快速上手(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