mirror of
https://github.com/BentoBoxWorld/AcidIsland.git
synced 2024-11-26 12:46:14 +01:00
Updated Readme
This commit is contained in:
parent
4a9158edbe
commit
7b86ec860a
42
README.md
42
README.md
@ -1,13 +1,43 @@
|
|||||||
# AcidIsland
|
AcidIsland
|
||||||
AcidIsland add-on for BentoBox.
|
==========
|
||||||
|
[![Build Status](https://ci.codemc.org/buildStatus/icon?job=BentoBoxWorld/AcidIsland)](https://ci.codemc.org/job/BentoBoxWorld/job/AcidIsland/)
|
||||||
|
[![Lines Of Code](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Aacidisland&metric=ncloc)](https://sonarcloud.io/component_measures?id=world.bentobox%3Aacidisland&metric=ncloc)
|
||||||
|
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Aacidisland&metric=sqale_rating)](https://sonarcloud.io/component_measures?id=world.bentobox%3Aacidisland&metric=Maintainability)
|
||||||
|
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Aacidisland&metric=reliability_rating)](https://sonarcloud.io/component_measures?id=world.bentobox%3Aacidisland&metric=Reliability)
|
||||||
|
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Aacidisland&metric=security_rating)](https://sonarcloud.io/component_measures?id=world.bentobox%3Aacidisland&metric=Security)
|
||||||
|
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Aacidisland&metric=bugs)](https://sonarcloud.io/project/issues?id=world.bentobox%3Aacidisland&resolved=false&types=BUG)
|
||||||
|
|
||||||
|
# Introduction
|
||||||
|
AcidIsland add-on for BentoBox, so to run AcidIsland, you must have BentoBox installed. It is not a Bukkit plugin and trying to use it as one will not work.
|
||||||
|
|
||||||
|
|
||||||
## The Story
|
## The Story
|
||||||
You're on an island, in a sea of acid! If you like Skyblock, try AcidIsland for a new challenge!
|
You're on an island, in a sea of acid! If you like Skyblock, try AcidIsland for a new challenge!
|
||||||
|
|
||||||
This is a variation of SkyBlock. Instead of falling, you must contend with acid water when expanding your island and players can boat to each other's islands.
|
This is a variation of SkyBlock. Instead of falling, you must contend with acid water when expanding your island and players can boat to each other's islands.
|
||||||
|
|
||||||
## Installing
|
## Installation
|
||||||
|
|
||||||
1. Place this jar into the addon folder of the BentoBox plugin.
|
0. Install BentoBox and run it on the server at least once to create its data folders.
|
||||||
2. Reload/restart the server
|
1. Place this jar in the addons folder of the BentoBox plugin.
|
||||||
3. Adjust the config.yml how you like
|
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.
|
||||||
|
|
||||||
|
### Other Add-ons
|
||||||
|
|
||||||
|
AcidIsland 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
|
||||||
|
* Biomes - enables biomes
|
||||||
|
|
||||||
|
You can find the projects on GitHub.
|
||||||
|
|
||||||
|
Bugs and Feature requests
|
||||||
|
=========================
|
||||||
|
File bug and feature requests here: https://github.com/BentoBoxWorld/AcidIsland/issues
|
||||||
|
Loading…
Reference in New Issue
Block a user