stockfish

A free and strong UCI chess engine

https://github.com/official-stockfish/stockfish

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (16.0%) to scientific vocabulary

Keywords

chess chess-engine cpp stockfish uci
Last synced: 6 months ago · JSON representation ·

Repository

A free and strong UCI chess engine

Basic Info
  • Host: GitHub
  • Owner: official-stockfish
  • License: gpl-3.0
  • Language: C++
  • Default Branch: master
  • Homepage: https://stockfishchess.org/
  • Size: 17.8 MB
Statistics
  • Stars: 13,687
  • Watchers: 258
  • Forks: 2,595
  • Open Issues: 38
  • Releases: 91
Topics
chess chess-engine cpp stockfish uci
Created over 11 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation Authors

README.md

[![Stockfish][stockfish128-logo]][website-link]

Stockfish

A free and strong UCI chess engine.
[Explore Stockfish docs »][wiki-link]

[Report bug][issue-link] · [Open a discussion][discussions-link] · [Discord][discord-link] · [Blog][website-blog-link] [![Build][build-badge]][build-link] [![License][license-badge]][license-link]
[![Release][release-badge]][release-link] [![Commits][commits-badge]][commits-link]
[![Website][website-badge]][website-link] [![Fishtest][fishtest-badge]][fishtest-link] [![Discord][discord-badge]][discord-link]

Overview

Stockfish is a free and strong UCI chess engine derived from Glaurung 2.1 that analyzes chess positions and computes the optimal moves.

Stockfish does not include a graphical user interface (GUI) that is required to display a chessboard and to make it easy to input moves. These GUIs are developed independently from Stockfish and are available online. Read the documentation for your GUI of choice for information about how to use Stockfish with it.

See also the Stockfish documentation for further usage help.

Files

This distribution of Stockfish consists of the following files:

  • README.md, the file you are currently reading.

  • Copying.txt, a text file containing the GNU General Public License version 3.

  • AUTHORS, a text file with the list of authors for the project.

  • src, a subdirectory containing the full source code, including a Makefile that can be used to compile Stockfish on Unix-like systems.

  • a file with the .nnue extension, storing the neural network for the NNUE evaluation. Binary distributions will have this file embedded.

Contributing

See Contributing Guide.

Donating hardware

Improving Stockfish requires a massive amount of testing. You can donate your hardware resources by installing the Fishtest Worker and viewing the current tests on Fishtest.

Improving the code

In the chessprogramming wiki, many techniques used in Stockfish are explained with a lot of background information. The section on Stockfish describes many features and techniques used by Stockfish. However, it is generic rather than focused on Stockfish's precise implementation.

The engine testing is done on Fishtest. If you want to help improve Stockfish, please read this guideline first, where the basics of Stockfish development are explained.

Discussions about Stockfish take place these days mainly in the Stockfish Discord server. This is also the best place to ask questions about the codebase and how to improve it.

Compiling Stockfish

Stockfish has support for 32 or 64-bit CPUs, certain hardware instructions, big-endian machines such as Power PC, and other platforms.

On Unix-like systems, it should be easy to compile Stockfish directly from the source code with the included Makefile in the folder src. In general, it is recommended to run make help to see a list of make targets with corresponding descriptions. An example suitable for most Intel and AMD chips:

cd src make -j profile-build

Detailed compilation instructions for all platforms can be found in our documentation. Our wiki also has information about the UCI commands supported by Stockfish.

Terms of use

Stockfish is free and distributed under the GNU General Public License version 3 (GPL v3). Essentially, this means you are free to do almost exactly what you want with the program, including distributing it among your friends, making it available for download from your website, selling it (either by itself or as part of some bigger software package), or using it as the starting point for a software project of your own.

The only real limitation is that whenever you distribute Stockfish in some way, you MUST always include the license and the full source code (or a pointer to where the source code can be found) to generate the exact binary you are distributing. If you make any changes to the source code, these changes must also be made available under GPL v3.

Acknowledgements

Stockfish uses neural networks trained on data provided by the Leela Chess Zero project, which is made available under the Open Database License (ODbL).

Owner

  • Name: official-stockfish
  • Login: official-stockfish
  • Kind: organization

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Stockfish
message: >-
  Please cite this software using the metadata from this
  file.
type: software
authors:
  - name: The Stockfish developers (see AUTHORS file)
repository-code: 'https://github.com/official-stockfish/Stockfish'
url: 'https://stockfishchess.org/'
repository-artifact: 'https://stockfishchess.org/download/'
abstract: Stockfish is a free and strong UCI chess engine.
keywords:
  - chess
  - artificial intelligence (AI)
  - tree search
  - alpha-beta search
  - neural networks (NN)
  - efficiently updatable neural networks (NNUE)
license: GPL-3.0

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 133
  • Total pull requests: 1,555
  • Average time to close issues: 29 days
  • Average time to close pull requests: 9 days
  • Total issue authors: 87
  • Total pull request authors: 130
  • Average comments per issue: 4.16
  • Average comments per pull request: 2.34
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 62
  • Pull requests: 896
  • Average time to close issues: 9 days
  • Average time to close pull requests: 6 days
  • Issue authors: 49
  • Pull request authors: 72
  • Average comments per issue: 3.0
  • Average comments per pull request: 1.78
  • Merged pull requests: 5
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Chess321 (8)
  • vondele (8)
  • amchess (6)
  • Disservin (4)
  • dav1312 (4)
  • PavelChess (4)
  • maximmasiutin (3)
  • PikaCat-OuO (3)
  • danispringer (3)
  • salhimohamedlamine (3)
  • peregrineshahin (3)
  • Rechenschieber (2)
  • pb00067 (2)
  • Skpro09 (2)
  • mstembera (2)
Pull Request Authors
  • FauziAkram (253)
  • xu-shawn (228)
  • Disservin (111)
  • Ergodice (90)
  • Vizvezdenec (89)
  • mstembera (84)
  • linrock (48)
  • Nonlinear2 (46)
  • vondele (45)
  • XInTheDark (36)
  • lucasart (33)
  • locutus2 (32)
  • MinetaS (27)
  • pb00068 (25)
  • robertnurnberg (24)
Top Labels
Issue Labels
build (10) needs-analysis (7) windows (4) to be merged (3) simplification (3) bug (3) CI/CD (2) feature/functionality (2) no-functional-change (2) discussion (1) functional-change (1)
Pull Request Labels
to be merged (826) simplification (416) 🚀 gainer (306) no-functional-change (185) functional-change (157) bug (45) feature/functionality (35) non-functional-change (35) CI/CD (22) no-bench-change (17) build (16) discussion (14) ci/cd (10) cleanup (4) windows (2) needs-analysis (2) bench-change (2) not-planned (1)

Dependencies

.github/workflows/stockfish_arm_binaries.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
.github/workflows/stockfish_binaries.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • msys2/setup-msys2 v2 composite
.github/workflows/stockfish_compile_test.yml actions
  • actions/checkout v3 composite
  • msys2/setup-msys2 v2 composite
.github/workflows/stockfish_sanitizers.yml actions
  • actions/checkout v3 composite
.github/workflows/stockfish_test.yml actions
  • actions/checkout v3 composite
  • msys2/setup-msys2 v2 composite