Essentials Kit GUI - 增强版礼包界面

💡简介

KitGUI 是一款轻量、稳定且功能强大的插件，它基于 Essentials 或 EssentialsX 的现有礼包系统，为其添加了一个美观、可自定义的图形用户界面（GUI）。玩家无需记忆命令，通过直观的菜单即可领取礼包，极大地提升了服务器体验。它构建于 Essentials 之上，无需重新配置礼包，并提供了丰富的自定义选项。

✨核心特性

稳定性与性能

• 全版本支持：完整支持自 1.8.8 起的所有 Minecraft 版本，并对 1.13+ 的现代版本有更好的优化。
• 完美兼容：完全支持原版 Essentials 和 EssentialsX。
• 代码整洁：采用模块化、清晰的代码结构。
• 轻量高效：插件本身非常轻量，不包含任何冗余功能。
• 多线程支持：减少主线程压力，对服务器 TPS 几乎无影响。

功能与易用性

• 开箱即用：安装即生效，无需花费大量时间进行复杂配置。
• 无缝集成：不会替换 Essentials 的礼包功能，而是在其基础上增强。自动检测服务器中已存在的所有礼包。
• 独立存储：每个礼包都存储在自己的文件中，便于迁移和修改。
• 高度可定制：支持自定义所有消息、GUI 外观，甚至按钮音效（可关闭）。
• 多页支持：可添加任意数量的礼包，GUI 会自动分页显示。
• 现代化 GUI：界面美观，支持 Hex 颜色代码（仅限 1.16+，例如 &#FF00FF）。
• 礼包按钮定制：
• 修改在 GUI 中的显示名称。
• 自定义图标材质。
• 添加描述文本（Lore）。
• 自由拖动礼包按钮到 GUI 中的任意位置。

🎮命令与权限

命令

插件会监听以下命令来打开礼包 GUI

• /kit
• /kits

管理员可以使用 /kitcfg 命令进行高级配置，其子命令用法可通过 /kitcfg help 查看。

权限

• 礼包访问权限：本插件不修改 Essentials 的权限系统。玩家在 GUI 中只能看到并领取他们拥有权限的礼包。这意味着玩家必须拥有 essentials.kits.<礼包名>（访问特定礼包）或 essentials.kits.*（访问所有礼包）权限。
• 配置权限：使用 /kitcfg 命令需要权限 kitcfg.cfg。

🔧配置详解

config.yml

主要配置文件，用于控制 GUI 的外观和行为。

# 库存标题
inventory-title: Kits
# 第二页及之后的库存标题
inventory-title-page: Kits - Page {page}
# 库存高度 (1-6)。使用 -1 自动调整
inventory-height: 6
# 物品在 GUI 中的对齐方式 (NONE, CENTRALIZED, ALIGNED)
inventory-center-x: CENTRALIZED
inventory-center-y: NONE
# 礼包物品在 GUI 中的边距
inventory-offset-top: 1
inventory-offset-right: 1
inventory-offset-left: 1
inventory-offset-bottom: 1
# 填充空槽位的材质
inventory-background-material: air
inventory-offset-material: air
# 分页栏材质
next-page-bar-material: STAINED_GLASS_PANE:7
next-page-button-material: ARROW
# 事件音效
sound:
  open:
    name: ENTITY_CHICKEN_EGG
    volume: 0.7
    pitch: 1.5
  close:
    name: ENTITY_CHICKEN_EGG
    volume: 0.7
    pitch: 0.5
  click-kit:
    name: UI_BUTTON_CLICK
    volume: 0.7
    pitch: 1.5
  switch-page:
    name: ENTITY_HORSE_STEP_WOOD
    volume: 1.0
    pitch: 1.2
# 用于打开 GUI 的命令
listen-to-commands:
  - kit
  - kits

messages.yml

用于自定义插件发送的所有文本消息。

⭐物品图标语法

在使用 /kitcfg icon <kit> <icon> 命令时，需要遵循特定的物品语法来设置礼包图标。

可用特性

• 1.19+：可以使用与 /give 命令相同的物品语法。
• 1.19 - 1.20.4：可以使用 NBT 数据。
• 1.20.5+：必须使用物品组件（Item Components）。
• 支持旧版材质ID（1.12 之前，不推荐）。
• 支持新旧版本的材质名称。
• 自定义头颅：
• player_head:<玩家名>
• player_head:<Base64纹理值>
• 使用 HEX 颜色染色皮革盔甲：
• leather_cheptplate:#FF00FF

语法示例

• stone
• stone:1 (变为花岗岩)
• iron_pickaxe:50 (为镐子添加一些耐久损耗)
• player_head:Notch (Notch 的头颅)
• player_head:eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvYjA0ODMxZjdhN2Q4ZjYyNGM5NjMzOTk2ZTM3OThlZGFkNDlhNWQ5YmNkMThlY2Y3NWJmYWU2NmJlNDhhMGE2YiJ9fX0= (显示一个地球头颅，纹理来自 minecraft-heads.com)
• leather_chestplate:#FFFF00 (黄色皮革胸甲)
• stick{Enchantments:[{id:"minecraft:knockback",lvl:1s}]} (仅限 1.19 - 1.20.4，带击退 I 附魔的棍子)

> 提示：你可以通过在线资料站查询所有可用的材质名称。请注意，与你 Minecraft 版本不兼容的材质将无法工作。

❓常见问题

• 问：这个插件会干扰 Essentials 的礼包吗？
• 答：完全不会。它只是为 Essentials 的礼包添加了一个 GUI 前端，所有原有的礼包数据、冷却时间和权限都保持不变。

• 问：我需要为每个礼包重新设置图标吗？
• 答：不需要。插件会自动为没有自定义图标的礼包生成一个默认图标。你可以随时使用 /kitcfg 命令进行个性化设置。

• 问：如何移动礼包在 GUI 中的位置？
• 答：使用 /kitcfg setslot <礼包名> <X> <Y> 命令，可以将指定礼包按钮固定到 GUI 的特定坐标。

• 问：支持其他插件（如 Vault）的权限吗？
• 答：礼包本身的领取权限完全依赖于 Essentials，Essentials 可以配置为与 Vault 协同工作。本插件的 GUI 只会显示玩家通过 Essentials 系统有权领取的礼包。

---

同类插件：本作者还开发了功能类似的 WarpGUI 插件，用于为 /warps 命令提供 GUI 界面。

**官方资源**

• 官方网站
• SpigotMC 页面