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