Skip to main content

Configuration

The configuration file for Nexal Leaderboards. Located at plugins/Nexal Leaderboards/config.yml.

config.yml
# ================================
# Nexal Leaderboards Configuration
# ================================

# Storage settings
storage:
  # Storage type: json or sql
  # To move your data: /lb admin export, change the type, /lb admin reload, /lb admin import
  type: json

  # SQL database settings (only used if type is 'sql')
  sql:
    host: localhost
    port: 3306
    database: minecraft
    username: root
    password: ""

# Default refresh interval in seconds (minimum 10)
# This is used when a new placeholder starts being tracked
# Individual leaderboards can have their own interval set via /lb admin setinterval
default-refresh-interval: 300  # 5 minutes

# Automatically start tracking a placeholder when it's first queried via PAPI
# (e.g. %nexalleaderboards_vault_eco_balance_1%). Only placeholders that give a number
# for at least one online player are tracked; anything else is ignored.
# If false, placeholders must be manually tracked using /lb admin track
auto-track-on-query: true

# Maximum players to track per leaderboard (performance optimization)
# Set to -1 for unlimited
max-tracked-per-leaderboard: 1000

# GUI settings
gui:
  # How often an open leaderboard GUI redraws, in ticks (20 ticks = 1 second)
  auto-refresh-ticks: 100  # 5 seconds

Configuration Options​

Below is a reference of the main configuration sections:

storage​

================================ Nexal Leaderboards Configuration

Storage settings

default-refresh-interval​

Default refresh interval in seconds (minimum 10) This is used when a new placeholder starts being tracked Individual leaderboards can have their own interval set via /lb admin setinterval

auto-track-on-query​

Automatically start tracking a placeholder when it's first queried via PAPI (e.g. %nexalleaderboards_vault_eco_balance_1%). Only placeholders that give a number for at least one online player are tracked; anything else is ignored. If false, placeholders must be manually tracked using /lb admin track

max-tracked-per-leaderboard​

Maximum players to track per leaderboard (performance optimization) Set to -1 for unlimited

gui​

GUI settings