Epitech-R-Type
diff --git a/Diff for: ‎.gitbook/assets/Bild_2022-11-12_142731446.png
22.7 KB b/Diff for: ‎.gitbook/assets/Bild_2022-11-12_142731446.png
22.7 KB
diff --git a/Diff for: ‎.gitbook/assets/Blank board.png
209 KB b/Diff for: ‎.gitbook/assets/Blank board.png
209 KB
diff --git a/Diff for: ‎.gitbook/assets/Document systems.png
37.6 KB b/Diff for: ‎.gitbook/assets/Document systems.png
37.6 KB
diff --git a/Diff for: ‎.gitbook/assets/ECS Systems overview.png
56.2 KB b/Diff for: ‎.gitbook/assets/ECS Systems overview.png
56.2 KB
diff --git a/Diff for: ‎.gitbook/assets/client processflow.png
65.4 KB b/Diff for: ‎.gitbook/assets/client processflow.png
65.4 KB
diff --git a/Diff for: ‎.gitbook/assets/server processflow.png
72.6 KB b/Diff for: ‎.gitbook/assets/server processflow.png
72.6 KB
diff --git a/Diff for: ‎.github/workflows/exec_tests.yml
-1 b/Diff for: ‎.github/workflows/exec_tests.yml
-1
diff --git a/Diff for: ‎.gitignore
+2 b/Diff for: ‎.gitignore
+2
diff --git a/Diff for: ‎CMakeLists.txt
+10-3 b/Diff for: ‎CMakeLists.txt
+10-3
diff --git a/Diff for: ‎README.md
+27-71 b/Diff for: ‎README.md
+27-71
diff --git a/Diff for: ‎dev-documentation/README.md
+8 b/Diff for: ‎dev-documentation/README.md
+8
diff --git a/Diff for: ‎Documentation/Client.md renamed to ‎dev-documentation/client-documentation.md
+8-9 b/Diff for: ‎Documentation/Client.md renamed to ‎dev-documentation/client-documentation.md
+8-9
@@ -28,7 +28,6 @@ jobs:
         run: >
           conan profile update conf.tools.system.package_manager:mode=install default;
           conan profile update conf.tools.system.package_manager:sudo=True default;
-          mkdir build;
           make test;
 
       - name: verify-files
 
@@ -12,3 +12,5 @@ bin/*
 **/*.html
 **/*.css
 report.html
+testmain.cpp
+a.out
@@ -65,6 +65,11 @@ function(build_server)
         src/server/levels/level1
         src/server/levels/level2
         src/server/levels/level3
+        src/server/levels/level4
+        src/server/levels/level5
+        src/server/levels/level6
+        src/server/levels/level7
+        src/server/levels/level8
         )
 
         target_link_libraries(Server server::rc)
@@ -78,6 +83,7 @@ function(build_client)
             "${CMAKE_CURRENT_SOURCE_DIR}/src/client/ClientGame/ClientGame.cpp"
             "${CMAKE_CURRENT_SOURCE_DIR}/src/client/GUI/Components/TextBox.cpp"
             "${CMAKE_CURRENT_SOURCE_DIR}/src/client/GUI/Components/Button.cpp"
+            "${CMAKE_CURRENT_SOURCE_DIR}/src/client/GUI/Menus/Menu.cpp"
             "${CMAKE_CURRENT_SOURCE_DIR}/src/client/GUI/Menus/ConnectionMenu.cpp"
             "${CMAKE_CURRENT_SOURCE_DIR}/src/client/GUI/Menus/LobbyMenu.cpp"
             "${CMAKE_CURRENT_SOURCE_DIR}/src/client/GUI/Menus/LobbySelectionMenu.cpp"
@@ -88,7 +94,8 @@ function(build_client)
             "${CMAKE_CURRENT_SOURCE_DIR}/src/client/Systems/HealthSystem.cpp"
             "${CMAKE_CURRENT_SOURCE_DIR}/src/client/Systems/MusicSystem.cpp"
             "${CMAKE_CURRENT_SOURCE_DIR}/src/client/Systems/PlayerMovementSystem.cpp"
-            ""
+            "${CMAKE_CURRENT_SOURCE_DIR}/src/shared/ECS/Serialization.cpp"
+
             "${CMAKE_CURRENT_SOURCE_DIR}/src/shared/ECS/CompPool.cpp"
             "${CMAKE_CURRENT_SOURCE_DIR}/src/shared/ECS/ECSManager.cpp"
             "${CMAKE_CURRENT_SOURCE_DIR}/src/shared/ECS/Components.cpp"
@@ -152,6 +159,8 @@ function(build_client)
         resources/r-typesheet44.png
         resources/lost.png
         resources/background.png
+        resources/citySunnset.png
+        resources/menu-background.png
         resources/song0.mp3
         resources/song1.mp3
         resources/song2.mp3
@@ -188,14 +197,12 @@ function(build_tests)
         "${CMAKE_CURRENT_SOURCE_DIR}/src/shared/ECS/CompPool.cpp"
         "${CMAKE_CURRENT_SOURCE_DIR}/src/shared/ECS/ECSManager.cpp"
         "${CMAKE_CURRENT_SOURCE_DIR}/src/shared/ECS/Components.cpp"
-        "${CMAKE_CURRENT_SOURCE_DIR}/src/shared/ECS/Serialization.cpp"
     )
 
     set(TEST_CODE
         "${CMAKE_CURRENT_SOURCE_DIR}/test/main.cpp"
         "${CMAKE_CURRENT_SOURCE_DIR}/test/ECS/EcsTests.cpp"
         "${CMAKE_CURRENT_SOURCE_DIR}/test/ECS/EcsFixture.cpp"
-        "${CMAKE_CURRENT_SOURCE_DIR}/test/ECS/Serialization.cpp"
     )
 
     add_executable(
 
@@ -1,79 +1,35 @@
-[Contributing Guide](CONTRIBUTING.md)
-
-# R-Type
+<p align="center">
+    <img src="https://cdn.dribbble.com/users/664697/screenshots/6458763/r-logo.png" alt="drawing" width="200">
+    <p align="center">
+        <img src="https://badgen.net/github/stars/Epitech-R-Type/R-Type?color=purple">
+        <img src="https://badgen.net/github/contributors/Epitech-R-Type/R-Type?color=green">
+        <img src="https://badgen.net/github/branches/Epitech-R-Type/R-Type?color=pink">
+        <img src="https://badgen.net/github/commits/Epitech-R-Type/R-Type/main?color=orange">
+    </p>
+    <p align="center">
+        <img src="https://github.com/Epitech-R-Type/R-Type/actions/workflows/build_linux.yml/badge.svg?branch=main">
+        <img src="https://github.com/Epitech-R-Type/R-Type/actions/workflows/build_windows.yml/badge.svg?branch=main">
+        <img src="https://github.com/Epitech-R-Type/R-Type/actions/workflows/linter.yml/badge.svg?branch=main">
+    </p>
+</p>
+
+### R-Type
 
 This project aims to implement the classic game [R-Type](https://wikiless.sethforprivacy.com/wiki/R-Type?lang=en).\
 It will include network based multiplayer.
 
-# Install dependencies
-
-```
-yay -S pkg-config cmake make
-```
-
-# Install Conan
-
-```
-pip install conan
-conan profile new default --detect
-conan profile update conf.tools.system.package_manager:mode=install default;
-conan profile update conf.tools.system.package_manager:sudo=True default;
-```
-
-# How to Build
-
-## Automatic build for Linux and Windows
-
-For this to work on Windows you need to have access to a Unix shell, such as Git Bash or WSL as well as access to the make command.
-
-In order to build both the client and the server, you can make the "all" rule:
-
-```
-make
-```
-
-In order to build the tests, make the "test" rule:
-
-```
-make test
-```
-
-Binaries can be found at:
-```
-./bin/Server
-./bin/Client
-./bin/Tests
-```
-
-## Manual Build
-### For Linux
-
-Delete the build folder if present:
-
-```
-rm -rf build
-```
-
-Then build the binaries:
-
-```
-conan install conanfile.txt -if build --build=missing
-cmake -S . -B build
-cmake --build build
-```
-
-### For Windows
+[gitbook documentation](https://r-type-1.gitbook.io/r-type-documentation/)
 
-Delete the build folder if present:
+*   [User Documentation](user-documentation/)
 
-```
-rmdir /s build
-```
+    * [install and build guide](user-documentation/install-and-build-guide.md)
+    * [tutorials](user-documentation/tutorials/)
+    * [System overview](user-documentation/systems-overview.md)
+    * [license](user-documentation/license.md)
 
-Then build the binaries:
 
-```
-conan install conanfile.txt -if build --build=missing
-cmake -S . -B build
-cmake --build build
-```
+* [Dev Documentation](dev-documentation/)
+  * [Client Documentation](dev-documentation/client-documentation.md)
+  * [communication protocol](dev-documentation/comunication-protocol.md)
+  * [ECS documentation](dev-documentation/ecs-documentation.md)
+  * [team/coding conventions](dev-documentation/team-coding-conventions.md)
@@ -0,0 +1,8 @@
+# dev-documentation
+
+### Contents
+
+* [Client Documentation](client-documentation.md)
+* [Communication protocol](comunication-protocol.md)
+* [ECS documentation](ecs-documentation.md)
+* [team/coding conventions](team-coding-conventions.md)
@@ -1,16 +1,16 @@
 # Client Documentation
 
-## Introduction
+### Introduction
 
 This documentation includes everything you need to know in order to implement your own client for the R-Type server.
 
 With this client, you should be able to connect to a game being run on the server alongside players currently using the default client implementation that we provide.
 
-## Entity Component System
+### Entity Component System
 
 At the core of the R-Type server architecture is the Entity Component System (or ECS). This entity component system will only be updated by the server which will then communicate the updates to the client though our UDP game protocol.
 
-### Serialization
+#### Serialization
 
 In order for the client to communicate the changes made to the ECS to the client, it is important that the client defines serialization and deserialization methods for each component.
 
@@ -22,11 +22,11 @@ ComponentID is the unique component ID that has to be generated by the client in
 
 After the ComponentID, each arg will be serialized separated by commas. These arguments are serialized in the same order as they appear in the component struct definition. It is **crucial** that the client deserialize the components attributes in the same order as they appear in the component definitions we provide further along in this document.
 
-### Components
+#### Components
 
 The following are the server side definitions of the components.
 
-```c++
+```cpp
 struct Armor {
         int armor = 0;
 };
@@ -105,19 +105,18 @@ struct SoundDamage {
 //SFXID is an enum that the client can associate sound effects to
 ```
 
-### Systems
+#### Systems
 
 In order for the client to display the information received by the server, only one system needs to be implemented. This system is the animation drawing system that should allow it to draw static and animated sprites.
 
 All sprite sheets required by the game to run will be provided in a directory named 'ressources'.
 
-### Player controls
+#### Player controls
 
 To communicate the direction a player wants to move the following enum is used:
 
 enum Move { UP = 1, DOWN = -1, LEFT = 3, RIGHT = -3 }
 
 The integer coresponding to the desired direction can be calculated by adding the integers in the enum that have an influence on the final direction.
 
-e.g.:
-Down right = DOWN + RIGHT = -1 - 3 = -4
+e.g.: Down right = DOWN + RIGHT = -1 - 3 = -4