Configuration

The config.yml is splitted into 3 sections.

The config section

Expamle:

config:
    chatformat: '[$group$] $playername$: $message$'
    timeformat: 'HH:mm:ii'

The chatformat config describes the format of your chatlines. Tags are enclosed by $. You can use any tagname you like. Unknown tags will be replaced with "".

The timeformat config describes the apperance of the time tag. This can be any String recognised by SimpleDateFormat

Predefined tags are playername, message, health (The player's health in the range of 0-20), world and time.

Predefined tags can be overwritten in the permissions section.

The permissions section

In the permissions section you define or overwrite tags specific to the users having a certain permission.

Example:

permissions:
    some.permission.node:
        group: 'SomeGroup'
    some.bad.permission.node:
        group: 'BadUser'
        message: "I'm stupid!"

You can use permission nodes provided by other plugins or create your own ones.

The first permission that matches wins. To use the example above, if a user has "some.permission.node" AND "some.bad.permission.node" the first one would be used.

The users section

In the users section you define or overwrite tags specific to single users.

Example:

users:
    Engelier:
        group: 'Developer'
        playername: 'Son of Notch'

Tags are parsed in the following order: Global predefined tags => permission tags => user tags.

Given I had the permission "some.bad.permission.node" and NOT "some.permission.node" and all the examples above in the config.yml my chatlines would look like this:

[Developer] Son of Notch: I'm stupid!

You can use ColorCodes in your chatformat and tags. ColorCodes are defined by a & followed by it's hexadecimal number found here.