Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miskibin/py-draughts
A checkers library with modern web GUI, Supprots multiple variants of game.
https://github.com/miskibin/py-draughts
ai alpha-beta-pruning checkers contributions-welcome draughts fastapi mini-max-algorithm open-to-collaborate reinforcement-learning
Last synced: 18 days ago
JSON representation
A checkers library with modern web GUI, Supprots multiple variants of game.
- Host: GitHub
- URL: https://github.com/miskibin/py-draughts
- Owner: miskibin
- License: gpl-3.0
- Created: 2023-06-26T16:37:44.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-28T21:17:07.000Z (about 1 year ago)
- Last Synced: 2025-01-20T17:24:32.342Z (21 days ago)
- Topics: ai, alpha-beta-pruning, checkers, contributions-welcome, draughts, fastapi, mini-max-algorithm, open-to-collaborate, reinforcement-learning
- Language: Python
- Homepage: https://michalskibinski109.github.io/py-draughts/
- Size: 5.34 MB
- Stars: 11
- Watchers: 4
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# py-draughts
[](https://github.com/michalskibinski109/checkers/actions/workflows/python-app.yml)
[](https://badge.fury.io/py/py-draughts)
[](https://pepy.tech/project/py-draughts)
Efficient modern and flexible implementation of the draughts game with a beautiful web interface.
Supports multiple variants of the game and allows playing against AI.
## Installation
```bash
pip install py-draughts
```
### [Documentation](https://miskibin.github.io/py-draughts/)
## Key features
- Displays simple ascii board for different variants of the game.
```python
>>> from draughts import get_board
>>> board = get_board('standard', "W:W4,11,28,31,K33,K34,38,40,K41,43,K44,45,K46,47:BK3,21,27,32")
>>> board
. . . . . B . w . .
. . . . . . . . . .
. w . . . . . . . .
. . . . . . . . . .
. b . . . . . . . .
. . b . w . . . . .
. w . b . W . W . .
. . . . w . . . w .
. W . . . w . W . w
W . w . . . . . . .
>>> board = get_board("american")
>>> board
. b . b . b . b
b . b . b . b .
. b . b . b . b
. . . . . . . .
. . . . . . . .
w . w . w . w .
. w . w . w . w
w . w . w . w .
```
- Make and undo moves
```python
>>> board.push_uci("31-27")
>>> board.pop() # undo last move
Move: 31->27
>>> board.turn
Color.WHITE
```
- detects draws and wins
> [!Important]
> Those methods are variant specific. Each variant has different set of them.
```python
>>> board.game_over
False
>>> board.is_threefold_repetition
False
>>> board.is_5_moves_rule
False
>>> board.is_16_moves_rule
False
>>> board.is_25_moves_rule
False
>>> board.is_draw
False
```
- Validate and generate moves
```python
>>> board.push_uci("31-22")
ValueError: 31-22 is correct, but not legal in given position.
Legal moves are: ['31-27', '31-26', '32-28', '32-27', '33-29', '33-28', '34-30', '34-29', '35-30']
>>> list(board.legal_moves)
['31-27', '31-26', '32-28', '32-27', '33-29', '33-28', '34-30', '34-29', '35-30']
```
- Reads and writes fen strings
- Writes PDN strings
```python
>>> board.push_uci("31-27")
>>> board.push_uci("32-28")
>>> board.push_uci("27-23")
>>> board.push_uci("28-24")
>>> board.pdn
'[GameType "20"]
[Variant "Standard (international) checkers"]
[Result "-"]
1. 31-27 32-28 2. 27-23 28-24'
```
```python
>>> board = get_board('standard', "W:W4,11,28,31,K33,K34,38,40,K41,43,K44,45,K46,47:BK3,21,27,32")
>>> board.fen
'[FEN "W:W4,11,28,31,K33,K34,38,40,K41,43,K44,45,K46,47:BK3,21,27,32"]'
```
- Has simple engine
```python
>>> from draughts.engine import AlphaBetaEngine
>>> engine = AlphaBetaEngine(depth=5)
>>> engine.get_best_move(board, with_evaluation=True)
Move: 28->37, 3.0
```
## UI
1. Allows to play against AI.
2. Allows to play vs another player. (on the same computer)
3. Allows to test and find bugs in your engine.
```python
python -m draughts.server.server
```
#### Use for testing your engine.
_Example with simplest possible engine._
```python
>>> from draughts import Server
>>> import numpy as np
>>> get_best_mv = lambda board: np.random.choice(list(board.legal_moves))
>>> server = Server(get_best_move_method=get_best_mv)
>>> server.run()
INFO: Started server process [1617]
INFO: Waiting for application startup.
INFO: Application startup complete.
INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
```
_It is as simple as that!_
> [!Warning]
> Server will not start when using _google colab_
---
## Contributing
Contributions to this project are welcome. If you encounter any issues or have suggestions for improvements, please open an issue or submit a pull request on the project repository.
## Bibliography
1. [Notation](https://en.wikipedia.org/wiki/Portable_Draughts_Notation)
2. [Rules and variants](https://en.wikipedia.org/wiki/Checkers)
3. [List of PDNs](https://github.com/mig0/Games-Checkers/)
4. [Draughts online](https://lidraughts.org/)
5. [Additional 1 (Checkers online)](https://checkers.online/play)
6. [Additional 2 (Chinook)](https://webdocs.cs.ualberta.ca/~chinook/play/notation.html)