EssentialsX Setup & Configuration: The Complete Guide

What Is EssentialsX?

EssentialsX is the most comprehensive core plugin for Minecraft servers. It ships more than 130 commands: the teleport system (home, warp, spawn, TPA), economy, chat formatting, kits, nicknames, private messaging and much more. It is the modern, actively maintained fork of Essentials, which has been in development since 2011.

• 130+ built-in commands — no extra plugins needed
• Modular design — install only the parts you actually need
• Active development — Paper, Spigot and Purpur support
• Full compatibility with PlaceholderAPI, LuckPerms and Vault
• Detailed config.yml — every feature can be customised

Installation

Download EssentialsX from the official site or straight from the CI server. Drop the main jar and whichever modules you need into the plugins/ folder.

cd ~/server/plugins

# Main plugin (required)
wget https://ci.ender.zone/job/EssentialsX/lastSuccessfulBuild/artifact/jars/EssentialsX.jar

# Vault (economy and permission bridge — strongly recommended)
wget https://github.com/MilkBowl/Vault/releases/latest/download/Vault.jar

# Modules (optional)
wget https://ci.ender.zone/job/EssentialsX/lastSuccessfulBuild/artifact/jars/EssentialsXChat.jar
wget https://ci.ender.zone/job/EssentialsX/lastSuccessfulBuild/artifact/jars/EssentialsXSpawn.jar
wget https://ci.ender.zone/job/EssentialsX/lastSuccessfulBuild/artifact/jars/EssentialsXAntiBuild.jar
wget https://ci.ender.zone/job/EssentialsX/lastSuccessfulBuild/artifact/jars/EssentialsXGeoIP.jar
wget https://ci.ender.zone/job/EssentialsX/lastSuccessfulBuild/artifact/jars/EssentialsXDiscord.jar
wget https://ci.ender.zone/job/EssentialsX/lastSuccessfulBuild/artifact/jars/EssentialsXProtect.jar

After the first start-up a config.yml will appear in the plugins/Essentials/ folder. Stop the server, edit the config, then start it again.

config.yml in Detail

The heart of EssentialsX is config.yml. It runs to over 800 lines. Below we go through the most critical settings, grouped by category.

Teleport Settings

# config.yml — Teleport section
teleport-cooldown: 3
teleport-delay: 3
teleport-invulnerability: 4
teleport-to-center: true

Economy Settings

# config.yml — Economy section
starting-balance: 1000
max-money: 10000000
min-money: 0
economy-log-enabled: true
currency-symbol: '₺'
currency-symbol-suffix: true

Home Settings

# config.yml — Home section
max-homes: 3
sethome-multiple:
  default: 3
  vip: 5
  admin: 10
world-home-permissions: false

Spawn Settings

Other Important Settings

The Teleport System

The teleport system is the most heavily used part of EssentialsX. It has four main components: Home, Warp, Spawn and TPA.

Home Commands

These manage each player's personal teleport points. The per-group home limit is set in config.yml.

/sethome              # Save the default home
/sethome mine          # Save a named home
/home                  # Teleport to the default home
/home mine             # Teleport to a named home
/delhome mine          # Delete the home
/homes                 # List all homes

Warp Commands

Fixed, server-wide teleport points that everyone (or everyone with the right permission) can use. Ideal for key locations such as the market, arena or farm.

Spawn Commands

TPA (Teleporting to a Player)

This lets players send each other teleport requests. The accept/deny mechanism keeps it safe.

The Economy System

EssentialsX includes a built-in economy engine. Working together with the Vault plugin, it integrates fully with third-party plugins such as ChestShop, ShopGUI+ and Jobs.

Chat Formatting (EssentialsX Chat)

The EssentialsXChat module lets you customise the chat format completely. It is configured from the chat section of config.yml.

# config.yml — Chat section
chat:
  format: '{DISPLAYNAME}&7: &f{MESSAGE}'
  group-formats:
    default: '&7{PREFIX}{DISPLAYNAME}{SUFFIX}&7: &f{MESSAGE}'
    vip: '&a{PREFIX}{DISPLAYNAME}{SUFFIX}&7: &f{MESSAGE}'
    moderator: '&b{PREFIX}{DISPLAYNAME}{SUFFIX}&7: &f{MESSAGE}'
    admin: '&c{PREFIX}{DISPLAYNAME}{SUFFIX}&7: &f{MESSAGE}'

Chat Variables

The Nickname System

This lets players change their display names. With colour code support, coloured nicknames are possible too.

# config.yml — Nickname settings
nick-prefix: '~'              # Character added in front of the nickname (can be left empty)
change-displayname: true      # Replace the display name with the nickname
nick-color: true              # Allow the use of colour codes
max-nick-length: 20           # Maximum nickname length

The Kit System

You can define ready-made item sets and hand them out to players at set intervals. Kits are defined inside config.yml.

# config.yml — Kits section
kits:
  starter:
    delay: 86400            # 24 hour cooldown
    items:
      - stone_sword 1
      - iron_pickaxe 1
      - bread 16
      - oak_log 32
  vipkit:
    delay: 43200            # 12 hour cooldown
    items:
      - diamond_sword 1 sharpness:2
      - diamond_pickaxe 1 efficiency:3
      - golden_apple 8
      - diamond 16
  miner:
    delay: 3600             # 1 hour cooldown
    items:
      - iron_pickaxe 1 efficiency:4 unbreaking:3
      - torch 64
      - bread 16

EssentialsX Modules

EssentialsX has a modular structure. Alongside the main jar, you can install whichever modules you need one by one:

Setting Up EssentialsX Discord

The EssentialsX Discord module carries Minecraft chat into a Discord channel and Discord messages back into the game.

• Create a new bot from the Discord Developer Portal
• Get the bot token and paste it into plugins/Essentials/config.yml
• Invite the bot to your server (the MESSAGE_CONTENT intent must be enabled)
• Edit the discord section in the config: enter your channel IDs

# config.yml — Discord section (simplified)
discord:
  token: 'YOUR_BOT_TOKEN_HERE'
  guild: '123456789012345678'
  channels:
    primary: '123456789012345678'
  staff:
    channel: '123456789012345679'
  console:
    channel: '123456789012345680'

Permissions Table

The most frequently used EssentialsX permissions. Assign them to groups with LuckPerms:

Translating the Messages

EssentialsX keeps its messages in plugins/Essentials/messages.properties. To run the plugin in another language — Turkish, for example:

# config.yml
locale: 'tr'

This setting generates a messages_tr.properties file automatically. You can edit any message inside it. Community translations are available as well.

Common Mistakes and How to Fix Them

Useful Resources