Update docs
[matilda.git] / GTP_README
blob060ba80b8fa6b202ef3185cee04795aeb0a90473
1 GTP MODIFICATIONS IN MATILDA
3 This file documents the changes to GTP 2 draft 2 commands as implemented, plus
4 the private command extensions supported.
6 1. Standard Commands
8 Reference: http://www.lysator.liu.se/~gunnar/gtp/gtp2-spec-draft2/gtp2-spec.html
11 boardsize -- the command fails if the board size requested is different than the
12 value set at compile time. Furthermore, if no argument is given the command
13 succeeds and returns the current board size.
16 komi -- the command also accepts no parameters, returning the current komidashi.
19 loadsgf -- the command fails if the game to be loaded uses a board size
20 different from the value set at compile time.
23 final_status_list -- Matilda may prefer playing to passing and, as such, kill
24 dead groups; when answering this command it will always mark all stones as
25 alive, not identifying life in seki.
29 2. Private Commands
31 2.1 KGS Go Server Commands
33 References: http://www.gokgs.com/download.jsp
34             http://www.gokgs.com/help/timesystems.html
36 kgs-game_over
39 kgs-genmove_cleanup
42 kgs-time_settings
46 2.2 GNU Go 3.8 Commands
48 Reference: https://www.gnu.org/software/gnugo/gnugo_19.html
50 clear_cache
53 cputime
56 echo
59 echo_err
62 gg-undo
65 help
68 printsgf
72 2.3 GoMill 0.7.4 Commands
74 Reference: http://mjw.woodcraft.me.uk/gomill/doc/0.7.4/gtp_extensions.html
76 gomill-cpu_time
79 gomill-describe_engine
83 2.4 Matilda Commands
85 mtld-game_info -- display current game information including the sequence of all
86 plays, player names and game result if any.
87 Arguments: none
88 Fails: never
91 mtld-last_evaluation -- returns in multi-line format the last full board
92 evaluation. It may not cover all plays if the last strategy ran only evaluated
93 part of them.
94 Arguments: none
95 Fails: never
98 mtld-time_left -- exactly the same as the standard time_left command, except for
99 the time being specified in milliseconds instead of seconds.
100 Arguments: player color, number of milliseconds remaining in the current period,
101 number of stones for the current period, or 0 if currently in main time
102 Fails: syntax error
105 exit -- alias to quit command.
106 Arguments: none
107 Fails: never