Category configuration

Guide to the categories.yml file

You can and have to define categories for your collections. You can do it in the categories.yml file.

Example configuration (the default file, with an added permission and menu item override):

categories:
  farming:
    name: "Farming"
    # You can lock the category behind a permission
    # making it not progressable until the player have the permission.
    permission: "my.permission"
    levels:
      my_level1:
        percentage: 50
        rewards:
          my_command:
            type: item
            item:
              material: diamond
            display: "&8+&b1 shiny diamond"
        # Optional - override/merge the menu item of this level
        # in the category rewards menu
        item:
          completed-level:
            material: diamond_block
          locked-level:
            material: coal_block
          next-level:
            material: gold_block
  mining:
    name: "Mining"
  combat:
    name: "Combat"
  foraging:
    name: "Foraging"
  fishing:
    name: "Fishing"

The key will be used as an id for the category. It will determine how will the plugin lookup the collections for the category, since it will search for a folder named as the id of the category in the collections folder (collections/<category id>/). Use only English letters, numbers, underscores and hyphens in the id. The same key is used in menus/categories.yml to define the menu item of the category.

Name field is the name of the category which will be displayed in menus. You can use any color codes here. If you you add levels , then when you right click on the category in the menu, you will see a leveling system for the entire category that is based on percentages. Any reward type can be used here as well.

Each entry under levels is a milestone. percentage is the category completion percent required to reach it, which is calculated from the summed collection levels inside the category compared to the maximum possible levels. When a player reaches a milestone, the rewards are given and the category-level-up-message from config.yml is sent. The level keys (like my_level1) can be anything, the levels are ordered by their percentage.

With the optional item section you can override or merge the completed-level, locked-level and next-level items of the category rewards menu for that level.

permission - Optional. If set, players can't progress any collection in the category, open it in the menus or view its rewards until they have this permission.