Objective GUI

The objective GUI opens when a player clicks a quest in the category GUI. It shows the quest's objectives, description, and reward. Configured in plugins/SpContentQuests/gui-objective.yml.

Configuration

gui-name: '&nObjective&8 -> {quest}'
gui-rows: 5

sound:
  click:
    id: ITEM_BOOK_PAGE_TURN
    pitch: 1.0
    volume: 1.0

objective-slots:
  1: [22]
  2: [21, 23]
  3: [20, 22, 24]
  4: [19, 21, 23, 25]
  5: [19, 20, 22, 24, 26]
  6: [19, 20, 21, 23, 24, 25]
  7: [19, 20, 21, 22, 24, 25, 26]

objective-item:
  ongoing:
    item: PAPER
    name: '&f<objective-display>'
    lore:
      - ''
      - '<objective-desc>'
      - ''
      - '&6Progress:'
      - '&7(<objective-value>/<objective-max-value>)'
      - ''
      - '&e➥ Click'
  complete:
    item: LIME_DYE
    name: '&f<objective-display>'
    lore:
      - ''
      - '<objective-desc>'
      - ''
      - '&6Progress:'
      - '&7(<objective-value>/<objective-max-value>)'
      - ''
      - '&2✔ Objective Complete'

goback-item:
  slot: 8
  item: RED_DYE
  name: '&fGo Back'
  lore:
    - ''
    - '&7Return to the quest category menu'

reward-item:
  slot: 41
  item: CHEST
  name: '&eQuest Reward'
  lore:
    - ''
    - '<reward>'

desc-item:
  slot: 39
  item: BOOK
  name: '&9Quest Description'
  lore:
    - ''
    - '<desc>'

Fields

Field	Required	Description
gui-name	Yes	GUI title ({quest} = quest display name)
gui-rows	Yes	GUI height (1–6 rows)
sound	No	Sound played on click
objective-slots	Yes	Slots for objectives based on count (1–7 supported)
objective-item	Yes	How objectives look in ongoing and complete states
goback-item	No	Back button to return to the category GUI
reward-item	No	Item showing the quest reward
desc-item	No	Item showing the quest description
item-custom	No	Decorative items at specific slots

Objective Slots

The objective-slots section maps the number of objectives to their GUI slots:

objective-slots:
  1: [22]              # 1 objective → center slot
  2: [21, 23]          # 2 objectives → side by side
  3: [20, 22, 24]      # 3 objectives → centered row
  4: [19, 21, 23, 25]  # 4 objectives → spread across
  5: [19, 20, 22, 24, 26]
  6: [19, 20, 21, 23, 24, 25]
  7: [19, 20, 21, 22, 24, 25, 26]

Slots are 0-indexed from top-left to bottom-right in a 6-row GUI (0–53). You can customize these to fit your layout preferences.

Placeholders

Placeholder	Description
<objective-display>	The objective's display name
<objective-desc>	The objective's description lines
<objective-value>	Player's current progress
<objective-max-value>	The maximum progress needed
<desc>	Quest icon description lines
<reward>	Quest reward-display lines

Per-Objective Icon Override

Each objective in a quest can optionally include an icon section to override the default objective-item appearance:

objective:
  - type: CRAFT
    amount: 10
    icon:
      item: BREAD
      skullvalue: ''
      modeldata: 0
      amount: 1

If no icon is defined, the default from objective-item in gui-objective.yml is used.

Custom Items

Same as in categories — you can add decorative or functional items:

item-custom:
  pane1:
    slots: [9, 10, 11, 12, 13, 14, 15, 16, 17, 18, ...]
    item: BLACK_STAINED_GLASS_PANE
    name: ' '
    lore: []
    commands: []