Merge pull request #164 from Longwater1234/dev

Clearing forcedMoves after either side capture

Author: Longwater1234

.github/workflows/cmake-single-platform.yml

@@ -11,8 +11,8 @@ on:
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
   BUILD_TYPE: Release
-  SFML_DIR: "C:/SFML/SFML-2.6.1"
-  SFML_WIN_ZIP: SFML-2.6.1-windows-vc17-64-bit.zip
+  SFML_DIR: "C:/SFML/SFML-2.6.2"
+  SFML_WIN_ZIP: SFML-2.6.2-windows-vc17-64-bit.zip
 
 jobs:
   build:
@@ -27,7 +27,7 @@ jobs:
       - name: Download and setup SFML for Windows
         shell: cmd
         run: |
-          mkdir "C:/SFML" && curl -fsSL "https://www.sfml-dev.org/files/${{ env.SFML_WIN_ZIP }}" -o "C:/SFML/${{ env.SFML_WIN_ZIP }}"
+          mkdir "C:/SFML" && curl -fsSL "https://github.com/SFML/SFML/releases/download/2.6.2/${{ env.SFML_WIN_ZIP }}" -o "C:/SFML/${{ env.SFML_WIN_ZIP }}"
           tar -xvf "C:/SFML/${{env.SFML_WIN_ZIP}}" -C "C:/SFML/"
 
       - name: Configure CMake

BUILDING.md

@@ -2,26 +2,26 @@
 
 ## On Windows
 
-1. Just open this project directly in Visual Studio 2022 (or newer), with native CMake extension installed.
+1. Just import this project directly in Visual Studio 2022 (or newer), with native CMake extension installed.
 2. Wait as Visual Studio auto-configures this project for you.
 3. Next, from top toolbar, change mode to **'Release'**, and click **Build** > **Build All**.
 4. Done. That's it! Your game `.exe` will be inside `{project_dir}/out/Release/bin/`. Enjoy!
 
-## On MacOS & Linux
+## On MacOS & Linux (using Terminal)
 
-1. Open this project directory in your Terminal.
-2. Ensure CMake 3.20 or higher is installed. Verify with `cmake --version`
+1. Ensure CMake 3.20 or higher is installed. Verify with `cmake --version`
+2. Open this project directory in your Terminal.
 3. Next, copy and run the following commands:
 
 ```bash
-mkdir build
-cd build
+mkdir out/
+cd out/
 cmake . . -DCMAKE_BUILD_TYPE=Release
-cmake --build . --config Release --target all -j
+cmake --build . --config Release -j
 
 ```
 
-4. Done. Your optimized game executable (`.app` on MacOS) will be found inside `{project_dir}/build/bin/`
+4. Done. Your optimized game executable (`.app` on MacOS) will be found inside `{project_dir}/out/bin/`
 5. Alternatively, if you have CLion IDE, you can skip ALL steps above, and use it to build in "Release" mode.
 
 ## Using CMake GUI (all desktop platforms)
@@ -33,9 +33,9 @@ cmake --build . --config Release --target all -j
 - 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**.
 - 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**.
-- 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.
+- Click **Configure** once again, then click (4) **Generate**.
+- Finally, on Windows or MacOS, click **Open Project** for building in respective IDE. On Linux desktop, open build folder, then run `make -j` in Terminal.
 
 ### Important:
 
-For macOS-specific guide with XCode, please [cmake/README.md](cmake/README.md)
+For macOS-specific guide with XCode, please see [cmake/README.md](cmake/README.md)

README.md

@@ -3,8 +3,7 @@
 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 (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 written in Golang, and is [available here](https://github.com/Longwater1234/checkers-backend) which you can self-host!
+This game can connect to both Private and Public game servers. The backend server for this game is written in Golang, and is [available on GitHub](https://github.com/Longwater1234/checkers-backend) which you can self-host! You can download pre-built game (Windows x64 exe) from Actions tab (on GitHub Web). For other platforms, use the itch.io link above.
 
 ### Main Libraries Used
 
@@ -23,17 +22,17 @@ This game can connect to both Private and Public game servers. The Server projec
 
 ### For Windows
 
-- At least Windows 10
+- At least Windows 10 / Server 2016
 - 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 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)
 
-- Please install SFML 2.6 as **Frameworks**, not as "dylibs", as shown in [official SFML guide](https://www.sfml-dev.org/tutorials/2.6/start-osx.php).
 - XCode 14 or newer from AppStore (with MacOS SDK)
-- Apple Developer tools. After Xcode is installed, run this in your Terminal:
+- Please install SFML 2.6 as **Frameworks**, not as "dylibs", as shown in [official SFML guide](https://www.sfml-dev.org/tutorials/2.6/start-osx.php).
+- Download Apple Developer tools. After Xcode is installed, run this in your Terminal:
 
 ```bash
   sudo xcode-select --install
@@ -50,22 +49,22 @@ This game can connect to both Private and Public game servers. The Server projec
 - Latest display drivers
 - Use your OS package manager (`apt` or `yum`) to install SFML 2.6 or newer.
 - Alternatively, you may build SFML 2.6 from source, see [official SFML docs](https://www.sfml-dev.org/tutorials/2.6/start-linux.php).
-- You are required to install latest **OpenSSL Dev** library. See example on Ubuntu / Debian below.
+- You are required to install latest **OpenSSL Dev** library. See example for Ubuntu / Debian below.
 
 ```bash
   sudo apt install libsfml-dev
   sudo apt install libssl-dev
 ```
 
-- Luckily, Windows and macOS come with their **native SSL libs pre-installed**, so nothing more to do 😁
+- Luckily, Windows and macOS come with their **native SSL libs pre-installed**, so nothing more to do 😊
 
 ## Build Instructions
 
 Please see [BUILDING.md](BUILDING.md) for detailed instructions for each platform.
 
 ## Code Contributions
 
-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`.
+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
 

cmake/README.md

@@ -2,13 +2,16 @@
 
 This contains CMake script to build MacOS GUI `.app` bundle. It embeds the icon to the app bundle. It also copies all static assets (resources) into the bundle at build time.
 
-**IMPORTANT**: If you installed SFML as "Frameworks" (recommended), you will need to manually instruct XCode to embed them into the bundle at Build time. Otherwise, the game won't work on other similar MacOS devices!
+**IMPORTANT**: If you installed SFML as "Frameworks" (recommended), you will need to manually instruct XCode to embed them into the bundle at Build time. Otherwise, the game won't work on other similar Macs!
 
 Kindly follow these steps:
 
 - Use CMake to generate "XCode Project". Refer to [BUILDING.md](../BUILDING.md). Open the project.
 - From top toolbar inside Xcode, click **Product** > **Add New Build Phase** > choose **Copy Files**. See official [Apple guide](https://developer.apple.com/documentation/xcode/customizing-the-build-phases-of-a-target)
+- Expand the "Copy Files" section, select destination: **Frameworks**.
 - Click the `+` (add button) to begin. A new window will pop up.
 - Now select all SFML frameworks listed: `sfml-graphics.framework`, `sflml-window.framework` etc.
-- Finally, you will need to add `freetype.framework`. Click **Other Locations**, find it inside `/Library/Frameworks`. Click "Copy as reference folder". Click OK
-- Now you can build your project. From top toolbar, Click **Product** > **Build**.
+- Lastly, you will need to add `freetype.framework` (for text support). Click **"Add Other..."**, find it inside `/Library/Frameworks`. Click "Copy as reference folder". Click OK.
+- You should have output similar to screenshot below (I renamed "Copy Files" to "Copy Frameworks"):
+  ![xcode screenshot](./xcode_copy_frameworks.png)
+- Now you can build your project. From top toolbar, Click **Product** > **Build**. Done!

cmake/xcode_copy_frameworks.png

@@ -159,6 +159,7 @@ void GameManager::handleCapturePiece(const chk::PlayerPtr &hunter, const chk::Pl
         return;
     }
     //  Check for extra opportunities (only if hunter has NOT just became KING)
+    this->forcedMoves.clear();
     if (isKingBefore == isKingNow)
     {
         GameManager::identifyTargets(hunter, targetCell);

src/managers/GameManager.cpp

@@ -7,6 +7,7 @@
 namespace chk
 {
 using chk::payload::TeamColor;
+
 /**
  * This class is responsible for online gameplay
  * @since 2024-04-11
@@ -292,11 +293,12 @@ inline void OnlineGameManager::handleCapturePiece(const chk::PlayerPtr &hunter,
         return;
     }
 
+    // CREATE SOME COPIES BEFORE UPDATING:
     int copyHunterPiece = 0; // hunter pieceId
-    int copySrcCell = 0;     // hunter src cell
+    int copySrcCell = 0;     // hunter src cell index
     int copyPreyPieceId = 0;
     int copyPreyCell = 0;
-    // track King status for Hunter piece
+    // for tracking King status of Hunter piece
     bool isKingBefore = false;
     bool isKingNow = false;
 
@@ -330,7 +332,7 @@ inline void OnlineGameManager::handleCapturePiece(const chk::PlayerPtr &hunter,
     {
         return;
     }
-    // prey details (must use raw pointers for embedded protobuf)
+    // prey details (must use raw ptr for embedded protobuf)
     auto *details = new chk::payload::CapturePayload_TargetDetails();
     details->set_hunter_src_cell(copySrcCell);
     details->set_prey_cell_idx(copyPreyCell);
@@ -374,6 +376,7 @@ inline void OnlineGameManager::handleCapturePiece(const chk::PlayerPtr &hunter,
         // NO MORE JUMPS AVAILABLE. SWITCH TURNS to opponent
         chk::GameManager::identifyTargets(prey);
         this->isMyTurn = !this->isMyTurn;
+        this->updateMessage("It's " + prey->getName() + "'s turn");
     }
     else
     {
@@ -414,7 +417,7 @@ inline void OnlineGameManager::handleCellTap(const chk::PlayerPtr &hunter, const
     }
     else
     {
-        // Cell is Empty! Let's judge if this is SIMPLE move or ATTACK move
+        // Cell is Empty! Let's evaluate if this is SIMPLE move or ATTACK move
         if (!buffer.isEmpty())
         {
             const short movablePieceId = buffer.getFront();
@@ -445,7 +448,7 @@ inline void OnlineGameManager::handleCellTap(const chk::PlayerPtr &hunter, const
 inline void OnlineGameManager::startMoveListener()
 {
     this->wsClient->setOnMovePieceCallback([this](const chk::payload::MovePayload &payload) {
-        // which color is my Opponent?
+        // which color is the Opponent?
         // clang-format off
         const chk::PlayerPtr &enemy = (payload.from_team() == TeamColor::TEAM_RED) ? this->playerRed : this->playerBlack;
         const chk::PlayerPtr &myTeam = (enemy->getPlayerType() == PlayerType::PLAYER_RED) ? this->playerBlack : this->playerRed;
@@ -507,6 +510,7 @@ inline void OnlineGameManager::startCaptureListener()
         });
 
         // Check for extra opportunities (for Enemy), only if Enemy did NOT just become King
+        this->forcedMoves.clear();
         if ((isKingBefore == isKingNow) && it != this->blockList.end())
         {
             GameManager::identifyTargets(opponent, *it);
@@ -517,6 +521,7 @@ inline void OnlineGameManager::startCaptureListener()
             // NO MORE JUMPS AVAILABLE. SWITCH TURNS to myself.
             chk::GameManager::identifyTargets(myTeam);
             this->isMyTurn = !this->isMyTurn;
+            this->updateMessage("It's now your turn!");
         }
     });
 }