Categories (main menu)

Guide to configure the main menu. menus/categories.yml

For the general ITEM configuration please see Item config

Left clicking a category opens its collection list. Right clicking opens the category rewards menu if the category has levels defined in categories.yml. Categories locked behind a permission the player doesn't have can't be clicked.

Placeholders you can use in the category items:

{name} - name of the category
{progress_percent} and {progressbar} - category completion (based on collection levels)
{total}, {total_formatted}, {total_short} - total collected items in the category
{maxed_collection_count}, {total_collection_count}, {maxed_progress_percent}, {maxed_progressbar} - maxed out collections in the category
{unlocked_collection_count}, {unlocked_progress_percent}, {unlocked_progressbar} - unlocked (discovered) collections in the category
{lb_position}, {lb_position_percent}, {lb_size} - category leaderboard position

You can also use these global placeholders here (and in the custom items): {unlocked_total_count}, {total_all_collection_count}, {unlocked_total_percent} and {unlocked_total_progressbar}, which are based on every collection in every category.

# Name of the inventory gui
title: "Collections"

# How many rows should the chest inventory have?
rows: 6

# How should the progress bars look like?
# Used by {progressbar}, {maxed_progressbar}, {unlocked_progressbar}
# and {unlocked_total_progressbar}
progress-bar:
  length: 10
  filled-character: "&a&l■"
  unfilled-character: "&7&l■"

# Should we fill the empty slots?
filler:
  enabled: true
  item:
    name: " "
    material: BLACK_STAINED_GLASS_PANE
    hide-tooltip: true

# These keys should match exactly the keys you used in categories.yml
items:
  farming:
    name: "&a{name} Collections"
    lore:
      - "&7View your {name} collections!"
      - ""
      - "&7Completion: &e{progress_percent}%"
      - "&7Total collected: &e{total_formatted}"
      - ""
      - "&8Global ranking: &8#&a{lb_position}"
      - "&8You are in the top &a{lb_position_percent}%&8 of &7{lb_size}"
      - "&8players!"
      - ""
      - "&7Collections maxed out: &a{maxed_progress_percent}%"
      - "{maxed_progressbar} &e{maxed_collection_count}&6/&e{total_collection_count}"
      - ""
      - "&eLeft click to view!"
      - "&eRight click to view rewards!"
    material: WHEAT
    slot: 20
  mining:
    name: "&a{name} Collections"
    lore:
      - "&7View your {name} collections!"
      - ""
      - "&7Completion: &e{progress_percent}%"
      - "&7Total collected: &e{total_formatted}"
      - ""
      - "&8Global ranking: &8#&a{lb_position}"
      - "&8You are in the top &a{lb_position_percent}%&8 of &7{lb_size}"
      - "&8players!"
      - ""
      - "&7Collections maxed out: &a{maxed_progress_percent}%"
      - "{maxed_progressbar} &e{maxed_collection_count}&6/&e{total_collection_count}"
      - ""
      - "&eLeft click to view!"
      - "&eRight click to view rewards!"
    material: IRON_PICKAXE
    slot: 21
    flags:
      - HIDE_ATTRIBUTES
  combat:
    name: "&a{name} Collections"
    lore:
      - "&7View your {name} collections!"
      - ""
      - "&7Completion: &e{progress_percent}%"
      - "&7Total collected: &e{total_formatted}"
      - ""
      - "&8Global ranking: &8#&a{lb_position}"
      - "&8You are in the top &a{lb_position_percent}%&8 of &7{lb_size}"
      - "&8players!"
      - ""
      - "&7Collections maxed out: &a{maxed_progress_percent}%"
      - "{maxed_progressbar} &e{maxed_collection_count}&6/&e{total_collection_count}"
      - ""
      - "&eLeft click to view!"
      - "&eRight click to view rewards!"
    material: DIAMOND_SWORD
    slot: 22
    flags:
      - HIDE_ATTRIBUTES
  foraging:
    name: "&a{name} Collections"
    lore:
      - "&7View your {name} collections!"
      - ""
      - "&7Completion: &e{progress_percent}%"
      - "&7Total collected: &e{total_formatted}"
      - ""
      - "&8Global ranking: &8#&a{lb_position}"
      - "&8You are in the top &a{lb_position_percent}%&8 of &7{lb_size}"
      - "&8players!"
      - ""
      - "&7Collections maxed out: &a{maxed_progress_percent}%"
      - "{maxed_progressbar} &e{maxed_collection_count}&6/&e{total_collection_count}"
      - ""
      - "&eLeft click to view!"
      - "&eRight click to view rewards!"
    material: OAK_LEAVES
    slot: 23
  fishing:
    name: "&a{name} Collections"
    lore:
      - "&7View your {name} collections!"
      - ""
      - "&7Completion: &e{progress_percent}%"
      - "&7Total collected: &e{total_formatted}"
      - ""
      - "&8Global ranking: &8#&a{lb_position}"
      - "&8You are in the top &a{lb_position_percent}%&8 of &7{lb_size}"
      - "&8players!"
      - ""
      - "&7Collections maxed out: &a{maxed_progress_percent}%"
      - "{maxed_progressbar} &e{maxed_collection_count}&6/&e{total_collection_count}"
      - ""
      - "&eLeft click to view!"
      - "&eRight click to view rewards!"
    material: FISHING_ROD
    slot: 24

# Your custom items. You can have any number of custom items here.
# Make sure to use unique keys for them.
custom-items:
  close:
    name: "&cClose"
    material: BARRIER
    slot: 53
    on-left-click:
      - "[close]"
  info:
    name: "&aCollections"
    material: PAINTING
    slot: 4
    lore:
      - ""
      - "&7View all of the items available"
      - "&7in the server! Collect more of an item"
      - "&7to unlock rewards!"