Amendment for documentation update (#30)
authorFabian Fichter <ianfab@users.noreply.github.com>
Fri, 11 Oct 2019 13:14:19 +0000 (15:14 +0200)
committerFabian Fichter <ianfab@users.noreply.github.com>
Fri, 11 Oct 2019 13:14:19 +0000 (15:14 +0200)
src/variants.ini

index df8c78a..c57abc8 100644 (file)
 # [int]: any natural number [0, 1, ...]
 # [PieceType]: a piece type [letters defined for pieces, e.g., p]
 # [Bitboard]: list of squares [e.g., d4 e4 d5 e5]
-# [Value]: game result [win, loss, draw]
+# [Value]: game result for the side to move [win, loss, draw]
 # [CountingRule]: makruk or ASEAN counting rules [makruk, asean, none]
 
 ### Rule definition options
-# variantTemplate: only relevant for XBoard/WinBoard [values: fairy, shogi] (default: fairy)
-# pocketSize: number of pockets shown by XBoard/WinBoard for drop variants (default: 0)
+# variantTemplate: only relevant for usage in XBoard/WinBoard GUI [values: fairy, shogi] (default: fairy)
+# pocketSize: number of pockets shown by XBoard/WinBoard for drop variants [int] (default: 0)
 # maxRank: maximum rank [Rank] (default: 8)
 # maxFile: maximum file [File] (default: 8)
 # chess960: allow chess960 castling [bool] (default: false)
 # nFoldValue: [Value] (default: draw)
 # nFoldValueAbsolute: [bool] (default: false)
 # perpetualCheckIllegal: [bool] (default: false)
-# stalemateValue: (win/draw/loss)
-# checkmateValue: (win/draw/loss)
+# stalemateValue: [Value] (default: draw)
+# checkmateValue: [Value] (default: loss)
 # shogiPawnDropMateIllegal: [bool] (default: false)
 # shatarMateRule: [bool] (default: false)
 # bareKingValue: [Value] (default: <none>)