bentobox/README.md

BentoBox

BentoBox is an expandable Minecraft plugin for island-type games like SkyBlock or AcidIsland.

About BentoBox

History

ASkyBlock and AcidIsland were originally created by tastybento. These two plugins were sharing the same codebase, which grew fastly but ultimately became hard to maintain. Poslovitch was running a Skyblock server before starting to contribute regularly on ASkyBlock's codebase.

Then came the idea of completely rewriting ASkyBlock. A turning point that would be called BSkyBlock. In May 2017, tastybento agreed to the idea, and Poslovitch and him spent more time developing the code of the plugin which would become BentoBox. During summer 2018, ASkyBlock's support got dropped and development was focused on the now called plugin BentoBox, which would then take over ASkyBlock and AcidIsland for 1.13+ servers.

Description

BentoBox introduces a unique Addon system and a powerful API which allows for a technically unlimited customization of the gamemodes. Therefore, BentoBox does nothing on its own: addons and gamemodes are bringing the features.

BentoBox being totally free and open-sourced, we are confident in seeing this platform grow and become even more powerful in the future.

Start now to create the server you've dreamed of!

Addons

These include some popular Gamemodes:

• AcidIsland: You are marooned in a sea of acid!
• BSkyBlock: The successor to the popular ASkyBlock.
• CaveBlock: Try to live underground!
• SkyGrid: Survive in world made up of scattered blocks - what an adventure!

All Addons can be found below:

• Addons: A list of all addons currently make for bentobox by us. There are also plenty of other official or community-made Addons you can try and use for your server!

Documentation

• Installation guide
• Javadocs
• Wiki

Downloads

Webtool

A webtool is currently being developed to allow you to easily setup BentoBox and Addons on your server.

Direct links

• Download

Developers

• Jenkins (untested and mostly unstable builds)

What about contributing?

BentoBox heavily relies on the community that gets involved in its development. You don't need to know any programming language to start helping us.

However, your contribution must be in agreement with:

• our code of conduct
• our contribution guidelines

Report bugs and suggest features

Bugs and feature requests must be filed on our issue tracker.

Pull requests

We consider Pull Requests from non-collaborators that contain actual code improvements or bug fixes. Do not submit PRs that only address code formatting because they will not be accepted.

API

BentoBox uses Maven, and its Maven repository is kindly provided by CodeMC.

Maven

<repositories>
  <repository>
    <id>codemc-repo</id>
    <url>https://repo.codemc.org/repository/maven-public/</url>
  </repository>
</repositories>

<dependencies>
  <dependency>
    <groupId>world.bentobox</groupId>
    <artifactId>bentobox</artifactId>
    <version>PUT-VERSION-HERE</version>
    <scope>provided</scope>
  </dependency>
</dependencies>

Gradle

repositories {
  maven { url "https://repo.codemc.org/repository/maven-public/" }
}

dependencies {
  compileOnly 'world.bentobox:bentobox:PUT-VERSION-HERE'
}