ok-script documentation

简体中文 | English · Project home

The documentation follows a practical path: understand the concepts, run a project, learn the visual tools and advanced workflows, then consult the API while implementing tasks.

Learning path

Guide	Audience	Topics
Introduction to game automation	Readers new to computer vision or automation	Capture, analysis, decisions, input, and development tools
Quick start	Developers creating their first project	Template setup, environment, device configuration, execution, and diagnostics
Interface and developer tools	Developers learning the visual workflow	Tasks, capture, interaction, scripting, templates, and debug overlays
Advanced guide	Developers with a working template project	COCO templates, i18n, testing, packaging, and publishing
API reference	Developers implementing task logic	`Box`, `BaseTask`, capture, input, OCR, and image matching APIs

Fastest route to a working project

Install Python 3.12. Python 3.11 or later is supported.
Create a repository from the ok-script-app template.
Follow the quick-start guide to configure a Windows game or ADB device.
Run the application in debug mode and complete the capture test.
Use the API reference while implementing your tasks.

Useful links

If the documentation differs from the behavior you observe, open a GitHub issue and include your ok-script version, Python version, and runtime environment.