Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/healeycodes/andoma
♟️ A chess engine with alpha-beta pruning, piece-square tables, move ordering, and command-line UI.
https://github.com/healeycodes/andoma
alpha-beta-pruning bot chess chess-engine lichess move-ordering piece-square-tables uci
Last synced: 3 days ago
JSON representation
♟️ A chess engine with alpha-beta pruning, piece-square tables, move ordering, and command-line UI.
- Host: GitHub
- URL: https://github.com/healeycodes/andoma
- Owner: healeycodes
- License: mit
- Created: 2020-11-16T17:29:30.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-03-24T00:28:14.000Z (over 1 year ago)
- Last Synced: 2024-12-06T22:43:12.392Z (16 days ago)
- Topics: alpha-beta-pruning, bot, chess, chess-engine, lichess, move-ordering, piece-square-tables, uci
- Language: Python
- Homepage: https://healeycodes.com/building-my-own-chess-engine/
- Size: 125 KB
- Stars: 154
- Watchers: 9
- Forks: 27
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/healeycodes/andoma/actions/workflows/python-app.yml)
# ♟ Andoma
> My blog post: [Building My Own Chess Engine](https://healeycodes.com/building-my-own-chess-engine/)
A chess engine which implements:
- [Alpha-beta pruning](https://en.wikipedia.org/wiki/Alpha%E2%80%93beta_pruning) for move searching
- [Move ordering](https://www.chessprogramming.org/Move_Ordering) based off heuristics like captures and promotions
- Tomasz Michniewski's [Simplified Evaluation Function](https://www.chessprogramming.org/Simplified_Evaluation_Function) for board evaluation and piece-square tables
- A slice of the Universal Chess Interface (UCI) to allow challenges via lichess.org
- A command-line user interface
It uses Python 3.8 with Mypy type hints and unit + integration tests.
See [Contributing](#contributing) to help out!
## Install
`pip install -r requirements.txt`
## Use it via command-line
Start the engine with:
`python ui.py`
```bash
Start as [w]hite or [b]lack:
w
8 ♖ ♘ ♗ ♕ ♔ ♗ ♘ ♖
7 ♙ ♙ ♙ ♙ ♙ ♙ ♙ ♙
6 · · · · · · · ·
5 · · · · · · · ·
4 · · · · · · · ·
3 · · · · · · · ·
2 ♟ ♟ ♟ ♟ ♟ ♟ ♟ ♟
1 ♜ ♞ ♝ ♛ ♚ ♝ ♞ ♜
a b c d e f g h
Enter a move like g1h3:
```
## Use it as a UCI engine
_The only interfaces that Andoma currently supports are [ShailChoksi/lichess-bot](https://github.com/ShailChoksi/lichess-bot) and the command-line UI (ui.py). Debug information and configuration options are minimal compared to a full UCI engine._
Start the engine with:
`python main.py`
An example interaction with the engine (responses have `#`):
```bash
uci
# id name Andoma
# id author Andrew Healey & Roma Parramore
# uciok
position startpos moves e2e4
go
# bestmove g8f6
```
Also accepts a FEN string:
`position fen rnbqk1nr/p1ppppbp/1p4p1/8/2P5/2Q5/PP1PPPPP/RNB1KBNR b KQkq - 0 1`
See the [UCI interface doc](https://github.com/healeycodes/andoma/blob/main/uci-interface.md) for more information on communicating with the engine.
## Lichess.org
The UCI protocol slice that's implemented by this engine means you can play it via lichess.org by using [ShailChoksi/lichess-bot](https://github.com/ShailChoksi/lichess-bot) (a bridge between Lichess API and chess engines) and a BOT account.
The engine file required by `lichess-bot` may be generated using [pyinstaller](https://www.pyinstaller.org/).
## Tests
There are unit tests for the engine, UI, and evaluation modules. Mate-in-two/mate-in-three puzzles are being added.
`python -m unittest discover test/`
Type hints:
`pip install -r requirements-dev.txt`
`mypy .`
## Contributing
Raise an issue to propose a bug fix or feature (or pick up an existing one).
I ([@healeycodes](https://github.com/healeycodes)) am happy to help you along the way.
For coding style: look at the existing files, use Mypy types, use PEP8, and add a test for any change in functionality.
Please run the tests locally before submitting a PR.