Offer Why us? How it works?
Guide

How to Install EssentialsX: Setup, Commands and Permissions

EssentialsX is the plugin almost every survival server runs: homes, teleport requests, warps, kits, private messages, nicknames and a simple economy in one download. This guide shows how to install EssentialsX and its modules, the commands players use every day, and why regular players can't use /home until you give them permissions.

Updated: 10 min read
Table of contents
  1. What is EssentialsX?
  2. What do you need to run EssentialsX?
  3. How to install EssentialsX on a Spot.gg server
  4. Why can't players use /home or /tpa?
  5. The most important EssentialsX commands
  6. How to set up homes, teleports and spawn
  7. How to make kits and warps
  8. How to show LuckPerms ranks in chat with EssentialsX Chat
  9. Common EssentialsX problems
  10. FAQ
  11. Is EssentialsX free?
  12. What is the difference between Essentials and EssentialsX?
  13. Does EssentialsX need Vault?
  14. How do I let players use /sethome?
  15. How do I give players more homes in EssentialsX?
  16. Does EssentialsX work on Fabric or Forge?
  17. Where is the EssentialsX config?

What is EssentialsX?

EssentialsX is a free plugin for Paper, Purpur and Spigot servers that adds more than a hundred everyday commands – homes, teleport requests, warps, kits, private messages, nicknames, AFK and a basic economy. It's the maintained continuation of the original Essentials plugin, which is why the files and permissions still start with "Essentials".

EssentialsX is split into a core plugin and optional modules. You always need the core; the modules add extra features on top of it.

File What it adds Do you need it?
EssentialsX (core) Homes, /tpa, warps, kits, /msg, nicknames, economy, signs Yes
EssentialsX Chat Chat formatting with prefixes, suffixes and colours If you want ranks in chat
EssentialsX Spawn /spawn, /setspawn, a spawn point for new players Almost always
EssentialsX Discord Bridge between Minecraft chat and a Discord channel Optional
EssentialsX Discord Link Links Minecraft accounts and groups with Discord roles Optional, needs Discord
EssentialsX AntiBuild Per-group build and item restrictions Rarely
EssentialsX Protect World settings like no creeper damage or no fire spread Rarely
EssentialsX GeoIP Shows which country players connect from Rarely

EssentialsX doesn't protect regions – for that, servers use plugins like WorldGuard.

What do you need to run EssentialsX?

A Paper, Purpur or Spigot server, plus LuckPerms for permissions and Vault if you want chat prefixes or other plugins to use the EssentialsX economy.

Plugin Why
EssentialsX The plugin itself
LuckPerms Decides which players can use which commands
Vault (or VaultUnlocked) Lets EssentialsX Chat read LuckPerms prefixes, and lets shop plugins use the EssentialsX economy

EssentialsX doesn't run on Vanilla, Forge, NeoForge or Fabric – those engines can't load plugins. If you're not sure what you're running, see Minecraft server software.

How to install EssentialsX on a Spot.gg server

Open "Addons", search for Essentials, install the EssentialsX core file marked "Compatible with your server" and restart. Modules are separate .jar files that you add next to it.

  1. Use Paper. On Vanilla go to "Information" → "Modify" → "Change engine" and switch to Paper on the same Minecraft version – your world stays.
  2. In "Addons" → "Available to install" search for Essentials and open the entry by EssentialsX.
  3. Install the core file, EssentialsX-<version>.jar, marked "Compatible with your server".
  4. Restart the server when the panel asks. EssentialsX creates plugins/Essentials/ with config.yml and kits.yml.

Adding modules (Spawn, Chat, Discord): in "Addons", the core and every module are listed as versions of the same addon, and installing another file there replaces the one you already have. So install only the core from "Addons", and add modules yourself:

  1. Download the module from the official download page on essentialsx.net – the same version number as your core jar (e.g. EssentialsXSpawn-2.22.0.jar next to EssentialsX-2.22.0.jar).
  2. In "Files" open the plugins folder and upload the module .jar.
  3. Restart the server.

Mixed versions (core 2.21, Spawn 2.22) cause errors, so when you update EssentialsX, update the modules too. Also install LuckPerms from "Addons" now – you'll need it in a minute.

Why can't players use /home or /tpa?

Because EssentialsX commands are for operators only until you give players permissions. You, as OP, can use everything; a normal player who types /sethome gets "You do not have access to that command". This is the most common EssentialsX question, and the fix is a permissions plugin.

Give yourself OP first: in the "Console" type op YourName (no slash in the console). Then give the basic commands to everyone with LuckPerms. Every player is in the default group automatically, so these commands in the console unlock the usual survival set:

lp group default permission set essentials.home true
lp group default permission set essentials.sethome true
lp group default permission set essentials.delhome true
lp group default permission set essentials.tpa true
lp group default permission set essentials.tpaccept true
lp group default permission set essentials.tpdeny true
lp group default permission set essentials.back true
lp group default permission set essentials.spawn true
lp group default permission set essentials.warp true
lp group default permission set essentials.warp.list true
lp group default permission set essentials.kit true
lp group default permission set essentials.kits.tools true
lp group default permission set essentials.msg true
lp group default permission set essentials.r true

The rule is simple: the permission for a command is essentials. plus the command name. Admin commands like essentials.setwarp, essentials.setspawn, essentials.eco or essentials.fly belong in a staff group, not in default.

The most important EssentialsX commands

Players mostly use /sethome, /home, /tpa, /spawn, /warp, /kit and /msg. Here's what each one does and which permission it needs.

Command What it does Permission
/sethome [name] Saves your current spot as a home essentials.sethome
/home [name] Teleports you home (/homes lists them) essentials.home
/delhome <name> Deletes a home essentials.delhome
/tpa <player> Asks to teleport to a player essentials.tpa
/tpahere <player> Asks a player to teleport to you essentials.tpahere
/tpaccept / /tpdeny Accepts or rejects a request essentials.tpaccept / essentials.tpdeny
/back Returns you to where you were before a teleport essentials.back
/spawn Teleports to spawn (Spawn module) essentials.spawn
/warp <name> Teleports to a warp; /warp alone lists them essentials.warp
/kit <name> Gives you a kit; /kit lists available kits essentials.kit + essentials.kits.<name>
/msg <player> <text> Private message (also /tell, /w) essentials.msg
/r <text> Replies to the last message essentials.r
/nick <name> Sets a nickname essentials.nick
/balance, /pay <player> <amount> Shows money, sends money essentials.balance, essentials.pay
/afk Marks you as away essentials.afk
/getpos Shows your coordinates (alias /coords) essentials.getpos

Admin commands:

Command What it does
/setspawn Sets the server spawn where you stand (Spawn module)
/setwarp <name> / /delwarp <name> Creates or deletes a warp
/createkit <name> <delay> Creates a kit from your inventory
/eco give <player> <amount> Gives a player money (also take, set, reset)

How to set up homes, teleports and spawn

Homes: by default a player gets one home. To allow more, EssentialsX uses "home ranks" in plugins/Essentials/config.yml:

sethome-multiple:
  default: 3
  vip: 5
  staff: 10

A player with essentials.sethome.multiple gets the default amount (3). Add essentials.sethome.multiple.vip for 5 homes, or essentials.sethome.multiple.unlimited for no limit. The home ranks don't have to match your LuckPerms group names – they're just labels.

Teleport requests: a /tpa request expires after 120 seconds by default (tpa-accept-cancellation). teleport-delay (warm-up before a teleport) and teleport-cooldown (time between teleports) are both 0 by default – many survival servers set a few seconds to stop players escaping fights with /home.

Spawn: with the Spawn module, stand at your spawn and type /setspawn. New players appear at the newbies spawn point (set it with /setspawn newbies), and the welcome message for first joins is announce-format under newbies in the config. spawn-on-join: false means returning players log in where they left; set it to true to send everyone to spawn on join.

After editing config.yml in "Files", type essentials reload in the console or restart the server.

How to make kits and warps

Kits live in plugins/Essentials/kits.yml. EssentialsX ships with an example kit called tools (stone tools, usable every 10 seconds). The easiest way to make your own:

  1. Put the items you want in your inventory.
  2. Type /createkit starter -1. The number is the delay in seconds; -1 means the kit can be claimed only once.
  3. Give players essentials.kits.starter (and essentials.kit for the command itself).

Warps: stand at a spot and type /setwarp shop. Players with essentials.warp can then use /warp shop. By default every warp is open to everyone with that permission. If you want VIP-only warps, set per-warp-permission: true in the config – each warp then needs its own permission, e.g. essentials.warps.shop.

How to show LuckPerms ranks in chat with EssentialsX Chat

Install EssentialsX Chat and Vault, give your LuckPerms group a prefix and include {DISPLAYNAME} or {PREFIX} in the chat format.

  1. Add EssentialsXChat-<version>.jar (same version as the core) to plugins and install Vault.
  2. Give a group a prefix in LuckPerms: lp group vip meta addprefix 10 "&6[VIP] ".
  3. In plugins/Essentials/config.yml find the chat: section. The default format is '<{DISPLAYNAME}> {MESSAGE}' – {DISPLAYNAME} already includes the prefix and suffix, so the prefix shows up as soon as Vault is installed.
  4. For a custom look, use something like format: '&7{PREFIX}&r {NICKNAME}&7:&r {MESSAGE}'. Don't combine {PREFIX} with {DISPLAYNAME}, or you'll see the prefix twice.

You can also set a different format per group under group-formats. More about prefixes and groups is in How to set up LuckPerms.

EssentialsX Discord connects a Discord channel with the in-game chat. It needs a Discord bot you create yourself; after the first start the module creates its own config in plugins/EssentialsDiscord/ where you put the bot token and channel ID. For a bigger feature set, many servers use DiscordSRV instead.

Common EssentialsX problems

Most problems come from missing permissions, mixed module versions or another plugin using the same command.

Problem Cause Fix
"You do not have access to that command" Player has no permission Give essentials.<command> with LuckPerms
/spawn doesn't exist Spawn module isn't installed Add EssentialsXSpawn with the same version as the core
Errors in the console after an update Core and modules have different versions Update all EssentialsX jars to the same version
Prefix doesn't show in chat No Vault or no EssentialsX Chat Install both and restart
/home opens another plugin's command Two plugins register the same command Use /essentials:home, or remove the other plugin's command in its config
Players don't respawn at their home EssentialsX leaves respawning to the game by default Set respawn-at-home: true (a bed still wins while respawn-at-home-bed is true)
Changes in config.yml do nothing Config wasn't reloaded essentials reload in the console or restart

The full Minecraft command basics (OP, gamemode, whitelist) are in Minecraft server commands.

Paid Minecraft servers on Spot.gg start from $3.90 per month, and a new account can try a server free for 24 hours – enough to install EssentialsX, set a spawn and invite friends.

FAQ

Is EssentialsX free?

Yes. EssentialsX is free and open source. On Spot.gg you install the core from the "Addons" tab at no extra cost.

What is the difference between Essentials and EssentialsX?

EssentialsX is the maintained continuation of the original Essentials plugin for modern Minecraft versions. File names and permissions still use "Essentials".

Does EssentialsX need Vault?

The core works without it. You need Vault for chat prefixes in EssentialsX Chat and for other plugins (shops, jobs) that use the EssentialsX economy.

How do I let players use /sethome?

Give the default group the permissions essentials.sethome and essentials.home, e.g. lp group default permission set essentials.sethome true in the console.

How do I give players more homes in EssentialsX?

Give essentials.sethome.multiple for the default amount (3), plus essentials.sethome.multiple.<rank> for a home rank from sethome-multiple in config.yml, or essentials.sethome.multiple.unlimited.

Does EssentialsX work on Fabric or Forge?

No. EssentialsX is a plugin for Paper, Purpur and Spigot. Fabric and Forge servers use mods for homes and teleports instead.

Where is the EssentialsX config?

In plugins/Essentials/config.yml. Kits are in plugins/Essentials/kits.yml, and player data in plugins/Essentials/userdata/.

Other guides