1 POLYGLOT(6) POLYGLOT(6)
6 PolyGlot - Winboard protocol to UCI protocol adapter
7 - book engine for Polyglot books
8 - a collection of utilities for creating and analyzing
10 - a utility for analyzing epd files
14 polyglot [configfile] [-noini] [-ec engine] [-ed enginedirectory] [-en
15 enginename] [-log] [-lf logfile] [-hash value] [-bk book] [-pg
16 <name>=<value>]* [-uci <name>=<value>]*
18 polyglot make-book [-pgn inputfile] [-bin outputfile] [-max-ply ply]
19 [-min-game games] [-min-score score] [-only-white] [-only-black]
22 polyglot merge-book -in1 inputfile1 -in2 inputfile2 [-out outputfile]
24 polyglot info-book [-bin inputfile] [-exact]
26 polyglot dump-book [-bin inputfile] -color color [-out outputfile]
28 polyglot [configfile] epd-test [engineoptions] [-epd inputfile]
29 [-min-depth depth] [-max-depth depth] [-max-time time] [-depth-delta
32 polyglot perft [-fen fen] [-max-depth depth]
35 PolyGlot as adapter and book engine
37 PolyGlot is a "UCI adapter". It connects a GUI interface (such as
38 XBoard, Winboard, Arena or Chessbase) to a UCI chess engine.
40 By specifying an opening book (in PolyGlot book format) chess engines
41 can transparently use such books.
43 PolyGlot understands the two main GUI protocols: UCI and xboard.
44 Normally the protocol will be auto detected but this can be overridden
45 in the configuration file.
47 In xboard mode PolyGlot fully translates between the xboard and UCI
48 protocols. In addition it tries to solve known problems with other
49 adapters. For instance, it detects and reports draws by fifty-move
50 rule, repetition, etc ... It also supports Chess960.
52 When in UCI mode PolyGlot mostly passes commands from the GUI to the
53 engine and vice versa, except that it will play book moves on behalf of
54 the engine when the occasion arises.
56 The engine options are exported as UCI options in UCI mode and as
57 "feature option=" commands in xboard mode. The latter form an extension
58 of the xboard protocol as defined by H.G. Muller.
60 Options which normally appear in the [PolyGlot] section of the config
61 file (see below) are exported as options with their name prefixed by
62 "Polyglot". This makes it easy to filter them in the GUI.
64 NOTE: Not all options are exported, only those that make sense in the
69 PolyGlot supports the "PolyGlot opening book format". This is the
70 defacto standard non-proprietary opening book format. It is fully
73 http://alpha.uhasselt.be/Research/Algebra/Toga/book_format.html
75 Roughly speaking a PolyGlot opening book is a collection of triples
76 (position, move, weight). A "position" is represented by a 64-bit
77 Zobrist hash key. The weight is proportional to the probability the
78 move should be played.
80 Other opening book formats such as ChessBase's .ctg format and Arena's
81 .abk format are undocumented and proprietary. They can only be used by
84 PolyGlot can compile a pgn file into a binary PolyGlot book and
85 furthermore it can merge two such binary books into a third one.
87 PolyGlot can also extract some useful information from PolyGlot books.
88 The utility "dump-book" dumps the "lines" in a book for a given color.
89 By definition a line is a sequence of moves (from the starting
90 position) in which the given color makes only book moves and the other
91 color makes arbitrary moves (i.e. not necessarily book moves).
93 Since a PolyGlot book is built up from positions and not lines there
94 may be (and there usually are) many positions in the book that are not
95 on a "line" as defined in the previous paragraph. It is convenient to
96 call such positions "isolated" positions. The utility "info-book"
97 counts such isolated positions.
99 Some of the isolated positions are provably unreachable and they could
100 in principle be deleted from the book. For example if a book contains
101 only the move "e4" in the starting position but also the position after
102 "d4 d5" then this last position is provably unreachable since it
103 requires white to make a non-book move when a book move is available.
104 Such situations arise frequently from the priority rules in merging
107 Unfortunately not all isolated positions are provably unreachable and
108 it is difficult to identify the latter. If invoked with "-exact" the
109 utility info-book will attempt to count the isolated positions which
110 require a player to make a non-book move when a book move is available.
111 Due to the possibility of transpositions this is not a fool proof
116 In epd test mode, PolyGlot will search positions in an epd file and
117 record the number of times the right best move was found. The
118 arguments specify when to stop the search in any given position.
122 A perft count is the number of legal move sequence in a given position
123 up to a given depth. PolyGlot can perform such perft counts. It is
124 however much slower than other more dedicated programs.
127 When PolyGlot is invoked as an adapter of in epd-test mode it gets its
128 options from a config file and then from the command line. The default
129 config file is "polyglot.ini" but an alternative one may be optionally
130 included as first argument. The config file format is described below.
132 The following engine options may be specified on the command line.
135 Do not use a config file, even if one was specified on the command
138 -pg The argument is a string of the form <name>=<value>. This option
139 will set the Polyglot option <name> to <value>.
142 The argument is a string of the form <name>=<value>. This option
143 will set the engine option <name> to <value>.
145 -ec This sets the EngineCommand.
147 -ed This sets the EngineDir.
149 -en This sets the EngineName.
152 This is an alias for -uci "Hash=<value>".
155 This is an alias for -pg "Log=true".
157 -lf (default: "polyglot.log")
158 This is an alias for -pg "LogFile=<value>".
160 -bk This is an alias for -pg "Book=true" -pg "BookFile=<value>".
166 PolyGlot supports the following options
168 -pgn (default: "book.pgn")
169 Input file in pgn format.
171 -bin (default: "book.bin")
172 Output file in PolyGlot format.
174 -max-ply (default: 1024)
175 Specifies the maximum ply-depth of lines included in the book.
177 -min-game (default: 3)
178 Specifies the minimum number of games that have to contain this
179 move for it to be included in the book.
181 -min-score (default: 0.0)
182 Specifies the minimum score (or weight) this move should have
183 received for it to be included in the book. The score is
184 2*(wins)+(draws), globally scaled to fit into 16 bits.
187 Include only moves for white in the book.
190 Include only moves for black in the book.
193 Set all weights to 1. In other words, all moves will be selected
194 with equal probability.
200 PolyGlot supports the following options
203 First input file (in PolyGlot book format).
206 Second input file (in PolyGlot book format).
208 -out (default: out.bin)
209 Output file (in PolyGlot book format).
211 Input files are not symmetrical, "in1" has priority over "in2". In
212 other words when a position occurs both in "in1" and "in2" only the
213 moves and weights from "in1" will be retained in "out".
219 PolyGlot supports the following options
221 -bin (default: book.bin)
222 Input file in PolyGlot book format.
225 The color for whom to generate the lines.
227 -out (default: book_<color>.txt)
228 The name of the output file.
234 PolyGlot supports the following options
236 -bin (default: book.bin)
237 Input file in PolyGlot book format.
240 Attempt to count the provably unreachable positions among the
241 isolated ones. Note that this takes a very long time.
247 (possibly with a config file as first argument) PolyGlot supports
248 besides the generic options described above the following additional
251 -max-depth (default: 63)
252 Unconditionally stop the search when this depth has been reached.
254 -max-time (default: 5.0)
255 Unconditionally stop the seach after this amount of time.
257 -depth-delta (default: 3)
258 Stop the search if the solution as been found and the best move has
259 been constant for this many depths, on condition that the mininal
260 depth and minimal time have been reached.
262 -min-depth (default: 8)
263 Minimal search depth when the search is stopped using
266 -min-time (default: 1.0)
267 Minimal search time when the search is stopped using
274 PolyGlot supports the following options
276 -fen (default: starting position)
277 Fen at which to start searching.
279 -max-depth (default: 1)
280 Maximum depth to search.
283 There should be a different config file for each engine.
285 The config file is in the traditional INI format.
294 The characters "#" and ";" serve as comment characters.
296 By default initial and final white space is stripped from option
297 values. If you want to avoid this, or if you want use one of the
298 comment characters # or ; in option values (such as for NalimovPath),
299 enclose the value in quotes.
303 This section is used by PolyGlot only. The engine is unaware of these
304 options. The list of available options is detailed below.
306 EngineName (default: UCI name)
307 This is the name that will appear in the GUI. It is cosmetic only.
308 You can use different names for tweaked versions of the same
311 EngineDir (default: ".")
312 Full path of the directory where the engine is installed. You can
313 use "." (without the quotes) if you know that PolyGlot will be
314 launched in the engine directory or the engine is in the "path" and
315 does not need any data file.
318 Put here the name of the engine executable file. You can also add
319 command-line arguments. Path searching is used and the current
320 directory will be "EngineDir".
323 Whether PolyGlot should log all transactions with the interface and
324 the engine. This should be necessary only to locate problems.
326 LogFile (default: polyglot.log)
327 The name of the log file. Note that it is put where PolyGlot was
328 launched from, not into the engine directory.
330 WARNING: Log files are not cleared between sessions, and can become
331 very large. It is safe to remove them though.
333 Resign (default: false)
334 Set this to "true" if you want PolyGlot to resign on behalf of the
337 NOTE: Some engines display buggy scores from time to time although
338 the best move is correct. Use this option only if you know what
339 you are doing (e.g. you always check the final position of games).
341 ResignMoves (default: 3)
342 Number of consecutive moves with "resign" score (see below) before
343 PolyGlot resigns for the engine. Positions with only one legal
346 ResignScore (default: 600)
347 This is the score in centipawns that will trigger resign
350 ShowPonder (default: true)
351 Show search information during engine pondering. Turning this off
352 might be better for interactive use in some interfaces.
354 ScoreWhite (default: true)
355 Report score from white's point of view in xboard mode.
357 KibitzMove (default: false)
358 Whether to kibitz when playing a move.
360 KibitzPV (default: false)
361 Whether to kibitz when the PV is changed (new iteration or new best
364 KibitzCommand (default: "tellall")
365 xboard command to use for kibitzing, normally "tellall" for
366 kibitzing or "tellothers" for whispering.
368 KibitzDelay (default: 5)
369 How many seconds to wait before starting kibitzing. This has an
370 effect only if "KibitzPV" is selected, move kibitzes are always
371 sent regardless of the delay.
373 KibitzInterval (default: 0)
374 This is another form of throttling. PolyGlot will usually wait this
375 many seconds before doing the next kibitz.
378 If true PolyGlot will not understand xboard commands.
380 MateScore (default: 10000)
381 Mate score reported to GUI when in xboard mode.
383 Book (default: false)
384 Indicates whether a PolyGlot book should be used. This has no
385 effect on the engine own book (which can be controlled with the UCI
386 option "OwnBook" in the [Engine] section). In particular, it is
387 possible to use both a PolyGlot book and an engine book. In that
388 case, the engine book will be used whenever PolyGlot is out of
389 book. Remember that PolyGlot is unaware of whether the engine is
390 itself using a book or not.
392 BookFile (default: book.bin)
393 The name of the (binary) book file. Note that PolyGlot will look
394 for it in the directory it was launched from, not in the engine
395 directory. Of course, full path can be used in which case the
396 current directory does not matter.
398 BookRandom (default: true)
399 Select moves according to their weights in the book. If false the
400 move with the highest weight is selected.
402 BookRandom (default: true)
403 Select moves according to their weights in the book. If false the
404 move with the highest weight is selected.
406 BookDepth (default: 256)
407 Stop using the book after this number of moves.
409 BookTreshold (default: 5)
410 Do not play moves with a weight (probability) lower than this (in
413 UseNice (default: false)
414 Run the engine at nice level 5, or "NiceValue" if it set. On some
415 operating systems it may be necessary to run the engine at lower
416 priority for it to be responsive to commands from PolyGlot while
419 NiceValue (default: 5)
420 Nice levels go from -20 to 20 with 20 being the lowest priority.
421 On Unix only root can set negative nice levels. On Windows the
422 standard Win32 priority levels are mapped in a sensible way to Unix
425 Affinity (default: -1)
426 This a bit vector in which each bit represents the processors that
427 a process is allowed to run on. This option works only on Windows.
429 Persist (default: true)
430 If true then PolyGlot will implement persistence by loading options
431 from an additional INI file whose name is by default derived from
432 the engine name. At exit PolyGlot will also save its options to
435 PersistFile (default: <EngineName>.ini)
436 The name of the file from which to take the additional options. It
437 is probably best to stick with the default. You can safely edit
438 this file, or delete it to restore the default options.
440 PersistDir (default: $HOME/.polyglot on Linux; ".\Polyglot Settings" on
442 The directory where the PersistFile is stored.
446 Work arounds are identical to options except that they should be used
447 only when necessary. Their purpose is to try to hide problems with
448 various software (not just engines).
450 IMPORTANT: Any of these work arounds might be removed in future
451 versions of PolyGlot. You are strongly recommended to contact the
452 author of faulty software and truly fix the problem.
454 PolyGlot supports the following work arounds:
456 UCIVersion (default: 2)
457 The default value of 2 corresponds to UCI+. Use 1 to select plain
458 UCI for engines that have problems with UCI+.
460 CanPonder (default: false)
461 PolyGlot now conforms to the documented UCI behaviour: the engine
462 will be allowed to ponder only if it (the engine) declares the
463 "Ponder" UCI option. However some engines which can actually
464 ponder do not declare the option. This work around lets PolyGlot
465 know that they can ponder.
467 SyncStop (default: false)
468 When a ponder miss occurs, Polyglot interrupts the engine and
469 IMMEDIATELY launches a new search. While there should be no
470 problem with this, some engines seem confused and corrupt their
471 search board. "SyncStop" forces PolyGlot to wait for the (now
472 useless) ponder search to finish before launching the new search.
474 PromoteWorkAround (default: false)
475 Some engines do not specify a promotion piece, e.g. they send
476 "e7e8" instead of the correct "e7e8q". This work around enables
477 the incorrect form (and of course promotes into a queen).
479 RepeatPV (default: true)
480 When true, PolyGlot repeats the last pv string (which also contains
481 score,depth and time usage) it got from the engine. Some engines
482 however do not send a new pv string just before sending the move.
483 In that case the output of PolyGlot would be inconsistent. When
484 RepeatPV is false PolyGlot does not repeat the last pv string. Due
485 to the way kibitzing is implemented, KibitzMove is disabled in that
488 WbWorkArounds (default: true)
489 The intention of these options is to provide work arounds for
490 xboard/winboard bugs should they arise. This one decapitalizes the
491 word Draw in options that contain this word. Some versions of
492 xboard/winboard contain a bug which causes such options to be
493 interpreted as draw claims by the engine.
495 Engines that send options with "Draw" in their name are Rybka and
498 WbWorkArounds2 (default: false)
499 Old version of Winboard clear the engine output window at depth 1.
500 With this work around PG will send info lines at depth >=2. This
501 may or may not improve the display.
505 This section contains engine UCI options. PolyGlot does not understand
506 them, but sends the information to the engine at startup (converted to
507 UCI form). You can add any UCI option that makes sense to the engine
508 (not just the common options about hash-table size and tablebases).
510 NOTE: use INI syntax, not UCI. For example "OwnBook = true" is
511 correct. It will be replaced by PolyGlot with "setoption name OwnBook
512 value true" at engine startup.
514 Standard UCI options are
521 Hidden options like "Ponder" or "UCI_xxx" are automatic and should not
522 be put in an INI file.
524 The other options are engine-specific. Check their name using a UCI
525 GUI or launch the engine in a console and type "uci".
528 Running the UCI engine "fruit" under xboard 4.3.15 and later (this
529 invokes PolyGlot internally).
531 xboard -fcp fruit -fUCI
533 An explicit command line for using the UCI engine "fruit" with 128M
534 hash in xboard with logging enabled (this also works on xboard 4.2.7).
536 xboard -fcp "polyglot -noini -log -ec fruit -hash 128"
538 The equivalent config file would be:
541 EngineCommand = fruit
546 Compile "games.pgn" into a book "book.bin" retaining all lines of at
549 polyglot make-book -pgn games.pgn -bin book.bin -max-ply 30
551 Merge books "w1.bin" and "w2.bin" into a book "w.bin".
553 polyglot merge-book -in1 w1.bin -in2 w2.bin -out w.bin
555 Inspect lines for white in "w.bin"
557 polyglot dump-book -bin w.bin -color white -out w_white.txt
559 Test epd file "test.epd" with a (maximum) search time of 7 minutes per
562 polyglot epd-test -epd test.epd -max-time 420
565 PolyGlot always returns 0 on exit.
568 Main author: Fabien Letouzey<fabien_letouzey(at)hotmail.com>
570 Native Windows port: Huang Chen<webmaster@elephantbase.net> ("Morning
573 Various enhancements: Fonzy Bleumers<match(at)geenvis.net>
575 UCI port, option persistence and new WB protocol: Michel Van den Bergh
576 <michel.vandenbergh(at)uhasselt.be>
583 2009-09-04 POLYGLOT(6)