NoCheatPlus/README.md

NoCheatPlus

NoCheatPlus is a fork of the famous anti-cheat plugin [NoCheat] (http://dev.bukkit.org/server-mods/nocheat/) created by [Evenprime] (https://github.com/Evenprime). NoCheatPlus attempts to enforce "vanilla Minecraft" mechanics, as well as preventing players from abusing weaknesses in Minecraft or its protocol, making your server more safe. Organized in different sections, various checks are performed to test players doing, covering a wide range including flying and speeding, fighting hacks, fast block breaking and nukers, inventory hacks, chat spam and other types of malicious behaviour. For a more complete list have a look at the always outdated [Features Page] (https://github.com/NoCheatPlus/Docs/wiki/Features).

Installation

• Get [CraftBukkit] (http://wiki.bukkit.org/Setting_up_a_server) or [Spigot] (https://www.spigotmc.org/threads/buildtools-updates-information.42865/)
• Download NoCheatPlus from either [BukkitDev (staff approved)] (http://dev.bukkit.org/server-mods/nocheatplus/files/) or [Jenkins (development versions)] (http://ci.md-5.net/job/NoCheatPlus/).
• Drop the NoCheatPlus.jar in to your plugins folder.
• Start or /reload your CraftBukkit server. (Using /reload can have unwanted side effects with players still online.)

Tips

• Be sure that your CraftBukkit and NoCheatPlus versions match together.
• Don't use tabs in the config.yml file.
• For compatibility with other plugins such as mcMMO, citizens and more check out [CompatNoCheatPlus] (http://dev.bukkit.org/server-mods/compatnocheatplus-cncp/).

Compiling NoCheatPlus

• We use [Maven] (http://maven.apache.org/download.cgi) 3 to handle the dependencies.
• You can compile it with this Maven goal: mvn clean package, if you don't want any dedicated CraftBukkit modules, or if you are lacking the jar files. If you do have all the dependencies, you can set the parameter cbdedicated to true and activate the profile all adding -P all to the goals (e.g. on Jenkins, for some setups setting the property may suffice). If you want to build only using the compat module for your current server version, you can remove all the unneeded module references from the root pom.xml and the corresponding dependencies from NCPPlugin/pom.xml. Custom modules not put under the group id fr.neatmonster might need to be added to the includes section in NoCheatPlus/pom.xml as well.
• Jar files for the dedicated compat modules, which your local maven repository might be missing, can also be installed manually. Example for Eclipse with embedded maven: Add a new maven build run configuration, name it appropriately, e.g. Install CB 1.7.5. Set goals to: install:install-file -Dfile=<PATH TO JAR> -DgroupId=org.bukkit -DartifactId=craftbukkit -Dversion=1.7.5-R0.1-SNAPSHOT -Dpackaging=jar On Windows the might look like: X:\...\craftbukkit\3042\craftbukkit-1.7.5-R0.1-20140408.020329-16.jar To let it run you might have to set the base directory, e.g. to ${workspace_loc}, it does not seem to have significance. Do set the correct version alongside the file name. On newer version of maven, you might do with much simplified goals, because the pom inside the jars are parsed.
• NoCheatPlus is compiled for Java 6.

Links

Project

• [NoCheatPlus at BukkitDev] (http://dev.bukkit.org/server-mods/nocheatplus/)

Download

• [BukkitDev (staff approved)] (http://dev.bukkit.org/server-mods/nocheatplus/files/)
• [Jenkins (development versions)] (http://ci.md-5.net/job/NoCheatPlus/)

Support and Documentation

• [Issues/Tickets] (https://github.com/NoCheatPlus/Issues/issues)
• [Wiki] (https://github.com/NoCheatPlus/Docs/wiki)
• [Configuration] (https://github.com/NoCheatPlus/Docs/wiki/Configuration)
• [Permissions] (https://github.com/NoCheatPlus/Docs/wiki/Permissions)
• [Commands] (https://github.com/NoCheatPlus/Docs/wiki/Commands)

Developers

• [License (GPLv3)] (https://github.com/NoCheatPlus/NoCheatPlus/blob/master/LICENSE.txt)
• [API] (https://github.com/NoCheatPlus/Docs/wiki/API)
• [Contribute] (https://github.com/NoCheatPlus/NoCheatPlus/blob/master/CONTRIBUTING.md)

Related

• [CompatNoCheatPlus at BukkitDev] (http://dev.bukkit.org/server-mods/compatnocheatplus-cncp/)