Configuring a Category

Default config

The default config can be found here.

How to add categories

Each quest is its own config file, placed in the /categories/ folder, and you can add or remove them as you please. There's an example config called _example.yml to help you out!

The ID of the Category is the file name. ID's must be lowercase letters, numbers, and underscores only.

Categories allow both Free and Premium quests

Example Category Config

name: "&8»&e Daily Challenges"
item: nether_star 1
lore:
  - "&a%completed%/%total% Complete"
  - "&7%time%"

battlepass: battlepass
priority: 0
start-date: 2025-03-23 00:00
duration: 100000
reset-time: 1440

timer-format:
  start: "Starts in %time%"  
  end: "Ends in %time%"  
  reset: "Resets in %time%"  
  none: "One-Time quest (does not end or reset)"

quests:
  - id: free_daily_quest_1
  - id: free_daily_quest_2
  - id: free_daily_quest_3

Understanding the Sections

The Display Section:

# The display name, display item, and lore of the category. This shows in the Categories GUI.
name: "&8»&e Daily Challenges"
item: nether_star 1
lore:
  - "&a%completed%/%total% Complete"
  - "%xbattlepass_category_daily_duration%"

The Config Section:

# The ID of the battlepass this category is assigned to.
battlepass: battlepass
# The priority of the category in the GUI. Categories are sorted by priority, 0 is the highest priority, and will show first.
priority: 0
# The date the category starts.
# Format: YYYY-MM-DD HH:MM
start-date: 2025-03-23 00:00
# The duration of the category in minutes, set to -1 for no end.
# This allows you to end/lock categories after a time frame.
duration: 100000
# The amount of minutes between resets. 
# Set to 1440 for daily resets, set to -1 for no reset.
reset-time: 1440
# The format of the timer in the GUI.
# Represented by %time% in the category lore.
timer-format:
  start: "Starts in %time%"  
  end: "Ends in %time%"  
  reset: "Resets in %time%"  
  none: "One-Time quest (does not end or reset)"

The Quests Section

# The list of Quest ID(s) to be completed.
# The order of this list is what determines the order within the Category GUI.
quests:
  - id: free_daily_quest_1
  - id: free_daily_quest_2
  - id: free_daily_quest_3

Internal Placeholders

Placeholder	Value
%completed%	The amount of completed quests in the category.
%total%	The total amount of quests in the category.
%time%	The time until start/reset/end of the category.