MaaPracticeBoilerplate

本仓库为 MaaFramework 所提供的项目模板，开发者可基于此模板直接创建自己的 MaaXXX 项目。

MaaFramework 是基于图像识别技术、运用 MAA 开发经验去芜存菁、完全重写的新一代自动化黑盒测试框架。 低代码的同时仍拥有高扩展性，旨在打造一款丰富、领先、且实用的开源库，助力开发者轻松编写出更好的黑盒测试程序，并推广普及。

即刻开始

• 📄 快速开始
• 🎞️ 视频教程

如何开发

0. 使用右上角 Use this template - Create a new repository 来基于本模板创建您自己的项目。

1. 完整克隆本项目及子项目（地址请修改为您基于本模板创建的新项目地址）。

   git clone --recursive https://github.com/MaaXYZ/MaaPracticeBoilerplate.git

   请注意，一定要完整克隆子项目，不要漏了 --recursive，也不要下载 zip 包！
   这步未正确操作会导致所有 OCR（文字识别）失败！

2. 下载 MaaFramework 的 Release 包，解压到 deps 文件夹中。

3. 配置资源文件。

   python ./configure.py

4. 按需求修改 assets 中的资源文件，请参考 MaaFramework 相关文档。

   • 可使用 MaaDebugger 进行调试；

   • 也可以在本地安装后测试：

     1. 执行安装脚本

        python ./install.py

     2. 执行MaaPiCli

        • Windows

          运行 install/MaaPiCli.exe

        • Linux/macOS

          如果提示缺少启动权限，可通过 chmod a+x install/MaaPiCli 命令添加

          运行 install/MaaPiCli

5. 完成开发工作后，上传您的代码并发布版本。

   # 配置 git 信息（仅第一次需要，后续不用再配置）
   git config user.name "您的 GitHub 昵称"
   git config user.email "您的 GitHub 邮箱"
   
   # 提交修改
   git add .
   git commit -m "XX 新功能"
   git push origin HEAD -u

6. 发布您的版本

   需要先修改仓库设置 Settings - Actions - General - Read and write permissions - Save

   # CI 检测到 tag 会自动进行发版
   git tag v1.0.0
   git push origin v1.0.0

7. 更多操作，请参考个性化配置（可选）

生态共建

MAA 正计划建设为一类项目，而非舟的单一软件。

若您的项目依赖于 MaaFramework，我们欢迎您将它命名为 MaaXXX, MXA, MAX 等等。当然，这是许可而不是限制，您也可以自由选择其他与 MAA 无关的名字，完全取决于您自己的想法！

同时，我们也非常欢迎您提出 PR，在 最佳实践列表 中添加上您的项目！

FAQ

1. 我是第一次使用 Python，在命令行输入 python ./configure.py 或 python -m pip install MaaFW 之后没有反应？没有报错，也没有提示成功，什么都没有

Win10 或者 Win11 系统自带了一份 "Python"，但它其实只是一个安装器，是没法用的。
你需要做的是关闭它或者删除它的环境变量，然后自己去 Python 官网下载并安装一份 Python。
参考方法

2. 我输入 python ./configure.py 后报错：Please clone this repository completely, don’t miss "--recursive", and don’t download the zip package!

请仔细阅读文档！！！
就是你现在正在看的本篇文档，就在上面，“如何开发”里的第一条，都已经用粗体标出来了，再问我要骂人了！

3. 使用 MaaDebugger 或 MaaPicli 时弹窗报错，应用程序错误：应用程序无法正常启动

一般是电脑缺少某些运行库，请安装一下 vc_redist 。

4. 我在这个仓库里提了 Issue 很久没人回复

这里是《项目模板》仓库，它仅仅是一个模板，一般很少会修改，开发者也较少关注。
在此仓库请仅提问模板相关问题，其他问题最好前往对应的仓库提出，如果有 log，最好也带上它（debug/maa.log 文件）

• MaaFW 本身及 MaaPiCli 的问题：MaaFramework/issues
• MaaDebugger 的问题：MaaDebugger/issues
• 不知道算是哪里的、其他疑问等：讨论区

5. OCR 文字识别一直没有识别结果，报错 "Failed to load det or rec", "ocrer_ is null"

你不但没有仔细阅读文档，还无视了前面步骤的报错。我不想解释了，请再把本文档仔细阅读一遍！

鸣谢

本项目由 MaaFramework 强力驱动！

感谢以下开发者对本项目作出的贡献（下面链接改成你自己的项目地址）: