Merge pull request #156 from Longwater1234/dev

Ready for making public on Github

Author: Longwater1234

.gitignore

@@ -20,7 +20,6 @@ bld/
 .idea/
 /cmake-build-*/
 
-
 # Prerequisites
 *.d
 
@@ -56,5 +55,4 @@ bld/
 *.app
 *.zip
 *.rar
-.DS_Store
-game_map.txt
+.DS_Store

BUILDING.md

@@ -1,4 +1,4 @@
-# Building Locally
+# Building Locally (Release mode only)
 
 ## On Windows
 
@@ -31,7 +31,11 @@ cmake --build . --config Release --target all
   ![cmake_screenshot](cmake/cmake_gui_screenshot.png)
 
 - Set "Source Folder" (1) to this project root dir. Then, set "Build Folder" (2) to a NEW _relative_ folder `/build` or `/out`.
-- Ensure "CMAKE_BUILD_TYPE" is **Release** (see image above, blue highlight). Ignore other settings. Then (3) click "**Configure**".
+- Ensure "CMAKE_BUILD_TYPE" is **Release** (see image above, blue highlight). Ignore other settings. Then (3) click **Configure**.
 - In the popup window, choose generator **'Unix Makefiles'** if on Linux; choose **'XCode'** if on MacOS. Choose **'Visual Studio'** if on Windows. Then click OK to save.
-- Click **'Configure'** once again, then **'Generate'**.
+- Click **Configure** once again, then **Generate**.
 - Finally, on Windows or MacOS, click **Open Project** for building in respective IDE. On Linux desktop, open build folder, then run `make all` in Terminal.
+
+### Important:
+
+For macOS-specific guide with XCode, please [cmake/README.md](cmake/README.md)

CMakeLists.txt

@@ -13,7 +13,7 @@ if (NOT APPLE)
   set(SFML_STATIC_LIBRARIES TRUE) 
 endif() 
 
-# write app version ONCE into Header
+# write app version into Header
 configure_file(
   ${CMAKE_CURRENT_SOURCE_DIR}/src/proto_schema/AppVersion.hpp.in
   ${CMAKE_CURRENT_SOURCE_DIR}/src/AppVersion.hpp

README.md

@@ -1,13 +1,14 @@
 # space - checkers
 
 Offline & Online Multiplayer Checkers game in C++ built with SFML 2.6, imGui, Protobuf and ixWebsockets. With very minimal dependencies
-and a simple build process. All dependencies are auto-downloaded (compressed as `.tar.gz`) and built for you using [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake).
+and a simple build process. All dependencies are auto-downloaded (as `.tar.gz`) and configured for you using [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake). The only dependency you need pre-installed on your OS is SFML 2.6.x (or newer).
 
-This game can connect to both Private and Public game servers. The Server project for this game is on a separate Git repo, [available here](https://github.com/Longwater1234/checkers-backend) which you can self-host! The only dependency you need pre-installed on your OS is SFML 2.6.x (or newer).
+
+This game can connect to both Private and Public game servers. The Server project for this game is written in Golang, and is [available here](https://github.com/Longwater1234/checkers-backend) which you can self-host!
 
 ### Main Libraries Used
 
-- SFML 2.6
+- SFML 2.6.1
 - imGui-SFML
 - ixWebsockets
 - spdlog
@@ -16,8 +17,8 @@ This game can connect to both Private and Public game servers. The Server projec
 
 ## Requirements for Building
 
-- C++17 (or newer) build tools.
-- Pre-built [SFML 2.6.x](https://www.sfml-dev.org/download/sfml/2.6.1/) binaries. (Must match your Compiler and OS)
+- C++17 (or newer) compiler.
+- Pre-built [SFML 2.6.x](https://www.sfml-dev.org/download/sfml/2.6.1/) binaries.
 - [CMake 3.20+](https://cmake.org/download/) or newer (GUI recommended)
 
 ### For Windows
@@ -26,7 +27,7 @@ This game can connect to both Private and Public game servers. The Server projec
 - MS Visual Studio 2022 or newer (NOT vscode), with "**Desktop C++ Development**" bundle.
 - Please download "Visual C++ 64bit" edition of SFML; ignore others.
 - Move your unzipped `SFML-2.6.x` folder to its own home, example: `C:/SFML/SFML-2.6.1`.
-- Edit **line 25** in [CMakeLists.txt](CMakeLists.txt), to set value `SFML_HOME` to folder path you moved SFML into (see previous step)
+- Edit **line 24** in [CMakeLists.txt](CMakeLists.txt#L24), to set value `SFML_HOME` to folder path you moved SFML into (from previous step)
 
 ### For macOS (x64 & arm64)
 
@@ -58,10 +59,14 @@ This game can connect to both Private and Public game servers. The Server projec
 
 - Luckily, Windows and macOS come with their **native SSL libs pre-installed**, so nothing more to do 😁
 
-## Building Instructions
+## Build Instructions
+
+Please see [BUILDING.md](BUILDING.md) for detailed instructions for each platform.
+
+## Code Contributions
 
-Please see [BUILDING.md](BUILDING.md) for detailed instructions. For macOS-specific guide with XCode, please [cmake/README.md](cmake/README.md)
+Pull requests are welcome! See GitHub Issues tab to help with new Features. Just kindly remember run `lint.sh` script before you git push. Also, for this project, header files should end with `.hpp`.
 
-### License
+## License
 
 [GPL v3](LICENSE) © 2024, Davis T.

TODO.md

@@ -1,7 +1,7 @@
 # TODO list
 
 - [ ] (Online mode) Display countdown timer (40 s), waiting for player's move. Reset it when they make a move.
-- [ ] Record and list all previous moves and captures (for current match), in a scroll window.
+- [ ] Record and list all previous moves and captures (for current match), in a scroll panel.
 
 ### (Extras) Standard CJK font paths
 

dependencies/mbedtls.cmake

@@ -2,7 +2,7 @@
 
 CPMAddPackage(
     NAME mbedtls
-    URL "https://github.com/Mbed-TLS/mbedtls/archive/refs/tags/v2.25.0.zip"
+    URL "https://github.com/Mbed-TLS/mbedtls/archive/refs/tags/v2.25.0.tar.gz"
     VERSION 2.25.0
     DOWNLOAD_EXTRACT_TIMESTAMP TRUE
     DOWNLOAD_ONLY ON

dependencies/simdjson.cmake

@@ -1,7 +1,7 @@
 # Get simdjson 3.10.0
 CPMAddPackage(
   NAME simdjson
-  URL  https://github.com/simdjson/simdjson/archive/refs/tags/v3.10.0.tar.gz
+  URL  "https://github.com/simdjson/simdjson/archive/refs/tags/v3.10.0.tar.gz"
   VERSION 3.10.0
   DOWNLOAD_EXTRACT_TIMESTAMP TRUE
 ) 

src/AppVersion.hpp

@@ -1,6 +1,8 @@
 #ifndef APP_VERSION_HPP
 #define APP_VERSION_HPP
 
+// AUTO-GENERATED BY CMAKE, DO NOT EDIT!
+
 // clang-format off
 namespace chk {
   constexpr const char* APP_VERSION = "1.0.10";

src/WsClient.hpp

@@ -61,6 +61,7 @@ class WsClient final
     std::atomic_bool connClicked = false;           // if 'connect' button clicked
     std::vector<chk::ServerLocation> publicServers; // list of public servers (fetched from CDN)
 
+    /* callbacks for different events from server */
     onConnectedServer _onReadyConnected;
     onReadyStartGame _onReadyStartGame;
     onDeathCallback _onDeathCallback;

src/managers/OnlineGameManager.hpp

@@ -498,7 +498,7 @@ inline void OnlineGameManager::startCaptureListener()
         gameMap.erase(payload.details().hunter_src_cell());                  // set opponent's old location empty!
         gameMap.erase(payload.details().prey_cell_idx());                    // set my old location empty!
         gameMap.emplace(payload.destination().cell_index(), hunterPieceId);  // fill in hunter new location
-        int targetId = payload.details().prey_piece_id();                    // get the target dead piece
+        const int targetId = payload.details().prey_piece_id();              // get the target dead piece
         myTeam->losePiece(static_cast<short>(targetId));                     // I will lose one piece
 
         const int destCellIdx = payload.destination().cell_index();