Fix engine names with spaces
[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 \r
20 This package includes the source code. To compile on Windows under Cygwin, use the commands\r
21 \r
22 windres --use-temp-file -O coff UCI2WB.rc -o rosetta.o\r
23 gcc -O2 -s -mno-cygwin UCI2WB.c rosetta.o -o UCI2WB.exe\r
24 \r
25 To compile under Linux, use\r
26 \r
27 gcc -O2 -s UCI2WB.c -lpthread -o UCI2WB\r
28 \r
29 Have fun,\r
30 H.G.Muller\r
31 \r
32 \r
33 \r
34 \r
35 Change log:\r
36 \r
37 14/10/2010\r
38 Port v1.5 to Linux\r
39 \r
40 26/9/2010 v1.5\r
41 Add mini-Shogi ("variant 5x5+5_shogi") in USI mode; make coordinate translation board-size dependent.\r
42 Translate FEN in setboard to SFEN (does not fully work for holdings yet).\r
43 \r
44 23/9/2010 v1.4\r
45 Translate USI engine PV to standard coordinates (no provision for deferred promotion yet).\r
46 \r
47 ??/?/2010 v1.3\r
48 Add work-around for non-compliant USI engines that do not understand winc, binc, movestogo.\r
49 Send btime before wtime, to avoid crashing USI engines with flakey (Shogidogoro) USI support.\r
50 \r
51 1/8/2010 v1.2\r
52 Suppress mate claim on mate-in-1 score in Xiangqi (cyclone dialect),\r
53 as some engines use this score when they reach repeats they would win if continued.\r
54 \r
55 31/7/2010 v1.1\r
56 Add WB remove command\r
57 \r
58 30/7/2010 v1.0\r
59 Allow spaces in option names.\r
60 Refactor StopPonder into separate subroutine.\r
61 Refactor LoadPos into separate subroutine.\r
62 Send stop-ponder commands on exit and force.\r
63 Added icon.\r
64 \r
65 29/7/2010 v0.9\r
66 Fixed analysis, which was broken after refacoring (newline after 'go infinite')\r
67 \r
68 27/7/2010 v0.8\r
69 Refactored sendng of go command into separate routine\r
70 Send times with 'go ponder'.\r
71 Measure time spend on own move, and correct time left for it (2% safety margin).\r
72 Do adjust time left for new session or move time.\r
73 \r
74 26/7/2010 v0.7\r
75 Fix bug w.r.t. side to move on setboard.\r
76 Print version number with -v option.\r
77 \r
78 25/7/2010 v0.6\r
79 Undo implemented.\r
80 Analyze mode implemented. Seems to work for Glaurung 2.2 and Cyclone 2.1.1.\r
81 Periodic updates still use fictitious total move count of 100.\r
82 \r
83 18/7/2010 v0.5\r
84 Switching between USI and UCI is now done at run time nased on a -s flag argument\r
85 Recognize WB variant command\r
86 In Xiangqi the position keyword is omitted, and a FEN is sent even for the start pos\r
87 Recognize 'null' as best move\r
88 Recognize scores without cp\r
89 Corrrect thinking time to centi-sec\r
90 \r
91 17/7/2010 v0.4:\r
92 Introduced  compiler switch that enables some macros for everything that is different\r
93 in USI compared to UCI.\r
94 Fixed pondering.\r
95 Fixed setboard (for UCI).\r
96 Added result claims on checkmate / stalemate (for engines that say 'bestmove (none)').\r
97 \r
98 16/7/2010 v0.3:\r
99 This is the first version for which the basics seem to work.\r
100 It could play a game of Blunder against itself, ending in resign.\r
101 Options of all types should work now.\r
102 Only classical time control tested.\r
103 Pondering not tested. (Blunder does not give a ponder move?)\r
104 Setboard not tested. (Probably does not work due to FEN format discrepancy.)\r
105 No analyze mode yet.\r
106 No SMP yet.\r