funcy's Ultimate Custom Weapons

Mastery

The Mastery system gives each custom weapon its own level path. Players gain XP while using a weapon, unlock mastery levels, receive rewards, and improve the weapon's damage bonus.

Each weapon tracks its mastery progress separately. Progress earned with one weapon does not apply to another weapon.

Weapon Information

The item displayed at the bottom of the Mastery Path shows information about the selected weapon.

Weapon name
Current mastery level
Maximum mastery level
Current XP
XP required for the next level
Current damage bonus

Example:

Weapon: Katana
Level: 4/10
XP: 60/150
Damage Bonus: 2.0

Mastery Rewards

Each mastery level can display its own rewards. Rewards are configured inside the weapon's YAML file.

The Mastery menu supports:

Vault money rewards
Custom reward descriptions

Reward Configuration

mastery:
  rewards:
    1:
      vault-money: 100.0
      display-lore:
        - "&7Unlocks the first mastery bonus."
        - "&7Increases weapon damage."

    5:
      vault-money: 500.0
      display-lore:
        - "&6Major Mastery Reward"
        - "&7Unlocks a special ability."

    10:
      vault-money: 1000.0
      display-lore:
        - "&cFinal Mastery Reward"
        - "&7You have mastered this weapon."

Setting	Description
`mastery.rewards.<level>`	Defines the reward for a specific mastery level.
`vault-money`	The economy reward for reaching the level.
`display-lore`	Extra text shown under the level inside the Mastery menu.

Using Vault

Adding a Vault Reward

Add vault-money under the required mastery level:

mastery:
  rewards:
    3:
      vault-money: 250.0

The Mastery menu will display:

Reward: $250.0

When the player reaches mastery level 3, the configured Mastery system can give the player $250 through Vault.

The code that displays the menu only shows the configured Vault reward. The Mastery reward handler must also process the payment when the player reaches the level.

If Vault is not installed or no economy plugin is connected, the money reward cannot be deposited.

Custom Reward Text

Use display-lore to explain what a mastery level unlocks. This text appears even when the reward does not give money.

mastery:
  rewards:
    4:
      display-lore:
        - "&7Reward:"
        - "&a+1.5 weapon damage"
        - "&bUnlocks the Frost Burst ability"

Colour codes using & are supported.

Code	Colour
`&a`	Green
`&b`	Aqua
`&c`	Red
`&e`	Yellow
`&6`	Gold
`&7`	Grey

Changing the Menu Titles

The Mastery menu titles can be changed in the main config.yml file.

gui:
  mastery-title: "&8Weapon Mastery"
  mastery-path-title: "&8Mastery Path"

Setting	Description
`gui.mastery-title`	The title of the weapon selection menu.
`gui.mastery-path-title`	The title shown after selecting a weapon.

Complete Example

mastery:
  max-level: 10

  rewards:
    1:
      vault-money: 100.0
      display-lore:
        - "&7Begin your mastery journey."
        - "&aReward: Starter bonus"

    3:
      vault-money: 250.0
      display-lore:
        - "&7Improves weapon damage."
        - "&cDamage Bonus: +1.0"

    5:
      vault-money: 500.0
      display-lore:
        - "&6Advanced Mastery"
        - "&7Unlocks a new weapon ability."

    10:
      vault-money: 1000.0
      display-lore:
        - "&cWeapon Mastered"
        - "&7Maximum damage bonus reached."

Creating a New Weapon

Mastery