Configuration

config.yml holds the plugin-wide settings. The ranks themselves live in ranks.yml (see Creating ranks) and the messages in lang/ (see Messages).

command

general

progression

towertrials

Only does anything when the TowerTrials plugin is installed. zQuestRank is built against TowerTrials 1.0.0-9.

A gate closes a floor, and every floor above it, until the party leader is on the rank you name. TowerTrials sends whole parties in together, so the leader is the one checked and the one who gets the message.

towertrials:
  enabled: true
  gates:
    - tower: ashen-spire      # tower id, leave it out or write * for every tower
      floor: 10               # this floor and everything above it
      rank: gold              # rank key from ranks.yml
      message: "&cYour party needs the &6Gold &crank to climb past floor 10."

message is optional: leave it out and players get the towertrials.gate-blocked line from your language file. Both accept {rank} and {floor}. Players on the named rank or any rank above it walk straight in.

gui

Want different page-button slots on different pages? Write previous-page-slots / next-page-slots as a per-page map instead of a single list. Page numbers are 1-based (page 1 is the first page), and a default entry covers any page you did not list:

gui:
  previous-page-slots:
    1: [45]
    2: [48, 49]
    default: [45]
  next-page-slots:
    1: [53]
    2: [51, 52]
    default: [53]

The quest menu is a 54-slot inventory. Slot numbers count from 0 in the top-left, left to right, row by row. If a rank has more quests than gui.quest-slots has entries, the extra quests go on a second page (then a third, and so on), reachable with the two arrows on gui.quest-previous-page-slot / gui.quest-next-page-slot. The arrows use the same previous-page-item / next-page-item pictures and the same menu.previous-page / menu.next-page texts as the rank menu.

gui.rank-menu-mode: manual is what you want for ItemsAdder frame menus, where one rank image spans several slots and each slot opens that rank. Full walkthrough on the Rank menu page.

Decoration items

gui.decorations fills slots of the rank menu with items that are not ranks. They only show text, clicking them does nothing:

gui:
  decorations:
    - slots: [4]
      page: all               # 1 = first page, "all" = every page
      icon: OAK_SIGN
      name: "&6&lServer Ranks"
      lore:
        - "&7Complete the quests of your"
        - "&7current rank to move up."
        - ""
        - "&eYou are &f%zquestrank_rank_name%"
    - slots: [45, 46, 47, 48, 49, 50, 51, 52, 53]
      icon: BLACK_STAINED_GLASS_PANE

Colors and PlaceholderAPI placeholders work in name and lore. Decorations are drawn over the ranks, so in auto mode do not use a slot a rank already sits on. Page arrows always stay on top of decorations. Details on the Rank menu page.

Icon formats

Every item above, and every icon in ranks.yml, accepts these formats:

fill-item: GRAY_STAINED_GLASS_PANE   # a vanilla material
back-item: PAPER:1042                # material + custom model data, for resource pack textures
claim-ready-item: itemsadder:myitems:golden_button   # an ItemsAdder custom item
locked-item: itemsadder-myitems:locked_frame         # ItemsAdder, DeluxeMenus-style hyphen (same thing)

The ItemsAdder form needs the ItemsAdder plugin installed. Both spellings work, itemsadder:namespace:id and the DeluxeMenus-style itemsadder-namespace:id, so an id copied straight from a DeluxeMenus setup resolves. If ItemsAdder is missing or the id does not exist, the menu falls back to the vanilla default and the console names the bad id once, nothing breaks.

Full default file

command:
  name: rank
  aliases: [ranks, zquestrank, zqr]

general:
  language: "en"
  debug: false
  auto-reload: true
  update-checker: true

progression:
  anti-place-cheese: true
  anti-replace-cheese: true
  permission-ranks: true
  notify-on-quest-complete: true
  broadcast-promotions: true
  permission-check-seconds: 5

towertrials:
  enabled: true
  gates: []

gui:
  fill-item: GRAY_STAINED_GLASS_PANE
  locked-item: GRAY_DYE
  completed-item: LIME_DYE
  back-item: ARROW
  previous-page-item: ARROW
  next-page-item: ARROW
  claim-ready-item: EMERALD_BLOCK
  claim-not-ready-item: REDSTONE_BLOCK
  quest-slots: [10, 11, 12, 13, 14, 15, 16, 21, 22, 23, 24, 25]
  quest-previous-page-slot: 48
  quest-next-page-slot: 50
  quest-info-item: RANK_ICON
  rank-menu-mode: auto
  rank-menu-rows: 6
  rank-menu-pages: 0
  previous-page-slots: [45]
  next-page-slots: [53]
  decorations: []

After editing, apply with /rank admin reload. That covers everything, the command name and aliases included.