Update docs

2025-03-13 06:30:13 +08:00 · 2021-01-12 17:58:13 +08:00 · 2021-01-12 17:58:13 +08:00 · 8ebbbe2a69
commit 8ebbbe2a69
parent c0531acab7
4 changed files with 109 additions and 26 deletions
--- a/README.md
+++ b/README.md
@ -22,6 +22,8 @@ Mirai 是一个在全平台下运行，提供 QQ 协议支持的高效率机器

 ## 使用

+- **[启动 Console](docs/Run.md)**
+
 ### 安装 JAR 插件

 将 `jar` 文件放入 `plugins` 并重启 Mirai Console 即可。
@ -30,31 +32,13 @@ Mirai 是一个在全平台下运行，提供 QQ 协议支持的高效率机器

 在控制台输入 `?` 查看可用指令列表。

+### 内置指令
+
+[BuiltInCommands](docs/BuiltInCommands.md#mirai-console---builtin-commands)
+
 ## 开发

-**Mirai Console 基于 [Mirai](https://github.com/mamoe/mirai)，因此请先阅读 [Mirai 文档](https://github.com/mamoe/mirai/tree/dev/docs)。**
-
- **[配置项目](docs/ConfiguringProjects.md)**
- **[启动 Console](docs/Run.md)**
-
-### 后端插件开发基础
-
- 插件 - [Plugin 模块](docs/Plugins.md)
- 指令 - [Command 模块](docs/Commands.md)
- 存储 - [PluginData 模块](docs/PluginData.md)
- 权限 - [Permission 模块](docs/Permissions.md)
-
-
-**示例插件**：
- [mirai-console-example-plugin (Kotlin DSL)](https://github.com/Him188/mirai-console-example-plugin)
- [mirai-console-example-plugin (Groovy DSL)](https://github.com/Karlatemp/mirai-console-example-plugin)
-
-### 后端插件开发进阶
-
- 扩展 - [Extension 模块和扩展点](docs/Extensions.md)
-
-### 实现前端
- [FrontEnd](docs/FrontEnd.md)
+[开发文档](docs/README.md#mirai-console)

 ## 实用链接

--- a/backend/mirai-console/src/command/BuiltInCommands.kt
+++ b/backend/mirai-console/src/command/BuiltInCommands.kt
@ -66,6 +66,8 @@ internal interface BuiltInCommandInternal : Command, BuiltInCommand

 /**
 * 内建指令列表
+ *
+ * [查看文档](https://github.com/mamoe/mirai-console/docs/BuiltInCommands.md)
 */
@Suppress("unused")
 public object BuiltInCommands {
@ -199,7 +201,7 @@ public object BuiltInCommands {
            sendMessage("OK")
        }

-        @Description("取消授权一个权限")
+        @Description("撤销一个权限")
        @SubCommand("cancel", "deny", "remove")
        public suspend fun CommandSender.cancel(
            @Name("被许可人 ID") target: PermitteeId,
@ -209,7 +211,7 @@ public object BuiltInCommands {
            sendMessage("OK")
        }

-        @Description("取消授权一个权限及其所有子权限")
+        @Description("撤销一个权限及其所有子权限")
        @SubCommand("cancelAll", "denyAll", "removeAll")
        public suspend fun CommandSender.cancelAll(
            @Name("被许可人 ID") target: PermitteeId,
@ -241,7 +243,7 @@ public object BuiltInCommands {
        @Description("查看所有权限列表")
        @SubCommand("listPermissions", "lp")
        public suspend fun CommandSender.listPermissions() {
-            sendMessage(PermissionService.INSTANCE.getRegisteredPermissions().joinToString("\n") { it.id.toString() })
+            sendMessage(PermissionService.INSTANCE.getRegisteredPermissions().joinToString("\n") { it.id.toString() + "    " + it.description })
        }
    }

--- a/docs/BuiltInCommands.md
+++ b/docs/BuiltInCommands.md
@ -0,0 +1,73 @@
+# Mirai Console - BuiltIn Commands
+
+Mirai Console 内置一些指令。
+
+下文中 `<A|B>` 表示可以是 A 或 B。`[ ]` 表示一个必须的参数, `[ ]?` 表示一个可选的参数。
+
+## HelpCommand
+
+`/help`
+
+查看指令帮助
+
+## StopCommand
+
+`/<stop|shutdown|exit>`
+
+关闭 Mirai Console
+
+## LoginCommand
+
+`/<login|登录> [qq] [password]`
+
+临时登录一个账号
+
+## PermissionCommand
+
+主指令: `/<permission|perm|权限>`
+
+次指令:
+
+| 指令                                                                                     | 描述                   |
+|:----------------------------------------------------------------------------------------|:----------------------|
+| `/<permission|perm|权限> <permit|grant|add> [target] [permission]`                       | 授权一个权限            |
+| `/<permission|perm|权限> <cancel|deny|remove> [target] [permission]`                     | 撤销一个权限            |
+| `/<permission|perm|权限> <cancelAll|denyAll|removeAll> [target] [permission]`            | 撤销一个权限及其所有子权限 |
+| `/<permission|perm|权限> <permittedPermissions|pp|grantedPermissions|gp> [target] [all]` | 查看被授权权限列表       |
+| `/<permission|perm|权限> <listPermissions|lp>`                                           | 查看所有权限列表         |
+
+### `[target]` 和 `[permission]` 示例
+
+`[target]` 是 [*被许可人 ID*](Permissions.md#被许可人-id)，可以查看[表示方法](Permissions.md#字符串表示) 。
+
+`[permission]` 是 [*权限 ID*](Permissions.md#权限-id)。每个指令都拥有一个权限 ID。请使用 `/perm list` 查看权限 ID 列表。
+
+示例：`/perm permit u123456 console:command.stop`
+
+## AutoLoginCommand
+
+主指令: `/autoLogin`
+
+次指令:
+
+| 指令                                                           | 描述                 |
+|:--------------------------------------------------------------|:---------------------|
+| `/<autoLogin|自动登录> list`                                    | 查看自动登录账号列表    |
+| `/<autoLogin|自动登录> add [account] [password] [passwordKind]` | 添加自动登录           |
+| `/<autoLogin|自动登录> clear`                                   | 清除所有配置           |
+| `/<autoLogin|自动登录> remove [account]`                        | 删除一个账号           |
+| `/<autoLogin|自动登录> setConfig [account] [configKey] [value]` | 设置一个账号的一个配置项 |
+| `/<autoLogin|自动登录> removeConfig [account] [configKey]`      | 删除一个账号的一个配置项 |
+
+
+| `configKey` |                       可选值                       |
+|:-----------:|:-------------------------------------------------:|
+| `protocol`  | `ANDROID_PHONE` / `ANDROID_PAD` / `ANDROID_WATCH` |
+
+示例：`/autoLogin setConfig 123456 protocol ANDROID_PHONE`
+
+## StatusCommand
+
+`/status`
+
+获取 Mirai Console 运行状态
--- a/docs/README.md
+++ b/docs/README.md
@ -1,3 +1,27 @@
 # Mirai Console

 欢迎来到 mirai-console 开发文档!
+
+**Mirai Console 基于 [Mirai](https://github.com/mamoe/mirai)，因此请先阅读 [Mirai 文档](https://github.com/mamoe/mirai/tree/dev/docs)。**
+
+- **[配置项目](ConfiguringProjects.md)**
+- **[启动 Console](Run.md)**
+
+### 后端插件开发基础
+
+- 插件 - [Plugin 模块](Plugins.md)
+- 指令 - [Command 模块](Commands.md)
+- 存储 - [PluginData 模块](PluginData.md)
+- 权限 - [Permission 模块](Permissions.md)
+
+
+**示例插件**：
+- [mirai-console-example-plugin (Kotlin DSL)](https://github.com/Him188/mirai-console-example-plugin)
+- [mirai-console-example-plugin (Groovy DSL)](https://github.com/Karlatemp/mirai-console-example-plugin)
+
+### 后端插件开发进阶
+
+- 扩展 - [Extension 模块和扩展点](Extensions.md)
+
+### 实现前端
+- [FrontEnd](FrontEnd.md)