| Name | pikafish-terminal JSON |
| Version |
0.0.8
JSON |
| download |
| home_page | None |
| Summary | A terminal-based Xiangqi (Chinese Chess) game powered by the Pikafish engine |
| upload_time | 2025-07-16 08:34:39 |
| maintainer | None |
| docs_url | None |
| author | Pikafish Terminal Contributors |
| requires_python | >=3.8 |
| license | MIT License
Copyright (c) 2025 Pikafish Terminal Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. |
| keywords |
xiangqi
chinese-chess
chess
game
terminal
pikafish
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Pikafish Terminal
Play Xiangqi (Chinese Chess) in your terminal against the Pikafish AI engine.
## Install
```bash
pip install pikafish-terminal
```
## Play
```bash
pikafish
```
## Controls
- Enter moves like `1013` (from position 1,0 to 1,3)
- Type `h` for move hints
- Type `s` to toggle score display
- Type `quit` to exit
## Examples
```bash
pikafish --difficulty 3 # Medium level (1-5)
pikafish --depth 10 # Custom depth
pikafish --time 2.0 # Custom time limit
pikafish --config-list # Show all settings
```
## Configuration
Settings are loaded from the built-in `config.yaml` file included with the package. The configuration provides default difficulty levels, hints, and display options.
That's it! The AI engine downloads automatically on first run.
Raw data
{
"_id": null,
"home_page": null,
"name": "pikafish-terminal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "xiangqi, chinese-chess, chess, game, terminal, pikafish",
"author": "Pikafish Terminal Contributors",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/90/13/882993aa374b59bf75b4528b570618ad71ee7f04260eba9052ded847ca14/pikafish_terminal-0.0.8.tar.gz",
"platform": null,
"description": "# Pikafish Terminal\n\nPlay Xiangqi (Chinese Chess) in your terminal against the Pikafish AI engine.\n\n## Install\n\n```bash\npip install pikafish-terminal\n```\n\n## Play\n\n```bash\npikafish\n```\n\n## Controls\n\n- Enter moves like `1013` (from position 1,0 to 1,3)\n- Type `h` for move hints\n- Type `s` to toggle score display\n- Type `quit` to exit\n\n## Examples\n\n```bash\npikafish --difficulty 3 # Medium level (1-5)\npikafish --depth 10 # Custom depth\npikafish --time 2.0 # Custom time limit\npikafish --config-list # Show all settings\n```\n\n## Configuration\n\nSettings are loaded from the built-in `config.yaml` file included with the package. The configuration provides default difficulty levels, hints, and display options.\n\nThat's it! The AI engine downloads automatically on first run.\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2025 Pikafish Terminal Contributors\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE. ",
"summary": "A terminal-based Xiangqi (Chinese Chess) game powered by the Pikafish engine",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/midstreeeam/pikafish-terminal",
"Issues": "https://github.com/midstreeeam/pikafish-terminal/issues",
"Repository": "https://github.com/midstreeeam/pikafish-terminal"
},
"split_keywords": [
"xiangqi",
" chinese-chess",
" chess",
" game",
" terminal",
" pikafish"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "04bb8745a6c40f674616aed6660a1c0bf2a4c6b0a98ae59dce0e4b804d45075d",
"md5": "10690456419e1776952c07988b69b9b4",
"sha256": "f2e46f754896824725f42d2165c685cdfb858a525753a30b53f46ff352571a76"
},
"downloads": -1,
"filename": "pikafish_terminal-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "10690456419e1776952c07988b69b9b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 32160,
"upload_time": "2025-07-16T08:34:38",
"upload_time_iso_8601": "2025-07-16T08:34:38.680957Z",
"url": "https://files.pythonhosted.org/packages/04/bb/8745a6c40f674616aed6660a1c0bf2a4c6b0a98ae59dce0e4b804d45075d/pikafish_terminal-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9013882993aa374b59bf75b4528b570618ad71ee7f04260eba9052ded847ca14",
"md5": "3dccfbc187fbf5d366c26e378579ea2a",
"sha256": "a2d7d667dac926ffff984bc58b8be90c8bcd412d0f1f0d51ce01fb09c46596ff"
},
"downloads": -1,
"filename": "pikafish_terminal-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "3dccfbc187fbf5d366c26e378579ea2a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 135125,
"upload_time": "2025-07-16T08:34:39",
"upload_time_iso_8601": "2025-07-16T08:34:39.792764Z",
"url": "https://files.pythonhosted.org/packages/90/13/882993aa374b59bf75b4528b570618ad71ee7f04260eba9052ded847ca14/pikafish_terminal-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-16 08:34:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "midstreeeam",
"github_project": "pikafish-terminal",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pikafish-terminal"
}
