Upstream
/
NoCheatPlus
mirror of https://github.com/NoCheatPlus/NoCheatPlus.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update README.md (mostly wiki links), add CONTRIBUTING.md.

This commit is contained in:
asofold 2015-10-23 17:26:46 +02:00
parent f578b4da53
commit 603a4dbb81
2 changed files with 41 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,32 @@
Contributing to NoCheatPlus
---------
This page describes how to contribute code to the project by means of pull requests.
Other types of contribution:
* [Tickets (all sorts)] (http://dev.bukkit.org/server-mods/nocheatplus/tickets/) are currently hosted on BukkitDev, but will be migrated to GitHub later on.
* [Tickets for the Wiki] (https://github.com/NoCheatPlus/Docs/issues) are on GitHub, these are only for the purpose of improving the Wiki itself.
Pull Requests
---------
This is a quick go, not covering all the areas.
Do comply with the [GPLv3 License] (https://github.com/NoCheatPlus/NoCheatPlus/blob/master/LICENSE.txt) of the project, ensure contributed code can be used in a GPLv3 project.
Code conventions haven't really been followed, however we try to go with some rules and change existing files once touching them.
Indentation, braces, split statements:
* Use spaces, 4 for a level of indentation, no tab characters.
* Curly braces rather like the Stoustrup variant of K&R indentation style (see wikipedia). Exceptions may be empty bodies for try-catch (compact). Open brace in the same line of a method signature or a condition, close in an extra line, place "else if" on the same level as "if" in an extra line.
* Splitting long lines only when semantically appealing. Don't use magic on splitting. Keep a (too) long line, rather than obfuscating the logic by splitting it.
* Indentation of split lines is out of our reach (use auto-indent), is that even configurable (eclipse)?
* In order to not mess everything up, we use auto-indentation but not auto-format, until decided.
* Comments:
* Document special cases and purpose, where necessary, especially for workarounds.
* For special case conditions place a comment between split lines, if there is a lot of cases in one statement.
* Don't format/split single line comments automatically.
Other:
* We do use "final" modifiers, especially for variables in lengthy method bodies, but also for not-to-be-changed instance members. Occasionally for very often used static methods, rather not for instance methods.

17
README.md
View File

@ -1,10 +1,10 @@
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/asofold/NCPDocs/blob/master/Features.creole).
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)
* 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.)
@ -32,7 +32,7 @@ Links
---------
Project
* [Project at BukkitDev] (http://dev.bukkit.org/server-mods/nocheatplus/)
* [NoCheatPlus at BukkitDev] (http://dev.bukkit.org/server-mods/nocheatplus/)
Download
* [BukkitDev (staff approved)] (http://dev.bukkit.org/server-mods/nocheatplus/files/)
@ -40,13 +40,14 @@ Download
Support and Documentation
* [Tickets] (http://dev.bukkit.org/server-mods/nocheatplus/tickets/)
* [Configuration] (https://github.com/asofold/NCPDocs/tree/master/wiki/configuration)
* [Permissions] (https://github.com/asofold/NCPDocs/blob/master/wiki/permissions/permissions.creole)
* [Commands] (https://github.com/asofold/NCPDocs/blob/master/wiki/Commands.creole)
* [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] (https://github.com/NoCheatPlus/NoCheatPlus/blob/master/LICENSE.txt)
* [API] (https://github.com/asofold/NCPDocs/blob/master/wiki/development/api.creole)
* [License (GPLv3)] (https://github.com/NoCheatPlus/NoCheatPlus/blob/master/LICENSE.txt)
* [API] (https://github.com/NoCheatPlus/Docs/wiki/API)
Related
* [CompatNoCheatPlus at BukkitDev] (http://dev.bukkit.org/server-mods/compatnocheatplus-cncp/)