Upgrades#

Upgrades gives players a progression curve by letting them purchase island upgrades — expanded protection range, higher block/entity limits, custom commands, spawner boosts, and crop growth boosts — using money, items, permissions, or island level.

Created and maintained by tastybento.

Installation#

1. Place the Upgrades addon jar in the addons folder of the BentoBox plugin.
2. Restart the server.
3. On first run, 8 example upgrades are seeded automatically so you can get started right away.
4. Use /[admin_command] upgrades to customise or create upgrades in-game.

How It Works#

Upgrades, their tiers, prices, and rewards are stored in BentoBox's database (YAML, JSON, MySQL, MongoDB, etc.). There is no large config file to edit. All upgrade data is loaded, cached, and saved automatically by the addon.

On first install the seeder creates 8 example upgrades. Once you delete an example upgrade it will not be re-seeded on the next restart. To re-trigger seeding, delete the .seeded-gamemodes marker file from the addon data folder.

Tiers and Levels#

Each upgrade is made up of one or more tiers. A tier covers a range of levels — for example, a tier might cover levels 0 to 4, meaning any player whose upgrade level falls in that range is affected by that tier's rewards.

• When a player purchases an upgrade their level increases by 1.
• The rewards applied are always those of the tier whose range contains the player's current level. Moving into a new tier's range immediately switches to that tier's rewards.
• A tier can require multiple prices (all must be paid) and grant multiple rewards (all are applied).
• Price and reward formulas can use variables (see Formula Variables) to scale automatically with level, island level, or team size.

Commands#

Price Types#

Each upgrade tier can require any combination of the following prices (all must be met to purchase):

Reward Types#

Each upgrade tier can grant any combination of the following rewards:

Commands#

The Commands reward runs one or more commands when a player purchases the upgrade.

• Console mode: commands run as the server console (use this for /give, rank-up commands, or anything requiring elevated permissions).
• Player mode: commands run as the purchasing player (limited to their own permissions).

The following placeholders are available in command strings:

• [player] — the name of the player who purchased the upgrade
• [owner] — the island owner's name

Spawner Boost#

Spawner Boost is a passive, always-on effect. It does not do anything at purchase time; it takes effect immediately and stays active as long as the island holds that upgrade level.

Every time a spawner on the island fires, the addon totals the island's Spawner Boost value across all active upgrade tiers and spawns that many additional mobs of the same type at the same location.

The formula value is a bonus multiplier:

Bonuses from multiple upgrades that include a Spawner Boost reward are added together. The boost works for all spawner types.

Crop Growth Boost#

Crop Growth Boost is also a passive, always-on effect. When a crop grows naturally, the addon applies additional bone-meal growth ticks equal to the bonus value — making crops grow faster the higher a player's upgrade level.

The formula value works the same way as Spawner Boost:

Bonuses from multiple upgrades stack. Supported crops: Wheat, Carrots, Potatoes, Beetroots, Nether Wart, Sweet Berry Bush, Torchflower, Pitcher Plant.

Formula Variables#

Formula fields in both prices and rewards support the following variables:

• [level] — the current upgrade level being purchased (or active)
• [islandLevel] — the island's current level (from Level addon; may be 0 if Level is not installed)
• [numberPlayer] — the number of players on the island team

These let you write formulas that scale automatically, e.g. a money cost of 500 * [level] or a spawner bonus of 0.1 * [level].

Permissions#

Permissions are granted automatically by the addon based on upgrade configuration. Check the addon.yml for the current permission list.

API#

The UpgradeAPI class is exposed for other addons to query and modify upgrade data programmatically. See the JavaDocs linked from the addon description above.

Changelog#

Translations#