GherrixDevPlugins & Resources

Official documentation

BattlePass

A complete free BattlePass for Spigot, Paper and Folia with free and premium tracks, missions, XP sources, reward claiming and network-ready storage.

BattlePass cover

Getting started

Installation

  1. 1

    Stop the Minecraft server completely.

  2. 2

    Install every required dependency listed below before BattlePass.

  3. 3

    Place BattlePass.jar inside the plugins folder.

  4. 4

    Start the Minecraft server and review the generated BattlePass configuration folder.

  5. 5

    Test the plugin on a staging server before enabling it for all players.

Supported environments

Compatibility

1.5.0Plugin version
1.20+Minecraft
Spigot / Paper / FoliaServer software
Java 17 or newerRuntime

Integrations

Dependencies

PlaceholderAPI

Optional

Exposes BattlePass placeholders to other plugins.

Reference

Commands

Player commands

CommandDescriptionPermission
/battlepassOpens the BattlePass GUI.battlepass.use
/bp seasonShows the current season information.battlepass.use
/bp statusShows your tier, XP and premium status.battlepass.use
/bp missionsOpens the mission GUI.battlepass.use
/bp topOpens the XP leaderboard.battlepass.use
/bp claim <tier> <free|premium>Claims one unlocked reward.battlepass.use
/bp claimallClaims every available reward.battlepass.use

Administration commands

CommandDescriptionPermission
/bp status <player>Shows another player's progress.battlepass.admin
/bp addxp|setxp <player> <amount>Changes BattlePass XP.battlepass.admin
/bp givelevel <player> <tier>Sets a player's tier.battlepass.admin
/bp premium <player> <on|off>Changes premium access.battlepass.admin
/bp reset <player>Resets one player's progress.battlepass.admin
/bp resetseasonResets the current season for all players.battlepass.admin
/bp reloadReloads configuration and messages.battlepass.admin

Access control

Permissions

PermissionDefaultDescription
battlepass.useEveryoneAllows players to use the BattlePass.
battlepass.adminAdministratorsAllows staff to manage progress, premium access and seasons.
battlepass.premiumNobodyGrants automatic premium-track access.

Server setup

Configuration notes

  • Configure tiers, missions, reward commands, icons and XP sources in the generated YAML files.
  • Reward commands support player, UUID, tier and track placeholders.
  • Network mode can share progression through a common SQLite database.

Important notes

  • Command aliases are /bp and /pass.
  • Use the matching proxy companion only when running BattlePass across a network.

Visual guide

Images