Firebot Variables

Variables let you place Minecraft data inside Firebot text fields.

Use them anywhere Firebot supports variables, such as Chat effects, overlay text, custom widgets, conditions, log messages, commands, and preset effect lists.

Variable pages

Bridge Message VariablesValues from Minecraft Bridge Message events.Player Death VariablesDeath message, cause, position, dimension, attacker, and direct damage source.Item Given VariablesGiver name, actual item, requested item or tag, amount, and item data.Quest VariablesQuest name, viewer, objectives, progress, reward, player, position, and dimension.Quest Statistics VariablesCached server statistics for started, completed, and abandoned quests.

Linked player variables

$minecraftPlayerName and $minecraftPlayerDisplayName always refer to the Minecraft player linked by the Player Code saved in Haven Minecraft Settings. They can be used in normal Firebot effects, including Minecraft: Send Server Command.

$minecraftItemName is a Give Item placeholder. Use it inside Item Data when the custom name must include the readable name of the exact item selected by Minecraft.

$minecraftItemGiverName is available inside Give Item Item Data and on the Minecraft Item Given event. Inside Item Data it resolves to the effect's Giver Name.

Basic use

Add a Firebot Chat effect and put variables in the message:

Quest progress: $minecraftQuestName - $minecraftQuestProgress / $minecraftQuestTarget

Firebot replaces the variables when the effect runs.

Event data and cached data

Some variables are best used directly inside their matching event. For example, player death variables are made for the Minecraft Player Died event.

Quest variables can also reuse the latest quest cache. That means you can use them in overlays or effects after a quest update has happened.