Why EzBoost?

• Clean, modern GUI – Let players browse available boosts, see cooldowns, costs, and status at a glance.
  
• Admin GUI – Create and manage boosts through an intuitive admin interface.
  
• Fully configurable boosts – Define any potion effects, amplifiers, durations, and permissions per boost.
• Cooldown control – Per-boost cooldowns with bypass permissions and optional per-type cooldown tracking.
  
• Guardian hover preview - Totem-style Guardian boost tooltip in the /boost GUI.
  
• Economy-ready – Optional Vault integration to charge currency per boost activation.
• World restrictions – Allow/deny specific worlds for tight gameplay balancing.
• Region-based overrides (WorldGuard) – Change boost effects, cost, or disable boosts in specific WorldGuard regions. WorldGuard is detected automatically if present.
• Boost tokens – Give, trade, or reward boost tokens. Players redeem tokens by right-clicking them to activate the boost.
• Player safety options – Keep boosts on death, reapply on join, and refund on failed activation.

Feature Highlights

• GUI-first experience – Inventory menu with configurable filler, slot layout, and MiniMessage formatting.
• Fully configurable boosts – Define custom potion effects, amplifiers, durations, and permissions per boost.
• Multi-file configuration – Clean separation of settings, GUI, boosts, and more for easy management.
• Storage backends – Persist boost states to YAML (default), SQLite, MySQL, MariaDB, or PostgreSQL. Configured in storage.yml.
• Boost top leaderboard – /boosttop tracks and displays the all-time top boost buyers.
• Folia support – Fully compatible with Folia servers; task scheduling routes through Folia's region schedulers automatically.
• Region & World Overrides – Use boosts.yml (top level) to define per-world or per-region settings. If WorldGuard is installed, region overrides are applied automatically using region IDs.
• Boost tokens – Grant boost token items with /ezboost give for rewards, crates, or shops. Players redeem tokens by right-clicking them to instantly activate the boost.
• Flexible limits – Clamp duration/amplifier ranges to keep boosts balanced.
• Per-boost cooldowns – Prevents abuse and enables balanced gameplay.
• World restrictions – Allow/deny boosts in specific worlds for tight gameplay tuning.
• Vault economy support – Optionally charge players for activating boosts.
• Live reload – Reload all configuration and messages at runtime with /ezboost reload.
• Friendly messaging – Customizable MiniMessage strings for actionbar/status feedback.
• Internal message tags – Use <boost_display>, <boost_cost>, <boost_duration> and more directly in messages.yml – no PlaceholderAPI needed.
• PlaceholderAPI expansion – 18+ placeholders for boost status, active boost, cooldowns, time remaining, XP multiplier and economy formatting. Usable in scoreboards, GUI plugins and any PAPI-compatible plugin.
• Command hooks – Run console commands on enable/disable/toggle per boost.
• Player-friendly behavior – Reapply boosts on join, keep on death, and refund on failed activation.

Quick Start

• Drop EzBoost.jar into plugins/, then start your Spigot, Paper, Bukkit, or Folia server (1.21+).
• Use /ezboost create to open the admin GUI and create boosts.
• Edit plugins/EzBoost/boosts.yml, gui.yml, and related config files to configure boosts, cooldowns, costs, and GUI slots.
• Use /boost to open the GUI, or /boost <boostKey> for direct activation.
• Use /ezboost give <player> <boostKey> [amount] to give boost tokens. Players redeem tokens by right-clicking them.
• Grant permissions like ezboost.boost.speed to control access per boost.

Commands & Permissions

Command	Description	Permission
/boost	Open the boosts GUI or show usage.	ezboost.use
/boost <boostKey>	Activate a specific boost directly.	ezboost.use + boost permission
/boosttop	View the top boost buyers leaderboard.	ezboost.top
/ezboost create	Open the admin GUI to create boosts.	ezboost.admin
/ezboost reload	Reload configuration and messages.	ezboost.reload
/ezboost give <player> <boostKey> [amount]	Give boost token items. Players redeem by right-clicking.	ezboost.give

For detailed command and permission documentation, see Commands and Permissions.

Setup Guide

Tip: Region & World Overrides

• Use region IDs from WorldGuard in boosts.yml to customize boost behavior per region.
• If WorldGuard is not installed, region overrides are ignored.
• See Overrides Documentation for syntax and examples.

Documentation & Support

• EzBoost GitHub Repository – Main source for all documentation, guides, and updates.
• Configuration Guide – Full details on all config options.
• Boosts Reference – YAML format and boost customization.
• GUI Customization – How to configure the boost GUI.
• Overrides Documentation – Region/world override syntax and examples.
• EzBoost Discord Support – Need help or want to chat? Join our Discord!

For issues, feature requests, and the latest releases, always check GitHub first.