Configuration

This page acts as a clarification of how I've formatted configuration data on the wiki, though really it is only to clear up one point that people who haven't tried making a plugin may not understand.

keyOne:
    keyTwo: 'Hello world'

If I am trying to talk about keyTwo which is "inside" (for lack of a better word) of keyOne then I will write it as keyOne.keyTwo which is also how configuration values are accessed using code.

Global Variables

Global configuration variables can be found here, it does not matter where you place them as they should always be formatted appropriately.

Default configuration

The most up to date configuration file can always be found here. I will try to post the latest configuration file here whenever I update BungeeEssentials, hopefully there shouldn't be any changed for a while though.

1.0.8a configuration

enable:
    - admin
    - alert
    - find
    - hide
    - join
    - list
    - log
    - message
    - multilog
    - rules
    - rules-chat
    - send
    - sendall
    - spam
    - spam-chat
    - slap
    - spy
format:
    admin: '&c{{ SERVER }} - {{ SENDER }} » &7{{ MESSAGE }}'
    alert: '&8[&a+&8] &7{{ MESSAGE }}'
    find: '&e{{ PLAYER }} &ais playing on &e{{ SERVER }}'
    message: '&a({{ SERVER }}) &7[{{ SENDER }} » {{ RECIPIENT }}] &f{{ MESSAGE }}'
    send: '&aSending &e{{ PLAYER }} &ato server &e{{ SERVER }}'
warnings:
    similarity: '&cPlease do not spam other players!'
    swearing: '&cPlease do not swear at other players!'
    advertising: '&cPlease do not advertise other servers!'
rules:
    - pattern: '\bfuck\b'
      handle: CURSING
    - pattern: '^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$'
      handle: ADVERTISEMENT
    - pattern: '(?:(?:2(?:[0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9])\.){3}(?:(?:2([0-4][0-9]|5[0-5])|[0-1]?[0-9]?[0-9]))'
      handle: ADVERTISEMENT
    - pattern: 'asshole'
      handle: REPLACE
      replacement: '******'
list:
    header: '&aServers:'
    body: '&a- {{ SERVER }} {{ DENSITY }}'
multilog:
    limit: 3
    kicked: '&cMaximum number of connections reached!'
spy:
    message: '&7[{{ SENDER }} » {{ RECIPIENT }}] &7{{ MESSAGE }}'
    enabled: '&aSocialspy has been enabled'
    disabled: '&cSocialspy has been disabled'
hide:
    enabled: '&aYou are now hidden from all players!'
    disabled: '&cYou are now visible to all players!'
errors:
    invalid: '&cInvalid arguments provided.'
    offline: '&cSorry, that player is offline.'
    slap: '&cYou are unworthy of slapping people.'
    messages: '&cNobody has messaged you recently.'