A chess game on your terminal
Project description
████████╗███████╗██████╗ ███╗ ███╗██╗ ██████╗██╗ ██╗███████╗███████╗███████╗
╚══██╔══╝██╔════╝██╔══██╗████╗ ████║██║██╔════╝██║ ██║██╔════╝██╔════╝██╔════╝
██║ █████╗ ██████╔╝██╔████╔██║██║██║ ███████║█████╗ ███████╗███████╗
██║ ██╔══╝ ██╔══██╗██║╚██╔╝██║██║██║ ██╔══██║██╔══╝ ╚════██║╚════██║
██║ ███████╗██║ ██║██║ ╚═╝ ██║██║╚██████╗██║ ██║███████╗███████║███████║
╚═╝ ╚══════╝╚═╝ ╚═╝╚═╝ ╚═╝╚═╝ ╚═════╝╚═╝ ╚═╝╚══════╝╚══════╝╚══════╝
Play a game of chess right in your terminal. Built using the amazing TUI framework Textual
.
Demo
https://github.com/user-attachments/assets/dff88fdc-95af-4441-8ad6-2e88cec04e35
Features
- ♟️ Play chess right in your terminal
- 🧠 Stockfish integration for chess engine
- ✅ Move validation and legal move highlighting
- 🎨 Change board themes
- 🤓 Variety of geeky board pieces
- ⚙️ Configuration menu for different options to change on the fly
Installation
-
Please use Python 3.10 within your favourite venv. I have only tested currently only on
python 3.10
-
Install Stockfish:
- On Ubuntu or Debian:
sudo apt-get install stockfish
- On macOS with Homebrew:
brew install stockfish
- On Windows, download from Stockfish's official website and add it to your system PATH.
- On Ubuntu or Debian:
-
Install TermiChess:
pip install termichess
Running the Game
After installation, you can start the game by simply running:
termichess
- To exit out at any time , Press
q
. - To restart the game click on the
Restart
button
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the Apache License - see the LICENSE file for details.
Acknowledgments
- Textual for the TUI framework
- python-chess for chess logic
- Stockfish for the chess engine
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file termichess-0.1.3.tar.gz
.
File metadata
- Download URL: termichess-0.1.3.tar.gz
- Upload date:
- Size: 36.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbae2bd9983ed6a29c9d803551f2ff13b5e4c47056c102021b15784b33278d31 |
|
MD5 | ed69ca1ea9ffb4d9e48dcf30cc03f941 |
|
BLAKE2b-256 | e4194e6a0022070ba77d5f7d57285b4b28111da2cb6118dfb56f2fc6bf1d0265 |
File details
Details for the file termichess-0.1.3-py3-none-any.whl
.
File metadata
- Download URL: termichess-0.1.3-py3-none-any.whl
- Upload date:
- Size: 41.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.15
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 044c0c7ba819396c07cf70d0449bcc72648dd948200b49964faf17e2b7a4b1e4 |
|
MD5 | 28759ab8067d3bbe9d44646bf72bb827 |
|
BLAKE2b-256 | 36580444d23a414d0847e1c64cf10173de44eddb096ae45fb2be4349b04064c9 |