HideCommands ✨
HideCommands 为 Velocity + Paper 网络提供了集中的命令可见性控制。
它专为快速的管理员工作流程、实时更新和简洁的权限管理体验而构建。
? Why Use It
- 使用
none、all 和 admin+ 组来控制命令可见性。
- 在后端、插件/类别、子树或单个命令级别应用更改。
- 在权限/组更改后获得实时的命令树刷新。
- 同时使用聊天工具和库存 GUI 进行管理。
- 跨重启保持后端/插件图标自定义的持久化。
- 在后端之间全局共享插件图标,命令图标继承自其所属的插件。
- 与 Companion 感知行为配合,在 Paper 中显示清晰的运行时状态。
? Architecture
velocity: 过滤引擎、持久化、权限、桥接服务器、聊天命令。
paper: 库存 GUI、管理员交互、桥接客户端、Companion 探针。
core: 共享桥接协议和数据包模型。
? Setup (Requirements + Installation)
- 将
hidecommands-velocity-<version>.jar 放入 Velocity 代理 plugins/ 文件夹。
- 将
hidecommands-paper-<version>.jar 放入每个 Paper 后端的 plugins/ 文件夹。
- 启动或重启具有匹配插件版本的代理和后端。
- 从以下位置验证:
- Velocity:
/hc status
- Paper:
/hcstatus
✅ Important for GUI Operations
- 插件必须安装在 代理 和 后端 服务器上。
- 您可以从想要编辑的后端或其他后端使用 GUI。
- 要使更改应用于 目标后端,该目标后端内必须至少有一名玩家在线。
? Companion Link States (Classic Mode)
Paper 使用经典的插件消息传递桥接检测。
waiting-companion-link: 后端正在运行但尚不存在最近的桥接响应。
connected: 桥接响应正常到达。
行为摘要:
- 后端重启后,状态以
waiting-companion-link 开始。
- 成功的桥接往返后,状态切换为
connected。
- 如果响应停止时间超过超时限制,它将返回到
waiting-companion-link。
⚙️ Configuration
Velocity 文件:
plugins/hidecommands/global.yml
plugins/hidecommands/backends/<backend>.yml
plugins/hidecommands/backend-icons.yml
Paper 文件:
plugins/HideCommandsPaper/config.yml
示例:
companion:
proxy-detection-timeout-seconds: 12
备注:
- 当从 GUI 更改时,
plugin-icons 和 backend-icons 会自动保存。
- 如果检测到后端启用了 Companion 且未显式设置过滤,则过滤默认为启用。
?️ Permission Management
有两种管理路径:
- 聊天管理:来自 Velocity 或 Paper 命令中继的命令/聊天工作流。
- GUI 管理:用于后端/插件/命令操作的 Paper 库存菜单。
两条路径都会更新相同的后端配置状态。
? Icon Customization
- 后端图标可自定义且具有持久性。
- 插件图标通过标准化的插件名称在全局范围内共享。
- 如果同一个插件出现在多个后端中,它在所有地方都保持相同的图标。
- 命令继承其所属的插件/类别的图标。
? Available Commands
Velocity
/hc reload: 重新加载插件配置并刷新命令树。
/hc status: 显示运行时状态、桥接状态和后端诊断信息。
/hc gui: 打开 Velocity 聊天 GUI 主菜单。
/hc gui main [page]: 在特定页面打开聊天 GUI 主菜单。
/hc gui backend <backend> [page]: 打开专注于后端的聊天 GUI 视图。
/hc gui category <backend> <category> [page]: 打开一个插件/类别的聊天视图。
/hc gui command <backend> <encoded-path> [page]: 打开一个命令的聊天视图。
/hc gui set <backend> <encoded-path> <group>: 为一个命令路径设置显式组。
/hc gui cycle <backend> <encoded-path>: 将一个命令路径循环切换到下一个组。
/hc gui cyclecategory <backend> <category>: 循环一个类别中的所有命令。
/hc gui cyclebackend <backend>: 循环一个后端中的所有命令。
/hc gui filter <backend> <on|off|toggle>: 启用/禁用/切换后端过滤。
Paper
/hc: Paper 上的主要管理员入口命令。
/hcgui: 打开库存 GUI 的别名。
/hcstatus: 请求并显示来自 Paper 的代理状态。
/hc gui: 打开 Paper 库存 GUI。
/hc status: 从代理请求状态。
/hc reload: 通过桥接请求代理重载。
/hc chat [main|gui|status|reload|search <text>]: 打开或控制聊天快捷方式面板。
/hc search <text>: 在当前命令上下文中应用命令搜索。
/hcgui input <text>: 发送由 GUI 搜索流程使用的私有文本输入。
? Permission Node
? License
本项目采用 MIT 许可证。请参阅 LICENSE。
? Contributing
请在提交 PR 之前阅读 CONTRIBUTING.md。
HideCommands ✨
HideCommands gives you centralized command visibility control for Velocity + Paper networks.
It is built for fast admin workflows, live updates, and a clean permission management experience.
? Why Use It
- Control command visibility with
none, all, and admin+ groups.
- Apply changes at backend, plugin/category, subtree, or single-command level.
- Get live command-tree refresh after permission/group changes.
- Use both chat tools and inventory GUI for management.
- Keep backend/plugin icon customization persistent across restarts.
- Share plugin icons globally across backends, with command icons inherited from their plugin.
- Companion-aware behavior with clear runtime states in Paper.
? Architecture
velocity: filtering engine, persistence, permissions, bridge server, chat commands.
paper: inventory GUI, admin interactions, bridge client, companion probes.
core: shared bridge protocol and packet models.
? Setup (Requirements + Installation)
- Put
hidecommands-velocity-<version>.jar in the Velocity proxy plugins/ folder.
- Put
hidecommands-paper-<version>.jar in every Paper backend plugins/ folder.
- Start or restart proxy and backends with matching plugin versions.
- Verify from:
- Velocity:
/hc status
- Paper:
/hcstatus
✅ Important for GUI Operations
- The plugin must be installed on the proxy and on the backend servers.
- You can use the GUI from the backend you want to edit, or from another backend.
- For changes to apply to a target backend, there must be at least one player online inside that target backend.
? Companion Link States (Classic Mode)
Paper uses classic plugin-messaging bridge detection.
waiting-companion-link: backend is running but no recent bridge response exists yet.
connected: bridge responses are arriving normally.
Behavior summary:
- After backend restart, state begins at
waiting-companion-link.
- State switches to
connected after a successful bridge roundtrip.
- If responses stop longer than timeout, it returns to
waiting-companion-link.
⚙️ Configuration
Velocity files:
plugins/hidecommands/global.yml
plugins/hidecommands/backends/<backend>.yml
plugins/hidecommands/backend-icons.yml
Paper file:
plugins/HideCommandsPaper/config.yml
Example:
companion:
proxy-detection-timeout-seconds: 12
Notes:
plugin-icons and backend-icons are saved automatically when changed from GUI.
- If a backend is detected as companion-enabled and filtering is not explicitly set, filtering defaults to enabled.
?️ Permission Management
There are two management paths:
- Chat management: command/chat workflows from Velocity or Paper command relay.
- GUI management: Paper inventory menus for backend/plugin/command actions.
Both paths update the same backend configuration state.
? Icon Customization
- Backend icons are customizable and persistent.
- Plugin icons are shared by normalized plugin name globally.
- If the same plugin appears in multiple backends, it keeps the same icon everywhere.
- Commands inherit the icon of the plugin/category they belong to.
? Available Commands
Velocity
/hc reload: Reloads plugin configuration and refreshes command trees.
/hc status: Shows runtime status, bridge state, and backend diagnostics.
/hc gui: Opens the Velocity chat GUI main menu.
/hc gui main [page]: Opens chat GUI main menu at a specific page.
/hc gui backend <backend> [page]: Opens backend-focused chat GUI view.
/hc gui category <backend> <category> [page]: Opens one plugin/category chat view.
/hc gui command <backend> <encoded-path> [page]: Opens one command chat view.
/hc gui set <backend> <encoded-path> <group>: Sets an explicit group for one command path.
/hc gui cycle <backend> <encoded-path>: Cycles one command path to the next group.
/hc gui cyclecategory <backend> <category>: Cycles all commands in a category.
/hc gui cyclebackend <backend>: Cycles all commands in a backend.
/hc gui filter <backend> <on|off|toggle>: Enables/disables/toggles backend filtering.
Paper
/hc: Main admin entry command on Paper.
/hcgui: Alias that opens the inventory GUI.
/hcstatus: Requests and displays proxy status from Paper.
/hc gui: Opens Paper inventory GUI.
/hc status: Requests status from proxy.
/hc reload: Requests proxy reload through bridge.
/hc chat [main|gui|status|reload|search <text>]: Opens or controls chat shortcuts panel.
/hc search <text>: Applies command search in the current command context.
/hcgui input <text>: Sends private text input used by GUI search flow.
? Permission Node
? License
This project is licensed under the MIT License. See LICENSE.
? Contributing
Please read CONTRIBUTING.md before opening a PR.
评论 0
登录后参与评分
还没有评论,来抢沙发吧