Skip to content

Commit 069a5c9

Browse files
committed
docs: 更新文档
1 parent ee62bfd commit 069a5c9

File tree

2 files changed

+24
-48
lines changed

2 files changed

+24
-48
lines changed

docs/en_us/1.1-QuickStarted.md

+12-24
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
1. Download the MaaFramework Release
44
2. Prepare Resource Files
5-
3. Use a Generic GUI or Write Integration Code
5+
3. Use a Generic CLI or Write Integration Code
66

77
## Download the MaaFramework Release
88

@@ -22,10 +22,9 @@ my_resource
2222
│ ├── det.onnx
2323
│ ├── keys.txt
2424
│ └── rec.onnx
25-
├── pipeline
26-
│ ├── my_pipeline_1.json
27-
│ └── my_pipeline_2.json
28-
└── properties.json
25+
└── pipeline
26+
├── my_pipeline_1.json
27+
└── my_pipeline_2.json
2928
```
3029

3130
You can modify the names of files and folders starting with "my_", but the others have fixed file names and should not be changed. Here's a breakdown:
@@ -39,7 +38,7 @@ You can refer to the [Task Pipeline Protocol](3.1-PipelineProtocol.md) for writi
3938
Tools:
4039

4140
- [JSON Schema](https://github.com/MaaAssistantArknights/MaaFramework/blob/main/tools/pipeline.schema.json)
42-
- [Graphical Editor](https://github.com/MaaAssistantArknights/MaaJsonViewer)
41+
- [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support)
4342

4443
### Image Files
4544

@@ -57,31 +56,20 @@ You can use our pre-converted files: [MaaCommonAssets](https://github.com/MaaAss
5756

5857
If needed, you can also fine-tune the official pre-trained models of PaddleOCR yourself (please refer to the official PaddleOCR documentation) and convert them to ONNX files for use. You can find conversion commands [here](https://github.com/MaaAssistantArknights/MaaCommonAssets/tree/main/OCR#command).
5958

60-
### Directory Property File
59+
## Run
6160

62-
`properties.json` can be used to set properties for the current directory. A typical JSON structure is as follows:
61+
You can integrate MaaFramework using MaaPiCli (Generic CLI) or by writing integration code yourself.
6362

64-
_Please note that JSON does not support comments, and the following is for demonstration purposes only. Do not copy and use directly._
63+
### Using MaaPiCli
6564

66-
```jsonc
67-
{
68-
"is_base": true, // Whether it is a base resource
69-
// If true, when reading resources in this directory, all previously read content will be cleared.
70-
}
71-
```
72-
73-
## Integration
74-
75-
You can integrate MaaFramework using MaaY (Generic GUI) or by writing integration code yourself.
76-
77-
### Using MaaY
65+
Use MaaPiCli in the `bin` folder of the Release package, and write `interface.json` and place it in the same directory to use it.
7866

79-
Use [MaaY](https://github.com/MaaAssistantArknights/MaaY). Refer to the corresponding documentation in MaaY to organize the `.maay` folder and directly import and use it in the GUI.
67+
The Cli has completed basic function development, and more functions are being continuously improved! Detailed documentation needs to be further improved. Currently, you can refer to sample to write it.
8068

8169
Examples:
8270

83-
- [M9A.maay](https://github.com/MaaAssistantArknights/M9A/tree/main/assets/.maay)
84-
- [MAS.maay](https://github.com/MaaAssistantArknights/MaaAssistantSkland/tree/main/.maay)
71+
- [Sample](https://github.com/MaaAssistantArknights/MaaFramework/blob/main/sample/interface.json)
72+
- [M9A](https://github.com/MaaAssistantArknights/M9A/tree/main/assets/interface.json)
8573

8674
### Writing Integration Code Yourself
8775

docs/zh_cn/1.1-快速开始.md

+12-24
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
1. 下载 MaaFramework 发行版
44
2. 准备资源文件
5-
3. 使用通用 GUI / 自行编写集成代码
5+
3. 使用通用 CLI / 自行编写集成代码
66

77
## 下载 MaaFramework 发行版
88

@@ -22,10 +22,9 @@ my_resource
2222
│ ├── det.onnx
2323
│ ├── keys.txt
2424
│ └── rec.onnx
25-
├── pipeline
26-
│ ├── my_pipeline_1.json
27-
│ └── my_pipeline_2.json
28-
└── properties.json
25+
└── pipeline
26+
├── my_pipeline_1.json
27+
└── my_pipeline_2.json
2928
```
3029

3130
其中以 `my_` 开头的文件/文件夹均可自行修改名称,其他的则为固定文件名,不可修改,下面依次介绍:
@@ -39,7 +38,7 @@ my_resource
3938
小工具:
4039

4140
- [JSON Schema](https://github.com/MaaAssistantArknights/MaaFramework/blob/main/tools/pipeline.schema.json)
42-
- [图形化编辑器](https://github.com/MaaAssistantArknights/MaaJsonViewer)
41+
- [VSCode 插件](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support)
4342

4443
### 图片文件
4544

@@ -57,31 +56,20 @@ my_resource
5756

5857
若有需要也可以自行对 PaddleOCR 的官方预训练模型进行 fine-tuning (请自行参考 [PaddleOCR](https://github.com/PaddlePaddle/PaddleOCR) 官方文档),并转换成 ONNX 文件使用,转换命令可参考 [这里](https://github.com/MaaAssistantArknights/MaaCommonAssets/tree/main/OCR#command)
5958

60-
### 目录属性文件
59+
## 运行
6160

62-
`properties.json` 可用于设置部分当前目录下的属性,典型 JSON 结构如下:
61+
使用 MaaPiCli(通用 CLI)或者 自行编写集成代码
6362

64-
_请注意,JSON 不支持注释,以下仅为演示,请勿直接复制使用。_
63+
### 使用 MaaPiCli
6564

66-
```jsonc
67-
{
68-
"is_base": true, // 是否是基准资源
69-
// 若为 true,在读取本目录下的资源时,会清除之前读取的所有内容
70-
}
71-
```
72-
73-
## 集成
74-
75-
使用 MaaY(通用 GUI)或者 自行编写集成代码
76-
77-
### 使用 MaaY
65+
使用 Release 包 bin 文件夹中的 MaaPiCli,并编写 `interface.json` 置于同目录下,即可使用
7866

79-
使用 [MaaY](https://github.com/MaaAssistantArknights/MaaY),参考 MaaY 中对应的文档整理 `.maay` 文件夹,并在 GUI 中直接导入使用。
67+
该 Cli 已完成基本功能开发,更多功能不断完善中!详细文档待进一步完善,当前可参考 sample 编写
8068

8169
实践:
8270

83-
- [M9A.maay](https://github.com/MaaAssistantArknights/M9A/tree/main/assets/.maay)
84-
- [MAS.maay](https://github.com/MaaAssistantArknights/MaaAssistantSkland/tree/main/.maay)
71+
- [Sample](https://github.com/MaaAssistantArknights/MaaFramework/blob/main/sample/interface.json)
72+
- [M9A](https://github.com/MaaAssistantArknights/M9A/tree/main/assets/interface.json)
8573

8674
### 自行编写集成代码
8775

0 commit comments

Comments
 (0)