Improve the Readme
[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?svg=true)](https://ci.appveyor.com/project/mcostalba/stockfish)
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.
59
60   * #### Move Overhead
61     Assume a time delay of x ms due to network and GUI overheads. This is useful to 
62     avoid losses on time in those cases.
63
64   * #### Minimum Thinking Time
65     Search for at least x ms per move. 
66
67   * #### Slow Mover
68     Lower values will make Stockfish take less time in games, higher values will 
69     make it think longer.
70
71   * #### nodestime
72     Tells the engine to use nodes searched instead of wall time to account for 
73     elapsed time. Useful for engine testing.
74
75   * #### UCI_Chess960
76     An option handled by your GUI. If true, Stockfish will play Chess960.
77
78   * #### UCI_AnalyseMode
79     An option handled by your GUI.
80
81   * #### SyzygyPath
82     Path to the folders/directories storing the Syzygy tablebase files. Multiple 
83     directories are to be separated by ";" on Windows and by ":" on Unix-based 
84     operating systems. Do not use spaces around the ";" or ":".
85     
86     Example: `C:\tablebases\wdl345;C:\tablebases\wdl6;D:\tablebases\dtz345;D:\tablebases\dtz6`
87     
88     It is recommended to store .rtbw files on an SSD. There is no loss in storing 
89     the .rtbz files on a regular HD.
90
91   * #### SyzygyProbeDepth
92     Minimum remaining search depth for which a position is probed. Set this option
93     to a higher value to probe less agressively if you experience too much slowdown
94     (in terms of nps) due to TB probing.
95
96   * #### Syzygy50MoveRule
97     Disable to let fifty-move rule draws detected by Syzygy tablebase probes count
98     as wins or losses. This is useful for ICCF correspondence games.
99
100   * #### SyzygyProbeLimit
101     Limit Syzygy tablebase probing to positions with at most this many pieces left
102     (including kings and pawns).
103
104
105 ## What to expect from Syzygybases?
106
107 If the engine is searching a position that is not in the tablebases (e.g.
108 a position with 8 pieces), it will access the tablebases during the search.
109 If the engine reports a very large score (typically 153.xx), this means
110 that it has found a winning line into a tablebase position.
111
112 If the engine is given a position to search that is in the tablebases, it
113 will use the tablebases at the beginning of the search to preselect all
114 good moves, i.e. all moves that preserve the win or preserve the draw while
115 taking into account the 50-move rule.
116 It will then perform a search only on those moves. **The engine will not move
117 immediately**, unless there is only a single good move. **The engine likely
118 will not report a mate score even if the position is known to be won.**
119
120 It is therefore clear that this behaviour is not identical to what one might
121 be used to with Nalimov tablebases. There are technical reasons for this
122 difference, the main technical reason being that Nalimov tablebases use the
123 DTM metric (distance-to-mate), while Syzygybases use a variation of the
124 DTZ metric (distance-to-zero, zero meaning any move that resets the 50-move
125 counter). This special metric is one of the reasons that Syzygybases are
126 more compact than Nalimov tablebases, while still storing all information
127 needed for optimal play and in addition being able to take into account
128 the 50-move rule.
129
130
131 ## Compiling Stockfish yourself from the sources
132
133 On Unix-like systems, it should be possible to compile Stockfish
134 directly from the source code with the included Makefile.
135
136 Stockfish has support for 32 or 64-bit CPUs, the hardware POPCNT
137 instruction, big-endian machines such as Power PC, and other platforms.
138
139 In general it is recommended to run `make help` to see a list of make
140 targets with corresponding descriptions. When not using the Makefile to
141 compile (for instance with Microsoft MSVC) you need to manually
142 set/unset some switches in the compiler command line; see file *types.h*
143 for a quick reference.
144
145
146 ## Understanding the code base and participating in the project
147
148 Stockfish's improvement over the last couple of years has been a great
149 community effort. There are a few ways to help contribute to its growth.
150
151 ### Donating hardware
152
153 Improving Stockfish requires a massive amount of testing. You can donate
154 your hardware resources by installing the [Fishtest Worker](https://github.com/glinscott/fishtest/wiki/Running-the-worker) 
155 and view the current tests on [Fishtest](http://tests.stockfishchess.org/tests).
156
157 ### Improving the code
158
159 If you want to help improve the code, there are several valuable ressources:
160
161 * [In this wiki,](https://www.chessprogramming.org) many techniques used in
162 Stockfish are explained with a lot of background information.
163
164 * [The section on Stockfish](https://www.chessprogramming.org/Stockfish)
165 describes many features and techniques used by Stockfish. However, it is
166 generic rather than being focused on Stockfish's precise implementation.
167 Nevertheless, a helpful resource.
168
169 * The latest source can always be found on [GitHub](https://github.com/official-stockfish/Stockfish).
170 Discussions about Stockfish take place in the [FishCooking](https://groups.google.com/forum/#!forum/fishcooking) 
171 group and engine testing is done on [Fishtest](http://tests.stockfishchess.org/tests).
172 If you want to help improve Stockfish, please read this [guideline](https://github.com/glinscott/fishtest/wiki/Creating-my-first-test)
173 first, where the basics of Stockfish development are explained.
174
175
176 ## Terms of use
177
178 Stockfish is free, and distributed under the **GNU General Public License version 3**
179 (GPL v3). Essentially, this means that you are free to do almost exactly
180 what you want with the program, including distributing it among your
181 friends, making it available for download from your web site, selling
182 it (either by itself or as part of some bigger software package), or
183 using it as the starting point for a software project of your own.
184
185 The only real limitation is that whenever you distribute Stockfish in
186 some way, you must always include the full source code, or a pointer
187 to where the source code can be found. If you make any changes to the
188 source code, these changes must also be made available under the GPL.
189
190 For full details, read the copy of the GPL v3 found in the file named
191 *Copying.txt*.