Merge pull request #9 from MyPictures/master

Add a ReadMe.md, which makes sense. TODO: Link to the license!
This commit is contained in:
asofold 2013-01-11 15:43:55 -08:00
commit 98ac036132

35
README.md Normal file
View File

@ -0,0 +1,35 @@
![NoCheatPlus](https://dl.dropbox.com/u/34835222/NoCheatPlus_doughnut.png)
===========
NoCheatPlus is an unofficial 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 safer. Organised 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 our [Features Page] (http://dev.bukkit.org/server-mods/nocheatplus/pages/documentation/features/).
Compiling
---------
NoCheatPlus uses [Maven 3] (http://maven.apache.org/download.cgi) techniques and is compiled for JDK 6. You NEED Maven to compile it!
Installation
---------
* Get [CraftBukkit] (http://wiki.bukkit.org/Setting_up_a_server)
* Download [NoCheatPlus] (http://nocheatplus.org:8080/job/NoCheatPlus/)
* Drop the NoCheatPlus.jar intoo your plugins folder
* Start or /reload your CraftBukkit server
Tips
---------
* Be sure that your CraftBukkit and NoCheatPlus versions match together
* Dont use tabs in the config.yml file
* For compatibilty with plugins such as mcmmo, citizens and more check out [CompatNoCheatPlus] (http://dev.bukkit.org/server-mods/compatnocheatplus-cncp/)
Links
---------
* [Website] (www.nocheatplus.org)
* [Jenkins] (www.nocheatplus.org:8080)
* [ProjectPage] (http://dev.bukkit.org/server-mods/nocheatplus/)
* [TicketSupport] (http://dev.bukkit.org/server-mods/nocheatplus/tickets/)
* [Statistics] (https://mcstats.org/plugin/NoCheatPlus)
* [API] (http://dev.bukkit.org/server-mods/nocheatplus/pages/documentation/api/)
* [Features] (http://dev.bukkit.org/server-mods/nocheatplus/pages/documentation/features/)
* [Permissions] (http://dev.bukkit.org/server-mods/nocheatplus/pages/documentation/permissions/)
* [Configuration] (http://dev.bukkit.org/server-mods/nocheatplus/pages/documentation/configuration/)
* [Commands] (http://dev.bukkit.org/server-mods/nocheatplus/pages/documentation/commands/)