Fix indentation in example
[sloppygui.git] / docs / engines.json.5
bloba2af9e4cfacf6871d8e457c2c152b83fe4820740
1 .Dd January 21, 2012
2 .Dt ENGINES.JSON 5
3 .Os
4 .Sh NAME
5 .Nm engines.json
6 .Nd Cute Chess engine configuration file
7 .Sh SYNOPSIS
8 .Nm
9 is the chess engine configuration file for
10 .Xr cutechess-cli 6 .
11 .Pp
12 Available configuration options are:
13 .Bl -tag -width Ds
14 .It Ic name No : Ar string
15 The name of the engine.
16 .It Ic command No : Ar string
17 The engine command.
18 .It Ic workingDirectory No : Ar string
19 The working directory of the engine.
20 .It Ic protocol No : Ar string
21 The chess engine protocol used by this engine.
22 .It Ic initStrings No : Ar array No of Ar string
23 Array of strings sent to the engine's standard input at startup.
24 .It Ic whitepov No : Ar boolean
25 Invert the engine's scores when it plays black. This option
26 should be used with engines that always report scores from
27 white's perspective.
28 .El
29 .Sh EXAMPLES
30 A minimal engine configuration file for the Sloppy chess engine:
31 .Bd -literal -offset indent
33     {
34         "name": "Sloppy",
35         "command": "sloppy",
36         "protocol": "xboard"
37     }
39 .Ed
40 .Sh SEE ALSO
41 .Xr cutechess-cli 6
42 .Rs
43 .%R RFC 4627
44 .%T "The application/json Media Type for JavaScript Object Notation (JSON)"
45 .%D July 2006
46 .Re