# \ud83d\udc51 EGUI (EssentialsGui) v2.1<\/p>\n
**EGUI** is a powerful, highly customizable GUI for **EssentialsX** Homes and Warps. One JAR works on **all Paper versions** \u2014 from Minecraft 1.21.1 through the latest 26.x releases.<\/p>\n
> **Note:** EGUI will still start without EssentialsX installed, but home and warp features will be unavailable. OPs are notified in chat.<\/p>\n
—<\/p>\n
## \u26a0\ufe0f Version Compatibility Notice<\/p>\n
| Minecraft Version | Java Version | EGUI Support |
\n| :— | :— | :— |
\n| **1.21.1 \u2013 1.21.6** | **Java 21** | \u2705 AnvilGUI text input |
\n| **1.21.7 \u2013 1.21.11** | **Java 21** | \u2705 Paper Dialog API text input |
\n| **26 and newer** | **Java 25** | \u2705 Paper Dialog API text input |<\/p>\n
> **One JAR for all servers.** EGUI automatically detects your Paper version and loads the correct input module. No more choosing between “legacy” and “modern” downloads.<\/p>\n
—<\/p>\n
## \ud83d\udea7 Development & Support<\/p>\n
**EGUI is currently in active development!** Many more features, flexible layouts, and extended customization options are planned for future updates.<\/p>\n
If you need support, want to report an issue, or have a great idea for a new feature you’d like to see added, please join our **Discord Server**! We would love to hear your feedback and suggestions.<\/p>\n
—<\/p>\n
## \ud83d\uded1 Prerequisites (Mandatory)<\/p>\n
EGUI is a companion plugin for **EssentialsX**.
\n* **EssentialsX**: Download Here \u2014 Required for full functionality (homes & warps). EGUI starts without it but warns admins.
\n* **Paper 1.21.1+**: PaperMC is required. Spigot\/CraftBukkit are NOT supported.
\n* **Java 21+**: Compiles to Java 21 bytecode \u2014 runs on both Java 21 and Java 25 JVMs.<\/p>\n
—<\/p>\n
## \ud83d\ude80 Features<\/p>\n
* \ud83d\udee1\ufe0f **EssentialsX Integration**: Seamlessly reads and manages homes and warps directly from EssentialsX data.
\n* \ud83d\udecf\ufe0f **Adaptive Home GUI**: Automatically displays the correct number of set and empty home slots based on the player’s max home permissions.
\n* \ud83d\udcd0 **Customizable Layouts**: Choose between a full `THREE_ROWS` (with borders) or a compact `ONE_ROW` style.
\n* \ud83c\udfa8 **Full Customization**: Every item, message, and layout is fully configurable in `config.yml`.
\n* \ud83c\udfe0 **Custom Home Icons**: Players can personalize their homes by setting custom material icons.
\n* \u2328\ufe0f **Smart Text Input**: Automatically uses **Paper’s native Dialog API** on modern servers (1.21.7+) and **AnvilGUI** on older servers (1.21.1\u20131.21.6). Zero configuration needed.
\n* \ud83d\udee1\ufe0f **Admin Panel**: Search and manage offline players’ homes with the `\/adminhomes` command.
\n* \ud83c\udf9b\ufe0f **Extensive Toggles**: Toggle the core `\/homes` or `\/warps` commands, the set home GUI, deletion confirmations, and the no-homes prompt easily in exactly one config!
\n* \ud83d\udce1 **Custom Warp Icons**: Assign unique items, names, and lore to specific warps in `warps.yml`.
\n* \ud83d\uddd1\ufe0f **Safe Deletion**: Integrated confirmation GUI for home deletions to prevent accidents (toggleable!).
\n* \ud83c\udfe0 **No-Homes GUI**: When a player with no homes runs `\/homes`, a GUI asks if they want to create one at their current location instead of just sending a chat message.
\n* \ud83d\udd04 **Live Reload**: Update your configurations on the fly with `\/egui reload`.
\n* \ud83d\udce1 **Status Dashboard**: Check Essentials connectivity and version status via `\/egui status`.
\n* \ud83d\udd14 **Update Checker**: Automatically notifies admins of new releases.
\n* \ud83d\udcc9 **Lightweight**: ~250 KB including both shaded providers.
\n* \ud83d\udcca **bStats Metrics**: Anonymous server usage tracking via bStats, including custom charts for active module, GUI style, player count, and server version.<\/p>\n
—<\/p>\n
## \ud83d\udccb Commands & Permissions<\/p>\n | Command | Description | Permission | Default | —<\/p>\n ## \u2699\ufe0f Configuration (`config.yml`)<\/p>\n “`yaml # —————————————————————————— # Print detailed module loading info to console on startup # Path to the Essentials userdata and warps folders. # ============================================================================== # Background filler item used for all GUIs # Navigation buttons item-for-next-page: # ============================================================================== # Item representing a set home # Item representing an available but unset home slot # ============================================================================== # Default template for warps (if not customized in warps.yml) # ============================================================================== # The “Yes” button # The “No” button # ============================================================================== # ============================================================================== # The “Create Home” button # The “Close” button # ============================================================================== # ============================================================================== — To give the warp “spawn” a unique icon, add this to `warps.yml`:<\/p>\n “`yaml —<\/p>\n ## \ud83d\udee0\ufe0f Installation<\/p>\n 1. **Download** the `EGUI-2.1.jar` file. —<\/p>\n ## \ud83e\udde9 How the Module System Works<\/p>\n EGUI 2.1 ships with two embedded modules inside a single JAR:<\/p>\n | Module | Paper Versions | Input Method | On startup, EGUI detects your server’s Minecraft version and instantiates the correct provider. Both implementations are shaded directly into the plugin JAR and compile to Java 21 bytecode, so the same JAR runs on both Java 21 and Java 25.<\/p>\n You can override the auto-detection in `config.yml`: —<\/p>\n ## \ud83d\udcca bStats Metrics<\/p>\n EGUI uses bStats to anonymously track server information: > **Privacy Note:** bStats aggregates all data anonymously. No server IP addresses, domain names, or player identities are ever transmitted.<\/p>\n <\/p>\n —<\/p>\n ## \ud83d\udcdc Credits<\/p>\n – **AnvilGUI** \u2014 Text input library for legacy Paper versions by WesJD EGUI is a powerful, highly customizable GUI for EssentialsX Homes and Warps.<\/p>\n","protected":false},"featured_media":65495,"template":"","meta":{"_minecraft_slug":"essentialx-gui","_minecraft_project_id":"LeBCMK1a","_minecraft_author":"obsyrixx","_minecraft_license":"MIT","_minecraft_downloads":1613,"_minecraft_follows":5,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"essentialx-gui.zip","_minecraft_size_bytes":650832,"_minecraft_version_count":5,"_minecraft_updated_at":"2026-05-16T07:06:12.482272Z","_minecraft_date_created":"2026-03-04T23:17:41.654433Z","_minecraft_date_modified":"2026-05-11T13:38:22.390132Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/essentialx-gui","_minecraft_icon_attachment_id":65495,"_minecraft_imported_at":"2026-06-03T18:22:28+00:00","_minecraft_import_hash":"629117395ef481ed4a2ea0c50d882485","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[126,90,127,128,867,129,123,92],"mod_loader":[132,133,134],"minecraft_version":[62,37,40,41,73,74,38,78,79,80,81,82,83,167,163],"class_list":["post-65494","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-management","mod_category-optimization","mod_category-paper","mod_category-purpur","mod_category-social","mod_category-spigot","mod_category-technology","mod_category-utility","mod_loader-paper","mod_loader-purpur","mod_loader-spigot","minecraft_version-1-21","minecraft_version-1-21-1","minecraft_version-1-21-10","minecraft_version-1-21-11","minecraft_version-1-21-2","minecraft_version-1-21-3","minecraft_version-1-21-4","minecraft_version-1-21-5","minecraft_version-1-21-6","minecraft_version-1-21-7","minecraft_version-1-21-8","minecraft_version-1-21-9","minecraft_version-26-1","minecraft_version-26-1-1","minecraft_version-26-1-2"],"yoast_head":"\nCommands & Permissions<\/summary>\n
\n| :— | :— | :— | :— |
\n| `\/homes` | Opens the Homes GUI | `egui.homes` | Everyone |
\n| `\/sethomeicon
\n| `\/adminhomes` | Opens the Admin Panel to manage player homes | `egui.admin` | OP |
\n| `\/warps` | Opens the Warps GUI | `egui.warps` | Everyone |
\n| `\/egui reload` | Reloads all configurations | `egui.reload` | OP |
\n| `\/egui status` | Displays plugin status and version info | `egui.status` | OP |<\/p>\n<\/details>\nconfig.yml<\/summary>\n
\n# ==============================================================================
\n# EGUI Configuration
\n# ==============================================================================<\/p>\n
\n# Module Selection (Advanced)
\n# ——————————————————————————
\n# EGUI automatically detects your server version and loads the correct module:
\n# – Paper 1.21.1 to 1.21.6 \u2192 loads AnvilGUI (legacy)
\n# – Paper 1.21.7+ and 26.x \u2192 loads Paper Dialog API (dialog)
\n#
\n# You can override this behavior:
\n# auto = Let EGUI decide (recommended)
\n# legacy = Force AnvilGUI on all versions
\n# dialog = Force Dialog API on all versions (will crash on old servers!)
\nmodule-selection: auto<\/p>\n
\nmodule-log-verbose: true<\/p>\n
\nessentials-userdata-folder: “plugins\/Essentials\/userdata”
\nwarps-folder: “plugins\/Essentials\/warps”<\/p>\n
\n# GUI Appearance
\n# ==============================================================================
\n# Options:
\n# THREE_ROWS: A 9×3 GUI with top\/bottom glass borders (as in screenshot).
\n# ONE_ROW: A compact 9×1 GUI containing only the functional row.
\ngui-style: ONE_ROW<\/p>\n
\nbackground-item:
\n material: BLACK_STAINED_GLASS_PANE
\n name: “”<\/p>\n
\nitem-for-previous-page:
\n material: ARROW
\n name: “&ePrevious Page”
\n lore:
\n – “&aLeft-Click to go to the Previous Page”<\/p>\n
\n material: ARROW
\n name: “&eNext Page”
\n lore:
\n – “&aLeft-Click to go to the next page”<\/p>\n
\n# Homes GUI Settings
\n# ==============================================================================
\ngui-titles:
\n homes: “&8Your homes”
\n warps: “&8Server Warps”
\n sethome: “&fEnter Home Name”
\n admin-search-online-player: “&fSearch Online Player”
\n admin-search-offline-player: “&fSearch Offline Player”<\/p>\n
\nitem-for-home:
\n material: RED_BED
\n name: “&e%home%”
\n lore:
\n – “&7World: &f%world%”
\n – “&7X: &f%x% &7Y: &f%y% &7Z: &f%z%”
\n – “”
\n – “&aLeft-Click to Teleport”
\n – “&cRight-Click to Delete”<\/p>\n
\nitem-for-empty-home:
\n material: GRAY_BED
\n name: “&8Empty Home Slot”
\n lore:
\n – “&7Click here to securely”
\n – “&7type and set a new home!”<\/p>\n
\n# Warps GUI Settings
\n# ==============================================================================<\/p>\n
\ndefault-item-for-warp:
\n material: ENDER_PEARL
\n name: “&e%warp%”
\n lore:
\n – “&7Click to teleport to %warp%.”<\/p>\n
\n# Confirm Deletion GUI
\n# ==============================================================================
\nconfirm-gui:
\n # Filling empty slots in the 9-slot confirmation menu
\n fill-background: true
\n background-material: BLACK_STAINED_GLASS_PANE
\n background-name: ” ”<\/p>\n
\n confirm-item:
\n material: LIME_WOOL
\n name: “&aConfirm Deletion”
\n lore:
\n – “&7Click to permanently delete”<\/p>\n
\n cancel-item:
\n material: RED_WOOL
\n name: “&cCancel”
\n lore:
\n – “&7Go back to your homes list.”<\/p>\n
\n# Features
\n# ==============================================================================
\nfeatures:
\n allow-custom-home-icons: true
\n enable-homes-command: true
\n enable-warps-command: true
\n enable-set-home-gui: true
\n delete-home-confirmation: true
\n admin-search-exact-match: false
\n ask-create-home-if-empty: true<\/p>\n
\n# No Homes GUI
\n# ==============================================================================
\n# Shown when a player uses \/homes but has no homes set
\n# (only if features.ask-create-home-if-empty is true)
\nno-homes-gui:
\n title: “&8No Homes Set”
\n fill-background: true
\n background-material: BLACK_STAINED_GLASS_PANE
\n background-name: ” ”<\/p>\n
\n create-item:
\n material: LIME_WOOL
\n name: “&aCreate Home”
\n lore:
\n – “&7Click to create a home”
\n – “&7at your current location.”<\/p>\n
\n close-item:
\n material: RED_WOOL
\n name: “&cClose”
\n lore:
\n – “&7Close this menu.”<\/p>\n
\n# Messages
\n# ==============================================================================
\nmessages:
\n no-homes: “&cYou do not have any homes set.”
\n no-warps: “&cThere are no warps set.”
\n deleted: “&cDeleted home &e%home%&c.”
\n confirm-delete-title: “&4Delete %home%?”
\n no-permission: “&cYou do not have permission to use this command.”
\n only-players: “&cOnly players can use this command.”
\n reload-success: “&aEGUI configuration reloaded!”
\n usage: “&eUsage: \/egui reload”
\n invalid-home: “&cThat home does not exist.”
\n invalid-material: “&cInvalid item name.”
\n icon-set-success: “&aSuccessfully set the icon for &e%home%&a to &e%material%&a.”
\n icons-disabled: “&cCustom home icons are disabled.”
\n feature-disabled: “&cThis feature is currently disabled.”
\n sethome-success: “&aYour new home &e%home%&a was added!”
\n sethome-invalid-name: “Enter a valid name”
\n sethome-no-spaces: “No spaces allowed”
\n player-not-found: “&cPlayer not found.”
\n admin-teleport-home: “&aTeleported to &e%player%&a’s home: &e%home%&a.”
\n admin-delete-home: “&cDeleted &e%player%&c’s home: &e%home%&c.”
\n admin-confirm-delete-title: “&4Delete &e%player%’s &4%home%?”
\n admin-player-head-lore: “&7Click to view homes”<\/p>\n
\n# Admin Panel Items
\n# ==============================================================================
\nadmin-panel-items:
\n background-item:
\n material: BLACK_STAINED_GLASS_PANE
\n name: ” ”
\n lore: []
\n search-online-button:
\n material: NAME_TAG
\n name: “&aSearch Online Player”
\n lore:
\n – “&7Click here to filter”
\n – “&7all online players.”
\n search-offline-button:
\n material: COMPASS
\n name: “&cSearch Offline Player”
\n lore:
\n – “&7Click here to find”
\n – “&7a specific offline player.”
\n back-button:
\n material: BARRIER
\n name: “&cBack to Admin Panel”
\n lore: []
\n“`<\/p>\n<\/details>\n
\n## \u2699\ufe0f Configuration Example: Customizing a Warp<\/p>\n
\nwarps:
\n spawn:
\n material: NETHER_STAR
\n name: “&b&lSpawn”
\n lore:
\n – “&7Return to the main spawn.”
\n“`<\/p>\n
\n2. **Ensure** you have **EssentialsX** already installed and running on your server.
\n3. **Place** the `EGUI-2.1.jar` into your server’s `plugins` folder.
\n4. **Restart** your server (or use a plugin loader) to generate the configuration files.
\n5. **Configure** the `plugins\/EGUI\/config.yml` to match your server’s aesthetic.
\n6. **Optional**: Add custom warp icons in `plugins\/EGUI\/warps.yml`.
\n7. Type `\/egui reload` in-game to apply any changes!<\/p>\n
\n|——–|—————|————-|
\n| **Legacy** | 1.21.1 \u2013 1.21.6 | AnvilGUI by WesJD |
\n| **Dialog** | 1.21.7+ and 26.x | Paper’s native Dialog API |<\/p>\n
\n“`yaml
\nmodule-selection: auto # auto, legacy, or dialog
\n“`<\/p>\n
\n– **Default metrics:** player count, Minecraft version, Java version, server software, operating system
\n– **Custom charts:** active input module, GUI style, player count range, and server version<\/p>\n
\n– **bStats** \u2014 Plugin metrics platform
\n– **EssentialsX** \u2014 The essential plugin suite for Minecraft servers<\/p>\n","protected":false},"excerpt":{"rendered":"