diff --git a/README.md b/README.md index 4572a28bd..4f766ab7b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,41 @@ This is a continually updated and custom version of Talabrek's Ultimate SkyBlock plugin, which he has decided to stop supporting. +# Installation + +This version depends on the following plugins: + +* Bukkit 1.8-R0.1-SNAPSHOT (I.e. the latest Spigot 1.8 release) +* Vault 1.4 +* WorldEdit 6.0.0-SNAPSHOT +* WorldGuard 6.0.0-SNAPSHOT + +## Config-files + +*Note*: The R0.X release candidates all change heavily in most of the config files, so place close attention to the changes between your local copy, and the "default" ones. + +# Building/Compiling + +Requirements: + +* Maven +* Java SDK 1.7 or above +* A local revision of the Spigot build (see http://www.spigotmc.org/threads/bukkit-craftbukkit-spigot-1-8.36598/) + +Configure Environment and Run Maven + +1. Define the SPIGOT_BASE environment variable to the folder where the BuildTools.jar reside +2. Make sure that the Bukkit folder in that hiearchy contains a /target/bukkit*.jar file +3. Run `mvn install` in the uSkyBlock folder + +## Issues + +Issues are maintained on the GitHub page: https://github.com/rlf/uSkyBlock/issues + +## Contributing + +Fork-away, and create pull-requests + ## License TL;DR - This is licensed under GPLv3 @@ -21,4 +56,4 @@ So even though Talabrek deserves all the credit in the world - for making such a ## References * [GPLv3](http://www.gnu.org/copyleft/gpl.html) - [tl;dr Legal](https://www.tldrlegal.com/l/gpl-3.0) -* Dutchy1001s guides and tutorials on uSkyBlock - [http://debocraft.x10.mx/skyblock/](http://debocraft.x10.mx/skyblock/) \ No newline at end of file +* Dutchy1001s guides and tutorials on uSkyBlock - [http://debocraft.x10.mx/skyblock/](http://debocraft.x10.mx/skyblock/)