Create new tag

Open /prefixes/ folder in plugin folder, then you will find default.yml file, this is an example file for tag config, if you want to create new tag, please copy it and rename it to tag ID you want to use.

An example file is here:

# Remove whole display item section to make it hide in GUI
display-item:
  unlocked:
    material: DRAGON_EGG
    name: '{display-value}'
    lore:
      - '&7Preview: {display-value} %player_name%'
      - '&eClick to use!'
  using:
    material: DRAGON_EGG
    name: '{display-value}'
    lore:
      - '&7Preview: {display-value} %player_name%'
      - '&cYou are now using this prefix!'
      - '&eClick to cancel use this prefix!'
  locked:
    material: DRAGON_EGG
    name: '&cLocked'
    lore:
      - '&7Preview: {display-value} %player_name%'
      - '&cKill a dragon to unlock!'
  max-reached:
    material: DRAGON_EGG
    name: '{display-value}'
    lore:
      - '&7Preview: {display-value} %player_name%'
      - '&cYou have reached max use of prefix!'
display-value: '&8Dragon Killer'
weight: 15
effects:
  libreforge: false
  MythicLib: false
MythicLib-effects:
  1:
    stat: MAX_HEALTH
    value: 1
auto-hide: false
equip-actions:
  - 'message: Start equip prefix!'
unequip-actions:
  - 'message: Unequip prefix!'
circle-actions:
  - 'console_command: say Wow!'
conditions:
  - 'permission: killed.dragon'

The display-item section is used to set the display items in the title GUI. If deleted, this tag will not be visible in the GUI.

If you find it troublesome, you can directly use ItemFormat under display-item key, so that all four states will use the same item, and support the {status} placeholder to display the current status of the tag.

The content displayed by the {status} placeholder can be set in config.yml, as shown below:

# {status} Placeholder
status-placeholder:
  unlocked: '&eClick to use'
  using: '&eClick to cancel use this prefix.'
  locked: '&cYou do not have permission to use this prefix.'
  max-reached: '&cYou can not use anymore prefix.'

Other options:

• display-value: The content displayed by this tag supports the use of PlaceholderAPI.

• weight: The weight displayed for this tag is higher for lower values, and tags with the same weight will be sorted based on their ID.

• effects: See next page.

• conditions: The unlocking conditions for this tag.

• equip-actions: The actions will executed after player equip this tag.

• unequip-actions: The actions will executed after player unequip this tag.

• circle-actions: The actions that will circle executed when player using this tag, you can set perior time at config.yml file.

• auto-hide: Whether we auto hide this prefix in GUI when player does not meet it's use condition.