--- title: "How to install and configure EssentialsX on a Minecraft server" description: "Install and configure EssentialsX on your Minecraft server hosted at Winheberg. Homes, economy, chat, kits, commands and LuckPerms permissions." category: jeux subcategory: minecraft-java icon: tabler:file-text date: 2026-08-11 author: Winheberg slug: "install-use-essentialsx-minecraft" order: 61 image: /statics/images/docs/en/gaming/minecraft-java/install-use-essentialsx-minecraft.webp tags: [essentialsx, minecraft, plugin, luckperms, permissions] keywords: [essentialsx, minecraft plugin, essentials config.yml, luckperms, essentialsx kits, winheberg] link_fr: "/docs/minecraft-java/installer-utiliser-essentialsx-minecraft" --- ## Context **[EssentialsX](https://essentialsx.net/)** is one of the foundational plugins for any Spigot, Paper, or Purpur Minecraft server infrastructure. It combines over a hundred core utilities missing from vanilla gameplay, including player teleports (homes, warps, tpa), a complete economy system, kit management, moderation toolsets (ban, mute, kick), and customizable system messaging. Rather than stacking dozens of single-purpose plugins, **[EssentialsX](https://essentialsx.net/)** provides a unified, performance-optimized suite designed for modern servers. This technical guide explains how to install, configure, and manage **[EssentialsX](https://essentialsx.net/)** through your [Winheberg panel](https://panel.winheberg.com). ## Prerequisites - An active Java Minecraft server (Spigot, Paper, or Purpur) hosted on your [Winheberg panel](https://panel.winheberg.com) - A permission manager plugin such as **[LuckPerms](https://luckperms.net/)** to assign node access to players - The **[Vault](https://www.curseforge.com/minecraft/bukkit-plugins/vault/files/all?page=1&pageSize=20&showAlphaFiles=hide)** plugin installed if you plan to hook **[EssentialsX](https://essentialsx.net/)** economy into third-party plugins > [!WARNING] > Stop your server before performing the initial installation to avoid file locking and configuration generation issues. ## Step 1: Install EssentialsX via Panel The [Winheberg panel](https://panel.winheberg.com) simplifies plugin management. You can choose between automatic installation and manual deployment. ### Method A: Automatic Installation (Recommended) 1. Log into your [Winheberg panel](https://panel.winheberg.com) 2. Stop your server instance to avoid write conflicts during initial setup 3. Navigation bar: click the **Plugins** button 4. Use the search bar to locate `EssentialsX` 5. Click the install button beside **[EssentialsX](https://essentialsx.net/)** (Core), then add `EssentialsXChat` for chat formatting and `EssentialsXSpawn` for spawn handling as required 6. Restart your server so the panel deploys the required files and dependencies Plugin installation tab via the Plugins button on the Winheberg panel ### Method B: Manual Installation via File Manager 1. Download the required `.jar` files from the official **[EssentialsX](https://essentialsx.net/downloads.html)** site 2. Access your panel and navigate to the **File manager** tab 3. Open the `/plugins/` directory 4. Click the **Upload** button at the top right and select your `.jar` files, or drag-and-drop them into the interface 5. Start your server to generate the configuration directories ## Step 2: Configure Core Features (config.yml) After restarting, a `/plugins/Essentials/` directory is generated. It contains the primary configuration file, `config.yml`, which can be edited directly inside the panel's File manager. Below are key settings to adapt. ### 1. Maximum Homes per Rank Locate the `sethome-multiple` section to set home quotas for different permission groups. ```yaml sethome-multiple: default: 3 vip: 5 staff: 20 ``` > [!TIP] > For the VIP group to claim 5 homes, assign them the permission node `essentials.sethome.multiple.vip` using your permission manager like **[LuckPerms](https://luckperms.net/)**. ### 2. Chat Formatting (Requires EssentialsXChat) Locate the `chat` section to format chat tags and rank prefixes. ```yaml chat: radius: 0 format: '<{DISPLAYNAME}> {MESSAGE}' group-formats: default: '&7[Player] {DISPLAYNAME}&7> &f{MESSAGE}' vip: '&e[VIP] {DISPLAYNAME}&f> &a{MESSAGE}' ``` ### 3. Economy Setup **[EssentialsX](https://essentialsx.net/)** features a built-in currency engine. Adjust default values to match your server's balance. ```yaml starting-balance: 100 currency-symbol: '$' max-money: 10000000 ``` ## Step 3: Essential Commands and Permissions Below is a summary of widely used commands for server admins and players. | Command | Description | Permission Node | |---|---|---| | `/v` or `/vanish` | Toggles administrator invisibility | `essentials.vanish` | | `/fly` | Toggles flight mode | `essentials.fly` | | `/setwarp [name]` | Creates a public warp location | `essentials.setwarp` | | `/warp [name]` | Teleports player to a warp | `essentials.warp` | | `/kit [name]` | Grants a predefined item kit | `essentials.kit.[name]` | | `/ess reload` | Reloads configuration files | Console or Operator | > [!WARNING] > By default, server operators (`/op`) bypass permission checks. For standard players, use a permission plugin like **[LuckPerms](https://luckperms.net/)** to delegate command access securely. ## Step 4: Create and Distribute Kits Kits allow you to give item packages to players, such as starter gear or daily rewards. Define them under the `kits` section in `config.yml`. ```yaml kits: welcome: delay: 86400 items: - diamond_sword 1 - bread 16 - iron_helmet 1 ``` > [!NOTE] > The `delay` value is measured in seconds. In this example, `86400` seconds equals a 24-hour cooldown before the kit can be claimed again. ## Troubleshooting ### ❌ Players cannot use `/spawn` or `/home` - **[EssentialsX](https://essentialsx.net/)** restricts most commands for non-operators by default. - Assign the `essentials.spawn` and `essentials.home` permission nodes to the target group in **[LuckPerms](https://luckperms.net/)**. - Confirm that players are properly assigned to the rank receiving the nodes. ### ❌ Changes to `config.yml` do not take effect - Reload the plugin configuration using `/ess reload`. - Execute the command via the panel console or in-game if logged in as an operator. - Check your YAML syntax: indentation errors prevent configuration files from loading. ### ❌ Other plugins do not detect the economy engine - Install the **[Vault](https://www.curseforge.com/minecraft/bukkit-plugins/vault/files/all?page=1&pageSize=20&showAlphaFiles=hide)** plugin to act as an economy bridge between **[EssentialsX](https://essentialsx.net/)** and external plugins. - Restart the server after uploading **[Vault](https://www.curseforge.com/minecraft/bukkit-plugins/vault/files/all?page=1&pageSize=20&showAlphaFiles=hide)**. - Review server startup logs to ensure **[Vault](https://www.curseforge.com/minecraft/bukkit-plugins/vault/files/all?page=1&pageSize=20&showAlphaFiles=hide)** registers **[EssentialsX](https://essentialsx.net/)** as the economy provider. ## Best Practices - **Create Backups:** Take a full server snapshot via the **Backups** tab on your panel before performing major configuration edits. - **Use Hot Reloads:** Run `/ess reload` after modifying YAML settings rather than restarting the entire server instance. - **Use Granular Permissions:** Manage access control through **[LuckPerms](https://luckperms.net/)** instead of granting full operator privileges (`/op`) to staff members. - **Validate Setup:** Test kits, warps, and permissions in-game using a non-operator test account to verify actual player permissions. ## Need Assistance? If you encounter plugin conflicts, syntax errors, or permission issues that persist after following this guide, our technical support team is ready to help. Submit a support ticket through [support Winheberg](https://billing.winheberg.com/login). Our team will help you review your logs and resolve any setup problems! 🎮