Skip to content

Commit

Permalink
docs: 更新文档关于插件等介绍
Browse files Browse the repository at this point in the history
  • Loading branch information
MistEO committed Jan 9, 2025
1 parent d529f4d commit eaf6a60
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 19 deletions.
12 changes: 3 additions & 9 deletions docs/en_us/1.1-QuickStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,8 @@ If needed, you can also fine-tune the official pre-trained models of PaddleOCR y

## Debug

There are currently two ways: [MaaDebugger](https://github.com/MaaXYZ/MaaDebugger) and [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support).

### MaaDebugger

- Use [MaaDebugger](https://github.com/MaaXYZ/MaaDebugger).
- Use [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support).
- If you use MaaPiCli, the `config/maa_option.json` file will be generated in the same directory, including:

- `logging`: Save the log and generate `debug/maa.log`. Default true.
Expand All @@ -176,13 +174,9 @@ There are currently two ways: [MaaDebugger](https://github.com/MaaXYZ/MaaDebugge

- If you integrate it yourself, you can enable debugging options through the `Toolkit.init_option` / `MaaToolkitConfigInitOption` interface. The generated json file is the same as above.

### VSCode Plugin

Compared to MaaDebugger, which focuses on debugging, the current VSCode plugin also has many functions such as screenshots and code completion. The specific content can be explored through the [official website](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support) and actual experience.

## Run

You can integrate MaaFramework using MaaPiCli (Generic CLI) or by writing integration code yourself.
You can integrate MaaFramework using Generic CLI (MaaPiCli), third-party Generic GUI (MFAWPF, etc) or by writing integration code yourself.

### Using MaaPiCli

Expand Down
14 changes: 4 additions & 10 deletions docs/zh_cn/1.1-快速开始.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,11 +162,9 @@ my_resource

## 调试

目前有两种方式:[MaaDebugger](https://github.com/MaaXYZ/MaaDebugger) 以及 [VSCode 插件](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support)

### MaaDebugger

- 若使用 MaaPiCli ,会在同目录下生成 `config/maa_option.json` 文件,其中:
- 使用 [MaaDebugger](https://github.com/MaaXYZ/MaaDebugger)
- 使用 [VSCode 插件](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support)
- 使用 MaaPiCli ,会在同目录下生成 `config/maa_option.json` 文件,其中:

- `logging`: 保存日志,会生成 `debug/maa.log`。默认 true 。
- `recording`: 保存录像功能,会保存运行期间所有的截图及操作数据,可使用 `DbgController` 进行复现调试。默认 false 。
Expand All @@ -176,13 +174,9 @@ my_resource

- 若自行集成,可通过 `Toolkit.init_option` / `MaaToolkitConfigInitOption` 接口开启调试选项。生成的 json 文件同上。

### VSCode 插件

相比专注于调试的 MaaDebugger,目前 VSCode 插件还有截图、代码补全等多种功能,具体内容可通过 [官网](https://marketplace.visualstudio.com/items?itemName=nekosu.maa-support) 和实际体验探索。

## 运行

使用 MaaPiCli(通用 CLI)或者 自行编写集成代码
使用 通用 CLI(MaaPiCli)、第三方通用 GUI(例如 MFAWPF 等)或者 自行编写集成代码

### 使用 MaaPiCli

Expand Down

0 comments on commit eaf6a60

Please sign in to comment.