3 Developer Documentation

tastybento edited this page 2020-02-16 07:48:29 -08:00

Table of Contents

• Welcome to the BentoBox developer documentation!
• JavaDocs
• Example Addon

Welcome to the BentoBox developer documentation!

BentoBox is a platform plugin that supports a suite of API's for addons that run on it. The architecture is virtually identical to the Bukkit plugin system. You can create GameModeAddons like BSkyBlock that provide players with your own game mode experience, or you can develop utility plugins, like Warps that enable players in any game mode (or even normal worlds) to use warp signs.

JavaDocs

Javadocs are here: https://bentoboxworld.github.io/BentoBox/

The core API package is world.bentobox.bentobox.api.*. Methods in those packages are kept as stable as possible over the long term. Methods and classes outside of the api package may change a lot or more frequently.

Example Addon

@BONNe maintains an example addon here: https://github.com/BONNePlayground/ExampleAddon

Homepage

Getting started

• Install BentoBox
• Migration from ASkyBlock or other plugins
• Set a BentoBox world as the server default world
• Database transition

About BentoBox

• Commands
• Permissions
  • AcidIsland, BSkyBlock, CaveBlock, SkyGrid
  • Biomes, Challenges, Level, Limits, WelcomeWarpSigns
• Island Protection, Flags & Ranks
  • Flags
  • Ranks
• Placeholders
• Blueprints

Using BentoBox's API

• Introduction to the API
• How to get data from Addons to Plugins
• Addons
  • addon.yml
  • Config API
  • Databases
• Creating a Game Mode Add-on
• Built-in Commands
• Javadocs
• Plans