Collection progression

Guide to configure the progression menu for the collection. menus/collection.yml

For the general ITEM configuration please see Item config.

# Title of the inventory
# {collection_title} will be the menu-title specified in the collection file
# or name if it doesn't exist. ALternatively you could just use
# {collection_name} here, but since {collection_title} also false back to name, it is
# a better option
title: "{collection_title} collection"

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

# If every one of your collection have less than 64 levels, then you can set this to true
# This will set item amounts to the level in the menu
allow-item-amounts: true

# Set this to true if you want your {level} and {level_formatted} placeholders to be roman numbers
# NOTE: you can also use just {level_roman}
force-roman-numerals: false

# Where should we display you collection levels and in what order?
display-area: [
#  10, 11, 12, 13, 14, 15, 16,
  19, 20, 21, 22, 23, 24, 25,
  28, 29, 30, 31, 32, 33, 34,
  37, 38, 39, 40, 41, 42, 43
]

# How should the progressbar look like?
progress-bar:
  length: 10
  filled-character: "&a&l■"
  unfilled-character: "&7&l■"

# How should we display rewards when you use component:rewards?
display-components:
  rewards:
    title: "&7Rewards:&r"
    line: "  {reward}"

# You can use this template so you don't have to repeat yourself later
# when you configure your collection menu items.
collection-menu-template:
  enabled: true
  # {prev_level} is correct here since the placeholders will be replaced with the next level
  item:
    name: "&e{collection_name} {prev_level}"
    lore:
      - "&7View all your {collection_name} Collection"
      - "&7progress and rewards!"
      - ""
      - "&7Progress to {collection_name} {level}: &e{progress_percent}&6%"
      - "&r{progressbar} &e{current_formatted}&6/&e{required_formatted}"
      - ""
      - "&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!"

# Pagination, filler, back menu item configurations
items:
  filler:
    enabled: true
    item:
      name: " "
      material: BLACK_STAINED_GLASS_PANE
      hide-tooltip: true
  back:
    name: "&7Back"
    material: ARROW
    slot: 45
  # These are only visible if it makes sense (page count > 1)
  previous-page:
    name: "&7Previous page"
    material: ARROW
    slot: 48
  current-page:
    name: "{current}/{max} page"
    material: NETHER_STAR
    slot: 49
  next-page:
    name: "&7Next page"
    material: ARROW
    slot: 50
  # How should the level look like when it is completed?
  completed-level:
    name: "&f{collection_name} {level}"
    lore:
    - "&8You have reached this level"
    - ""
    - "&7Progress: &a{progress_percent}%"
    - "&r{progressbar} &e{current_formatted}&6/&e{required_formatted}"
    - ""
    - "component:rewards"
    - ""
    - "&a&lᴄᴏᴍᴘʟᴇᴛᴇᴅ"
    material: LIME_STAINED_GLASS_PANE
  # How should the level look like when it isn't completed yet?
  locked-level:
    name: "&f{collection_name} {level}"
    lore:
    - "&8Complete the previous levels"
    - ""
    - "&7Progress: &e{progress_percent}&6%"
    - "&r{progressbar} &e{current_formatted}&6/&e{required_formatted}"
    - ""
    - "component:rewards"
    - ""
    - "&c&lɴᴏᴛ ᴄᴏᴍᴘʟᴇᴛᴇᴅ"
    material: RED_STAINED_GLASS_PANE
  # How should the level look like when you are currently progressing it?
  next-level:
    name: "&f{collection_name} {level}"
    lore:
    - "&8You are almost there!"
    - ""
    - "&7Progress: &e{progress_percent}&6%"
    - "&r{progressbar} &e{current_formatted}&6/&e{required_formatted}"
    - ""
    - "component:rewards"
    material: YELLOW_STAINED_GLASS_PANE

# 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]"