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 your Spigot/CraftBukkit server. (Using /reload can have unwanted side effects with players still online, but also with complex plugins and cross-plugin dependencies, so we don't recommend it. Usually it should work with NCP.)

Tips

• Be sure that your Spigot/CraftBukkit and NoCheatPlus versions match together.
• Don't use tabs in the config.yml file.
• Use [ProtocolLib] (http://dev.bukkit.org/bukkit-plugins/protocollib) for full efficiency of the fight checks and other. Using version of ProtocolLib that is supported by NCP is essential, as otherwise some checks will be disabled.
• For compatibility with other plugins such as mcMMO, citizens and more check out [CompatNoCheatPlus] (http://dev.bukkit.org/server-mods/compatnocheatplus-cncp/).

Compiling NoCheatPlus

• NoCheatPlus is compiled for Java 6 (same as Minecraft/Spigot).
• 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). For more options, see the table below. If your specific needs are not met by the provided options, you can still build only using the compat module(s) that you need, e.g. by adjusting the build/dependency profiles or adding your own profile, which means changing/adding a profile both in the root pom.xml for modules to have and in NCPPlugin/pom.xml for the dependency inclusion. The preset profiles should be enough of a hint for that. If you add custom modules with a different package naming than fr.neatmonster, you might have to add the source inclusion to the NoCheatPlus/pom.xml as well.
• Jar files for the dedicated compat modules, which your local maven repository might be missing, can 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 files inside the jars are parsed.

All profiles for reference:

Profile	Parameter set to true	Description
-P minimal	default	Default profile without native access modules, likely problematic with moving checks.
-P all	cbdedicated	All compat modules.
-P spigot1_8_r3	spigot1_8_r3	Just Spigot 1.8 R3 (MC 1.8.4-1.8.8).
-P spigot1_9_r1	spigot1_9_r1	Just Spigot 1.9 R1 (MC 1.9-1.9.3).
-P spigot1_9_r2	spigot1_9_r2	Just Spigot 1.9 R2 (MC 1.9.4).
-P spigot1_10_r1	spigot1_10_r1	Just Spigot 1.10 R1 (MC 1.10).
-P cbdev	cbdev	The latest version in development.

(On the long run, only the latest module for a major Minecraft release will be kept, such as 1_8_r3.)

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

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