用户手册

详细用法说明

通常来说，在安装本插件以后，以及安装了任意一个需要接入本插件的帮助功能的新插件后都需要执行如下命令

/h-help loadDefaults

执行本指令成功后

• 对于用户自定义配置中不存在的插件配置，本插件将会将该插件的默认配置插入至用户自定义配置中。
• 对于已经存在的插件配置，本插件不会覆盖已有的配置，但是会对比自定义配置与默认配置的等价性，当两个配置不同时，触发该指令的 Bot 和 Console 都会对用户做出提示。若有需要，你可以检查 data/io.github.argonariod.hammer-help/defaults/<对应插件的ID>.json 中与 custom.yml 中对应的字段，修改自己的自定义配置。

---

当你修改了配置文件说明中的任何一个配置后，若想在不重启 Mirai Console 的情况下应用配置更改，需要执行如下命令

/h-help reload

---

当你想要将任何一个插件的自定义配置重置为默认配置时，执行如下命令

/h-help resetToDefault <插件ID>

注意： 你原本的配置将会被不可挽回地覆盖，执行本命令前请三思！

---

对于一般的 Bot 用户来说

• 使用 <帮助指令前缀> 指令可以看到本插件的指令用法。
• 使用 <帮助指令前缀> list 指令可以看到所有该用户能够查看帮助信息的插件的列表，其中包括插件的名称、ID、别名和简介。
• 使用 <帮助指令前缀> <插件名/插件别名/插件ID> 指令可以看到指定插件的详细帮助信息。

只需要了解以上的三条指令即可。

关于 <帮助指令前缀> 的概念，请查看下文中的 本插件配置 config.yml 和 用户指令

配置文件说明

本插件的配置文件都存储在 Mirai Console 的 Plugin Config Storage 文件夹中，通常情况下路径为 config/io.github.argonariod.hammer-help/ 。

关于配置文件的详细信息请参考配置文件中的注释。

本插件配置 config.yml

字段名	值类型	说明
helpCommandName	字符串	本插件帮助指令的前缀名，支持正则表达式
enablePrivateMessages	布尔值	是否允许私聊请求帮助信息

自定义帮助信息配置 custom.yml

关于配置文件的详细信息请参考配置文件中的注释。

当 usage 为多行文本时，建议考虑使用 YAML 提供的文本块特性。

字段名	值类型	说明
plugins	Map	插件列表
> key	字符串	插件ID
> value	插件帮助信息	请注意，本文中所有的 插件帮助信息 都是指下面的所有信息
>> enable	布尔值	该插件的帮助信息是否启用
>> names	列表<字符串>	该插件的名称及别名，其中该列表中的第一个值为该插件的名字
>> brief	字符串	该插件的简介，会显示在插件帮助列表中
>> displayPermission	字符串或null	显示该插件的帮助信息所需的权限，当其为null时，代表不需要权限
>> usage	字符串	该插件的详细帮助信息

指令列表

管理命令

在以下的指令中，hammer-help 为本插件的主指令前缀，与 h-help 等价，在本文中将通篇使用较短的 h-help 作为主指令前缀。

指令名	说明	备注
/h-help reload	重新加载 Hammer Mirai Help 插件的配置
/h-help loadDefaults	令Hammer Help插件加载所有插件的默认帮助信息	不会改变已经存在的自定义配置
/h-help resetToDefault <插件ID>	将指定插件的自定义配置的帮助信息置为默认帮助信息

用户指令

在以下的指令中，<帮助指令前缀> 为 config.yml 文件（即本插件的配置文件）中配置的 helpCommandName 所配置的字段。

指令名	说明	备注
<帮助指令前缀>	查看本插件的帮助信息
<帮助指令前缀> list	查看所有调用者能够查看帮助信息的插件的列表	能够查看指已启用插件，且权限满足
<帮助指令前缀> <插件名>	查看插件 <插件名> 的帮助信息	插件名、插件别名、插件ID都可以作为 <插件名>