modify some documents

ArgonarioD · Mar 6, 2023 · 26ef7cf · 26ef7cf
1 parent b62687a
commit 26ef7cf
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/...er-mirai-help-plugin/src/main/kotlin/io/github/argonariod/hammer/mirai/help/HammerHelp.kt b/...er-mirai-help-plugin/src/main/kotlin/io/github/argonariod/hammer/mirai/help/HammerHelp.kt
@@ -15,19 +15,19 @@ import net.mamoe.mirai.event.globalEventChannel
 object HammerHelp : KotlinPlugin(
     JvmPluginDescription(
         id = "io.github.argonariod.hammer-help",
-        name = "Hammer Help",
+        name = "Hammer Mirai Help",
         version = "1.0.0",
     ) {
         author("ArgonarioD")
-        info("""帮助Bot主组织各插件的帮助信息""")
+        info("""用以组织 Mirai Console 装载的插件们的帮助信息的 Mirai Console 插件""")
     }
 ) {
     @OptIn(ConsoleExperimentalApi::class)
     override fun onEnable() {
         help {
             names.addAll("hammer-help", "h-help")
             usage = """
-                |欢迎使用Hammer Help插件！
+                |欢迎使用Hammer Mirai Help插件！
                 |下文中的帮助指令前缀就是你呼出本帮助信息的指令前缀，如：你的帮助指令前缀为"help"时，你可以通过发送"help"来呼出本帮助信息。
                 |<帮助指令前缀> - 查看本帮助信息
                 |<帮助指令前缀> list - 查看所有你能够查看帮助信息的插件的列表
@@ -36,7 +36,7 @@ object HammerHelp : KotlinPlugin(
                 |在以下指令中，/hammer-help可以替换为/h-help
                 |/hammer-help reload - 重新加载Hammer Help的配置
                 |/hammer-help loadDefaults - 令Hammer Help插件加载所有插件的默认帮助信息（不会改变已经存在的自定义配置）
-                |/hammer-help resetToDefault - 将指定插件的自定义配置的帮助信息置为默认帮助信息
+                |/hammer-help resetToDefault <插件ID> - 将指定插件的自定义配置的帮助信息置为默认帮助信息
             """.trimMargin()
         }
 

diff --git a/...c/main/kotlin/io/github/argonariod/hammer/mirai/help/config/CustomHelpInfoPluginConfig.kt b/...c/main/kotlin/io/github/argonariod/hammer/mirai/help/config/CustomHelpInfoPluginConfig.kt
@@ -17,7 +17,7 @@ object CustomHelpInfoPluginConfig : AutoSavePluginConfig("custom-helps") {
         """
         自定义帮助信息，
         enable是该插件的帮助信息是否启用，当其为false时，该插件不会出现在帮助列表中，也不会响应对于该插件的详细帮助查询。
-        names是该插件的名称及别名，该项的值是一个字符串列表。
+        names是该插件的名称及别名，该项的值是一个字符串列表，其中第一个值是插件的名称，第二个开始的值是插件的别名。
         brief是该插件的简介，会显示在插件帮助列表中。
         displayPermissionId是显示该插件的帮助信息所需的权限，当其为null时，代表不需要权限。
         usage是该插件的帮助信息。

diff --git a/...n/src/main/kotlin/io/github/argonariod/hammer/mirai/help/config/HammerHelpPluginConfig.kt b/...n/src/main/kotlin/io/github/argonariod/hammer/mirai/help/config/HammerHelpPluginConfig.kt
@@ -11,7 +11,7 @@ object HammerHelpPluginConfig : ReadOnlyPluginConfig("config") {
         如：本项配置为"help"时：
             Bot接收到"help"的消息时，将会发送本插件的总览帮助信息
             Bot接收到"help list"的消息时，将会发送所有该发送者能够查看帮助信息的插件的列表
-            Bot接收到"help xxx"的消息时，将会发送插件xxx的帮助信息
+            Bot接收到"help xxx"的消息时，将会发送插件xxx的帮助信息，其中xxx可以是插件的ID、插件的名称、插件的别名
         """
     )
     val helpCommandName: String by value("help")