在哪里可以找到 SikuliX 的文档和源码?
更新时间
在 SikuliX 官网(sikulix.com)首页即可找到两个核心入口:Read the docs 指向文档,Sources on GitHub 指向源码仓库。首页同时提示 RaiMan 已停止开发,并指向后续项目 Oculix;如果你需要的是长期维护的版本,应把这一点纳入选择。
官网提供的入口
首页标题为“SikuliX by RaiMan”,正文明确列出以下导航项:
| 入口 | 指向内容 | 适用场景 |
|---|---|---|
| Read the docs | SikuliX 官方文档 | 查安装、API 用法、脚本编写方法 |
| Sources on GitHub | GitHub 上的源码 | 阅读实现、提交 issue、自行构建 |
| HOME | 返回站点首页 | 在站内切换页面 |
| Disclaimer | 免责声明 | 了解使用条款与责任范围 |
首页还提到“Sikulix history in 2015 with version 1”,并附有 RaiMan 在 2015 年 2 月接受 Joe Colantonio 采访的记录。这些属于背景资料,查文档和源码时不必先读。
使用这些入口的注意事项
文档入口
点击 Read the docs 后,按你使用的版本查找对应章节。SikuliX 的核心能力是“Automate what you see on a computer monitor”,即基于屏幕图像识别来操作界面,因此文档中与截图匹配、等待时机、失败重试相关的内容最值得先看。例如需要让脚本在弹窗出现后自动点击按钮,就要先确认文档里图像匹配的相似度设置和等待超时写法,而不是直接照搬示例。
源码入口
点击 Sources on GitHub 会离开官网进入代码托管页面。适合以下情况:
- 想确认某个行为在源码中如何实现;
- 遇到疑似 bug,需要对照代码或提交 issue;
- 想自行构建或做二次开发。
如果只是想用 SikuliX 完成自动化任务,优先读文档即可,源码不是必需入口。
开发状态提示
首页写明“Now Oculix - RaiMan stopped dev”,并给出“Look here for more information”的跳转。这意味着官网所介绍的 SikuliX 已不再由原作者继续开发。选择时可按需求区分:
- 维护旧脚本、复现既有方案:继续使用 SikuliX,文档和 GitHub 源码仍可查阅;
- 新项目、需要持续更新:先通过首页的 Oculix 链接了解后续项目,再决定是否采用 SikuliX。
常见卡点
- 只看到首页导航,找不到具体文档页:文档内容在 Read the docs 指向的站点内,不在首页展开,需点击进入后再检索。
- 把 GitHub 当成使用手册:源码仓库适合查实现和提问题,系统学习用法仍应以文档为主。
- 忽略停止开发的提示:在团队项目中引入前,先确认版本维护状态是否符合你的支持周期要求。
首页另有一个标注为“A gimmik :-)”的条目,属于站点趣味内容,与获取文档和源码无关,可跳过。