快速上手(QUICKSTART)
本项目仅支持 Python 3.12,请以管理员权限启动终端。依赖管理使用 uv。
💡 提示:如果只需使用程序挂机或辅助,建议直接前往 GitHub Releases 下载打包好的安装包运行,无需配置 Python 开发环境。
1. 安装依赖
uv sync
2. 从源码运行
# Release 版
uv run python main.py
# Debug 版(开启调试模式,输出更多识别信息)
uv run python main_debug.py
3. 新增一个一次性任务
- 在
src/tasks/onetime/下新建文件,继承BaseGameTask(最简范例见src/tasks/test/test_screenshot_task.py,完整业务任务见src/tasks/onetime/claim_daily_task.py等)。 - 在
__init__中设置name、description、icon与default_config。 - 实现
run(self),使用self.wait_ocr/self.wait_click_feature/self.click_relative等 API。 若是「看到某东西 → 点它 → 验证结果」这类流程,用self.wait_action_result(识别源适配器见src/core/detector/);只等一个结果用self.wait_expectation。详见development.md的 「Action 生命周期」一节。 - 在
src/config.py的onetime_tasks中注册:["src.tasks.onetime.my_task", "MyTask"]。
4. 新增一个触发式任务
- 在
src/tasks/trigger/下新建文件,继承BaseGameTask, TriggerTask(见src/tasks/trigger/skip_dialog_task.py)。 - 设置
trigger_interval与default_config。 - 在
src/config.py的trigger_tasks中注册。
5. 模板匹配
标记模板资源后(ok-script 的标注工具),在 debug 模式运行一次会生成
src/data/feature_list.py 枚举。之后可用 self.wait_feature(FeatureList.xxx)。
6. 测试
./run_tests.ps1
# 或
uv run python -m unittest discover -s tests