Set up EssentialsX on your Minecraft server: homes, warps, kits and /tpa

Every module must have exactly the same version as the core. Mixing versions stops the modules from loading.

1. Make sure the server runs Paper or Purpur. Fabric and Forge cannot run plugins.
2. Open the Plugins tab and type EssentialsX in Search plugins under Plugin catalog.
3. Install EssentialsX. Install EssentialsX Spawn too if you want /spawn.
4. Restart the server.
5. Type essentials version in the Console. It replies with the version, which shows the plugin is running.

Modules that are not in the catalog, such as EssentialsX Chat, can be uploaded by hand to the plugins folder in the Files tab. Take them from the same release as the core. Install plugins covers uploading.

How many homes a player may have is set in config.yml:

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

A player gets the number of a line through the permission essentials.sethome.multiple.vip, with the name of the line at the end. Players without one of those permissions get the default number.

• /setwarp shop saves your position as a warp called shop. Only staff should have this.
• /warp shop teleports to it. /warp on its own lists the warps.
• /delwarp shop removes it.

Give players essentials.warp to use warps and essentials.warp.list to see the list. To limit some warps to some players, set per-warp-permission: true in config.yml; a player then needs essentials.warps.shop for the warp called shop.

Two lines in config.yml decide how teleports feel:

• teleport-delay is the number of seconds a player must stand still before a teleport happens. 3 stops players from teleporting out of a fight.
• teleport-cooldown is the number of seconds between two teleports.
• tpa-accept-cancellation is how many seconds a request stays open; 120 by default.

/back after death needs the permission essentials.back.ondeath as well. On a hardcore or survival server you may want to leave that one out.

Kits live in plugins/Essentials/kits.yml. The quickest way to make one is in the game:

1. Put the items for the kit in your inventory.
2. Type /createkit starter 86400. The number is the delay in seconds before a player can take the kit again; 86400 is one day.
3. Players with essentials.kit and essentials.kits.starter can now type /kit starter.

To give the kit to every new player on their first join, set it under newbies in config.yml:

newbies:
  kit: starter

Run /essentials reload after editing config.yml or kits.yml, or restart the server.

1. Stand where players should arrive and type /setspawn.
2. Give players essentials.spawn so they can type /spawn.
3. To send every player to spawn when they join, set spawn-on-join: true in config.yml.
4. To let players respawn at their home instead of spawn after dying, set respawn-at-home: true.

For a separate arrival spot for first-time players, stand there and type /setspawn newbies. The newbies section of config.yml has spawnpoint: newbies, which sends new players to that spot.

Without permissions, most EssentialsX commands work for operators only. Give the default group the basic set in the Console:

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.warp true
lp group default permission set essentials.warp.list 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

Staff ranks, moderation commands and temporary ranks are explained in permissions with LuckPerms. Avoid giving players essentials.*: it includes commands such as /give, /gamemode and /sudo.

Edit the file in the Files tab under plugins/Essentials. YAML uses spaces, not tabs, and a wrong indent stops the file from loading. Make a backup in the Backups tab before larger changes.