Releases · BentoBoxWorld/BentoBox

01 May 16:29

1.13.0

a764e9e

Description

BentoBox 1.13.0 gets the ball rolling. It is the first major update of the Future development cycle of 2020 Q2. It brings in a lot of awesome and quality-of-life features for players, admins and addon developers! In these release notes, you will find the usual changelog, but also an overview of the new features as well as a detailed walkthrough of the API improvements for addons.

Alongside this update, you should update your addons to take advantage of all the new features. Updates for official addons will be progressively released over the next few weeks.

We are also officially launching our new documentation website! Basically, the contents of all the Wikis on each of our repositories have been moved to this website so that it can be more easily read and updated.

Which Minecraft versions are compatible with this release?

Compiled against: Spigot 1.15.2.
Tested on: 1.15.2.

Support BentoBoxWorld

As a user, you're the one that keeps us thrilled to make continuous updates and improvements to all the BentoBoxWorld products. This is a voluntary and time-consuming yet exciting hobby.

So don't hesitate to join our Discord server and give us a hug, a “Thank You”. And if you feel that extra-generosity rushing in, tip us on PayPal or become a sponsor of tastybento, that's really much appreciated! (Donors get a special rank on our Discord server!) ❤️

Overview of the new features

Keep player's old island when they reset their island

An option is added to the gamemodes' config, allowing admins to decide whether BentoBox should delete the players' islands when they reset theirs. If enabled, whenever a player resets their island, it is going to create a new one and leave the old one unowned. The player won't have access to it, but it will remain in the server's worlds. Those islands can be later definitely removed from the worlds by purging unowned islands. This might come in handy to be able to give players their island back if they accidentally deleted it; or to avoid deletion occurring while the server is running with players.

This feature was implemented by @Poslovitch and was requested in #1188.

Coop and Trust limitations

Prior to this release, players could coop or trust unlimited amount of fellow players to their island.
Specific options to define how many players can be cooped or trusted on an island are added to the gamemodes' config files, and similarly to the team size, you can assign permissions to players to allow them to coop or trust more players. Those permissions are the following: [gamemode].coop.maxsize.<number> and [gamemode].trust.maxsize.<number>.

This feature was implemented by @Cleymax in #1267 and was requested in #1065.

Player UUIDs in admin commands

In some cases, depending on the server setup, a player's UUID can change. This leads to some inconvenience when trying to re-register them to their own island. This new feature allows admins to use player UUIDs in most admin commands, such as follows:

This feature was implemented by @tastybento in #1298 and was requested in #1297.

Prefixes in localizations

Admins and addon developers can now define prefixes in the localization files that can be used virtually anywhere throughout the entirety of BentoBox and addons' localization files. As this feature allows for an unlimited amount of prefixes, admins and addon developers can also choose which message uses a specific prefix. Moreover, prefixes can be translated. Currently, only the BentoBox prefix is part of the default locales. That's up to you to add more, if you wish 😉.

A detailed guide about this new feature is being worked on and will be made available on the docs soon.

This feature was implemented by @Poslovitch and was requested in #1086.

An admin command to set an island's spawn point

In case the spawn point on an island is not where you'd like it to be, you will now be able to change it using this new command: /[admin_command] setspawnpoint. Easy to use!

This feature was implemented by @BONNe in #1295 and was requested in #937.

Change the behavior of the main player command

New options in gamemodes' config allow admins to define the behavior of the main player command. Admins can finally decide which subcommand should be executed when players have or do not have an island on the gamemode!

This feature was implemented by @BONNe in #1293 and was requested in #498.

Addon developers

Here you'll find the key points of this update and the things you should do to update your addons to the new standards.

Addons

Use the placeholder permissions

This feature allows addons to avoid updating their permissions each time there is a new gamemode.
You can use [gamemode] in their permissions to automatically register the permissions on all available gamemodes.

Example:

BEFORE

permissions:
  bskyblock.myperm:
    default: true
  acidisland.myperm:
    default: true
  skygrid.myperm:
    default: true

AFTER

permissions:
  [gamemode].myperm:
    default: true

Database management

Database#saveObject() has been deprecated. Use Database#saveObjectAsync() instead.

SafeSpotTeleport

SafeSpotTeleport now requires the use of its Builder in order to be instanciated.

Gamemodes

New provided commands

AdminSetSpawnPointCommand;
AdminPurgeStatusCommand (already called in AdminPurgeCommand).

Default commands API

BentoBox now provides two default commands (DefaultAdminCommand and DefaultPlayerCommand) that you can both register instead of having to create and update your own implementations of an admin and player commands.

Some gamemode addons are already implementing custom settings in their config to allow users to change the commands' label and aliases. If that's your case, do not forget to properly override getAdminCommandAliases() and getPlayerCommandAliases() from WorldSettings.

New WorldSettings

The following WorldSettings are to be overriden only if the default commands are used:
- getAdminCommandAliases();
- getPlayerCommandAliases();
- getDefaultPlayerAction();
- getDefaultNewPlayerAction().
Put the following WorldSettings close to the "max team size" option in the config. Eventually use a similar comment that explains what those two new settings do and which permission they are associated with.
- getMaxCoopSize(): [gamemode].coop.maxsize.<number>
- getMaxTrustSize(): [gamemode].trust.maxsize.<number>

Changelog

Legend

⚠️ deprecated/removed API.
🔺 need special attention.

API

Added some nullability annotations.
Added AdminPurgeStatusCommand to allow admins to view the current purge's status (#1254).
🔺 SafeSpotTeleport now requires the use of its Builder.
Added IslandEvent.IslandRankChangeEvent (@Cleymax, #1135, #1260).
Improved error message if BentoBox fails to save an Addon's config.
Added CompositeCommand#setHidden(boolean) to enable commands to be hidden from help and tab-complete (#1300, #1301).
Implemented ability to set an amount for a PanelItem: added #getAmount() and #setAmount(int) in PanelItemBuilder (@BONNe, #1299).
Added AdminSetSpawnPointCommand to change an island's spawn point (@BONNe, #937, #1295).
🔺 Made IslandsManager#getSafeHomeLocation(...) return null if the world is not an island world (#1306).
Added Addon#reloadConfig() (@YellowZaki, #1302).
Added DefaultPlayerCommand and DefaultAdminCommand (@BONNe, #498, #1293).
Added 4 new methods in WorldSettings: getAdminCommandAliases(), getPlayerCommandAliases(), getDefaultPlayerAction(), getDefaultNewPlayerAction() (@BONNe, #498, #1293).
⚠️ Deprecated the saveObject() method for databases (#1308).
🔺 Added saveObjectAsync() method for databases (#1308). This new method makes use of a CompletableFuture, making (async) saves into the database much easier to handle.
Implemented placeholder permissions for addons (#1303, #1305). Addons will no longer need to see their permissions updated each time there is a new gamemode. They can use [gamemode] in their permissions to automatically register the permissions on all available gamemodes.
Added 2 new methods in WorldSettings: getMaxCoopSize() and getMaxTrustSize() (@Cleymax, #1065, #1267).

Feature / Tweaks

Added %[gamemode]_island_members_list% and %[gamemode]_visited_island_members_list% placeholders (#1243, #1246).
Improved/Fixed EXPERIENCE_PICKUP flag on Paper servers (@kennytv, #1256).
🔺 IslandResetCommand now requires the [gamemode].island.reset permission (#1207).
🔺 Removed support for MVdWPlaceholderAPI - you can still use our placeholders through PlaceholderAPI.
Added %[gamemode]_on_island% placeholder (@Cleymax, #1168, #1259).
Updated copyright info in about command.
Added BREAK_SPAWNERS (PROTECTION) flag (@N0tMyFaultOG, #1130, #1263).
Added a single character prefix to database tables (#1277, #1278).
Added a config option to keep islands when pla...

Assets 4

21 Mar 12:44

tastybento

1.12.0

5c9cb4b

1.12.0 - The Future is Next

Description

BentoBox 1.12.0 polishes existing features and fixes bugs while we are concluding the Addons Initiative 2020 and moving towards our next roadmap for 2020 Q2 : Future. Through performance improvements and API additions, this update leads BentoBox to the path of becoming the sturdiest plugin capable of running island-based gamemodes, which is our dearest wish.

Alongside this update, you should not need to update your gamemode addons.

Which Minecraft versions are compatible with this release?

Compiled against: Spigot 1.15.2.
Tested on: 1.14.4 (might be unstable), 1.15.2.

We highly recommend you update to 1.15.2, as this will become our only compatible version by BentoBox 1.13.0.

Psssst! Are you still on 1.13.2? Well, if that is the case, you're missing out tons of 1.15-related features. But worry not, we've (unofficially) got your back covered. Download the BentoBox-1.12.0-1.13.2.jar file below, which is kindly provided by @BONNe. While we understand some may want to remain on 1.13.2 and are doing it thanks to his build, keep in mind you are at risk of addons becoming incompatible at some point.

What comes next?

We are currently reviewing our roadmap for the following months. We are planning to focus our efforts on polishing BentoBox. The current worldwide situation is leading to an increase of servers using BentoBox. Those are newcomers we want to welcome warmly into the BentoBoxWorld community through the implementation of a more user-friendly experience overall.