Termichess
A game of chess in your terminal. Built using the amazing TUI framework Textual.
Demo
https://github.com/user-attachments/assets/305f1e5b-9c76-474f-b30e-5bee12ac3be8
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
Restartbutton
Running via Docker
You can also run termichess via Docker if that's what you prefer.
docker run -it ghcr.io/whiletruelearn/termichess:latest termichess
Note : Please keep sound config to off while using docker
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
1 maintainer
Metadata
1 maintainer
Release files for termichess 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| termichess-0.1.4.tar.gz | 68.5 kB | Without provenance | Details for termichess-0.1.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| termichess-0.1.4-py3-none-any.whl | Python 3 | none | any | Details for termichess-0.1.4-py3-none-any.whl |
Total release size: 141.6 kB
Release files / termichess-0.1.4.tar.gz
| Download URL | termichess-0.1.4.tar.gz |
|---|---|
| Size | 68.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7bd11c9bd6d13334713097f865beeb086b0108496392d9062269bcf66f996d5b
|
|
BLAKE2b-256 checksum How to use checksums |
342a6200361fce3f3d8fedfc5f98c506397c473498f54feaf6c69904e45ae80e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.15
|
Release files / termichess-0.1.4-py3-none-any.whl
| Download URL | termichess-0.1.4-py3-none-any.whl |
|---|---|
| Size | 73.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bc10b205426e0f92bfdade2e4166bcf48fe2283a7cd999a70138cde27fbb15fb
|
|
BLAKE2b-256 checksum How to use checksums |
f351da9c912d0312acc86ec86f14fc6d2f5106b21a1a377ce903f9eb415a7a3a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.15
|
Security for termichess 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
