Type Structure

Quest type structure (Questborn/types/type_name.yml)

Here is a simple example of a default type setup:

id: daily
folder: "quests/daily"
display-name: "<#fffb99>☀ Daily Quests"
lore:
- "<#cccccc>Refresh every 24 hours."
- "<#cccccc>Complete short tasks"
- "<#cccccc>to earn steady rewards."
- ""
- "<#a7ff99>✔ Available: <#ffffff>{available}"
- "<#ff9999>⏳ Cooldown: <#ffffff>{cooldown}"
- "<#cccccc>Total: <#ffffff>{total}"
- ""
- "<#7dd3ff>Click to open"
material: "CREEPER_SPAWN_EGG"
custom-model-data: 1000 # Optional
slot: 19
cooldown: 1d
engine: DEFAULT
enabled: true

And here is an example of an advanced setup using the ROTATION engine with requirements and custom titles:

id: weekly
folder: "quests/weekly"
display-name: "<#ffd479>★ Weekly Quests"
gui-type-title: "<#ffd479>★ Weekly Quests | {page}/{total}"
gui-quest-title: "<#ffd479>★ Weekly - {quest}"
lore:
- "<#cccccc>Epic challenges for the week."
- ""
- "<#ffd479>Weekly Progress:"
- " <#a7ff99>✔ <#ffffff>{cooldown}/{total} <#cccccc>completed"
material: DROWNED_SPAWN_EGG
slot: 21
engine: ROTATION
rotation-pools:
  rare: 3
  epic: 2
rotation-slots:
  - 20
  - 21
  - 22
  - 23
  - 24
reset-period: 7d
reset-time: "00:00"
reset-anchor-day: 1
requirements:
  permission: "questborn.type.weekly"
requirements-lore:
  - "<#ff5555>Requires VIP status to access."
enabled: true

Configuration Keys

Key	Whai it does
id	Unique quest type ID. Tip: daily/weekly...
folder	Location of the folder where quests of this type will be located
display-name	Quest type title in the GUI
gui-type-title gui-quest-title gui-transfer-title	(Optional) Custom titles for various GUIs based on this quest type (the main type menu, the quest details screen, and the transfer UI).
lore	Quest type description in GUI
material	Quest type icon that will be displayed in the GUI
custom-model-data	(Optional) CustomModelData integer applied to the type icon.
slot	The slot in which the quest type will be located in the GUI
cooldown-seconds	Quest type cooldown, all quests in this type will have this cooldown. Tip: Set to 0 if you want one-time quests.
engine	Quest type engine. The engine decides what the quest type list will be. There are default and chain
rotation-pools	(Requires ROTATION engine) Number of quests from each pool to include in the periodic rotation. E.g., rare: 3.
rotation-slots	(Requires ROTATION engine) A list of GUI slots where the generated random quests will appear for the player.
reset-period	(Requires ROTATION engine) Interval between rotations (e.g., 7d, 24h)
reset-time	(Requires ROTATION engine, Optional) A specific time of day for the global rotation reset (e.g., "00:00")
reset-anchor-day	(Requires ROTATION engine, Optional) An anchor day for weekly or longer global resets (1 = Monday, ..., 7 = Sunday)
requirements	(Optional) Requirements to unlock this quest type. Can check for variables like permission: "questborn.type.weekly", quest-completed: "id", type-completed: "id", etc.
requirements-lore	(Optional) Description of requirements displayed in the GUI when the type is locked for the player.
auto-activate-next	If true - automatically activates the next quest in the chain
enabled	Decides whether to load the system type and the quests in it.

Tip: If you need the default engine, you can skip it.