BentoBox

About BentoBox

Slimeworld Edition

This version is a Proof Of Concept (POC) that uses the Slimeworld Manager.

How it works

• Each island exists in its own world
• The world is stored in a database via the SlimeWorldManager plugin
• Worlds are loaded when the player joins the server
• When a player resets, a new world is created
• In theory, a load-balancing system of multiple servers could use one world-storage database (not tested)

Limitations

• SlimeWorldManager only supports up to 1.15.2 so far, so use that server and client.
• Only supports BSkyBlock game mode, i.e., void world
• Does not support addons yet, e.g., Level, because they are not multi-world aware
• Worlds are not unloaded once they are loaded
• Old Slimeworlds are not deleted
• A default world (a hub or lobby world) is required for players to appear in after a server restart.
• Islands are always at 0,0 in any particular world (shouldn't be an issue).

Installation

1. Place the BentoBox jar into the plugins folder. Remove any addons except for BSkyBlock.
2. Download the latest version from the Spigot resource page.
3. Place the downloaded slimeworldmanager-plugin-<version>.jar file inside your server's plugin folder.
4. Place the slimeworldmanager-classmodifier-<version>.jar file inside your server's main directory (not the plugins folder).
5. Modify your server startup command and at this argument before '-jar':

-javaagent:slimeworldmanager-classmodifier-<version>.jar

6. Run the server.
7. Stop the server
8. Edit the SlimeWorldManager sources.yml to use the database you want. The default is flat-file.
9. Run the server again, log in and make an island with /island
10. Have fun!

Description

BentoBox is a powerful Bukkit library plugin that provides core features for island-style games like SkyBlock, AcidIsland, SkyGrid and others. These games are added to it via its unique Addon system. Further, non-game addons can provide features across games, such as challenges or warps. This enables admins to mix and match games and features to customize their server. It also enables the same code to be run across games, reducing bugs and speeding updates across all games. For coders, BentoBox has a powerful API allows for quick and easy development of these addons and simplifies complex aspects such as island protection, GUIs, and team management.

BentoBox is free and open-source software so join us to make this platform grow, become even more powerful and popular! Admins can pay to support BentoBox and Addons via donations and sponsorship.

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

Addons

These are 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 official Addons are listed here:

• Addons

There are also plenty of other official or community-made Addons you can try and use for your server!

Documentation

• Start reading: https://docs.bentobox.world
• For developers: Javadocs

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)
• Javadocs

What about contributing?

Join the BentoBox community. You don't need to know any programming language to start helping us.

You can contribute by:

• Donating or sponsoring the developers
• Coding new addons
• Adopting an Addon and maintaining it
• Translating text for BentoBox and Addons (We use GitLocalize to make this easier)
• Submitting good bug reports or helpful feature requests
• Fixing bugs and submitting Pull Requests for the fixes

If you contribute code it must be in agreement with:

• our license
• 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'
}

History

tastybento created ASkyBlock and AcidIsland that shared the same codebase. These plugins became very popular but became hard to maintain. Poslovitch was running a Skyblock server before starting to contribute regularly to ASkyBlock's codebase. He proposed the idea of completely rewriting ASkyBlock to make it easier to maintain and richer in features. In May 2017, this became the BSkyBlock project. As development progressed it became clear that a lot of the new core features could be used by other island-style games and so that core functionality was split off and renamed BentoBox and the addon system was created. The addons for BSkyBlock and AcidIsland became very simple to develop and much smaller. The community started to grow and we added new game modes like SkyGrid and CaveBlock by BONNe. BONNe also took over maintenance of Challenges and Biomes and contributed to other addons.

In December 2019, Poslovitch launched the BentoBox collection on SpigotMC and the story continues!