A draughts library for Python, with move generation and validation, PDN parsing and writing. Supprots multiple variants of game.
Project description
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
pip install py-draughts
Key features
- Provides beautiful web interface for testing your engine/playing against AI.
- Supports multiple variants of the game (with different board size).
standard
,american
etc. - Follows international draughts standards. like
fen
pdn
etc. - Allows to easily create new variants of the game. by extending the
Board
class. - Accurate documentation generated from code.
Documentation
Usage
Displays simple ascii board
>>> from draughts.standard import Board
>>> board = Board()
Board initialized with shape (10, 10). (base.py:108)
>>> board
. b . b . b . b . b
b . b . b . b . b .
. b . b . b . b . b
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
w . w . w . w . w .
. w . w . w . w . w
w . w . w . w . w .
Make and undo moves
>>> board.push_from_str("37-32")
>>> board.push_from_str("14-19")
>>> board.push_from_str("32-28")
>>> board.push_from_str("19-23")
>>> board.pop() # undo last move
>>> board.push_from_str("19-23")
>>> board.push_from_str("28x19")
>>> board
. b . b . b . b . b
b . b . b . b . b .
. b . b . b . . . b
. . . . . . w . . .
. . . . . . . . . .
. . . . . . . . . .
. . . . . . . . . .
w . . . w . w . w .
. w . w . w . w . w
w . w . w . w . w .
Generate legal moves and validate moves
>>> board.push_from_str("10x42")
Move: 10->42 is correct, but not legal in given position.
Legal moves are: [Move: 36->31, Move: 37->32, Move: 37->31, Move: 38->33, Move: 38->32, Move: 39->34, Move: 39->33, Move: 40->35, Move: 40->34]
>>> list(board.legal_moves)
[Move: 36->31, Move: 37->32, Move: 37->31, Move: 38->33, Move: 38->32, Move: 39->34, Move: 39->33, Move: 40->35, Move: 40->34]
Generate fen string and load board from fen string
>>> board =Board.from_fen("W:W4,11,28,31,K33,K34,38,40,K41,43,K44,45,K46,47:BK3,21,27,32")
Board initialized with shape (10, 10). (base.py:109)
>>> board.push_from_str("28-37")
>>> board.fen
'[FEN "B:W4,11,31,K33,K34,37,38,40,K41,43,K44,45,K46,47:BK3,21,27"]'
American checkers
>>> from draughts.american import Board
>>> board = Board()
Board initialized with shape (8, 8). (base.py:108)
>>> 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 .
UI
from draughts.server import Server
Server().run()
Use for testing your engine.
Example with simplest possible engine.
>>> server = Server(get_best_move_method=lambda board: np.random.choice(list(board.legal_moves)))
>>> 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!
Legal moves for selected square (on image "16")
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
py-draughts-0.9.9.tar.gz
(32.3 kB
view hashes)
Built Distribution
Close
Hashes for py_draughts-0.9.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a18a2c25c9c6368dc3fa3c759050ef961b071d57a254570fe4c898ea17fd8d89 |
|
MD5 | c93c6b38fade620bc359cf9fecb4c5d5 |
|
BLAKE2b-256 | 864046f192b3c88bb180f27a97c38893d3eb51a0d33cef62e61be76474ab004c |