Code reorganization, better code readability, new game features

[yufanana]

Reorganisation changes

• gui/: new package to contain GUI-related sections
• renamed custom_bots package to bots
• game_logic/player.py: split into separate files for human and each bot

General code modifications

• Formatted code with ruff
• Avoided the use of * star imports
• Added docstrings to classes and functions
• Added comments to explain the code
• Improved general readability
• pre-commit file to help code formatting

New features

• Path visualization: instead of highlighting the start and end piece only, the entire path taken by the piece is indicated with purple dots. this helps to track the performance of bots. The path is obtained using breadth-first-search, see getMovePath() in game_logic/game.py
• Turn indicator: to help keep track of game progress in the gameplay window, see gui/gui_helpers.py.
• Player names: to help keep track of players in the gameplay window, see gui/gui_helpers.py.
• Number of pieces: possible to start with 10 or 15 pieces, see game_logic/layout.py, configured in main.py.
• Layouts: possible to start with mirror or triangle layout, see game_logic/layout.py, configured in main.py.
• Autoplay: autoplay button to autoplay replays, see replayLoop() in gui/loops.py.
• 1-3 players: select 1-3 players instead of 2-3 players in loadPlayer window.
• 1-6 players: possible to have up to 6 players if the players are loaded in another way besides from the loadPlayer window.

[henrychess]

Hey, thanks for contributing to my (now not working on) hobby project! I didn't expect this to have a pull request as it's just a small coding practice that doubled as a final project for a class 🤣 I'll look at the code tomorrow, but I have to wait until Saturday to test it on my computer. Henry PS. Are you from Taiwan?

…

On Mon, Apr 1, 2024, 21:21 yufan ***@***.***> wrote: Reorganisation changes - gui/: new package to contain GUI-related sections - renamed custom_bots package to bots - game_logic/player.py: split into separate files for human and each bot General code modifications - Formatted code with ruff - Avoided the use of * star imports - Added docstrings to classes and functions - Added comments to explain the code - Improved general readability - pre-commit file to help code formatting New features - *Path visualization*: instead of highlighting the start and end piece only, the entire path taken by the piece is indicated with purple dots. this helps to track the performance of bots. The path is obtained using breadth-first-search, see getMovePath() in game_logic/game.py - *Turn indicator*: to help keep track of game progress in the gameplay window, see gui/gui_helpers.py. - *Player names*: to help keep track of players in the gameplay window, see gui/gui_helpers.py. - *Number of pieces*: possible to start with 10 or 15 pieces, see game_logic/layout.py, configured in main.py. - *Layouts*: possible to start with mirror or triangle layout, see game_logic/layout.py, configured in main.py. - *Autoplay*: autoplay button to autoplay replays, see replayLoop() in gui/loops.py. - *1-3 players*: select 1-3 players instead of 2-3 players in loadPlayer window. - *1-6 players*: possible to have up to 6 players if the players are loaded in another way besides from the loadPlayer window. ------------------------------ You can view, comment on, or merge this pull request online at: #3 Commit Summary - 946d072 <946d072> Code reorganization, better code readability, new game features File Changes (29 files <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files>) - *A* .gitignore <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-bc37d034bad564583790a46f19d807abfe519c5671395fd494d8cce506c42947> (11) - *A* .pre-commit-config.yaml <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-63a9c44a44acf85fea213a857769990937107cf072831e1a26808cfde9d096b9> (39) - *M* README.md <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5> (2) - *R* bots/BotTemplate.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-d3c7454bca3f4e9fedfa06076e64ad4c6e38c125fd03585e576d25c9c12b58c0> (23) - *A* bots/GreedyBot0.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-b5577eb245d55ada38ad3a51d6948f23378bce4d1f2f14cd35b7679bb153aaae> (64) - *A* bots/GreedyBot1.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-975db9a63a7fc570b396225602d311ce60026f5ba38dc718be6ea97c14d51637> (86) - *A* bots/GreedyBot2.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-2238d5c657a251c6c4bbd57059737179cdc174095e0dc408953425d39ef0b9a4> (75) - *R* bots/README.md <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-054a2e2a6e2d5206cd32e5046440f1aeaf4158f23e25e2f4c0d95acb389119c9> (0) - *A* bots/RandomBot.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-06e4ef5751c3f999fc22a0030eaeab48d1834cc72199201f9a3b666c832e4c58> (33) - *A* bots/__init__.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-60d4596ef21f272145824a76c5404b8337a259b4f4ec76f654d984b58399837a> (13) - *M* coor_display.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-d207113ccb905f599de847fd626187576974c627aade288434caf1e1ba31ad1e> (89) - *D* custom_bots/__init__.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-55be90dbfa78b56d55dd2e467a5a476e6d141db646ead318a70463db47d9fedd> (7) - *M* game_logic/game.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-16b53360b7f724caeeaf1bf5ed7ad7c6efa301a04605cde771ec3a0862d1959a> (423) - *M* game_logic/helpers.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-02f28d8f919078b73653eb0fd18577ae0b8a9048d35d5565a6b536718c37ea4e> (305) - *A* game_logic/human.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-8176ecada2190bdbee38d4f5a06270789add6d4f001e9aae0a2d252af0b8109c> (200) - *A* game_logic/layout.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-2a97dc90e7345a2cc577d5f7cf2b4379e331d42ae015136b355b1f7da4efe3e3> (371) - *D* game_logic/literals.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-5eda5a915112a9b44cd748b1117ec63a1ea897dbe3c676cee83f14d60122c151> (93) - *D* game_logic/loops.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-e129e802d273205f100268df9f8f9425ab19e6891dac3d04053d9802f26d48b2> (469) - *M* game_logic/piece.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-683b5e0f523f8993398e0602f4623857ad68672267c1531daec76ab9e624ccbd> (15) - *M* game_logic/player.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-66490556537088e92bd438258879dae59a18dc3b2f6c8e6296d59b14637779b2> (247) - *A* gui/__init__.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-1385881a0fb33d9b61b390b2ae5cd9af7702434c6a005b6e854ed4862b5ea43e> (0) - *A* gui/constants.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-b0293caec909a7e332cbce484fc3ada3eb081be9e4f879b5f2edc55aa53dae2c> (68) - *A* gui/gui_helpers.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-2ea6cbd4c191ed2b8542cc226c001e239c1ee108654bef3e891549c42e36f0ec> (397) - *A* gui/loops.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-efe475e17b81400d1531189ffec3f8fb50b554f8eb29b1bbc9359e8fb495b5ad> (872) - *M* main.py <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-b10564ab7d2c520cdd0243874879fb0a782862c3c902ab535faabe57d5a505e1> (37) - *A* replays/2_player_replay.txt <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-74553b1123fa8c5c610fa01e359c21f29c0b2ad8e29f26bc5313f5892ae3e92b> (126) - *A* replays/3_player_replay.txt <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-98fb518ac6e195507845ae1d588575ef1a3fac27d4ed702d00db548ac3183063> (177) - *D* replays/replay-20231029-213732.txt <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-55c16f653c90c7c957a084406f7903de64ffcd703e22650d7fb6d3a7c69a15cb> (188) - *D* replays/replay-20231029-214014.txt <https://github.com/henrychess/pygame-chinese-checkers/pull/3/files#diff-1c887dbfa9750bbbba191b54afc55cbeec55d36d178b253bf50b691f0ba23be7> (120) Patch Links: - https://github.com/henrychess/pygame-chinese-checkers/pull/3.patch - https://github.com/henrychess/pygame-chinese-checkers/pull/3.diff — Reply to this email directly, view it on GitHub <#3>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AV3HMIEARQDH4RCZ434LDRDY3FNPDAVCNFSM6AAAAABFRTKQNGVHI2DSMVQWIX3LMV43ASLTON2WKOZSGIYTQMRUGYYTMOA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[yufanana]

Hi, your repository was very helpful for a course that I am taking at the Technical University of Denmark. My group used it for a project, and made some improvements to it, so it was not a big issue to create a pull request and contribute back to the repository. Take your time to review the pull request, and hopefully you can take away a few of the good coding practices that you see. Thanks again :)

[henrychess]

Hey, I see a bug!

This occurs when I try to change the number of players to 1 or 2:

Traceback (most recent call last):
  File "/Users/andytseng/Downloads/pygame-chinese-checkers-yufanana/gui/loops.py", line 242, in <lambda>
    lambda: setItem(
  File "/Users/andytseng/Downloads/pygame-chinese-checkers-yufanana/game_logic/helpers.py", line 70, in setItem
    list_[index] = item
IndexError: list assignment index out of range
[<bots.GreedyBot2.GreedyBot2 object at 0x7fa599d4d130>]
Traceback (most recent call last):
  File "/Users/andytseng/Downloads/pygame-chinese-checkers-yufanana/gui/loops.py", line 227, in <lambda>
    rButton_2P.toggled.connect(lambda: setItem(self.playerList, 2, None))
  File "/Users/andytseng/Downloads/pygame-chinese-checkers-yufanana/game_logic/helpers.py", line 70, in setItem
    list_[index] = item
IndexError: list assignment index out of range
[<bots.GreedyBot2.GreedyBot2 object at 0x7fa599d4d130>]

The game does not crash on this error message; however, if I click play, there is only one player present.

Also, the option to switch between 10/15 pieces per player is missing, and the buttons are somehow not responding to mouse hover.

Btw the trainingLoop is intended for a possible expansion to make machine learning easier on this game. It's a GUIless gameplay loop which returns all the necessary numbers.

That's all the things I have for this pull request for now, but maybe I'll find some more issues or explain some more stuff later on.