更好 /help

更好 /help

将/help替换为更清晰、可交互、分页的列表。为命令和参数添加描述,以及来自其他模组的可选元数据。

管理

Better /help Header

一个 Minecraft 模组,将 /help 替换为更清晰、可交互、分页的列表。
为命令和参数添加描述,并支持来自其他模组的可选元数据。

documentation github modrinth curseforge kofi

✨ 特性

原版 /help 会向你抛出一大堆难以阅读的文字,几乎没有任何有用的细节。Better /help 将其替换为玩家真正可用的内容。

  • 清晰的分页命令列表:逐页浏览命令,而不是在一大堆文字中滚动

  • 可交互输出:悬停查看详情,点击翻页导航

  • 命令和参数描述:覆盖了大多数原版命令,参数也可以拥有自己的描述

  • 易于集成:其他模组只需使用其语言文件即可添加描述和元数据(如主页链接)

  • 归属信息:当描述来自其他模组时,玩家可以看到该命令来自哪个模组

  • 补全建议:/help <command...> 的自动补全与直接输入该命令时一致,不同于原版 /help

⌨️ 用法

命令 作用
/help 显示分页命令列表
/help <command...> 显示某个命令或参数的帮助

示例:

/help
/help gamemode
/help advancement grant @s everything

💻 面向模组开发者

你可以通过语言文件(例如 assets/<mod_id>/lang/en_us.json)添加描述和其他元数据。 Better /help 会在服务器启动时扫描已安装的模组以查找这些键。翻译在服务端解析。

命令或参数描述

当你添加命令描述时,Better /help 会将该公司归属于你的模组:

{
  "examplemod.commands.examplecommand.description": "Description of your command."
}

将 examplemod 替换为你的模组 id,将 examplecommand 替换为你的命令名称。

你可以省略模组 id 前缀,但不推荐这样做,因为会导致翻译键冲突:

{
  "commands.examplecommand.description": "Description of your command."
}

你也可以描述嵌套的字面量和参数。路径段是 Brigadier 的节点名称(即你传给 Commands.literal("name") 和 Commands.argument("name", ...) 的字符串,而不是玩家输入的内容):

{
  "examplemod.commands.examplecommand.targets.description": "Who the command applies to."
}

例如,一个通过 Commands.argument("targets", EntityArgument.players()) 注册的 EntityArgument 在翻译键中使用的是 targets,而不是 @s、@a 或玩家名称。

来自 Better /help 的示例:

{
  "commands.advancement.grant.description": "Grants player advancements.",
  "commands.advancement.grant.targets.everything.description": "Grants all advancements to players.",
  "commands.advancement.grant.targets.only.description": "Grants one specified advancement to players."
}
主页链接

设置后,/help <command...> 输出中的模组名称可以成为可点击的链接:

{
  "betterhelp.homepage.examplemod": "https://example.com"
}

将 examplemod 替换为你的模组 id。

必须是完整的 http:// 或 https:// URL。无效的 URL 将被忽略。

你可以省略模组 id 后缀,但不推荐这样做,因为会导致翻译键冲突:

{
  "betterhelp.homepage": "https://example.com"
}

更多细节请参阅文档。

❓ 常见问题

如果服务器安装了 Better /help,玩家也需要安装吗?
不需要。它是一个服务端模组。客户端无需安装。

它在单人游戏中有效吗?
有效。

如果其他模组的开发者没有与 Better /help 集成,它们的命令还会显示吗?
会,但不会有描述或其他元数据。用法仍然会显示。

我可以将它包含在整合包中吗?
可以。无需请求许可。