Skip to content

Commit 3d43926

Browse files
committed
Update variant.rst with XBoard
1 parent d8d2109 commit 3d43926

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

docs/variant.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ python-chess supports several chess variants.
1010
>>> # General information about the variants
1111
>>> type(board).uci_variant
1212
'giveaway'
13+
>>> type(board).xboard_variant
14+
'giveaway'
1315
>>> type(board).starting_fen
1416
'rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w - - 0 1'
1517

@@ -18,9 +20,9 @@ See :func:`chess.Board.is_variant_end()`, :func:`~chess.Board.is_variant_win()`
1820
for special variant end conditions and results.
1921

2022
================ ========================================= ============= ============
21-
Variant Board class UCI Syzygy
23+
Variant Board class UCI/XBoard Syzygy
2224
================ ========================================= ============= ============
23-
Standard :class:`chess.Board` chess .rtbw, .rtbz
25+
Standard :class:`chess.Board` chess/normal .rtbw, .rtbz
2426
Suicide :class:`chess.variant.SuicideBoard` suicide .stbw, .stbz
2527
Giveaway :class:`chess.variant.GiveawayBoard` giveaway .gtbw, .gtbz
2628
Atomic :class:`chess.variant.AtomicBoard` atomic .atbw, .atbz
@@ -46,16 +48,16 @@ See :func:`chess.BaseBoard.set_chess960_pos()`,
4648
:func:`~chess.BaseBoard.from_chess960_pos()` for dealing with Chess960 starting
4749
positions.
4850

49-
UCI
50-
---
51+
UCI/XBoard
52+
----------
5153

5254
`Multi-Variant Stockfish`_ and other engines have an ``UCI_Variant`` option.
5355
XBoard engines may declare support for ``variants``.
5456
This is automatically managed.
5557

5658
>>> import chess.engine
5759
>>>
58-
>>> engine = chess.engine.SimpleEngine.popen_uci("stockfish")
60+
>>> engine = chess.engine.SimpleEngine.popen_uci("stockfish-mv")
5961
>>>
6062
>>> board = chess.variant.RacingKingsBoard()
6163
>>> result = engine.play(board, chess.engine.Limit(time=1.0))

0 commit comments

Comments
 (0)