fixed premove recapture problem;promotion popup appearing on obviously illegal moves...
[xboard.git] / engine-intf.html
1 <html>\r
2 <head>\r
3 <title>Chess Engine Communication Protocol</title>\r
4 </head>\r
5 \r
6 <body>\r
7 <hr noshade size="2">\r
8 <h1>Chess Engine Communication Protocol</h1>\r
9 <h2><a href="">Tim Mann</a> &amp; <a href="">H.G.Muller</a></h2>\r
10 <p>\r
11 Version 2; implemented in xboard/WinBoard 4.2.1 and later. (Sept 3, 2009)<br>\r
12 Changes since version 1 are indicated in <font color=red>red</font>.<br>\r
13 Changes for WinBoard 4.3.xx are indicated in <font color=green>green</font>.<br>\r
14 Changes for WinBoard 4.4.xx are indicated in <font color=blue>blue</font>.\r
15 <hr noshade size="2">\r
16 \r
17 <ul>\r
18 <li><a href="#1">1. Introduction</a>\r
19 <li><a href="#2">2. Connection</a>\r
20 <li><a href="#3">3. Debugging</a>\r
21 <li><a href="#4">4. How it got this way</a>\r
22 <li><a href="#5">5. WinBoard requires Win32 engines</a>\r
23 <li><a href="#6">6. Hints on input/output</a>\r
24 <li><a href="#7">7. Signals</a>\r
25 <li><a href="#8">8. Commands from xboard to the engine</a>\r
26 <li><a href="#9">9. Commands from the engine to xboard</a>\r
27 <li><a href="#10">10. Thinking Output</a>\r
28 <li><a href="#11">11. Time control</a>\r
29 <li><a href="#12">12. Analyze Mode</a>\r
30 <li><a href="#13">13. Idioms and backward compatibility features</a>\r
31 </ul>\r
32 \r
33 <hr noshade size="2">\r
34 \r
35 <h2><a name="1">1. Introduction</a></h2>\r
36 \r
37 <p>\r
38 This document is a set of rough notes on the protocol that xboard and\r
39 WinBoard use to communicate with gnuchessx and other chess engines.\r
40 These notes may be useful if you want to connect a different chess\r
41 engine to xboard.  Throughout the notes, "xboard" means both xboard\r
42 and WinBoard except where they are specifically contrasted.\r
43 </p>\r
44 \r
45 <p>\r
46 There are two reasons I can imagine someone wanting to do this: \r
47 </p>\r
48 <ol>\r
49 <li>You have, or are developing, a chess engine but you don't want to\r
50 write your own graphical interface. \r
51 <li>You have, or are developing,a chess engine, and you want to\r
52 interface it to the Internet Chess Server.\r
53 </ol>\r
54 \r
55 <p>\r
56 In case (2), if you are using xboard, you will need to configure the\r
57 "Zippy" code into it, but WinBoard includes this code already.  See\r
58 the file <a\r
59 href="">zippy.README</a>\r
60 in the xboard or WinBoard distribution for more information.\r
61 \r
62 </p>\r
63 \r
64 <p>\r
65 These notes are unpolished, but I've attempted to make them complete\r
66 in this release.  If you notice any errors, omissions, or misleading\r
67 statements, let me know.\r
68 </p>\r
69 \r
70 <p>\r
71 I'd like to hear from everyone who is trying to interface their own\r
72 chess engine to xboard/WinBoard. Please join the mailing list for \r
73 authors of xboard/WinBoard compatible chess engines and post a message \r
74 about what you're doing. The list is now hosted by Yahoo Groups; you \r
75 can join at <a href="" \r
76 ></a>, or you can read the\r
77 list there without joining.  The list is filtered to prevent spam.\r
78 </p>\r
79 <p>\r
80 <font color=green>\r
81 Note that the WinBoard 4.3.xx line was developed independently of the\r
82 original GNU project, by H.G.Muller.\r
83 If you have questions about WinBoard 4.3.xx, or want to report bugs in it,\r
84 report them in the appropriate section of the \r
85 <a href="">WinBoard forum</a>.\r
86 </font>\r
87 </p>\r
88 \r
89 <h2><a name="2">2. Connection</a></h2>\r
90 \r
91 <p>\r
92 An xboard chess engine runs as a separate process from xboard itself,\r
93 connected to xboard through a pair of anonymous pipes.  The engine\r
94 does not have to do anything special to set up these pipes.  xboard\r
95 sets up the pipes itself and starts the engine with one pipe as its\r
96 standard input and the other as its standard output.  The engine then\r
97 reads commands from its standard input and writes responses to its\r
98 standard output.  This is, unfortunately, a little more complicated to\r
99 do right than it sounds; see <a href="#6">section 6</a> below.\r
100 </p>\r
101 \r
102 <p>\r
103 And yes, contrary to some people's expectations, exactly the same\r
104 thing is true for WinBoard.  Pipes and standard input/output are\r
105 implemented in Win32 and work fine.  You don't have to use DDE, COM,\r
106 DLLs, BSOD, or any of the other infinite complexity that\r
107 Microsoft has created just to talk between two programs.  A WinBoard\r
108 chess engine is a Win32 console program that simply reads from its\r
109 standard input and writes to its standard output.  See sections \r
110 <a href="#5">5</a> and <a href="#6">6</a> below for additional details.\r
111 </p>\r
112 \r
113 <h2><a name="3">3. Debugging</a></h2>\r
114 \r
115 <p>\r
116 To diagnose problems in your engine's interaction with xboard, use the\r
117 -debug flag on xboard's command line to see the messages that are\r
118 being exchanged.  In WinBoard, these messages are written to the file\r
119 WinBoard.debug instead of going to the screen.\r
120 </p>\r
121 \r
122 <p>\r
123 You can turn debug mode on or off while WinBoard is running by\r
124 pressing Ctrl+Alt+F12.  You can turn debug mode on or off while xboard\r
125 is running by binding DebugProc to a shortcut key (and pressing the\r
126 key!); see the instructions on shortcut keys in the xboard man page.\r
127 </p>\r
128 \r
129 <p>\r
130 While your engine is running under xboard/WinBoard, you can send a\r
131 command directly to the engine by pressing Shift+1 (xboard) or Alt+1\r
132 (WinBoard 4.0.3 and later).  This brings up a dialog that you can type\r
133 your command into.  Press Shift+2 (Alt+2) instead to send to the\r
134 second chess engine in Two Machines mode.  On WinBoard 4.0.2 and earlier,\r
135 Ctrl+Alt is used in place of Alt; this had to be changed due to a conflict\r
136 with typing the @-sign on some European keyboards.\r
137 </p>\r
138 \r
139 <h2><a name="4">4. How it got this way</a></h2>\r
140 \r
141 <p>\r
142 Originally, xboard was just trying to talk to the existing\r
143 command-line interface of GNU Chess 3.1+ and 4, which was designed\r
144 for people to type commands to.  So the communication protocol is very\r
145 ad-hoc.  It might have been good to redesign it early on, but because\r
146 xboard and GNU Chess are separate programs, I didn't want to force\r
147 people to upgrade them together to versions that matched.  I\r
148 particularly wanted to keep new versions of xboard working with old\r
149 versions of GNU Chess, to make it easier to compare the play of old\r
150 and new gnuchess versions.  I didn't foresee the need for a clean\r
151 protocol to be used with other chess engines in the future.\r
152 </p>\r
153 \r
154 <p>\r
155 Circumstances have changed over the years, and now there are many more\r
156 engines that work with xboard.  I've had to make the protocol\r
157 description more precise, I've added some features that GNU Chess\r
158 does not support, and I've specified the standard semantics of a few\r
159 features to be slightly different from what GNU Chess 4 does.\r
160 </p>\r
161 \r
162 <p>\r
163 <font color=red>\r
164 This release of the protocol specification is the first to carry a\r
165 version number of its own -- version 2.  Previous releases simply\r
166 carried a last-modified date and were loosely tied to specific \r
167 releases of xboard and WinBoard.  The version number "1" applies\r
168 generally to all those older versions of the protocol.\r
169 </font>\r
170 \r
171 <font color=red>\r
172 <p>Protocol version 2 remains compatible with older engines but has\r
173 several new capabilities.  In particular, it adds the \r
174 "feature" command, a new mechanism for making backward-compatible\r
175 changes and extensions to the protocol.  Engines that do not support a\r
176 particular new feature do not have to use it; new features are not\r
177 enabled unless the engine specifically requests them using the feature\r
178 command.  If an engine does not send the feature command at all, the\r
179 protocol behavior is nearly identical to version 1.  Several new\r
180 features can be selected by the feature command in version 2,\r
181 including the "ping" command (recommended for all engines), the\r
182 "setboard" command, and many optional parameters.  Additional features\r
183 will probably be added in future versions.\r
184 </p>\r
185 \r
186 <p>\r
187 <font color=green>\r
188 If it is necessary to have a separate name, \r
189 it would be best to refer to the protocol including the green additions as version 2f.\r
190 I really don't think it is a different protocol from version 2, though.\r
191 I just tried to clarify some ambiguities in the original definition,\r
192 now that the WinBoard 4.3.xx line has implemented them in a specific way.\r
193 The hand-shaking protocol for features as defined in protocol 2 perfectly\r
194 allows addition of an occasional new features without any need for stepping up the protocol version number,\r
195 and I think refraining from the latter would enormously lower the barrier for actual\r
196 implementation of these features in engines.\r
197 <br>\r
198 The two really new things are the engine debug comments, and the "nps" command.\r
199 The former merely tries to regulate an extremely common existing pactice \r
200 of having engines dump debug messages on WinBoard in an unprotected way, \r
201 as usually you get away with that.\r
202 </font>\r
203 \r
204 </font>\r
205 \r
206 <h2><a name="5">5. WinBoard requires Win32 engines</a></h2>\r
207 \r
208 <p>\r
209 Due to some Microsoft brain damage that I don't understand, WinBoard\r
210 does not work with chess engines that were compiled to use a DOS\r
211 extender for 32-bit addressing.  (Probably not with 16-bit DOS or\r
212 Windows programs either.)  WinBoard works only with engines that are\r
213 compiled for the Win32 API.  You can get a free compiler that targets\r
214 the Win32 API from <a href=""\r
215 ></a>.  I think DJGPP 2.x should also\r
216 work if you use the RSXNTDJ extension, but I haven't tried it.  Of\r
217 course, Microsoft Visual C++ will work.  Most likely the other\r
218 commercial products that support Win32 will work too (Borland, etc.),\r
219 but I have not tried them.  Delphi has been successfully used to write\r
220 engines for WinBoard; if you want to do this, Tony Werten has donated\r
221 some <a href="" >sample\r
222 code</a> that should help you get started.\r
223 </p>\r
224 \r
225 <h2><a name="6">6. Hints on input/output</a></h2>\r
226 \r
227 <p>\r
228 Beware of using buffered I/O in your chess engine.  The C stdio\r
229 library, C++ streams, and the I/O packages in most other languages use\r
230 buffering both on input and output.  That means two things.  First,\r
231 when your engine tries to write some characters to xboard, the library\r
232 stashes them in an internal buffer and does not actually write them to\r
233 the pipe connected to xboard until either the buffer fills up or you\r
234 call a special library routine asking for it to be flushed.  (In C\r
235 stdio, this routine is named <tt>fflush</tt>.)  Second, when your engine tries\r
236 to read some characters from xboard, the library does not read just\r
237 the characters you asked for -- it reads all the characters that are\r
238 currently available (up to some limit) and stashes any characters you\r
239 are not yet ready for in an internal buffer.  The next time you ask to\r
240 read, you get the characters from the buffer (if any) before the\r
241 library tries to read more data from the actual pipe.\r
242 </p>\r
243 \r
244 <p>\r
245 Why does this cause problems?  First, on the output side, remember\r
246 that your engine produces output in small quantities (say, a few\r
247 characters for a move, or a line or two giving the current analysis),\r
248 and that data always needs to be delivered to xboard/WinBoard for\r
249 display immediately.  If you use buffered output, the data you print\r
250 will sit in a buffer in your own address space instead of being\r
251 delivered.\r
252 </p>\r
253 \r
254 <p>\r
255 You can usually fix the output buffering problem by asking for the\r
256 buffering to be turned off.  In C stdio, you do this by calling\r
257 <tt>setbuf(stdout, NULL)</tt>.  A more laborious and error-prone\r
258 method is to carefully call <tt>fflush(stdout)</tt> after every line\r
259 you output; I don't recommend this.  In C++, you can try\r
260 <tt>cout.setf(ios::unitbuf)</tt>, which is documented in current\r
261 editions of "The C++ Programming Language," but not older ones.\r
262 Another C++ method that might work is\r
263 <tt>cout.rdbuf()-&gt;setbuf(NULL, 0)</tt>.  Alternatively, you can\r
264 carefully call <tt>cout.flush()</tt> after every line you output;\r
265 again, I don't recommend this.\r
266 </p>\r
267 \r
268 <p>\r
269 Another way to fix the problem is to use unbuffered operating system\r
270 calls to write directly to the file descriptor for standard output.\r
271 On Unix, this means <tt>write(1, ...)</tt> -- see the man page for write(2).\r
272 On Win32, you can use either the Unix-like <tt>_write(1, ...)</tt> or Win32\r
273 native routines like <tt>WriteFile</tt>.\r
274 </p>\r
275 \r
276 <p>\r
277 Second, on the input side, you are likely to want to poll during your\r
278 search and stop it if new input has come in.  If you implement\r
279 pondering, you'll need this so that pondering stops when the user\r
280 makes a move.  You should also poll during normal thinking on your\r
281 move, so that you can implement the "?" (move now) command, and so\r
282 that you can respond promptly to a "result", "force", or "quit"\r
283 command if xboard wants to end the game or terminate your engine.\r
284 Buffered input makes polling more complicated -- when you poll, you\r
285 must stop your search if there are <em>either</em> characters in the buffer\r
286 <em>or</em> characters available from the underlying file descriptor.\r
287 </p>\r
288 \r
289 <p>\r
290 The most direct way to fix this problem is to use unbuffered operating\r
291 system calls to read (and poll) the underlying file descriptor\r
292 directly.  On Unix, use <tt>read(0, ...)</tt> to read from standard input, and\r
293 use <tt>select()</tt> to poll it.  See the man pages read(2) and select(2).\r
294 (Don't follow the example of GNU Chess 4 and use the FIONREAD ioctl to\r
295 poll for input.  It is not very portable; that is, it does not exist\r
296 on all versions of Unix, and is broken on some that do have it.)  On\r
297 Win32, you can use either the Unix-like <tt>_read(0, ...)</tt> or the native\r
298 Win32 <tt>ReadFile()</tt> to read.  Unfortunately, under Win32, the function to\r
299 use for polling is different depending on whether the input device is\r
300 a pipe, a console, or something else.  (More Microsoft brain damage\r
301 here -- did they never hear of device independence?)  For pipes, you\r
302 can use <tt>PeekNamedPipe</tt> to poll (even when the pipe is unnamed).\r
303 For consoles, \r
304 you can use <tt>GetNumberOfConsoleInputEvents</tt>.  For sockets only, you can\r
305 use <tt>select()</tt>.  It might be possible to use\r
306 <tt>WaitForSingleObject</tt> more \r
307 generally, but I have not tried it.  Some code to do these things can\r
308 be found in Crafty's utility.c, but I don't guarantee that it's all\r
309 correct or optimal.\r
310 </p>\r
311 \r
312 <p>\r
313 A second way to fix the problem might be to ask your I/O library not\r
314 to buffer on input.  It should then be safe to poll the underlying\r
315 file descriptor as described above.  With C, you can try calling\r
316 <tt>setbuf(stdin, NULL)</tt>.  However, I have never tried this.  Also, there\r
317 could be problems if you use <tt>scanf()</tt>, at least with certain patterns,\r
318 because <tt>scanf()</tt> sometimes needs to read one extra character and "push\r
319 it back" into the buffer; hence, there is a one-character pushback\r
320 buffer even if you asked for stdio to be unbuffered.  With C++, you\r
321 can try <tt>cin.rdbuf()-&gt;setbuf(NULL, 0)</tt>, but again, I have never tried\r
322 this.\r
323 </p>\r
324 \r
325 <p>\r
326 A third way to fix the problem is to check whether there are\r
327 characters in the buffer whenever you poll.  C I/O libraries generally\r
328 do not provide any portable way to do this.  Under C++, you can use\r
329 <tt>cin.rdbuf()-&gt;in_avail()</tt>.  This method has been reported to\r
330 work with \r
331 EXchess.  Remember that if there are no characters in the buffer, you\r
332 still have to poll the underlying file descriptor too, using the\r
333 method described above.\r
334 </p>\r
335 \r
336 <p>\r
337 A fourth way to fix the problem is to use a separate thread to read\r
338 from stdin.  This way works well if you are familiar with thread\r
339 programming.  This thread can be blocked waiting for input to come in\r
340 at all times, while the main thread of your engine does its thinking.\r
341 When input arrives, you have the thread put the input into a buffer\r
342 and set a flag in a global variable.  Your search routine then\r
343 periodically tests the global variable to see if there is input to\r
344 process, and stops if there is.  WinBoard and my Win32 ports of ICC\r
345 timestamp and FICS timeseal use threads to handle multiple input\r
346 sources.\r
347 </p>\r
348 \r
349 <h2><a name="7">7. Signals</a></h2>\r
350 \r
351 <p>Engines that run on Unix need to be concerned with two Unix\r
352 signals: <tt>SIGTERM</tt> and <tt>SIGINT</tt>.  This applies both to\r
353 engines that run under xboard and (the unusual case of) engines that\r
354 WinBoard remotely runs on a Unix host using the -firstHost or\r
355 -secondHost feature.  It does not apply to engines that run on\r
356 Windows, because Windows does not have Unix-style signals.\r
357 <font color=red>\r
358 Beginning with version 2, you can now turn off the use of\r
359 either or both\r
360 signals.  See the "feature" command in <a href="#6">section 9</a> below.\r
361 </font>\r
362 </p>\r
363 \r
364 <p>First, when an engine is sent the "quit" command, it is also given\r
365 a <tt>SIGTERM</tt> signal shortly afterward to make sure it goes away.\r
366 If your engine reliably responds to "quit", and the signal causes\r
367 problems for you, you should either ignore it by calling\r
368 <tt>signal(SIGTERM, SIG_IGN)</tt> at the start of your program,\r
369 or disable it with the "feature" command.</p>\r
370 \r
371 <p>Second, xboard will send an interrupt signal (<tt>SIGINT</tt>) at\r
372 certain times when it believes the engine may not be listening to user\r
373 input (thinking or pondering).  WinBoard currently does this only when\r
374 the engine is running remotely using the -firstHost or -secondHost\r
375 feature, not when it is running locally.  You probably need to know\r
376 only enough about this grungy feature to keep it from getting in your\r
377 way.\r
378 </p>\r
379 \r
380 <p>\r
381 The <tt>SIGINT</tt>s are basically tailored to the needs of GNU Chess 4\r
382 on systems where its input polling code is broken or disabled.\r
383 Because they work in a rather peculiar way, it is recommended that you\r
384 either ignore <tt>SIGINT</tt> by having your engine call\r
385 <tt>signal(SIGINT, SIG_IGN)</tt>, or disable it with the "feature"\r
386 command.</p>\r
387 \r
388 <p>\r
389 Here are details for the curious.  If xboard needs to send a command\r
390 when it is the chess engine's move (such as before the "?" command), \r
391 it sends a <tt>SIGINT</tt> first.  If xboard needs to send commands when it is\r
392 not the chess engine's move, but the chess engine may be pondering\r
393 (thinking on its opponent's time) or analyzing (analysis or analyze\r
394 file mode), xboard sends a <tt>SIGINT</tt> before the first such command only.\r
395 Another <tt>SIGINT</tt> is not sent until another move is made, even if xboard\r
396 issues more commands.  This behavior is necessary for GNU Chess 4.  The\r
397 first <tt>SIGINT</tt> stops it from pondering until the next move, but on some\r
398 systems, GNU Chess 4 will die if it receives a <tt>SIGINT</tt> when not \r
399 actually thinking or pondering.\r
400 </p>\r
401 \r
402 <p>\r
403 There are two reasons why WinBoard does not send the Win32 equivalent\r
404 of <tt>SIGINT</tt> (which is called <tt>CTRL_C_EVENT</tt>) to local\r
405 engines.  First, the Win32 GNU Chess 4 port does not need it.  Second, I\r
406 could not find a way to get it to work.  Win32 seems to be designed\r
407 under the assumption that only console applications, not windowed\r
408 applications, would ever want to send a <tt>CTRL_C_EVENT</tt>.\r
409 </p>\r
410 \r
411 <h2><a name="8">8. Commands from xboard to the engine</a></h2>\r
412 \r
413 <p>\r
414 All commands from xboard to the engine end with a newline (\n), even\r
415 where that is not explicitly stated.  All your output to xboard must\r
416 be in complete lines; any form of prompt or partial line will cause\r
417 problems.\r
418 </p>\r
419 \r
420 <p>\r
421 At the beginning of each game, xboard sends an initialization string.\r
422 This is currently "new\nrandom\n" unless the user changes it with the\r
423 initString or secondInitString option.\r
424 </p>\r
425 \r
426 <p>\r
427 xboard normally reuses the same chess engine process for multiple\r
428 games.  At the end of a game, xboard will send the "force" command\r
429 (see below) to make sure your engine stops thinking about the current\r
430 position.  It will later send the initString again to start a new\r
431 game.  If your engine can't play multiple games, you can disable reuse\r
432 <font color=red>\r
433 either with the "feature" command (beginning in protocol version\r
434 2; see below) or \r
435 </font>\r
436 with xboard's -xreuse (or -xreuse2) command line\r
437 option.  xboard will then ask the process to quit after each game and\r
438 start a new process for the next game.\r
439 </p>\r
440 \r
441 <dl>\r
442 <dt><strong>xboard</strong>\r
443 <dd>This command will be sent once immediately after your engine\r
444 process is started.  You can use it to put your engine into "xboard\r
445 mode" if that is needed.  If your engine prints a prompt to ask for\r
446 user input, you must turn off the prompt and output a newline when the\r
447 "xboard" command comes in.\r
448 <p>\r
449 \r
450 <dt><font color=red><strong>protover N</strong></font>\r
451 <dd><font color=red>\r
452 Beginning in protocol version 2 (in which N=2), this command will\r
453 be sent immediately after the "xboard" command.  If you receive some\r
454 other command immediately after "xboard" (such as "new"), you can\r
455 assume that protocol version 1 is in use.  The "protover" command is\r
456 the only new command that xboard always sends in version 2.  All other\r
457 new commands to the engine are sent only if the engine first enables\r
458 them with the "feature" command.  Protocol versions will always be\r
459 simple integers so that they can easily be compared.\r
460 \r
461 <p>Your engine should reply to the protover command by sending the\r
462 "feature" command (see below) with the list of non-default feature\r
463 settings that you require, if any.\r
464 \r
465 <p>Your engine should never refuse to run due to receiving a higher\r
466 protocol version number than it is expecting!  New protocol versions\r
467 will always be compatible with older ones by default; the larger\r
468 version number is simply a hint that additional "feature" command\r
469 options added in later protocol versions may be accepted.\r
470 </font>\r
471 <p>\r
472 \r
473 <dt><font color=red><strong>accepted</strong></font>\r
474 <dt><font color=red><strong>rejected</strong></font>\r
475 <dd><font color=red>\r
476 These commands may be sent to your engine in reply to the "feature"\r
477 command; see its documentation below.\r
478 </font>\r
479 <p>\r
480 \r
481 <dt><strong>new</strong>\r
482 <dd>Reset the board to the standard chess starting position.  Set\r
483 White on move.  Leave force mode and set the engine to play Black.\r
484 Associate the engine's clock with Black and the opponent's clock with\r
485 White.  Reset clocks and time controls to the start of a new game.\r
486 Use wall clock for time measurement.\r
487 Stop clocks.  Do not ponder on this move, even if pondering is on.\r
488 Remove any search depth limit previously set by the sd command.\r
489 <p>\r
490 \r
491 <dt><strong>variant VARNAME</strong>\r
492 <dd>If the game is not standard chess, but a variant, this command is\r
493 sent after "new" and before the first move or "edit" command.  Currently\r
494 defined variant names are:\r
495 \r
496 <table>\r
497 <tr align="left"><th>wildcastle<td>Shuffle chess where king can castle from d file\r
498 <tr align="left"><th>nocastle<td>Shuffle chess with no castling at all\r
499 <tr align="left"><th>fischerandom<td>Fischer Random\r
500 <tr align="left"><th>bughouse<td>Bughouse, ICC/FICS rules\r
501 <tr align="left"><th>crazyhouse<td>Crazyhouse, ICC/FICS rules\r
502 <tr align="left"><th>losers<td>Win by losing all pieces or getting mated (ICC)\r
503 <tr align="left"><th>suicide<td>Win by losing all pieces including king,\r
504 or by having fewer pieces when one player has no legal moves (FICS)\r
505 <tr align="left"><th><font color=red>giveaway</font>\r
506 <td><font color=red>Win by losing all pieces including king,\r
507 or by having no legal moves (ICC)</font>\r
508 <tr align="left"><th>twokings<td>Weird ICC wild 9\r
509 <tr align="left"><th>kriegspiel<td>Kriegspiel (engines not supported)\r
510 <tr align="left"><th>atomic<td>Atomic\r
511 <tr align="left"><th>3check<td>Win by giving check 3 times\r
512 <tr align="left"><th><font color=green>xiangqi</font>\r
513 <td><font color=green>Chinese Chess (9x10 board)</font>\r
514 <tr align="left"><th><font color=green>shogi</font>\r
515 <td><font color=green>Japanese Chess (9x9 bord)</font>\r
516 <tr align="left"><th><font color=green>capablanca</font>\r
517 <td><font color=green>Capablanca Chess (10x8 board, with Archbishop and Chancellor)</font>\r
518 <tr align="left"><th><font color=green>gothic</font>\r
519 <td><font color=green>Gothic Chess (10x8 board, same with better opening setup)</font>\r
520 <tr align="left"><th><font color=green>falcon</font>\r
521 <td><font color=green>Falcon Chess (10x8 board, with two Falcon pieces)</font>\r
522 <tr align="left"><th><font color=green>shatranj</font>\r
523 <td><font color=green>ancient Arabic Chess, with Elephants and General in stead of B and Q</font>\r
524 <tr align="left"><th><font color=green>courier</font>\r
525 <td><font color=green>Courier Chess (12x8 board, a medieval precursor of modern Chess</font>\r
526 <tr align="left"><th><font color=green>knightmate</font>\r
527 <td><font color=green>King moves as Knight and vice versa</font>\r
528 <tr align="left"><th><font color=green>berolina</font><td>\r
529 <font color=green>Pawns capture straight ahead, and move diagonally</font>\r
530 <tr align="left"><th><font color=green>janus</font><td>\r
531 <font color=green>Janus Chess (10x8, with two Archbishops)</font>\r
532 <tr align="left"><th><font color=green>caparandom</font>\r
533 <td><font color=green>shuffle variant like FRC (10x8 board)</font>\r
534 <tr align="left"><th><font color=green>cylinder</font>\r
535 <td><font color=green>Pieces wrap around between side edges, like board is a cylinder</font>\r
536 <tr align="left"><th><font color=blue>super</font>\r
537 <td><font color=blue>Superchess: a shuffle variant with 4 fairy pieces on 8x8 board</font>\r
538 <tr align="left"><th><font color=blue>great</font>\r
539 <td><font color=blue>Great Shatranj: sliders are replaced by corresponding short-range pieces on a 10x8 board</font>\r
540 <tr align="left"><th>unknown<td>Unknown variant (not supported)\r
541 </table>\r
542 <p>\r
543 \r
544 <dt><strong>quit</strong>\r
545 <dd>The chess engine should immediately exit.  This command is used\r
546 when xboard is itself exiting, and also between games if the -xreuse\r
547 command line option is given (or -xreuse2 for the second engine).\r
548 See also <a href="#7">Signals</a> above.\r
549 <p>\r
550 \r
551 <dt><strong>random</strong>\r
552 <dd>This command is specific to GNU Chess 4.  You can either ignore it\r
553 completely (that is, treat it as a no-op) or implement it as GNU Chess\r
554 does.  The command toggles "random" mode (that is, it sets random =\r
555 !random).  In random mode, the engine adds a small random value to its\r
556 evaluation function to vary its play.  The "new" command sets random\r
557 mode off.\r
558 <p>\r
559 \r
560 <dt><strong>force</strong>\r
561 <dd>Set the engine to play neither color ("force mode").  Stop clocks.\r
562 The engine should check that moves received in force mode are legal\r
563 and made in the proper turn, but should not think, ponder, or make\r
564 moves of its own.\r
565 <p>\r
566 \r
567 <dt><strong>go</strong>\r
568 <dd>Leave force mode and set the engine to play the color that is on\r
569 move.  Associate the engine's clock with the color that is on move,\r
570 the opponent's clock with the color that is not on move.  Start the engine's\r
571 clock.  Start thinking and eventually make a move.\r
572 <p>\r
573 \r
574 <dt><font color=red><strong>playother</strong></font>\r
575 <dd>\r
576 <font color=red>\r
577 (This command is new in protocol version 2.  It is not\r
578 sent unless you enable it with the feature command.)\r
579 Leave force mode and set the engine to play the color that is <i>not</i> on\r
580 move.  Associate the opponent's clock with the color that is on move,\r
581 the engine's clock with the color that is not on move.  Start the opponent's\r
582 clock.  If pondering is enabled, the engine should begin pondering.\r
583 If the engine later receives a move, it should start thinking and eventually\r
584 reply.\r
585 </font>\r
586 <p>\r
587 \r
588 <dt><strong>white</strong>\r
589 <dd>\r
590 <font color=red>\r
591 (This command is obsolete as of protocol version 2, but is still\r
592 sent in some situations to accommodate older engines unless you disable it \r
593 with the feature command.)\r
594 </font>\r
595 Set White on move.  Set the engine to play Black.  Stop clocks.\r
596 <p>\r
597   \r
598 <dt><strong>black</strong>\r
599 <dd>\r
600 <font color=red>\r
601 (This command is obsolete as of protocol version 2, but is still\r
602 sent in some situations to accommodate older engines unless you disable it \r
603 with the feature command.)\r
604 </font>\r
605 Set Black on move.  Set the engine to play White.  Stop clocks.\r
606 <p>\r
607 \r
608 <dt><strong>level MPS BASE INC</strong>\r
609 <dd>Set time controls.  See the <a href="#11">Time Control</a> section below.\r
610 <p>\r
611   \r
612 <dt><strong>st TIME</strong>\r
613 <dd>Set time controls.  See the <a href="#11">Time Control</a> section\r
614 below. \r
615 <p>\r
616 \r
617 <dt><strong>sd DEPTH</strong>\r
618 <dd>The engine should limit its thinking to DEPTH ply.\r
619 <font color=green>The commands "level" or "st" and "sd" can be used together in an orthogonal way.\r
620 If both are issued, the engine should observe both limitations:</font>\r
621 In the protocol, the "sd" command isn't a time control.  It doesn't\r
622 say that your engine has unlimited time but must search to exactly the\r
623 given depth.  It says that you should pay attention to the time\r
624 control as normal, but cut off the search at the specified depth even\r
625 if you have time to search deeper.  If you don't have time to search\r
626 to the specified depth, given your normal time management algorithm,\r
627 then you will want to stop sooner than the given depth.\r
628 <p>\r
629 The "new" command should set the search depth back to unlimited.  This\r
630 is already stated in the spec.  The "level" command should not affect\r
631 the search depth.  As it happens, xboard/WinBoard currently always\r
632 sends sd (if needed) right after level, but that isn't part of the\r
633 spec.\r
634 <p>\r
635 \r
636 <dt><font color=green><strong>nps NODE_RATE</strong></font>\r
637 <dd><font color=green>The engine should not use wall-clock time to make its timing decisions,\r
638 but an own internal time measure based on the number of nodes it has searched\r
639 (and will report as "thinking output", see <a href="#10">section 10</a>),\r
640 converted to seconds through dividing by the given NODE_RATE.\r
641 Example: after receiving the commands "st 8" and "nps 10000",\r
642 the engine should never use more that 80,000 nodes in the search for any move.\r
643 In this mode, the engine should report user CPU time used (in its thinking output), \r
644 rather than wall-clock time.\r
645 This even holds if NODE_RATE is given as 0,\r
646 but in that case it should also use the user CPU time for its timing decisions.\r
647 The effect of an "nps" command should persist until the next "new" command.\r
648 </font>\r
649 <p>\r
650 \r
651 <dt><strong>time N</strong>\r
652 <dd>Set a clock that always belongs to the engine.  N is a number in\r
653   centiseconds (units of 1/100 second).  Even if the engine changes to\r
654   playing the opposite color, this clock remains with the engine.\r
655 <p>\r
656 \r
657 <dt><strong>otim N</strong>\r
658 \r
659 <dd>Set a clock that always belongs to the opponent.  N is a number in\r
660 centiseconds (units of 1/100 second).  Even if the opponent changes to\r
661 playing the opposite color, this clock remains with the opponent.\r
662 <p>\r
663 If needed for purposes of board display in force mode (where the\r
664 engine is not participating in the game) the time clock should be\r
665 associated with the last color that the engine was set to play, the\r
666 otim clock with the opposite color.\r
667 </p>\r
668 <p>\r
669 <font color=green>This business of "clocks remaining with the engine" is apparently so ambiguous\r
670 that many engines implement it wrong.\r
671 The clocks in fact always remain with the color.\r
672 Which clock reading is relayed with "time", and which by "otim", is determined by which side the engine plays.\r
673 Note that the way the clocks operate and receive extra time (in accordance with the selected time control)\r
674 is not affected in any way by which moves are made by the engine, which by the opponent, and which were forced.\r
675 </font>\r
676 </p>\r
677 <p>\r
678 <font color=red>\r
679 Beginning in protocol version 2, if you can't handle the time and\r
680 otim commands, you can use the "feature" command to disable them; see\r
681 below.  \r
682 </font>\r
683 The following techniques from older protocol versions also\r
684 work: You can ignore the time and otim commands (that is, treat them\r
685 as no-ops), or send back "Error (unknown command): time" the first\r
686 time you see "time".\r
687 </p>\r
688 \r
689 <dt><strong>MOVE</strong>\r
690 <dd>See below for the syntax of moves.  If the move is illegal, print\r
691 an error message; see the section "<a href="#9">Commands from the engine to\r
692 xboard</a>".  If the move is legal and in turn, make it.  If not in force\r
693 mode, stop the opponent's clock, start the engine's clock, start\r
694 thinking, and eventually make a move.\r
695 <p>\r
696 When xboard sends your engine a move, it normally sends coordinate\r
697 algebraic notation.  Examples:\r
698 <p>\r
699 <table>\r
700 <tr align="left"><td>Normal moves:<td>e2e4\r
701 <tr align="left"><td>Pawn promotion:<td>e7e8q\r
702 <tr align="left"><td>Castling:<td>e1g1, e1c1, e8g8, e8c8\r
703 <tr align="left"><td>Bughouse/crazyhouse drop:<td>P@h3\r
704 <tr align="left"><td>ICS Wild 0/1 castling:<td>d1f1, d1b1, d8f8, d8b8\r
705 <tr align="left"><td>FischerRandom castling:<td>O-O, O-O-O (oh, not zero)\r
706 </table>\r
707 \r
708 <p>\r
709 <font color=green>\r
710 Note that on boards with more than 9 ranks, counting of the ranks starts at 0.\r
711 </font>\r
712 </p>\r
713 <p>\r
714 <font color=red>\r
715 Beginning in protocol version 2, you can use the feature command\r
716 to select SAN (standard algebraic notation) instead; for example, e4,\r
717 Nf3, exd5, Bxf7+, Qxf7#, e8=Q, O-O, or P@h3.  Note that the last form,\r
718 P@h3, is a extension to the PGN standard's definition of SAN, which does\r
719 not support bughouse or crazyhouse.\r
720 </font>\r
721 </p>\r
722 \r
723 <p>\r
724 xboard doesn't reliably detect illegal moves, because it does not keep\r
725 track of castling unavailability due to king or rook moves, or en\r
726 passant availability.  If xboard sends an illegal move, send back an\r
727 error message so that xboard can retract it and inform the user; see\r
728 the section "<a href="#9">Commands from the engine to xboard</a>".\r
729 </p>\r
730 \r
731 <dt><font color=red><strong>usermove MOVE</strong></font>\r
732 <dd><font color=red>\r
733 By default, moves are sent to the engine without a command name;\r
734 the notation is just sent as a line by itself.\r
735 Beginning in protocol version 2, you can use the feature command\r
736 to cause the command name "usermove" to be sent before the move.\r
737 Example: "usermove e2e4".\r
738 </font>\r
739 </p>\r
740 \r
741 <dt><strong>?</strong>\r
742 <dd>Move now.  If your engine is thinking, it should move immediately;\r
743   otherwise, the command should be ignored (treated as a no-op).  It\r
744   is permissible for your engine to always ignore the ? command.  The\r
745   only bad consequence is that xboard's Move Now menu command will do\r
746   nothing.\r
747 <p>\r
748 It is also permissible for your engine to move immediately if it gets\r
749 any command while thinking, as long as it processes the command right\r
750 after moving, but it's preferable if you don't do this.  For example,\r
751 xboard may send post, nopost, easy, hard, force, quit,\r
752 <font color=red>\r
753 or other commands\r
754 </font>\r
755 while the engine is on move.\r
756 </p>\r
757 \r
758 <dt><font color=red><strong>ping N</strong></font>\r
759 <dd>\r
760 <font color=red>\r
761 In this command, N is a decimal number.  When you receive the command,\r
762 reply by sending the string <strong>pong N</strong>, where N is the\r
763 same number you received.  Important: You must not reply to a "ping"\r
764 command until you have finished executing all commands that you\r
765 received before it.  Pondering does not count; if you receive a ping\r
766 while pondering, you should reply immediately and continue pondering.\r
767 Because of the way xboard uses the ping command, if you implement the\r
768 other commands in this protocol, you should never see a "ping" command\r
769 when it is your move; however, if you do, you must not send the "pong"\r
770 reply to xboard until after you send your move.  For example, xboard\r
771 may send "?" immediately followed by "ping".  If you implement the "?"\r
772 command, you will have moved by the time you see the subsequent ping\r
773 command.  Similarly, xboard may send a sequence like "force", "new",\r
774 "ping".  You must not send the pong response until after you have\r
775 finished executing the "new" command and are ready for the new game to\r
776 start.\r
777 \r
778 <p>\r
779 The ping command is new in protocol version 2 and will not be sent\r
780 unless you enable it with the "feature" command.  Its purpose is to\r
781 allow several race conditions that could occur in previous versions of\r
782 the protocol to be fixed, so it is highly recommended that you\r
783 implement it.  It is especially important in simple engines that do\r
784 not ponder and do not poll for input while thinking, but it is needed in all\r
785 engines.  \r
786 </p>\r
787 </font>\r
788 \r
789 <dt><strong>draw</strong>\r
790 <dd>The engine's opponent offers the engine a draw.  To accept the\r
791 draw, send "offer draw".  To decline, ignore the offer (that is, send\r
792 nothing).  If you're playing on ICS, it's possible for the draw offer\r
793 to have been withdrawn by the time you accept it, so don't assume the\r
794 game is over because you accept a draw offer.  Continue playing until\r
795 xboard tells you the game is over.  See also "offer draw" below.\r
796 <p>\r
797 \r
798 <dt><strong>result RESULT {COMMENT}</strong>\r
799 <dd>After the end of each game, xboard will send you a result command.\r
800 You can use this command to trigger learning.  RESULT is either 1-0,\r
801 0-1, 1/2-1/2, or *, indicating whether white won, black won, the game\r
802 was a draw, or the game was unfinished.  The COMMENT string is purely\r
803 a human-readable comment; its content is unspecified and subject to\r
804 change.  In ICS mode, it is passed through from ICS uninterpreted.\r
805 Example: <pre>result 1-0 {White mates}</pre>\r
806 <p>\r
807 Here are some notes on interpreting the "result" command.  Some apply\r
808 only to playing on ICS ("Zippy" mode).\r
809 </p>\r
810 \r
811 <p>\r
812 If you won but did not just play a mate, your opponent must have\r
813 resigned or forfeited.  If you lost but were not just mated, you\r
814 probably forfeited on time, or perhaps the operator resigned manually.\r
815 If there was a draw for some nonobvious reason, perhaps your opponent\r
816 called your flag when he had insufficient mating material (or vice\r
817 versa), or perhaps the operator agreed to a draw manually.\r
818 </p>\r
819 \r
820 <p>\r
821 You will get a result command even if you already know the game ended\r
822 -- for example, after you just checkmated your opponent.  In fact, if\r
823 you send the "RESULT {COMMENT}" command (discussed below), you will\r
824 simply get the same thing fed back to you with "result" tacked in\r
825 front.  You might not always get a "result *" command, however.  In\r
826 particular, you won't get one in local chess engine mode when the user\r
827 stops playing by selecting Reset, Edit Game, Exit or the like.\r
828 </p>\r
829 \r
830 <dt><font color=red><strong>setboard FEN</strong></font>\r
831 <dd><font color=red>\r
832 The setboard command is the new way to set up positions, beginning\r
833 in protocol version 2.  It is not used unless it has been selected\r
834 with the feature command.  Here FEN is a position in Forsythe-Edwards\r
835 Notation, as defined in the PGN standard.</font>\r
836 <font color=green>Note that this PGN standard referred to here\r
837 only applies to normal Chess;\r
838 Obviously in variants that cannot be described by a FEN for normal Chess,\r
839 e.g. because the board is not 8x8, other pieces then PNBRQK participate, \r
840 there are holdings that need to be specified, etc., \r
841 xboard will use a FEN format that is standard or suitable for that varant.\r
842 In particular, in FRC or CRC, WinBoard will use Shredder-FEN or X-FEN standard,\r
843 i.e. it can use the rook-file indicator letter to represent a castling right \r
844 (like HAha) whenever it wants, but if it uses KQkq, this will always refer \r
845 to the outermost rook on the given side.</font>\r
846 <font color=red>\r
847 \r
848 <p><i>Illegal positions:</i> Note that either setboard or edit can\r
849 be used to send an illegal position to the engine.  The user can\r
850 create any position with xboard's Edit Position command (even, say,\r
851 an empty board, or a board with 64 white kings and no black ones).\r
852 If your engine receives a position that it considers illegal, \r
853 I suggest that you send the response "tellusererror Illegal position",\r
854 and then respond to any attempted move with "Illegal move" until\r
855 the next new, edit, or setboard command.</p>\r
856 </font>\r
857 <p>\r
858 \r
859 <dt><strong>edit</strong>\r
860 <dd>\r
861 <font color=red>\r
862 The edit command is the old way to set up positions.  For compatibility\r
863 with old engines, it is still used by default, but new engines may prefer\r
864 to use the feature command (see below) to cause xboard to use setboard instead.\r
865 </font>\r
866 The edit command puts the chess engine into a special mode, where\r
867 it accepts the following subcommands:\r
868 <table>\r
869 <tr align="left"><th>c<td>change current piece color, initially white\r
870 <tr align="left"><th>Pa4 (for example)<td>place pawn of current color on a4\r
871 <tr align="left"><th>xa4 (for example)<td>empty the square a4 (not used by xboard)\r
872 <tr align="left"><th>#<td>clear board\r
873 <tr align="left"><th>.<td>leave edit mode\r
874 </table>\r
875 <font color=red>\r
876 See the Idioms section below for additional subcommands used in\r
877 ChessBase's implementation of the protocol.\r
878 </font>\r
879 \r
880 <p>The edit command does not change the side to move.  To set up a\r
881 black-on-move position, xboard uses the following command sequence:\r
882 </p>\r
883 <pre>\r
884     new\r
885     force\r
886     a2a3\r
887     edit\r
888     &lt;edit commands&gt;\r
889     .\r
890 </pre>\r
891 \r
892 <p>\r
893 This sequence is used to avoid the "black" command, which is now\r
894 considered obsolete and which many engines never did implement as \r
895 specified in this document.\r
896 </p>\r
897 \r
898 <p>\r
899 After an edit command is complete, if a king and a rook are on their\r
900 home squares, castling is assumed to be available to them.  En passant\r
901 capture is assumed to be illegal on the current move regardless of the\r
902 positions of the pawns.  The clock for the 50 move rule starts at\r
903 zero, and for purposes of the draw by repetition rule, no prior\r
904 positions are deemed to have occurred.\r
905 <font color=green>\r
906 In FRC or CRC, any rook and king put on the back rank should be considered to\r
907 have castling rights, even if it later becomes apparent that they cannot be both in the\r
908 initial position, because the position just set up is asymmetric.\r
909 It is upto WinBoard to find work-around in cases where this is not desired,\r
910 similar to the "black kludge" shown above, by setting up an earlier position,\r
911 and then do a move to destroy castling rights or create e.p. rights.\r
912 (Don't bet your life on it...)\r
913 </font>\r
914 </p>\r
915 \r
916 <dt><strong>hint</strong>\r
917 <dd>If the user asks for a hint, xboard sends your engine the command\r
918 "hint".  Your engine should respond with "Hint: xxx", where xxx is a\r
919 suggested move.  If there is no move to suggest, you can ignore the\r
920 hint command (that is, treat it as a no-op).\r
921 <p>\r
922 \r
923 <dt><strong>bk</strong>\r
924 <dd>If the user selects "Book" from the xboard menu, xboard will send\r
925 your engine the command "bk".  You can send any text you like as the\r
926 response, as long as each line begins with a blank space or tab (\t)\r
927 character, and you send an empty line at the end.  The text pops up in\r
928 a modal information dialog.\r
929 <p>\r
930 \r
931 <dt><strong>undo</strong>\r
932 <dd>If the user asks to back up one move, xboard will send you the\r
933 "undo" command.  xboard will not send this command without putting you\r
934 in "force" mode first, so you don't have to worry about what should\r
935 happen if the user asks to undo a move your engine made.  (GNU Chess 4\r
936 actually switches to playing the opposite color in this case.)\r
937 <p>\r
938 \r
939 <dt><strong>remove</strong>\r
940 <dd>If the user asks to retract a move, xboard will send you the\r
941 "remove" command.  It sends this command only when the user is on\r
942 move.  Your engine should undo the last two moves (one for each\r
943 player) and continue playing the same color.\r
944 <p>\r
945 \r
946 <dt><strong>hard</strong>\r
947 <dd>Turn on pondering (thinking on the opponent's time, also known as\r
948 "permanent brain").  xboard will not make any assumption about what\r
949 your default is for pondering or whether "new" affects this setting.\r
950 <p>\r
951 \r
952 <dt><strong>easy</strong>\r
953 <dd>Turn off pondering.\r
954 <p>\r
955   \r
956 <dt><strong>post</strong>\r
957 <dd>Turn on thinking/pondering output.  \r
958 See <a href="#10">Thinking Output</a> section.\r
959 <p>\r
960 \r
961 <dt><strong>nopost</strong>\r
962 <dd>Turn off thinking/pondering output.\r
963 <p>\r
964   \r
965 <dt><strong>analyze</strong>\r
966 <dd>Enter analyze mode.  See <a href="#12">Analyze Mode</a> section.\r
967 <p>\r
968 \r
969 <dt><strong>name X</strong> <dd>This command informs the engine of its\r
970 opponent's name.  When the engine is playing on a chess server, xboard\r
971 obtains the opponent's name from the server. \r
972 <font color=red>\r
973 When the engine is\r
974 playing locally against a human user, xboard obtains the user's login\r
975 name from the local operating system.  When the engine is playing\r
976 locally against another engine, xboard uses either the other engine's\r
977 filename or the name that the other engine supplied in the myname\r
978 option to the feature command.  By default, xboard uses the name\r
979 command only when the engine is playing on a chess server.  Beginning\r
980 in protocol version 2, you can change this with the name option to the\r
981 feature command; see below.\r
982 </font>\r
983 <p>\r
984 \r
985 <dt><strong>rating</strong>\r
986 <dd>In ICS mode, xboard obtains the ICS opponent's rating from the\r
987 "Creating:" message that appears before each game.  (This message may\r
988 not appear on servers using outdated versions of the FICS code.)  In\r
989 Zippy mode, it sends these ratings on to the chess engine using the\r
990 "rating" command.  The chess engine's own rating comes first, and if\r
991 either opponent is not rated, his rating is given as 0.  \r
992 <font color=red>\r
993 In the future this command may also be used in other modes, if ratings\r
994 are known.\r
995 </font>\r
996 Example: <pre>rating 2600 1500</pre>\r
997 <p>\r
998 \r
999 <dt><font color=red><strong>ics HOSTNAME</strong></font>\r
1000 <dd><font color=red>\r
1001 If HOSTNAME is "-", the engine is playing against a local\r
1002 opponent; otherwise, the engine is playing on an Internet Chess Server\r
1003 (ICS) with the given hostname.  This command is new in protocol\r
1004 version 2 and is not sent unless the engine has enabled it with\r
1005 the "feature" command.  Example: "ics"\r
1006 </font>\r
1007 <p>\r
1008 \r
1009 <dt><strong>computer</strong>\r
1010 <dd>The opponent is also a computer chess engine.  Some engines alter\r
1011 their playing style when they receive this command.\r
1012 <p>\r
1013 \r
1014 <dt><font color=red><strong>pause</strong></font>\r
1015 <dt><font color=red><strong>resume</strong></font>\r
1016 <dd><font color=red>(These commands are new in protocol\r
1017 version 2 and will not be sent unless feature pause=1 is set.  At\r
1018 this writing, xboard actually does not use the commands at all, but it\r
1019 or other interfaces may use them in the future.)\r
1020 The "pause" command puts the engine into a special state where it\r
1021 does not think, ponder, or otherwise consume significant CPU time.\r
1022 The current thinking or pondering (if any) is suspended and both\r
1023 player's clocks are stopped.  The only command that the interface may\r
1024 send to the engine while it is in the paused state is "resume".  The\r
1025 paused thinking or pondering (if any) resumes from exactly where it\r
1026 left off, and the clock of the player on move resumes running from\r
1027 where it stopped.\r
1028 </font>\r
1029 <p>\r
1030 \r
1031 <dt><font color=blue><strong>memory N</strong></font>\r
1032 <dd><font color=blue>\r
1033 This command informs the engine on how much memory it is allowed to use maximally, in MegaBytes.\r
1034 On receipt of this command, the engine should adapt the size of its hash tables accordingly.\r
1035 This command does only fix the total memory use,\r
1036 the engine has to decide for itself \r
1037 (or be configured by the user by other means) \r
1038 how to divide up the available memory between the various tables it wants to use \r
1039 (e.g. main hash, pawn hash, tablebase cache, bitbases).\r
1040 This command will only be sent to engines that have requested it through the memory feature,\r
1041 and only at the start of a game,\r
1042 as the first of the commands to relay engine option settings just before each "new" command.\r
1043 </font>\r
1044 <p>\r
1045 \r
1046 <dt><font color=blue><strong>cores N</strong></font>\r
1047 <dd><font color=blue>\r
1048 This command informs the engine on how many CPU cores it is allowed to use maximally.\r
1049 This could be interpreted as the number of search threads for SMP engines. \r
1050 (Threads that do not consume significant amounts of CPU time, like I/O threads, need not be included in the count.)\r
1051 This command will only be sent to engines that have requested it through the smp feature.\r
1052 The engine should be able to respond to the "cores" command any time during a game,\r
1053 but it is allowed to finish a search in progress before procesing the command.\r
1054 (Obeying the command should take priority over finishing a ponder search, though.)\r
1055 In any case it will be sent at the start of every game\r
1056 as the last command to relay engine option settings before the "new" command.\r
1057 </font>\r
1058 <p>\r
1059 \r
1060 <dt><font color=blue><strong>egtpath TYPE PATH</strong></font>\r
1061 <dd><font color=blue>\r
1062 This command informs the engine in which directory (given by the PATH argument)\r
1063 it can find end-game tables of the specified TYPE.\r
1064 The TYPE argument can be any character string which does not contain spaces.\r
1065 Currently <strong>nalimov</strong> and <strong>scorpio</strong> are defined types, \r
1066 for Nalimov tablebases and Scorpio bitbases, respectively,\r
1067 but future developers of other formats are free to define their own format names.\r
1068 The GUI simply matches the TYPE names the engine says it supports \r
1069 with those that the user supplied when configuring xboard.\r
1070 For every match, it sends a separate "y" command.\r
1071 The PATH argument would normally (for Nalimov) be the pathname of the directory the EGT files are in,\r
1072 but could also be the name of a file, or in fact anything the particular EGT type requires.\r
1073 It is upto the developer of the EGT format to specify the syntax of this parameter.\r
1074 This command will only be sent to engines that have told the GUI they support EGTs of the given TYPE\r
1075 through the egt feature.\r
1076 It will be sent at the start of each game, before the "new" command.\r
1077 </font>\r
1078 <p>\r
1079 \r
1080 <dt><font color=blue><strong>option NAME[=VALUE]</strong></font>\r
1081 <dd><font color=blue>\r
1082 This command changes the setting of the option NAME defined by the engine \r
1083 (through an earlier feature command)\r
1084 to the given VALUE.\r
1085 XBoard will in general have no idea what the option means,\r
1086 and will send the command only when a user changes the value of this option through a menu,\r
1087 or at startup of the engine \r
1088 (before the first 'cores' command or, if that is not sent, the first 'new' command)\r
1089 in reaction to command-line options.\r
1090 The NAME echoes back to the engine the string that was identified as an option NAME\r
1091 in the feature command defining the option.\r
1092 The VALUE is of the type (numeric or text or absent) that was implied by the option type\r
1093 specified in this feature command,\r
1094 i.e. with 'spin' and 'check' options VALUE will be a decimal integer (in the latter case 0 or 1),\r
1095 with 'combo' and 'string' options VALUE will be a text string,\r
1096 and with 'button' and 'save' options no VALUE will be sent at all.\r
1097 </font>\r
1098 </dl>\r
1099 \r
1100 <h3>Bughouse commands:</h3>\r
1101 \r
1102 <p>\r
1103 xboard now supports bughouse engines when in Zippy mode.  See\r
1104 <a href=""\r
1105 >zippy.README</a> for information on Zippy mode and how to turn on the\r
1106 bughouse support.  The bughouse move format is given above.  xboard\r
1107 sends the following additional commands to the engine when in bughouse\r
1108 mode.  \r
1109 Commands to inform your engine of the partner's game state may\r
1110 be added in the future.\r
1111 </p>\r
1112 \r
1113 <dl>\r
1114 <dt><strong>partner &lt;player&gt;</strong>\r
1115 <dd>&lt;player&gt; is now your partner for future games.  Example: <pre>partner mann</pre>\r
1116 <p>\r
1117 \r
1118 <dt><strong>partner</strong>\r
1119 <dd>Meaning: You no longer have a partner.\r
1120 <p>\r
1121 \r
1122 <dt><strong>ptell &lt;text&gt;</strong>\r
1123 <dd>Your partner told you &lt;text&gt;, either with a ptell or an ordinary tell.  \r
1124 <p>\r
1125 \r
1126 <dt><strong>holding [&lt;white&gt;] [&lt;black&gt;]</strong>\r
1127 <dd>White currently holds &lt;white&gt;; black currently holds &lt;black&gt;.\r
1128   Example: <pre>holding [PPPRQ] []</pre>\r
1129 \r
1130 <dt><strong>holding [&lt;white&gt;] [&lt;black&gt;] &lt;color&gt;&lt;piece&gt;</strong>\r
1131 <dd>White currently holds &lt;white&gt;; black currently holds &lt;black&gt;, after\r
1132   &lt;color&gt; acquired &lt;piece&gt;.   Example: <pre>holding [PPPRQ] [R] BR</pre>\r
1133 </dl>\r
1134 \r
1135 <h2><a name="9">9. Commands from the engine to xboard</a></h2>\r
1136 \r
1137 <p>\r
1138 <font color=red>\r
1139 In general, an engine should not send any output to xboard that is not\r
1140 described in this document.  As the protocol is extended, newer\r
1141 versions of xboard may recognize additional strings as commands that\r
1142 were previously not assigned a meaning.\r
1143 </font>\r
1144 </p>\r
1145 \r
1146 <dl>\r
1147 <dt><font color=red>\r
1148 <strong>feature FEATURE1=VALUE1 FEATURE2=VALUE2 ...</strong> \r
1149 </font>\r
1150 \r
1151 <dd><font color=red>\r
1152 Beginning with version 2, the protocol includes the "feature"\r
1153 command, which lets your engine control certain optional protocol\r
1154 features.  Feature settings are written as FEATURE=VALUE, where\r
1155 FEATURE is a name from the list below and VALUE is the value to be\r
1156 assigned.  Features can take string, integer, or boolean values; the\r
1157 type of value is listed for each feature.  String values are written\r
1158 in double quotes (for example, <tt>feature myname="Miracle Chess\r
1159 0.9"</tt>), integers are written in decimal, and boolean values are\r
1160 written as 0 for false, 1 for true.  Any number of features can be set\r
1161 in one feature command, or multiple feature commands can be given.\r
1162 \r
1163 <p>\r
1164 Your engine should send one or more feature commands immediately after\r
1165 receiving the "protover" command, since xboard needs to know the\r
1166 values of some features before sending further commands to the engine.\r
1167 Because engines that predate protocol version 2 do not send "feature",\r
1168 xboard uses a timeout mechanism: when it first starts your engine, it\r
1169 sends "xboard" and "protover N", then listens for feature commands for\r
1170 two seconds before sending any other commands.  To end this timeout\r
1171 and avoid the wait, set the feature "done=1" at the end of your last\r
1172 feature command.  To increase the timeout, if needed, set the feature\r
1173 "done=0" before your first feature command and "done=1" at the end.\r
1174 If needed, it is okay for your engine to set done=0 soon as it starts,\r
1175 even before it receives the xboard and protover commands.  This can be\r
1176 useful if your engine takes a long time to initialize itself.  It\r
1177 should be harmless even if you are talking to a (version 1) user\r
1178 interface that does not understand the "feature" command, since such\r
1179 interfaces generally ignore commands from the engine that they do not\r
1180 understand.\r
1181 </p>\r
1182 \r
1183 <p>\r
1184 The feature command is designed to let the protocol change without\r
1185 breaking engines that were written for older protocol versions.  When\r
1186 a new feature is added to the protocol, its default value is always\r
1187 chosen to be compatible with older versions of the protocol that did\r
1188 not have the feature.  Any feature that your engine does not set in a\r
1189 "feature" command retains its default value, so as the protocol\r
1190 changes, you do not have to change your engine to keep up with it\r
1191 unless you want to take advantage of a new feature.  Because some\r
1192 features are improvements to the protocol, while others are meant to\r
1193 cater to engines that do not implement all the protocol features, the\r
1194 recommended setting for a feature is not always the same as the\r
1195 default setting.  The listing below gives both default and recommended\r
1196 settings for most features.\r
1197 </p>\r
1198 \r
1199 <p>\r
1200 You may want to code your engine so as to be able to work with\r
1201 multiple versions of the engine protocol.  Protocol version 1 does not\r
1202 send the protover command and does not implement the feature command;\r
1203 if you send a feature command in protocol version 1, it will have no\r
1204 effect and there will be no response.  In protocol version 2 or later,\r
1205 each feature F that you set generates the response "accepted F" if the\r
1206 feature is implemented, or "rejected F" if it is not.  Thus an engine\r
1207 author can request any feature without having to keep track of which\r
1208 protocol version it was introduced in; you need only check whether the\r
1209 feature is accepted or rejected.  This mechanism also makes it\r
1210 possible for a user interface author to implement a subset of a\r
1211 protocol version by rejecting some features that are defined in that\r
1212 version; however, you should realize that engine authors are likely to\r
1213 code for xboard and may not be prepared to have a feature that they\r
1214 depend on be rejected.\r
1215 <font color=blue>If the GUI rejects an option feature because of the\r
1216 syntax of the value, it should print the value string with the\r
1217 "rejected" command, e.g. "rejected option nonsense" in response\r
1218 to receiving feature option="nonsense".</font>\r
1219 </p>\r
1220 \r
1221 <p>\r
1222 Here are the features that are currently defined.\r
1223 </p>\r
1224 </font>\r
1225 \r
1226 <dl>\r
1227 <dt><font color=red>\r
1228 <strong>ping</strong> (boolean, default 0, recommended 1)\r
1229 </font>\r
1230 <dd><font color=red>\r
1231 If ping=1, xboard may use the protocol's new "ping" command;\r
1232 if ping=0, xboard will not use the command.\r
1233 </font>\r
1234 \r
1235 <dt><font color=red>\r
1236 <strong>setboard</strong> (boolean, default 0, recommended 1)\r
1237 </font>\r
1238 <dd><font color=red>\r
1239 If setboard=1, xboard will use the protocol's new "setboard" command\r
1240 to set up positions; if setboard=0, it will use the older "edit" command.\r
1241 </font>\r
1242 \r
1243 <dt><font color=red>\r
1244 <strong>playother</strong> (boolean, default 0, recommended 1)\r
1245 </font>\r
1246 <dd><font color=red>\r
1247 If playother=1, xboard will use the protocol's new "playother" command\r
1248 when appropriate; if playother=0, it will not use the command.\r
1249 </font>\r
1250 \r
1251 <dt><font color=red>\r
1252 <strong>san</strong> (boolean, default 0)\r
1253 </font>\r
1254 <dd><font color=red>\r
1255 If san=1, xboard will send moves to the engine in standard algebraic\r
1256 notation (SAN); for example, Nf3.  If san=0, xboard will send moves in\r
1257 coordinate notation; for example, g1f3.  See MOVE in \r
1258 <a href="#8">section 8</a> above for more details of both kinds of notation.\r
1259 </font>\r
1260 \r
1261 <dt><font color=red>\r
1262 <strong>usermove</strong> (boolean, default 0)\r
1263 </font>\r
1264 <dd><font color=red>\r
1265 If usermove=1, xboard will send moves to the engine with the\r
1266 command "usermove MOVE"; if usermove=0, xboard will send just the move,\r
1267 with no command name.\r
1268 </font>\r
1269 \r
1270 <dt><font color=red>\r
1271 <strong>time</strong> (boolean, default 1, recommended 1)\r
1272 </font>\r
1273 <dd><font color=red>\r
1274 If time=1, xboard will send the "time" and "otim" commands to\r
1275 update the engine's clocks; if time=0, it will not.\r
1276 </font>\r
1277 \r
1278 <dt><font color=red>\r
1279 <strong>draw</strong> (boolean, default 1, recommended 1)\r
1280 </font>\r
1281 <dd><font color=red>\r
1282 If draw=1, xboard will send the "draw" command if the engine's opponent\r
1283 offers a draw; if draw=0, xboard will not inform the engine about\r
1284 draw offers.  Note that if draw=1, you may receive a draw offer while you\r
1285 are on move; if this will cause you to move immediately, you should set\r
1286 draw=0.\r
1287 </font>\r
1288 \r
1289 <dt><font color=red>\r
1290 <strong>sigint</strong> (boolean, default 1)\r
1291 </font>\r
1292 <dd><font color=red>\r
1293 If sigint=1, xboard may send SIGINT (the interrupt signal) to\r
1294 the engine as <a href="#7">section 7</a> above; if sigint=0, it will\r
1295 not.\r
1296 </font>\r
1297 \r
1298 <dt><font color=red>\r
1299 <strong>sigterm</strong> (boolean, default 1)\r
1300 </font>\r
1301 <dd><font color=red>\r
1302 If sigterm=1, xboard may send SIGTERM (the termination signal) to\r
1303 the engine as <a href="#7">section 7</a> above; if sigterm=0, it will\r
1304 not.\r
1305 </font>\r
1306 \r
1307 <dt><font color=red>\r
1308 <strong>reuse</strong> (boolean, default 1, recommended 1) \r
1309 </font>\r
1310 <dd><font color=red>\r
1311 If reuse=1, xboard may reuse your engine for multiple games.  If\r
1312 reuse=0 (or if the user has set the -xreuse option on xboard's command\r
1313 line), xboard will kill the engine process after every game and start\r
1314 a fresh process for the next game.\r
1315 </font>\r
1316 \r
1317 <dt><font color=red>\r
1318 <strong>analyze</strong> (boolean, default 1, recommended 1)\r
1319 </font>\r
1320 <dd><font color=red>\r
1321 If analyze=0, xboard will not try to use the "analyze" command; it\r
1322 will pop up an error message if the user asks for analysis mode.  If\r
1323 analyze=1, xboard will try to use the command if the user asks for\r
1324 analysis mode.\r
1325 </font>\r
1326 \r
1327 <dt><font color=red>\r
1328 <strong>myname</strong> (string, default determined from engine filename)\r
1329 </font>\r
1330 <dd><font color=red>\r
1331 This feature lets you set the name that xboard will use for your\r
1332 engine in window banners, in the PGN tags of saved game files, and when\r
1333 sending the "name" command to another engine.\r
1334 </font>\r
1335 \r
1336 <dt><font color=red>\r
1337 <strong>variants</strong> (string, see text below)\r
1338 </font>\r
1339 <dd><font color=red>\r
1340 This feature indicates which chess variants your engine accepts.\r
1341 It should be a comma-separated list of variant names.  See the table\r
1342 under the "variant" command in <a href="#8">section 8</a> above.  If\r
1343 you do not set this feature, xboard will assume by default that your\r
1344 engine supports all variants.  (However, the -zippyVariants\r
1345 command-line option still limits which variants will be accepted in\r
1346 Zippy mode.)  It is recommended that you set this feature to the\r
1347 correct value for your engine (just "normal" in most cases) rather\r
1348 than leaving the default in place, so that the user will get an\r
1349 appropriate error message if he tries to play a variant that your\r
1350 engine does not support.</font>\r
1351 <br>\r
1352 <font color=green>If your engine can play variants on a deviating board size,\r
1353 like capablanca on an 8x8 board, or capablanca crazyhouse,\r
1354 it can list them amongst the variants with a prefix spcifying board size plus\r
1355 holdings size, like 8x8+0_capablanca or 10x8+7_capablanca.\r
1356 If it is capable of playing any variant with an arbitrary board size,\r
1357 it should list "boardsize" as one of the variants.\r
1358 If there is a maximum to the board size, this can be prefixed,\r
1359 e.g. "12x10+0_boardsize".\r
1360 </font>\r
1361 \r
1362 <dt><font color=red>\r
1363 <strong>colors</strong> (boolean, default 1, recommended 0) \r
1364 </font>\r
1365 <dd><font color=red>\r
1366 If colors=1, xboard uses the obsolete "white" and "black"\r
1367 commands in a stylized way that works with most older chess engines\r
1368 that require the commands.  See the "<a href="#13">Idioms</a>" section\r
1369 below for details.  If colors=0, xboard does not use the "white" and\r
1370 "black" commands at all.\r
1371 </font>\r
1372 \r
1373 <dt><font color=red>\r
1374 <strong>ics</strong> (boolean, default 0)\r
1375 </font>\r
1376 <dd><font color=red>\r
1377 If ics=1, xboard will use the protocol's new "ics" command\r
1378 to inform the engine of whether or not it is playing on a chess server;\r
1379 if ics=0, it will not.\r
1380 </font>\r
1381 \r
1382 <dt><font color=red>\r
1383 <strong>name</strong> (boolean, see text below)\r
1384 </font>\r
1385 <dd><font color=red>\r
1386 If name=1, xboard will use the protocol's "name" command\r
1387 to inform the engine of the opponent's name; if name=0, it will not.\r
1388 By default, name=1 if the engine is playing on a chess server; name=0 if not.\r
1389 </font>\r
1390 \r
1391 <dt><font color=red>\r
1392 <strong>pause</strong> (boolean, default 0)\r
1393 </font>\r
1394 <dd><font color=red>\r
1395 If pause=1, xboard may use the protocol's new "pause" command;\r
1396 if pause=0, xboard assumes that the engine does not support this command.\r
1397 </font>\r
1398 \r
1399 <dt><font color=green>\r
1400 <strong>nps</strong> (boolean, default ?)\r
1401 </font>\r
1402 <dd><font color=green>\r
1403 If nps=1, it means the engine supports the nps command.\r
1404 If nps=0, it means the engine does not support it, and WinBoard should refrain from sending it.\r
1405 Default is that WinBoard sends it, in an attempt to try out if the engine understand it.\r
1406 The engine should properly respond with "Error (unkown command): nps" if it does not implement it,\r
1407 (as any protocol version pre-scribes),\r
1408 or WinBoard might assume that the engine did understand the command. \r
1409 In that case the use of different time standards that ensues could lead to time forfeits for the engine.\r
1410 </font>\r
1411 \r
1412 <dt><font color=green>\r
1413 <strong>debug</strong> (boolean, default 0)\r
1414 </font>\r
1415 <dd><font color=green>\r
1416 If debug=1, it means the engine wants to send debug output prefixed by '#',\r
1417 which WinBoard should ignore, except for including it in the winboard.debug file.\r
1418 As this feature is added to protocol 2 ony late,\r
1419 so that not all protocol-2 supporting versions of WinBoard might implement it,\r
1420 it is important that engines check if WinBoard accepts the feature.\r
1421 If the feature is rejected,\r
1422 engines must refrain from sending the debug output,\r
1423 or do so at their own risk.\r
1424 </font>\r
1425 \r
1426 <dt><font color=blue>\r
1427 <strong>memory</strong> (boolean, default 0)\r
1428 </font>\r
1429 <dd><font color=blue>\r
1430 If memory=1, the size of the total amount of memory available for the memory-consuming tables of the engine \r
1431 (e.g. hash, EGTB cache)\r
1432 will be set by the GUI through the "memory" command.\r
1433 </font>\r
1434 \r
1435 <dt><font color=blue>\r
1436 <strong>smp</strong> (boolean, default 0)\r
1437 </font>\r
1438 <dd><font color=blue>\r
1439 If smp=1, the GUI will send the "cores" command to the engine to inform it how many CPU cores it can use.\r
1440 Note that sending smp=1 does not imply the engine can use more than one CPU;\r
1441 just that it wants to receive the "cores" command.\r
1442 </font>\r
1443 \r
1444 <dt><font color=blue>\r
1445 <strong>egt</strong> (string, see text below)\r
1446 </font>\r
1447 <dd><font color=blue>\r
1448 This feature indicates which end-game table formats the engine supports.\r
1449 It should be a comma-separated list of format names.\r
1450 See under the "egtpath" command in <a href="#8">section 8</a> above.\r
1451 If you do not set this feature, xboard will assume the engine does not support end-game tables,\r
1452 and will not send any "egtpath" commands to inform the engine about their whereabouts.\r
1453 </font>\r
1454 \r
1455 <dt><font color=blue>\r
1456 <strong>option</strong> (string, see text below)\r
1457 </font>\r
1458 <dd><font color=blue>\r
1459 This feature is used by the engine to define an option command to appear in a GUI menu,\r
1460 so that the user can change the corresponding setting of the engine through the GUI interactively.\r
1461 The string describes the option by defining a name, type, current value and (sometimes) the acceptable value range.\r
1462 Unlike other features, option features are accumulated by the GUI, \r
1463 and the GUI must be able to add a new option to the list at any time,\r
1464 even after having received feature done=1.\r
1465 There are ten different options types, each requiring a slighly different syntax of the defining string:\r
1466 <br>\r
1467 feature option="NAME -button"\r
1468 <br>\r
1469 feature option="NAME -save"\r
1470 <br>\r
1471 feature option="NAME -reset"\r
1472 <br>\r
1473 feature option="NAME -check VALUE"\r
1474 <br>\r
1475 feature option="NAME -string VALUE"\r
1476 <br>\r
1477 feature option="NAME -spin VALUE MIN MAX"\r
1478 <br>\r
1479 feature option="NAME -combo CHOICE1 /// CHOICE2 ..."\r
1480 <br>\r
1481 feature option="NAME -slider VALUE MIN MAX"\r
1482 <br>\r
1483 feature option="NAME -file VALUE"\r
1484 <br>\r
1485 feature option="NAME -path VALUE"\r
1486 <br>\r
1487 NAME is an arbitrary alphanumeric string which can contain spaces; \r
1488 the other words in capitals would be replaced by the current (default) setting of the option,\r
1489 (a character string for -string options, a decimal number for -spin and -check options,\r
1490 were the latter uses 1=checked, 0=unchecked),\r
1491 the minimum or maximum value of numeric (-spin) options, \r
1492 or arbitrary text labels (for -combo option).\r
1493 In the latter case, the current value will be preceded by an asterisk.\r
1494 The -file and -path options are similar to -string, but can be used to inform the GUI that\r
1495 the text represents a file name or folder name respectively, \r
1496 so the GUI dialog could add the appropriate browse button to the text-edit field.\r
1497 Similarly, a -slider option is like a -spin, but the GUI might make a different\r
1498 graphical representation for it.\r
1499 A -save option is like a -button, and defines an immediate command to be sent by the engine.\r
1500 With -save the GUI will make sure all current option settings are flushed to the engine\r
1501 before it sends this command.\r
1502 A -reset option is like a -button, but use of it purges the list of options before sending \r
1503 the corresponding option command to the engine.\r
1504 This enables the engine to completely redefine its options or their current settings,\r
1505 by sending a new set of option feature commands to the GUI, \r
1506 terminated by feature done=1.\r
1507 (The effect of sending an option feature for an option with the same name as was defined before, \r
1508 without first receiving a -reset option command, is undefined.)\r
1509 </font>\r
1510 \r
1511 <dt><font color=red>\r
1512 <strong>done</strong> (integer, no default)\r
1513 </font>\r
1514 <dd><font color=red>\r
1515 If you set done=1 during the initial two-second timeout after\r
1516 xboard sends you the "xboard" command, the\r
1517 timeout will end and xboard will not look for any more feature\r
1518 commands before starting normal operation.\r
1519 If you set done=0, the initial timeout is increased to one hour;\r
1520 in this case, you must set done=1 before xboard will enter normal operation.\r
1521 </font>\r
1522 </dl>\r
1523 <p>\r
1524 \r
1525 <dt><strong>Illegal move: MOVE</strong>\r
1526 <dt><strong>Illegal move (REASON): MOVE</strong>\r
1527 <dd>If your engine receives a MOVE command that is recognizably a move\r
1528 but is not legal in the current position, your engine must print an\r
1529 error message in one of the above formats so that xboard can pass the\r
1530 error on to the user and retract the move.  The (REASON) is entirely\r
1531 optional.  Examples:\r
1532 \r
1533 <pre>\r
1534   Illegal move: e2e4\r
1535   Illegal move (in check): Nf3\r
1536   Illegal move (moving into check): e1g1\r
1537 </pre>\r
1538 <p>\r
1539 Generally, xboard will never send an ambiguous move, so it does not \r
1540 matter whether you respond to such a move with an Illegal move message \r
1541 or an Error message.\r
1542 </p>\r
1543 \r
1544 <dt><strong>Error (ERRORTYPE): COMMAND</strong>\r
1545 <dd>If your engine receives a command it does not understand or does\r
1546 not implement, it should print an error message in the above format so\r
1547 that xboard can parse it.  Examples:\r
1548 <pre>\r
1549   Error (ambiguous move): Nf3\r
1550   Error (unknown command): analyze\r
1551   Error (command not legal now): undo\r
1552   Error (too many parameters): level 1 2 3 4 5 6 7\r
1553 </pre>\r
1554 \r
1555 <dt><strong>move MOVE</strong>\r
1556 <dd>Your engine is making the move MOVE.  Do not echo moves from\r
1557 xboard with this command; send only new moves made by the engine.\r
1558 \r
1559 <font color=red>\r
1560 <p>For the actual move text from your chess engine (in place of MOVE\r
1561 above), your move should be either\r
1562 <ul>\r
1563 <li>in coordinate notation (e.g.,\r
1564 e2e4, e7e8q) with castling indicated by the King's two-square move (e.g.,\r
1565 e1g1), or\r
1566 <li>in Standard Algebraic Notation (SAN) as defined in the\r
1567 Portable Game Notation standard (e.g, e4, Nf3, O-O, cxb5, Nxe4, e8=Q),\r
1568 with the extension piece@square (e.g., P@f7) to handle piece placement\r
1569 in bughouse and crazyhouse.\r
1570 </ul>\r
1571 xboard itself also accepts some variants of SAN, but for compatibility\r
1572 with non-xboard interfaces, it is best not to rely on this behavior.\r
1573 </p>\r
1574 \r
1575 <p>Warning: Even though all versions of this protocol specification\r
1576 have indicated that xboard accepts SAN moves, some non-xboard\r
1577 interfaces are known to accept only coordinate notation.  See the\r
1578 Idioms section for more information on the known limitations of some\r
1579 non-xboard interfaces.  It should be safe to send SAN moves if you\r
1580 receive a "protover 2" (or later) command from the interface, but\r
1581 otherwise it is best to stick to coordinate notation for maximum\r
1582 compatibility.  An even more conservative approach would be for your\r
1583 engine to send SAN to the interface only if you have set feature san=1\r
1584 (which causes the interface to send SAN to you) and have received\r
1585 "accepted san" in reply.\r
1586 </p>\r
1587 </font>\r
1588 \r
1589 <dt><strong>RESULT {COMMENT}</strong> <dd>When your engine detects\r
1590 that the game has ended by rule, your engine must output a line of the\r
1591 form "RESULT {comment}" (without the quotes), where RESULT is a PGN\r
1592 result code (1-0, 0-1, or 1/2-1/2), and comment is the reason.  Here\r
1593 "by rule" means that the game is definitely over because of what\r
1594 happened on the board.  In normal chess, this includes checkmate,\r
1595 stalemate, triple repetition, the 50 move rule, or insufficient\r
1596 material; it does not include loss on time or the like.\r
1597 Examples:\r
1598 <pre>\r
1599   0-1 {Black mates}\r
1600   1-0 {White mates}\r
1601   1/2-1/2 {Draw by repetition}\r
1602   1/2-1/2 {Stalemate}\r
1603 </pre>\r
1604 \r
1605 <p>\r
1606 xboard relays the result to the user, the ICS, the other engine in Two\r
1607 Machines mode, and the PGN save file as required.\r
1608 <font color=green>Note that "definitey over" above means that sending this command \r
1609 will be taken by WinBoard as an unconditional refusal of the engine to play on,\r
1610 which might cause you to forfeit if the game was in fact not over.\r
1611 This command should thus not be used to offer draws, accept draws,\r
1612 or make draw-by-rule claims that are not yet valid in the current position\r
1613 (but will be after you move).\r
1614 For offering and claiming such draws, "offer draw" should be used.</font>\r
1615 <p>\r
1616 <font color=blue>\r
1617 Note that (in accordance with FIDE rules) only KK, KNK, KBK and KBKB with all bishops on the\r
1618 same color can be claimed as draws on the basis of insufficient mating material.\r
1619 The end-games KNNK, KBKN, KNKN and KBKB with unlike bishops do have mate positions,\r
1620 and cannot be claimed.\r
1621 Complex draws based on locked Pawn chains will not be recognized as draws by most interfaces,\r
1622 so do not claim in such positions, but just offer a draw or play on.\r
1623 </font>\r
1624 <p>\r
1625 <font color=blue>\r
1626 Note to GUI programmers: RESULT commands that the engine sends immediately after its move\r
1627 might be detected by the GUI only after the opponent has moved, because of communication\r
1628 and scheduling delays, no matter how fast the engine sent it.\r
1629 Any judgement of the validity of RESULT claims based on te "current" board position\r
1630 will have to account for this uncertainty.\r
1631 </font>\r
1632 </p>\r
1633 \r
1634 <dt><strong>resign</strong>\r
1635 <dd>If your engine wants to resign, it can send the command "resign".\r
1636 Alternatively, it can use the "RESULT {comment}" command if the string\r
1637 "resign" is included in the comment; for example "0-1 {White\r
1638 resigns}".  xboard relays the resignation to the user, the ICS, the\r
1639 other engine in Two Machines mode, and the PGN save file as required.\r
1640 <font color=blue>Note that many interfaces work more smoothly if you resign <em>before</em>\r
1641 you move.</font>\r
1642 <p>\r
1643 \r
1644 <dt><strong>offer draw</strong>\r
1645 <dd>If your engine wants to offer a draw by agreement (as opposed to\r
1646 claiming a draw by rule), it can send the command "offer draw".\r
1647 xboard relays the offer to the user, the ICS, the other engine in Two\r
1648 Machines mode, and the PGN save file as required.  In Machine White,\r
1649 Machine Black, or Two Machines mode, the offer is considered valid\r
1650 until your engine has made two more moves.\r
1651 <font color=green>This command must also be used to accept a draw offer.\r
1652 Do not use the 1/2-1/2 command for that, as the offer might be no longer valid,\r
1653 in which case a refusal to play on implied by the RESULT command might make you forfeit the game.\r
1654 "offer draw" should also be used to claim 50-move and 3-fold-repetition draws\r
1655 that will occur <em>after</em> your move, by sending it <em>before</em> making the move.\r
1656 WinBoard will grant draw offers without the opponent having any say in\r
1657 it in situations where draws can be claimed.\r
1658 Only if the draw cannot be claimed, the offer will be passed to your opponent after you make your next move,\r
1659 just before WinBoard relays this move to the opponent.\r
1660 </font>\r
1661 <p>\r
1662 \r
1663 <dt><font color=red><strong>tellopponent MESSAGE</strong></font>\r
1664 <dd><font color=red>\r
1665 This command lets the engine give a message to its opponent,\r
1666 independent of whether the opponent is a user on the local machine or\r
1667 a remote ICS user (Zippy mode).  MESSAGE consists of any characters,\r
1668 including whitespace, to the end of the line.  When the engine is\r
1669 playing against a user on the local machine, xboard pops up an\r
1670 information dialog containing the message.  When the engine is playing\r
1671 against an opponent on the ICS (Zippy mode), xboard sends "say\r
1672 MESSAGE\n" to the ICS.\r
1673 <p>\r
1674 \r
1675 <dt><strong>tellothers MESSAGE</strong> \r
1676 <dd>This command lets the engine give a message to people watching the\r
1677 game other than the engine's opponent.  MESSAGE consists of any\r
1678 characters, including whitespace, to the end of the line.  When the\r
1679 engine is playing against a user on the local machine, this command\r
1680 does nothing.  When the engine is playing against an opponent on the\r
1681 ICS (Zippy mode), xboard sends "whisper MESSAGE\n" to the ICS.\r
1682 <p>\r
1683 \r
1684 <dt><strong>tellall MESSAGE</strong>\r
1685 <dd>This command lets the engine give a message to its opponent and\r
1686 other people watching the game, \r
1687 independent of whether the opponent is a user on the local machine or\r
1688 a remote ICS user (Zippy mode).  MESSAGE consists of any characters,\r
1689 including whitespace, to the end of the line.  When the engine is\r
1690 playing against a user on the local machine, xboard pops up an\r
1691 information dialog containing the message.  When the engine is playing\r
1692 against an opponent on the ICS (Zippy mode), xboard sends "kibitz\r
1693 MESSAGE\n" to the ICS.\r
1694 </font>\r
1695 <p>\r
1696 \r
1697 <dt><strong>telluser MESSAGE</strong>\r
1698 <dd>xboard pops up an information dialog containing the message.\r
1699 MESSAGE consists of any characters, including whitespace, to the end\r
1700 of the line.\r
1701 <p>\r
1702 \r
1703 <dt><strong>tellusererror MESSAGE</strong>\r
1704 <dd>xboard pops up an error dialog containing the message.\r
1705 MESSAGE consists of any characters, including whitespace, to the end\r
1706 of the line.\r
1707 <p>\r
1708 \r
1709 <dt><strong>askuser REPTAG MESSAGE</strong>\r
1710 <dd>Here REPTAG is a string containing no whitespace, and MESSAGE\r
1711 consists of any characters, including whitespace, to the end of the\r
1712 line.  xboard pops up a question dialog that says MESSAGE and\r
1713 has a typein box.  If the user types in "bar", xboard sends "REPTAG\r
1714 bar" to the engine.  The user can cancel the dialog and send nothing.\r
1715 <p>\r
1716 \r
1717 <dt><strong>tellics MESSAGE</strong>\r
1718 <dd>In Zippy mode, xboard sends "MESSAGE\n" to ICS.  MESSAGE consists\r
1719 of any characters, including whitespace, to the end of the line.\r
1720 <p>\r
1721 \r
1722 <dt><font color=red><strong>tellicsnoalias MESSAGE</strong></font>\r
1723 <dd><font color=red>\r
1724 In Zippy mode, xboard sends "xMESSAGE\n" to ICS, where "x" is a\r
1725 character that prevents the ICS from expanding command aliases, if\r
1726 xboard knows of such a character.  (On and,\r
1727 "/" is used; on, "$" is used.)  MESSAGE consists of any\r
1728 characters, including whitespace, to the end of the line.\r
1729 </font>\r
1730 <p>\r
1731 \r
1732 <dt><font color=green><strong># COMMENT</strong></font>\r
1733 <dd><font color=green>\r
1734 The engine can send any string of printable characters, terminated by a newline,\r
1735 for inclusion in the winboard.debug file, provided the line starts with a '#' character.\r
1736 If the engine has set feature debug=1,\r
1737 it is guaranteed that WinBoard (and any future version of it) will completely ignore\r
1738 these lines in any other respect.\r
1739 </font>\r
1740 </dl>\r
1741 <p>\r
1742 \r
1743 <h2><a name="10">10. Thinking Output</a></h2>\r
1744 \r
1745 <p>\r
1746 If the user asks your engine to "show thinking", xboard sends your\r
1747 engine the "post" command.  It sends "nopost" to turn thinking off.\r
1748 In post mode, your engine sends output lines to show the progress of\r
1749 its thinking.  The engine can send as many or few of these lines as it\r
1750 wants to, whenever it wants to.  Typically they would be sent when the\r
1751 PV (principal variation) changes or the depth changes.  The thinking\r
1752 output should be in the following format:\r
1753 </p>\r
1754 \r
1755 <pre>ply score time nodes pv</pre>\r
1756 \r
1757 Where:\r
1758 <table>\r
1759 <tr align="left"><th>ply<td>Integer giving current search depth.\r
1760 <tr align="left"><th>score<td>Integer giving current evaluation in centipawns.\r
1761 <tr align="left"><th>time<td>Current search time in centiseconds (ex:\r
1762 1028 = 10.28 seconds).\r
1763 \r
1764 <tr align="left"><th>nodes<td>Nodes searched.\r
1765 <tr align="left"><th>pv<td>Freeform text giving current "best" line.\r
1766 You can continue the pv onto another line if you start each\r
1767 continuation line with at least four space characters.\r
1768 </table>\r
1769 \r
1770 <p>\r
1771 Example:\r
1772 </p>\r
1773 \r
1774 <pre>  9 156 1084 48000 Nf3 Nc6 Nc3 Nf6</pre>\r
1775 \r
1776 <p>\r
1777 Meaning:\r
1778 </p>\r
1779 \r
1780 9 ply, score=1.56, time = 10.84 seconds, nodes=48000, \r
1781 PV = "Nf3 Nc6 Nc3 Nf6"\r
1782 \r
1783 <p>\r
1784 Longer example from actual Crafty output:\r
1785 </p>\r
1786 <pre>\r
1787   4    109      14   1435  1. e4 d5 2. Qf3 dxe4 3. Qxe4 Nc6\r
1788   4    116      23   2252  1. Nf3 Nc6 2. e4 e6\r
1789   4    116      27   2589  1. Nf3 Nc6 2. e4 e6\r
1790   5    141      44   4539  1. Nf3 Nc6 2. O-O e5 3. e4\r
1791   5    141      54   5568  1. Nf3 Nc6 2. O-O e5 3. e4\r
1792 </pre>\r
1793 \r
1794 <p>\r
1795 You can use the PV to show other things; for instance, while in book,\r
1796 Crafty shows the observed frequency of different reply moves in its\r
1797 book.  In situations like this where your engine is not really\r
1798 searching, start the PV with a '(' character:\r
1799 </p>\r
1800 \r
1801 <pre>\r
1802   0      0       0      0  (e4 64%, d4 24%)\r
1803 </pre>\r
1804 \r
1805 <p>\r
1806 GNU Chess output is very slightly different.  The ply number is\r
1807 followed by an extra nonblank character, and the time is in seconds,\r
1808 not hundredths of seconds.  For compatibility, xboard accepts the\r
1809 extra character and takes it as a flag indicating the different time\r
1810 units.  Example:\r
1811 </p>\r
1812 \r
1813 <pre>\r
1814  2.     14    0       38   d1d2  e8e7 \r
1815  3+     78    0       65   d1d2  e8e7  d2d3 \r
1816  3&     14    0       89   d1d2  e8e7  d2d3 \r
1817  3&     76    0      191   d1e2  e8e7  e2e3 \r
1818  3.     76    0      215   d1e2  e8e7  e2e3 \r
1819  4&     15    0      366   d1e2  e8e7  e2e3  e7e6 \r
1820  4.     15    0      515   d1e2  e8e7  e2e3  e7e6 \r
1821  5+     74    0      702   d1e2  f7f5  e2e3  e8e7  e3f4 \r
1822  5&     71    0     1085   d1e2  e8e7  e2e3  e7e6  e3f4 \r
1823  5.     71    0     1669   d1e2  e8e7  e2e3  e7e6  e3f4 \r
1824  6&     48    0     3035   d1e2  e8e7  e2e3  e7e6  e3e4  f7f5  e4d4 \r
1825  6.     48    0     3720   d1e2  e8e7  e2e3  e7e6  e3e4  f7f5  e4d4 \r
1826  7&     48    0     6381   d1e2  e8e7  e2e3  e7e6  e3e4  f7f5  e4d4 \r
1827  7.     48    0    10056   d1e2  e8e7  e2e3  e7e6  e3e4  f7f5  e4d4 \r
1828  8&     66    1    20536   d1e2  e8e7  e2e3  e7e6  e3d4  g7g5  a2a4  f7f5 \r
1829  8.     66    1    24387   d1e2  e8e7  e2e3  e7e6  e3d4  g7g5  a2a4  f7f5 \r
1830  9&     62    2    38886   d1e2  e8e7  e2e3  e7e6  e3d4  h7h5  a2a4  h5h4 \r
1831                            d4e4 \r
1832  9.     62    4    72578   d1e2  e8e7  e2e3  e7e6  e3d4  h7h5  a2a4  h5h4 \r
1833                            d4e4 \r
1834 10&     34    7   135944   d1e2  e8e7  e2e3  e7e6  e3d4  h7h5  c2c4  h5h4 \r
1835                            d4e4  f7f5  e4f4 \r
1836 10.     34    9   173474   d1e2  e8e7  e2e3  e7e6  e3d4  h7h5  c2c4  h5h4 \r
1837                            d4e4  f7f5  e4f4 \r
1838 </pre>\r
1839 \r
1840 <p>If your engine is pondering (thinking on its opponent's time) in post\r
1841 mode, it can show its thinking then too.  In this case your engine may\r
1842 omit the hint move (the move it is assuming its opponent will make)\r
1843 from the thinking lines <em>if and only if</em> it sends xboard the move in\r
1844 the usual "Hint: xxx" format before sending the first line.\r
1845 </p>\r
1846 \r
1847 <h2><a name="11">11. Time control</a></h2>\r
1848 \r
1849 <p>\r
1850 xboard supports three styles of time control: conventional chess clocks,\r
1851 the ICS-style incremental clock, and an exact number of seconds per move.\r
1852 </p>\r
1853 \r
1854 <p>In conventional clock mode, every time control period is the same.\r
1855 That is, if the time control is 40 moves in 5 minutes, then after each\r
1856 side has made 40 moves, they each get an additional 5 minutes, and so\r
1857 on, ad infinitum.  At some future time it would be nice to support a\r
1858 series of distinct time controls.  This is very low on my personal\r
1859 priority list, but code donations to the xboard project are accepted,\r
1860 so feel free to take a swing at it.  I suggest you talk to me first,\r
1861 though.\r
1862 </p>\r
1863 \r
1864 <p>\r
1865 The command to set a conventional time control looks like this:\r
1866 </p>\r
1867 \r
1868 <pre>\r
1869   level 40 5 0\r
1870   level 40 0:30 0\r
1871 </pre>\r
1872 \r
1873 <p>\r
1874 The 40 means that there are 40 moves per time control.  The 5 means\r
1875 there are 5 minutes in the control.  In the second example, the 0:30\r
1876 means there are 30 seconds.  The final 0 means that we are in\r
1877 conventional clock mode.\r
1878 </p>\r
1879 \r
1880 <p>\r
1881 <font color=green>\r
1882 Note that the time parameter in this command is not a pure numeric argument,\r
1883 but in general is a character string, in order to pass the number of seconds.\r
1884 Engines are encouraged to ignore any unexpected characters at the end of this string,\r
1885 i.e. following the MIN or MIN:SEC specification.\r
1886 Future protocol versions might (under control of an appropriate feature)\r
1887 append such extra characters to this argument,\r
1888 in order to inform the engine in advance of the time control it can expect after the current session completes.\r
1889 E.g. "level 40 25+5 0" could mean that the engine has to play 40 moves in 25 minutes,\r
1890 but should expect to get only 5 minutes for the entire remainder of the game after that,\r
1891 rather than another 25 minutes for the next 40 moves.\r
1892 When the time comes, (i.e. after the 40 moves), \r
1893 it will be informed of the time-control change by receiving a new "level 0 5 0" command,\r
1894 but engines with advanced time management might want to plan for this in advance.\r
1895 </font>\r
1896 </p>\r
1897 \r
1898 <p>\r
1899 The command to set an incremental time control looks like this:\r
1900 </p>\r
1901 \r
1902 <pre>\r
1903   level 0 2 12\r
1904 </pre>\r
1905 \r
1906 <p>\r
1907 Here the 0 means "play the whole game in this time control period",\r
1908 the 2 means "base=2 minutes", and the 12 means "inc=12 seconds".  As\r
1909 in conventional clock mode, the second argument to level can be in\r
1910 minutes and seconds.\r
1911 </p>\r
1912 \r
1913 <p>\r
1914 At the start of the game, each player's clock is set to base minutes.\r
1915 Immediately after a player makes a move, inc seconds are added to his\r
1916 clock.  A player's clock counts down while it is his turn.  Your flag\r
1917 can be called whenever your clock is zero or negative.  (Your clock\r
1918 can go negative and then become positive again because of the\r
1919 increment.)\r
1920 </p>\r
1921 \r
1922 <p><font color=blue>\r
1923 The number of moves given in the level command (when non-zero) should \r
1924 be taken as the number of moves still to do before the specified time\r
1925 will be added to the clock, if the "level" command is received after\r
1926 some moves have already been played.\r
1927 The time given should be interpreted as the time left on its clock\r
1928 (including any time left over from the previous sessions),\r
1929 and not necessarily the time that will be added to the clock\r
1930 after the specified number of moves has been played.\r
1931 This is only relevant in WinBoard 4.3.xx, which might send the engine\r
1932 "level" commands during a game,\r
1933 just before the engine has to start thinking about the first move of \r
1934 a new time-control session.\r
1935 Example: if at the start of the game "level 40 60 0" was given \r
1936 (40 moves per hour),\r
1937 and the engine receives "level 20 22 0" just before move 41,\r
1938 it should understand that it should do the next 20 moves in 22 minutes\r
1939 (pehaps because the secondary session was 20 moves per 15 minutes,\r
1940 and it had 7 minutes left on its clock after the first 40 moves).\r
1941 </font></p>\r
1942 \r
1943 <p>\r
1944 A special rule on some ICS implementations: if you ask for a game with\r
1945 base=0, the clocks really start at 10 seconds instead of 0.  xboard\r
1946 itself does not know about this rule, so it passes the 0 on to the\r
1947 engine instead of changing it to 0:10.\r
1948 </p>\r
1949 \r
1950 <p>\r
1951 ICS also has time odds games.  With time odds, each player has his own\r
1952 (base, inc) pair, but otherwise things work the same as in normal\r
1953 games.  The Zippy xboard accepts time odds games but ignores the fact\r
1954 that the opponent's parameters are different; this is perhaps not\r
1955 quite the right thing to do, but gnuchess doesn't understand time\r
1956 odds.  Time odds games are always unrated.\r
1957 </p>\r
1958 \r
1959 <p>\r
1960 The command to set an exact number of seconds per move looks like this:\r
1961 </p>\r
1962 \r
1963 <pre>\r
1964   st 30\r
1965 </pre>\r
1966 \r
1967 <p>\r
1968 This means that each move must be made in at most 30 seconds.  Time not used\r
1969 on one move does not accumulate for use on later moves.\r
1970 </p>\r
1971 \r
1972 <h2><a name="12">12. Analyze Mode</a></h2>\r
1973 \r
1974 <p>xboard supports analyzing fresh games, edited positions, and games\r
1975 from files.  However, all of these look the same from the chess\r
1976 engine's perspective. Basically, the engine just has to respond to the\r
1977 "analyze" command.  \r
1978 <font color=red>\r
1979 Beginning in protocol version 2,\r
1980 if your engine does not support analyze mode, it should use\r
1981 the feature command to set analyze=0.  \r
1982 </font>\r
1983 The older method of\r
1984 printing the error message "Error (unknown command): analyze" in\r
1985 response to the "analyze" command will also work, however.\r
1986 </p>\r
1987 \r
1988 <p>\r
1989 To enter analyze mode, xboard sends the command sequence "post", "analyze".  \r
1990 Analyze mode in your engine should be\r
1991 similar to force mode, except that your engine thinks about what move\r
1992 it would make next if it were on move.  Your engine should accept the\r
1993 following commands while in analyze mode:\r
1994 </p>\r
1995 \r
1996 <ul>\r
1997 <li>Any legal move, as in force mode\r
1998 <li><strong>undo</strong>&nbsp;&nbsp; Back up one move and analyze previous position.\r
1999 <li><strong>new</strong>&nbsp;&nbsp; Reset position to start of game but stay in analyze mode.\r
2000 <li><font color=red><strong>setboard</strong> if you have set feature setboard=1; otherwise <strong>edit</strong>.  Exiting edit mode returns to analyze mode.\r
2001 </font>\r
2002 <li><strong>exit</strong>&nbsp;&nbsp; Leave analyze mode.\r
2003 <li><strong>.</strong>&nbsp;&nbsp; Send a search status update (optional); see below.\r
2004 <li><font color=red>\r
2005 <strong>bk</strong>&nbsp;&nbsp; Show book moves from this position,\r
2006 if any; see above.</font>\r
2007 <li><font color=red>\r
2008 <strong>hint</strong>&nbsp;&nbsp; Show the predicted move from this\r
2009 position, if any; see above.</font>\r
2010 </ul>\r
2011   \r
2012 <p>\r
2013 If the user selects "Periodic Updates", xboard will send the string\r
2014 ".\n" to the chess engine periodically during analyze mode, unless the\r
2015 last PV received began with a '(' character.\r
2016 </p>\r
2017 \r
2018 <p>\r
2019 The chess engine should respond to ".\n" with a line like this:\r
2020 </p>\r
2021 \r
2022 <pre>\r
2023 stat01: time nodes ply mvleft mvtot <font color=red>mvname</font>\r
2024 </pre>\r
2025 \r
2026 Where:\r
2027 <table>\r
2028 <tr align="left"><th>time<td>Elapsed search time in centiseconds (ie: 567 = 5.67 seconds).\r
2029 <tr align="left"><th>nodes<td>Nodes searched so far.\r
2030 <tr align="left"><th>ply<td>Search depth so far.\r
2031 <tr align="left"><th>mvleft<td>Number of moves left to consider at this depth.\r
2032 <tr align="left"><th>mvtot<td>Total number of moves to consider.\r
2033 <tr align="left"><th><font color=red>mvname</font><td><font color=red>\r
2034 Move currently being considered (SAN or coordinate notation).  Optional;\r
2035 added in protocol version 2.</font>\r
2036 </table>\r
2037 \r
2038 <p>\r
2039 Examples:\r
2040 </p>\r
2041 <pre>\r
2042   stat01: 1234 30000 7 5 30\r
2043   stat01: 1234 30000 7 5 30 Nf3\r
2044 </pre>\r
2045 \r
2046 <p>\r
2047 Meaning:\r
2048 </p>\r
2049 \r
2050 <p>After 12.34 seconds, I've searched 7 ply/30000 nodes, there are a\r
2051   total of 30 legal moves, and I have 5 more moves to search\r
2052   before going to depth 8.  In the second example, of the 30 legal\r
2053   moves, the one I am currently searching is Nf3.</p>\r
2054 \r
2055 <p>\r
2056 Implementation of the "." command is optional. If the engine does not\r
2057 respond to the "." command with a "stat01..." line, xboard will stop\r
2058 sending "."  commands.  If the engine does not implement this command,\r
2059 the analysis window will use a shortened format to display the engine\r
2060 info.\r
2061 </p>\r
2062 \r
2063 <p>\r
2064 To give the user some extra information, the chess engine can output\r
2065 the strings "++\n" and "--\n", to indicate that the current search is\r
2066 failing high or low, respectively.  You don't have to send anything\r
2067 else to say "Okay, I'm not failing high/low anymore."  xboard will\r
2068 figure this out itself.\r
2069 </p>\r
2070 \r
2071 <h2><a name="13">13. Idioms and backward compatibility features</a></h2>\r
2072 \r
2073 <p>\r
2074 Some engines have variant interpretations of the force/go/white/black,\r
2075 time/otim, and hard/easy command sets.  \r
2076 In order to accommodate these older engines, xboard uses these commands\r
2077 only according to the stylized patterns ("idioms") given in this section.\r
2078 The obsolete white and black commands\r
2079 have historically been particularly troublesome, and it is recommended\r
2080 that new engines set the feature colors=0 and/or ignore the commands.\r
2081 </p>\r
2082 \r
2083 <dl>\r
2084 \r
2085 <dt><strong>time N</strong>\r
2086 <dt><strong>otim N</strong>\r
2087 <dt><strong>MOVE</strong>\r
2088 <dd>Sent when the opponent makes a move and the engine is already\r
2089 playing the opposite color.\r
2090 <p>\r
2091 \r
2092 <dt><strong>white</strong>\r
2093 <dt><strong>go</strong>\r
2094 <dd>Sent when the engine is in force mode or playing Black but should\r
2095 switch to playing White.  This sequence is sent only when White is\r
2096 already on move.  \r
2097 <font color=red>\r
2098 If you set the feature colors=0, "white" is not sent.\r
2099 </font>\r
2100 <p>\r
2101 \r
2102 <dt><strong>black</strong>\r
2103 <dt><strong>go</strong>\r
2104 <dd>Sent when the engine is in force mode or playing White but should\r
2105 switch to playing Black.  This sequence is sent only when Black is\r
2106 already on move.  \r
2107 <font color=red>\r
2108 If you set the feature colors=0, "black" is not sent.\r
2109 </font>\r
2110 <p>\r
2111 \r
2112 <dt><strong>white</strong>\r
2113 <dt><strong>time N</strong>\r
2114 <dt><strong>otim N</strong>\r
2115 <dt><strong>black</strong>\r
2116 <dt><strong>go</strong>\r
2117 <dd>Sent when Black is on move, the engine is in force mode or playing\r
2118 White, and the engine's clock needs to be updated before it starts\r
2119 playing.  \r
2120 The initial "white" is a kludge to accommodate GNU Chess\r
2121 4's variant interpretation of these commands.  \r
2122 <font color=red>\r
2123 If you set the feature colors=0, "white" and "black" are not sent.\r
2124 </font>\r
2125 <p>\r
2126 \r
2127 <dt><strong>black</strong>\r
2128 <dt><strong>time N</strong>\r
2129 <dt><strong>otim N</strong>\r
2130 <dt><strong>white</strong>\r
2131 <dt><strong>go</strong>\r
2132 <dd>Sent when White is on move, the engine is in force mode or playing\r
2133 Black, and the engine's clock needs to be updated before it starts\r
2134 playing.  See previous idiom.  \r
2135 The initial "black" is a kludge to accommodate GNU Chess\r
2136 4's variant interpretation of these commands.  \r
2137 <font color=red>\r
2138 If you set the feature colors=0, "black" and "white" are not sent.\r
2139 </font>\r
2140 <p>\r
2141 \r
2142 <dt><strong>hard</strong>\r
2143 <dt><strong>easy</strong>\r
2144 <dd>Sent in sequence to turn off pondering if xboard is not sure\r
2145 whether it is on.  When xboard is sure, it will send "hard" or "easy"\r
2146 alone.  xboard does this because "easy" is a toggle in GNU Chess 4 but\r
2147 "hard" is an absolute on.\r
2148 \r
2149 </dl>\r
2150 \r
2151 <p>\r
2152 To support older engines, certain additional commands from the engine\r
2153 to xboard are also recognized.  (These are commands by themselves, not\r
2154 values to be placed in the comment field of the PGN result code.)\r
2155 These forms are not recommended for new engines; use the PGN result\r
2156 code commands or the resign command instead.\r
2157 </p>\r
2158 \r
2159 <table>\r
2160 <tr align="left"><th>Command              <th>Interpreted as\r
2161 <tr align="left"><td>White resigns        <td>0-1 {White resigns}\r
2162 <tr align="left"><td>Black resigns        <td>1-0 {Black resigns}\r
2163 <tr align="left"><td>White                <td>1-0 {White mates}\r
2164 <tr align="left"><td>Black                <td>0-1 {Black mates}\r
2165 <tr align="left"><td>Draw                 <td>1/2-1/2 {Draw}\r
2166 <tr align="left"><td>computer mates       <td>1-0 {White mates} or 0-1 {Black mates}\r
2167 <tr align="left"><td>opponent mates       <td>1-0 {White mates} or 0-1 {Black mates}\r
2168 <tr align="left"><td>computer resigns     <td>0-1 {White resigns} or 1-0 {Black resigns}\r
2169 <tr align="left"><td>game is a draw       <td>1/2-1/2 {Draw}\r
2170 <tr align="left"><td>checkmate            <td>1-0 {White mates} or 0-1 {Black mates}\r
2171 </table>\r
2172 \r
2173 <p>\r
2174 Commands in the above table are recognized if they begin a line and\r
2175 arbitrary characters follow, so (for example) "White mates" will be\r
2176 recognized as "White", and "game is a draw by the 50 move rule" will\r
2177 be recognized as "game is a draw".  All the commands are\r
2178 case-sensitive.\r
2179 </p>\r
2180 \r
2181 <p>\r
2182 An alternative move syntax is also recognized:\r
2183 </p>\r
2184 \r
2185 <table>\r
2186 <tr align="left"><th>Command              <th>Interpreted as\r
2187 <tr align="left"><td>NUMBER ... MOVE      <td>move MOVE\r
2188 </table>\r
2189 \r
2190 <p>\r
2191 Here NUMBER means any string of decimal digits, optionally ending in a\r
2192 period.  MOVE is any string containing no whitespace.  In this command\r
2193 format, xboard requires the "..." even if your engine is playing\r
2194 White.  A command of the form NUMBER MOVE will be ignored.  This odd\r
2195 treatment of the commands is needed for compatibility with gnuchessx.\r
2196 The original reasons for it are lost in the mists of time, but I\r
2197 suspect it was originally a bug in the earliest versions of xboard,\r
2198 before I started working on it, which someone "fixed" in the wrong\r
2199 way, by creating a special version of gnuchess (gnuchessx) instead of\r
2200 changing xboard.\r
2201 </p>\r
2202 \r
2203 <p>\r
2204 Any line that contains the words "offer" and "draw" is recognized as\r
2205 "offer draw".\r
2206 </p>\r
2207 \r
2208 <p>\r
2209 The "Illegal move" message is recognized even if spelled "illegal\r
2210 move" and even if the colon (":") is omitted.  This accommodates GNU\r
2211 Chess 4, which prints messages like "Illegal move (no matching\r
2212 move)e2e4", and old versions of Crafty, which print just "illegal move".\r
2213 </p>\r
2214 \r
2215 <p>\r
2216 In Zippy mode, for compatibility with older versions of Crafty,\r
2217 xboard passes through to ICS any line that begins "kibitz", "whisper",\r
2218 "tell", or "draw".  Do not use this feature in new code.  Instead, use the\r
2219 commands "tellall", "tellothers", "tellopponent", "tellics" (if needed),\r
2220 "1/2-1/2 {COMMENT}", or "offer draw", as appropriate.\r
2221 </p>\r
2222 \r
2223 <p>\r
2224 <font color=red>\r
2225 If the engine responds to the "sd DEPTH" command with an error message\r
2226 indicating the command is not supported (such as "Illegal move: sd"),\r
2227 xboard sets an internal flag and subsequently uses the command\r
2228 "depth\nDEPTH" instead, for the benefit of GNU Chess 4.  Note the\r
2229 newline in the middle of this command!  New engines should not rely on\r
2230 this feature.\r
2231 </font>\r
2232 </p>\r
2233 \r
2234 <p>\r
2235 <font color=red>\r
2236 If the engine responds to the "st TIME" command with an error message\r
2237 indicating the command is not supported (such as "Illegal move: st"),\r
2238 xboard sets an internal flag and subsequently uses the command "level\r
2239 1 TIME" instead, for the benefit of GNU Chess 4.  Note that this is\r
2240 not a standard use of the level command, as TIME seconds are not added\r
2241 after each player makes 1 move; rather, each move is made in at most\r
2242 TIME seconds.  New engines should not implement or rely on this\r
2243 feature.\r
2244 </font>\r
2245 </p>\r
2246 \r
2247 <font color=red>\r
2248 <p>\r
2249 In support of the -firstHost/-secondHost features, which allow a chess\r
2250 engine to be run on another machine using the rsh protocol, xboard recognizes\r
2251 error messages that are likely to come from rsh as fatal errors.  The following\r
2252 messages are currently recognized:\r
2253 </p>\r
2254 \r
2255 <blockquote>\r
2256 unknown host<br>\r
2257 No remote directory<br>\r
2258 not found<br>\r
2259 No such file<br>\r
2260 can't alloc<br>\r
2261 Permission denied<br>\r
2262 </blockquote>\r
2263 </font>\r
2264 \r
2265 <p>\r
2266 <font color=red>\r
2267 ChessBase/Fritz now implements the xboard/winboard protocol and can use\r
2268 WinBoard-compatible engines in its GUI.  ChessBase's version of the\r
2269 protocol is generally the same as version 1, except that they have\r
2270 added the commands <strong>fritz</strong>, <strong>reset</strong>, and\r
2271 <strong>ponder</strong>, and the edit subcommands\r
2272 <strong>castle</strong> and <strong>ep</strong>.  If you want your\r
2273 engine to work well with the ChessBase/Fritz GUI, you may need to\r
2274 implement these additional commands, and you should also be aware of\r
2275 the peculiar way that ChessBase uses the protocol.  See their <a\r
2276 href=""\r
2277 >web page</a> for documentation.\r
2278 </font>\r
2279 </p>\r
2280 \r
2281 <p>\r
2282 <font color=red>\r
2283 ChessMaster 8000 also implements version 1 of the xboard/winboard\r
2284 protocol and can use WinBoard-compatible engines.  The original\r
2285 release of CM8000 also has one additional restriction: only pure\r
2286 coordinate notation (e.g., e2e4) is accepted in the move command.  A\r
2287 patch to correct this should be available from The Learning Company\r
2288 (makers of CM8000) in February 2001.\r
2289 </font>\r
2290 </p>\r
2291 \r
2292 <hr noshade size="2">\r
2293 <address>converted to HTML by <a href="">Steffen A. Jakob</a></address>\r
2294 </body>\r
2295 </html>\r