⚙️Configuration

The configurations are found at .../plugins/LeaderboardMenus/

⚙️ Default config.yml

# This plugin utilizes bStats which collects anonymous data (https://bStats.org/)
# You can find statistics about this plugin at https://bstats.org/plugin/bukkit/LeaderboardMenus/20242
# If you wish to disable data collection, change "enabled: true" to "enabled: false" in .../plugins/bStats/config.yml
# Config version, do NOT edit
config-version: "1.3.0"

leaderboard_name_beautifier:
  settings:
    enabled: true
    # true/false - Whether to capitalize after applying replacers
    # For example: "players killed" -> "Players Killed"
    capitalize_result_equals: false
    capitalize_result_contains: true
  replacers:
    # For these replacers to work, the board name must equal the matcher (case-sensitive)
    equals:
      # Name of the replacer
      walk:
        # What to match the board name with
        matcher: "statistic_walk_one_cm"
        # What to replace the matcher with
        replacement: "Cm walked"
    # For these replacers to work, the board name must contain the matcher
    contains:
      statistic:
        matcher: "statistic_"
        replacement: ""
      underscore:
        matcher: "_"
        replacement: " "
      colon:
        matcher: ":"
        replacement: ": "
        cut: true
        # This replacer section will only get applied if the "colon" replacement was successful
        # You can have as many nested if_match sections as you want
        if_match:
          comma:
            matcher: ","
            # Allows you to cut the board name until the matcher
            # For example: "kill_entity:ender_dragon,wither,warden,elder_guardian" -> "kill_entity:ender_dragon,"
            cut: true
            replacement: "..."

# Menu item options:
#  material: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Material.html
#  display_name: ""
#  enchantments: # This is using the minecraft namespace names for enchantments: https://www.digminecraft.com/lists/enchantment_list_pc.php
#    - enchantment;level
#  lore:
#    - ""
#  glow: true/false # Adds an invisible enchantment to make the item appear glowing
#  hide_enchants: true/false # Hides item enchantments
#  hide_attributes: true/false # Hides item attributes (Weapons, Armor...)
#  hide_unbreakable: true/false # Hides the unbreakable tag
#  hide_destroys: true/false # Hides the destroys tag
#  hide_placed_on: true/false # Hides the placed on tag
#  hide_potion_effects: true/false # Applicable for potions
#  hide_dye: true/false # Applicable for leather armor
#

menu:
  # Title of the menu
  title: "%board%: %timedType% (Page %currentPage%/%maxPages%)"
  rows: 6
  # Number of leaderboard players there can be at most in the menu
  max_entries: 100
  leaderboard_player:
    # Available internal placeholders:
    #  %position%         Position in the leaderboard
    #  %playerName%       Name of the player in the leaderboard
    #  %score%            Score format: 19288.0
    #  %scorePretty%      Score format: 19288
    #  %scoreFormatted%   Score format: 19,29k
    display_name: "<!i><#F3E9D0>#<b>%position%</b> <#ECC149>%playerName% <#6D6D6D><#569cd6>%scoreFormatted%"
  items:
    close:
      material: BARRIER
      display_name: <#c93434><!i>Close
      slot: 49
      click_commands:
#        - "[player]" # Command executed by the clicker
#        - "[console]" # Command executed by the console
#        - "[message]" # Message sent to the clicker
        - "[sound] ui.button.click" # Sound played to the clicker
        - "[close]" # Close menu
    previous_page:
      material: ARROW
      display_name: <#e5c07b><!i>Previous page
      slot: 48
      click_commands:
        - "[sound] ui.button.click"
        - "[previous]"
      fallback:
        material: GRAY_STAINED_GLASS_PANE
        display_name: <gray>
    next_page:
      material: ARROW
      display_name: <#e5c07b><!i>Next page
      slot: 50
      click_commands:
        - "[sound] ui.button.click"
        - "[next]"
      fallback:
        material: GRAY_STAINED_GLASS_PANE
        display_name: <gray>
    black_filler:
      material: BLACK_STAINED_GLASS_PANE
      display_name: <gray>
      slots:
        - 0
        - 8
        - 9
        - 17
        - 18
        - 26
        - 27
        - 35
        - 36
        - 44
        - 45
        - 53
    gray_filler:
      material: GRAY_STAINED_GLASS_PANE
      display_name: <gray>
      slots:
        - 1
        - 2
        - 3
        - 5
        - 6
        - 7
        - 46
        - 47
        - 51
        - 52

# You can define one alias for any board
# Whenever you execute "/aliasCommand", "/leaderboardmenu <boardName>" will be executed
# Format: <boardName>: "/aliasCommand"
# You can also use "/aliasCommand [timedType]"
# WARNING: Server restart is needed to register and unregister these alias commands
aliases:
  player_level: "/toplevels"
  statistic_walk_one_cm: "/topwalk"

# These are shown in the menu title with the %timedType% placeholder
timed_types:
  alltime: "alltime"
  hourly: "hourly"
  daily: "daily"
  weekly: "weekly"
  monthly: "monthly"
  yearly: "yearly"