how_to_develop.md

如何开发

在开始开发前请先阅读 MaaFramework 开发文档的快速开始章节，以便你对MaaFramework 有一个基本的了解。

同时，我们还提供了一个🎞️ 视频教程以供参考。 视频中使用的版本较老，一切问题须以最新版文档为准。

开发前提

使用本教程进行开发则默认你遵守MaaFramework衍生项目的相关开发规范以及共识，所有的讨论也将基于以下前提。

1. 使用基于 git 作为版本控制工具 如果你还不会用，可以先在菜鸟教程进行学习。
2. 使用 GitHub 托管代码并使用相关 CI/CD 工作流 项目中附带了一些基于 GitHub Actions 的 CI/CD 工作流配置，你可以通过他们来自动进行测试以及将项目打包和发布。
3. 了解本框架中一些常见的术语 MaaFramework 手册中的术语解释章节介绍了一些基本的专有术语。

开发步骤

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

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

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

2. 下载 OCR（文字识别）资源文件 ppocr_v5.zip 解压到 assets/resource/model/ocr/ 目录下，确保路径如下：

   assets/resource/model/ocr/
   ├── det.onnx
   ├── keys.txt
   └── rec.onnx
   

   [!WARNING] 请注意，您不需要将 OCR 资源文件上传到您的代码仓库中。.gitignore 已经忽略了 assets/resource/model/ocr/ 目录，且 GitHub workflow 在发布版本时会自动配置这些资源文件。

   如果希望使用其他版本的模型，可以参考这个说明。

3. 进行开发工作。请参考 MaaFramework 相关文档，并按您的业务需求修改 assets 目录下的 resource 资源文件以及 interface.json 文件，然后使用 开发工具进行调试。

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

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

5. 发布您的版本

   本模板附带 GitHub Actionss 工作流的配置文件，CI 检测到 tag 会自动将 MFAAvalonia 与你的项目一同打包和发版。

   [!NOTE] 第一次操作前，需要先修改 Github 仓库设置 Settings - Actions - General - Read and write permissions - Save

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

   执行上述命令后，CI 会自动进行打包和发布，你可以在项目仓库的 Actions 页面中看到工作流的执行情况。如果一切顺利，运行结束后你可以在项目仓库的 Releases 页面中看到新发布的版本。

常见问题

请参考 FAQ

更多操作

请参考 个性化配置（可选）