# How to Install and Configure EssentialsX on Your Minecraft Server (/docs/minecraft/setup-essentialsx)



import { Step, Steps } from 'fumadocs-ui/components/steps';

**EssentialsX** is the de facto standard plugin for Minecraft servers — it adds homes, warps, kits, economy, teleport requests, chat formatting, AFK detection, and over 100 commands. Most Bukkit/Spigot/Paper servers install it on day one because so many other plugins depend on it.

EssentialsX Modules [#essentialsx-modules]

EssentialsX is split into several JARs. You only need the modules you'll actually use.

| Module                   |  Required?  | What it adds                                                        |
| ------------------------ | :---------: | ------------------------------------------------------------------- |
| **EssentialsX**          |    ✅ Yes    | Core commands: homes, warps, kits, economy, `/tpa`, `/back`, `/msg` |
| **EssentialsXChat**      | Recommended | Chat formatting, prefixes, suffixes (needs Vault)                   |
| **EssentialsXSpawn**     | Recommended | `/spawn`, first-join location, respawn handling                     |
| **EssentialsXAntiBuild** |   Optional  | Per-player build permission control                                 |
| **EssentialsXProtect**   |   Optional  | Block/area protection (use WorldGuard instead — better)             |
| **EssentialsXDiscord**   |   Optional  | Discord integration (use DiscordSRV instead — more features)        |
| **EssentialsXGeoIP**     |   Optional  | Country lookup for player IPs                                       |
| **EssentialsXXMPP**      | Rarely used | XMPP chat bridge                                                    |

Install EssentialsX [#install-essentialsx]

<Steps>
  <Step>
    Download EssentialsX [#download-essentialsx]

    Go to [essentialsx.net/downloads.html](https://essentialsx.net/downloads.html) and download the modules you need. The current builds work on Paper, Spigot, and Folia.

    > **Version note:** Always download the build matching your Minecraft version. EssentialsX 2.20+ supports 1.16–1.21+.
  </Step>

  <Step>
    Stop the server [#stop-the-server]

    In the [XGamingServer Panel](https://panel.xgamingserver.com), open **Console** and stop your server.
  </Step>

  <Step>
    Upload to plugins/ [#upload-to-plugins]

    Click **Files** in the sidebar, navigate to `plugins/`, and upload the EssentialsX JARs (one per module).
  </Step>

  <Step>
    Start the server [#start-the-server]

    Start from **Console**. EssentialsX generates `plugins/Essentials/config.yml` and other config files on first run.
  </Step>

  <Step>
    Verify it loaded [#verify-it-loaded]

    Run in Console:

    ```
    plugins
    ```

    `Essentials` should appear in green. If it's red, see the troubleshooting section below.
  </Step>
</Steps>

Configure EssentialsX [#configure-essentialsx]

The main config is `plugins/Essentials/config.yml`. Stop the server before editing.

Economy [#economy]

```yaml
currency-symbol: '$'
starting-balance: 100
worth-item-cap: 1000
min-money: -10000
max-money: 10000000000000
```

Teleportation [#teleportation]

```yaml
teleport-cooldown: 10      # Seconds between /tpa requests
teleport-delay: 3          # Warmup before /tpa completes
teleport-invulnerability: 4
teleport-safety: true      # Push players to safe blocks
```

Homes and Warps [#homes-and-warps]

```yaml
homes:
  default: 3       # Default players get 3 homes
  vip: 10          # VIP rank gets 10 homes
  patron: 25
  staff: 100
```

To make these per-rank limits work, give the matching permission in LuckPerms:

```
lp group vip permission set essentials.sethome.multiple.vip true
```

Spawn-On-Join [#spawn-on-join]

In `plugins/EssentialsSpawn/config.yml`:

```yaml
spawn-on-join: true
respawn-at-spawn: true
```

Chat Formatting [#chat-formatting]

In `plugins/EssentialsChat/config.yml`:

```yaml
format: '{DISPLAYNAME}: {MESSAGE}'
group-formats:
  default: '&7[Member] {DISPLAYNAME}&7: {MESSAGE}'
  vip: '&a[VIP] {DISPLAYNAME}&7: {MESSAGE}'
  admin: '&c[Admin] {DISPLAYNAME}&7: {MESSAGE}'
```

This requires [Vault](/docs/minecraft/setup-vault) and a permissions plugin like [LuckPerms](/docs/minecraft/setup-luckperms).

Essential Commands [#essential-commands]

| Command                  | Permission            | Description                     |
| ------------------------ | --------------------- | ------------------------------- |
| `/sethome [name]`        | `essentials.sethome`  | Set a home                      |
| `/home [name]`           | `essentials.home`     | Teleport to a home              |
| `/delhome [name]`        | `essentials.delhome`  | Delete a home                   |
| `/spawn`                 | `essentials.spawn`    | Teleport to spawn               |
| `/setspawn`              | `essentials.setspawn` | Set the spawn point (admin)     |
| `/tpa <player>`          | `essentials.tpa`      | Request to teleport to a player |
| `/tpaccept`              | `essentials.tpaccept` | Accept a teleport request       |
| `/tpdeny`                | `essentials.tpdeny`   | Deny a teleport request         |
| `/back`                  | `essentials.back`     | Return to last location/death   |
| `/warp <name>`           | `essentials.warp`     | Teleport to a warp              |
| `/setwarp <name>`        | `essentials.setwarp`  | Create a warp (admin)           |
| `/kit [name]`            | `essentials.kit`      | List or claim a kit             |
| `/bal`                   | `essentials.balance`  | Check your balance              |
| `/pay <player> <amount>` | `essentials.pay`      | Send money                      |
| `/msg <player> <text>`   | `essentials.msg`      | Private message                 |
| `/r <text>`              | `essentials.msg`      | Reply to last message           |
| `/afk`                   | `essentials.afk`      | Toggle AFK status               |
| `/tp <player>`           | `essentials.tp`       | Teleport to player (admin)      |
| `/heal`                  | `essentials.heal`     | Heal yourself                   |
| `/feed`                  | `essentials.feed`     | Restore hunger                  |
| `/fly`                   | `essentials.fly`      | Toggle flight                   |
| `/gm <mode>`             | `essentials.gamemode` | Change gamemode                 |

Setting Up Kits [#setting-up-kits]

Edit `plugins/Essentials/kits.yml`:

```yaml
kits:
  starter:
    delay: 0
    items:
    - 1 stone_sword
    - 1 stone_pickaxe
    - 16 bread
    - 64 cobblestone
  daily:
    delay: 86400  # 24 hours in seconds
    items:
    - 1 diamond
    - 5 cooked_beef
```

Players claim with `/kit starter`. Permissions:

```
essentials.kits.starter
essentials.kits.daily
```

Common Issues [#common-issues]

| Problem                                  | Fix                                                                                    |
| ---------------------------------------- | -------------------------------------------------------------------------------------- |
| `Essentials` is red in `/plugins`        | Check Console for the load error — usually a YAML mistake                              |
| Chat formatting doesn't show prefixes    | Install Vault + LuckPerms                                                              |
| Economy commands say "no economy plugin" | Install Vault — EssentialsX provides the economy, Vault hooks it                       |
| `/back` doesn't work                     | Set `essentials.back` permission, or Essentials Spawn isn't loaded                     |
| Players say "you don't have permission"  | EssentialsX uses fine-grained perms — see [LuckPerms](/docs/minecraft/setup-luckperms) |
| Conflicts with another spawn plugin      | Use only one spawn plugin — disable the other                                          |
| Multiple `/home` commands not working    | Set `essentials.sethome.multiple.<group>` permission                                   |

EssentialsX vs Alternatives [#essentialsx-vs-alternatives]

| Feature              | EssentialsX     | CMI   | Alternatives  |
| -------------------- | --------------- | ----- | ------------- |
| Cost                 | Free            | Paid  | —             |
| Homes / warps / kits | ✅               | ✅     | —             |
| Economy              | ✅ (with Vault)  | ✅     | TheNewEconomy |
| Chat formatting      | ✅ (chat module) | ✅     | DeluxeChat    |
| Per-world spawn      | Limited         | ✅     | Multiverse    |
| Web GUI              | ❌               | ✅     | —             |
| Player count         | 1M+ servers     | \~50k | —             |

For most servers, EssentialsX is the right choice — it's free, well-maintained, and has the broadest plugin compatibility.

Common Mistakes [#common-mistakes]

| Mistake                                       | Fix                                              |
| --------------------------------------------- | ------------------------------------------------ |
| Not installing Vault before EssentialsXChat   | Install Vault first, then EssentialsXChat        |
| Editing config while server is running        | Stop server first, edit, then start              |
| Using EssentialsX 2.18 on 1.21                | Always use the version matching your MC version  |
| Mixing EssentialsX with CMI                   | Pick one — they conflict on most commands        |
| Missing `essentials.sethome.multiple.X` perms | Set per-group multiple-home perms in LuckPerms   |
| Forgetting to give `/back` permission         | Default players don't get it — assign explicitly |

Related Guides [#related-guides]

* [Plugin Setup](/docs/minecraft/plugin-setup)
* [Setup LuckPerms](/docs/minecraft/setup-luckperms)
* [Setup Vault](/docs/minecraft/setup-vault)
* [Setup DiscordSRV](/docs/minecraft/setup-discordsrv)
* [Find / Fix YAML Errors](/docs/minecraft/find-fix-yaml-errors)