EssentialsX is one of the most popular plugins for Paper and Spigot servers. It adds over 130 commands that players expect to have on a multiplayer server, including homes, warps, teleport requests, kits, private messaging, and more. If you are setting up a new server, this is usually one of the first plugins you will want to install.
What EssentialsX Adds
Once installed, your players will be able to:
- Set and teleport to homes (
/sethome,/home) - Teleport to other players (
/tpa) - Use warps (
/warp) and spawn (/spawn) - Send private messages (
/msg) - Claim kits (
/kit) - Return to their previous location (
/back) - And much more
Installing EssentialsX
EssentialsX is actually a set of modules, each distributed as a separate .jar file. You only need to install the ones you want to use.
Which Modules to Install
For most beginners, we recommend:
- EssentialsX (required) - the core plugin with all the main commands
- EssentialsXSpawn (recommended) - adds
/spawnand/setspawn - EssentialsXChat (recommended if using LuckPerms) - adds chat formatting with prefixes
Warning: Do not install EssentialsXAntiBuild unless you specifically want it. It prevents players from building and breaking blocks unless they have the correct permissions, and catches many beginners out.
Installing Through the Plugin Installer
The easiest way to install EssentialsX is through the built-in Plugin Installer in the Game Panel:
- Log in to the Game Panel
- Select your server
- In the left menu, click Game then Plugins
- Search for EssentialsX and install each of the modules you want
- Restart your server
Alternatively, you can download the modules manually from essentialsx.net/downloads.html or Modrinth and upload the .jar files to your plugins folder using the File Manager.
When the server starts up, EssentialsX will create a plugins/Essentials/ folder containing its configuration files.
Essential Commands for Players
Here are the most common commands your players will use:
Homes
/sethome [name]- Save your current location as a home/home [name]- Teleport to a saved home/delhome <name>- Delete a home
Teleporting
/tpa <player>- Ask to teleport to another player/tpahere <player>- Ask another player to teleport to you/tpaccept- Accept an incoming teleport request/tpdeny- Deny an incoming teleport request/back- Return to your previous location (works after dying)
Spawn and Warps
/spawn- Teleport to the server spawn/warp [name]- Teleport to a warp, or list all warps/setwarp <name>- Create a warp at your current location (admin)/setspawn- Set the server spawn at your current location (admin)
Other Useful Commands
/msg <player> <message>- Send a private message/r <message>- Reply to the last private message/kit [name]- Claim a kit/list- See who is online/afk- Toggle AFK status
Setting Up Permissions
EssentialsX uses permission nodes to control who can use which commands. If you are using LuckPerms (which we recommend), you can assign these to groups. See Setting Up Permissions with LuckPerms for help with LuckPerms.
Common Permissions for Regular Players
essentials.help
essentials.spawn
essentials.home
essentials.sethome
essentials.delhome
essentials.tpa
essentials.tpaccept
essentials.tpdeny
essentials.back
essentials.msg
essentials.warp
essentials.kit
essentials.afk
essentials.listAllowing Multiple Homes
By default, players can only set one home. To let them set more, give them essentials.sethome.multiple. You can also create tiers in the config file - for example, VIP players could have more homes than regular players.
Per-Kit Permissions
Each kit needs its own permission node in the format essentials.kits.<kitname>. For example, a kit named "starter" would need essentials.kits.starter.
The Wildcard Permission
You can grant all EssentialsX commands with essentials.*. Only give this to trusted admins, as it includes dangerous commands like /ban, /eco, and /god.
Common Configuration Changes
The main config file is plugins/Essentials/config.yml. Here are some settings beginners often want to change:
starting-balance- How much money new players start with (requires Vault)spawn-on-join- Set totrueto teleport players to spawn when they log inteleport-cooldown- Seconds a player must wait between teleportsteleport-delay- Seconds a player must stand still before a teleport happenssethome-multiple- Controls home limits for different groups
After editing the config, restart your server for the changes to take effect.
Chat Formatting with LuckPerms
If you have installed EssentialsXChat and LuckPerms, you can show group prefixes in chat.
- Install Vault and EssentialsXChat (in addition to EssentialsX and LuckPerms)
- Set up your group prefixes in LuckPerms (see our LuckPerms guide)
- Open
plugins/Essentials/config.ymland find thechatsection - Set the chat format to include
{PREFIX}:
chat:
format: '{PREFIX}{DISPLAYNAME}{SUFFIX}&r: {MESSAGE}'- Restart your server
Your prefixes from LuckPerms should now appear next to player names in chat.
Economy
EssentialsX includes a built-in economy system with commands like /balance, /pay, and /eco. If you want other economy-related plugins (like shops) to work with it, you also need to install Vault. Vault acts as a bridge that lets other plugins talk to the EssentialsX economy.
Common Issues
Players Cannot Break or Place Blocks
This is almost always caused by having EssentialsXAntiBuild installed. Remove the EssentialsXAntiBuild.jar from your plugins folder and restart your server.
Home or Warp Commands Are Not Working
Other plugins (like CMI or Multiverse) may register the same commands. Check your console for conflicts, or use the full command name like /essentials:home to force EssentialsX to handle it.
Players Only Have One Home
You need to give them the essentials.sethome.multiple permission as well as essentials.sethome. You can also adjust the limits in config.yml under the sethome-multiple section.
Chat Prefixes Are Not Showing
Make sure you have installed all of these: EssentialsX, EssentialsXChat, LuckPerms, and Vault. All four are required for chat prefixes to work. Also check that you have set prefixes on your groups in LuckPerms and updated the chat format in the EssentialsX config.
Spawn Command Takes Players to the Wrong Location
If you have not run /setspawn at your desired spawn location, EssentialsX uses the world's default spawn point, which is often a random location. Stand where you want the spawn to be and run /setspawn.
Having Trouble Setting Up EssentialsX?
Feel free to reach out to us and we can help:
- Support Ticket
- Discord Server - use the
/supportcommand - Email: [email protected]