Merge pull request #153 from Longwater1234/dev

Update protobuf library

Author: Longwater1234

BUILDING.md

@@ -2,16 +2,16 @@
 
 ## On Windows
 
-1. Just open this project folder in Visual Studio 2019 (or newer), with CMake extension installed.
-2. From top toolbar, change mode to **Release**, and click **Build** > **Build All**.
-3. Done. That's it. Your game .EXE will be in `{project_dir}/out/Release/bin`
-4. If the game fails to start, make sure `openal32.dll` is present in **same folder** with your .EXE. If not, copy it from SFML directory `${SFML_HOME}/bin/openal32.dll`
+1. Just open 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
 
-1. Open this project directory in your terminal.
+1. Open this project directory in your Terminal.
 2. Ensure CMake 3.20 or higher is installed. Verify with `cmake --version`
-3. Once installed, run the following commands:
+3. Next, copy and run the following commands:
 
 ```bash
 mkdir build
@@ -21,20 +21,17 @@ cmake --build . --config Release --target all
 
 ```
 
-4. Your executable (`.app` bundle for MacOS) and binary for Linux will be found in `{project_dir}/build/bin`
+4. Done. Your optimized game executable (`.app` on MacOS) will be found inside `{project_dir}/build/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 destkop platforms)
+## Using CMake GUI (all desktop platforms)
 
-- Download CMake GUI installer for your OS from the official site. (supported on all desktop OS)
-- On MacOS, after installing the GUI, add Cmake CLI to path, run the following command:
-  ```bash
-   sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
-  ```
-- Refer to the screenshot below:
-![cmake_screenshot](cmake/cmake_gui_screenshot.png)
+- Download latest stable [CMake GUI installer](https://cmake.org/download/) from official site
+- Open CMake GUI, refer to the screenshot below:
+  ![cmake_screenshot](cmake/cmake_gui_screenshot.png)
 
-- Set "Source Folder" (1) to this project root. Then set "Build Folder" (2) to a NEW _relative_ folder `/build` or `/out`. See image above. Then (3) click "**Configure**",
-- In the next screen, Choose **Unix Makefiles** if on Linux; choose **XCode** if on Mac. Choose **Visual Studio** if on Windows. Then click OK to save. 
-- Make sure CMAKE_BUILD_TYPE is **Release**.
-- Click Configure once again, then **Generate**.
-- Finally, on Windows and MacOS, click **Open Project** for building in respective IDE. On Linux desktop, open build folder, then run `make all` in Terminal. 
+- 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.

CMakeLists.txt

@@ -7,7 +7,7 @@ set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
-if(NOT APPLE) 
+if (NOT APPLE) 
   set(SFML_STATIC_LIBRARIES TRUE) 
 endif() 
 
@@ -43,14 +43,14 @@ target_link_libraries(SpaceCheckers PRIVATE sfml-graphics sfml-window sfml-syste
 include_directories(${SFML_HOME}/include)     
 
 # show warnings (depending on C++ compiler)
-if(MSVC)
+if (MSVC) 
   target_compile_options(SpaceCheckers PRIVATE /W4 /sdl /Qvec-report:1)
 else()  
-  target_compile_options(SpaceCheckers PRIVATE -Wall -Werror=overflow) 
+  target_compile_options(SpaceCheckers PRIVATE -Wall -Werror=constant-conversion) 
 endif()
-
+ 
 # COPY resources folder to destination
-if(NOT APPLE)
+if (NOT APPLE)
   add_custom_command( 
     TARGET SpaceCheckers 
     POST_BUILD

LICENSE

@@ -1,18 +1,17 @@
 # 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 (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 (compressed as `.tar.gz`) and built for you using [CPM.cmake](https://github.com/cpm-cmake/CPM.cmake).
 
-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](#).
-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).
 
 ### Main Libraries Used
 
 - SFML 2.6
 - imGui-SFML
 - ixWebsockets
 - spdlog
-- Google Protobuf 27.2 (Used entirely during gameplay)
+- Google Protobuf v30.1 (Used entirely during gameplay)
 - simdjson (Used once, for parsing list of public servers)
 
 ## Requirements for Building
@@ -27,20 +26,25 @@ The only dependency you need pre-installed on your OS is SFML 2.6.x (or newer).
 - 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 16** in [CMakeLists.txt](CMakeLists.txt), to set value `SFML_HOME` to folder path you moved SFML into (see
-  previous step)
+- Edit **line 16** in [CMakeLists.txt](CMakeLists.txt), to set value `SFML_HOME` to folder path you moved SFML into (seeprevious step)
 
-### For MacOS
+### For macOS (x64 & arm64)
 
-- Please install SFML 2.6 as **Frameworks**, not as "dylibs", as shown in [official macOS guide](https://www.sfml-dev.org/tutorials/2.6/start-osx.php).
+- 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:
 
 ```bash
   sudo xcode-select --install
 ```
 
-### For Linux Destkop
+- After installing the CMake GUI, add its accompanying CLI to PATH by simply run the following command:
+
+```bash
+   sudo "/Applications/CMake.app/Contents/bin/cmake-gui" --install
+```
+
+### For Linux Desktop
 
 - Latest display drivers
 - Use your OS package manager (`apt` or `yum`) to install SFML 2.6 or newer.
@@ -52,12 +56,12 @@ The only dependency you need pre-installed on your OS is SFML 2.6.x (or newer).
   sudo apt install libssl-dev
 ```
 
-- Luckily, Windows and macOS **come with their native SSL libs built-in**, so nothing more to do :-)
+- Luckily, Windows and macOS come with their **native SSL libs pre-installed**, so nothing more to do 😁
 
 ## Building Instructions
 
-Please see [BUILDING.md](BUILDING.md) for detailed instructions. For macOS-specific build guide with XCode, please [see this doc](cmake/README.md)
+Please see [BUILDING.md](BUILDING.md) for detailed instructions. For macOS-specific guide with XCode, please [cmake/README.md](cmake/README.md)
 
 ### License
 
-[MIT License](LICENSE) © 2024, Davis T.
+[GPL v3](LICENSE) © 2024, Davis T.

README.md

@@ -1,17 +1,14 @@
+# TODO list
 
-## GAME LOGS
+- [ ] (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.
 
-### first game
+### (Extras) Standard CJK font paths
 
-- start time: 19:31:12
-- end time: 19:35:17
-
-### Standard CJK font paths
-
-- Windows: `C:/Windows/Fonts/ARIALUNI.TTF.ttf`
+- Windows 10/11: `C:/Windows/Fonts/msyc.ttc`
 - MacOS: `/System/Library/Fonts/PingFang.ttc`
-- How to load cjk font in imgui
+- How to load CJK font in imGui:
 
 ```cpp
 ImFont* font = io.Fonts->AddFontFromFileTTF("/path/to/font.ext", 18.0f, nullptr, io.Fonts->GetGlyphRangesChineseFull());
-```
+```

TODO.md

@@ -1,12 +1,14 @@
 ## What's 'macbundle.cmake' for?
 
-This contains CMake script to build MacOS GUI `.app` bundle. It embeds the icon to the app bundle. It also copies all static assets into the bundle at build time.
+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.
 
-If you installed SFML as "Frameworks", you will need to tell XCode to copy them into the bundle before Building. Follow these steps: 
+**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!
 
-- 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)
-- Click the `+` (add button). A new window will pop up.
-- Now select all SFML frameworks listed: `sfml-graphics.framework` `sflml-window.framework` etc. You should also add `Foundation` framework.
-- Finally, you will need to find `freetype.framework`. Click **Other Locations**, find it inside `/Library/Frameworks`.
+Kindly follow these steps:
 
-Now you can build your project. Choose **Product** from top toolbar, click **Build**.
+- 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)
+- 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**.

cmake/README.md

@@ -1,18 +1,19 @@
-# Get abseil 20240116.2
+# Get abseil 20250127
 CPMAddPackage(
   NAME abseil
-  URL  "https://github.com/abseil/abseil-cpp/archive/refs/tags/20240116.2.tar.gz"
-  VERSION 20240116.2
+  URL  "https://github.com/abseil/abseil-cpp/archive/refs/tags/20250127.0.tar.gz"
+  VERSION 220250127
   DOWNLOAD_EXTRACT_TIMESTAMP TRUE   
   OPTIONS "ABSL_ENABLE_INSTALL ON" "ABSL_PROPAGATE_CXX_STD ON"
 ) 
 
-# Get protobuf 27.2
+# Get protobuf 30.1
 CPMAddPackage(
   NAME protobuf
-  URL  "https://github.com/protocolbuffers/protobuf/archive/refs/tags/v27.2.tar.gz" 
-  VERSION 27.2
+  URL  "https://github.com/protocolbuffers/protobuf/archive/refs/tags/v30.1.tar.gz" 
+  VERSION 30.1
   DOWNLOAD_EXTRACT_TIMESTAMP TRUE
-  OPTIONS        "protobuf_BUILD_TESTS OFF" "protobuf_INSTALL OFF" "protobuf_BUILD_LIBPROTOC ON" 
-  "protobuf_BUILD_PROTOC_BINARIES OFF" "protobuf_WITH_ZLIB ON" "protobuf_MSVC_STATIC_RUNTIME OFF"
+  OPTIONS    "protobuf_BUILD_TESTS OFF" "protobuf_INSTALL OFF" "protobuf_BUILD_PROTOBUF_BINARIES ON"
+   "protobuf_BUILD_LIBUPB OFF" "protobuf_WITH_ZLIB OFF" "protobuf_BUILD_PROTOC_BINARIES OFF" 
+   "protobuf_MSVC_STATIC_RUNTIME OFF"
 ) 

dependencies/protobuf.cmake

@@ -1,4 +1,4 @@
-# zlib v1.3.0 (zlib License)
+# zlib v1.3.1 (zlib License)
 
 CPMAddPackage(
     NAME zlib 

dependencies/zlib.cmake

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# Define the source directory
+SRC_DIR="src"
+
+clang-format $(find $SRC_DIR -type f -name "*.cpp" -o -name "*.hpp") -i --verbose
+echo "Formatting completed."

lint.sh

@@ -243,7 +243,7 @@ inline bool Piece::moveCapture(const sf::Vector2f &destPos)
         return false;
     }
 
-    this->move(sf::Vector2f{deltaX, deltaY}); // means "move by (x,y) amout"
+    this->move(sf::Vector2f{deltaX, deltaY}); // means "move by (x,y) amount"
     this->myCircle.setPosition(this->getPosition());
     if ((this->pieceType == PieceType::Red && destPos.y == 0) ||
         (this->pieceType == PieceType::Black && destPos.y == 7 * chk::SIZE_CELL))