Merge remote-tracking branch 'origin/master'

README.md

@@ -1,2 +1,39 @@
 # CaveBlock
-CaveBlock addon for BentoBox. An interesting variation from Skyblock, where your goal is to survive in a cube of stone!
+
+CaveBlock is an addon for BentoBox, so to run CaveBlock, you must have BentoBox installed. It is not a Bukkit plugin and trying to use it as one will not work.
+
+## Installation
+
+0. Install BentoBox and run it on the server at least once to create its data folders.
+1. Place this jar in the addons folder of the BentoBox plugin.
+2. Restart the server.
+3. The addon will create worlds and a data folder and inside the folder will be a config.yml.
+4. Stop the server .
+5. Edit the config.yml how you want.
+6. Delete any worlds that were created by default if you made changes that would affect them.
+7. Restart the server.
+
+## Config.yml
+
+The config.yml is similar to BSkyblock and AcidIsalnd but *not the same*. It has some additional or changed parameters, like,
+instead of wrold-height it has world-depth.
+It also has option to choose main block for each world, and blocks that will be occasionally replace main block, f.e. diamond ore or shulker.
+It also allows to specifiy if roof and floor for each world must be generated from bedrock.
+
+
+### Other Add-ons
+
+CaveBlock is an add-on that uses the BentoBox API. Here are some other ones that you may be interested in:
+
+* Level - provides island level calculation and a top ten - may need some adjusments, as main block will be over all island.
+* Welcome Warps - provides the warp sign feature
+* Challenges - challenges
+* Biomes - allows to change biomes per island
+* Greenhouses - allows to create green houses that provides some biome specific materials / mobs.
+* invSwitcher - allows to switch inventories between gamemode worlds
+
+You can find the projects on GitHub.
+
+Bugs and Feature requests
+=========================
+File bug and feature requests here: https://github.com/BentoBoxWorld/CaveBlock/issues