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, messages here. The latest configuration should also be available below.

Latest configuration

config.yml

enable:
  - alert
  - announcement
  - commandspy
  - hide
  - joinannounce
  - lookup
  - mute
  - send
  - sendall
  - spy
  - staffchat
  - chat
  - find
  - ignore
  - join
  - list
  - message
  - slap
  - aliases
  #- betaupdates
  #- clean
  - fulllog
  - log
  #- multilog
  - rules
  - rules-chat
  - spam
  - spam-chat
  - updater
commands:
  alert:
    - 'alert'
    - 'broadcast'
  commandspy:
    - 'commandspy'
    - 'cspy'
  hide:
    - 'hide'
  lookup:
    - 'lookup'
  mute:
    - 'bmute'
  send:
    - 'send'
  sendall:
    - 'sendall'
  spy:
    - 'spy'
    - 'socialspy'
  staffchat:
    - 'staffchat'
    - 'admin'
    - 'a'
    - 'sc'
  chat:
    - 'g'
    - 'global'
  find:
    - 'find'
    - 'whereis'
  ignore:
    - 'bignore'
  join:
    - 'join'
  list:
    - 'glist'
    - 'servers'
    - 'serverlist'
  message:
    - 'message'
    - 'msg'
    - 'm'
    - 'pm'
    - 't'
    - 'tell'
    - 'w'
    - 'whisper'
  reply:
    - 'reply'
    - 'r'
  slap:
    - 'slap'
    - 'uslap'
    - 'smack'
  reload:
    - 'gssreload'
aliases:
  - alias: 'greet'
    commands:
      - 'msg {0} Hey! How are you doing today? I was at {{ SERVER }} but I''m coming to join you!'
      - 'join {0}'
  - alias: 'disappear'
    commands:
      - 'spy'
      - 'cspy'
      - 'hide'
configversion: 2.4.5

messages.yml

format:
  alert: '&8[&b!&8] &7{{ MESSAGE }}'
  join: '&8[&a+&8] &7{{ PLAYER }}'
  quit: '&8[&c-&8] &7{{ PLAYER }}'
  kick: '{{ PLAYER }} was kicked for {{ REASON }}'
  chat: '{{ PLAYER }}: {{ 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: '^.+((\.|dot).+)*(\.|dot)\s*[a-zA-Z]{2,5}'
    handle: ADVERTISEMENT
  - pattern: '(\d{1,4}\.){3}\d{1,4}'
    handle: ADVERTISEMENT
  - pattern: 'asshole'
    handle: REPLACE
    replacement: '******'
  - pattern: 'I hate (this|your) server'
    handle: REPLACE
    replacement: 'I love this server'
  - pattern: 'I hate (this|your) server'
    handle: COMMAND
    command: 'send {{ SENDER }} lobby'
rulenotify:
  advertisement: '&7{{ PLAYER }} just advertised!'
  cursing: '&7{{ PLAYER }} just sweared!'
  replace: '&7{{ PLAYER }} sweared but was replaced!'
  command: '&7{{ PLAYER }} sweared, triggering a command!'
staffchat:
  message: '&c{{ SERVER }} - {{ SENDER }} » &7{{ MESSAGE }}'
  enabled: '&aYou are now chatting in staff chat!'
  disabled: '&cYou are no longer chatting in staff chat!'
chat:
  message: '&e{{ SERVER }} - {{ SENDER }} » &7{{ MESSAGE }}'
  enabled: '&aYou are now chatting in global chat!'
  disabled: '&cYou are no longer chatting in global chat!'
list:
  header: '&aServers:'
  body: '&a- {{ SERVER }} {{ DENSITY }}'
lookup:
  header: '&6Found {{ SIZE }} player(s):'
  body: '&f - {{ PLAYER }}'
multilog:
  limit: 3
  kicked: '&cMaximum number of connections reached!'
spy:
  message: '&7[{{ SENDER }} » {{ RECIPIENT }}] &7{{ MESSAGE }}'
  enabled: '&aSpy has been enabled'
  disabled: '&cSpy has been disabled'
commandspy:
  command: '&7[{{ SENDER }}] &b{{ COMMAND }}'
  enabled: '&aCommand Spy has been enabled'
  disabled: '&cCommand Spy has been disabled'
hide:
  enabled: '&aYou are now hidden from all players!'
  disabled: '&cYou are now visible to all players!'
ignore:
  enabled: '&6Now ignoring {{ PLAYER }}.'
  disabled: '&6No longer ignoring {{ PLAYER }}.'
slap:
  slapper: '&aYou just slapped &e{{ SLAPPED }}&a. I bet that felt good, didn''t it?'
  slapped: '&cYou were just slapped by &e{{ SLAPPER }}&c! Ouch! (/slap him back!)'
mute:
  muted:
    enabled: '&cYou are now muted!'
    disabled: '&aYou are no longer muted!'
    error: '&cHey, you can''t chat while muted!'
  muter:
    enabled: '&c{{ PLAYER }} is now muted!'
    disabled: '&a{{ PLAYER }} is no longer muted!'
    exempt: '&cHey, you can''t mute that player!'
    error: '&7{{ PLAYER }} tried to chat while muted!'
errors:
  invalid: '&cInvalid arguments provided. Usage: {{ HELP }}'
  offline: '&cSorry, that player is offline.'
  slap: '&cYou are unworthy of slapping people.'
  messages: '&cNobody has messaged you recently.'
  ignoreself: '&cYou can''t ignore yourself!'
  ignoring: '&cYou can''t send a message to someone you''re ignoring!'
  sendfail: '&cUnable to send {{ PLAYER }} to {{ SERVER }}.'
announcements:
# Time measured in seconds
  - delay: 30
    interval: 60
    message: 'Vote for our server for great rewards!'
  - delay: 0
    interval: 60
    message: 'Donate to support our server!/n&f&ndonate.myserver.com'