NewSchokr 13 is here. A whole new UI, seven locations, snapshots and more. Read more →

EssentialsX basics: homes, warps, spawn and kits

Set up EssentialsX on a Paper server: which modules to install, key commands, permissions for players, home limits and the built-in economy.

Updated · 2 min read

EssentialsX adds the everyday commands most servers want: homes, warps, spawn, teleport requests, kits, private messages and nicknames. It is split into modules, so you install the core plus only the extras you need.

Which jars to install

ModuleNeeded?What it adds
EssentialsXYesCore commands, homes, warps, kits, economy.
EssentialsX ChatOptionalChat formatting and group prefixes.
EssentialsX SpawnOptional/spawn, /setspawn and where new players appear.
EssentialsX DiscordOptionalRelays chat to a Discord channel.
Others (AntiBuild, GeoIP, Protect, XMPP)RarelyNiche features. Skip unless you need them.

All modules must be the same version. Upload the jars to plugins and restart. Install Vault and LuckPerms too if you want prefixes and per-group permissions.

Everyday commands

CommandWhat it does
/sethome [name] and /home [name]Save and return to a home.
/setwarp name and /warp nameCreate and use server warps.
/setspawn and /spawnSet and go to spawn (Spawn module).
/tpa player, /tpaccept, /tpdenyTeleport requests between players.
/msg player text and /rPrivate messages and replies.
/kit nameClaim a kit.
/nick nameChange display name.
/bal, /pay player amountEconomy.

Operators can use everything. Regular players need permissions.

Give players permissions

With LuckPerms, add the basic nodes to the default group:

/lp group default permission set essentials.home true
/lp group default permission set essentials.sethome true
/lp group default permission set essentials.spawn true
/lp group default permission set essentials.tpa true
/lp group default permission set essentials.tpaccept true
/lp group default permission set essentials.warp true
/lp group default permission set essentials.msg true
/lp group default permission set essentials.balance true
/lp group default permission set essentials.pay true

See LuckPerms basics for groups and ranks.

Limit homes per rank

In plugins/Essentials/config.yml, find sethome-multiple:

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

Players get the default amount. Give a group the node essentials.sethome.multiple.vip to grant the vip limit, and so on.

Kits

Hold the items you want in your inventory and run:

/createkit starter 86400

The number is the cooldown in seconds (here, one day). Players need essentials.kits.starter to use it. Kits are saved in plugins/Essentials/kits.yml.

Economy

EssentialsX includes a simple economy. Player balances are stored in their user files. With Vault installed, shop and job plugins can use it. Admins can manage money with:

/eco give Steve 500
/eco take Steve 100
/eco set Steve 1000

The starting balance is starting-balance in config.yml.

Applying config changes

After editing config.yml, run /essentials reload or restart the server. Avoid the server-wide /reload.