pydraughts 0.3.0

A draughts library for Python with move generation, PDN reading and writing and engine communication

pydraughts

pydraughts is a draughts library for Python with move generation, PDN reading and writing and engine communication. It is based on ImparaAI/checkers.

Installing

Download and install the latest release:

pip install pydraughts

Features

Note: White always starts. Black always has the squares starting from 1 (e.g. 1-20 in international draughts).

Variants:

• Standard (International)
• Frisian
• frysk!
• Antidraughts
• Breakthrough
• Russian
• Brazilian
• English/American
• Italian

Engine protocols:

• Hub
• DXP
• CheckerBoard

PDN Reading and Writing

• Import library

from draughts import Game, Move

• Create a game

game = Game(variant="standard", fen="startpos")

• Make a move

game.move([34, 30])

• Get legal moves

moves, captures = game.legal_moves()

• Convert move to other types

move = Move(game, board_move=moves[0]).pdn_move

• Get fen

fen = game.get_li_fen()

• Communicate with engines

from draughts.engine import HubEngine, Limit
engine = HubEngine("scan.exe hub")
engine.init()
limit = Limit(time=10)
engine_move = engine.play(game, limit, ponder=False)

• Read PDN games

from draughts.PDN import PDNReader
games = PDNReader(filename=filepath)
game = games.games[0]
moves = game.moves

• Write PDN games

from draughts.PDN import PDNWriter
games = PDNWriter(filename=filepath, board=game)

Acknowledgements

Thanks to RoepStoep for his draughtsnet which was modified to add support for Hub engines. Thanks to akalverboer for their DXC100_draughts_client which was modified to add support for DXP engines.

License

pydraughts is licensed under the GPL 3 (or any later version at your option). Check out LICENSE.txt for the full text. The license of ImparaAI/checkers is also present here.