Upstream/NoCheatPlus
1
0
Fork 0
mirror of https://github.com/NoCheatPlus/NoCheatPlus.git synced 2024-09-19 18:31:23 +02:00
Code Issues Projects Releases Wiki Activity

New descriptions and some rudimentary spell-checking

Browse Source
This commit is contained in:
Evenprime 2012-02-11 21:28:56 +01:00
parent 2d713b90d1
commit 72cefe94ed
1 changed files with 46 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
Instructions.txt
View File

@ -9,13 +9,13 @@ Configuration file description.
"worldname_config.yml". Settings in that file will now only "worldname_config.yml". Settings in that file will now only
affect the world with the name "worldname". You may also delete affect the world with the name "worldname". You may also delete
all settings from that world-specific file that you won't use. all settings from that world-specific file that you won't use.
They'll be implicitely taken from the master "config.yml" file. They'll be implicitly taken from the master "config.yml" file.
- If you have files ending with "config.txt", "actions.txt" or - If you have files ending with "config.txt", "actions.txt" or
"default_actions.txt", please delete them. They are no longer "default_actions.txt", please delete them. They are no longer
used by NoCheat. used by NoCheat.
- Never change the amount of whitespaces in front of options in the config file - Never change the amount of white-spaces in front of options in the config file
"config.yml". It will break the configuration. "config.yml". It will break the configuration.
2) How the "actions" work, how to modify them and how to write your own, 2) How the "actions" work, how to modify them and how to write your own,
@ -48,7 +48,7 @@ Configuration file description.
Use this for situations where it's common to have false Use this for situations where it's common to have false
positives in checks and you only want the log message to be positives in checks and you only want the log message to be
shown if a player fails the check multiple times within a shown if a player fails the check multiple times within a
short timeframe (1 minute) short time-frame (1 minute)
"repeat" = a number declaring how many seconds have to pass after logging "repeat" = a number declaring how many seconds have to pass after logging
the message before it will be logged again for that player. the message before it will be logged again for that player.
This is needed to prevent "log-spam". Usually a value of 5 This is needed to prevent "log-spam". Usually a value of 5
@ -114,8 +114,8 @@ checks:
inventory: inventory:
All checks that have to do with the player inventory All checks that have to do with the player inventory
drop: drop:
The "inventory.drop" check. It limits how many seperate items a player can drop The "inventory.drop" check. It limits how many separate items a player can drop
onto the ground within a specific time. Dropping a lot of seperate items at once onto the ground within a specific time. Dropping a lot of separate items at once
can cause lag on the server. can cause lag on the server.
active: active:
Should the check be enabled. Set to false if you are not interested in this at all Should the check be enabled. Set to false if you are not interested in this at all
@ -123,7 +123,7 @@ checks:
Over how many seconds should dropped items be counted Over how many seconds should dropped items be counted
limit: limit:
How many items may be dropped in that timeframe. Please consider that dying causes How many items may be dropped in that timeframe. Please consider that dying causes
a player to drop up to 36 seperate items. Therefore this value shouldn't be set a player to drop up to 36 separate items. Therefore this value shouldn't be set
below ~50. below ~50.
actions: actions:
What should happen when a player goes beyond the set limit. Default settings log What should happen when a player goes beyond the set limit. Default settings log
@ -132,7 +132,7 @@ checks:
Players may attack extremely fast and with a fully charged bow without Players may attack extremely fast and with a fully charged bow without
waiting for it to be fully pulled back. waiting for it to be fully pulled back.
active: active:
Should players be checked for this behaviour. Should players be checked for this behavior.
actions: actions:
What should happen if the player fails this check. Default is to stop What should happen if the player fails this check. Default is to stop
the attack ("cancel" it) and log messages. the attack ("cancel" it) and log messages.
@ -140,7 +140,7 @@ checks:
Players may eat various kinds of food instantly instead of waiting the Players may eat various kinds of food instantly instead of waiting the
usual time munching on the item. usual time munching on the item.
active: active:
Should players be checked for this behaviour. Should players be checked for this behavior.
actions: actions:
What should happen if the player fails this check. Default is to deny What should happen if the player fails this check. Default is to deny
them the food level gain ("cancel" it) and log messages. Sadly it's them the food level gain ("cancel" it) and log messages. Sadly it's
@ -152,6 +152,22 @@ checks:
This is a combined check for running, flying and "nofall" hacks This is a combined check for running, flying and "nofall" hacks
active: active:
Should players get checked for movement related hacks at all Should players get checked for movement related hacks at all
walkspeed:
(You'll have to manually add this entry if you want to use it)
How fast should the player be allowed to walk. Default is "100", meaning
100% of normal walking speed
sprintspeed:
(You'll have to manually add this entry if you want to use it)
How fast should the player be allowed to sprint. Default is "100", meaning
100% of normal sprinting speed
sneakspeed:
(You'll have to manually add this entry if you want to use it)
How fast should the player be allowed to sneak. Default is "100", meaning
100% of normal sneaking speed
swimspeed:
(You'll have to manually add this entry if you want to use it)
How fast should the player be allowed to swim. Default is "100", meaning
100% of normal swimming speed
allowfastsneaking: allowfastsneaking:
Should sneaking players be allowed to move as fast as normal players. Set this to Should sneaking players be allowed to move as fast as normal players. Set this to
true, if you use plugins that enable players to do that (e.g. RPG plugins tend true, if you use plugins that enable players to do that (e.g. RPG plugins tend
@ -259,7 +275,7 @@ checks:
precision: precision:
How strict should NoCheat be when checking if a player is looking in the How strict should NoCheat be when checking if a player is looking in the
correct direction. 75 (which means a player may be up to 0.75 blocks off) correct direction. 75 (which means a player may be up to 0.75 blocks off)
seems to be an ok value. seems to be a good value.
penaltytime: penaltytime:
How long after failing this check should the player be prevented from How long after failing this check should the player be prevented from
placing any further blocks. This value is in milliseconds, the default placing any further blocks. This value is in milliseconds, the default
@ -273,7 +289,7 @@ checks:
chat: chat:
All checks related to sending chat messages. All checks related to sending chat messages.
color: color:
Players may use colorcodes to send colored messages. This may be used Players may use color-codes to send colored messages. This may be used
to fool other players into believing they are admins or similar. to fool other players into believing they are admins or similar.
active: active:
Should player messages get checked for the use of colors in messages. Should player messages get checked for the use of colors in messages.
@ -287,7 +303,7 @@ checks:
active: active:
Should player messages get checked for the sending of too many messages. Should player messages get checked for the sending of too many messages.
whitelist: whitelist:
A " " (whitespace) seperated list of words. Messages that start with A " " (whitespace) separated list of words. Messages that start with
these sequences will not be counted. these sequences will not be counted.
timeframe: timeframe:
For how many seconds should messages and commands be counted. For how many seconds should messages and commands be counted.
@ -295,7 +311,7 @@ checks:
How many "normal" chat messages may be sent within the timeframe. How many "normal" chat messages may be sent within the timeframe.
commandlimit: commandlimit:
How many commands may be issued within the timeframe. Some mods (e.g. How many commands may be issued within the timeframe. Some mods (e.g.
TooManyItems) send a command on every mouseclick, which may cause TooManyItems) send a command on every mouse-click, which may cause
problems if this is set too low. problems if this is set too low.
actions: actions:
What should happen if players send more messages/commands? Default is What should happen if players send more messages/commands? Default is
@ -307,9 +323,9 @@ checks:
Everything related to fighting Everything related to fighting
direction: direction:
Players may attack enemies without looking at them. This check tries to Players may attack enemies without looking at them. This check tries to
identify such behaviour. identify such behavior.
active: active:
Should players get checked for such behaviour. Should players get checked for such behavior.
precision: precision:
How strict should NoCheat be when comparing the line of sight with the How strict should NoCheat be when comparing the line of sight with the
position of the target. Default is 75 which means a player may look position of the target. Default is 75 which means a player may look
@ -328,7 +344,7 @@ checks:
Players may attack enemies without moving their arm. This may confuse Players may attack enemies without moving their arm. This may confuse
other players as they can't see who is attacking them or monsters. other players as they can't see who is attacking them or monsters.
active: active:
Should players be checked for this behaviour. Should players be checked for this behavior.
actions: actions:
What should happen if the player fails this check. Default is to stop What should happen if the player fails this check. Default is to stop
the attack ("cancel" it) and log messages. the attack ("cancel" it) and log messages.
@ -337,7 +353,7 @@ checks:
a significant advantage in fights. Normally attacks are only allowed a significant advantage in fights. Normally attacks are only allowed
over a ~4 block distance, but these hacks may increase that to 6 blocks. over a ~4 block distance, but these hacks may increase that to 6 blocks.
active: active:
Should players be checked for this behaviour. Should players be checked for this behavior.
distance: distance:
What is the maximum distance that NoCheat should allow attacks for. What is the maximum distance that NoCheat should allow attacks for.
Default is ~4 blocks (value 400). Setting this even lower will limit Default is ~4 blocks (value 400). Setting this even lower will limit
@ -355,7 +371,7 @@ checks:
Players may be attacking extremely fast within a short time by using Players may be attacking extremely fast within a short time by using
automated clicking or hacks. This is an advantage in many situations. automated clicking or hacks. This is an advantage in many situations.
active: active:
Should players be checked for this behaviour. Should players be checked for this behavior.
attacklimit: attacklimit:
How many attacks may a player start within 1 second. Consider setting How many attacks may a player start within 1 second. Consider setting
this to a value that's close to how fast you believe players can click this to a value that's close to how fast you believe players can click
@ -363,6 +379,18 @@ checks:
actions: actions:
What should happen if the player fails this check. Default is to stop What should happen if the player fails this check. Default is to stop
the attack ("cancel" it) and log messages. the attack ("cancel" it) and log messages.
godmode:
Players may trick Bukkit into not dealing them damage when they get
attacked. This will try to identify and correct that behavior.
active:
Should players be checked for this behavior.
attacklimit:
How many attacks may a player start within 1 second. Consider setting
this to a value that's close to how fast you believe players can click
their mouse.
actions:
What should happen if the player fails this check. Default is to make
him vulnerable to the attack ("cancel" his "godmode) and log messages.
strings: strings:
This is the section that defines various strings for "log" or "cmd" actions. This is the section that defines various strings for "log" or "cmd" actions.
@ -372,7 +400,7 @@ strings:
this section. Arbitrary many additional strings may be defined here, or this section. Arbitrary many additional strings may be defined here, or
existing strings may be changed. existing strings may be changed.
Most messages/commands use placeholders in [ ], which will be replaced at Most messages/commands use place-holders in [ ], which will be replaced at
runtime with relevant information. Some of these may only be available in runtime with relevant information. Some of these may only be available in
certain circumstances, only "[player]" can be used everywhere, especially certain circumstances, only "[player]" can be used everywhere, especially
in "cmd" actions. in "cmd" actions.