Metadata-Version: 2.4
Name: pikafish-terminal
Version: 0.0.5
Summary: A terminal-based Xiangqi (Chinese Chess) game powered by the Pikafish engine
Author: Pikafish Terminal Contributors
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. 
Project-URL: Homepage, https://github.com/midstreeeam/pikafish-terminal
Project-URL: Repository, https://github.com/midstreeeam/pikafish-terminal
Project-URL: Issues, https://github.com/midstreeeam/pikafish-terminal/issues
Keywords: xiangqi,chinese-chess,chess,game,terminal,pikafish
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Games/Entertainment :: Board Games
Classifier: Topic :: Games/Entertainment :: Turn Based Strategy
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.25.0
Requires-Dist: colorama>=0.4.0
Requires-Dist: urllib3>=1.26.0
Requires-Dist: py7zr>=0.20.0
Requires-Dist: tqdm>=4.60.0
Requires-Dist: pyyaml>=6.0.2
Provides-Extra: dev
Requires-Dist: pytest>=6.0; extra == "dev"
Requires-Dist: black>=22.0; extra == "dev"
Requires-Dist: flake8>=4.0; extra == "dev"
Requires-Dist: mypy>=0.900; extra == "dev"
Dynamic: license-file

# 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 stored in `config.yaml` (auto-created). Edit this file to customize difficulties, hints, and display options.

That's it! The AI engine downloads automatically on first run.
