HomeGUI
HomeGUI 为 EssentialsX 的家系统添加了实用的界面。玩家无需记住每个家的名称,即可浏览、搜索、创建、删除并传送至家中。
EssentialsX 仍负责存储和管理家。HomeGUI 专注于围绕其操作的界面,因此 /home <name> 命令在通过 /home 打开菜单时同样有效。
功能
- 带有世界和位置详情的分页家列表。
- 基于铁砧的家名搜索。
- 从界面中创建和删除家。
- 收藏的家始终位于列表顶部。
- 支持按类别、收藏和历史记录显示个性化的家图标。
- 可选使用 CraftEngine、ItemsAdder、Nexo 和 Oraxen 的自定义物品。
- 可配置的传送延迟、冷却时间、音效和粒子效果。
- 移动或受到攻击时可取消传送。
- 只读的管理员视图,可查看其他玩家的家园。
- 事务性配置重载:无效文件不会替换当前活动配置。
- 内置英语和西班牙语的消息与菜单翻译。
家图标
玩家可以为每个家分配不同的图标。内置选择器包括:
- 按类别分组的 Minecraft 方块和物品。
- 精选的小型头颅目录。
- 收藏图标。
- 最近使用的图标。
- 由服务器管理员显式配置的自定义物品。
外部物品提供者为可选功能。如果未安装某个提供者,其条目将不可用,而 HomeGUI 的其他部分仍可正常工作。
语言
HomeGUI 附带 en_US 和 es_ES 两种语言。所选区域设置控制聊天消息、库存标题、物品名称、描述、类别名称和头颅名称。
在 config.yml 中选择语言:
language: en_US
或:
language: es_ES
菜单布局文件仅包含槽位、图标和翻译键。更改语言时无需编辑每个菜单文件。要添加另一种语言,请复制 languages/ 中的现有文件,翻译其中的可见值,并在 config.yml 中选择该文件名。
使用 /homeadmin reload 应用语言和菜单更改。
依赖
| 依赖项 |
用途 |
| Paper 1.21.x |
服务端平台 |
| Java 21 |
运行环境 |
| EssentialsX |
家的存储与管理 |
仅在将 CraftEngine、ItemsAdder、Nexo 和 Oraxen 的物品用作家图标时才需要这些插件。
安装
- 停止服务器。
- 安装 EssentialsX。
- 将 HomeGUI JAR 放入
plugins 文件夹。
- 安装您打算使用的任何可选物品提供插件。
- 启动服务器一次以生成配置文件。
- 设置区域设置并替换选定语言文件中的
SERVERNAME。
- 如有需要,向
menu/icon-custom.yml 添加自定义物品引用。
命令
| 命令 |
描述 |
/home |
打开您的家列表。 |
/home <home> |
通过 EssentialsX 进行传送。 |
/home search |
按名称搜索您的家。 |
/home view <player> |
查看其他玩家的家。 |
/homeadmin reload |
验证并重载所有配置文件。 |
/homeadmin validate |
检查当前配置是否存在错误。 |
/homeadmin providers |
显示各物品提供者的状态。 |
/homeadmin identify |
识别主手中持有的物品。 |
/homeadmin preview <menu> |
预览菜单。 |
/homeadmin view <player> |
打开管理员视角的家列表。 |
别名包括 /homes、/home buscar、/home ver 和 /homegui。
权限
| 权限 |
描述 |
默认 |
homegui.create |
从菜单创建家。 |
所有人 |
homegui.search |
使用家搜索功能。 |
所有人 |
homegui.others |
查看其他玩家的家。 |
操作员 |
homegui.teleport.others |
传送到其他玩家的家。 |
操作员 |
homegui.teleport.bypasscooldown |
忽略传送冷却时间。 |
操作员 |
homegui.admin |
授予所有 HomeGUI 管理权限。 |
操作员 |
针对 reload、validate、providers、identify、preview 和 view 的单独管理权限可在 homegui.admin.* 命名空间下获得。
自定义物品引用
自定义图标列于 menu/icon-custom.yml 中。每个引用必须在其对应的提供者中存在:
items:
- 'craftengine:server:home_icon'
- 'itemsadder:server:home_icon'
- 'nexo:home_icon'
- 'oraxen:home_icon'
HomeGUI 绝不会猜测或重写自定义物品 ID。
文件结构
plugins/HomeGUI/
├── config.yml
├── languages/
│ ├── en_US.yml
│ └── es_ES.yml
├── menu/
│ ├── home-list.yml
│ ├── home-search.yml
│ ├── admin-view.yml
│ ├── delete-confirm.yml
│ └── icon-*.yml
└── icons/
├── palette.yml
└── heads.yml
支持
报告问题时,请同时提供 Paper、EssentialsX 和 HomeGUI 的版本信息,以及完整的控制台错误日志。
Discord:
HomeGUI
HomeGUI adds a practical interface to the EssentialsX home system. Players can browse, search, create, delete, and teleport to homes without having to remember every home name.
EssentialsX remains responsible for storing and managing homes. HomeGUI focuses on the interface around them, so /home <name> still works alongside the menu opened with /home.
Features
- Paginated home list with world and location details.
- Anvil-based search by home name.
- Create and delete homes from the interface.
- Favorite homes are kept at the top of the list.
- Per-home icons with categories, favorites, and recent history.
- Optional custom items from CraftEngine, ItemsAdder, Nexo, and Oraxen.
- Configurable teleport delay, cooldown, sounds, and particles.
- Teleports can be cancelled by movement or incoming damage.
- Read-only administrative view for another player's homes.
- Transactional configuration reloads: invalid files do not replace the active configuration.
- English and Spanish included for messages and menus.
Home icons
Players can assign a different icon to each home. The built-in selector includes:
- Minecraft blocks and items grouped by category.
- A small, curated head catalog.
- Favorite icons.
- Recently used icons.
- Custom items explicitly configured by the server administrator.
External item providers are optional. If a provider is not installed, its entries are simply unavailable while the rest of HomeGUI continues to work.
Languages
HomeGUI ships with en_US and es_ES. The selected locale controls chat messages, inventory titles, item names, lore, category names, and head names.
Choose the language in config.yml:
language: en_US
or:
language: es_ES
Menu layout files contain only slots, icons, and translation keys. You do not need to edit every menu when changing languages. To add another locale, copy an existing file in languages/, translate its visible values, and select its filename in config.yml.
Apply language and menu changes with /homeadmin reload.
Requirements
| Requirement |
Purpose |
| Paper 1.21.x |
Server platform |
| Java 21 |
Runtime |
| EssentialsX |
Home storage and management |
CraftEngine, ItemsAdder, Nexo, and Oraxen are only required when their items are used as home icons.
Installation
- Stop the server.
- Install EssentialsX.
- Place the HomeGUI JAR in the
plugins folder.
- Install any optional item providers you intend to use.
- Start the server once to generate the configuration.
- Set the locale and replace
SERVERNAME in the selected language file.
- Add custom item references to
menu/icon-custom.yml if needed.
Commands
| Command |
Description |
/home |
Open your home list. |
/home <home> |
Teleport through EssentialsX. |
/home search |
Search your homes by name. |
/home view <player> |
Open another player's homes. |
/homeadmin reload |
Validate and reload all configuration files. |
/homeadmin validate |
Check the active configuration for errors. |
/homeadmin providers |
Show the state of each item provider. |
/homeadmin identify |
Identify the item held in the main hand. |
/homeadmin preview <menu> |
Preview a menu. |
/homeadmin view <player> |
Open the administrative home view. |
Aliases include /homes, /home buscar, /home ver, and /homegui.
Permissions
| Permission |
Description |
Default |
homegui.create |
Create homes from the menu. |
Everyone |
homegui.search |
Use home search. |
Everyone |
homegui.others |
View another player's homes. |
Operators |
homegui.teleport.others |
Teleport to another player's homes. |
Operators |
homegui.teleport.bypasscooldown |
Ignore the teleport cooldown. |
Operators |
homegui.admin |
Grant all HomeGUI administration permissions. |
Operators |
Individual administration permissions are available for reload, validate, providers, identify, preview, and view under the homegui.admin.* namespace.
Custom item references
Custom icons are listed in menu/icon-custom.yml. Each reference must exist in its provider:
items:
- 'craftengine:server:home_icon'
- 'itemsadder:server:home_icon'
- 'nexo:home_icon'
- 'oraxen:home_icon'
HomeGUI never guesses or rewrites custom item IDs.
File structure
plugins/HomeGUI/
├── config.yml
├── languages/
│ ├── en_US.yml
│ └── es_ES.yml
├── menu/
│ ├── home-list.yml
│ ├── home-search.yml
│ ├── admin-view.yml
│ ├── delete-confirm.yml
│ └── icon-*.yml
└── icons/
├── palette.yml
└── heads.yml
Support
When reporting an issue, include the Paper, EssentialsX, and HomeGUI versions together with the complete console error.
Discord:
评论 0
登录后参与评分
还没有评论,来抢沙发吧