From f93ad60b0e0451ad28ed80515baf06d59a411787 Mon Sep 17 00:00:00 2001 From: MistEO Date: Mon, 10 Mar 2025 10:17:59 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=96=87=E6=A1=A3=E6=8E=AA=E8=BE=9E?= =?UTF-8?q?=E6=95=B4=E7=90=86?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en_us/1.1-QuickStarted.md | 24 +++++++++---------- docs/en_us/1.2-ExplanationOfTerms.md | 2 +- ...53\351\200\237\345\274\200\345\247\213.md" | 18 +++++++------- ...57\350\257\255\350\247\243\351\207\212.md" | 2 +- 4 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/en_us/1.1-QuickStarted.md b/docs/en_us/1.1-QuickStarted.md index 96ea8b1d9..4b68f1baa 100644 --- a/docs/en_us/1.1-QuickStarted.md +++ b/docs/en_us/1.1-QuickStarted.md @@ -6,10 +6,10 @@ MaaFramework supports complete low-code programming through JSON (Pipeline JSON) It is also possible to combine both approaches, using low-code as a form of "wrapper" for invocation. Below are several common integration methods: -### Complete Dependence on JSON Low-Code Programming (Using MaaPiCli.exe) +### Pure Json low-code programming (with common UI) This method is simple and quick, but not very flexible. It is recommended for beginners and those new to programming with MaaFramework. -We provide a [🎞️ video tutorial](https://www.bilibili.com/video/BV1yr421E7MW) and [⭐ project template](https://github.com/MaaXYZ/MaaPracticeBoilerplate) for this method. Here is an example: +We provide a [🎞️ video tutorial](https://www.bilibili.com/video/BV1yr421E7MW) and [⭐ boilerplate](https://github.com/MaaXYZ/MaaPracticeBoilerplate) for this method. Here is an example: ```jsonc // JSON does not support comments; this is pseudo-code for reference only and cannot be executed directly @@ -32,10 +32,10 @@ We provide a [🎞️ video tutorial](https://www.bilibili.com/video/BV1yr421E7M ### Use JSON Low-Code Programming with Custom Logic for Complex Tasks -**💡MaaFW 4.x version highlights** +**💡 MaaFW v4.x version highlights** -Use the universal GUI or CLI to run MaaFW and register custom tasks in the child process (AgentServer). -This method can be seamlessly switched from 1. Here is an example: +Based on the above pure Json low-code programming, register your custom task in the child process (AgentServer). +This method can be seamlessly switched from pure Json low-code and is also applicable to [⭐ boilerplate](https://github.com/MaaXYZ/MaaPracticeBoilerplate). The following is an example: ```jsonc { @@ -94,6 +94,8 @@ For details, please refer to [this commit](https://github.com/MaaXYZ/MaaPractice You can use low-code as a "wrapper" for invocation or register custom callbacks. +This method is not applicable to the boilerplate. You need to prepare resource files yourself. + ```python # This is pseudo code, for reference only, and cannot be run directly # "Recognize and click the start button", "Recognize and click the confirmation icon" and so on are all logic in Json @@ -115,7 +117,7 @@ def main(): ## Prepare resource files -*⭐If you use the project template, just modify it directly in [folder](https://github.com/MaaXYZ/MaaPracticeBoilerplate/tree/main/assets/resource).* +*⭐If you use the boilerplate, just modify it directly in [folder](https://github.com/MaaXYZ/MaaPracticeBoilerplate/tree/main/assets/resource).* You need to prepare some resource files with the typical file structure as follows: @@ -155,9 +157,7 @@ Tools: The files in `my_resource/image` are primarily used for template matching images, feature detection images, and other images required by the pipeline. They are read based on the `template` and other fields specified in the pipeline. -Please note that the images used need to be cropped from the lossless original image and scaled to 720p. If you use an Android emulator, please use the screenshot function that comes with the emulator! (You cannot directly take screenshots of the emulator window) - -**UNLESS YOU EXACTLY KNOW HOW MAAFRAMEWORK PROCESSES, DO USE THE CROPPING TOOLS BELOW TO OBTAIN IMAGES.** +Please note that the images used need to be cropped from the lossless original image and scaled to 720p. **UNLESS YOU EXACTLY KNOW HOW MAAFRAMEWORK PROCESSES, DO USE THE CROPPING TOOLS BELOW TO OBTAIN IMAGES.** - [Image Cropping and ROI Extraction Tool](https://github.com/MaaXYZ/MaaFramework/tree/main/tools/ImageCropper) - [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support) @@ -165,7 +165,7 @@ Please note that the images used need to be cropped from the lossless original i ### Text Recognition Model Files -*⭐If you use the project template, just follow its documentation and run `configure.py` to automatically deploy the model file.* +*⭐If you use the boilerplate, just follow its documentation and run `configure.py` to automatically deploy the model file.* The files in `my_resource/model/ocr` are ONNX models obtained from [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR) after conversion. @@ -189,11 +189,11 @@ If needed, you can also fine-tune the official pre-trained models of PaddleOCR y ## Run -You can integrate MaaFramework using Generic CLI (MaaPiCli), third-party Generic GUI (MFAWPF, etc) or by writing integration code yourself. +You can using Generic UI (MaaPiCli, MFA, MFW, etc) or by writing integration code yourself. ### Using MaaPiCli -*⭐If you use the project template, follow its documentation directly and run `install.py` to automatically package the relevant files.* +*⭐If you use the boilerplate, follow its documentation directly and run `install.py` to automatically package the relevant files.* Use MaaPiCli in the `bin` folder of the Release package, and write `interface.json` and place it in the same directory to use it. diff --git a/docs/en_us/1.2-ExplanationOfTerms.md b/docs/en_us/1.2-ExplanationOfTerms.md index 32b392330..2c53095ca 100644 --- a/docs/en_us/1.2-ExplanationOfTerms.md +++ b/docs/en_us/1.2-ExplanationOfTerms.md @@ -32,7 +32,7 @@ - **Agent** - The highlight of MaaFW 4.x is that it can separate the MaaFW body and `CustomRecognition` / `CustomAction` into two independent processes. + 💡 MaaFW v4.x version highlights, that it can separate the MaaFW body and `CustomRecognition` / `CustomAction` into two independent processes. For example, the body runs in a common GUI written in C#, and at the same time runs your own Custom logic in Python code, breaking the language barrier. ## General terms diff --git "a/docs/zh_cn/1.1-\345\277\253\351\200\237\345\274\200\345\247\213.md" "b/docs/zh_cn/1.1-\345\277\253\351\200\237\345\274\200\345\247\213.md" index a248f05ed..dbbdef0d3 100644 --- "a/docs/zh_cn/1.1-\345\277\253\351\200\237\345\274\200\345\247\213.md" +++ "b/docs/zh_cn/1.1-\345\277\253\351\200\237\345\274\200\345\247\213.md" @@ -6,7 +6,7 @@ MaaFramework 支持完全通过 Json 低代码编程（Pipeline Json），同时 亦可将两者结合，将低代码作为一种 “封装” 进行调用。 下面介绍几种常用的集成方式： -### 完全依赖 Json 低代码编程（使用 MaaPiCli.exe） +### 纯 Json 低代码编程（使用通用 UI） 简单快捷，但不够灵活，推荐 MaaFramework 初学者及编程小白使用。 我们为此方式提供了 [🎞️视频教程](https://www.bilibili.com/video/BV1yr421E7MW) 和 [⭐项目模板](https://github.com/MaaXYZ/MaaPracticeBoilerplate)。以下是一个例子： @@ -32,10 +32,10 @@ MaaFramework 支持完全通过 Json 低代码编程（Pipeline Json），同时 ### 使用 Json 低代码编程，但对复杂任务使用自定义逻辑 -**💡 MaaFW 4.x 版本亮点功能** +**💡 MaaFW v4.x 版本亮点功能** -使用通用 GUI 或 CLI 运行 MaaFW 本体，同时在子进程（AgentServer）中注册自定义任务。 -该方法可从 1 中无缝切换，以下是一个例子： +在上述纯 Json 低代码编程的基础上，在子进程（AgentServer）中注册自定义任务。 +该方法可从纯 Json 低代码上无缝切换，并同样适用[⭐项目模板](https://github.com/MaaXYZ/MaaPracticeBoilerplate)，以下是一个例子： ```jsonc { @@ -92,7 +92,9 @@ class MyAction(CustomAction): ### 自行编写代码 -可以将低代码作为一种“封装”进行调用，亦可注册自定义回调使用 +可以将低代码作为一种“封装”进行调用，亦可注册自定义回调使用。 + +该方式不适用项目模板，需要您自行准备资源文件~ ```python # 此处为伪代码，仅供参考思路，无法直接运行 @@ -155,9 +157,7 @@ my_resource `my_resource/image` 中的文件，主要为 pipeline 所用到的模板匹配图片、特征检测图片等，会按照 pipeline 中设定的 `template` 等字段读取对应的文件。 -所使用的图片需要是无损原图缩放到 720p 后的裁剪。若使用安卓模拟器，请使用模拟器自带的截图功能！（不可以直接对模拟器窗口进行截图） - -**除非你完全清楚 MaaFramework 在做什么，否则请使用下面的截图工具来获取图片。** +所使用的图片需要是无损原图缩放到 720p 后的裁剪。**除非你完全清楚 MaaFramework 在做什么，否则请使用下面的截图工具来获取图片。** - [VSCode 插件](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support) - [MFA 小工具](https://github.com/SweetSmellFox/MFATools) @@ -189,7 +189,7 @@ my_resource ## 运行 -使用 通用 CLI（MaaPiCli）、第三方通用 GUI（例如 MFAWPF 等）或者 自行编写集成代码 +使用 通用 UI（如 MaaPiCli, MFA, MFW 等）或者 自行编写集成代码 ### 使用 MaaPiCli diff --git "a/docs/zh_cn/1.2-\346\234\257\350\257\255\350\247\243\351\207\212.md" "b/docs/zh_cn/1.2-\346\234\257\350\257\255\350\247\243\351\207\212.md" index fa31ee9ff..8e8f450d1 100644 --- "a/docs/zh_cn/1.2-\346\234\257\350\257\255\350\247\243\351\207\212.md" +++ "b/docs/zh_cn/1.2-\346\234\257\350\257\255\350\247\243\351\207\212.md" @@ -32,7 +32,7 @@ - **Agent** | **执行代理** - MaaFW 4.x 版本亮点功能，可将 MaaFW 本体与 `CustomRecognition` / `CustomAction` 分离至独立的两个进程中。 + 💡 MaaFW v4.x 版本亮点功能。可将 MaaFW 本体与 `CustomRecognition` / `CustomAction` 分离至独立的两个进程中。 例如本体运行在 C# 编写的通用 GUI 中，同时在 Python 代码中运行编写自己的 Custom 逻辑，打破语言壁垒。 ## 通用术语