Fix gRPC crashes.
[stockfish] / README.md
1 ## Overview
2
3 [![Build Status](https://github.com/official-stockfish/Stockfish/actions/workflows/stockfish.yml/badge.svg)](https://github.com/official-stockfish/Stockfish/actions)
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. Stockfish is not a complete chess program and requires a
8 UCI-compatible graphical user interface (GUI) (e.g. XBoard with PolyGlot, Scid,
9 Cute Chess, eboard, Arena, Sigma Chess, Shredder, Chess Partner or Fritz) in order
10 to be used comfortably. Read the documentation for your GUI of choice for information
11 about how to use Stockfish with it.
12
13 The Stockfish engine features two evaluation functions for chess, the classical
14 evaluation based on handcrafted terms, and the NNUE evaluation based on efficiently
15 updatable neural networks. The classical evaluation runs efficiently on almost all
16 CPU architectures, while the NNUE evaluation benefits from the vector
17 intrinsics available on most CPUs (sse2, avx2, neon, or similar).
18
19
20 ## Files
21
22 This distribution of Stockfish consists of the following files:
23
24   * [Readme.md](https://github.com/official-stockfish/Stockfish/blob/master/README.md), the file you are currently reading.
25
26   * [Copying.txt](https://github.com/official-stockfish/Stockfish/blob/master/Copying.txt), a text file containing the GNU General Public License version 3.
27
28   * [AUTHORS](https://github.com/official-stockfish/Stockfish/blob/master/AUTHORS), a text file with the list of authors for the project
29
30   * [src](https://github.com/official-stockfish/Stockfish/tree/master/src), a subdirectory containing the full source code, including a Makefile
31     that can be used to compile Stockfish on Unix-like systems.
32
33   * a file with the .nnue extension, storing the neural network for the NNUE
34     evaluation. Binary distributions will have this file embedded.
35
36 ## The UCI protocol and available options
37
38 The Universal Chess Interface (UCI) is a standard protocol used to communicate with
39 a chess engine, and is the recommended way to do so for typical graphical user interfaces
40 (GUI) or chess tools. Stockfish implements the majority of it options as described
41 in [the UCI protocol](https://www.shredderchess.com/download/div/uci.zip).
42
43 Developers can see the default values for UCI options available in Stockfish by typing
44 `./stockfish uci` in a terminal, but the majority of users will typically see them and
45 change them via a chess GUI. This is a list of available UCI options in Stockfish:
46
47   * #### Threads
48     The number of CPU threads used for searching a position. For best performance, set
49     this equal to the number of CPU cores available.
50
51   * #### Hash
52     The size of the hash table in MB. It is recommended to set Hash after setting Threads.
53
54   * #### Clear Hash
55     Clear the hash table.
56
57   * #### Ponder
58     Let Stockfish ponder its next move while the opponent is thinking.
59
60   * #### MultiPV
61     Output the N best lines (principal variations, PVs) when searching.
62     Leave at 1 for best performance.
63
64   * #### Use NNUE
65     Toggle between the NNUE and classical evaluation functions. If set to "true",
66     the network parameters must be available to load from file (see also EvalFile),
67     if they are not embedded in the binary.
68
69   * #### EvalFile
70     The name of the file of the NNUE evaluation parameters. Depending on the GUI the
71     filename might have to include the full path to the folder/directory that contains the file.
72     Other locations, such as the directory that contains the binary and the working directory,
73     are also searched.
74
75   * #### UCI_AnalyseMode
76     An option handled by your GUI.
77
78   * #### UCI_Chess960
79     An option handled by your GUI. If true, Stockfish will play Chess960.
80
81   * #### UCI_ShowWDL
82     If enabled, show approximate WDL statistics as part of the engine output.
83     These WDL numbers model expected game outcomes for a given evaluation and
84     game ply for engine self-play at fishtest LTC conditions (60+0.6s per game).
85
86   * #### UCI_LimitStrength
87     Enable weaker play aiming for an Elo rating as set by UCI_Elo. This option overrides Skill Level.
88
89   * #### UCI_Elo
90     If enabled by UCI_LimitStrength, aim for an engine strength of the given Elo.
91     This Elo rating has been calibrated at a time control of 60s+0.6s and anchored to CCRL 40/4.
92
93   * #### Skill Level
94     Lower the Skill Level in order to make Stockfish play weaker (see also UCI_LimitStrength).
95     Internally, MultiPV is enabled, and with a certain probability depending on the Skill Level a
96     weaker move will be played.
97
98   * #### SyzygyPath
99     Path to the folders/directories storing the Syzygy tablebase files. Multiple
100     directories are to be separated by ";" on Windows and by ":" on Unix-based
101     operating systems. Do not use spaces around the ";" or ":".
102
103     Example: `C:\tablebases\wdl345;C:\tablebases\wdl6;D:\tablebases\dtz345;D:\tablebases\dtz6`
104
105     It is recommended to store .rtbw files on an SSD. There is no loss in storing
106     the .rtbz files on a regular HD. It is recommended to verify all md5 checksums
107     of the downloaded tablebase files (`md5sum -c checksum.md5`) as corruption will
108     lead to engine crashes.
109
110   * #### SyzygyProbeDepth
111     Minimum remaining search depth for which a position is probed. Set this option
112     to a higher value to probe less aggressively if you experience too much slowdown
113     (in terms of nps) due to tablebase probing.
114
115   * #### Syzygy50MoveRule
116     Disable to let fifty-move rule draws detected by Syzygy tablebase probes count
117     as wins or losses. This is useful for ICCF correspondence games.
118
119   * #### SyzygyProbeLimit
120     Limit Syzygy tablebase probing to positions with at most this many pieces left
121     (including kings and pawns).
122
123   * #### Move Overhead
124     Assume a time delay of x ms due to network and GUI overheads. This is useful to
125     avoid losses on time in those cases.
126
127   * #### Slow Mover
128     Lower values will make Stockfish take less time in games, higher values will
129     make it think longer.
130
131   * #### nodestime
132     Tells the engine to use nodes searched instead of wall time to account for
133     elapsed time. Useful for engine testing.
134
135   * #### Debug Log File
136     Write all communication to and from the engine into a text file.
137
138 For developers the following non-standard commands might be of interest, mainly useful for debugging:
139
140   * #### bench *ttSize threads limit fenFile limitType evalType*
141     Performs a standard benchmark using various options. The signature of a version (standard node
142     count) is obtained using all defaults. `bench` is currently `bench 16 1 13 default depth mixed`.
143
144   * #### compiler
145     Give information about the compiler and environment used for building a binary.
146
147   * #### d
148     Display the current position, with ascii art and fen.
149
150   * #### eval
151     Return the evaluation of the current position.
152
153   * #### export_net [filename]
154     Exports the currently loaded network to a file.
155     If the currently loaded network is the embedded network and the filename
156     is not specified then the network is saved to the file matching the name
157     of the embedded network, as defined in evaluate.h.
158     If the currently loaded network is not the embedded network (some net set
159     through the UCI setoption) then the filename parameter is required and the
160     network is saved into that file.
161
162   * #### flip
163     Flips the side to move.
164
165
166 ## A note on classical evaluation versus NNUE evaluation
167
168 Both approaches assign a value to a position that is used in alpha-beta (PVS) search
169 to find the best move. The classical evaluation computes this value as a function
170 of various chess concepts, handcrafted by experts, tested and tuned using fishtest.
171 The NNUE evaluation computes this value with a neural network based on basic
172 inputs (e.g. piece positions only). The network is optimized and trained
173 on the evaluations of millions of positions at moderate search depth.
174
175 The NNUE evaluation was first introduced in shogi, and ported to Stockfish afterward.
176 It can be evaluated efficiently on CPUs, and exploits the fact that only parts
177 of the neural network need to be updated after a typical chess move.
178 [The nodchip repository](https://github.com/nodchip/Stockfish) provides additional
179 tools to train and develop the NNUE networks. On CPUs supporting modern vector instructions
180 (avx2 and similar), the NNUE evaluation results in much stronger playing strength, even
181 if the nodes per second computed by the engine is somewhat lower (roughly 80% of nps
182 is typical).
183
184 Notes:
185
186 1) the NNUE evaluation depends on the Stockfish binary and the network parameter
187 file (see the EvalFile UCI option). Not every parameter file is compatible with a given
188 Stockfish binary, but the default value of the EvalFile UCI option is the name of a network
189 that is guaranteed to be compatible with that binary.
190
191 2) to use the NNUE evaluation, the additional data file with neural network parameters
192 needs to be available. Normally, this file is already embedded in the binary or it
193 can be downloaded. The filename for the default (recommended) net can be found as the default
194 value of the `EvalFile` UCI option, with the format `nn-[SHA256 first 12 digits].nnue`
195 (for instance, `nn-c157e0a5755b.nnue`). This file can be downloaded from
196 ```
197 https://tests.stockfishchess.org/api/nn/[filename]
198 ```
199 replacing `[filename]` as needed.
200
201 ## What to expect from the Syzygy tablebases?
202
203 If the engine is searching a position that is not in the tablebases (e.g.
204 a position with 8 pieces), it will access the tablebases during the search.
205 If the engine reports a very large score (typically 153.xx), this means
206 it has found a winning line into a tablebase position.
207
208 If the engine is given a position to search that is in the tablebases, it
209 will use the tablebases at the beginning of the search to preselect all
210 good moves, i.e. all moves that preserve the win or preserve the draw while
211 taking into account the 50-move rule.
212 It will then perform a search only on those moves. **The engine will not move
213 immediately**, unless there is only a single good move. **The engine likely
214 will not report a mate score, even if the position is known to be won.**
215
216 It is therefore clear that this behaviour is not identical to what one might
217 be used to with Nalimov tablebases. There are technical reasons for this
218 difference, the main technical reason being that Nalimov tablebases use the
219 DTM metric (distance-to-mate), while the Syzygy tablebases use a variation of the
220 DTZ metric (distance-to-zero, zero meaning any move that resets the 50-move
221 counter). This special metric is one of the reasons that the Syzygy tablebases are
222 more compact than Nalimov tablebases, while still storing all information
223 needed for optimal play and in addition being able to take into account
224 the 50-move rule.
225
226 ## Large Pages
227
228 Stockfish supports large pages on Linux and Windows. Large pages make
229 the hash access more efficient, improving the engine speed, especially
230 on large hash sizes. Typical increases are 5..10% in terms of nodes per
231 second, but speed increases up to 30% have been measured. The support is
232 automatic. Stockfish attempts to use large pages when available and
233 will fall back to regular memory allocation when this is not the case.
234
235 ### Support on Linux
236
237 Large page support on Linux is obtained by the Linux kernel
238 transparent huge pages functionality. Typically, transparent huge pages
239 are already enabled, and no configuration is needed.
240
241 ### Support on Windows
242
243 The use of large pages requires "Lock Pages in Memory" privilege. See
244 [Enable the Lock Pages in Memory Option (Windows)](https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/enable-the-lock-pages-in-memory-option-windows)
245 on how to enable this privilege, then run [RAMMap](https://docs.microsoft.com/en-us/sysinternals/downloads/rammap)
246 to double-check that large pages are used. We suggest that you reboot
247 your computer after you have enabled large pages, because long Windows
248 sessions suffer from memory fragmentation, which may prevent Stockfish
249 from getting large pages: a fresh session is better in this regard.
250
251 ## Compiling Stockfish yourself from the sources
252
253 Stockfish has support for 32 or 64-bit CPUs, certain hardware
254 instructions, big-endian machines such as Power PC, and other platforms.
255
256 On Unix-like systems, it should be easy to compile Stockfish
257 directly from the source code with the included Makefile in the folder
258 `src`. In general it is recommended to run `make help` to see a list of make
259 targets with corresponding descriptions.
260
261 ```
262     cd src
263     make help
264     make net
265     make build ARCH=x86-64-modern
266 ```
267
268 When not using the Makefile to compile (for instance, with Microsoft MSVC) you
269 need to manually set/unset some switches in the compiler command line; see
270 file *types.h* for a quick reference.
271
272 When reporting an issue or a bug, please tell us which Stockfish version
273 and which compiler you used to create your executable. This information
274 can be found by typing the following command in a console:
275
276 ```
277     ./stockfish compiler
278 ```
279
280 ## Understanding the code base and participating in the project
281
282 Stockfish's improvement over the last decade has been a great community
283 effort. There are a few ways to help contribute to its growth.
284
285 ### Donating hardware
286
287 Improving Stockfish requires a massive amount of testing. You can donate
288 your hardware resources by installing the [Fishtest Worker](https://github.com/glinscott/fishtest/wiki/Running-the-worker:-overview)
289 and view the current tests on [Fishtest](https://tests.stockfishchess.org/tests).
290
291 ### Improving the code
292
293 If you want to help improve the code, there are several valuable resources:
294
295 * [In this wiki,](https://www.chessprogramming.org) many techniques used in
296 Stockfish are explained with a lot of background information.
297
298 * [The section on Stockfish](https://www.chessprogramming.org/Stockfish)
299 describes many features and techniques used by Stockfish. However, it is
300 generic rather than being focused on Stockfish's precise implementation.
301 Nevertheless, a helpful resource.
302
303 * The latest source can always be found on [GitHub](https://github.com/official-stockfish/Stockfish).
304 Discussions about Stockfish take place these days mainly in the [FishCooking](https://groups.google.com/forum/#!forum/fishcooking)
305 group and on the [Stockfish Discord channel](https://discord.gg/nv8gDtt).
306 The engine testing is done on [Fishtest](https://tests.stockfishchess.org/tests).
307 If you want to help improve Stockfish, please read this [guideline](https://github.com/glinscott/fishtest/wiki/Creating-my-first-test)
308 first, where the basics of Stockfish development are explained.
309
310
311 ## Terms of use
312
313 Stockfish is free, and distributed under the **GNU General Public License version 3**
314 (GPL v3). Essentially, this means you are free to do almost exactly
315 what you want with the program, including distributing it among your
316 friends, making it available for download from your website, selling
317 it (either by itself or as part of some bigger software package), or
318 using it as the starting point for a software project of your own.
319
320 The only real limitation is that whenever you distribute Stockfish in
321 some way, you MUST always include the full source code, or a pointer
322 to where the source code can be found, to generate the exact binary
323 you are distributing. If you make any changes to the source code,
324 these changes must also be made available under the GPL.
325
326 For full details, read the copy of the GPL v3 found in the file named
327 [*Copying.txt*](https://github.com/official-stockfish/Stockfish/blob/master/Copying.txt).