Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

important

This page does not serve as documentation for the plugin. This page contains summaries, clarifications of certain topics, frequently referenced sections, etc. If you are generally looking for information on how to use the plugin, how to set it up, and how it works, you should always refer to the documentation of the plugin.

EssentialsX Plugin

EssentialsX provides a number of often used features such as homes, warps, commands like tpa, god and much more.

Addon plugins

To use the features of EssXSpawn, EssXChat or any other addon plugin, you must first install the addon plugin.

When installing, make sure the version of the addon plugin and EssentialsX is the same. Otherwise, the addon plugin will not work.

Custom translation (messages)

To change messages in EssentialsX, create a messages.properties file in the /plugins/Essentials/ directory and paste the content of the language file you want to use there. Language files can be found here.

After saving the file and loading the changes using ess reload command, the messages from the messages.properties file will be used.

EssentialsX Protect and EssentialsX AntiBuild

If you don’t know why you want to use one of these plugins, don’t install them. EssX Protect and AntiBuild plugins are completely useless for most people (the plugins usually cause unwanted behavior so people usually delete them right away - specifically it disallows actions like block breaking by default).

Configuration

To reflect changes in config, the plugin needs to be reloaded with ess reload command.

Below are the most common configuration issues/topics that are frequently referenced. If you are looking for a specific setting in the config, search (Ctrl + F) for keywords.

How to disable red nicks

Set the value of ops-name-color in config to none.

Unsafe enchantments

If you cannot enchant above standard enchantment levels, enable unsafe-enchantments in config.

How to remove the ‘~’ prefix

Set nickname-prefix in config to an empty value (nickname-prefix: '')

How to enable multiple homes?

Read more here.

How to disable specific EssentialsX command?

There is a disabled-commands section in config where you can disable specific EssentialsX commands.

When I connect, I get a message that I have not received any message (mail)

This is caused by the notify-no-new-mail setting in config.

Player is immortal after teleporting for a few seconds

This is caused by the teleport-invulnerability setting in config.

New players get a kit when they first join

This is caused by the EssentialsXSpawn setting in config, specifically the newbies.kit. If you do not want to give new players any kit, set a blank value for this field (kit: '')