Checkin README
authorH.G. Muller <h.g.muller@hccnet.nl>
Fri, 15 Oct 2010 09:15:25 +0000 (11:15 +0200)
committerH.G. Muller <h.g.muller@hccnet.nl>
Fri, 15 Oct 2010 09:15:25 +0000 (11:15 +0200)
README.txt [new file with mode: 0644]

diff --git a/README.txt b/README.txt
new file mode 100644 (file)
index 0000000..5a41725
--- /dev/null
@@ -0,0 +1,101 @@
+                         UCI2WB relelease notes\r
+\r
+UCI2WB is an adapter for running USI (Shogi) engines under WinBoard.\r
+Install USI2WB in WinBoard as if it was the engine, with one or two arguments\r
+on its command line, to indicate the name of the real engine executable,\r
+and (optionally) its working directory. \r
+\r
+E.g. when you have placed USI2WB.exe in a sub-folder 'Adapters' inside the WinBoard folder,\r
+you could include the following line in winboard.ini amongst the firstChessPrograms:\r
+\r
+"UCI2WB -s USI_ENGINE.exe ENGINE_FOLDER" /fd="./Adapters" /variant=shogi\r
+\r
+UCI2WB was developed with gcc under Cygwin. It can also be used as a (dumb) UCI2WB adapter. \r
+"Dumb" here means that the adapter does not know anything about the game state, \r
+and just passes on the moves and position FENs as it receives them from engine or GUI. \r
+As this can be done without any knowledge of the game rules, or even of the board size, \r
+such a dumb adapter can in principle be used for any variant. To use it for UCI protocol\r
+(both the Chess or Xiangqi dialects), use it without the -s flag (or with a -c flag).\r
+\r
+This package includes the source code. To compile, use the command\r
+\r
+gcc -O2 -s -mno-cygwin UCI2WB.c -o UCI2WB.exe\r
+\r
+Have fun,\r
+H.G.Muller\r
+\r
+\r
+\r
+\r
+Change log:
+
+14/10/2010
+Port v1.5 to Linux\r
+
+26/9/2010 v1.5
+Add mini-Shogi ("variant 5x5+5_shogi") in USI mode; make coordinate translation board-size dependent.
+Translate FEN in setboard to SFEN (does not fully work for holdings yet).
+
+23/9/2010 v1.4
+Translate USI engine PV to standard coordinates (no provision for deferred promotion yet).
+
+??/?/2010 v1.3
+Add work-around for non-compliant USI engines that do not understand winc, binc, movestogo.
+Send btime before wtime, to avoid crashing USI engines with flakey (Shogidogoro) USI support.
+
+1/8/2010 v1.2
+Suppress mate claim on mate-in-1 score in Xiangqi (cyclone dialect),
+as some engines use this score when they reach repeats they would win if continued.
+\r
+31/7/2010 v1.1\r
+Add WB remove command\r
+\r
+30/7/2010 v1.0\r
+Allow spaces in option names.\r
+Refactor StopPonder into separate subroutine.\r
+Refactor LoadPos into separate subroutine.\r
+Send stop-ponder commands on exit and force.\r
+Added icon.\r
+\r
+29/7/2010 v0.9\r
+Fixed analysis, which was broken after refacoring (newline after 'go infinite')\r
+\r
+27/7/2010 v0.8\r
+Refactored sendng of go command into separate routine\r
+Send times with 'go ponder'.\r
+Measure time spend on own move, and correct time left for it (2% safety margin).\r
+Do adjust time left for new session or move time.\r
+\r
+26/7/2010 v0.7\r
+Fix bug w.r.t. side to move on setboard.\r
+Print version number with -v option.\r
+\r
+25/7/2010 v0.6\r
+Undo implemented.\r
+Analyze mode implemented. Seems to work for Glaurung 2.2 and Cyclone 2.1.1.\r
+Periodic updates still use fictitious total move count of 100.\r
+\r
+18/7/2010 v0.5\r
+Switching between USI and UCI is now done at run time nased on a -s flag argument\r
+Recognize WB variant command\r
+In Xiangqi the position keyword is omitted, and a FEN is sent even for the start pos\r
+Recognize 'null' as best move\r
+Recognize scores without cp\r
+Corrrect thinking time to centi-sec\r
+\r
+17/7/2010 v0.4:\r
+Introduced  compiler switch that enables some macros for everything that is different\r
+in USI compared to UCI.\r
+Fixed pondering.\r
+Fixed setboard (for UCI).\r
+Added result claims on checkmate / stalemate (for engines that say 'bestmove (none)').\r
+\r
+16/7/2010 v0.3:\r
+This is the first version for which the basics seem to work.\r
+It could play a game of Blunder against itself, ending in resign.\r
+Options of all types should work now.\r
+Only classical time control tested.\r
+Pondering not tested. (Blunder does not give a ponder move?)\r
+Setboard not tested. (Probably does not work due to FEN format discrepancy.)\r
+No analyze mode yet.\r
+No SMP yet.