AlphaQuestsDocs v1.0.0
AlphaQuestsReferenceConfiguration

Configuration

What lives in each file, and every key in config.yml.

On this page

File layout

plugins/AlphaQuests/
  config.yml # features, tracker, limits, storage, sounds, panel
  categories.yml # category names, lore and icons
  lang/messages.yml # every chat message
  menus/ # titles, buttons and labels of each menu
  quests/ # one YAML file per quest
  races.yml # runtime, the active race and weekly points

Missing lang and menu keys fall back to the bundled defaults, so you only need to keep the keys you change.

Theme

theme:
  accent-hex: "C8A96E"
  gradient-start: "FF9400"
  gradient-end: "FFBE00"

The accent and the gradient used by plugin messages. Set your own hex values without the #.

The bundled theme, category text and quests use a gold palette. To move to your own colors, change theme and replace the hex values in categories.yml and the quest display text. A reload applies it.

Features

KeyDefaultMeaning
features.trackertrueShow the tracked quest on screen.
features.titlestrueShow titles on quest events.
features.bossbar-completetrueShow a boss bar when a quest completes.
features.streak-bonustrueMultiply money rewards by the streak bonus.
features.quest-autotracktrueTrack a quest as soon as it is accepted.
features.gui-close-after-accepttrueClose the menu after accepting.
features.drop-overflowtrueDrop reward items that do not fit in the inventory.
features.partiesfalseNot implemented. Leave it off.
features.racestrueAllow /aquests race.

Tracker

tracker:
  display: "bossbar"
  title-format: "{quest} §7{current}/{goal}"
  actionbar-format: "{current}/{goal} {description}"
  bossbar-color: "YELLOW"
  bossbar-overlay: "PROGRESS"

display is bossbar, actionbar, both or off. The formats take {quest}, {current}, {goal} and {description}.

Quest limits

quest-limit:
  default: 1
  vip: 20
  level_4: 2
  level_8: 4

default applies to everyone. Every other key is a rank, and a player with alphaquests.limit.<rank> gets that value if it is higher. The shipped list includes vip, elite, ultra and level_4 through level_20.

Storage

storage:
  provider: "yaml"
  autosave-ticks: 12000
  mysql:
    address: "localhost:3306"
    database: "minecraft"
    username: "root"
    password: ""
    pool-size: 8
    table-prefix: "alphaquests_"

Sounds

Under sounds: gui-open, gui-click, quest-start and quest-complete, each written as SOUND:volume:pitch.

The panel block holds the approval settings.