X-Git-Url: http://winboard.nl/cgi-bin?a=blobdiff_plain;f=engine-intf.html;h=bd6bcd798054c0001e7ce458f24310f5eda1faa5;hb=262a1501c25d57e39848d21647e607c8319c2088;hp=8b401ae12b0e72fe9b03ea1b08b2e4cb89378a8d;hpb=7b4dacf6fe9f8c10b6eb4d6070869a3d933dbeb5;p=xboard.git diff --git a/engine-intf.html b/engine-intf.html index 8b401ae..bd6bcd7 100644 --- a/engine-intf.html +++ b/engine-intf.html @@ -6,13 +6,12 @@
Version 2; implemented in xboard/WinBoard 4.2.1 and later.
Changes since version 1 are indicated in red.
Changes for WinBoard 4.3.xx are indicated in green.
-Proposed changes, implemented only in alpha versions are indicated in blue.
+Changes for WinBoard 4.4.xx are indicated in blue.
@@ -1454,7 +1455,7 @@ and will not send any "egtpath" commands to inform the engine about their wherea
This feature is used by the engine to define an option command to appear in a GUI menu,
so that the user can change the corresponding setting of the engine through the GUI.
The string describes the option by defining a name, type, current value and (sometimes) the acceptable value range.
-There are six different options types, each requiring a slighly different syntax of the defining string:
+There are nine different options types, each requiring a slighly different syntax of the defining string:
feature option="NAME -button"
@@ -1468,11 +1469,27 @@ feature option="NAME -spin VALUE MIN MAX"
feature option="NAME -combo CHOICE1 /// CHOICE2 ..."
+feature option="NAME -slider VALUE MIN MAX"
+
+feature option="NAME -file VALUE"
+
+feature option="NAME -path VALUE"
+
NAME is an arbitrary alphanumeric string which can contain spaces;
-the oter words in capitals would be replaced by the current (default) setting of the option,
+the other words in capitals would be replaced by the current (default) setting of the option,
+(a character string for -string options, a decimal number for -spin and -check options,
+were the latter uses 1=checked, 0=unchecked),
the minimum or maximum value of numeric (-spin) options,
or arbitrary text labels (for -combo option).
-In the latter cae, the current value will be preceded by an asterisk.
+In the latter case, the current value will be preceded by an asterisk.
+The -file and -path options are similar to -string, but can be used to inform the GUI that
+the text represents a file name or folder name respectively, so the GUI dialog to set it
+could add the appropriate browse button to the text-edit field.
+Similarly, a -slider option is like a -spin, but the GUI might make a different
+graphical representation for it.
+A -save option is like a -button, and defines an immediate command to be sent by the engine.
+With -save the GUI will make sure all current option settings are flushed to the engine
+before it sends this command.
+ +Note that (in accordance with FIDE rules) only KK, KNK, KBK and KBKB with all bishops on the +same color can be claimed as draws on the basis of insufficient mating material. +The end-games KNNK, KBKN, KNKN and KBKB with unlike bishops do have mate positions, +and cannot be claimed. +Complex draws based on locked Pawn chains will not be recognized as draws by most interfaces, +so do not claim in such positions, but just offer a draw or play on. + +
+ Note to GUI programmers: RESULT commands that the engine sends immediately after its move might be detected by the GUI only after the opponent has moved, because of communication and scheduling delays, no matter how fast the engine sent it. Any judgement of the validity of RESULT claims based on te "current" board position will have to account for this uncertainty. +