-
Notifications
You must be signed in to change notification settings - Fork 27
/
README.md
114 lines (70 loc) · 3.12 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
[](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/)
<br>
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!
<br>
## Install
`pip install -r requirements.txt`
<br>
## 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:
```
<br>
## 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._
<br>
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`
<br>
See the [UCI interface doc](https://github.com/healeycodes/andoma/blob/main/uci-interface.md) for more information on communicating with the engine.
<br>
## 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/).
<br>
## 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 .`
<br>
## 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.