JokyMouse 开发者文档
JokyMouse 不只是一个本地 Lua 宏宿主。它把脚本创作、录制增强、市场发布、试用订阅和创作者收益串成了一条完整链路,所以开发文档也应该是多页结构,而不是一张把所有内容塞满的长页面。
这套文档覆盖什么
- 如何写出一份可以在桌面端运行的脚本。
- 脚本元信息怎样影响审核、安装、更新和订阅。
- 当前公开的运行时模块,以及每个模块应该承担什么职责。
- 脚本从本地创作走向市场发布之后,平台会接管哪些产品流程。
阅读顺序
- 从 快速开始 了解最小脚本结构。
- 在 运行时模型 里确认模块边界和执行语义。
- 参考 脚本结构 设计稳定的元信息和 settings。
- 需要设计配置结构时,先看 脚本设置。
- 需要查函数签名时,先看 jokymouse API 与 jokymouse.system API,再按需阅读 jokymouse.dialog API、jokymouse.log API 与 键名列表。
- 涉及识字能力时进入 jokymouse.ocr API,涉及屏幕定位、取色和图像匹配时进入 jokymouse.screen API。
文档地图
快速开始 用一份最小可运行脚本把本地链路跑通,再逐步接入 settings、通知和发布流程。 运行时模型 理解 require 模块、异步任务、中断检查和为什么脚本不应该自行接管整套 UI。 API: jokymouse 主模块对外开放的运行时、输入控制、并发任务和设置读取接口。 API: jokymouse.system 系统时间、当前前台窗口与窗口查找能力。 API: 脚本设置 解释 settings 的作用、常见组件结构,以及平铺与树节点嵌套的推荐写法。 API: 键名列表 列出 key_press、key_release、key_click 可用的键名,并说明 macOS / Windows / Linux 的差异。 API: jokymouse.dialog 统一的提示框与确认框能力,适合在关键节点向用户说明状态并请求明确确认。 API: jokymouse.log 查看 print 和显式日志函数如何进入小丑鼠的运行日志面板,帮助定位脚本执行过程。 API: jokymouse.screen 屏幕尺寸、取色与找图能力,适合在自动化流程中做视觉判断与定位。
JokyMouse 的 API 还在持续开发中,欢迎加入 QQ 群:123 参与讨论和测试。