Quest Variables
Quest variables are filled by quest events and can also use the latest quest cache.
Use them in Firebot Chat effects, overlay text, custom widgets, conditions, quick actions, or preset effect lists.
| Variable | What it gives you |
|---|---|
$minecraftQuestStatus | Started, Progress, Completed, or Abandoned. |
$minecraftQuestName | Quest name. |
$minecraftQuestId | Quest ID. |
$minecraftQuestViewerName | Viewer attached to the quest. |
$minecraftQuestPlayerName | Minecraft username. |
$minecraftQuestPlayerDisplayName | Minecraft display name. |
$minecraftQuestType | Current objective type. |
$minecraftQuestObjectives | Readable objective list. |
$minecraftQuestTargetIds | Raw target IDs. |
$minecraftQuestTargetNames | Readable target names when available. |
$minecraftQuestDisplayMode | Quest display mode. |
$minecraftQuestProgress | Current progress amount. |
$minecraftQuestTarget | Target amount. |
$minecraftQuestRemaining | Amount left. |
$minecraftQuestPercent | Completion percent. |
$minecraftQuestReward | Reward text. |
$minecraftQuestRewardItems | Reward item list. |
$minecraftQuestRandomReward | Whether random rewards are enabled. |
$minecraftQuestPosition | Player position from the quest update. |
$minecraftQuestDimensionId | Raw dimension ID. |
$minecraftQuestDimensionDisplayName | Readable dimension name. |
Example: chat message when a quest starts
- Create a Minecraft Quest Started event.
- Add a Firebot Chat effect.
- Use this message:
$minecraftQuestViewerName started $minecraftQuestName for $minecraftQuestPlayerName.
Example: progress message
Use this in a Minecraft Quest Progress event:
$minecraftQuestName: $minecraftQuestProgress / $minecraftQuestTarget ($minecraftQuestPercent%)
Example: overlay text
Use this in an overlay widget or custom widget:
$minecraftQuestName
$minecraftQuestObjectives
$minecraftQuestPercent% complete
Example: completion message
Use this in a Minecraft Quest Completed event:
Quest complete: $minecraftQuestName. Reward: $minecraftQuestReward