Metadata-Version: 2.4
Name: chatgame
Version: 0.1.12
Summary: Game puzzle screenshot solver with CLI and Web UI
Author-email: ChatArch <1073853456@qq.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ChatArch/ChatGame
Project-URL: Repository, https://github.com/ChatArch/ChatGame
Project-URL: Documentation, https://arch.gh.wzhecnu.cn/ChatGame/
Keywords: chatgame,chatarch,cli
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click<9.0,>=8.0
Requires-Dist: chatstyle<0.3.0,>=0.2.0
Requires-Dist: pillow>=9.0
Requires-Dist: scikit-learn>=1.0
Requires-Dist: numpy>=1.23
Requires-Dist: fastapi>=0.100
Requires-Dist: uvicorn>=0.20
Requires-Dist: python-multipart>=0.0.6
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: httpx; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Requires-Dist: twine; extra == "dev"
Provides-Extra: docs
Requires-Dist: mkdocs<2.0,>=1.6; extra == "docs"
Requires-Dist: mkdocs-material<9.7,>=9.5; extra == "docs"
Requires-Dist: mkdocs-static-i18n<2.0,>=1.2; extra == "docs"
Requires-Dist: mike<3.0,>=2.0; extra == "docs"
Dynamic: license-file

<div align="center">
    <a href="https://pypi.python.org/pypi/chatgame">
        <img src="https://img.shields.io/pypi/v/chatgame.svg" alt="PyPI version" />
    </a>
    <a href="https://github.com/ChatArch/ChatGame/actions/workflows/ci.yml">
        <img src="https://github.com/ChatArch/ChatGame/actions/workflows/ci.yml/badge.svg" alt="Tests" />
    </a>
    <a href="https://arch.gh.wzhecnu.cn/ChatGame/">
        <img src="https://img.shields.io/badge/docs-mkdocs-blue.svg" alt="Documentation" />
    </a>
</div>

<div align="center">

[English](README.en.md) | [简体中文](README.md)
</div>

# ChatGame

ChatGame 是游戏谜题截图求解工具：从截图解析棋盘，输出求解步骤，并提供安装态 Web UI。

## 快速开始

```bash
pip install chatgame
chatgame --version
chatgame --tree
chatgame --tree-brief
chatgame games
chatgame solve level24.png -o solved.png
chatgame web setup
chatgame web serve
```

## 当前 CLI

以下为 `chatgame --tree-brief` 的注册命令面；`chatgame --tree` 会额外显示参数签名。

```text
chatgame
├── --help  # Show this message and exit.
├── --version  # Show the version and exit.
├── --tree  # Print the registered CLI tree and exit.
├── --tree-brief  # Print the registered CLI tree without parameter signatures and exit.
├── games  # 列出已支持的游戏；只读文本输出。
├── solve  # 解析截图并输出求解步骤；--output 写入标注图。
└── web  # 管理安装态 Web 服务（后端 + 前端）。
    ├── serve  # 启动长驻 Web 服务；监听指定地址和端口。
    └── setup  # 检查 Web 运行环境；只读状态输出。
```

完整命令树见： https://arch.gh.wzhecnu.cn/ChatGame/cli-tree/

## 文档

- 文档首页： https://arch.gh.wzhecnu.cn/ChatGame/
- CLI 树： https://arch.gh.wzhecnu.cn/ChatGame/cli-tree/
- 英文文档： https://arch.gh.wzhecnu.cn/ChatGame/en/

## 开发验证

```bash
pip install -e ".[dev,docs]"
python -m pytest -q
mkdocs build --strict
python -m build
```

扩展前先阅读 `DEVELOP.md` 和 `AGENTS.md`。
