Macro builder
Library macros: steps, text or code, seeing what it would do, when they fire by themselves, who sees them and how to take them to a campaign.
A macro is an action you repeat: roll dice with a modifier, heal an ally, switch on a light, play a sound. The Workshop macro is yours and works at any table; you copy it to a campaign with Take to when you want to use it there.
Where it is
In the Workshop, Macros column, with Create; or with Ctrl K: "Add step: …" and "Run macro: …". At the table, macros live in the macro bar (Macros at the table).
Requirements and permissions
An account with a session. The Script mode is for paid plans; the others are free. A macro can fire by itself on something that happens at the table (Runs by itself when…) only if the GM wrote it.
Step by step
- Press Create in Macros, or start from one of the Templates, or Base on a macro one you already have.
- Give it a Name and write what it does in one of the modes:
| Mode | Who it is for |
|---|---|
| On click… | You pick steps from a catalog, no syntax: roll, damage, light, sound… They show as List, Blocks or Nodes |
| Text | The Roll20 and Foundry syntax |
| Script | Code, for what the steps do not cover |
| Foundry | A macro brought from Foundry, as it came |
- Press See what it does: it tells, step by step, what it would do, without running anything.
- Set Who sees it and who uses it: Only whoever wrote it, GM only or Everyone at the table.
- Take to copies it to a campaign or to the Test table.
When it fires by itself
Runs by itself when… picks an event: Someone starts their turn, Combat starts, Someone drops to 0 HP, A door opens, The table changes scene… and you can limit it with Applies to. Each step accepts a Chance (100 = always) and Wait before (seconds). There is a cap on steps per macro.
Importing and exporting
Import understands a pasted macro or a file (also Foundry's); Download JSON saves it as a copy.
Common problems
"My macro does nothing." If it has no steps it says so: "This macro does nothing.".
"A step says it does not run yet." "It does not run yet." appears on steps the engine does not support yet: they do nothing when the macro runs; replace them with another step.
See also
Macros at the table, Table chat and commands, The Workshop: the eleven columns.