Configuration

admin.enabled

Enables the admin module.

true or false

true

chat.enabled

Enables the chat module.

true or false

true

chat.manage-chat

Can Essence manage the server's chat? When set to false, /nick is disabled.

true or false

true

chat.name-format

The format that chat messages should appear in. Supports Placeholders

String.

"%essence_combined_prefix% %essence_player%%essence_player_suffix%:"

chat.allow-message-formatting

Should Essence process formatting codes (& codes) in chat messages?

true or false

false

chat.broadcasts.first-join

The message broadcast in chat when a player joins for the first time. Supports Placeholders.

String.

"§a{} joined the server for the first time!"

chat.broadcasts.join

The message broadcast in chat when a player joins. Supports Placeholders.

String.

"§e{} joined the server!"

chat.broadcasts.leave

The message broadcast in chat when a player leaves. Supports Placeholders.

String.

"§c{} left the server!"

chat.motd

A message displayed to players in chat when they log in. Supports Placeholders. Set to 'false' to disable.

Multi-line string.

See example below.

economy.enabled

Enables the economy module.

true or false

true

economy.mode

This is the mode that Essence will run its economy in. Most players should not change this. This config value is useful if you'd like to use another economy provider or to disable Essence's economy altogether. See the economy page for more information.

'VAULT' default mode - sets up Essence as the server's economy provider.

'ESSENCE' Tells Essence to keep its economy to itself.

To disable economy use economy.enabled.

'VAULT'

economy.start-money

This is the amount of money players get when they first join the server. It should be a decimal number (e.g. 100.0, 40.99, 0.0)

Any decimal number

100.0

economy.symbol

This value will be displayed in front of any monetary values shown in chat. Whilst we recommend sticking with standard symbols you can put anything here, such as "Coins" or whatever really.

Anything

$

environment.enabled

Enables the environment module.

true or false

true

gamemode.enabled

Enables the gamemode module.

true or false

true

inventory.enabled

Enables the inventory module.

true or false

true

kit.enabled

Enables the kit module.

true or false

true

kit.spawn-kits

A list of kits the player should be given when they first join the server. Set to false to disable. Players must have the required permissions to access the kits. Learn more about kits.

Any list of valid kits.

See example below.

stats.enabled

Enables the stats module.

true or false

true

team.enabled

Enables the team module.

true or false

true

teleportation.enabled

Enables the teleportation module.

true or false

true

teleportation.back.wait

The amount of time (in seconds) the player should have to wait for after sending the command before they're teleported. To disable this feature set this value to 0.

Integer

3

teleportation.top.wait

The amount of time (in seconds) the player should have to wait for after sending the command before they're teleported. To disable this feature set this value to 0.

Integer

3

teleportation.bottom.wait

The amount of time (in seconds) the player should have to wait for after sending the command before they're teleported. To disable this feature set this value to 0.

Integer

3

teleportation.home.wait

The amount of time (in seconds) the player should have to wait for after sending the command before they're teleported. To disable this feature set this value to 0.

Integer

3

teleportation.home.cooldown

The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0.

Integer

10

teleportation.warp.wait

The amount of time (in seconds) the player should have to wait for after sending the command before they're teleported. To disable this feature set this value to 0.

Integer

3

teleportation.warp.cooldown

The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0.

Integer

10

teleportation.randomtp.cooldown

The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0.

Integer

10

teleportation.spawn.wait

The amount of time (in seconds) the player should have to wait for after sending the command before they're teleported. To disable this feature set this value to 0.

Integer

3

teleportation.spawn.cooldown

The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0.

Integer

10

teleportation.spawn.global-spawn.enabled

Should the spawn be global? (e.g. a single spawn for all worlds within a single world). See Global Spawn / Lobby World.

Any valid world name.

world

teleportation.spawn.global-spawn.world

Sets the world that should be used as the global spawn. This can cause issues if you're using non-loaded world - learn more.

Any valid world name.

world

teleportation.spawn.force-spawn.on-join

Should players be sent to the main world's spawnpoint every time they join the server?

true or false

false

teleportation.spawn.force-spawn.on-death

Should players be sent to the main world's spawnpoint every time they die?

true or false

false

teleportation.requests.cooldown

The amount of time (in seconds) the player should have to wait for to teleport since they last teleported. To disable this feature set this value to 0.

Integer

10

teleportation.requests.default-enabled

Should teleportation requests be enabled by default for all users. This can be changed per-user using /tptoggle (permissions required).

true or false

true

teleportation.extended-toggle

Should teleportation toggling also apply to the standard /teleport /tp commands? Not recommended.

true or false

false

teleportation.move-to-cancel

Should player movement cancel teleportation?

true or false

true

language

This sets the language file that Essence will use for chat messages. Console log messages are not affected by this and are hard-coded. For more information please see Language Files.

Any valid language code with an existing file.

en-gb

disabled-commands

This disables processing of certain commands in Essence, to add commands to the list you should create a new line and follow the format of the example. Please note: this does have limitations - for more information please see Disabling Commands.

List of commands to disable (or blank).

See example below.

item-blacklist

This disables processing of certain items in Essence, to add items to the list you should create a new line and follow the format of the example.

List of items to blacklist (or blank).

See example below.

advanced.playerdata.store-ip-address

Decides if Essence should store player IP addresses in data files.

true or false

true

advanced.update-check

This value defines if Essence should check for updates during startup. If this is enabled, the plugin will query LewMC Services to check for updates. The doesn't collect any data about you or your server.

true or false

true

advanced.verbose

Outputs additional information to the console, including file information. You should only enable this if you're having problems. Warning: Creates a LOT of console spam.

true or false

false

config-version

Please don't change this! It can mess with Essence's configuration updater, and if we change anything you'll be in for a whole load of red text in your server console.

Do not change this value, it can mess up the config in later versions!

3