Pygame Checkers

The classic game of checkers implemented in Python.

Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

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.

(back to top)

Getting Started

To get Pygame Checkers up and running, follow these simple steps shown below.

Prerequisites

Before we get started, you will need to download some dependencies.

1. 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.
2. Pygame. To install pygame, simply run pip install pygame in a terminal.

Installation

1. Clone the repo.

   git clone https://github.com/PeanutButterRat/pygame-checkers.git

2. 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.

(back to top)

Usage

1. 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.

The main menu.

2. 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 while CPU will pit you against my the simple AI built for the game.

The options menu.

3. To play over the local network, click on Host to create a session or Join 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 use ipconfig for Windows users.

Here the user can input the host's IPv4 address.

4. 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.

A standard checkers game in-progress.

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Eric Brown - GitHub - ebrown5676@gmail.com

Project Link: https://github.com/PeanutButterRat/pygame-checkers

(back to top)