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

Updated README.md.

This commit is contained in:
sk89q 2012-10-19 17:01:16 -07:00
parent 3d1012ba94
commit 05e408ee65
1 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,25 +1,34 @@
WorldGuard
![WorldGuard](http://i.imgur.com/EAnS0.png)
==========
WorldGuard protects your Minecraft server. As Minecraft's oldest surviving world protection mod, you know you're in safe hands.
WorldGuard is a toolbox of various functions, useful for multiplayer servers, that lets you:
* Protect your server from a number of problems.
* Block fire spread, lava spread, endermen, and more.
* Flag areas as "no PVP" or "no TNT."
* Assign ownership to areas so only selected individuals can build.
* Use a number of useful commands.
WorldGuard is open source and is available under the GNU General Public License.
Compiling
---------
You need to have Maven installed (http://maven.apache.org). Once installed,
simply run:
The project is written for Java 6 and our build process makes use of [Maven](http://maven.apache.org). Detailed compilation information [can be found on the wiki](http://wiki.sk89q.com/wiki/WorldGuard/Development#Compiling).
mvn clean install
Maven will automatically download dependencies for you. Note: For that to work,
be sure to add Maven to your "PATH".
Dependencies are automatically handled by Maven.
Contributing
------------
We happily accept contributions. The best way to do this is to fork WorldGuard
on GitHub, add your changes, and then submit a pull request. We'll look at it,
make comments, and merge it into WorldGuard if everything works out.
We happily accept contributions, especially through pull requests on GitHub.
By submitting code, you agree to place to license your code under the
GNU General Public License v3.
Please see [the wiki for further information about contributing](http://wiki.sk89q.com/wiki/WorldGuard/Development#Contributing).
Links
-----
* [IRC channel](http://skq.me/irc/irc.esper.net/sk89q/) (#sk89q on irc.esper.net)
* [Issue tracker](http://redmine.sk89q.com)
* [Continuous integration](http://build.sk89q.com) [![Build Status](https://secure.travis-ci.org/sk89q/worldguard.png)](http://travis-ci.org/sk89q/worldguard)
* [End-user documentation](http://wiki.sk89q.com/wiki/WorldGuard)