diff --git a/docs/zh_cn/develop/agent.md b/docs/zh_cn/develop/agent.md new file mode 100644 index 0000000..d635ab0 --- /dev/null +++ b/docs/zh_cn/develop/agent.md @@ -0,0 +1,9 @@ +# AgentServer 编写指引 + +> [!WARNING] +> Agent 属于 MaaFramework 的高级功能之一。在学习本章节以前请确保你已经掌握以下技能: +> +> - 对`ProjectInterface协议`和`Pipeline`非常熟悉。 +> - 至少用`Pipeline`编写过一个完整的可用`通用UI`执行的任务链。 + +本教程使用 Python 编写 AgentServer 示例。如果你有面向对象编程的经验,也可选用任意 MaaFramework 支持的编程语言来实现,将示例代码套用到其他语言是一件很容易的事。 diff --git a/docs/zh_cn/develop/custom_configure.md b/docs/zh_cn/develop/custom_configure.md index 194b194..6e37a15 100644 --- a/docs/zh_cn/develop/custom_configure.md +++ b/docs/zh_cn/develop/custom_configure.md @@ -96,7 +96,6 @@ - json ``` - 配置文件 `.prettierrc.yaml` , [具体规则](https://prettier.io/docs/en/options.html) 这里用到了 "prettier-plugin-multiline-arrays" 插件,目的是保持多行数组,不需要则可删去。 diff --git a/docs/zh_cn/develop/faq.md b/docs/zh_cn/develop/faq.md index 514aab6..77f672c 100644 --- a/docs/zh_cn/develop/faq.md +++ b/docs/zh_cn/develop/faq.md @@ -37,6 +37,6 @@ Win10 或者 Win11 系统自带了一份 "Python",但它其实只是一个安 闭门造车大概率无法解决任何问题,你可以加入 [MaaFramework 开发交流群](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=9sleK6URhEG0v3QeTmpFueCjF26wibEH&authKey=LBZc5FxWa3M%2BiWj3rpBfRmqg9PD9jJNaxpp3xTqTcGxsp1Am3kd1uzxQXiP4w8w4&noverify=0&group_code=595990173) 以寻求帮助。 -> [!WARNING] +> [!WARNING] > 在提问前,请完整阅读 [MaaFramework 开发文档](https://maafw.com/docs/1.1-QuickStarted)以及[如何开发](./how_to_develop.md),通常情况下他们能解决大多数问题。 > 在提问时,请 **具体指出文档中困惑的章节** / **分享你的项目文件中的具体内容** / **提供完整的报错信息** ,不然你能得的大概率只有类似 _“请先读文档”_ 这样的回答。 diff --git a/docs/zh_cn/develop/how_to_develop.md b/docs/zh_cn/develop/how_to_develop.md index 0e8b75b..fa29b87 100644 --- a/docs/zh_cn/develop/how_to_develop.md +++ b/docs/zh_cn/develop/how_to_develop.md @@ -1,18 +1,18 @@ # 如何开发 -在开始开发前请先阅读 MaaFramework 开发文档的[快速开始](https://maafw.com/docs/1.1-QuickStarted)章节,以便你对MaaFramework 有一个基本的了解。 +在开始开发前请先阅读 MaaFramework 开发文档的[快速开始](https://maafw.com/docs/1.1-QuickStarted)章节,以便你对 MaaFramework 有一个基本的了解。 ~~同时,我们还提供了一个[🎞️ 视频教程](https://www.bilibili.com/video/BV1yr421E7MW)以供参考。~~ 视频中使用的版本较老,一切问题须以最新版文档为准。 ## 开发前提 -使用本教程进行开发则默认你遵守MaaFramework衍生项目的相关开发规范以及共识,所有的讨论也将基于以下前提。 +使用本教程进行开发则默认你遵守 MaaFramework 衍生项目的相关开发规范以及共识,所有的讨论也将基于以下前提。 -1. 使用基于 git 作为版本控制工具 +1. 使用基于 git 作为版本控制工具 如果你还不会用,可以先在[菜鸟教程](https://www.runoob.com/git/git-tutorial.html)进行学习。 -2. 使用 GitHub 托管代码并使用相关 [CI/CD 工作流](https://docs.github.com/zh/actions) +2. 使用 GitHub 托管代码并使用相关 [CI/CD 工作流](https://docs.github.com/zh/actions) 项目中附带了一些基于 [GitHub Actions](https://docs.github.com/zh/actions) 的 CI/CD 工作流配置,你可以通过他们来自动进行测试以及将项目打包和发布。 -3. 了解本框架中一些常见的术语 +3. 了解本框架中一些常见的术语 MaaFramework 手册中的[术语解释](https://maafw.com/docs/1.2-ExplanationOfTerms)章节介绍了一些基本的专有术语。 ## 开发步骤 @@ -34,7 +34,7 @@ └── rec.onnx ``` - > [!WARNING] + > [!WARNING] > 请注意,您不需要将 OCR 资源文件上传到您的代码仓库中。`.gitignore` 已经忽略了 `assets/resource/model/ocr/` 目录,且 GitHub workflow 在发布版本时会自动配置这些资源文件。 _如果希望使用其他版本的模型,可以参考[这个说明](https://github.com/MaaXYZ/MaaCommonAssets/tree/main/OCR)。_ @@ -58,7 +58,7 @@ 本模板附带 GitHub Actionss 工作流的配置文件,CI 检测到 tag 会自动将 [MFAAvalonia](https://github.com/SweetSmellFox/MFAAvalonia) 与你的项目一同打包和发版。 - > [!NOTE] + > [!NOTE] > 第一次操作前,需要**先**修改 Github 仓库设置 `Settings` - `Actions` - `General` - `Read and write permissions` - `Save` ```bash