How to use the .yml files
There are three yaml files: "Curses", "Player Curse Count" and "config"
Curses
Curses stores all banned words and all information related to them. The format for that is
shit: value: 5 matching: default-ignorecase fuck: value: 10 matching: default-ignorecase ass: value: 7 matching: literal-ignorecase [curse]: value: [value] matching: [matchtype]
About the new matching types;
- default: Just your regular old matching (will also match ass in grass, etc)
- literal: Will match only whitespace-seperated words (ass, but not dumbass)
- regex; Will match according to these rules: http://www.regular-expressions.info/tutorial.html
The suffix -ignorecase (or -all-lower for regex) enables case-insensitive matching. For regex, all letters in the pattern should be lowercase if the -all-lower option is used.
Player Curse Count
Player curse count stores, you guessed it, the total points of each player:
[playername]: [total]
Config
Config stores several miscellaneous information. For one, the default kick message is saved there:
def-kick-message: [kickmessage]
Also, it stores an option to auto-enable or disable kicking every time a user curses, no matter what other commands may be executed
always-kick: [true/false]
Since 1.2.3, config also stores cooldown data:
cooldown-enabled: [true/false] #Enables or disabled cooldown cooldown-time-min: [Some number] #The time between cooldown steps cooldown-stepsize: [Some number] #The cooldown stepsize, i.e. the points subtracted every time the cooldown is triggered
The last thing the config does for now is storing the commands to be executed (omit the '/' at the beginning). If the command needs a player name, use %name%. If you want to use multiple commands, put them in as a semicolon (';') seperated list
[value to match]: [command to execute]
The default config file will look like this:
def-kick-message: Cursing (This happens automatically, don't be hatin') always-kick: true 0: kick %name% Cursing (This happens automatically, don't be hatin') 100: ban %name%;broadcast %name% has been banned because he can't keep his mouth shut. cooldown-enabled: true cooldown-time-min: 10 cooldown-stepsize: 10
Comments