fz-mirrors/MaaAssistantArknights
0
0
Fork 0
mirror of https://github.com/MaaAssistantArknights/MaaAssistantArknights.git synced 2026-07-20 10:57:45 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix install dir and less line break

Browse Source
This commit is contained in:
Long Wang
2023-09-01 13:47:26 +08:00
parent d8d0cb27f7
commit dc223db368
1 changed files with 12 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
docs/1.6-CLI使用指南.md
View File

@@ -11,20 +11,17 @@
### Linux
对于最新版本的 MAA，CLI 已经打包在 MAA 压缩包中，如果你下载了最新版 MAA，解压后就可以使用 CLI，无需额外安装。
**注意**: 请不要将库文件和资源文件随便移动到其他位置，否则CLI将无法找到它们。
如果你想将它们移动到其他位置，你可以通过以下命令：
对于最新版本的 MAA，CLI 已经打包在 MAA 压缩包中，如果你下载了最新版 MAA，解压后就可以使用 CLI，无需额外安装。 **注意**: 请不要将库文件和资源文件随便移动到其他位置，否则CLI将无法找到它们。 如果你想将它们移动到其他位置，你可以通过以下命令：
```bash
# 请确保你当前的工作目录是解压后的MAA目录
lib_dir="$(./maa dir lib)"
resource_dir="$(./maa dir resource)"
lib_dir="$(./maa dir data)/lib"
resource_dir="$(./maa dir data)/resource"
mv lib* "$lib_dir"
mv resource "$resource_dir"
```
如果你当前使用的是旧版本的MAA或者希望单独安装CLI，你可以前往[CLI Release页面](https://github.com/MaaAssistantArknights/maa-cli/releases/latest)
根据你的架构下载对应的预编译的LCI二进制文件（对于x86_64架构，你可以下载以 `x86_64-unknown-linux-gnu.tar.gz` 结尾的文件，对于aarch64架构，你可以下载以 `aarch64-unknown-linux-gnu.tar.gz` 结尾的文件），解压后将 `maa` 文件移动到你任何在 `PATH` 环境变量中的目录下, 然后使用 `maa install` 命令安装MAA共享库和资源。
如果你当前使用的是旧版本的MAA或者希望单独安装CLI，你可以前往[CLI Release页面](https://github.com/MaaAssistantArknights/maa-cli/releases/latest) 根据你的架构下载对应的预编译的LCI二进制文件（对于x86_64架构，你可以下载以 `x86_64-unknown-linux-gnu.tar.gz` 结尾的文件，对于aarch64架构，你可以下载以 `aarch64-unknown-linux-gnu.tar.gz` 结尾的文件），解压后将 `maa` 文件移动到你任何在 `PATH` 环境变量中的目录下, 然后使用 `maa install` 命令安装MAA共享库和资源。
### macOS
@@ -38,14 +35,11 @@ CLI目前尚不支持Windows。
### 配置目录
你的配置文件（选项，任务等）位于配置目录中，你可以通过 `maa dir config` 获取配置目录，并通过 `mkdir -p "$(maa dir config)"` 创建它。
在以下的介绍中，配置目录的将被称为 `$MAA_CONFIG_DIR`。
此外尽管所有的例子都是针对 TOML 格式的，但是以下所有配置文件的格式可以是 TOML，JSON 或 YAML。
你的配置文件（选项，任务等）位于配置目录中，你可以通过 `maa dir config` 获取配置目录，并通过 `mkdir -p "$(maa dir config)"` 创建它。在以下的介绍中，配置目录的将被称为 `$MAA_CONFIG_DIR`。此外尽管所有的例子都是针对 TOML 格式的，但是以下所有配置文件的格式可以是 TOML，JSON 或 YAML。
### MAA选项
针对MAA本身的选项，你可以在 `$MAA_CONFIG_DIR/asst.toml` 中进行配置。
这里的选项包括三个部分：
针对MAA本身的选项，你可以在 `$MAA_CONFIG_DIR/asst.toml` 中进行配置。 这里的选项包括三个部分：
- `connection`：MAA连接设置；
- `instance_options`：MAA实例选项；
@@ -67,8 +61,7 @@ device = "emulator-5554" # 你的android设备的序列号
config = "General" # maa connect的配置名称，可选，不建议修改
```
设备的序列号可以是地址加端口号，也可以是非地址的任意字符串，可以通过 `adb devices` 命令获取。
更多信息参见模拟器支持文档。
设备的序列号可以是地址加端口号，也可以是非地址的任意字符串，可以通过 `adb devices` 命令获取。更多信息参见模拟器支持文档。
##### PlayTools 连接
@@ -109,8 +102,7 @@ resources = ["platform_diff/iOS", "global/YoStarEN"]
### 定义任务
任务文件位于 `$MAA_CONFIG_DIR/tasks` 目录下。
每一个任务文件都是一个任务列表，每一个子任务是一个 MAA 任务，其中包含任务类型和参数，可用的任务及其参数参见[集成文档](https://maa.plus/docs/3.1-集成文档.html#asstappendtask)。
任务文件位于 `$MAA_CONFIG_DIR/tasks` 目录下。 每一个任务文件都是一个任务列表，每一个子任务是一个 MAA 任务，其中包含任务类型和参数，可用的任务及其参数参见[集成文档](https://maa.plus/docs/3.1-集成文档.html#asstappendtask)。
一个简单的任务文件示例：
@@ -205,14 +197,11 @@ condition = { type = "Time", start = "18:00:00" }
### 运行任务
当你定义了任务后，你可以通过 `maa run <task>` 命令运行任务，所有可用的任务可以通过 `maa list` 命令列出。
更多其他可用命令参见 `maa --help`。
当你定义了任务后，你可以通过 `maa run <task>` 命令运行任务，所有可用的任务可以通过 `maa list` 命令列出。 更多其他可用命令参见 `maa --help`。
#### 日志级别
当运行任务时，CLI 会处理 MAA 的消息。但是不是所有的消息都会输出。
日志级别用于控制哪些消息会被输出。
当前有6个日志级别：
当运行任务时，CLI 会处理 MAA 的消息。但是不是所有的消息都会输出。日志级别用于控制哪些消息会被输出。当前有6个日志级别：
- Error：出现错误，MAA将会停止运行或者无法正常工作；
- Warning：出现错误，但是MAA仍然可以正常工作；
@@ -221,9 +210,6 @@ condition = { type = "Time", start = "18:00:00" }
- Debug：关于你的配置的详细信息，例如将要运行任务的类型和参数；
- Trace：任何没有被CLI正确解析的MAA消息。
默认的日志级别是 `Normal`，你可以通过 `-v` 和 `-q` 选项来控制日志级别：
`-v`将会提高日志级别以显更多消息，`-q` 将会减少日志级别以显示更少的消息，重复使用 `-v` 和 `-q` 将会提高或降低日志级别，直到达到最高或最低级别。
比如，`-vv` 将会显示 `Debug` 级别及以上的消息，而 `-qq` 将会显示 `Warning` 级别及以下的消息。
默认的日志级别是 `Normal`，你可以通过 `-v` 和 `-q` 选项来控制日志级别：`-v`将会提高日志级别以显更多消息，`-q` 将会减少日志级别以显示更少的消息，重复使用 `-v` 和 `-q` 将会提高或降低日志级别，直到达到最高或最低级别。比如，`-vv` 将会显示 `Debug` 级别及以上的消息，而 `-qq` 将会显示 `Warning` 级别及以下的消息。
对于一般使用，建议使用 `maa run -v <task>`，这样你可以看到 MAA 的所有有用的消息。
当你在调试配置时，你可以使用 `maa run -vv <task>` 来看到更多的调试信息。
对于一般使用，建议使用 `maa run -v <task>`，这样你可以看到 MAA 的所有有用的消息。 当你在调试配置时，你可以使用 `maa run -vv <task>` 来看到更多的调试信息。