Configuration

- config.yml
- tags.yml
- messages.yml

config.yml


gui:
  title: "&#38ecff&lTags"
  # Must be a multiple of 9, between 9 and 54.
  size: 36
  # Item shown in every slot that has no tag.
  filler:
    material: GRAY_STAINED_GLASS_PANE
    name: " "
  # Shown on tags the player has not unlocked.
  locked-lore:
    - ""
    - "&cLocked"
    - "&7Unlock this tag in the store."
 
behaviour:
  # Close the menu after equipping.
  close-on-select: true
  # Play a sound when a tag is equipped.
  sound: UI_BUTTON_CLICK
  # Re-check permissions on join and strip tags the player lost.
  revoke-on-permission-loss: true
 
storage:
  # sqlite | mysql
  type: sqlite
  mysql:
    host: 127.0.0.1
    port: 3306
    database: aquatags
    username: root
    password: ""
    pool-size: 10
    use-ssl: false

Key	Type	Default	Effect
`gui.size`	integer	`36`	Slots available for tags
`gui.filler.material`	enum	`GRAY_STAINED_GLASS_PANE`	`AIR` leaves empty slots
`behaviour.close-on-select`	boolean	`true`	Keep it open to let players compare
`behaviour.revoke-on-permission-loss`	boolean	`true`	Off means expired ranks keep their tag
`storage.type`	enum	`sqlite`	Use `mysql` for a network

On a multi-server network every server must point at the same MySQL database. With sqlite, each server keeps its own copy and players see a different tag on each one.

tags.yml


tags:
  vip:
    display: "&#38ecff[VIP]"
    permission: aquatags.tag.vip
    icon: DIAMOND
    slot: 10
    lore:
      - "&7A clean blue tag."
      - ""
      - "&#38ecffClick to equip"
 
  legend:
    display: "<gradient:#38ecff:#0a84ff>[LEGEND]</gradient>"
    permission: aquatags.tag.legend
    icon: NETHER_STAR
    slot: 11
    glow: true
    lore:
      - "&7Animated gradient tag."
      - ""
      - "&#38ecffClick to equip"
 
  staff:
    display: "&c[STAFF]"
    permission: aquatags.tag.staff
    icon: SHIELD
    slot: 16
    hidden: true
    lore:
      - "&7Staff only."

Key	Type	Required	Notes
`display`	string	Yes	Supports legacy, HEX and gradients
`permission`	string	Yes	Node that unlocks the tag
`icon`	material	Yes	Any Bukkit `Material`
`slot`	integer	Yes	`0`-indexed, must fit inside `gui.size`
`lore`	list	No	Appended below the generated lines
`glow`	boolean	No	Enchant shine, default `false`
`hidden`	boolean	No	Only visible to players who hold the node

Two tags on the same slot is a fatal configuration error. AquaTags refuses to load tags.yml and prints Duplicate slot 10 used by 'vip' and 'legend'.

Placeholders

Placeholder	Returns
`%aquatags_prefix%`	The player’s equipped tag, coloured
`%aquatags_prefix_raw%`	Same, without colour codes
`%aquatags_id%`	Tag id, e.g. `vip`
`%aquatags_unlocked%`	How many tags the player can equip
`%aquatags_total%`	How many tags exist

scoreboard.yml


lines:
  - "&7Tag: %aquatags_prefix%"
  - "&7Unlocked: &f%aquatags_unlocked%&8/&f%aquatags_total%"