EssentialsX Setup: Homes, Warps, Kits and Permissions on Paper

This guide is for Minecraft server owners setting up EssentialsX on Paper. By the end, you will know which modules to install, how to set home limits and kits, and which permission nodes to assign with LuckPerms.

EssentialsX Free A free, open source suite of core server commands for Paper and Spigot, with optional chat, spawn and protection modules. On Modrinth

Check EssentialsX support before updating#

EssentialsX is a suite of utility, social and economy commands for Paper and Spigot. Its 2.22.0 release, dated 31 May 2026, lists Minecraft 26.1.2 as actively supported and 1.21.11 as supported. Older versions back to 1.8.8 have lower priority. The release fixes item duplication and server crash exploits, and its developers advise all users to upgrade.

The release information does not list Minecraft 26.2 or 26.3. If your server runs one of those Paper versions, test EssentialsX on a copy before updating the live server. Paper's 26.3 news also warns that a world upgraded to 26.3 cannot be downgraded, so make a backup before trying it.

When you update, keep every EssentialsX module on the same version. Back up the plugins/Essentials/ folder first, and keep a separate server backup if you are changing Minecraft versions.

For more on Paper version changes, see our Paper update checklist.

Install the core jar and only the modules you need#

The EssentialsX wiki recommends Paper over Spigot for Minecraft 1.13 and newer. The main EssentialsX jar provides the core commands, signs, kits and economy features. Other jars add optional functions:

• EssentialsX-Spawn: controls where players spawn on first join and after death, and adds spawn controls.
• EssentialsX-Chat: formats chat using group prefixes, suffixes and colours.
• EssentialsX-Protect: controls certain mob spawns and protections such as creeper damage and fire spread.
• EssentialsX-AntiBuild: controls who can build, interact or craft through permissions.
• EssentialsX-Discord: adds a lightweight chat bridge, console relay and slash commands.
• EssentialsX-Discord-Link: syncs in-game groups with Discord roles.
• EssentialsX-GeoIP: shows admins an approximate player location at login or with /whois.
• EssentialsX-XMPP: provides a legacy Jabber bridge.

Download the jars from an official EssentialsX source, unzip the download if needed, and put the main jar plus any chosen modules in the server's plugins folder. Restart the server to generate the configuration files.

How to Install & Configure the EssentialsX Plugin for Minecraft (Guide) Apex Hosting

The video is a general installation walkthrough. Use the version guidance above when deciding which build to run.

Connect Vault and LuckPerms for rank features#

Use LuckPerms to create ranks and manage permission nodes. EssentialsX's wiki says Vault is needed for EssentialsX to read permissions, prefixes, suffixes and group information. Vault is an API that gives plugins hooks into permissions, chat and economy systems. It is not required for EssentialsX's basic commands, but without it the group-related features described by the wiki will not work.

LuckPerms Free A free permissions plugin for assigning EssentialsX permission nodes to ranks. On SpigotMC

Vault A permissions, chat and economy API that lets EssentialsX read ranks, prefixes and suffixes from a permissions plugin. On SpigotMC

Install Vault and LuckPerms using their project instructions, then assign EssentialsX permission nodes to the appropriate groups. For example, essentials.home lets a player use /home, while essentials.sethome lets them set a home. The EssentialsX permission reference lists nodes, and our LuckPerms ranks guide explains rank inheritance and promotions. Check the node for each command instead of granting broad permissions by habit.

Vault's listed release is older, so check your server copy for compatibility before enabling it on a live network.

Set home limits for each rank#

EssentialsX creates config.yml in plugins/Essentials/. Its sethome-multiple section controls how many homes each home rank can set. The shipped limits are default: 3, vip: 5 and staff: 10. Change the values to match your rank names and the limits you want.

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

Players need essentials.sethome.multiple to have more than one home. Then grant essentials.sethome.multiple.<rank> for the matching limit, such as essentials.sethome.multiple.vip. The essentials.sethome.multiple.unlimited node gives unlimited homes, so reserve it for groups that should have no limit.

After editing config.yml, save it and restart the server so the settings load. Use the following panel or machine steps for file changes and restarts.

Create kits with a cooldown#

Kits are stored in kits.yml. Each kit has a delay in seconds and an items list. Add an item name and quantity for each item. The example below defines a kit with a 1,000-second cooldown:

kits:
  starter:
    delay: 1000
    items:
      - stone 1
      - apple 1

A delay of -1 makes a kit one-time only. The file also supports item enchantments and metadata. Kits can include commands as entries, but review any command rewards carefully before making them available to players.

Staff with essentials.createkit can create a kit in game with /createkit <kitname> <delay>, then inspect it with /showkit <kitname>. Editing kits.yml is useful for reviewing the full kit definition before the server opens.

To edit the file, stop the server, change plugins/Essentials/kits.yml, save, and restart. Follow the same VPS, Pterodactyl File Manager and Multicraft Files / FTP tabs above.

Configure warps and teleport behavior#

Players need essentials.warp to use /warp and essentials.setwarp to create a warp with /setwarp. To give access to selected warps only, enable per-warp-permission in config.yml. Each warp then needs a matching node in the form essentials.warps.<name>. Leave that setting disabled if every player with essentials.warp should be able to use all warps.

EssentialsX also has teleport-cooldown and teleport-delay settings. Both are 0 by default. The cooldown sets the time between teleport commands; the delay makes a player wait before teleporting, and movement or damage cancels that wait. The default teleport-safety setting is true, which moves an unsafe destination to a nearby safe spot.

Change these values in plugins/Essentials/config.yml, then restart to apply them. Use the panel tabs above when editing files or restarting. For spawn behavior, install EssentialsX-Spawn and use its spawn controls, including /setspawn.

Check the result before opening the server#

• Confirm all EssentialsX module jars have the same version.
• Test each command with a player in the rank that should receive access.
• Check that each home limit matches the rank name in sethome-multiple.
• Try a warp both with and without its per-warp permission, if that setting is enabled.
• Review kit contents and cooldowns, then check the console after restarting.

For a Minecraft version newer than the version listed for EssentialsX 2.22.0, complete these checks on a copy first. Keep a backup that you can restore if the plugin or world behaves differently than expected.