bentobox/README.md

BSkyBlock
==========

[![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=us.tastybento%3Abskyblock&metric=ncloc)
![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=us.tastybento%3Abskyblock&metric=sqale_rating)
![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=us.tastybento%3Abskyblock&metric=reliability_rating)
![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=us.tastybento%3Abskyblock&metric=security_rating)
![Bugs](https://sonarcloud.io/api/project_badges/measure?project=us.tastybento%3Abskyblock&metric=bugs)


A skyblock Bukkit plugin for Minecraft derived from the well-known ASkyBlock!
This is a survival game where the player starts with an island in the sky.

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.

**Discover today BSkyBlock, its gameplay overhaul, and enjoy the Skyblock revival!**

Add-ons
=======
BSkyBlock is built to enable add-ons (plugins that use the BSkyBlock API). Here is a list of the current ones:

* Level - provides island level calculation and a top ten
* Welcome Warps - provides the warp sign feature

You can find the projects on tastybento's GitHub.

Bugs and Feature requests
=========================
File bug and feature requests here: https://github.com/tastybento/bskyblock/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/