Config

Configuring this plugin is actually super simple! This wiki page will walk you through the entire (short) process.

Config structure

The structure of a "replacer" goes as follows:

replaceName:
  type: "name highlighter"
  prefix: ""
  suffix: ""
  playerNamePrefix: ""
  playerNameSuffix: ""

The type is always name highlighter, but it is there so that we could expand in the future to other replacer types.

playerNamePrefix is what must come before the name for it to match. For example, if playerNamePrefix is @ and playerNameSuffix is an empty string, then it would match @SomePlayerName. If for example playerNamePrefix was < and playerNameSuffix was >, then it would match <SomePlayerName>.

prefix and suffix are what it should insert before and after the player name. If the prefix is @, for example, and suffix is set to &a&o, then all the text after an @mention of a player's name would be highlighted italic-green. The colors are only displayed for the person who was mentioned.

Examples

atMention:
  type: "name highlighter"
  prefix: "&4"
  suffix: "&c&l"
  playerNamePrefix: "@"
  playerNameSuffix: ""

For Bob, the message Hello @Bob! How are you today? would be translated to Hello &4@Bob&c&l! How are you today?

warnings:
  type: "name highlighter"
  prefix: "&c&l"
  suffix: "&e&n"
  playerNamePrefix: "!"
  playerNameSuffix: "!"

This would match Warning !Bob!, do that again and you will be banned!, and would show as Warning &c&l!Bob!&e&n, do that again and you will be banned!