Change UCI_Variant name from threecheck to 3check
[uci2wb.git] / README.txt
1                          UCI2WB relelease notes\r
2 \r
3 UCI2WB is an adapter for running USI (Shogi) engines under WinBoard.\r
4 Install USI2WB in WinBoard as if it was the engine, with one or two arguments\r
5 on its command line, to indicate the name of the real engine executable,\r
6 and (optionally) its working directory. \r
7 \r
8 E.g. when you have placed USI2WB.exe in a sub-folder 'Adapters' inside the WinBoard folder,\r
9 you could include the following line in winboard.ini amongst the firstChessPrograms:\r
10 \r
11 "UCI2WB -s USI_ENGINE.exe ENGINE_FOLDER" /fd="./Adapters" /variant=shogi\r
12 \r
13 UCI2WB was developed with gcc under Cygwin. It can also be used as a (dumb) UCI2WB adapter. \r
14 "Dumb" here means that the adapter does not know anything about the game state, \r
15 and just passes on the moves and position FENs as it receives them from engine or GUI. \r
16 As this can be done without any knowledge of the game rules, or even of the board size, \r
17 such a dumb adapter can in principle be used for any variant. To use it for UCI protocol\r
18 (both the Chess or Xiangqi dialects), use it without the -s flag (or with a -c flag).\r
19   As of version 2.0 UCI2WB also supports the UCCI protocol for Xiangqi, for which it was\r
20 made slightly less dumb: in UCCI mode it keeps track of the board position on a (Xiangqi)\r
21 board, so it can recognize capture moves, and send only the moves after it (with an\r
22 appropriate FEN to start them from).\r
23   The general syntax of the UCI2WB command is:\r
24 \r
25 UCI2WB [debug] [-var VARIANTLIST] [-s|-c|-x] ENGINE.exe [ENGINEFOLDER]\r
26 \r
27 Presence of the 'debug' argument causes UCI2WB to report everything it receives from the engine,\r
28 as well as the 'position' and 'go' commands sent to it, as debug output (prefixed with '#')\r
29 to the GUI. This has the same effect as switching the option 'UCI2WB debug output' on,\r
30 except that it forces the option to be on from the very beginning, so that the engine\r
31 startup will also be reported.\r
32   The '-var' option overrules the list of variants UCI2WB says it supports with the given list,\r
33 like 'feature variants="VARIANTLIST"'.\r
34 \r
35 \r
36 This package includes the source code. To compile on Windows under Cygwin, use the commands\r
37 \r
38 windres --use-temp-file -O coff UCI2WB.rc -o rosetta.o\r
39 gcc -O2 -s -mno-cygwin UCI2WB.c rosetta.o -o UCI2WB.exe\r
40 \r
41 To compile under Linux, use\r
42 \r
43 gcc -O2 -s UCI2WB.c -lpthread -o UCI2WB\r
44 \r
45 Have fun,\r
46 H.G.Muller\r
47 \r
48 \r
49 \r
50 \r
51 Change log:\r
52 \r
53 24/12/2016 3.0\r
54 Implement UCI_AnalyseMode option\r
55 Support egtpath command for Nalimov, Gaviota and Syzygy\r
56 Allow ?, quit, force and result commands to terminate thinking\r
57 Stop search during setoption commands, or buffer those until engine is done thinking\r
58 Explicitly report when engine dies, through GUI popup (tellusererror)\r
59 Make sure reporting of mated-in-0 score causes resign, even without PV\r
60 Fix eclipsing of -var option with engines that have UCI_Chess960 option\r
61 Fix empty default of string options\r
62 \r
63 8/11/2016 2.3\r
64 Implement handling of 'UCI_Variant' option for variant announcement and selection\r
65 Pass 'info string variant' line as 'setup' command to allow engine-defined variants\r
66 Set 'UCI_Opponent' option in accordance with CECP 'name' and 'computer' commands\r
67 Fix option setting during analysis (MultiPV!)\r
68 \r
69 22/11/2016 2.2\r
70 Use USI gameover command to relay game result\r
71 Handle USI win claims\r
72 Correct wtime/btime for byoyomi\r
73 \r
74 7/11/2016 2.1\r
75 Make Linux version SIGTERM-proof\r
76 Recognize forward Pawn pushes as irreversible in UCCI\r
77 Block input from GUI during thinking\r
78 Use uxinewgame\r
79 Implement support for pre-standard UCI Chess960 engines ('Arena960 dialect')\r
80 Fix hash-size setting in UCCI\r
81 Combine name and version when engine gives them in separate 'id' commands\r
82 Fake time and node count for engines that do not report it\r
83 Add interactive options for byoyomi work-around\r
84 \r
85 28/10/2014 2.0\r
86 Implement UCCI support\r
87 \r
88 4/12/2012 1.10\r
89 Implement pause / resume commands\r
90 \r
91 9/5/2012\r
92 Fix bug in converting shogi moves, introduced in v1.8\r
93 \r
94 19/4/2012 1.9\r
95 Remove S-Chess move translation, to parallel change in UCI S-Chess 'standard'\r
96 Implement WB exclude feature\r
97 \r
98 17/4/2012 1.8\r
99 Wait for uciok before processing GUI commands for setting options\r
100 Implement move translations required for variant seirawan\r
101 Make supported-variants string configurable from command line.\r
102 \r
103 15/4/2012 v1.7\r
104 Take 30ms safety margin in translating st command to movetime\r
105 \r
106 14/1/2011 v1.6\r
107 Replaced all polling by blocking synchronization (through pipes).\r
108 Implemented ping (using isready/readyok)\r
109 Made sending of debug info to GUI subject to option feature / command-line argument.\r
110 Fixed myname feature to handle names containing spaces.\r
111 \r
112 14/10/2010\r
113 Port v1.5 to Linux\r
114 \r
115 26/9/2010 v1.5\r
116 Add mini-Shogi ("variant 5x5+5_shogi") in USI mode; make coordinate translation board-size dependent.\r
117 Translate FEN in setboard to SFEN (does not fully work for holdings yet).\r
118 \r
119 23/9/2010 v1.4\r
120 Translate USI engine PV to standard coordinates (no provision for deferred promotion yet).\r
121 \r
122 ??/?/2010 v1.3\r
123 Add work-around for non-compliant USI engines that do not understand winc, binc, movestogo.\r
124 Send btime before wtime, to avoid crashing USI engines with flakey (Shogidogoro) USI support.\r
125 \r
126 1/8/2010 v1.2\r
127 Suppress mate claim on mate-in-1 score in Xiangqi (cyclone dialect),\r
128 as some engines use this score when they reach repeats they would win if continued.\r
129 \r
130 31/7/2010 v1.1\r
131 Add WB remove command\r
132 \r
133 30/7/2010 v1.0\r
134 Allow spaces in option names.\r
135 Refactor StopPonder into separate subroutine.\r
136 Refactor LoadPos into separate subroutine.\r
137 Send stop-ponder commands on exit and force.\r
138 Added icon.\r
139 \r
140 29/7/2010 v0.9\r
141 Fixed analysis, which was broken after refacoring (newline after 'go infinite')\r
142 \r
143 27/7/2010 v0.8\r
144 Refactored sendng of go command into separate routine\r
145 Send times with 'go ponder'.\r
146 Measure time spend on own move, and correct time left for it (2% safety margin).\r
147 Do adjust time left for new session or move time.\r
148 \r
149 26/7/2010 v0.7\r
150 Fix bug w.r.t. side to move on setboard.\r
151 Print version number with -v option.\r
152 \r
153 25/7/2010 v0.6\r
154 Undo implemented.\r
155 Analyze mode implemented. Seems to work for Glaurung 2.2 and Cyclone 2.1.1.\r
156 Periodic updates still use fictitious total move count of 100.\r
157 \r
158 18/7/2010 v0.5\r
159 Switching between USI and UCI is now done at run time nased on a -s flag argument\r
160 Recognize WB variant command\r
161 In Xiangqi the position keyword is omitted, and a FEN is sent even for the start pos\r
162 Recognize 'null' as best move\r
163 Recognize scores without cp\r
164 Corrrect thinking time to centi-sec\r
165 \r
166 17/7/2010 v0.4:\r
167 Introduced  compiler switch that enables some macros for everything that is different\r
168 in USI compared to UCI.\r
169 Fixed pondering.\r
170 Fixed setboard (for UCI).\r
171 Added result claims on checkmate / stalemate (for engines that say 'bestmove (none)').\r
172 \r
173 16/7/2010 v0.3:\r
174 This is the first version for which the basics seem to work.\r
175 It could play a game of Blunder against itself, ending in resign.\r
176 Options of all types should work now.\r
177 Only classical time control tested.\r
178 Pondering not tested. (Blunder does not give a ponder move?)\r
179 Setboard not tested. (Probably does not work due to FEN format discrepancy.)\r
180 No analyze mode yet.\r
181 No SMP yet.\r