From a6df31244f7ca008c2d66501bc939cd6c8485c63 Mon Sep 17 00:00:00 2001 From: tastybento Date: Tue, 15 Jan 2019 18:35:28 -0800 Subject: [PATCH] Updated README with installation instructions. --- README.md | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bbf62fd..fadcf3c 100755 --- a/README.md +++ b/README.md @@ -2,20 +2,33 @@ BSkyBlock ========== [![Build Status](https://ci.codemc.org/buildStatus/icon?job=BentoBoxWorld/BSkyBlock)](https://ci.codemc.org/job/BentoBoxWorld/job/BSkyBlock/) -This is a survival game where the player starts with an island in the sky. +BSkyBlock is an addon for BentoBox, so to run BSkyBlock, you must have BentoBox installed. It is not a Bukkit plugin and trying to use it as one will not work. -BSkyBlock (Better SkyBlock) represents a turning point on ASkyBlock's history : Tastybento and Poslovitch thought and designed together this complete rewrite in order to provide a whole new way to play Skyblock. +## Installation -**Discover today BSkyBlock, its gameplay overhaul, and enjoy the Skyblock revival!** +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. -Add-ons -======= -BSkyBlock is an add-on that uses the BentoBox API. Here is a list of other ones: +## Config.yml + +The config.yml is similar to ASkyBlock but *not the same*. Note that distance-between-islands and protection-range are radius values so the island size will be twice these values! + + +### Other Add-ons + +BSkyBlock 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 * Welcome Warps - provides the warp sign feature * Challenges - challenges * AcidIsland - survival game in a sea of acid +* Biomes - enables biomes You can find the projects on GitHub.