How to set up EssentialsX: homes, warps, kits and teleports
EssentialsX is the plugin that gives a Minecraft server its everyday commands: setting homes, teleporting to friends, warps, kits, a spawn point and a simple economy. Most community servers run it, so players already know the commands. This guide covers installing it, the modules worth having, the settings you will actually change, and the permission setup that stops it being abused.
What is in the package
EssentialsX is released as a set of separate files. You always need the core, and the others are optional:
- EssentialsX is the core: homes, teleport requests, kits, economy, nicknames, messaging and much more.
- EssentialsX Chat formats chat and can show ranks and prefixes.
- EssentialsX Spawn adds a proper spawn point and the
/spawncommand, including sending new players there. - EssentialsX AntiBuild can restrict which blocks or items people may use.
- EssentialsX GeoIP and others exist for niche needs.
Start with the core and Spawn, then add others only when you need them. Each extra plugin is one more thing to update and troubleshoot.
Install it
- Stop the server and take a backup.
- Upload the EssentialsX
.jarfiles intoplugins, using the file manager. - Start the server. A folder called
Essentialsappears with aconfig.ymland auserdatafolder. - Read the console. Errors on first start usually mean the plugin was built for a different Minecraft version.
If you are unsure whether your server software supports plugins at all, see Paper, Purpur, Fabric, Forge or Vanilla.
Commands your players will use
| Command | What it does |
|---|---|
/sethome and /home | Save a location and return to it |
/tpa name and /tpaccept | Ask to teleport to someone, and accept requests |
/spawn | Go to the spawn point (with the Spawn module) |
/warp name | Travel to a named public location |
/kit name | Claim a starter kit, with a cooldown |
/msg name text | Send a private message |
/back | Return to the last location before a teleport or death |
Operators also get /setwarp, /delwarp, /setspawn, /give, /heal, /fly and many more, each gated behind its own permission.
The settings worth changing
Open plugins/Essentials/config.yml. It is long and well commented, so you can read what each line does. These are the ones most servers adjust:
sethome-multiple: how many homes each group may have. The default group is usually given one, and you can raise it for trusted ranks.teleport-cooldownandteleport-delay: a cooldown stops teleport spam, and a delay (where moving cancels the teleport) stops players using it to escape fights.starting-balanceand the economy section: set how much money new players begin with, if you use the economy.motdandops-name-color: cosmetic touches.- Command cooldowns: any command can be given a cooldown, which keeps kits fair.
After editing, run /essentials reload or restart. Restarting is safer for big changes.
Creating kits
Kits are defined in kits.yml. A starter kit lists items with amounts, and a delay in seconds before it can be claimed again. Give each kit a permission, like essentials.kits.starter, so that you control who gets which kit. A one-time kit, such as a welcome pack, uses a very long delay or a negative one to mean "once".
Permissions: the part that matters
By default, EssentialsX gives almost nothing to ordinary players. You grant commands through a permissions plugin, and without one only operators can use most of it. How to set up LuckPerms ranks and permissions shows how.
A good default group gets homes, teleport requests, /spawn, /msg and a starter kit. Keep teleporting to other players, flying, healing and item commands for staff. Avoid giving out essentials.*, which is every permission at once.
The economy
EssentialsX includes a basic economy with /balance, /pay and /baltop. If you want shops, jobs or other plugins that use money, install Vault, which acts as a bridge between your economy and the plugins that need it. Mixed economies are a common source of confusion, so pick one economy plugin and keep to it.
Troubleshooting
- Commands do nothing, or another plugin answers. Two plugins can claim the same command, such as
/home. Use/essentialsand the console to see which wins, or prefix the command withessentials:. - "You do not have permission". Check the player's groups with
/lp user Name info, and use verbose mode as described in the LuckPerms guide. - Data lost after a version change. Player data lives in
plugins/Essentials/userdata. Back it up before updates.
For anything that is not working, the console shows the cause first. How to read your server logs explains how to find it.
Still stuck? Open a ticket on Discord - run /ticket in any channel, pick a department, and include your Server ID or Invoice ID so we can jump straight in.