Merge pull request #94 from ASM-Studios/dev

dev

Author: m-brl

.clang-format

@@ -127,7 +127,7 @@ IncludeCategories:
     CaseSensitive:   false
 IncludeIsMainRegex: '(Test)?$'
 IncludeIsMainSourceRegex: ''
-IndentAccessModifiers: false
+IndentAccessModifiers: true
 IndentCaseBlocks: false
 IndentCaseLabels: true
 IndentExternBlock: AfterExternBlock

.clang-tidy

@@ -4,4 +4,8 @@ Checks: "bugprone-*,cppcoreguidelines-*,clang-analyzer-*,readability-*,misc-*,mo
   -readability-identifier-length,
   -cppcoreguidelines-pro-type-union-access,
   -cppcoreguidelines-avoid-magic-numbers,
-  -readability-magic-numbers"
+  -readability-magic-numbers,
+  -unused-includes,
+  -bugprone-easily-swappable-parameters,
+  -readability-braces-around-statements
+"

.github/workflows/deploy.yml

@@ -0,0 +1,110 @@
+name: deploy
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+
+env:
+  EXECUTABLES:  r-type_client, r-type_server
+
+jobs:
+  create_release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Get current date
+        id: date
+        run: echo "date=$(TZ='Europe/Paris' date +'%Y.%m.%d.%H.%M')" >> $GITHUB_ENV
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ env.date }}
+          release_name: ${{ env.date }}
+    outputs:
+        upload_url: ${{ steps.create_release.outputs.upload_url }}
+
+  build_and_deploy_linux:
+    name: Build and deploy (Linux)
+    runs-on: ubuntu-latest
+    needs: create_release
+    container:
+      image: mathieubrl/rtype
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Cache vcpkg
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/vcpkg/
+          key: ${{ hashFiles('vcpkg.json') }}
+      - name: Setup vcpkg
+        run: |
+          if [ ! -d "vcpkg" ]; then
+            git clone https://github.com/microsoft/vcpkg.git
+            ./vcpkg/bootstrap-vcpkg.sh
+          fi
+          ./vcpkg/vcpkg install
+      - name: Setup CMake
+        uses: jwlawson/actions-setup-cmake@v2
+        with:
+          cmake-version: '3.27.4'
+      - name: Compilation
+        run: |
+          ./release.sh
+      - name: Create archive
+        run: |
+          zip -r linux_executables.zip r-type_client r-type_server
+      - name: Upload Release Asset
+        id: upload-release-asset-linux
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ needs.create_release.outputs.upload_url }}
+          asset_path: ./linux_executables.zip
+          asset_name: linux_executables.zip
+          asset_content_type: application/zip
+
+#  build_and_deploy_windows:
+#    name: Build and deploy (Windows)
+#    runs-on: windows-latest
+#    needs: create_release
+#    steps:
+#      - name: Checkout repository
+#        uses: actions/checkout@v4
+#      - name: Cache vcpkg
+#        uses: actions/cache@v4
+#        with:
+#          path: C:\Users\runneradmin\AppData\Local\vcpkg\archives
+#          key: ${{ hashFiles('vcpkg.json') }}
+#      - name: Setup vcpkg
+#        run: |
+#          if (-not (Test-Path -Path "C:\vcpkg")) {
+#            git clone https://github.com/microsoft/vcpkg.git C:\vcpkg
+#            .\vcpkg\bootstrap-vcpkg.bat
+#          }
+#          C:\vcpkg\vcpkg install
+#      - name: Compilation # ne fonctionne pas encore
+#        run: |
+#          cmake -S . -B build -G "Ninja" -DCMAKE_TOOLCHAIN_FILE="C:\Program Files\Microsoft Visual Studio\2022\Community\VC\vcpkg\scripts\buildsystems\vcpkg.cmake" -DCMAKE_BUILD_TYPE=Release
+#          cmake --build .
+#      - name: Create archive
+#        run: |
+#          Compress-Archive -Path r-type_client.exe, r-type_server.exe -DestinationPath windows_executables.zip
+#      - name: Upload Release Asset
+#        id: upload-release-asset-windows
+#        uses: actions/upload-release-asset@v1
+#        env:
+#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#        with:
+#          upload_url: ${{ needs.create_release.outputs.upload_url }}
+#          asset_path: ./windows_executables.zip
+#          asset_name: windows_executables.zip
+#          asset_content_type: application/zip

.gitignore

@@ -18,7 +18,7 @@ note
 
 # Documentation
 
-docs/html/*
+docs/docs/html/*
 
 # CMake
 

CMakeLists.txt

@@ -3,9 +3,11 @@ project(rtype)
 
 include_directories(shared/network/include)
 include_directories(shared/ECS/include)
+include_directories(shared/ECS/src/Factories)
 include_directories(shared/Config/include)
 include_directories(shared/Logger/include)
 include_directories(shared/Texture/include)
+include_directories(shared/GameLogic/include)
 
 set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_EXTENSIONS OFF)

CMakePresets.json

@@ -6,16 +6,40 @@
       "generator": "Ninja",
       "binaryDir": "${sourceDir}/cmake-build-debug",
       "cacheVariables": {
-        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
+        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+        "CMAKE_BUILD_TYPE": "Debug",
+        "CMAKE_CXX_COMPILER": "g++"
       }
     },
     {
       "name": "release",
       "generator": "Ninja",
       "binaryDir": "${sourceDir}/cmake-build-release",
       "cacheVariables": {
-        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake"
+        "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_CXX_COMPILER": "g++"
       }
+    },
+    {
+        "name": "windows-from-linux",
+        "generator": "Ninja",
+        "binaryDir": "${sourceDir}/cmake-build-windows",
+        "cacheVariables": {
+          "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+          "CMAKE_BUILD_TYPE": "Release",
+          "CMAKE_CXX_COMPILER": "i686-w64-mingw32-g++"
+        }
+    },
+    {
+        "name": "windows-from-windows",
+        "generator": "Ninja",
+        "binaryDir": "${sourceDir}/cmake-build-windows",
+        "cacheVariables": {
+          "CMAKE_TOOLCHAIN_FILE": "$env{VCPKG_ROOT}/scripts/buildsystems/vcpkg.cmake",
+          "CMAKE_BUILD_TYPE": "Release",
+          "CMAKE_CXX_COMPILER": "g++"
+        }
     }
   ]
 }

README.md

@@ -8,6 +8,10 @@ The server will be developed has a game engine, and the client will be a simple
 
 The project is made solely in C++.
 
+## Supported platforms
+
+This project can run on Windows and Linux.
+
 ## Requirements
 
 - Doxygen: [see documentation](https://www.doxygen.nl/manual/install.html)
@@ -35,6 +39,12 @@ Use debug.sh script to create a debug build.
 ./debug.sh
 ```
 
+or
+
+```powershell
+debug.bat
+```
+
 ### Release
 
 Use release.sh script to create a release build.
@@ -43,18 +53,40 @@ Use release.sh script to create a release build.
 ./release.sh
 ```
 
+or
+
+```powershell
+release.bat
+```
+
 ## Documentation
 
 This project is documented using Doxygen.
 
 You can find additional information in the [`docs`](docs/Hub.md) folder.
 
+For developers, refer to the [Developers.md](docs/Developers.md) file.
+
 ## Authors
 
 | Name            | Github                                              |
 |-----------------|-----------------------------------------------------|
 | Mathieu Coulet  | [Djangss](https://github.com/Djangss)               |
-| Mathieu Borel   | [mat0904](https://github.com/mat0904)               |
+| Mathieu Borel   | [mathieu-brl](https://github.com/mathieu-brl)       |
 | Yohann Mangenot | [YohannMgt](https://github.com/YohannMgt)           |
 | Charles Madjeri | [charlesmadjeri](https://github.com/charlesmadjeri) |
 | Maël RABOT      | [Mael-RABOT](https://github.com/Mael-RABOT)         |
+
+## License
+
+This project is under the GNU General Public License v3.0.
+
+## Assets
+
+All assets used in this project are under the Creative Commons License.
+
+Here are the authors of some of the assets:
+
+- [helianthus-games](https://helianthus-games.itch.io/)
+- [kayillustrations](https://kayillustrations.itch.io/)
+- [ansimuz](https://ansimuz.itch.io/)