https://github.com/otakuweber/chesspilot
Introducing an advanced chess bot that effortlessly automates gameplay on virtually every board configuration, delivering a seamless and immersive experience.
https://github.com/otakuweber/chesspilot
autocomplete automated automatic automation automove chess chess-ai chess-automove chess-autoplay chess-bot chess-cheat chess-database chess-engine chess-extension chess-game chess-hack chess-puzzle chess-stockfish python-chess stockfish
Last synced: about 2 months ago
JSON representation
Introducing an advanced chess bot that effortlessly automates gameplay on virtually every board configuration, delivering a seamless and immersive experience.
- Host: GitHub
- URL: https://github.com/otakuweber/chesspilot
- Owner: OTAKUWeBer
- License: mit
- Created: 2025-02-26T06:42:40.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-08-14T21:10:28.000Z (2 months ago)
- Last Synced: 2025-08-14T23:18:05.215Z (2 months ago)
- Topics: autocomplete, automated, automatic, automation, automove, chess, chess-ai, chess-automove, chess-autoplay, chess-bot, chess-cheat, chess-database, chess-engine, chess-extension, chess-game, chess-hack, chess-puzzle, chess-stockfish, python-chess, stockfish
- Language: Python
- Homepage:
- Size: 2.92 MB
- Stars: 16
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ChessPilot
A fully offline chess position evaluator and autoplayer for Windows and Linux, powered by ONNX and Stockfish.
---
## 🚀 Features
* **Automatic Stockfish Download**: Automatically detects your CPU and downloads the best Stockfish version—no manual setup required.
* **FEN Extraction**: Captures your board state with a local ONNX model ([Zai-Kun’s 2D Chess Detection](https://github.com/Zai-Kun/2d-chess-pieces-detection)).
* **Stockfish Analysis**: Integrates with the Stockfish engine to compute the optimal move.
* **Auto-Move Execution**: Plays the suggested move on your screen automatically.
* **Manual Play**: Click **“Play Next Move”** when you’re ready to proceed.
* **Board Flipping**: Supports playing as Black by flipping the board.
* **Castling Rights**: Toggle Kingside/Queenside castling.
* **Depth Control**: Adjust analysis depth via a slider (default: 15).
* **Retry Logic**: Retries failed moves up to three times.
* **ESC Shortcut**: Press **ESC** to reselect playing color at any time.
* **Cross-Platform GUI**: Built with Tkinter for simplicity.
* **100% Offline**: No external API calls—your data stays local.
---
## 📦 Download
👉 [Download the latest release](https://github.com/OTAKUWeBer/ChessPilot/releases/latest)
### Included in Binary Releases
The ONNX model (`chess_detectionv0.0.4.onnx`) is already bundled in official **AppImage**, **EXE**, and **DEB** builds.
Stockfish will be **downloaded automatically** on first run according to your CPU.
---
## 🔧 Engine Configuration (v1.0.1)
You can fine-tune Stockfish’s performance without touching any code.
Simply place an `engine_config.txt` file next to the ChessPilot executable:
```ini
# ================================
# ChessPilot Engine Configuration
# ================================
# Memory used in MB (64–1024+ recommended)
setoption name Hash value 512
# CPU threads to use (1–8; match your CPU core count)
setoption name Threads value 2
```
1. Edit `Hash` to adjust how much RAM (in MB) Stockfish uses.
2. Edit `Threads` to match your CPU cores.
3. Save and restart ChessPilot to apply the new settings.
---
## ⚙️ Prerequisites (For Source Builds / Raw File Users)
If you're running from source or using the **raw files** (not packaged AppImage/EXE/DEB), you need:
```bash
sudo apt install python3-tk # Ubuntu / Debian
sudo pacman -S tk # Arch Linux
sudo dnf install python3-tkinter # Fedora
```
Install Python dependencies:
```bash
pip install -r requirements.txt
```
* **Assets Needed (Source only)**:
1. [chess\_detectionv0.0.4.onnx](https://github.com/Zai-Kun/2d-chess-pieces-detection/releases/download/v0.0.4/chess_detectionv0.0.4.onnx)
> Stockfish will be downloaded automatically when you run ChessPilot.
> **Windows Raw File Users Only**: You may also need the Microsoft Visual C++ Redistributable if it's not already installed.
> [Download here](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170)
---
## 🛠️ Installation (From Source)
```bash
git clone https://github.com/OTAKUWeBer/ChessPilot.git
cd ChessPilot
pip install -r requirements.txt
# Add ONNX model if not using binary
```
---
## ▶️ Usage
From the project root:
```bash
python src/main.py
```
**Workflow**:
1. Choose **White** or **Black**.
2. Enable castling rights if needed.
3. Adjust analysis depth.
4. Select **Manual** or **Auto** play.
---
## đź’» Platform Support
* **Windows**: âś… Tested
* **Linux**: âś… Tested (including Wayland via `grim`)
* **macOS**: ❌ Untested (no macOS build; contributions welcome!)
---
## ⌨️ Shortcuts
See [SHORTCUTS.md](SHORTCUTS.md) for a full list of hotkeys and actions.
---
## 🤝 Contributing
Contributions are welcome! Please open an issue or submit a pull request.
---
## đź“ś License
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
---
## 🙏 Acknowledgments
* **Zai-Kun** for the ONNX chess piece detector.
* **Stockfish Team** for the world’s strongest open-source engine.
