EzBoost

CI GitHub Packages Coverage

EzBoost is a modern, production-ready Minecraft plugin for Spigot, Paper, and Bukkit servers (1.21+). It gives server owners full control over configurable, time-limited potion boosts – complete with GUI, cooldowns, economy integration, WorldGuard region support, and a developer API.

Features

  • Folia support – compatible with Folia; task scheduling automatically routes through Folia’s region schedulers when detected
  • Flexible boost definitions – configure any potion effect with duration, amplifier, cooldowns, limits, and particle effects via boosts.yml
  • Interactive GUI – fully-customisable chest-based boost menu driven by gui.yml; fully disableable
  • Economy integration – optional Vault economy support with per-boost pricing; gracefully skipped when Vault is absent
  • WorldGuard support – restrict boost activation to specific WorldGuard regions
  • Per-player and global limits – cap how many active boosts a player or the server can run simultaneously
  • Overrides – server-wide event-driven multipliers layered on top of individual boosts
  • PlaceholderAPI – exposes boost state and duration as placeholders for scoreboards, holograms, and more
  • Boost top leaderboard – /boosttop tracks and displays the all-time top boost buyers
  • MiniMessage formatting – all messages use the Adventure MiniMessage format for rich, hex-colour text
  • Developer API – clean Java API to start/stop boosts and listen to lifecycle events from other plugins

Quick start

1. Download the plugin:

Grab the latest EzBoost-x.y.z.jar from Releases and drop it into your server’s plugins/ directory.

2. Start your server once to generate default configuration files in plugins/EzBoost/.

3. Edit boosts.yml to define your server’s boost types, then edit settings.yml to enable economy or WorldGuard if needed.

4. Reload with /ezboost reload (requires ezboost.admin).

Documentation

Page What it covers
Commands All /boost and /ezboost commands with syntax and permissions
Permissions Full permissions reference and default values
Configuration settings.yml, limits.yml, worlds.yml, economy.yml
Boosts boosts.yml schema – effects, duration, cooldowns, costs
GUI gui.yml schema – slots, items, actions
Overrides Server-wide boost multiplier overrides
Events Plugin events overview
  BoostStartEvent Fired when a boost activates
  BoostEndEvent Fired when a boost expires or is cancelled
API EzBoost developer API overview
  EzBoostAPI Full public-method reference
  CustomBoostEffect Implementing custom boost effects
PlaceholderAPI Available placeholders and usage

Developer API

EzBoost exposes a Java API for starting/stopping boosts, querying active state, registering custom effect types, and listening to lifecycle events. See the API reference for setup instructions, method tables, and code examples.

<dependency>
  <groupId>com.github.ez-plugins</groupId>
  <artifactId>EzBoost</artifactId>
  <version>2.1.0</version>
</dependency>