VaultLeaderboards — Getting Started

Requirements

Before installing, make sure your server meets the minimum requirements. VaultLeaderboards targets modern Paper builds and requires a Vault economy provider.

Dependency	Version	Required
Paper	1.21 or newer	Required
Java	21 or newer	Required
Vault	1.7 or newer	Required
Economy Plugin	Any Vault-compatible	Required
PlaceholderAPI	2.11.5 or newer	Optional

Economy provider. VaultLeaderboards needs at least one Vault economy plugin installed (such as EssentialsX, CMI, or EconomyShopGUI). The plugin will disable itself if no economy provider is found.

Installation

Installation is a standard plugin drop-in. No build step required.

1

Download the jar

Grab the latest release from Modrinth or GitHub Releases. Always prefer the Modrinth release for stable builds.

2

Drop it into your plugins folder

Copy VaultLeaderboards-x.x.x.jar into your server's /plugins directory.

3

Start the server

Start or restart your server. VaultLeaderboards will generate its configuration file under /plugins/VaultLeaderboards/ on first run.

4

Verify it loaded

Run /vl status or check the console for the VaultLeaderboards startup banner confirming the plugin loaded correctly.

After first boot, you can customise all display formats by editing config.yml. Leaderboard templates, refresh intervals, and database settings are all configurable.

First Run

On first startup, VaultLeaderboards will:

1. Detect and connect to your Vault economy provider.

2. Generate the default config.yml configuration file.

3. Begin scanning online player balances on the configured refresh interval (default 60 seconds).

If PlaceholderAPI is installed, the VaultLeaderboards expansion is registered automatically. No extra steps needed.

Integrations

VaultLeaderboards detects supported plugins at startup and hooks into them automatically. No extra configuration is required to enable a hook — just have the plugin loaded before VaultLeaderboards starts.

Vault Economy

Vault is a hard dependency. VaultLeaderboards reads player balances via Economy.getBalance() on a configurable interval. Works with any Vault-compatible economy plugin.

PlaceholderAPI

Installing PlaceholderAPI automatically registers the VaultLeaderboards expansion, exposing placeholders for top players, individual player rank, server average, and time-based top earners. Use %vaultleaderboards_<placeholder>% in any PAPI-compatible plugin.

MySQL (Optional)

When database mode is enabled, VaultLeaderboards syncs balances to MySQL via HikariCP for cross-server leaderboards. Balance history is recorded automatically for time-based queries.