Upstream
/
bentobox
mirror of https://github.com/BentoBoxWorld/BentoBox.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Fix readme. 

API and Jenkins references will need to change I expect.
This commit is contained in:
tastybento 2018-07-29 13:41:17 -07:00
parent 268a301a47
commit d383bf9231
1 changed files with 58 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -1,2 +1,58 @@
# bentobox
BentoBox Minecraft Plugin
BentoBox
========
[![Build Status](https://travis-ci.org/tastybento/bskyblock.svg?branch=master)](https://travis-ci.org/tastybento/bskyblock)
![Lines Of Code](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=ncloc)
![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=sqale_rating)
![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=reliability_rating)
![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=security_rating)
![Bugs](https://sonarcloud.io/api/project_badges/measure?project=world.bentobox%3Abentobox%3Adevelop&metric=bugs)
BentoBox is an expandable Minecraft Bukkit plugin for island-type games like ASkyBlock or AcidIsland.
Admins can assemble the game or games how they like with a variety of add-ons. These include:
BSkyBlock - the successor to the popular ASkyBlock. Don't fall!
AcidIsland - you are marooned in a sea of acid!
Level - an add-on to calculate your island level and show a top ten
Challenges - an add-on that gives you challenges to accomplish
Welcome WarpSigns - an add-on that enables players to plant a warp sign
Bentobox 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.
**Discover today BSkyBlock, its gameplay overhaul, and enjoy the Skyblock revival!**
Bugs and Feature requests
=========================
File bug and feature requests here: https://github.com/BentoBoxWorld/bentobox/issues
Note for developers
===================
This is an actively developed project but we are not currently accepting Pull Requests from non-collaborators. Once we have finished the main development, we'll be open to PR's.
Development Builds
==================
Jenkins: https://ci.codemc.org/job/Tastybento/job/bskyblock/
API
===
Maven dependency:
```xml
<repositories>
<repository>
<id>codemc-repo</id>
<url>https://repo.codemc.org/repository/maven-public/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>us.tastybento</groupId>
<artifactId>bskyblock</artifactId>
<version>FC-0.74</version>
<scope>provided</scope>
</dependency>
</dependencies>
```
You can find the javadoc here: https://ci.codemc.org/job/Tastybento/job/bskyblock/javadoc/