GherrixDevPlugins & Resources

Official documentation

BattlePassProxy

The free BungeeCord/Waterfall companion for a network-wide BattlePass, shared progression and proxy-level status commands.

View productGet support
BattlePassProxy cover

Getting started

Installation

  1. 1

    Stop the BungeeCord or Waterfall proxy completely.

  2. 2

    Install every required dependency listed below before BattlePassProxy.

  3. 3

    Place BattlePassProxy.jar inside the plugins folder.

  4. 4

    Start the BungeeCord or Waterfall proxy and review the generated BattlePassProxy configuration folder.

  5. 5

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

Supported environments

Compatibility

1.0.0Plugin version
Proxy companion for 1.20+ networksMinecraft
BungeeCord / WaterfallServer software
Java 17 or newerRuntime

Integrations

Dependencies

BattlePass

Required

Install BattlePass on each backend that records mission progress.

Reference

Commands

Network commands

CommandDescriptionPermission
/nbp status [player]Shows BattlePass status from the shared database.None
/nbp topShows the network leaderboard.None
/nbp send <server>Moves the player to a configured server.None
/nbp reloadReloads proxy configuration.battlepassproxy.admin

Access control

Permissions

PermissionDefaultDescription
battlepassproxy.adminAdministratorsAllows reloading the proxy companion.

Server setup

Configuration notes

  • Point the proxy companion and every backend BattlePass instance to the same SQLite database.

Important notes

  • Use BattlePassVelocity instead when your proxy is Velocity.

Visual guide

Images

BattlePassProxy temporary cover
BattlePassProxy - temporary GherrixDev cover