Merge remote-tracking branch 'upstream/master'
[stockfish] / Readme.md
1 ## Overview
2
3 [![Build Status](https://travis-ci.org/official-stockfish/Stockfish.svg?branch=master)](https://travis-ci.org/official-stockfish/Stockfish)
4 [![Build Status](https://ci.appveyor.com/api/projects/status/github/official-stockfish/Stockfish?branch=master&svg=true)](https://ci.appveyor.com/project/mcostalba/stockfish/branch/master)
5
6 [Stockfish](https://stockfishchess.org) is a free, powerful UCI chess engine
7 derived from Glaurung 2.1. It is not a complete chess program and requires a
8 UCI-compatible GUI (e.g. XBoard with PolyGlot, Scid, Cute Chess, eboard, Arena,
9 Sigma Chess, Shredder, Chess Partner or Fritz) in order to be used comfortably.
10 Read the documentation for your GUI of choice for information about how to use
11 Stockfish with it.
12
13
14 ## Files
15
16 This distribution of Stockfish consists of the following files:
17
18   * Readme.md, the file you are currently reading.
19
20   * Copying.txt, a text file containing the GNU General Public License version 3.
21
22   * src, a subdirectory containing the full source code, including a Makefile
23     that can be used to compile Stockfish on Unix-like systems.
24
25
26 ## UCI parameters
27
28 Currently, Stockfish has the following UCI options:
29
30   * #### Debug Log File
31     Write all communication to and from the engine into a text file.
32
33   * #### Contempt
34     A positive value for contempt favors middle game positions and avoids draws.
35
36   * #### Analysis Contempt
37     By default, contempt is set to prefer the side to move. Set this option to "White"
38     or "Black" to analyse with contempt for that side, or "Off" to disable contempt.
39
40   * #### Threads
41     The number of CPU threads used for searching a position. For best performance, set
42     this equal to the number of CPU cores available.
43
44   * #### Hash
45     The size of the hash table in MB.
46
47   * #### Clear Hash
48     Clear the hash table.
49
50   * #### Ponder
51     Let Stockfish ponder its next move while the opponent is thinking.
52
53   * #### MultiPV
54     Output the N best lines (principal variations, PVs) when searching.
55     Leave at 1 for best performance.
56
57   * #### Skill Level
58     Lower the Skill Level in order to make Stockfish play weaker (see also UCI_LimitStrength).
59     Internally, MultiPV is enabled, and with a certain probability depending on the Skill Level a
60     weaker move will be played.
61
62   * #### UCI_LimitStrength
63     Enable weaker play aiming for an Elo rating as set by UCI_Elo. This option overrides Skill Level.
64
65   * #### UCI_Elo
66     If enabled by UCI_LimitStrength, aim for an engine strength of the given Elo.
67     This Elo rating has been calibrated at a time control of 60s+0.6s and anchored to CCRL 40/4.
68
69   * #### Move Overhead
70     Assume a time delay of x ms due to network and GUI overheads. This is useful to
71     avoid losses on time in those cases.
72
73   * #### Minimum Thinking Time
74     Search for at least x ms per move.
75
76   * #### Slow Mover
77     Lower values will make Stockfish take less time in games, higher values will
78     make it think longer.
79
80   * #### nodestime
81     Tells the engine to use nodes searched instead of wall time to account for
82     elapsed time. Useful for engine testing.
83
84   * #### UCI_Chess960
85     An option handled by your GUI. If true, Stockfish will play Chess960.
86
87   * #### UCI_AnalyseMode
88     An option handled by your GUI.
89
90   * #### SyzygyPath
91     Path to the folders/directories storing the Syzygy tablebase files. Multiple
92     directories are to be separated by ";" on Windows and by ":" on Unix-based
93     operating systems. Do not use spaces around the ";" or ":".
94
95     Example: `C:\tablebases\wdl345;C:\tablebases\wdl6;D:\tablebases\dtz345;D:\tablebases\dtz6`
96
97     It is recommended to store .rtbw files on an SSD. There is no loss in storing
98     the .rtbz files on a regular HD. It is recommended to verify all md5 checksums
99     of the downloaded tablebase files (`md5sum -c checksum.md5`) as corruption will
100     lead to engine crashes.
101
102   * #### SyzygyProbeDepth
103     Minimum remaining search depth for which a position is probed. Set this option
104     to a higher value to probe less agressively if you experience too much slowdown
105     (in terms of nps) due to TB probing.
106
107   * #### Syzygy50MoveRule
108     Disable to let fifty-move rule draws detected by Syzygy tablebase probes count
109     as wins or losses. This is useful for ICCF correspondence games.
110
111   * #### SyzygyProbeLimit
112     Limit Syzygy tablebase probing to positions with at most this many pieces left
113     (including kings and pawns).
114
115
116 ## What to expect from Syzygybases?
117
118 If the engine is searching a position that is not in the tablebases (e.g.
119 a position with 8 pieces), it will access the tablebases during the search.
120 If the engine reports a very large score (typically 153.xx), this means
121 that it has found a winning line into a tablebase position.
122
123 If the engine is given a position to search that is in the tablebases, it
124 will use the tablebases at the beginning of the search to preselect all
125 good moves, i.e. all moves that preserve the win or preserve the draw while
126 taking into account the 50-move rule.
127 It will then perform a search only on those moves. **The engine will not move
128 immediately**, unless there is only a single good move. **The engine likely
129 will not report a mate score even if the position is known to be won.**
130
131 It is therefore clear that this behaviour is not identical to what one might
132 be used to with Nalimov tablebases. There are technical reasons for this
133 difference, the main technical reason being that Nalimov tablebases use the
134 DTM metric (distance-to-mate), while Syzygybases use a variation of the
135 DTZ metric (distance-to-zero, zero meaning any move that resets the 50-move
136 counter). This special metric is one of the reasons that Syzygybases are
137 more compact than Nalimov tablebases, while still storing all information
138 needed for optimal play and in addition being able to take into account
139 the 50-move rule.
140
141
142 ## Compiling Stockfish yourself from the sources
143
144 On Unix-like systems, it should be possible to compile Stockfish
145 directly from the source code with the included Makefile.
146
147 Stockfish has support for 32 or 64-bit CPUs, the hardware POPCNT
148 instruction, big-endian machines such as Power PC, and other platforms.
149
150 In general it is recommended to run `make help` to see a list of make
151 targets with corresponding descriptions. When not using the Makefile to
152 compile (for instance with Microsoft MSVC) you need to manually
153 set/unset some switches in the compiler command line; see file *types.h*
154 for a quick reference.
155
156 When reporting an issue or a bug, please tell us which version and
157 compiler you used to create your executable. These informations can
158 be found by typing the following commands in a console:
159
160 ```
161     ./stockfish
162     compiler
163 ```
164
165 ## Understanding the code base and participating in the project
166
167 Stockfish's improvement over the last couple of years has been a great
168 community effort. There are a few ways to help contribute to its growth.
169
170 ### Donating hardware
171
172 Improving Stockfish requires a massive amount of testing. You can donate
173 your hardware resources by installing the [Fishtest Worker](https://github.com/glinscott/fishtest/wiki/Running-the-worker:-overview)
174 and view the current tests on [Fishtest](https://tests.stockfishchess.org/tests).
175
176 ### Improving the code
177
178 If you want to help improve the code, there are several valuable resources:
179
180 * [In this wiki,](https://www.chessprogramming.org) many techniques used in
181 Stockfish are explained with a lot of background information.
182
183 * [The section on Stockfish](https://www.chessprogramming.org/Stockfish)
184 describes many features and techniques used by Stockfish. However, it is
185 generic rather than being focused on Stockfish's precise implementation.
186 Nevertheless, a helpful resource.
187
188 * The latest source can always be found on [GitHub](https://github.com/official-stockfish/Stockfish).
189 Discussions about Stockfish take place in the [FishCooking](https://groups.google.com/forum/#!forum/fishcooking)
190 group and engine testing is done on [Fishtest](https://tests.stockfishchess.org/tests).
191 If you want to help improve Stockfish, please read this [guideline](https://github.com/glinscott/fishtest/wiki/Creating-my-first-test)
192 first, where the basics of Stockfish development are explained.
193
194
195 ## Terms of use
196
197 Stockfish is free, and distributed under the **GNU General Public License version 3**
198 (GPL v3). Essentially, this means that you are free to do almost exactly
199 what you want with the program, including distributing it among your
200 friends, making it available for download from your web site, selling
201 it (either by itself or as part of some bigger software package), or
202 using it as the starting point for a software project of your own.
203
204 The only real limitation is that whenever you distribute Stockfish in
205 some way, you must always include the full source code, or a pointer
206 to where the source code can be found. If you make any changes to the
207 source code, these changes must also be made available under the GPL.
208
209 For full details, read the copy of the GPL v3 found in the file named
210 *Copying.txt*.