Files
Project-CrankedPvP/Masks/README.md
T
2026-10-12 13:57:05 -03:00

1.2 KiB

Each registered mask has a config at plugins/CrankedMasks/masks/<id>.yml. Starting the plugin fills in missing settings with that mask's defaults and keeps existing settings. For example, masks/boss.yml contains:

mask:
  displayName: '&6&lBoss Mask'
  texture: '<base64 skin texture>'
  perks:
    - '&6Abilities:'
    - '&8 ● &6+15% Outgoing damage to bosses'
    - '&8 ● &6-20% Incoming damage to bosses'
  lore:
    - '&7A seasoned monster hunter, you pride'
    - '&7yourself on your boss slaying record.'

Keep the generated texture or replace it with a valid base64 skin texture. Names, lore, and perk descriptions support & color codes. perks controls the text shown on the item; ability behavior remains defined in each mask's Java class. The mask ID and filename remain stable when changing the display name.

After editing, run /cm reload in game to apply the config to newly generated items. Existing items keep their saved name and lore. Invalid values are logged with their filename and setting; malformed YAML is left intact for correction.

/adminitems includes a Masks entry opening the same menu as /masks. Players with cranked.admin can click a mask in that menu to receive it.