################################################################################ # # # Important files, config.yml or "clean up your stuff" # # # ################################################################################ 1) The config file for NoCheatPlus is called "config.yml" now. 2) You can have different config files for different worlds. To achieve this, copy the "config.yml" and rename the copy to "worldname_config.yml". Set- tings in that file will now only affect the world with the name "worldname". You may also delete all settings from that world-specific file that you won't use. They'll be implicitly taken from the master "config.yml" file. 3) If you have files named "config.txt", "default_actions.txt" or "actions.txt" please delete them. They are no longer used by NoCheatPlus and serve no purpose anymore. 4) Never change the amount of white-spaces in front of options in the config file "config.yml". It will break the configuration. ################################################################################ # # # How "actions" work, an Overview # # # ################################################################################ NoCheatPlus allows to define in detail what should happen when a player fails a check in form of "actions". There are 4 possible things that may be done: (read on to learn in detail on how to define/modify actions) cancel: The effects of the action "cancel" depend on the check that it is used for. Usually it means to prevent something from happening, e.g. stop an attack or prevent sending of a chat message. log: Create and show/log a message. Log messages can be customized in how often, when and where they are registered/shown. cmd: Execute a command of Bukkit or another plugin as if it were typed into the server console by an admin. Like logging, these can be customized. vl>X: Is meant to symbolize "violation level at least X". Used to define actions that will be executed only if players reached a certain violation level. Failing a check usually increases their "vl", not failing checks reduces it over time. Violation levels mean different things for different checks, e.g. they may describe moved distance beyond the limit, number of attacks above the attack limit, sent messages beyond the spam limit. ################################################################################ # # # How to customize your "actions" # # # ################################################################################ 1) The "cancel" action is just the word "cancel". Read in the detailed option description to find out what it does depending on the check that it is assigned to. 2) The "log" action is a string of the form "log:string:delay:repeat:target". log: is simply used to let NoCheatPlus know it is a log action. Don't remove it from the action, or NoCheatPlus will not know what it is and how to handle it. string: is the message that will be logged. Because there is so little space here, you only give a name here and define the actual log message in the "strings" section of the config file. delay: a number declaring how many times that action initially has to be executed before it really leads to logging a message. Use this for situations where it's common to have false positives in checks and you only want the log message to be shown if a player fails the check multiple times within a minute. repeat: a number declaring how many seconds have to pass after logging the message before it will be logged again for that player. This is needed to prevent "log-spam". Usually a value of 5 seconds is acceptable, for rare events you can use lower values. It is very recommended to at least use the value 1 (one second) here. target: where should the message be logged to? You can use three letters here. The order that you use is not important. "c" means logging to console "i" means logging to ingame chat and "f" means logging to the log file. 3) The "cmd" action is a string of the form "cmd:string:delay:repeat". cmd: is simply used to let NoCheatPlus know it is a command action. Don't remove it from the action, or NoCheatPlus will not know what it is and how to handle it. string: is the command that will be issued. Because there is so little space here, you only give a name here and define the actual command in the "strings" section of the config file. delay: a number declaring how many times that action initially has to be executed before it really leads to running the command in the console. Use this to create e.g. a 3-strikes-law by setting it to 3. Only if a player fails the check 3 times within 1 minute, the command will be really run. repeat: a number declaring how many seconds have to pass after running the command before it can be run again for that player. Because many commands are expensive (take time, resources), you may want to limit how often they can be called. 4) The "vl>" isn't really an action. It limits all actions that are written afterwards to be only executed if the players violation level has reached at least the given value. This allows to define layers of actions and handle repeated or severe failing of checks different. For example the spam check will only kick players if they reach a certain violation level (vl). ################################################################################ # # # Permissions # # # ################################################################################ NoCheatPlus only supports "SuperPerms", CraftBukkits official permission framework. You'll need to use a permissions plugin that supports "SuperPerms" to use it with NoCheatPlus. Here are some I know of: - bPermissions; - PermissionsEx; - Essentials GroupManager. I personally recommend bPermissions, but any of them will do just fine. By default all these permissions are set to "op", which means players with OP- status have all permissions, unless you change it. -------------------------------------------------------------------------------- ----------------------- Permissions for ADMINISTRATION ------------------------- -------------------------------------------------------------------------------- - nocheatplus.admin.chatlog The player will receive log messages that are directed at the "ingame chat" as a normal chat message ingame. - nocheatplus.admin.commands The player gets access to some of the "/nocheatplus" commands. - nocheatplus.admin.reload In combination with "nocheatplus.admin.commands", the player gets access to the "/nocheatplus reload" command, which will cause NoCheatPlus to reread its config files. - nocheatplus.admin.plugins Give this permissions to the players you want to be able to see the plugins your server is using. -------------------------------------------------------------------------------- --------------------------- Permissions for CHECKS ----------------------------- -------------------------------------------------------------------------------- These permission nodes are grouped the same way as the options in the config file, based on the event type they belong to. The logic is, that a player having one of these nodes means he will NOT be checked. Players without the permission node will be checked. Example: A player has permission "nocheatplus.checks.moving.morepackets". That means he is allowed to use that hack/cheat because NoCheatPlus won't check/ stop it. -------------------- BLOCKBREAK Permissions for CHECKS ------------------------- - nocheatplus.checks.blockbreak.fastbreak Allows the player to break blocks very quickly. - nocheatplus.checks.blockbreak.reach Allows the player to break blocks that are further away than usual. - nocheatplus.checks.blockbreak.direction Don't force players to look at the blocks that they try to destroy. - nocheatplus.checks.blockbreak.noswing Don't force players to swing their arm when breaking blocks. -------------------- BLOCKPLACE Permissions for CHECKS ------------------------- - nocheatplus.checks.blockplace.fastplace Allows the player to place blocks very quickly. - nocheatplus.checks.blockplace.reach Allows the player to place blocks that are further away than usual. - nocheatplus.check...
dominik716