The menu update is finally here! Added are three new menus, many more customization options, and configuration format changes. Your existing menus.yml will be automatically migrated into the new format in the menus folder. If you have any issues migrating your menus or encounter any bugs, please report them to the Discord immediately.

Be sure to read the entire changelog to see all the changes. If you need more info on how to configure menus, check out the wiki article.

Like the update? Consider donating to support the development of Aurelium Skills. Donations are much appreciated!

From this update forward, 1.12 will no longer be supported due to future plans, as well as being difficult to maintain.

New Features:

• Sources menu:
  • The sources menu shows every way players can gain XP in a skill and how much XP they will earn for each source
  • Accessible by clicking the sources item (experience bottle) in the level progression menu or using /skills sources <skill> [sortType]
  • Each source item will show the base XP earned and the multiplied XP, which accounts for abilities and multipliers, if applicable
  • Sort the items in the menu by clicking on the hopper to cycle sorting modes
  • Available sort types: ascending by XP, descending by XP, alphabetical, and reverse alphabetical
  • The material shown for each source is generated by default but can be overridden by adding a context with the name of the source and a material field under it
  • Supports multiple pages if sources cannot fit in one page
  • Fully configurable in menus/sources.yml
• Leaderboard menu:
  • Displays the top 10 players in a skill
  • Each item is a player head with the skin of the player and includes the player's username and level
  • Accessible by clicking the rank item (paper by default) in the level progression menu
  • Fully configurable in menus/leaderboards.yml
  • The head will be replaced with an alternate item in versions 1.12-1.16 to due to a vanilla bug that causes lag, can be disabled using the auto_replace_heads_on_legacy option
• Abilities menu:
  • Displays information about each ability and mana ability in a skill
  • Includes the name, description, player level, unlock status, and level up progress of the ability
  • Accessible by clicking the abilities item (light blue dye) in the level progression menu
  • Shows different materials and information depending on whether the ability is unlocked or not
  • Fully configurable in menus/abilities.yml
• New item options:
  • Add 'enchantments' key as a list of strings, formatted as 'name level', such as 'sharpness 5'
  • The key 'potion_type' has been renamed to 'potion_data', added the 'extended' and 'upgraded' optional boolean sub-keys
  • Add the 'custom_effects' key as a map list of effects with sub-keys 'type', 'duration', and 'amplifier'
  • Add the 'nbt' key to add custom NBT data to the item (automatically infers types and supports nested data)
    • Use CustomModelData under nbt to add custom model data
  • Add the 'flags' key to add item flags, such as 'hide_enchants' and 'hide_potion_effects'
  • Add the 'durability' key to set the durability of the item (0 means almost broken, goes up to the max durability to the item)
  • Add the 'skull_meta' key with either 'uuid', 'base64', or 'url' subfields to define the skin used
  • Add the 'key' key to use a registered item (/skills item register); 'material' and other item keys are not required if used
• New options in level progression menu:
  • Item options are accessible under the options section of a menu configuration file
  • Add items_per_page option to control how many skill level items are shown per page
  • Add use_level_as_amount option to match the item amount with the corresponding skill level it represents
  • Add over_max_stack_amount option to control the amount shown if the skill level is higher than the max stack of the item (64)
  • The position of skill items can be overridden by adding context sections named after the level number (i.e. '10') and 'pos' keys under each
• Click actions:
  • Define custom functionality when a player clicks an item in the menu
  • Supported actions:
    • Executing a command (either through the player or console)
    • Closing the menu
    • Opening another Aurelium Skills menu
    • Going to the next page or previous page
  • Supported triggers (key in parenthesis):
    • Any click ('on_click')
    • Left click ('on_left_click')
    • Right click ('on_right_click')
    • Middle click ('on_middle_click')
    • Drop key ('on_drop')
  • Actions are defined by adding a the key of a trigger listed about as a new field under any item or template
  • Actions are listed in map list format with certain fields used to define type and functionality:
    • type - required field that is either 'command' for executing a command or 'menu' for everything menu related
    • Command action fields:
      • command - The text of the command (without slash), supports {player} placeholder and all PlaceholderAPI placeholders
      • executor - The executor of the command, either 'console' or 'player' (defaults to console)
    • Menu action fields:
      • action - The action type, can be 'open', 'close', 'next_page', or 'previous_page'
      • menu - The name of the menu to open (only required for the 'open' action)
      • properties - A subsection of properties used to define variables when opening a menu ('open' action only)
        • A list of properties used to open each Aurelium Skills menu can be found in the wiki
        • Custom types can be used as a property using the 'type:value' format (see wiki for list of types and values)
• Custom menu items:
  • Completely new items can be added to any menu simply by creating a subsection in the items section
  • The name of the section can be anything except item names already used in that items section
  • The format of custom items is exactly the same as default items (material, pos, display_name, lore, etc)
  • Add functionality to custom items using click actions mentioned above
  • Lore and display name supports PlaceholderAPI placeholders like all other items
• Add hex color support to menus

Changes:

• Menu file format changes:
  • menus.yml has been replaced by an individual file for each menu in the menus folder
  • Existing changes to menus.yml will be automatically migrated to the new files
    • Exception: the lore of the rank item in the level progression menu will be reset due to new additions to it
  • The old menus.yml has been renamed to menus-OLD.yml and should not be used
  • The 'rows' menu entry has been renamed to 'size'
  • Material names are now in lowercase (uppercase is still allowed though)
  • The 'row' and 'column' entries for items has been replaced with the 'pos' entry with two acceptable formats:
    • The row,column format, such as 3,0 for row 3, column 0 (the first row/column is 0)
    • The slot format, which is a single number for the slot number from 0 up to 53 (starting at the top left slot increasing left to right then top to bottom)
  • Each context (skill, stat) in a template has been moved to its own subsection under the template name
    • Values such as the material, pos, and item meta of each context are separate fields under the subsection with the context name
    • For example, the path 'templates.skill.farming.material' in menus/skills.yml is the material used for Farming in the skils menu
  • Item meta options, such as potion_data, are now separate fields under the item section (alongside material, lore) for items and in the context subsection for templates
  • Legacy material data for 1.12 is still defined in the material field, using the material:data format
• Reduce kelp XP from 0.5 to 0.3
• Update NBT API version
• Add Czech messages
• Update German messages
• Update Polish messages
• Update Brazilian Portuguese messages

Bug Fixes:

• Fix Lucky Catch not working with custom loot tables
• Fix incorrectly named ACF message key
• Fix missing percent in Runner description