Skip to content

Configuration

Jump to bottom Edit New page
PantherMan594 edited this page Jan 22, 2016 · 24 revisions

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
  - autoredirect
  - commandspy
  - fastrelog
  - friend
  - hide
  - joinannounce
  - lookup
  - mute
  - send
  - sendall
  - spy
  - staffchat
  - chat
  - find
  - ignore
  - join
  - list
  - message
  - slap
  - aliases
  #- betaupdates
  #- clean
  - fulllog
  - log
  - rules
  - rules-chat
  - spam
  - spam-chat
  - spam-command
  - 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'
  friend:
    - 'friend'
    - 'f'
  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:
  greet:
    - 'TELL: Joining {0}...'
    - 'TELL {0}: {{ PLAYER }} was at {{ SERVER }} but is coming to join you!'
    - 'join {0}'
  disappear:
    - 'spy'
    - 'cspy'
    - 'hide'
    - 'TELL ALL: &8[&c-&8] &7{{ PLAYER }}'
  vote:
    - 'CONSOLE: staffchat {{ PLAYER }} wants to vote!'
    - 'TELL: Vote for the server at yourvote.site!'
configversion: 2.5.0
messages.yml
format:
  alert: '&8[&4!&8] &4{{ 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 }}'
  send: '&aSending &e{{ PLAYER }} &ato server &e{{ SERVER }}'
message:
  format: '&a({{ SERVER }}) &7[{{ SENDER }} » {{ RECIPIENT }}] &f{{ MESSAGE }}'
  enabled: '&aMessaging is now enabled!'
  disabled: '&cMessaging is now disabled!'
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'
bannedwords:
  replace: '*'
  list:
    - 'anal'
    - 'anus'
    - 'aroused'
    - 'asshole'
    - 'bastard'
    - 'bitch'
    - 'boob'
    - 'bugger'
    - 'cock'
    - 'cum'
    - 'cunt'
    - 'dafuq'
    - 'dick'
    - 'ffs'
    - 'fuck'
    - 'gay'
    - 'hentai'
    - 'homo'
    - 'homosexual'
    - 'horny'
    - 'intercourse'
    - 'jerk'
    - 'lesbian'
    - 'milf'
    - 'nigga'
    - 'nigger'
    - 'pedo'
    - 'penis'
    - 'piss'
    - 'prostitute'
    - 'pussy'
    - 'rape'
    - 'rapist'
    - 'retard'
    - 'sex'
    - 'shit'
    - 'slag'
    - 'slut'
    - 'sperm'
    - 'spunk'
    - 'testicle'
    - 'titt'
    - 'tosser'
    - 'twat'
    - 'vagina'
    - 'wanker'
    - 'whore'
    - 'wtf'
rulenotify:
  advertisement: '&7{{ PLAYER }} just advertised!'
  cursing: '&7{{ PLAYER }} just swore!'
  replace: '&7{{ PLAYER }} swore but was replaced!'
  command: '&7{{ PLAYER }} swore, 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 }}'
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'
friend:
  header: '&2Current Friends:'
  body: '- {{ NAME }} ({{ SERVER }})'
  new: '&aYou are now friends with {{ NAME }}!'
  old: '&aYou are already friends with {{ NAME }}!'
  remove: '&cYou are no longer friends with {{ NAME }}.'
  outrequests:
    header: '&2Outgoing Friend Requests:'
    body: '- {{ NAME }}'
    new: '&a{{ NAME }} has received your friend request.'
    old: '&cYou already requested to be friends with {{ NAME }}. Please wait for a response!'
    remove: '&cThe friend request to {{ NAME }} was removed.'
  inrequests:
    header: '&2Incoming Friend Requests:'
    body: '- {{ NAME }}'
    new: '&a{{ NAME }} would like to be your friend. /friend <add|remove> {{ NAME }} to accept or decline the request.'
    remove: '&cThe friend request from {{ NAME }} was removed.'
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 }}.'
  fastrelog: '&cPlease wait before reconnecting!'
announcements:
# Time measured in seconds
  vote:
    delay: 30
    interval: 60
    message: 'Vote for our server for great rewards!'
    server: 'Hub'
  donate:
    delay: 0
    interval: 60
    message: 'Donate to support our server!\n&f&ndonate.myserver.com'format:
  alert: '&8[&4!&8] &4{{ 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 }}'
  send: '&aSending &e{{ PLAYER }} &ato server &e{{ SERVER }}'
message:
  format: '&a({{ SERVER }}) &7[{{ SENDER }} » {{ RECIPIENT }}] &f{{ MESSAGE }}'
  enabled: '&aMessaging is now enabled!'
  disabled: '&cMessaging is now disabled!'
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'
bannedwords:
  replace: '*'
  list:
    - 'anal'
    - 'anus'
    - 'aroused'
    - 'asshole'
    - 'bastard'
    - 'bitch'
    - 'boob'
    - 'bugger'
    - 'cock'
    - 'cum'
    - 'cunt'
    - 'dafuq'
    - 'dick'
    - 'ffs'
    - 'fuck'
    - 'gay'
    - 'hentai'
    - 'homo'
    - 'homosexual'
    - 'horny'
    - 'intercourse'
    - 'jerk'
    - 'lesbian'
    - 'milf'
    - 'nigga'
    - 'nigger'
    - 'pedo'
    - 'penis'
    - 'piss'
    - 'prostitute'
    - 'pussy'
    - 'rape'
    - 'rapist'
    - 'retard'
    - 'sex'
    - 'shit'
    - 'slag'
    - 'slut'
    - 'sperm'
    - 'spunk'
    - 'testicle'
    - 'titt'
    - 'tosser'
    - 'twat'
    - 'vagina'
    - 'wanker'
    - 'whore'
    - 'wtf'
rulenotify:
  advertisement: '&7{{ PLAYER }} just advertised!'
  cursing: '&7{{ PLAYER }} just swore!'
  replace: '&7{{ PLAYER }} swore but was replaced!'
  command: '&7{{ PLAYER }} swore, 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 }}'
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'
friend:
  header: '&2Current Friends:'
  body: '- {{ NAME }} ({{ SERVER }})'
  new: '&aYou are now friends with {{ NAME }}!'
  old: '&aYou are already friends with {{ NAME }}!'
  remove: '&cYou are no longer friends with {{ NAME }}.'
  outrequests:
    header: '&2Outgoing Friend Requests:'
    body: '- {{ NAME }}'
    new: '&a{{ NAME }} has received your friend request.'
    old: '&cYou already requested to be friends with {{ NAME }}. Please wait for a response!'
    remove: '&cThe friend request to {{ NAME }} was removed.'
  inrequests:
    header: '&2Incoming Friend Requests:'
    body: '- {{ NAME }}'
    new: '&a{{ NAME }} would like to be your friend. /friend <add|remove> {{ NAME }} to accept or decline the request.'
    remove: '&cThe friend request from {{ NAME }} was removed.'
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 }}.'
  fastrelog: '&cPlease wait before reconnecting!'
announcements:
# Time measured in seconds
  vote:
    delay: 30
    interval: 60
    message: 'Vote for our server for great rewards!'
    server: 'Hub'
  donate:
    delay: 0
    interval: 60
    message: 'Donate to support our server!\n&f&ndonate.myserver.com'

Project initially created by csh, maintained by PantherMan594! Visit plugin page

Home
Configuration
Modules
Commands and Permissions
Release Notes
Bugs
Suggestions
Donate

Clone this wiki locally