Welcome!

DMentions is a Minecraft plugin that supports mentioning player in chat with many features.

There are some files that you may want to edit if the default settings are not to your liking. I'll be explaining them clearly as possible. You can open an issue here if you still need help after reading the wiki.

The Configuration File

The config.yml

Language File

This defines the file that contains in-game messages. You should enter a valid file name that exist in the plugin folder with path DMentions/lang/.
If the value you entered is invalid, the plugin will take the default language for referance.

[!NOTE] The default language file is en-US.yml.
Console error messages are not included in these files.

[!CAUTION] You may see an error if the default language file is absent. Please reload the plugin to regenerate it.

Check for Updates

Whether the plugin should check the latest version from spigot and notify you.

Mention Limit

This is for limiting the mentions in a single chat message. After reaching the limit, the rest mentions in the message will be ignored.

Vanish Respect

This option erases player's name from valid keywords when enabled, preventing mentioning the vanished players. It gets added back they exit from vanish state.

[!IMPORTANT] This option requires EssentialsX to be installed.

AFK Respect

This option prevents mentioning players that's marked as AFK when enabled.

[!IMPORTANT] This option requires EssentialsX to be installed.

Ignore respect

This option prevents players to mention a player who ignores the sender. (targeted player used /ignore )

[!IMPORTANT] This option requires EssentialsX to be installed.

Suffix Colors

This is an important section in the config file to match the player's chat color after mention word. You have to add all your groups in this section to avoid making messages look awkward.

[!NOTE] There is __OTHER__ key within the section that represents the color for the groups that you did not explicitly add to the section.

[!IMPORTANT] The key __OTHER__ is also used when the server does not include plugin LuckPerms.

Disabled Worlds

Players won't be able to use any mention keyword in these worlds.

[!NOTE] You can keep this value empty([]) to cancel disabling any world.

Mentioning

Enabled

This defines whether the relevant mention is enabled on the server.

[!CAUTION] This key is applied to all groups in group mentioning.

Permission

The required permission for a player to use this mentioning.

[!CAUTION] This key is applied to all groups in group mentioning.

Sound

This is the sound that will be played to the mention sender and the targeted players.

[!NOTE] You can keep this value empty("") to cancel sounds.

[!CAUTION] This key is applied to each group separately in group mentioning. So keep it within group.list section

Keyword

This is the required keyword to call the relevant mention.

[!IMPORTANT] The player mentions does not include keyword. They are called when the player name is entered in chat separated from other words.

[!CAUTION] This key is applied to all groups in group mentioning.

Display

This is about how the mention will be displayed in chat.

[!CAUTION] This key is applied to each group separately in group mentioning. So keep it within group.list section

Cooldown

This is important to avoid players spamming the mentions.

[!IMPORTANT] This value is an integer and needs to be entered in time unit of seconds.

[!CAUTION] This key is applied to each group separately in group mentioning. So keep it within group.list section

Nearby - Radius

This is to determine the targeted players within what radius of the sender.

[!CAUTION] You should keep this low to avoid server laggings.

Group - Disabled Groups

This is to disable mentions of specified groups.

[!CAUTION] This value is a string list. Be careful to not break it.

Config Version

This value must not changed manually. It is required to check if the file version is matched with plugin version. There might be key changes etc. It will be updated automatically when you download a newer version.

The Language File

The some-language.yml

Every key is important to keep same. You can create your own language file as long as you fill all the keys that are in default language file. Also if you want to share this file, you can open an issue and post there for me and the people speak that language. That would be much appreciated!

[!NOTE] The keys that are in default language file is called when some keys are missing in your selected file.

Config Version

This value must not changed manually. It is required to check if the file version is matched with plugin version. There might be key changes etc. It will be updated automatically when you download a newer version.