Command Syntax Guide API

Fabric 客户端模组，为 IDEA 插件导出当前连接所提供的 Brigadier 指令树。服务器发给客户端的树已经按当前玩家权限过滤，因此 API 同时支持原版、数据包和模组动态注册的指令，不依赖预置的指令名称或颜色表。

本地 API

模组在 127.0.0.1:32123（或系统对应的 loopback 地址）启动只读 HTTP 服务：

• GET /v1/status：返回 Minecraft 版本以及是否已经进入世界。
• GET /v1/commands：返回完整的指令图；未进入世界时返回 HTTP 409。
• GET /v1/suggestions?input=...：让游戏本身为未完成的指令计算补全，包括服务器动态返回的参数值。

指令节点采用 ID 引用，以保留 Brigadier 的子节点和 redirect 图结构。argument 节点包含解析器类名、示例以及可用时的建议提供器类型。IDEA 插件应把未知解析器作为通用参数处理，因此新的指令仍然能够立即参与结构补全与标色。

Invoke-RestMethod http://localhost:32123/v1/status
Invoke-RestMethod http://localhost:32123/v1/commands
Invoke-RestMethod 'http://localhost:32123/v1/suggestions?input=give%20'

构建

.\gradlew.bat build

IDEA 插件

idea-plugin 子工程提供 .mcfunction 文件类型、注释/字符串/数字基础标色、基于实时 Brigadier 指令图的 literal/argument 语义标色，以及代码补全。

使用流程：

1. 将模组放入 Fabric 客户端并进入世界或服务器。
2. 在 IDEA 中安装 idea-plugin/build/distributions/command-syntax-guide-idea-plugin-1.0.0.zip。
3. 打开 .mcfunction 文件；插件每两秒刷新一次指令树，触发补全时会请求游戏实时建议。

单独构建插件：

.\gradlew.bat -p idea-plugin buildPlugin

插件当前以 IntelliJ IDEA 2026.1 为最低版本，并使用 2026.1.3 SDK 构建。首次构建需要从 JetBrains 下载 IntelliJ Platform SDK。

License

This project is available under the CC0 license.