Merge pull request #165 from Longwater1234/dev

major code cleanup

Author: Longwater1234

BUILDING.md

@@ -5,7 +5,7 @@
 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!
+4. Done. That's it! Your game `.exe` will be inside `{PROJECT_DIR}/out/Release/bin/`. Enjoy!
 
 ## On MacOS & Linux (using Terminal)
 
@@ -21,7 +21,7 @@ cmake --build . --config Release -j
 
 ```
 
-4. Done. Your optimized game executable (`.app` on MacOS) will be found inside `{project_dir}/out/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)

CMakeLists.txt

@@ -1,67 +1,76 @@
 cmake_minimum_required(VERSION 3.20 FATAL_ERROR)
 
-project("SpaceCheckers" VERSION 1.0.11
- HOMEPAGE_URL "https://github.com/Longwater1234/space-checkers")
+project(
+  "SpaceCheckers"
+  VERSION 1.0.12
+  HOMEPAGE_URL "https://github.com/Longwater1234/space-checkers")
 
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
 
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED TRUE)
 set(CMAKE_CXX_EXTENSIONS OFF)
-
-if (NOT APPLE) 
-  set(SFML_STATIC_LIBRARIES TRUE) 
-endif()  
+# Only macOS links SFML as Frameworks, not static
+if(NOT APPLE)
+  set(SFML_STATIC_LIBRARIES TRUE)
+endif()
 
 # write app version into Header
-configure_file(
-  ${CMAKE_CURRENT_SOURCE_DIR}/src/proto_schema/AppVersion.hpp.in
-  ${CMAKE_CURRENT_SOURCE_DIR}/src/AppVersion.hpp
-)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/src/proto_schema/AppVersion.hpp.in
+               ${CMAKE_CURRENT_SOURCE_DIR}/src/AppVersion.hpp)
 
 # ==== UPDATE ME HERE ===========
 # Absolute path where you installed SFML (Required on Windows)
-set(SFML_HOME "C:/SFML/SFML-2.6.1") 
-set(SFML_DIR ${SFML_HOME}/lib/cmake/SFML)   
+set(SFML_HOME "C:/SFML/SFML-2.6.1")
+set(SFML_DIR ${SFML_HOME}/lib/cmake/SFML)
 # ==========================
 
 # Collect all sources
-file(GLOB_RECURSE GAME_SRC "src/*.cpp" "src/*.hpp")  
-find_package(SFML 2.6 REQUIRED COMPONENTS "graphics" "window" "system") 
+file(GLOB_RECURSE GAME_SRC "src/*.cpp" "src/*.hpp")
+find_package(SFML 2.6 REQUIRED COMPONENTS "graphics" "window" "system")
 
-# download extra libs  
-add_subdirectory(dependencies)   
+# download extra libs
+add_subdirectory(dependencies)
 
 if(WIN32)
   add_executable(SpaceCheckers WIN32 ${GAME_SRC} ${CMAKE_SOURCE_DIR}/resources/win-icon.rc)
   target_link_libraries(SpaceCheckers PRIVATE sfml-main)
-elseif(APPLE) 
+elseif(APPLE)
   include(${CMAKE_SOURCE_DIR}/cmake/macbundle.cmake)
   find_library(FOUNDATION_FRAMEWORK Foundation)
   target_link_libraries(SpaceCheckers PRIVATE ${FOUNDATION_FRAMEWORK})
-else() 
-  add_executable(SpaceCheckers ${GAME_SRC})     
-endif()   
+else()
+  add_executable(SpaceCheckers ${GAME_SRC})
+endif()
 
-# link all required libraries 
-target_link_libraries(SpaceCheckers PRIVATE sfml-graphics sfml-window sfml-system ImGui-SFML
-                        ixwebsocket spdlog::spdlog cpr::cpr simdjson::simdjson protobuf::libprotobuf)
+# link all required libraries
+target_link_libraries(
+  SpaceCheckers
+  PRIVATE sfml-graphics
+          sfml-window
+          sfml-system
+          ImGui-SFML
+          ixwebsocket
+          spdlog::spdlog
+          cpr::cpr
+          simdjson::simdjson
+          protobuf::libprotobuf)
 
 # include SFML headers
 target_include_directories(SpaceCheckers PUBLIC ${SFML_HOME}/include)
 
 # show warnings (depending on C++ compiler)
-if (MSVC) 
-  target_compile_options(SpaceCheckers PRIVATE /W4 /sdl /Qvec-report:1)
-else()  
-  target_compile_options(SpaceCheckers PRIVATE -Wall -Werror=constant-conversion) 
+if(MSVC)
+  target_compile_options(SpaceCheckers PRIVATE /W4 /sdl)
+else()
+  target_compile_options(SpaceCheckers PRIVATE -Wall -Werror=constant-conversion)
 endif()
- 
+
 # COPY resources folder to destination
-if (NOT APPLE)
-  add_custom_command( 
-    TARGET SpaceCheckers 
+if(NOT APPLE)
+  add_custom_command(
+    TARGET SpaceCheckers
     POST_BUILD
     COMMAND ${CMAKE_COMMAND} -E copy_directory ${PROJECT_SOURCE_DIR}/resources
             $<TARGET_FILE_DIR:SpaceCheckers>/resources)
-endif() 
+endif()

TODO.md

@@ -2,6 +2,8 @@
 
 - [ ] (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 panel.
+- [ ] highlight cell color blue after clicking a piece, reset when click srcCell = null
+- [ ] write unit tests using googletests
 
 ### (Extras) Standard CJK font paths
 
@@ -10,5 +12,5 @@
 - How to load CJK font in imGui:
 
 ```cpp
-ImFont* font = io.Fonts->AddFontFromFileTTF("/path/to/font.ext", 18.0f, nullptr, io.Fonts->GetGlyphRangesChineseFull());
-```
+    ImFont* font = io.Fonts->AddFontFromFileTTF("/path/to/font.file", 18.0f, nullptr, io.Fonts->GetGlyphRangesChineseFull());
+```

cmake/macbundle.cmake

@@ -4,21 +4,21 @@ set(application_icon "${CMAKE_SOURCE_DIR}/resources/${MACOSX_BUNDLE_ICON_FILE}")
 set_source_files_properties(${application_icon}
                             PROPERTIES MACOSX_PACKAGE_LOCATION "Resources")
 
-# images
-file(GLOB_RECURSE my_images "${CMAKE_SOURCE_DIR}/resources/*")
-foreach(FILE ${my_images}) 
-  get_filename_component(FILENAME ${FILE} DIRECTORY)
-  # SKIP .DS_Store files
+# images and fonts
+file(GLOB_RECURSE assets "${CMAKE_SOURCE_DIR}/resources/*")
+foreach(FILE ${assets}) 
+  get_filename_component(FILENAME ${FILE} NAME)
+  # skip .DS_Store files
   if (NOT FILENAME STREQUAL ".DS_Store")   
     file(RELATIVE_PATH NEW_FILE "${CMAKE_SOURCE_DIR}/" ${FILE})
-    get_filename_component(NEW_FILE_PATH ${NEW_FILE} DIRECTORY)
-    set_source_files_properties(${FILE} PROPERTIES MACOSX_PACKAGE_LOCATION "Resources/${NEW_FILE_PATH}")
+    get_filename_component(PARENT_DIR ${NEW_FILE} DIRECTORY) # parent dir
+    set_source_files_properties(${PARENT_DIR} PROPERTIES MACOSX_PACKAGE_LOCATION "Resources/${PARENT_DIR}")
   endif()
 endforeach()
 
 add_executable(${CMAKE_PROJECT_NAME} MACOSX_BUNDLE
                ${GAME_SRC} "${CMAKE_SOURCE_DIR}/src/utils/ResourcePath.mm" 
-               ${application_icon} "${my_images}")
+               ${application_icon} "${assets}") 
 
 set_target_properties(
   ${CMAKE_PROJECT_NAME}
@@ -31,4 +31,4 @@ set_target_properties(
              MACOSX_BUNDLE_COPYRIGHT "(c) 2024, Davis Tibbz"
              MACOSX_BUNDLE_BUNDLE_VERSION ${PROJECT_VERSION}
              MACOSX_BUNDLE_SHORT_VERSION_STRING ${PROJECT_VERSION}
-             RESOURCE "${my_images}")
+             RESOURCE "${assets}")

src/AppVersion.hpp

@@ -5,7 +5,7 @@
 
 // clang-format off
 namespace chk {
-  constexpr const char* APP_VERSION = "1.0.11";
+  constexpr const char* APP_VERSION = "1.0.12";
 }
 
 #endif // APP_VERSION_HPP

src/GameManager.hpp

@@ -82,11 +82,11 @@ class GameManager
     // collection of Player's next targets (Map<HunterPieceID, CaptureTarget>)
     std::unordered_map<short, chk::CaptureTarget> forcedMoves{};
 
-    [[nodiscard]] const bool isPlayerRedTurn() const;
+    [[nodiscard]] bool isPlayerRedTurn() const;
     [[nodiscard]] short getPieceFromCell(const int cell_idx) const;
     [[nodiscard]] const std::vector<chk::Block> &getBlockList() const;
     [[nodiscard]] bool isHunterActive() const;
-    [[nodiscard]] const bool isGameOver() const;
+    [[nodiscard]] bool isGameOver() const;
     void setSourceCell(const int src_cell);
     void doCleanup();
     void identifyTargets(const chk::PlayerPtr &hunter, const chk::Block &singleCell = nullptr);

src/Player.hpp

@@ -24,7 +24,7 @@ class Player final
     void losePiece(const short targetId);
     [[nodiscard]] const std::unordered_map<short, chk::PiecePtr> &getOwnPieces() const;
     void showMyHunters(const std::set<short> &hunterPieces) const;
-    void emptyBasket();
+    void clearBasket();
     [[nodiscard]] size_t getPieceCount() const;
     [[nodiscard]] const std::string &getName() const;
     [[nodiscard]] PlayerType getPlayerType() const;
@@ -89,7 +89,7 @@ inline void Player::showMyHunters(const std::set<short> &hunterPieces) const
 /**
  * Remove all pieces from this player's ownership
  */
-inline void Player::emptyBasket()
+inline void Player::clearBasket()
 {
     this->basket.clear();
 }

src/managers/GameManager.cpp

@@ -181,7 +181,7 @@ void GameManager::handleCapturePiece(const chk::PlayerPtr &hunter, const chk::Pl
  * Whether it's Red player's turn
  * @return TRUE or FALSE
  */
-const bool GameManager::isPlayerRedTurn() const
+bool GameManager::isPlayerRedTurn() const
 {
     return this->playerRedTurn;
 }
@@ -202,8 +202,8 @@ void chk::GameManager::doCleanup()
 {
     this->gameMap.clear();
     this->forcedMoves.clear();
-    this->playerRed->emptyBasket();
-    this->playerBlack->emptyBasket();
+    this->playerRed->clearBasket();
+    this->playerBlack->clearBasket();
     this->gameOver = true;
     this->alreadyCached = false;
     this->sourceCell = std::nullopt;
@@ -368,7 +368,7 @@ void chk::GameManager::showForcedMoves(const chk::PlayerPtr &player, const chk::
  * Whether game is over
  * @return TRUE or FALSE
  */
-const bool GameManager::isGameOver() const
+bool GameManager::isGameOver() const
 {
     return this->gameOver;
 }

src/managers/OnlineGameManager.hpp

@@ -96,7 +96,7 @@ inline void chk::OnlineGameManager::createAllPieces()
             {
                 if ((row + col) % 2 != 0)
                 {
-                    sf::CircleShape circle(0.5 * chk::SIZE_CELL);
+                    sf::CircleShape circle{0.5 * chk::SIZE_CELL};
                     const float x = static_cast<float>(col % NUM_COLS) * chk::SIZE_CELL;
                     circle.setPosition(sf::Vector2f{x, row * chk::SIZE_CELL});
                     if (row < 3 && blackItr != payload.pieces_black().end())