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

CraftEngine, ItemsAdder, Nexo, and Oraxen are only required when their items are used as home icons.

Installation

1. Stop the server.
2. Install EssentialsX.
3. Place the HomeGUI JAR in the plugins folder.
4. Install any optional item providers you intend to use.
5. Start the server once to generate the configuration.
6. Set the locale and replace SERVERNAME in the selected language file.
7. Add custom item references to menu/icon-custom.yml if needed.

Commands

Aliases include /homes, /home buscar, /home ver, and /homegui.

Permissions

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: https://discord.com/invite/5vjhNfeVDS