Table of Contents
Pygame Checkers is a fully functional GUI version of checkers that you can play with other people. It supports local play against another person or CPU but also includes LAN functionality to play with another person over the same network.
To get Pygame Checkers up and running, follow these simple steps shown below.
Before we get started, you will need to download some dependencies.
- Python: Version 3.10+. You can most likely use a different version of Python, but I can guarantee it runs with at least Python 3.10.
- Pygame. To install pygame, simply run
pip install pygame
in a terminal.
-
Clone the repo.
git clone https://github.com/PeanutButterRat/pygame-checkers.git
-
Run
main.py
.cd pygame-checkers # You should now be in the repo directory. python src/main.py
Alternatively, you can simply download the executable from the releases page found here if you are running Windows.
- To play Pygame checkers, run
main.py
or the pre-bundled executable. After running the program, you should be greeted with the screen shown below.
- To play locally, click on
Local
which should greet you with some options for configuring the intial board state.Human Player
will allow two players to play on the same computer whileCPU
will pit you against my the simple AI built for the game.
- To play over the local network, click on
Host
to create a session orJoin
to join a session.Join
will bring you to a screen where you can input the host's IPv4 address. The easiest way is find the address is to useipconfig
for Windows users.
- Once in a game, you can click on a pawn to move it during your turn. Upon reaching the opposite side of the board, your pawn will turn into a king allowing it to move in all diagonal directions. To make multiple jumps, perform each jump individually before ending your turn. At the end of your turn, you can click
End Turn
to give control over to the other player. Right-click will cancel your current move if you change your mind mid-jump. Finally,Forfeit
will end the game and give victory to the opponent.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with and present your idea there. I don't forsee anyone feeling inspired enough to contribute, but any contributions are greatly appreciated if you do decide to do so!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Eric Brown - GitHub - ebrown5676@gmail.com
Project Link: https://github.com/PeanutButterRat/pygame-checkers