mirror of
https://github.com/plexusorg/Plex-FAWE.git
synced 2025-08-02 08:14:05 +00:00
Modernized pom, readmes.
This commit is contained in:
66
README.md
66
README.md
@@ -1,56 +1,36 @@
|
||||
WorldEdit
|
||||

|
||||
=========
|
||||
|
||||
WorldEdit is a voxel and block manipulation library for Minecraft. It is
|
||||
primarily a library but bindings to Bukkit (included) and SPC (external)
|
||||
are available.
|
||||
WorldEdit is an easy-to-use in-game world editor for Minecraft, supporting both single
|
||||
player and multiplayer, that lets you:
|
||||
|
||||
* Change thousands of blocks in an area at once by selecting regions.
|
||||
* Use over 100 functions to modify the world or remove problems.
|
||||
* Remove large chunks of land as you wish.
|
||||
* Sculpt the world and build mountains with brushes.
|
||||
* Fix annoyances such as broken water, missing snow, raging fires, and more.
|
||||
|
||||
WorldEdit is open source and is available under the GNU General Public License v3.
|
||||
|
||||
Compiling
|
||||
---------
|
||||
|
||||
You need to have Maven installed (http://maven.apache.org). Once installed,
|
||||
simply run:
|
||||
|
||||
mvn clean install
|
||||
|
||||
Maven will automatically download dependencies for you. Note: For that to work,
|
||||
be sure to add Maven to your "PATH".
|
||||
|
||||
|
||||
Compiling branches from pull requests
|
||||
-------------------------------------
|
||||
WARNING: This is not recommended if you dont understand the changes and/or
|
||||
trust the sender of the pull request!
|
||||
|
||||
You need to have Maven and Git installed.
|
||||
|
||||
Run the following commands:
|
||||
|
||||
git clone -b <branch> git://github.com/<author>/worldedit.git <directory>
|
||||
cd <directory>
|
||||
mvn clean package
|
||||
|
||||
The <directory> is just a directory name you can pick at your leisure
|
||||
The other placeholders should be filled in from the pull request's headline:
|
||||
|
||||
<author> wants someone to merge 1 commit into sk89q:master from <author>:<branch>
|
||||
|
||||
|
||||
Issue Tracker
|
||||
-------------
|
||||
|
||||
Please submit bug reports and feature requests here:
|
||||
http://redmine.sk89q.com/projects/worldedit/issues
|
||||
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/WorldEdit/Development#Compiling).
|
||||
|
||||
Dependencies are automatically handled by Maven.
|
||||
|
||||
Contributing
|
||||
------------
|
||||
|
||||
We happily accept contributions. The best way to do this is to fork
|
||||
WorldEdit on GitHub, add your changes, and then submit a pull request. We'll
|
||||
look at it, make comments, and merge it into WorldEdit if everything
|
||||
works out.
|
||||
We happily accept contributions, especially through pull requests on GitHub. Submissions
|
||||
must be licensed under the GNU Lesser General Public License v3.
|
||||
|
||||
All new submissions have to be licensed under the GNU Lesser General
|
||||
Public License v3, which is outlined inside LICENSE_LGPL.txt.
|
||||
Please see [the wiki for further information about contributing](http://wiki.sk89q.com/wiki/WorldEdit/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) [](http://travis-ci.org/sk89q/worldedit)
|
||||
* [End-user documentation](http://wiki.sk89q.com/wiki/WorldEdit)
|
Reference in New Issue
Block a user