Skip to content

Commit a273680

Browse files
skiminkiAloril
authored andcommitted
Add README for cuteseal support
1 parent 069a9f4 commit a273680

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

cuteseal-remote-runner/README

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
Cuteseal support
2+
----------------
3+
4+
Cuteseal support is intended for laggy network connections to
5+
eliminate the network lag from move time. Cuteseal moves timing from
6+
the cutechess server to the remote engine side of the network
7+
connection. This is achieved by running the engine with
8+
cuteseal-remote-runner, which adds timing info for all input and
9+
output commands. Cutechess-cli then uses this timing info to calculate
10+
move times correctly without the effect of the network lag.
11+
12+
13+
Usage
14+
-----
15+
16+
First, compile the cutechess remote runner:
17+
18+
cd cuteseal-remote-runner
19+
./compile.sh
20+
21+
Then, to enable cuteseal support for a remote engine, launch is as
22+
follows in engines.json:
23+
24+
"command": "<tceccutechess-path>/cuteseal-remote-runner/cuteseal-remote-runner stockfish",
25+
26+
Then, set cuteseal="true" in the cutechess-cli launch parameters. For
27+
example:
28+
29+
-engine conf="Stockfish Cuteseal" tc="1+0.1" cuteseal="true"
30+
31+
This tells cutechess that the engine input/output uses cuteseal.
32+
33+
Run cuteseal-remote-runner without parameters for a usage and
34+
explanation on the cuteseal protocol layer.
35+
36+
You can also launch the engine with cuteseal-remote-runner on your
37+
console, as you'd do with any other engine:
38+
39+
./cuteseal-remote-runner stockfish
40+
41+
You can then send the usual commands such as 'uci' and 'go
42+
infinite'. Or try:
43+
44+
./cuteseal-remote-runner stockfish bench
45+
46+
Cuteseal has one extra input command prefix that sets a timeout for
47+
the engine to send the 'bestmove' command. This is:
48+
49+
cuteseal-deadline <ns> <command ...>
50+
51+
For example:
52+
53+
cuteseal-deadline 1100000000 go movetime 1000
54+
55+
to ensure that bestmove is received within 1.1 sec. If not, a "STATUS
56+
TIMEOUT" message will be sent back to inform that the engine did not
57+
respond in time. Receiving this message triggers the Cutechess server
58+
to immediately forfeit the game due to timeout.
59+

0 commit comments

Comments
 (0)