{"id":13459016,"url":"https://github.com/official-pikafish/Pikafish","last_synced_at":"2025-03-24T16:31:16.216Z","repository":{"id":50589871,"uuid":"518502302","full_name":"official-pikafish/Pikafish","owner":"official-pikafish","description":"UCI xiangqi engine","archived":false,"fork":false,"pushed_at":"2024-10-29T12:24:16.000Z","size":15228,"stargazers_count":954,"open_issues_count":4,"forks_count":175,"subscribers_count":22,"default_branch":"master","last_synced_at":"2024-10-29T14:51:39.223Z","etag":null,"topics":["board-game","chinese-chess","engine","free","pikafish","powerful","stockfish","strongest","uci","xiangqi"],"latest_commit_sha":null,"homepage":"http://pikafish.com","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"official-stockfish/Stockfish","license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/official-pikafish.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"Copying.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-07-27T14:57:11.000Z","updated_at":"2024-10-29T14:16:38.000Z","dependencies_parsed_at":"2023-02-19T03:50:18.027Z","dependency_job_id":"433cf272-5a16-42e6-ad70-44610743eb13","html_url":"https://github.com/official-pikafish/Pikafish","commit_stats":null,"previous_names":[],"tags_count":64,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/official-pikafish%2FPikafish","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/official-pikafish%2FPikafish/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/official-pikafish%2FPikafish/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/official-pikafish%2FPikafish/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/official-pikafish","download_url":"https://codeload.github.com/official-pikafish/Pikafish/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245308545,"owners_count":20594265,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["board-game","chinese-chess","engine","free","pikafish","powerful","stockfish","strongest","uci","xiangqi"],"created_at":"2024-07-31T09:01:00.999Z","updated_at":"2025-03-24T16:31:16.210Z","avatar_url":"https://github.com/official-pikafish.png","language":"C++","funding_links":[],"categories":["Engines","C++"],"sub_categories":["Games collections"],"readme":"\u003cdiv align=\"center\"\u003e\n\n  [![Pikafish][pikafish-logo]][website-link]\n\n\n  \u003ch3\u003ePikafish\u003c/h3\u003e\n\n  A free and strong UCI xiangqi engine.\n  \u003cbr\u003e\n  \u003cstrong\u003e[Explore Pikafish docs »][wiki-link]\u003c/strong\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n  [Report bug][issue-link]\n  ·\n  [Open a discussion][discussions-link]\n  ·\n  [Discord][discord-link]\n  ·\n  [Blog][website-blog-link]\n\n  [![Build][build-badge]][build-link]\n  [![License][license-badge]][license-link]\n  [![RuleBook][rulebook-badge]][rulebook-link]\n  \u003cbr\u003e\n  [![Release][release-badge]][release-link]\n  [![Commits][commits-badge]][commits-link]\n  \u003cbr\u003e\n  [![Website][website-badge]][website-link]\n  [![Fishtest][fishtest-badge]][fishtest-link]\n  [![Discord][discord-badge]][discord-link]\n\n\u003c/div\u003e\n\n## Overview\n\n[Pikafish][website-link] is a **free and strong UCI xiangqi engine** derived from\n[Stockfish][stockfish-link] that analyzes xiangqi positions and computes the optimal moves.\n\nPikafish **does not include a graphical user interface** (GUI) that is required\nto display a chessboard and to make it easy to input moves. These GUIs are\ndeveloped independently from Pikafish and are available online. **Read the\ndocumentation for your GUI** of choice for information about how to use\nPikafish with it.\n\nSee also the Pikafish [documentation][wiki-usage-link] for further usage help.\n\n## Files\n\nThis distribution of Pikafish consists of the following files:\n\n  * [README.md][readme-link], the file you are currently reading.\n\n  * [Copying.txt][license-link], a text file containing the GNU General Public\n    License version 3.\n\n  * [AUTHORS][authors-link], a text file with the list of authors for the official Pikafish project.\n\n  * [src][src-link], a subdirectory containing the full source code, including a\n    Makefile that can be used to compile Pikafish on Unix-like systems.\n\n  * a file with the .nnue extension, storing the neural network for the NNUE\n    evaluation.\n\n## Contributing\n\n__See [Contributing Guide](./CONTRIBUTING.md).__\n\n### Donating hardware\n\nImproving Pikafish requires a massive amount of testing. You can donate your\nhardware resources by installing the [Fishtest Worker][worker-link] and viewing\nthe current tests on [Fishtest][fishtest-link].\n\n### Improving the code\n\nIn the [chessprogramming wiki][programming-link], many techniques used in\nPikafish are explained with a lot of background information.\nThe [section on Stockfish][programmingsf-link] describes many features\nand techniques used by Stockfish. However, it is generic rather than\nfocused on Stockfish's precise implementation.\n\nThe engine testing is done on [Fishtest][fishtest-link].\nIf you want to help improve Pikafish, please read this [guideline][guideline-link]\nfirst, where the basics of Pikafish development are explained.\n\nDiscussions about Pikafish take place these days mainly in the Pikafish\n[Discord server][discord-link]. This is also the best place to ask questions\nabout the codebase and how to improve it.\n\n\n## Compiling Pikafish\n\nPikafish has support for 32 or 64-bit CPUs, certain hardware instructions,\nbig-endian machines such as Power PC, and other platforms.\n\nOn Unix-like systems, it should be easy to compile Pikafish directly from the\nsource code with the included Makefile in the folder `src`. In general, it is\nrecommended to run `make help` to see a list of make targets with corresponding\ndescriptions.\n\n```\ncd src\nmake -j profile-build\n```\n\nDetailed compilation instructions for all platforms can be found in our\n[documentation][wiki-compile-link]. Our wiki also has information about\nthe [UCI commands][wiki-uci-link] supported by Pikafish.\n\n## Terms of use\n\n### GNU General Public License version 3\n\nPikafish is free and distributed under the\n[**GNU General Public License version 3**][license-link] (GPL v3). Essentially,\nthis means you are free to do almost exactly what you want with the program,\nincluding distributing it among your friends, making it available for download\nfrom your website, selling it (either by itself or as part of some bigger\nsoftware package), or using it as the starting point for a software project of\nyour own.\n\nThe only real limitation is that whenever you distribute Pikafish in some way,\nyou MUST always include the license and the full source code (or a pointer to\nwhere the source code can be found) to generate the exact binary you are\ndistributing. If you make any changes to the source code, these changes must\nalso be made available under GPL v3.\n\n## Acknowledgements\n\nPikafish uses neural networks trained on [data provided by the Pika Xiangqi Zero\nproject][px0-data-link], which is made available under the [Open Database License][odbl-link] (ODbL).\n\n[authors-link]:\t\t\thttps://github.com/official-pikafish/Pikafish/blob/master/AUTHORS\n[build-badge]:\t\t\thttps://img.shields.io/github/actions/workflow/status/official-pikafish/Pikafish/pikafish.yml?branch=master\u0026style=for-the-badge\u0026label=pikafish\u0026logo=github\n[build-link]:\t\t\t\thttps://github.com/official-pikafish/Pikafish/actions/workflows/pikafish.yml\n[commits-badge]:\t\thttps://img.shields.io/github/commits-since/official-pikafish/Pikafish/latest?style=for-the-badge\n[commits-link]:\t\t\thttps://github.com/official-pikafish/Pikafish/commits/master\n[discord-badge]:\t\t\thttps://img.shields.io/discord/1013130558089478144?style=for-the-badge\u0026label=discord\u0026logo=Discord\n[discord-link]:\t\t\thttps://discord.com/invite/uSb3RXb7cY\n[discussions-link]:   https://github.com/official-pikafish/Pikafish/discussions/new\n[fishtest-badge]:\t\t\thttps://img.shields.io/website?style=for-the-badge\u0026down_color=red\u0026down_message=Offline\u0026label=Fishtest\u0026up_color=success\u0026up_message=Online\u0026url=https://test.pikafish.org\n[fishtest-link]:\t\t\thttps://test.pikafish.org\n[guideline-link]:\t\t\thttps://github.com/glinscott/fishtest/wiki/Creating-my-first-test\n[issue-link]:         https://github.com/official-pikafish/Pikafish/issues/new?assignees=\u0026labels=\u0026template=BUG-REPORT.yml\n[license-badge]:\t\t\thttps://img.shields.io/github/license/official-pikafish/Pikafish?style=for-the-badge\u0026label=license\u0026color=success\n[license-link]:\t\t\thttps://github.com/official-pikafish/Pikafish/blob/master/Copying.txt\n[pikafish-logo]:\t\t\thttps://pikafish.org/assets/logo_256.png\n[programming-link]:\t\thttps://www.chessprogramming.org/Main_Page\n[programmingsf-link]:\thttps://www.chessprogramming.org/Stockfish\n[qqgroup-link]:\t\t\thttps://jq.qq.com/?_wv=1027\u0026k=FORWUh4W\n[readme-link]:\t\t\thttps://github.com/official-pikafish/Pikafish/blob/master/README.md\n[release-badge]:\t\t\thttps://img.shields.io/github/v/release/official-pikafish/Pikafish?style=for-the-badge\u0026label=official%20release\n[release-link]:\t\t\thttps://github.com/official-pikafish/Pikafish/releases/latest\n[rulebook-badge]:\t\thttps://img.shields.io/badge/computer%20rule-20B2AA?style=for-the-badge\u0026logo=mdbook\n[rulebook-link]:\t\t\thttps://pikafish.org/rule.html\n[src-link]:\t\t\t\thttps://github.com/official-pikafish/Pikafish/tree/master/src\n[stockfish-link]:\t\t\thttps://github.com/official-stockfish/Stockfish\n[uci-link]:\t\t\t\thttps://backscattering.de/chess/uci/\n[website-badge]:\t\thttps://img.shields.io/website?style=for-the-badge\u0026down_color=red\u0026down_message=Offline\u0026label=website\u0026up_color=success\u0026up_message=Online\u0026url=https://pikafish.org\n[website-link]:\t\t\thttps://pikafish.org\n[website-blog-link]:  https://pikafish.org/\n[wiki-link]:          https://github.com/official-pikafish/Pikafish/wiki\n[wiki-compile-link]:  https://github.com/official-pikafish/Pikafish/wiki/Compiling-from-source\n[wiki-uci-link]:      https://github.com/official-pikafish/Pikafish/wiki/UCI-\u0026-Commands\n[wiki-usage-link]:    https://github.com/official-pikafish/Pikafish/wiki/Download-and-usage\n[worker-link]:\t\t\thttps://github.com/xyztnecniV/yolo\n[px0-data-link]:      https://www.kaggle.com/datasets/pikacat/px0data\n[odbl-link]:          https://opendatacommons.org/licenses/odbl/odbl-10.txt","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fofficial-pikafish%2FPikafish","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fofficial-pikafish%2FPikafish","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fofficial-pikafish%2FPikafish/lists"}