# Leaderboards

The Leaderboards system allows you to showcase the wealthiest players for each currency. You can display these rankings through text-based messages or a nice GUI. It also includes server balance placeholders for use with PlaceholderAPI.

# 🛡️ Hiding Players

If you need to exclude certain players (like staff members) from appearing on the rankings, you can do so by giving them the coinsengine.hidefromtops permission.

Note

Permission changes will be applied the next time the leaderboard updates if the player is online. Otherwise, the player must (re-)join the server first for the plugin to inspect its permissions.

# ⚙️ Main Configuration

You can manage the Leaderboards settings by editing the config.yml file.

config.yml
Top:
  # Turns the entire leaderboard system on or off.
  Enabled: true
  # Enables a visual menu for players to view rankings.
  Use_GUI: true
  # Sets how many players are shown on a single page in the chat-based rankings.
  # [*] Useful for text-based leaderboard only. For the GUI, there is an explicit slots setting in the GUI config.
  Entries_Per_Page: 10
  # Controls how often the plugin recalculates the top player list.
  # [Asynchronous]
  # [Default is 900 (15 minutes)]
  Update_Interval: 900

To customize the look of the GUI, edit the /menu/leaderboard.yml file.

# 💎 Currency Settings

You can choose to disable the leaderboard for specific currencies by editing their individual Currency File:

Leaderboard:
  Enabled: false