快速开始

1. 从模板创建仓库

点击 GitHub 上的 Use this template,创建自己的 repository,然后 clone:

git clone https://github.com/<你的 GitHub 用户名>/<你的仓库名>.git
cd <你的仓库名>

clone 完成后,可以选择以下任一方式初始化项目:

  • 使用 AI 编程工具(推荐):在 Codex 中输入 使用 $initialize-ok-script-app 初始化这个仓库。使用其他工具时,让它先阅读 .agents/skills/initialize-ok-script-app/SKILL.md。初始化助手会先询问游戏名、运行目标、仓库地址、图标和首个任务,再修改项目。
  • 手动初始化:继续完成本文和后续页面中的步骤。

2. 安装 Python 3.12 和项目依赖

安装 Python 3.12.10,然后在仓库目录中执行:

py -3.12 -m venv .venv
.\.venv\Scripts\Activate.ps1
$PypiIndex = "https://pypi.org/simple/"
python -m pip install --index-url $PypiIndex --upgrade pip

根据应用的运行目标选择一个依赖 profile。Qt 桌面界面:

python -m pip install --index-url $PypiIndex --no-deps --upgrade -r requirements.txt
python main_debug.py

Web 界面:

python -m pip install --index-url $PypiIndex --no-deps --upgrade -r requirements-web.txt
python web_main_debug.py

锁定文件用于可重复安装,是日常开发的推荐方式。如果需要直接从 pyproject.toml 解析最新的兼容依赖,可以分别使用:

python -m pip install --index-url $PypiIndex ".[qt]"
python -m pip install --index-url $PypiIndex ".[web]"

只需执行与目标对应的一条命令。官方 PyPI 的 pip 索引入口是 https://pypi.org/simple/,而不是网站首页 https://pypi.org/;使用后者会导致 No matching distribution found,即使该包实际存在。

通常不需要管理员权限。如果目标游戏以管理员权限运行,自动化程序也需要以相同权限启动,否则截图或输入可能无法生效。

3. 初始化应用

接下来完成以下工作:

  1. 按应用配置修改应用名称、运行目标、图标和更新仓库。
  2. 按任务开发创建并注册第一个任务。
  3. 启动 Debug 模式:
python main_debug.py
  1. 运行测试:
python -m unittest tests.TestMain
  1. 验证完成后,按打包与发布配置工作流并推送 tag。
在 GitHub 查看源文件 ↗ · 页面生成时间: 2026年9月24日