Application Documentation

https://essentialsx.net/wiki/
Admin
Comprehensive documentation covering commands, features, and usage of an application.
Tokens:12,020
Snippets:179
Trust Score:8.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Show Kit Command Example

Source: https://essentialsx.net/wiki/improvements

Use the /showkit command to view the contents of a specific kit directly from the configuration file.

```bash
/showkit <kitname>
```

--------------------------------

### BannerMeta Example Syntax

Source: https://essentialsx.net/wiki/banner-meta

This example demonstrates the syntax for defining a banner with a base color and a pattern. The base color is specified first, followed by the pattern type and its color.

```plaintext
- BANNER:13 1 basecolor:11685080 SQUARE_TOP_RIGHT:14188339
```

--------------------------------

### Discord Command Configuration Example

Source: https://essentialsx.net/wiki/discord

This example demonstrates how to configure Discord commands in EssentialsX. It shows options like enabling commands, hiding them from other users, and specifying allowed roles.

```yaml
commands:
  execute:
    enabled: true
    hide-command: true
    allowed-roles: "*"
  message:
    enabled: true
    hide-command: false
    allowed-roles: "@staff"
    admin-roles: "@moderators"
```

--------------------------------

### Example Kit with Commands and Placeholders

Source: https://essentialsx.net/wiki/improvements

Demonstrates how to define a kit in kits.yml that includes items and executes commands using EssentialsX placeholders. Ensure the 'kits' section is correctly formatted in your configuration.

```yaml
kits:
  mykit:
    delay: 1000
    items:
      - stone 1
      - /give {USERNAME} apple 1
```

--------------------------------

### Custom Book in kits.yml

Source: https://essentialsx.net/wiki/Text-Commands.html

This example shows how to define a custom book within the 'kits.yml' file, using the same ItemMeta tags as the /give and /item commands.

```yaml
- writtenbook 1 title:JRoy's_Adventure author:Chester book:story
```

--------------------------------

### Spawner Item Example (1.13+)

Source: https://essentialsx.net/wiki/improvements

On newer Minecraft versions (1.13+), use the item name directly with the spawner command.

```bash
/i blazespawner
```

--------------------------------

### Default MOTD Text File

Source: https://essentialsx.net/wiki/text-commands

This is an example of the default motd.txt file, which displays a welcome message and server information to players upon joining or when using the /motd command.

```text
&6Welcome, {PLAYER}&6!
&6Type &c/help&6 for a list of commands.
&6Type &c/list&6 to see who else is online.
&6Players online:&c {ONLINE} &6- World time:&c {WORLDTIME12}

```

--------------------------------

### Create Kit Command Example

Source: https://essentialsx.net/wiki/improvements

Use the /createkit command to define a new kit from your inventory. The behavior (saving to file or generating a pastebin link) depends on the 'pastebin-createkit' setting in config.yml.

```bash
/createkit <kitname> <delay>
```

--------------------------------

### Default MOTD Text File

Source: https://essentialsx.net/wiki/Text-Commands.html

This is an example of the default motd.txt file. It uses keywords for placeholders like player name and online count.

```text
&6Welcome, {PLAYER}&6!
&6Type &c/help&6 for a list of commands.
&6Type &c/list&6 to see who else is online.
&6Players online:&c {ONLINE} &6- World time:&c {WORLDTIME12}


```

--------------------------------

### Multi-Page Rules Text File

Source: https://essentialsx.net/wiki/Text-Commands.html

This example shows how to create multi-page text commands using chapter markers. The '#chat' line creates a separate chapter for chat rules.

```text
These are the rules when playing on the server:
1. Don't steal pufferfish
2. Don't dig up sand beaches
Before chatting, make sure you check the chat rules: /rules chat

#chat
When chatting, these are the rules:
1. Don't swear
2. Don't say mean things about JRoy


```

--------------------------------

### EssentialsX MiniMessage Syntax Example

Source: https://essentialsx.net/wiki/translations

Use this syntax to create hoverable and clickable elements in EssentialsX messages. Supports gradients, custom fonts, and more.

```yaml
backAfterDeath=<primary><hover:show_text:'Click to go back'><click:run_command:'/back'><secondary>Click here</secondary> to return to your death point.

```

--------------------------------

### Spawner Item ID Example (1.8-1.12)

Source: https://essentialsx.net/wiki/improvements

On older Minecraft versions (1.8-1.12), use item IDs with spawner types for commands like /i. Spawners will update when placed.

```bash
/i mob_spawner:51
```

--------------------------------

### Create and Register Custom Message Type

Source: https://essentialsx.net/wiki/discord

This example demonstrates how to create a new message type, register it with EssentialsX Discord, and send a message using the custom type. It's useful for categorizing your plugin's messages distinctly.

```java
public class CustomTypeExample {
    private final DiscordService api;
    private final MessageType type;

    public CustomTypeExample(final Plugin plugin) {
      // Gets the EssentialsX Discord API service, so we can register our type and
      // send a message with it later.
      api = Bukkit.getServicesManager().load(DiscordService.class);

      // Create a new message type for the user to define in our config.
      // Unless you're putting a discord channel id as the type key, it's probably
      // a good idea to store this object, so you don't create it every time.
      type = new MessageType("my-awesome-channel");

      // Registers the type we just created with EssentialsX Discord.
      api.registerMessageType(plugin, type);
    }

    @EventHandler()
    public void onAwesomeEvent(AwesomeEvent event) {
      // Set to true if your message should be allowed to ping @everyone, @here, or roles.
      // If you are sending user-generated content, you probably should keep this as false.
      final boolean allowGroupMentions = false;
      // Send the actual message
      api.sendMessage(type, "The player, " + event.getPlayer() + ", did something awesome!", allowPing);
    }
}
```

--------------------------------

### Multi-Page Rules Text File

Source: https://essentialsx.net/wiki/text-commands

This example demonstrates how to create a multi-page custom text command using chapters defined by '#<chapter name>'. This allows for organizing longer sets of rules or information.

```text
These are the rules when playing on the server:
1. Don't steal pufferfish
2. Don't dig up sand beaches
Before chatting, make sure you check the chat rules: /rules chat

#chat
When chatting, these are the rules:
1. Don't swear
2. Don't say mean things about JRoy

```

--------------------------------

### Custom Book Chapter in book.txt

Source: https://essentialsx.net/wiki/Text-Commands.html

This snippet demonstrates defining a chapter for a custom book within the 'book.txt' file. The '#story' marker indicates the start of the book's content.

```text
(...)

#story
Once upon a time, in a land not that far away, a man called JRoy embarked on an adventure that would shape the destiny of his virtual realm.
JRoy was an intrepid explorer in the world of EssentialsX, a vast and dynamic landscape where plugins and commands ruled.
Tales of his epic journey spread far and wide, capturing the imaginations of players and server administrators alike.


```

--------------------------------

### Potion with Damage Value Example (1.9-1.12)

Source: https://essentialsx.net/wiki/improvements

In Minecraft versions 1.9-1.12, you can specify damage values for potions when giving them via commands.

```plaintext
potions with damage values
```

--------------------------------

### Regex Command Cooldowns

Source: https://essentialsx.net/wiki/command-cooldowns

Utilize regular expressions for advanced command matching. Commands must start with a caret '^' to enable regex interpretation.

```yaml
command-cooldowns:
  '^^ban([^ip])?( .*)?': 30 # match any ban command that isn't `banip`.

```

--------------------------------

### Override Commands using Bukkit's commands.yml

Source: https://essentialsx.net/wiki/faq

Use Bukkit's `commands.yml` to create command aliases, overriding existing commands. This example overrides `/gc` with Spark's profiler, `/tell` with vanilla, and forces `/msg` to use EssentialsX's version.

```yaml
aliases:
  gc:
    - 'spark:profiler $1-'
  tell:
    - 'minecraft:tell $1-'
  msg:
    - 'essentials:msg $1-'
```

--------------------------------

### Register Discord Slash Command in onEnable

Source: https://essentialsx.net/wiki/discord

This Java code snippet demonstrates how to register a custom slash command with EssentialsX Discord. It should be placed within your plugin's onEnable method to ensure commands are registered when the plugin starts. Ensure the DiscordService is loaded correctly.

```java
import net.essentialsx.api.v2.services.discord.DiscordService;

public class MyEconomyPlugin {
  @Override
  public void onEnable() {
    final DiscordService api = Bukkit.getServicesManager().load(DiscordService.class);
    api.getInteractionController().registerCommand(new BalanceSlashCommand());
  }
}
```

--------------------------------

### Get Linked Player's Discord Tag (Java)

Source: https://essentialsx.net/wiki/discord-link

Retrieve a linked player's Discord tag (Name#0000) using the EssentialsX Discord Link API. Returns null if the player is not linked.

```java
public String getDiscordTag(final Player player) {
    // Gets the API service for EssentialsX Discord Link
    final DiscordLinkService linkApi = Bukkit.getServicesManager().load(DiscordLinkService.class);

    final String discordId = linkApi.getDiscordId(player.getUniqueId());
    if (discordId == null) {
        return null;
    }

    // Gets the API service for EssentialsX Discord which we will use to get the actual user
    final DiscordService discordApi = Bukkit.getServicesManager().load(DiscordService.class);

    final InteractionMember member = discordApi.getMemberById(discordId).join();
    return member == null ? null : member.getTag();
}
```

--------------------------------

### Cancel Discord Chat Messages

Source: https://essentialsx.net/wiki/discord

This example shows how to cancel a `DiscordChatMessageEvent` to prevent messages intended for specific groups (like staff chat) from being broadcast. Listen for this event to filter messages.

```java
public class StaffChatExample {
    private final StaffChatPlugin plugin = ...;

    @EventHandler()
    public void onDiscordChatMessage(DiscordChatMessageEvent event) {
      // Checks if the player is in staff chat mode in this theoretical plugin.
      if (plugin.isPlayerInStaffChat(event.getPlayer()) ||
              // or we could check if their message started with a # if we use that
              // to indicate typing in a specific channel.
              event.getMessage().startsWith("#")) {
          event.setCanceled(true);
      }
    }
}
```

--------------------------------

### Build EssentialsX from Source using Gradle

Source: https://essentialsx.net/wiki/faq

After setting up the environment and building Spigot versions, navigate to the EssentialsX source root and run `./gradlew build` to compile the plugin jars.

```bash
./gradlew build
```

--------------------------------

### Creating Custom Books with ItemMeta

Source: https://essentialsx.net/wiki/text-commands

These commands demonstrate how to give players custom books created in book.txt using the book:<chapter> ItemMeta tag. This can be used in-game commands, server kits, or other contexts where items are given.

```minecraft-commands
/give mdcfe writtenbook 1 title:JRoy's_Adventure author:Chester book:story
```

```minecraft-commands
/item writtenbook 1 title:JRoy's_Adventure author:Chester book:story
```

```yaml
- writtenbook 1 title:JRoy's_Adventure author:Chester book:story
```

--------------------------------

### Giving a Custom Book

Source: https://essentialsx.net/wiki/Text-Commands.html

These commands show how to give a player a custom book using the 'book:<chapter>' ItemMeta tag. This allows for custom titles, authors, and content defined in 'book.txt'.

```minecraft-commands
/give mdcfe writtenbook 1 title:JRoy's_Adventure author:Chester book:story
```

```minecraft-commands
/item writtenbook 1 title:JRoy's_Adventure author:Chester book:story
```

--------------------------------

### Add EssentialsX Repository and Dependency (Gradle Snapshots)

Source: https://essentialsx.net/wiki/faq

Configure your build.gradle to include the EssentialsX snapshots repository and add EssentialsX as a compileOnly dependency.

```gradle
repositories {
    maven {
        name "essentialsx-snapshots"
        url "https://repo.essentialsx.net/snapshots/"
    }
    maven {
        name "papermc"
        url "https://papermc.io/repo/repository/maven-public/"
    }
}

dependencies {
    ...
    compileOnly 'net.essentialsx:EssentialsX:2.19.1-SNAPSHOT'
}
```

--------------------------------

### Build Older Spigot Versions with BuildTools

Source: https://essentialsx.net/wiki/faq

Before building EssentialsX, build specific Spigot versions using `BuildTools.jar` to ensure compatibility with older server versions. This only needs to be done once.

```java
java -jar BuildTools.jar --rev 1.8
java -jar BuildTools.jar --rev 1.8.3
java -jar BuildTools.jar --rev 1.9
java -jar BuildTools.jar --rev 1.9.4
```

--------------------------------

### Link Account Command in Minecraft

Source: https://essentialsx.net/wiki/discord-link

Run the /link command in Minecraft to initiate the account linking process and obtain a code.

```plaintext
/link
```

--------------------------------

### Add EssentialsX Repository and Dependency (Gradle Releases)

Source: https://essentialsx.net/wiki/faq

Configure your build.gradle to include the EssentialsX releases repository and add EssentialsX as a compileOnly dependency.

```gradle
repositories {
    maven {
        name "essentialsx-releases"
        url "https://repo.essentialsx.net/releases/"
    }
    maven {
        name "papermc"
        url "https://papermc.io/repo/repository/maven-public/"
    }
}

dependencies {
    ...
    compileOnly 'net.essentialsx:EssentialsX:2.19.0'
}
```

--------------------------------

### Implement a Discord Slash Command

Source: https://essentialsx.net/wiki/discord

This Java class defines a Discord slash command for checking a player's balance. It includes methods for command logic, name, description, arguments, and visibility settings. Ensure the 'MyEconomyPlugin' is properly initialized.

```java
public class BalanceSlashCommand extends InteractionCommand {
    private final MyEconomyPlugin plugin = ...;

    @Override
    public void onCommand(InteractionEvent event) {
        // The name of the argument here has to be the same you used in getArguments()
        final String playerName = event.getStringArgument("player");
        final Player player = Bukkit.getPlayerExact(playerName);
        if (player == null) {
            event.reply("A player by that name could not be found!");
            return;
        }

        final int balance = plugin.getBalance(player);

        // It is important you reply to the InteractionEvent at least once as discord
        // will show your bot is 'thinking' until you do so.
        event.reply("The balance of " + player.getName() + " is $" + balance);
    }

    @Override
    public String getName() {
        // This should return the name of the command as you want it to appear in discord.
        // This method should never return different values.
        return "balance";
    }

    @Override
    public String getDescription() {
        // This should return the description of the command as you want it
        // to appear in discord.
        // This method should never return different values.
        return "Checks the balance of the given player";
    }

    @Override
    public List<InteractionCommandArgument> getArguments() {
        // Should return a list of arguments that will be used in your command.
        // If you don't want any arguments, you can return null here.
        return List.of(
                new InteractionCommandArgument(
                        // This should be the name of the command argument.
                        // Keep it a single world, all lower case.
                        "player",
                        // This is the description of the argument.
                        "The player to check the balance of",
                        // This is the type of the argument you'd like to receive from
                        // discord.
                        InteractionCommandArgumentType.STRING,
                        // Should be set to true if the argument is required to send
                        // the command from discord.
                        true));
    }

    @Override
    public boolean isEphemeral() {
        // Whether the command and response should be hidden to other users on discord.
        // Return true here in order to hide command/responses from other discord users.
        return false;
    }

    @Override
    public boolean isDisabled() {
        // Whether the command should be prevented from being registered/executed.
        // Return true here in order to mark the command as disabled.
        return false;
    }
}
```

--------------------------------

### Spawner Placement Permission

Source: https://essentialsx.net/wiki/improvements

Assign the 'essentials.spawnerconvert.*' permission to automatically convert placed spawners to the correct mob type, resolving issues where they might default to pig spawners.

```plaintext
essentials.spawnerconvert.*
```

--------------------------------

### Add EssentialsX Repository and Dependency (Maven Snapshots)

Source: https://essentialsx.net/wiki/faq

Configure your pom.xml to include the EssentialsX snapshots repository and add EssentialsX as a provided dependency.

```xml
<repositories>
    ...
    <repository>
        <id>essentials-snapshots</id>
        <url>https://repo.essentialsx.net/snapshots/</url>
    </repository>
    <repository>
        <id>paper-repo</id>
        <url>https://papermc.io/repo/repository/maven-public/</url>
    </repository>
</repositories>

<dependencies>
    ...
    <dependency>
        <groupId>net.essentialsx</groupId>
        <artifactId>EssentialsX</artifactId>
        <version>2.19.1-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
</dependencies>
```

--------------------------------

### Check Player Seen Status by UUID

Source: https://essentialsx.net/wiki/improvements

You can now use a player's UUID with the `/seen` command, in addition to their username.

```command
/seen 5552e21d-de79-40bc-89da-62ee63244fb2
```

--------------------------------

### Add EssentialsX Repository and Dependency (Maven Releases)

Source: https://essentialsx.net/wiki/faq

Configure your pom.xml to include the EssentialsX releases repository and add EssentialsX as a provided dependency.

```xml
<repositories>
    ...
    <repository>
        <id>essentials-releases</id>
        <url>https://repo.essentialsx.net/releases/</url>
    </repository>
    <repository>
        <id>paper-repo</id>
        <url>https://papermc.io/repo/repository/maven-public/</url>
    </repository>
</repositories>

<dependencies>
    ...
    <dependency>
        <groupId>net.essentialsx</groupId>
        <artifactId>EssentialsX</artifactId>
        <version>2.19.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>
```

--------------------------------

### Enable Console Command Execution

Source: https://essentialsx.net/wiki/discord

Allow messages sent in the console channel to be treated as console commands. Use with caution, as it grants significant permissions.

```yaml
console:
  allow-commands: true
```

--------------------------------

### Configure Spawn on Join Teleportation

Source: https://essentialsx.net/wiki/improvements

Set `spawn-on-join` in `config.yml` to control whether players are teleported to spawn upon joining. Accepts boolean, group name string, or list of group names.

```yaml
spawn-on-join: true
```

--------------------------------

### Enable Specific Signs in EssentialsX Config

Source: https://essentialsx.net/wiki/faq

To enable specific signs like '[balance]', uncomment their lines under `enabledSigns` in `plugins/Essentials/config.yml`. Enabling 'color' allows color codes in sign text but requires another sign type to be active.

```yaml
enabledSigns:
  #- color
  - balance
  #- buy
```

--------------------------------

### Basic Command Cooldowns

Source: https://essentialsx.net/wiki/command-cooldowns

Set cooldowns for specific commands in seconds. This is the simplest way to limit command usage.

```yaml
command-cooldowns:
  feed: 10 # 10 seconds
  home: 70 # 1 minute 10 seconds

```

--------------------------------

### Wildcard Command Cooldowns

Source: https://essentialsx.net/wiki/command-cooldowns

Use wildcards (*) to match commands containing specific patterns. This allows for broader cooldown application.

```yaml
command-cooldowns:
  '*potato*': 30

```

--------------------------------

### Per-Gamemode Permissions

Source: https://essentialsx.net/wiki/improvements

Grant specific permissions to allow players to change to certain gamemodes using the /gamemode command. The base 'essentials.gamemode' permission is still required to use the command itself.

```plaintext
essentials.gamemode.creative
essentials.gamemode.survival
essentials.gamemode.adventure
essentials.gamemode.spectator
essentials.gamemode.all
```

--------------------------------

### Exempt Players from Spawn on Join

Source: https://essentialsx.net/wiki/improvements

Players with the `essentials.spawn-on-join.exempt` permission will not be teleported to spawn when joining, even if `spawn-on-join` is enabled.

```command
essentials.spawn-on-join.exempt
```

--------------------------------

### Link Account Command in Discord

Source: https://essentialsx.net/wiki/discord-link

Use the /link command in Discord with the code provided from Minecraft to complete the account linking.

```plaintext
/link [code]
```

--------------------------------

### Configure Role to Group Synchronization

Source: https://essentialsx.net/wiki/discord-link

Define Discord role to Vault group synchronization in the config.yml file. Use the format 'role-id: group-name'.

```yaml
roles:
  882835662280224818: donator
```

--------------------------------

### Configure Group to Role Synchronization

Source: https://essentialsx.net/wiki/discord-link

Define Vault group to Discord role synchronization in the config.yml file. Use the format 'group-name: role-id'.

```yaml
groups:
  vip: 882835722640433242
```

--------------------------------

### Customize Message Text

Source: https://essentialsx.net/wiki/translations

Create custom message files named 'messages_<lang>.properties' in the 'plugins/Essentials/messages/' folder to override default message text. Use template placeholders like {0} and {1} for dynamic content.

```properties
backOther=<primary>Returned <secondary>{0}<primary> to previous location.

```

--------------------------------

### Customize AFK Player List Name

Source: https://essentialsx.net/wiki/improvements

Use the `afk-list-name` config property to define how AFK players appear in the player list. Supports {USERNAME} and {PLAYER} placeholders.

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

--------------------------------

### Configure Console Channel ID

Source: https://essentialsx.net/wiki/discord

Set the Discord channel ID for console output in the EssentialsX configuration file.

```yaml
console:
  channel: 0
```

--------------------------------

### Enable Per-World Time Setting Permissions

Source: https://essentialsx.net/wiki/improvements

Set `world-time-permissions` to true to require specific permissions for setting time in each world. This feature is disabled by default.

```yaml
world-time-permissions: true
```

--------------------------------

### Restrict Nickname Color Changes

Source: https://essentialsx.net/wiki/improvements

Grant `essentials.nick.changecolors` permission to allow players to only change the color and formatting of their nickname, not the text content. This aligns with Mojang's chat component system.

```command
essentials.nick.changecolors
```

--------------------------------

### Set Server Locale

Source: https://essentialsx.net/wiki/translations

Change the default language for all server messages by uncommenting and setting the 'locale' option in config.yml.

```yaml
# Set the locale for all messages.
# ...
locale: de

```

--------------------------------

### Enable Per-Player Translations

Source: https://essentialsx.net/wiki/translations

Enable per-player translations to use each player's game language. If a language is unsupported, the default server locale will be used.

```yaml
# Should EssentialsX use player's language instead of the server's when sending messages?
# ...
per-player-locale: true

```

--------------------------------

### Force EssentialsX to Handle Overridden Commands

Source: https://essentialsx.net/wiki/faq

Configure `overridden-commands` in `config.yml` to ensure EssentialsX handles commands that might be provided by other plugins. This prevents EssentialsX from yielding the command to another plugin.

```yaml
overridden-commands:
  - msg
```

--------------------------------

### Disable Command Cooldown Persistence

Source: https://essentialsx.net/wiki/command-cooldowns

Set 'command-cooldown-persistence' to false to reset all cooldowns on server startup. By default, cooldowns persist across server sessions.

```yaml
command-cooldown-persistence: false

```

--------------------------------

### Send Message to Discord Chat Channel

Source: https://essentialsx.net/wiki/discord

This Java code snippet demonstrates how to send a message to the default Discord chat channel using the EssentialsX Discord API. It shows how to specify whether group mentions are allowed.

```java
// The built-in channel you want to send your message to, in this case the chat channel.
final MessageType channel = MessageType.DefaultTypes.CHAT;
// Set to true if your message should be allowed to ping @everyone, @here, or roles.
// If you are sending user-generated content, you probably should keep this as false.
final boolean allowGroupMentions = false;
// Send the actual message
final DiscordService api = Bukkit.getServicesManager().load(DiscordService.class);
api.sendMessage(channel, "My Epic Message", allowGroupMentions);
```

--------------------------------

### Define Primary Discord Channel

Source: https://essentialsx.net/wiki/discord

Set the default Discord channel for messages. This channel is used as a fallback if a specific message type's channel is invalid.

```yaml
channels:
  primary: 0
```

--------------------------------

### Define Staff Discord Channel

Source: https://essentialsx.net/wiki/discord

Set a specific Discord channel for staff-related messages. This is often used for join/leave notifications.

```yaml
channels:
  staff: 0
```

--------------------------------

### Customize Console Message Format

Source: https://essentialsx.net/wiki/discord

Modify the format of console messages sent to Discord using Discord's markdown. Reload EssentialsX to apply changes.

```yaml
console:
  format: "**{timestamp}** [{level}] {message}"
```

--------------------------------

### Receive Discord Messages in Minecraft

Source: https://essentialsx.net/wiki/discord

Grant players the 'essentials.discord.receive.<channel_name>' permission to allow them to see messages from a specific Discord channel in Minecraft chat. This is useful for relaying general chat or staff-only messages.

```plaintext
essentials.discord.receive.chat
essentials.discord.receive.staff
```

--------------------------------

### Route Chat Messages to a Specific Channel

Source: https://essentialsx.net/wiki/discord

Configure the 'chat' message type to send messages to a custom-defined Discord channel. This requires creating a new channel definition and assigning it.

```yaml
channels:
  chat: 123456789012345678
message-types:
  chat: chat
```

--------------------------------

### Set Custom Console Relay Name

Source: https://essentialsx.net/wiki/discord

Change the display name for the console relay in Discord. The default is 'EssX Console Relay'.

```yaml
console:
  name: "My Server Console"
```

--------------------------------

### Bypass Discord Markdown Filter

Source: https://essentialsx.net/wiki/discord

Players with the 'essentials.discord.markdown' permission can bypass the Markdown filter, allowing them to use formatting like bold, underline, and italics in their Minecraft chat messages when sent to Discord.

```plaintext
essentials.discord.markdown
```

--------------------------------

### Customize Message Colors

Source: https://essentialsx.net/wiki/translations

Change the default primary and secondary colors used in EssentialsX messages via the 'message-colors' section in config.yml. Some messages may have custom colors defined separately.

```yaml
# Change the default primary and secondary colours used in EssentialsX messages.
# Some messages may use custom colours, which will need to be edited in the appropriate message files.
# For more information on customising messages, see https://essentialsx.net/wiki/Locale.html
message-colors:
  primary: '#ffaa00'
  secondary: '#ff5555'

```

--------------------------------

### Configure Last Message Reply Recipient

Source: https://essentialsx.net/wiki/improvements

Set `last-message-reply-recipient` to true to make `/reply` target the last person you messaged, not the last person who messaged you. This setting is controlled by `last-message-reply-recipient-timeout`.

```yaml
last-message-reply-recipient: true
```

--------------------------------

### Hiding EssentialsX Messages

Source: https://essentialsx.net/wiki/translations

To disable or hide specific messages in EssentialsX, set the corresponding message key to a blank value in the configuration file.

```yaml
noNewMail=

```

--------------------------------

### Bypass Discord Ping Filter

Source: https://essentialsx.net/wiki/discord

Players with the 'essentials.discord.ping' permission can bypass the ping filter, enabling them to send @everyone, @here, or role pings from Minecraft chat to Discord.

```plaintext
essentials.discord.ping
```
Tokens:
Raw