Skip to content

Home

Jump to bottom
Lax edited this page Mar 8, 2018 · 99 revisions

EssentialsX wiki!

EssentialsX is a fork of Essentials. Most commands and permissions work the same way. Old Essentials files are compatible with EssentialsX and are optimized further than the original.

For original permissions: http://wiki.mc-ess.net/wiki/Command_Reference/Perm

For original commands: http://wiki.mc-ess.net/wiki/Command_Reference

Note: You need to update all Essentials modules to the same version of EssentialsX to prevent version mismatch errors. You can find the latest version at the build server. In addition, you may want to update your config file - the latest config file can always be found here.

Pages

Improvements over Essentials and Spigot Essentials

  • Actively maintained and updated for the latest Spigot and Minecraft versions at all times, retaining support going back to 1.8.
  • Support for updated enchantments, mobs, items and tree types.
  • Has buy/trade sign support for Minecraft 1.9.
  • Support for Banner Metadata and Command Cooldowns.
  • Configuration option to not send no new mail notification on join.
  • Allow commands in kits and use {player} to replace with player's name.
  • Fixed mob spawner support. This means you can use spawner signs and commands such as /i mob_spawner:51, and the spawners won't be pigs when placed.
  • Fixes giving spawner eggs with entity ID values and potions with damage values in 1.9.
  • Fixes sending and receiving money with EssentialsEco.
  • Uses UUID-backed Vault for permissions group and prefix/suffix lookups. This results in better performance due to not needing a name-to-UUID conversion. Spigot-Essentials implements UUID lookups for zPermissions, but not other permissions plugins. Because EssentialsX prioritizes Vault, all queries using the Vault handler should be much faster.
  • /tppos can now optionally accept a world name.
  • The /msgtoggle command allows people to ignore all private messages with permission: essentials.msgtoggle
  • Separate permissions for bulk sell and hand sell
    • essentials.sell.hand
    • essentials.sell.bulk
  • Adds a permission for exemption from SocialSpy: essentials.chat.spy.exempt
  • Adds configuration option for the milk bucket "easter egg", which (really shouldn't, but does) allow players to mess with other people's horses: milk-bucket-easter-egg
  • Adds configuration option for the "Set fly mode enabled..." message on join: send-fly-enable-on-join

Per-gamemode permissions

Permissions have been added for each gamemode with the EssentialsX /gamemode command, meaning that if desired, players may run /gma and /gms, but not /gmc or /gmsp. You need to give the player essentials.gamemode to use the /gm command, then whichever gamemodes you want them to be able to change to:

  • essentials.gamemode.creative
  • essentials.gamemode.survival
  • essentials.gamemode.adventure
  • essentials.gamemode.spectator
  • essentials.gamemode.all

Note: essentials.gamemode is still required to execute the /gamemode (and its aliases) command.

Kits changes

Kits have been moved from the main config to kits.yml. This means that kits can be created from in-game and automatically added to your server without needing to manually edit the config, while also retaining all the comments in config.yml.

In addition, commands are now supported in kits - simply add a line to your kit as follows:

kits:
  mykit:
    delay: 1000
    items:
      - 272 1
      - /give {player} apple 1

You can also include {player}, which will be substituted for the player's name.

/showkit

Command: /showkit <kitname>
Permission: essentials.showkit
Shows a list of kit contents straight from config file.
showkit

/createkit

Command: /createkit <kitname> <delay>
Permission: essentials.createkit
If pastebin-createkit is set to false, creates a kit from your inventory and puts it in the kits.yml file.
If pastebin-createkit is set to true, creates a kit based on your inventory and returns a link to the file to add to your kits.yml.
createkit

Forcefully disable teleportation safety

Upstream Essentials only has two values for the teleport-safety option:

  • Convert locations to safe teleports (results in plenty of exploits); or
  • Deny the teleport entirely.

EssentialsX adds a force-disable-teleport-safety option (defaulting to false), that when combined with teleport-safety: true, disables conversion to safe locations and teleports the user to their exact location.

Note: To disable cross-world teleportation safety, switch to PaperSpigot and set disable-teleportation-suffocation-check to true in paper.yml.

Spawner placement fix

If your placed spawners are still pig spawners, assign essentials.spawnerconvert.* to your default group.

Controlled Private Messaging

This feature was added in build 210.

There is a configurable feature you may set called last-message-reply-recipient. If set to true, your reply recipient will be whoever you messaged last and not whoever messaged you last, unless you don't have a reply recipient, in which case whoever messaged you last will be your reply recipient.

Here's a formatted scenario of the new last-message-reply-recipient feature:

SupaHam: /msg Kakifrucht Hi

SupaHam -> Kakifrucht: Hi

Kakifrucht: /r Hi

Kakifrucht -> SupaHam: Hi

EvilOlaf: /msg Kakifrucht Hi

EvilOlaf -> Kakifrucht: Hi

Kakifrucht: /r Hi back to you, SupaHam!

Kakifrucht -> SupaHam: Hi back to you, SupaHam!

If this feature is enabled, EssentialsX will take into account the last-message-reply-recipient-timeout setting. This setting allows you to configure the duration, in seconds, that the reply-recipient will not change, when receiving replies. If after this duration the recipient receives a message, the recipient's replies will start going to the latest message sender.

/seen by UUID

This feature was added in build 241 (2e903ac).

Typing /seen SupaHam and /seen 5552e21d-de79-40bc-89da-62ee63244fb2 are now both valid methods of checking when a player was last seen.

Per-world /time setting permission

This feature was added in build 250 (eb924b9).

Note: As of build 262 (c6d2746), this feature can now be enabled by setting the world-time-permissions config property to true. world-time-permissions is set to false by default.

Prior to this build, players with the permissions essentials.time and essentials.time.set were able to set the time in any world, despite world-permissions provided via permission plugins. This build provides the feature of per world permissions for setting the time of a world.

Permissions

Permission Description
essentials.time.world.<world> Permits the user to set the time in <world>. <world> is the world name with spaces replaced with _. e.g. My World becomes, my_world.
essentials.time.world.all Permits the user to set time of all worlds. This will override essentials.time.world.<world>.

AFK Player List name

This feature was added in build 263 (bbf657e).

This build introduces the afk-list-name config property which is used to specify the player-list name format for players that are AFK.

The property has two placeholders:

  • {USERNAME}: The player's name
  • {PLAYER}: The player's display name.

Here's an example of "[AFK] SupaHam":

afk-list-name: '&7[AFK] &o{USERNAME}'

Nickname color permissions

This feature was added in build 246 (9f75f1a).

PR #198 introduced the ability to limit /nick to only allow color changes, ensuring players could still be identified by their original Minecraft name. The feature introduced a new permission node called essentials.nick.changecolors. When a player has the preceding permission, they are only allowed to add colours to their names. Where if the player was called SupaHam, he could only be able to use /nick &5SupaHam but not /nick &5TheSupaHam, where the latter is prefixing the name with 'The'.

However, this feature also introduced the essentials.nick.changecolors.bypass permission node. Where if a player has the preceeding permission they are allowed to bypass the check and thus be able to change the characters of their name. This was originally created to ensure convenience for Server Operators without breaking functionality when they updated EssentialsX.

Note: This permission requires the essentials.nick.color permission in order to use colors in the nickname to begin with.

Teleport to spawn when joining

This feature was added in build 361 (b673630).

Requested in #345. Administrators can now specify whether joining players are to be teleported to spawn using the spawn-on-join option found in the config.yml file.

spawn-on-join accepts three different data types:

  1. Boolean - if the value is true, all players will be teleported to spawn when joining. If false, this feature is simply disabled.
  2. String - The value is interpreted as a group name and the user is checked for presence in said group when joining. If they belong to the group, then they will be teleported to spawn when joining.
  3. List of Strings - The value is interpreted as a list of groups that are treated as stated above in String.

Note: a group name of "*" is interpreted as a wildcard and catches all players, causing them to teleport to spawn on join.

When spawn-on-join is true all players are teleport to their group spawn point. If no group spawn point has been set, the default spawn point, set with /setspawn, will be used instead.

If Admins wish to exempt certain players from this feature when spawn-on-join is true, they can give them the essentials.spawn-on-join.exempt permission and they will log in where they left off, assuming no other plugin is interfering.

AFK message

This feature was added in build 380 (9dfa650d). Requested in #590. PR in #664.

Players can now set their AFK message when using the /afk command to notify others of their situation. This helps give insight on how long the player will be back so that other inquiring players can be informed and act appropriately.

Players are informed with the AFK message by default when they /msg a player who is AFK. However, when a player goes AFK with a message, by default the message will not be broadcast. However, this can be changed in the locale file (messages_en.proeprties, or whichever locale file you are using) by modifying userIsAwayWithMessage and using the {1} argument, the message. This can be found in the jar file.

To set the AFK message simply type /afk <message...> e.g. /afk I'm walking my dog.

In order to use this feature a player must have the essentials.afk.message permission.

If a player is muted, they are not able to supply a message as it can be used to exploit their punishment.

Pay toggle

This feature was added in build 416 (2493c65). Requested in #413.

Players have the ability to disable any and all payment via the /paytoggle command. This can be used to combat players using /pay as a means of spam towards other players, like celebrities on your server.

paytoggle also has the following aliases: epaytoggle, payoff, epayoff, payon, epayon

payoff will always disable payments to prevent errors. On the contrary, payon will always enable payments.

Pay confirmation toggle

This feature was added in build 461 (5f83766). Requested in #1032.

In build #458, confirmation prompting for /pay was introduced, but rapidly became repetitive for some players. This feature aims to combat it by allowing individual players to toggle the confirm prompt at their own risk.

This feature introduces the command /payconfirmtoggle which modifies confirm-pay in the user's data file. confirm-pay determines whether a player should be prompted to confirm a payment (regardless of amount) or not. By default, confirm-pay is true, meaning enabled. Players would need to use the /payconfirmtoggle command to change this property, and thus the behaviour of the /pay command for themselves.

payconfirmtoggle also has the following aliases: epayconfirmtoggle, payconfirmoff, epayconfirmoff, payconfirmon, epayconfirmon, payconfirm, epayconfirm

Teleport to exact coordinates

This feature was implemented in (0a563b9).

This feature introduces the teleport-to-center configuration feature. When set to true - the default - all teleportations are centered to the block; technically, setting the x and z coordinate decimals to .5 and .5. When teleport-to-center is set to false, all teleports are performed to the exact location as given.

Mail chat formatting

This feature was added in build 540 (665229b). Requested in #1560.

This feature introduces the ability to format messages using the traditional ampersand (&) syntax.

The following table defines the permissions introduced in this feature.

Permission Description
essentials.mail.url Allow use of URLs
essentials.mail.color Allow use of colors
essentials.mail.magic Allow use of obfuscated/magic text styling
essentials.mail.format Allow use of chat styles
Clone this wiki locally