GherrixDevPlugins & Resources

Official documentation

BattlePassVelocity

The free Velocity companion for shared BattlePass progress, status lookup, leaderboards and backend synchronization.

BattlePassVelocity cover

Getting started

Installation

  1. 1

    Stop the Velocity proxy completely.

  2. 2

    Install every required dependency listed below before BattlePassVelocity.

  3. 3

    Place BattlePassVelocity.jar inside the plugins folder.

  4. 4

    Start the Velocity proxy and review the generated BattlePassVelocity configuration folder.

  5. 5

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

Supported environments

Compatibility

1.1.0Plugin version
Proxy companion for 1.20+ networksMinecraft
VelocityServer software
Java 17 or newerRuntime

Integrations

Dependencies

BattlePass

Required

Install BattlePass on every backend that participates in progression.

Reference

Commands

Network commands

CommandDescriptionPermission
/nbp status [player]Shows network BattlePass progress.None
/nbp topShows the network leaderboard.None
/nbp send <server>Moves the player to another server.None
/nbp reloadReloads proxy configuration.battlepassvelocity.admin
/nbp reloadallRequests a reload across connected backends.battlepassvelocity.admin

Access control

Permissions

PermissionDefaultDescription
battlepassvelocity.adminAdministratorsAllows network BattlePass administration.

Server setup

Configuration notes

  • Use the same storage settings and season configuration on the proxy companion and backend servers.

Important notes

  • This build is for Velocity. BungeeCord and Waterfall users should install BattlePassProxy.

Visual guide

Images