An open API service indexing awesome lists of open source software.

https://github.com/bentoboxworld/bentobox

Expandable Minecraft server plugin for island-type games like SkyBlock or AcidIsland.
https://github.com/bentoboxworld/bentobox

acidisland askyblock bentobox bentobox-addon bentobox-gamemode bukkit-plugin gamemodes island minecraft minecraft-plugin plugin skyblock spigot spigot-plugin

Last synced: 24 days ago
JSON representation

Expandable Minecraft server plugin for island-type games like SkyBlock or AcidIsland.

Awesome Lists containing this project

README

          

# BentoBox

[![Discord](https://img.shields.io/discord/272499714048524288.svg?logo=discord)](https://discord.bentobox.world)
[![Build Status](https://ci.codemc.io/job/BentoBoxWorld/job/BentoBox/badge/icon)](https://ci.codemc.io/job/BentoBoxWorld/job/BentoBox/)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=BentoBoxWorld_BentoBox&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=BentoBoxWorld_BentoBox&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=BentoBoxWorld_BentoBox&metric=security_rating)](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=BentoBoxWorld_BentoBox&metric=bugs)](https://sonarcloud.io/dashboard?id=BentoBoxWorld_BentoBox)

# SkyBlock, OneBlock, AcidIsland, and more - all in one plugin

[![Discord](https://img.shields.io/discord/272499714048524288.svg?logo=discord)](https://discord.bentobox.world)

BentoBox powers island-style game modes for Paper servers. Pick the game modes you want, drop them in, and you're running. No forks, no outdated code — one actively maintained platform that stays current with every Minecraft release.

**Game modes available:**

- **BSkyBlock** — classic SkyBlock, successor to the original ASkyBlock
- **AOneBlock** — the popular OneBlock experience
- **AcidIsland** — survive in a sea of acid
- **Boxed** — expand your world by completing advancements
- **CaveBlock** — underground survival
- **SkyGrid** — scattered blocks, maximum adventure
- **Poseidon** — underwater island challenge
- And more community-created game modes

**Why server admins choose BentoBox:**

- Run multiple game modes on one server with shared features (challenges, warps, levels, leaderboards)
- 20+ addons let you customize exactly the experience you want
- Actively maintained and always up to date with the latest Minecraft version
- Free and open source — used on 1,100+ servers worldwide
- Rich API for developers who want to build custom addons

[Full Documentation](https://docs.bentobox.world)

# Installation

1. Place the BentoBox jar in your plugins folder
2. Start the server
3. Download the game mode and feature addons you want from [this site](https://hangar.papermc.io/BentoboxWorld/) or [download.bentobox.world](https://download.bentobox.world) and place them in the `plugins/BentoBox/addons` folder
4. Restart the server — you're good to go

## Addons
These are some popular Gamemodes:
* [**AcidIsland**](https://github.com/BentoBoxWorld/AcidIsland): You are marooned in a sea of acid!
* [**AOneBlock**](https://github.com/BentoBoxWorld/AOneBlock): Start to play with only 1 magical block.
* [**Boxed**](https://github.com/BentoBoxWorld/Boxed): A game mode where you are boxed into a tiny space that only expands by completing advancements.
* [**BSkyBlock**](https://github.com/BentoBoxWorld/BSkyBlock): The successor to the popular ASkyBlock.
* [**CaveBlock**](https://github.com/BentoBoxWorld/CaveBlock): Try to live underground!
* [**SkyGrid**](https://github.com/BentoBoxWorld/SkyGrid): Survive in world made up of scattered blocks - what an adventure!

All official Addons are listed here:
* [**Addons**](https://github.com/BentoBoxWorld/BentoBox/blob/develop/ADDON.md)

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](https://docs.bentobox.world)
* For developers: [Javadocs](https://ci.codemc.io/job/BentoBoxWorld/job/BentoBox/ws/target/apidocs/index.html)

## Bugs or Issues
[File bugs on GitHub](https://github.com/BentoBoxWorld/BentoBox/issues). Confused? Ask on Discord. Note: we are **not** a company, so please be kind with your requests.

### Developers
* [Jenkins](https://ci.codemc.org/job/BentoBoxWorld/job/BentoBox/) (**untested and mostly unstable builds**)
* [Javadocs](https://bentoboxworld.github.io/BentoBox/)

## What about contributing?

Join the BentoBox [community](https://github.com/BentoBoxWorld/BentoBox/graphs/contributors).
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](https://github.com/BentoBoxWorld/BentoBox/blob/develop/LICENSE)
* our [code of conduct](https://github.com/BentoBoxWorld/.github/blob/master/CODE_OF_CONDUCT.md)
* our contribution guidelines

### Report bugs and suggest features
Bugs and feature requests must be filed on our [issue tracker](https://github.com/BentoBoxWorld/BentoBox/issues).

### 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](https://codemc.org).

### Maven
```xml


codemc-snapshots
https://repo.codemc.org/repository/maven-snapshots


codemc-repo
https://repo.codemc.org/repository/maven-public/


world.bentobox
bentobox
PUT-VERSION-HERE
provided

```

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

dependencies {
compileOnly 'world.bentobox:bentobox:PUT-VERSION-HERE-SNAPSHOT'
}
```
**Note:** Due to a Gradle issue with versions for Maven, you need to use -SNAPSHOT at the end.