Update README file
[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   The general syntax of the UCI2WB command is:\r
20 \r
21 UCI2WB [debug] [-var VARIANTLIST] [-s|-c] ENGINE.exe [ENGINEFOLDER]\r
22 \r
23 Presence of the 'debug' argument causes UCI2WB to report everything it receives from the engine,\r
24 as well as the 'position' and 'go' comamnds sent to it, as debug output (prefixed with '#')\r
25 to the GUI. This has the same effect as switching the option 'UCI2WB debug output' on,\r
26 except that it forces the option to be on from the very beginning, so that the engine\r
27 startup will also be reported.\r
28   The '-var' option overrules the list of variants UCI2WB says it supports with the given list,\r
29 like 'feature variants="VARIANTLIST"'.\r
30 \r
31 \r
32 This package includes the source code. To compile on Windows under Cygwin, use the commands\r
33 \r
34 windres --use-temp-file -O coff UCI2WB.rc -o rosetta.o\r
35 gcc -O2 -s -mno-cygwin UCI2WB.c rosetta.o -o UCI2WB.exe\r
36 \r
37 To compile under Linux, use\r
38 \r
39 gcc -O2 -s UCI2WB.c -lpthread -o UCI2WB\r
40 \r
41 Have fun,\r
42 H.G.Muller\r
43 \r
44 \r
45 \r
46 \r
47 Change log:\r
48 \r
49 17/4/2012\r
50 Make supported-variants string configurable from command line.\r
51 \r
52 15/4/2012 v1.7\r
53 Take 30ms safety margin in translating st command to movetime\r
54 \r
55 14/1/2011 v1.6\r
56 Replaced all polling by blocking synchronization (through pipes).\r
57 Implemented ping (using isready/readyok)\r
58 Made sending of debug info to GUI subject to option feature / command-line argument.\r
59 Fixed myname feature to handle names containing spaces.\r
60 \r
61 14/10/2010\r
62 Port v1.5 to Linux\r
63 \r
64 26/9/2010 v1.5\r
65 Add mini-Shogi ("variant 5x5+5_shogi") in USI mode; make coordinate translation board-size dependent.\r
66 Translate FEN in setboard to SFEN (does not fully work for holdings yet).\r
67 \r
68 23/9/2010 v1.4\r
69 Translate USI engine PV to standard coordinates (no provision for deferred promotion yet).\r
70 \r
71 ??/?/2010 v1.3\r
72 Add work-around for non-compliant USI engines that do not understand winc, binc, movestogo.\r
73 Send btime before wtime, to avoid crashing USI engines with flakey (Shogidogoro) USI support.\r
74 \r
75 1/8/2010 v1.2\r
76 Suppress mate claim on mate-in-1 score in Xiangqi (cyclone dialect),\r
77 as some engines use this score when they reach repeats they would win if continued.\r
78 \r
79 31/7/2010 v1.1\r
80 Add WB remove command\r
81 \r
82 30/7/2010 v1.0\r
83 Allow spaces in option names.\r
84 Refactor StopPonder into separate subroutine.\r
85 Refactor LoadPos into separate subroutine.\r
86 Send stop-ponder commands on exit and force.\r
87 Added icon.\r
88 \r
89 29/7/2010 v0.9\r
90 Fixed analysis, which was broken after refacoring (newline after 'go infinite')\r
91 \r
92 27/7/2010 v0.8\r
93 Refactored sendng of go command into separate routine\r
94 Send times with 'go ponder'.\r
95 Measure time spend on own move, and correct time left for it (2% safety margin).\r
96 Do adjust time left for new session or move time.\r
97 \r
98 26/7/2010 v0.7\r
99 Fix bug w.r.t. side to move on setboard.\r
100 Print version number with -v option.\r
101 \r
102 25/7/2010 v0.6\r
103 Undo implemented.\r
104 Analyze mode implemented. Seems to work for Glaurung 2.2 and Cyclone 2.1.1.\r
105 Periodic updates still use fictitious total move count of 100.\r
106 \r
107 18/7/2010 v0.5\r
108 Switching between USI and UCI is now done at run time nased on a -s flag argument\r
109 Recognize WB variant command\r
110 In Xiangqi the position keyword is omitted, and a FEN is sent even for the start pos\r
111 Recognize 'null' as best move\r
112 Recognize scores without cp\r
113 Corrrect thinking time to centi-sec\r
114 \r
115 17/7/2010 v0.4:\r
116 Introduced  compiler switch that enables some macros for everything that is different\r
117 in USI compared to UCI.\r
118 Fixed pondering.\r
119 Fixed setboard (for UCI).\r
120 Added result claims on checkmate / stalemate (for engines that say 'bestmove (none)').\r
121 \r
122 16/7/2010 v0.3:\r
123 This is the first version for which the basics seem to work.\r
124 It could play a game of Blunder against itself, ending in resign.\r
125 Options of all types should work now.\r
126 Only classical time control tested.\r
127 Pondering not tested. (Blunder does not give a ponder move?)\r
128 Setboard not tested. (Probably does not work due to FEN format discrepancy.)\r
129 No analyze mode yet.\r
130 No SMP yet.\r