Termichess

A game of chess in your terminal. Built using the amazing TUI framework Textual.

Demo

termichess.v3.demo.mov

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

1. Please use Python 3.10 within your favourite venv. I have only tested currently only on python 3.10

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

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

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