Character Vault
Any Concept / Any System
Compendium
Your System Come To Life
Roll20 for Android
Streamlined for your Tablet
Roll20 for iPad
Streamlined for your Tablet

Personal tools

Difference between revisions of "Complete Guide to Macros & Rolls"

From Roll20 Wiki

Jump to: navigation, search
(Initiative: examples of increase/decrease init)
m (HTML replacement)
(32 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This is meant to serve as a comprehensive guide & starting point for figuring out how the {{Text Chat}}, [[Dice Reference|Dice Rolling]], [[Macros]] and related things work and interact with each-other, and to list everything you can write/make appear in the {{Text Chat}}.
+
This is meant to serve as a comprehensive guide & starting point for figuring out how the {{Text Chat}}, [[Dice Reference|Dice Rolling]], [[Macros]] and related things work and interact with each-other, to find the documentation for each, and to list everything you can write/make appear in the {{Text Chat}}.
  
This is both for Players/Game Masters who are just writing their own custom rolls or macros to be used in their game, as well as those who [[BCS|build Character Sheets]] and are creating/editing [[Button#Roll Button|Roll Buttons]] for their sheets.
+
This is both for [[Players]] and [[GM|Gamemasters]] who are just writing their own custom rolls or macros to be used in their game, as well as those who [[BCS|build Character Sheets]] and are creating/editing [[Button#Roll Button|Roll Buttons]] for their sheets.
  
==[[Text Chat|Basics]]==
+
==[[Text Chat]]==
The {{Text Chat}} page shows the basic commands that can be used in the chat, such as <code>/roll</code>(or <code>/r</code>) for making simple rolls, <code>/em</code> for emoting text, <code>/w</code> for whispering to someone, and <code>/gmroll</code>(or <code>/gr</code>) for sending simple rolls to the GM.
+
[[File:Basic-roll-example.png|right|thumbnail|400px|]]
 +
The {{Text Chat}}-page shows the basic commands that can be used in the chat, such as <code>/roll</code>(or <code>/r</code>) for making simple rolls, <code>/em</code> for emoting text, <code>/w</code> for whispering to someone, and <code>/gmroll</code>(or <code>/gr</code>) for sending simple rolls to the GM.
  
 
You can write in the {{Text Chat}} normal text without using any commands like <code>/r</code>.
 
You can write in the {{Text Chat}} normal text without using any commands like <code>/r</code>.
  
 +
'''Normal macros can't edit stats, only read them.''' To edit stats with a command, you need to use [[#API|API]] in some form.
 +
<br>
 
===Text Formatting===
 
===Text Formatting===
 
You can use common '''Markdown''' to format you text, and to create hyperlinks.
 
You can use common '''Markdown''' to format you text, and to create hyperlinks.
Line 15: Line 18:
 
* [https://app.roll20.net/forum/permalink/9031455/ Using Images as Links] - Oosh
 
* [https://app.roll20.net/forum/permalink/9031455/ Using Images as Links] - Oosh
 
* [https://app.roll20.net/forum/permalink/8511142/ Hypertext Macro to Open a Linked Character Sheet  Hypertext Macro to Open a Linked Character Sheet] - Vince
 
* [https://app.roll20.net/forum/permalink/8511142/ Hypertext Macro to Open a Linked Character Sheet  Hypertext Macro to Open a Linked Character Sheet] - Vince
==Chat Commands==
 
Beyond using the various Roll Commands shown on the {{Text Chat}}-page, here are some other examples of what you can write in the {{Text Chat}}:
 
  
 +
===HTML replacement===
 +
When creating some complicated/sophisticated macros, usually involving [[#Nesting|nesting]], you will need to use [https://www.w3schools.com/html/html_entities.asp HTML entities] in parts of the code to trick the Roll20 system to make it behave like you want, or some advanced tricks won't work.
  
 +
Here are the HTML entities used in advanced Roll20 macros:
 +
 +
{| class="wikitable"
 +
|-
 +
! Character || Replacement
 +
|-
 +
| &#124;|| &amp;#124;
 +
|-
 +
| &#44;|| &amp;#44;
 +
|-
 +
| &#125;|| &amp;#125;
 +
|-
 +
| & || &amp;amp;
 +
|}
 +
 +
'''Example use:'''
 +
Here is a macro that '''won't work''':
 +
<pre style="overflow:auto; width:auto;">
 +
?{Choose a Roll|
 +
  STR,/roll 1d20 + 3 + ?{Bonus&amp;#125;|
 +
  DEX,/roll 1d20 + 2 + ?{Bonus&amp;#125;|
 +
  CON,/roll 1d20 + 1 + ?{Bonus&amp;#125;}
 +
</pre>
 +
 +
Here is how you use HTML entities in it to replace certain characters to make it work:
 +
<pre style="overflow:auto; width:auto;">
 +
?{Choose a Roll|
 +
  STR,/roll 1d20 + 3 + ?{Bonus&amp;#125; |
 +
  DEX,/roll 1d20 + 2 + ?{Bonus&amp;#125; |
 +
  CON,/roll 1d20 + 1 + ?{Bonus&amp;#125; }
 +
</pre>
 +
 +
'''Advanced Nesting example:'''
 +
 +
<pre style="overflow:auto; width:auto;">?{Name of Query|
 +
  Label 1, ?{value1&amp;#124;
 +
      Label 1A&amp;#44; ?{value1A&amp;amp;#124;
 +
        Label 1Ai&amp;amp;#44; value1Ai &amp;amp;#124;
 +
        Label 1Aii&amp;amp;#44; value1Aii
 +
      &amp;amp;#125; &amp;#124;
 +
     
 +
      Label 1B&amp;#44; ?{value1B&amp;amp;#124;
 +
        Label 1Bi&amp;amp;#44; value1Bi &amp;amp;#124;
 +
        Label 1Bii&amp;amp;#44; value1Bii
 +
      &amp;amp;#125;
 +
  &amp;#125; |
 +
 +
  Label 2, ?{value2&amp;#124;value2&amp;#125;
 +
}</pre>
 +
 +
[https://www.freeformatter.com/html-entities.html HTML entities] contains a longer list of all the existing HTML entities, of which only few are used/needed in Roll20 context, but might be useful to check if the above table isn't enough.
 +
 +
See '''[[Macros#Advanced_Usage_for_Roll_Queries|Advanced Usage for Roll_Queries]]''' for examples of use.
 +
 +
==Chat Commands==
 +
''Main Page:'' '''{{Text Chat}}'''
 +
 +
* <code>/r</code>, <code>/roll</code> - for making simple rolls. '''Ex.''' <code>/r 1d20+5</code>
 +
* <code>/w</code> - for whispering a message to a person so only they see it. '''Ex.''' <code>/w Alice Does the goblin know the paladin?</code>, <code>/w "Bob Smith" Where's the money pouch?!</code>
 +
* <code>/gr</code>, <code>/gmroll</code> - to make rolls only to the GM. '''Ex.''' <code>/gr 2d6+3</code>
 +
* <code>/em</code> to emote as the character selected. '''Ex.''' <code>/em takes out one of his throwing daggers and brandishes it threateningly.</code>
 +
* <code>/ooc</code> - to message something that is Out-of-character '''Ex.''' <code>/ooc I could really use another coffee right now.</code>
 +
* <code>/talktomyself</code> - To turn off your chat display for all others, including the GM and the chat archive recording. Use it again to turn it back on
 +
* <code>/fx</code> - used for creating visual effects '''Ex.''' <code>/fx beam-acid @{target|Caster|token_id} @{target|Foe|token_id}</code>
 +
* [[GM]]-exclusive:
 +
** <code>/desc</code> to describe the situation '''Ex.''' <code>The old house begins to creak and moan...</code>
 +
** <code>/as</code>, <code>/emas</code> emote as any character, better version of <code>/em</code> '''Ex.''' <code>/as "Sir Bearington" I'm going to eat you for breakfast.</code>
 +
<br>
 +
Beyond using the various Roll Commands shown on the {{Text Chat}}-page, here are some other examples of what you can write in the {{Text Chat}}:
 
* [[Macros]] - Start with <code>#</code>, and start typing the macro name, and a list of your macros will be displayed.
 
* [[Macros]] - Start with <code>#</code>, and start typing the macro name, and a list of your macros will be displayed.
 
** '''Example:''' writing <code>#testmacro</code> in the chat will roll the macro with that name
 
** '''Example:''' writing <code>#testmacro</code> in the chat will roll the macro with that name
Line 27: Line 99:
 
* [[Journal#Attributes|Character Abilities]]/Character Sheet Button - <code>%{character name|ability or roll button name}</code>
 
* [[Journal#Attributes|Character Abilities]]/Character Sheet Button - <code>%{character name|ability or roll button name}</code>
 
** '''Example 1;''' writing <code>%{Sam Bobbins|initiative}</code> in the chat, will work if there exists a Character with that name, who have a Character Ability/[[Character Sheet]] Roll Button by that name
 
** '''Example 1;''' writing <code>%{Sam Bobbins|initiative}</code> in the chat, will work if there exists a Character with that name, who have a Character Ability/[[Character Sheet]] Roll Button by that name
** '''Example 2:''' selecting a [Token]] on the map, and then writing <code>%{selected|initiative}</code> in the chat, will work if the token is linked to a character sheet that has an Ability or Roll button with that name.
+
** '''Example 2:''' selecting a [[Token]] on the map, and then writing <code>%{selected|initiative}</code> in the chat, will work if the token is linked to a character sheet that has an Ability or Roll button with that name.
 
* [[API|API commands]]''(available in games hosted by a pro user)'', - Start with <code>!</code> to call the API command, and then write and parameters it can take
 
* [[API|API commands]]''(available in games hosted by a pro user)'', - Start with <code>!</code> to call the API command, and then write and parameters it can take
 
** '''Example:''' writing <code>!MassInit</code> in the chat will trigger an API that uses <code>MassInit</code> as a keyword.
 
** '''Example:''' writing <code>!MassInit</code> in the chat will trigger an API that uses <code>MassInit</code> as a keyword.
Line 41: Line 113:
 
* [https://app.roll20.net/forum/permalink/8717558/ Auto calculating level specific buffs. (Basic IF/THEN statement, no API)] - Greg S.
 
* [https://app.roll20.net/forum/permalink/8717558/ Auto calculating level specific buffs. (Basic IF/THEN statement, no API)] - Greg S.
 
* [https://app.roll20.net/forum/permalink/6003370/ Keep Crits/Fumbles from Display on Attack Rolls] - Scott C.
 
* [https://app.roll20.net/forum/permalink/6003370/ Keep Crits/Fumbles from Display on Attack Rolls] - Scott C.
 +
 +
====Order of Operations====
 +
The [[Dice_Reference#Order_of_Operations|Order of Operations]] sections highlights in what order different components resolve, which can become important when you do complicated things.
  
 
====Inline Labels====
 
====Inline Labels====
Line 50: Line 125:
  
 
This is especially useful if a roll contains multiple variables and you want to look up what number comes from what attribute.
 
This is especially useful if a roll contains multiple variables and you want to look up what number comes from what attribute.
 +
  
 
===[[Macros]]===
 
===[[Macros]]===
The main [[Macros]] page lists all the the other kind of options for modifying rolls that isn't covered by the '''Dice Reference'''-page. Also check the [https://app.roll20.net/forum/permalink/5899495/ Stupid Roll20 Tricks (and some clever ones)]-thread for Advanced and clever tricks that might not be linked on this page yet.
+
''Main Article:'' '''[[Macros]]'''
 +
 
 +
The [[Macros]] page lists all the the other kind of options for modifying rolls that isn't covered by the '''[[Dice Reference]]'''-page. Also check the [https://app.roll20.net/forum/permalink/5899495/ Stupid Roll20 Tricks (and some clever ones)]-thread for Advanced and clever tricks that might not be linked on this page yet.
  
 
Features include:
 
Features include:
* Using [[Macros#Using_a_Targeted_Token_with_a_Macro|target]] and [[Macros#Using_a_Selected_Token_with_a_Macro|selected]] with tokens
+
* Adding options to user when roll is made('''Roll Queries''')
 +
* Using [[Macros#Using_a_Targeted_Token_with_a_Macro|@{target}]] and [[Macros#Using_a_Selected_Token_with_a_Macro|@{selected}]] to target tokens and their stats. See [[#Token|Token]]-section for interaction with them
 
** [https://app.roll20.net/forum/permalink/8048203/ Variable numbers of targets in an AoE attack] GenKitty
 
** [https://app.roll20.net/forum/permalink/8048203/ Variable numbers of targets in an AoE attack] GenKitty
 +
* Automatically add a roll to the [[Turn Tracker]]
 
* [[Reusing Rolls]]
 
* [[Reusing Rolls]]
====Errors====
 
If there is a mistake in the macro, or an attribute is missing, the roll might not work at all and only send and error message in the chat.
 
  
In some cases you can suppress error message and the roll will try to do waht it can while removing the error message.
+
====[[Dice_Reference#Roll_Queries|Roll Queries]]====
: <code>/roll 1d20 + @{selected|nonexistent_attribute} '''&{noerror}'''</code>
+
Sometimes you may have a roll (or a macro) which you want to change every time it is rolled. For example, you may want to roll a variable number of dice, or add a different modifier onto the roll each time you perform the action.
  
* Advanced Trick: [https://app.roll20.net/forum/permalink/9102789/ Catering for 'missing attributes' when summing values] by Ziechael shows how you can account for unknown number of stats in a repeating section, beyond just using <code>&{noerror}</code>
+
Roll Queries allow you to prompt whoever is performing the roll to fill in a value when the roll is made. The syntax for a roll query is:
 
+
====[[Dice_Reference#Roll_Queries|Roll Queries]]====
+
Sometimes you may have a roll (or a macro) which you want to change every time it is rolled. For example, you may want to roll a variable number of dice, or add a different modifier onto the roll each time you perform the action. Roll Queries allow you to prompt whoever is performing the roll to fill in a value when the roll is made. The syntax for a roll query is:
+
  
 
<pre data-language="javascript">
 
<pre data-language="javascript">
Line 80: Line 155:
 
'''Drop-down Queries'''
 
'''Drop-down Queries'''
  
You can specify a list of options which can be presented to the player, rather than only a free-form text field.
+
You can specify a list of options which can be presented to the [[player]], rather than only a free-form text field. Be mindful about if/when you add spaces inside a Roll Query, as having/not having them changes how things work.
  
 
Syntax:
 
Syntax:
 
<pre>?{Name of Query|Option1|Option2|Option3|Option4|Option5}</pre>
 
<pre>?{Name of Query|Option1|Option2|Option3|Option4|Option5}</pre>
  
You can also specify a different value for the result other than label like so:
+
Example:
<pre>?{Name of Query|Label 1, value1|Label 2, value2}</pre>
+
<pre>/em attempts ?{Difficulty level|an Easy|a Moderate|a Hard} task.</pre>
 +
 
 +
You can also specify a separate label for each option, instead of displaying the Option itself in the dropdown.
 +
<pre>?{Name of Query|Label 1,Option1|Label 2,Option2}</pre>
 +
This can be useful if the Option itself is long, or if it's better to describe what the options represent, rather than show exactly what they are.
 +
 
 +
 
 +
'''Example:'''
 +
<pre>
 +
/r d20+?{Stat:|Strength,2|Dexterity,1}
 +
</pre>
 +
 
 +
You may also split up Roll Queries on multiple rows to make the code more readable. ''Extra line breaks in code isn't generally a good idea, and could be good to avoid to not create errors.''
 +
<pre>
 +
?{Choose an Attack|
 +
  Melee,/roll 1d20 + 3[STR] |
 +
  Ranged,/roll 1d20 + 2[DEX] |
 +
  Magic,/roll 1d20 + 1[INT] }
 +
</pre>
 +
 
 +
If you're listing macros in your roll query, you '''must''' have a space after the macro name,  so Roll20 knows the name ends inside the query.In the below example, the three rolls have been saved into macros on the {{Collections}}-tab which then can be referenced in the macro.
 +
<pre>
 +
?{Choose an Attack|
 +
  Melee,#str |
 +
  Ranged,#dex |
 +
  Magic,#int }
 +
</pre>
 +
 
  
 
* [https://app.roll20.net/forum/permalink/6053873/ Query Ordering Without Affecting Functionality] how to borrow API command syntax(works for free users) - Ziechael
 
* [https://app.roll20.net/forum/permalink/6053873/ Query Ordering Without Affecting Functionality] how to borrow API command syntax(works for free users) - Ziechael
 +
* [[Chat Menus]],by Keith – In some cases, creating a '''chat menu''' for your macros is easier or better than making a complicated Query with several options.
  
 
====Nesting====
 
====Nesting====
Line 95: Line 198:
 
* [[Macros#Nesting_in_a_Roll_Query]]
 
* [[Macros#Nesting_in_a_Roll_Query]]
 
* [[Macros#Nesting_Abilities]]
 
* [[Macros#Nesting_Abilities]]
 +
* [[#HTML replacement|HTML replacement]](same page)
  
If you start nesting queries too much, you need to star using [[Macros#Advanced_Usage_for_Roll_Queries|HTML replacement]] keep the macros working. Once saved, these macros shouldn't be opened(if saved in the {{Collections}}-tab's Macro section, as opening a macro that have HTML replacement will result in those being converted into regular things, breaking your macro.
+
If you start nesting queries too much, you need to start using [[Macros#Advanced_Usage_for_Roll_Queries|HTML replacement]] keep the macros working. Once saved, these macros shouldn't be opened(if saved in the {{Collections}}-tab's Macro section, as opening a macro that have HTML replacement will result in those being converted into regular things, breaking your macro.
  
* [https://app.roll20.net/forum/permalink/6582632/ Drop down Nester] google sheet that generates the HTML replacement code needed. Scott C.
+
* [https://app.roll20.net/forum/permalink/6582632/ Drop down Nester] google sheet that generates the HTML replacement code needed. by Scott C.
 +
* [https://www.freeformatter.com/html-entities.html HTML entities] contains a longer list of all the existing HTML replacement code, of which only few are used/needed in Roll20 context.
  
 
====Initiative====
 
====Initiative====
Line 138: Line 243:
 
'''[[#API_Command_Buttons|API Command buttons]]'''
 
'''[[#API_Command_Buttons|API Command buttons]]'''
  
API Command buttons do not actually use the API—anyone can make and use them. The '''[https://app.roll20.net/forum/permalink/5927072/ Chat Menus]''' trick by Keith, uses utilizes them to great length.
+
API Command buttons do not actually use the API—anyone can make and use them. The '''[[Chat Menus]]''' trick by Keith, uses utilizes them to great length.
 +
 
 +
====Errors====
 +
If there is a mistake in the macro, or an attribute is missing, the roll might not work at all and only send and error message in the chat.
 +
 
 +
In some cases you can suppress error message and the roll will try to do what it can while removing the error message.
 +
: <code>/roll 1d20 + @{selected|nonexistent_attribute} '''&{noerror}'''</code>
 +
 
 +
* Advanced Trick: [https://app.roll20.net/forum/permalink/9102789/ Catering for 'missing attributes' when summing values] by Ziechael shows how you can account for unknown number of stats in a repeating section, beyond just using <code>&{noerror}</code>
 +
 
  
 
===[[Roll Table]]===
 
===[[Roll Table]]===
Line 164: Line 278:
 
''Main Page:'' '''[[Roll Templates]]'''
 
''Main Page:'' '''[[Roll Templates]]'''
  
You can access the Default Roll template in any game, to structure your results in the Text Chat. You simply write the template in the chat/macro( and don't use  the "/roll").
+
You can access the Default Roll template in any game, to structure your results in the Text Chat. You simply write the template in the chat/macro( and don't use  the <code>/roll</code>).
 
[[File:Roll template default example.JPG||right]]
 
[[File:Roll template default example.JPG||right]]
 
<pre style="overflow:hidden;white-space:pre-wrap">
 
<pre style="overflow:hidden;white-space:pre-wrap">
Line 170: Line 284:
 
</pre>
 
</pre>
  
You can use a Roll Template in general messages (without a command like "/desc" or "/emote") and whispers. You can't use roll templates with the "/roll" command; instead, Roll Templates are meant to be used with inline rolls. As long as they use inline rolls, you can use Roll Templates with macros, Character Abilities, and sheet authors can use them inside of their Roll Buttons on sheets.
+
You can use a Roll Template in general messages (without a command like <code>/desc</code> or <code>/emote</code>) and whispers. You can't use roll templates with the <code>/roll</code> command; instead, Roll Templates are meant to be used with inline rolls. As long as they use inline rolls, you can use Roll Templates with macros, Character Abilities, and sheet authors can use them inside of their Roll Buttons on sheets.
 +
 
 +
{{orange| Macros for roll templates are sensitive to leading spaces, so '''<code><nowiki>{{name=Dexterity}}</nowiki></code>''' will work, but  '''<code><nowiki>{{ name=Dexterity}}</nowiki></code>''' won't. }}
  
 
Many character sheets have built in Roll Templates that can only be used with those specific character sheets.
 
Many character sheets have built in Roll Templates that can only be used with those specific character sheets.
Line 186: Line 302:
 
* [https://app.roll20.net/forum/permalink/6827714/ Monster Images in Chat] - Kirsty
 
* [https://app.roll20.net/forum/permalink/6827714/ Monster Images in Chat] - Kirsty
 
* [https://app.roll20.net/forum/permalink/9031455/ Using Images as Links] - Oosh
 
* [https://app.roll20.net/forum/permalink/9031455/ Using Images as Links] - Oosh
 +
* [https://app.roll20.net/forum/post/9209645/inserting-images-into-macros Inserting Images into Macros] -forum thread
  
 
===Advanced===
 
===Advanced===
Line 194: Line 311:
  
 
* [[Reusing Rolls]] - clever trick to reuse rolls withing the same command. Was discovered in mid-2020.
 
* [[Reusing Rolls]] - clever trick to reuse rolls withing the same command. Was discovered in mid-2020.
* [https://app.roll20.net/forum/permalink/5927072/ Chat Menus] - how to create chat menu for your macros, by Keith
 
 
* [https://app.roll20.net/forum/permalink/5924364/ Macro Character Sheet] - keithcurtis — [https://app.roll20.net/forum/permalink/7605679/ More info] - gui8312 — [https://app.roll20.net/forum/permalink/6138238/ Giving Players Limited Access] - Kyle.G
 
* [https://app.roll20.net/forum/permalink/5924364/ Macro Character Sheet] - keithcurtis — [https://app.roll20.net/forum/permalink/7605679/ More info] - gui8312 — [https://app.roll20.net/forum/permalink/6138238/ Giving Players Limited Access] - Kyle.G
 
* [https://app.roll20.net/forum/permalink/6356266/ DM whispers without breaks]
 
* [https://app.roll20.net/forum/permalink/6356266/ DM whispers without breaks]
Line 202: Line 318:
 
* [https://app.roll20.net/forum/permalink/7406810/ Use a Macro to Report on Obscure Character Abilities and Rules] - macro template for calculating/showing derivative stats that aren't listed on the sheet but can be known, such as how long a character can hold breath. by PapaWhiskey11
 
* [https://app.roll20.net/forum/permalink/7406810/ Use a Macro to Report on Obscure Character Abilities and Rules] - macro template for calculating/showing derivative stats that aren't listed on the sheet but can be known, such as how long a character can hold breath. by PapaWhiskey11
  
==[[Token Actions]]==
+
====Chat Menus====
 +
''Idea by Keith Curtis''
 +
 
 +
Creating a '''[[Chat Menus]]''' for your macros is a great shortcut to have access to many buttons by only calling the chat menu macro.
 +
 
 +
==[[Token]]==
 +
Main Section: [[Macros#Token]]
 +
 
 +
You can target the stats of tokens(and the stats of a linked character sheet) by two methods,  using either '''[[Macros#Using_a_Selected_Token_with_a_Macro|@{selected}]]''', or '''[[Macros#Using_a_Targeted_Token_with_a_Macro|@{target}]]'''.
 +
 
 +
 
 +
===Variables===
 +
List of token-specific stats you can target with the usual <code>@{}</code> commands, that doesn't need to rely on having a [[Link Token|character sheet linked to the token]]:
 +
 
 +
* <code>bar1</code>,<code>bar2</code>,<code>bar3</code>(max values can also be used, see examples with <code>selected</code> and <code>target</code> how they differ)
 +
* <code>token_name</code>
 +
* <code>token_id</code>
 +
 
 +
===selected===
 +
Main page: '''[[Macros#Selected_Token_with_a_Macro|@{selected}]]'''
 +
 
 +
When using '''[[Macros#Selected_Token_with_a_Macro|@{selected}]]''', you need to first select the token you want to use, before making the roll, and you can only have one token using this method.
 +
 
 +
The <code>selected</code>-keyword will allow you to pull information from the element that is currently selected on the screen when the roll/macro is executed. So for example, if you want to pull the value of Bar 1 from the selected [[Token]] during a roll, you can do:
 +
 
 +
<pre data-language="javascript">/roll 1d20 + @{selected|bar1}</pre>
 +
 
 +
You can use "bar1", "bar2", or "bar3". In addition, you can also pull an attribute from the Character linked to that token, if there is one:
 +
 
 +
<pre data-language="javascript">/roll 1d20 + @{selected|Intelligence}</pre>
 +
 
 +
You can pull the Name of the currently selected tokens by using the &quot;token_name&quot; variable.
 +
 
 +
<pre data-language="javascript">/em @{selected|token_name} fires his gun!</pre>
 +
 
 +
If the selected token has a character journal linked to it, you can pull the Name from the character journal instead, using the &quot;character_name&quot; variable.
 +
 
 +
<pre data-language="javascript">/em @{selected|character_name} blocks with his shield!</pre>
 +
 
 +
You can also trigger abilities from the linked character journal by using the ability name as a variable.
 +
 
 +
<pre data-language="javascript">%{selected|Attack}</pre>
 +
 
 +
Finally, we've introduced a third argument for variables, allowing you to pull the "max" of a bar or attribute:
 +
 
 +
<pre data-language="javascript">
 +
/roll 1d20 + @{Guard|Intelligence|max}
 +
/roll 1d20 + @{selected|bar2|max}
 +
</pre>
 +
 
 +
===target===
 +
Main page: '''[[Macros#Targeted_Token_with_a_Macro|@{target}]]''',
 +
 
 +
When using [[Macros#Targeted_Token_with_a_Macro|@{target}]], you make the roll first, and then get prompted to select the target token(s), before the roll is then executed. You can target several tokens/characters in a single roll.
 +
 
 +
<pre data-language="javascript">/roll 1d20 - @{target|strength}</pre>
 +
This will bring up a prompt screen for the player to select which token target they are rolling against:
 +
 
 +
[[File:Choosetarget.png]]
 +
 
 +
The full syntax for the target variable is:
 +
 
 +
<pre data-language="javascript">@{target|<target_name>|<attribute_name>|<optional_flags>}</pre>
 +
(Note that 'target_name' can be anything you like, and can include spaces.)
 +
 
 +
So if you want to have multiple targets in your macro you can do:
 +
 
 +
<pre data-language="javascript">@{target|Target1|HP} vs @{target|Target2|AC}</pre>
 +
 
 +
And if you want to use the max of an attribute:
 +
 
 +
<pre data-language="javascript">@{target|Target1|HP|max}</pre>
 +
 
 +
Note that if you want to use the "max" flag you must specify the name of the target yourself, even if you just put "target1" as above.
 +
 
 +
Additionally, if you use the same target_name in multiple attribute queries, you will only get prompted for it once and the same token will be used to fulfill all of the attribute queries.  This also applies when you have multi-line macros or commands:
 +
 
 +
<pre data-language="javascript">/me strikes out at @{target|foe|character_name}!
 +
**To Hit**: [[1d20+3]] vs. @{target|foe|npc_AC} AC
 +
</pre>
 +
 
 +
===[[Token Actions]]===
 
Token Actions are specially-designated [[Macros|macros]] and [[Journal#Abilities_.28Need_Update.29|character abilities]] (with tokens [[Linking_Tokens_to_Journals|representing a character]]) which appear whenever a token is selected on the screen. They appear in a bar along the top of your screen, and the contents of the bar are context-sensitive. When you select a token, all macro token actions will be shown, as well as ability token actions for the token's linked character (if applicable).
 
Token Actions are specially-designated [[Macros|macros]] and [[Journal#Abilities_.28Need_Update.29|character abilities]] (with tokens [[Linking_Tokens_to_Journals|representing a character]]) which appear whenever a token is selected on the screen. They appear in a bar along the top of your screen, and the contents of the bar are context-sensitive. When you select a token, all macro token actions will be shown, as well as ability token actions for the token's linked character (if applicable).
  
Line 208: Line 405:
 
{{pro only}}
 
{{pro only}}
  
[[API|API commands]] start with <code>!</code> and then the name of the API command, and then write any other parameters for the API. The specific API script need to be installed in the game for this to work.
+
'''[[API|API commands]]'''(AKA '''API calls'''), start with <code>!</code> and then the name of the API command, and then write any other parameters for the API. Some API macros can be imbedded into regular macros, such as [[ChatSetAttr]]. To use any API in macros, the specific APIs[[API#Install_API| need to be installed in the game]] for them to work. Here are some examples of API commands/macros.
  
 
'''Example 1:'''
 
'''Example 1:'''
Line 230: Line 427:
 
<code>[Attack Roll](!attackroll)</code>
 
<code>[Attack Roll](!attackroll)</code>
  
You can also send them into the chat for others to use, but them needs to use HTML Replacement like with [[#Nesting]]:
+
You can also send them into the chat for others to use, but them needs to use HTML Replacement like with [[#Nesting|Nesting]]:
 
   
 
   
 
<code>[Attack Roll](!attackroll &amp;#64;{target|token_id} &amp;#91;[1d6+&amp;#63;{Bonus|0}]&amp;#93;)</code>  
 
<code>[Attack Roll](!attackroll &amp;#64;{target|token_id} &amp;#91;[1d6+&amp;#63;{Bonus|0}]&amp;#93;)</code>  
  
API Command buttons do not actually use the API — anyone can make and use them. The '''[https://app.roll20.net/forum/permalink/5927072/ Chat Menus]''' trick by Keith, uses utilizes them to great length.
+
API Command buttons do not actually use the API — anyone can make and use them. The '''[[Chat Menus]]''' trick by [[Keith]], uses utilizes them to great length.
  
 
''Tricks:''
 
''Tricks:''
Line 246: Line 443:
 
* [https://app.roll20.net/forum/permalink/9097236/ InsertArg & XRay]  script that gives you a way to interact with information in the game and feed it to the chat and/or other scripts, or to build your own output on the fly.
 
* [https://app.roll20.net/forum/permalink/9097236/ InsertArg & XRay]  script that gives you a way to interact with information in the game and feed it to the chat and/or other scripts, or to build your own output on the fly.
 
* [https://app.roll20.net/forum/permalink/4225825/ TokenMod] API that can edit any info on tokens. If token's are linked to a character, the changes to token bars extends to the character sheet.
 
* [https://app.roll20.net/forum/permalink/4225825/ TokenMod] API that can edit any info on tokens. If token's are linked to a character, the changes to token bars extends to the character sheet.
* [https://app.roll20.net/forum/post/8126152/combatmaster-alpha/?pagenum=1 Combat Master Alpha] Manages many facets of combat. It allows for API and Macro calls at various timing points (beginning of each round, beginning of each turn, when a condition is assigned, when a condition is removed).  
+
* [https://app.roll20.net/forum/post/9441420/combatmaster-2-dot-0&pagenum=1 Combat Master] Manages many facets of combat. It allows for API and Macro calls at various timing points (beginning of each round, beginning of each turn, when a condition is assigned, when a condition is removed).  
 
* [https://app.roll20.net/forum/permalink/8458497/ Token Action Maker]
 
* [https://app.roll20.net/forum/permalink/8458497/ Token Action Maker]
 
* '''Rollable Table Macros''' - a simple script that gets an item from a rollable table and enters its name as a chat message rather than showing it as a rollable table result
 
* '''Rollable Table Macros''' - a simple script that gets an item from a rollable table and enters its name as a chat message rather than showing it as a rollable table result
 
* [[Script:Star Wars: Fantasy Flight Games - Dice Roller]] - API for rolling the custom dice system used in the game
 
* [[Script:Star Wars: Fantasy Flight Games - Dice Roller]] - API for rolling the custom dice system used in the game
 +
* '''It's A Trap!''' Can be used to create a Trap that can automate rolls related to the trap, both for the trap and for the character(such as saves). There exists a generic one, as well as a number of system-specific version designed with popular sheets in mind(D&D5e, Pathfinder 1E)
  
 
==Character Sheet Creation==
 
==Character Sheet Creation==
Line 267: Line 465:
 
When you create/edit a character sheet, you can make your own Roll Templates to make your roll output look like you want, and to do some conditional things such as only showing some sections in case of a critical roll in another sections.
 
When you create/edit a character sheet, you can make your own Roll Templates to make your roll output look like you want, and to do some conditional things such as only showing some sections in case of a critical roll in another sections.
  
See [[Roll_Templates#Creating_a_Roll_Template]] for more.
+
See [[Building_Character_Sheets/Roll_Templates|Creating Roll Templates]] for how to make your own.
  
[[Roll_Templates#Helper_Functions]] describes what functions you can build into your sheets.
+
[[Roll_Templates#Helper_Functions|Helper_Functions]] describes what functions you can build into your sheets.
  
 
==Related Pages==
 
==Related Pages==
Line 277: Line 475:
 
** [[Macros]] - How to create macros, and other info on how the Roll20 <span style="font-family:Pictos;">q</span>Text Chat works, like referencing stats on character sheets, roll queries, nesting macros & initiative
 
** [[Macros]] - How to create macros, and other info on how the Roll20 <span style="font-family:Pictos;">q</span>Text Chat works, like referencing stats on character sheets, roll queries, nesting macros & initiative
 
*** [[Reusing Rolls]]
 
*** [[Reusing Rolls]]
 +
*** [[Chat Menus]]
 
** [[Roll Templates]] - a method of formatting roll results in the chat, with some extra functions
 
** [[Roll Templates]] - a method of formatting roll results in the chat, with some extra functions
 +
** [[Tokens]]
 
** [[API]]''(Pro Only)'' - API commands can be used in the <span style="font-family:Pictos;">q</span>Text Chat
 
** [[API]]''(Pro Only)'' - API commands can be used in the <span style="font-family:Pictos;">q</span>Text Chat
 +
 +
==Other Guides==
 +
 +
=== Creating Macros in Roll20(Nick Olivo) YT ===
 +
 +
{{#evp:youtube|SlwAXIDFveo|Creating [[Macros]] in Roll20 (Nick Olivo) |center|500}}
  
 
==TODO==
 
==TODO==

Revision as of 15:04, 14 February 2021

This is meant to serve as a comprehensive guide & starting point for figuring out how the q Text Chat, Dice Rolling, Macros and related things work and interact with each-other, to find the documentation for each, and to list everything you can write/make appear in the q Text Chat.

This is both for Players and Gamemasters who are just writing their own custom rolls or macros to be used in their game, as well as those who build Character Sheets and are creating/editing Roll Buttons for their sheets.

Contents

Text Chat

Basic-roll-example.png

The q Text Chat-page shows the basic commands that can be used in the chat, such as /roll(or /r) for making simple rolls, /em for emoting text, /w for whispering to someone, and /gmroll(or /gr) for sending simple rolls to the GM.

You can write in the q Text Chat normal text without using any commands like /r.

Normal macros can't edit stats, only read them. To edit stats with a command, you need to use API in some form.

Text Formatting

You can use common Markdown to format you text, and to create hyperlinks.

See also:

HTML replacement

When creating some complicated/sophisticated macros, usually involving nesting, you will need to use HTML entities in parts of the code to trick the Roll20 system to make it behave like you want, or some advanced tricks won't work.

Here are the HTML entities used in advanced Roll20 macros:

Character Replacement
| &#124;
, &#44;
} &#125;
& &amp;

Example use: Here is a macro that won't work:

?{Choose a Roll|
  STR,/roll 1d20 + 3 + ?{Bonus&#125;|
  DEX,/roll 1d20 + 2 + ?{Bonus&#125;|
  CON,/roll 1d20 + 1 + ?{Bonus&#125;}

Here is how you use HTML entities in it to replace certain characters to make it work:

?{Choose a Roll|
  STR,/roll 1d20 + 3 + ?{Bonus&#125; |
  DEX,/roll 1d20 + 2 + ?{Bonus&#125; |
  CON,/roll 1d20 + 1 + ?{Bonus&#125; }

Advanced Nesting example:

?{Name of Query|
   Label 1, ?{value1&#124;
      Label 1A&#44; ?{value1A&amp;#124;
         Label 1Ai&amp;#44; value1Ai &amp;#124;
         Label 1Aii&amp;#44; value1Aii
      &amp;#125; &#124;
      
      Label 1B&#44; ?{value1B&amp;#124;
         Label 1Bi&amp;#44; value1Bi &amp;#124;
         Label 1Bii&amp;#44; value1Bii
      &amp;#125;
   &#125; |

   Label 2, ?{value2&#124;value2&#125; 
}

HTML entities contains a longer list of all the existing HTML entities, of which only few are used/needed in Roll20 context, but might be useful to check if the above table isn't enough.

See Advanced Usage for Roll_Queries for examples of use.

Chat Commands

Main Page: q Text Chat

  • /r, /roll - for making simple rolls. Ex. /r 1d20+5
  • /w - for whispering a message to a person so only they see it. Ex. /w Alice Does the goblin know the paladin?, /w "Bob Smith" Where's the money pouch?!
  • /gr, /gmroll - to make rolls only to the GM. Ex. /gr 2d6+3
  • /em to emote as the character selected. Ex. /em takes out one of his throwing daggers and brandishes it threateningly.
  • /ooc - to message something that is Out-of-character Ex. /ooc I could really use another coffee right now.
  • /talktomyself - To turn off your chat display for all others, including the GM and the chat archive recording. Use it again to turn it back on
  • /fx - used for creating visual effects Ex. /fx beam-acid @{target|Caster|token_id} @{target|Foe|token_id}
  • GM-exclusive:
    • /desc to describe the situation Ex. The old house begins to creak and moan...
    • /as, /emas emote as any character, better version of /em Ex. /as "Sir Bearington" I'm going to eat you for breakfast.


Beyond using the various Roll Commands shown on the q Text Chat-page, here are some other examples of what you can write in the q Text Chat:

  • Macros - Start with #, and start typing the macro name, and a list of your macros will be displayed.
    • Example: writing #testmacro in the chat will roll the macro with that name
  • Roll Templates - &{template:name-of-roll-template} {{sectionname(optional)=content of roll template}}.
    • The Default Roll Template is available in any games, other templates are tied to specific Character Sheet Templates. (E.g. you can only access the specific &{template:simple} when you have D&D 5E by Roll20-sheet in the game).
    • Example: &{template:default} {{name=Test Attack}} {{attack=[[1d20]]}} {{damage=[[2d6]]}}
    • This will generate a roll template using the default template, displaying "Test Attack" in the purple title, then on a new row the result of 1d20 roll, and on the third row the 2d6 roll
  • Character Abilities/Character Sheet Button - %{character name|ability or roll button name}
    • Example 1; writing %{Sam Bobbins|initiative} in the chat, will work if there exists a Character with that name, who have a Character Ability/Character Sheet Roll Button by that name
    • Example 2: selecting a Token on the map, and then writing %{selected|initiative} in the chat, will work if the token is linked to a character sheet that has an Ability or Roll button with that name.
  • API commands(available in games hosted by a pro user), - Start with ! to call the API command, and then write and parameters it can take
    • Example: writing !MassInit in the chat will trigger an API that uses MassInit as a keyword.

Dice Syntax

The Dice Reference page shows how the syntax for the Roll20 dice rolling works, and all the advanced alternatives you can use, such as rolling Fate Dice, or counting successes rather than the sum of the rolls. It also details when the green "Critical Success" and red "Critical Failure" highlights are shown.

Tricks:

Order of Operations

The Order of Operations sections highlights in what order different components resolve, which can become important when you do complicated things.

Inline Labels

If you want to include additional comments before the end of the roll (we call them "inline labels"), use square brackets. For example, /roll 2d10+5[Fire Damage] + 3d6[Ice Damage]. When these comments are applied directly after a die roll they show up as tool-tips on the dice:

/roll 2d10+5[Fire Damage] + 3d6[Ice Damage]

This is especially useful if a roll contains multiple variables and you want to look up what number comes from what attribute.


Macros

Main Article: Macros

The Macros page lists all the the other kind of options for modifying rolls that isn't covered by the Dice Reference-page. Also check the Stupid Roll20 Tricks (and some clever ones)-thread for Advanced and clever tricks that might not be linked on this page yet.

Features include:

Roll Queries

Sometimes you may have a roll (or a macro) which you want to change every time it is rolled. For example, you may want to roll a variable number of dice, or add a different modifier onto the roll each time you perform the action.

Roll Queries allow you to prompt whoever is performing the roll to fill in a value when the roll is made. The syntax for a roll query is:

?{Prompt Message}
//Example:
/roll ?{Number of Dice}d20
//You can also include a default value:
/roll ?{Number of Dice|1}d20
// 1 would be the default

Drop-down Queries

You can specify a list of options which can be presented to the player, rather than only a free-form text field. Be mindful about if/when you add spaces inside a Roll Query, as having/not having them changes how things work.

Syntax:

?{Name of Query|Option1|Option2|Option3|Option4|Option5}

Example:

/em attempts ?{Difficulty level|an Easy|a Moderate|a Hard} task.

You can also specify a separate label for each option, instead of displaying the Option itself in the dropdown.

?{Name of Query|Label 1,Option1|Label 2,Option2}
This can be useful if the Option itself is long, or if it's better to describe what the options represent, rather than show exactly what they are.


Example:

/r d20+?{Stat:|Strength,2|Dexterity,1}

You may also split up Roll Queries on multiple rows to make the code more readable. Extra line breaks in code isn't generally a good idea, and could be good to avoid to not create errors.

?{Choose an Attack|
   Melee,/roll 1d20 + 3[STR] |
   Ranged,/roll 1d20 + 2[DEX] |
   Magic,/roll 1d20 + 1[INT] }

If you're listing macros in your roll query, you must have a space after the macro name, so Roll20 knows the name ends inside the query.In the below example, the three rolls have been saved into macros on the l Collections-tab which then can be referenced in the macro.

?{Choose an Attack|
   Melee,#str |
   Ranged,#dex |
   Magic,#int }


Nesting

To some degree, you can nest abilities, macros and queries.

If you start nesting queries too much, you need to start using HTML replacement keep the macros working. Once saved, these macros shouldn't be opened(if saved in the l Collections-tab's Macro section, as opening a macro that have HTML replacement will result in those being converted into regular things, breaking your macro.

  • Drop down Nester google sheet that generates the HTML replacement code needed. by Scott C.
  • HTML entities contains a longer list of all the existing HTML replacement code, of which only few are used/needed in Roll20 context.

Initiative

Main section: Macros#Rolling_For_Initiative

To send a roll result directly to the Turn Tracker, first, select the Token you wish to roll initiative for, and then make a roll that includes the &{tracker}-flag. You can also increase/decrease initiative by using &{tracker:+}/&{tracker:-}.

Examples:

  • /roll 1d20 + 5 &{tracker}
  • &{template:default} {{name=Initiative}} {{Roll=[[1d20+4 &{tracker}]]}}
  • /roll 1d4 + 1 &{tracker:+} (increases the initiative by 1d4+1)
  • /roll 2 &{tracker:-} (decreases the initiative by a flat 2)
  • [[5 &{tracker:-}]] (inline roll that decreases the initiative by a flat 2)

See also: Cards#Using_Cards_for_Initiative_Order

See the Turn Tracker-page for the Token/Turn Tracker/Character Sheet related info.

Tricks using the Turn Tracker:

Chat Buttons

There are two types of buttons you can create in the Text Chat to be included in a macro/dicerolling result.

Ability Command Buttons

Ability Command Buttons can be used to call Abilities (or sheet button rolls) from a clickable button in the Text Chat. They are very closely related to API Command Buttons.

Their syntax is as follows:

[Label](~<keyword>|<ability name>)

As with Attribute and Ability calls, the keyword is your choice of selected, target or a character_name. You can also use a character_id as a keyword.

If you have an Ability Command Button saved somewhere within one of the tabs of the Character Window, you can choose to omit a keyword:

[Label](~<ability name>)

API Command buttons

API Command buttons do not actually use the API—anyone can make and use them. The Chat Menus trick by Keith, uses utilizes them to great length.

Errors

If there is a mistake in the macro, or an attribute is missing, the roll might not work at all and only send and error message in the chat.

In some cases you can suppress error message and the roll will try to do what it can while removing the error message.

/roll 1d20 + @{selected|nonexistent_attribute} &{noerror}


Roll Table

If you have Roll Tables on your l Collections-tab, they can be used in rolls & macros.

Example1:

Let's assume there exist a roll table with the name fumble.

You can roll a table directly in the chat input, or in a macro, simply as 1t[fumble].

Example 2: To roll your "crit-failure" table two time, you would enter /roll 2t[crit-failure]. You can change 2 to whatever number you would like. However, this currently does not work with inline rolls.

You can also roll a table inline in chat or a macro by wrapping it in double square brackets like this [[1t[table-name]]]. Currently, any number beyond 1 does not display for the inline roll, the results are show on mouseover though.


Roll Templates

Main Page: Roll Templates

You can access the Default Roll template in any game, to structure your results in the Text Chat. You simply write the template in the chat/macro( and don't use the /roll).

Roll template default example.JPG
&{template:default} {{name=Test Attack}} {{attack=[[1d20]]}} {{damage=[[2d6]]}}

You can use a Roll Template in general messages (without a command like /desc or /emote) and whispers. You can't use roll templates with the /roll command; instead, Roll Templates are meant to be used with inline rolls. As long as they use inline rolls, you can use Roll Templates with macros, Character Abilities, and sheet authors can use them inside of their Roll Buttons on sheets.


Many character sheets have built in Roll Templates that can only be used with those specific character sheets.

Tricks:

  • Use images with Default Roll Template: If you want to dress up your default template, you can stuff an image in the name portion instead of just text
    • Example: &{template:default}{{name=[x](YOUR_IMAGE_URL#.png)}}{{test=foo}}
  • Overwriting Template Fields in Macros - Oosh

Images

Various ways to use or show images in macros or the chat.

Advanced

The Stupid Roll20 Tricks (and some clever ones) contains a large amount of tricks and examples of clever uses for macros etc. that is a must to check out.

Here under are mentioned a limited number of the list's tricks(more could be listed or copied entirely to the wiki):

Chat Menus

Idea by Keith Curtis

Creating a Chat Menus for your macros is a great shortcut to have access to many buttons by only calling the chat menu macro.

Token

Main Section: Macros#Token

You can target the stats of tokens(and the stats of a linked character sheet) by two methods, using either @{selected}, or @{target}.


Variables

List of token-specific stats you can target with the usual @{} commands, that doesn't need to rely on having a character sheet linked to the token:

  • bar1,bar2,bar3(max values can also be used, see examples with selected and target how they differ)
  • token_name
  • token_id

selected

Main page: @{selected}

When using @{selected}, you need to first select the token you want to use, before making the roll, and you can only have one token using this method.

The selected-keyword will allow you to pull information from the element that is currently selected on the screen when the roll/macro is executed. So for example, if you want to pull the value of Bar 1 from the selected Token during a roll, you can do:

/roll 1d20 + @{selected|bar1}

You can use "bar1", "bar2", or "bar3". In addition, you can also pull an attribute from the Character linked to that token, if there is one:

/roll 1d20 + @{selected|Intelligence}

You can pull the Name of the currently selected tokens by using the "token_name" variable.

/em @{selected|token_name} fires his gun!

If the selected token has a character journal linked to it, you can pull the Name from the character journal instead, using the "character_name" variable.

/em @{selected|character_name} blocks with his shield!

You can also trigger abilities from the linked character journal by using the ability name as a variable.

%{selected|Attack}

Finally, we've introduced a third argument for variables, allowing you to pull the "max" of a bar or attribute:

/roll 1d20 + @{Guard|Intelligence|max}
/roll 1d20 + @{selected|bar2|max}

target

Main page: @{target},

When using @{target}, you make the roll first, and then get prompted to select the target token(s), before the roll is then executed. You can target several tokens/characters in a single roll.

/roll 1d20 - @{target|strength}

This will bring up a prompt screen for the player to select which token target they are rolling against:

Choosetarget.png

The full syntax for the target variable is:

@{target|<target_name>|<attribute_name>|<optional_flags>}

(Note that 'target_name' can be anything you like, and can include spaces.)

So if you want to have multiple targets in your macro you can do:

@{target|Target1|HP} vs @{target|Target2|AC}

And if you want to use the max of an attribute:

@{target|Target1|HP|max}

Note that if you want to use the "max" flag you must specify the name of the target yourself, even if you just put "target1" as above.

Additionally, if you use the same target_name in multiple attribute queries, you will only get prompted for it once and the same token will be used to fulfill all of the attribute queries. This also applies when you have multi-line macros or commands:

/me strikes out at @{target|foe|character_name}!
**To Hit**: [[1d20+3]] vs. @{target|foe|npc_AC} AC

Token Actions

Token Actions are specially-designated macros and character abilities (with tokens representing a character) which appear whenever a token is selected on the screen. They appear in a bar along the top of your screen, and the contents of the bar are context-sensitive. When you select a token, all macro token actions will be shown, as well as ability token actions for the token's linked character (if applicable).

API

API commands(AKA API calls), start with ! and then the name of the API command, and then write any other parameters for the API. Some API macros can be imbedded into regular macros, such as ChatSetAttr. To use any API in macros, the specific APIs need to be installed in the game for them to work. Here are some examples of API commands/macros.

Example 1: writing !wd [[4d6+2]] in the chat will trigger the Script:Wild Dice script to make a custom roll output, rolling 3 normal d6 dice, and one Wild Die, presenting it in a table. If the Wild Die comes up as a "1", it, and the value of the highest dice is removed form the roll total. This is not something that can be done with macros alone, which is why this API was created.

Wild-Dice-result-v3-4.png

Example 2:

writing !group-init in the chat will trigger the GroupInitiative(must be installed) API that uses group-init as a keyword. This particular API command would roll initiative order for all selected tokens, if the API is configured to know what stats to roll.

Example 3:

writing &{template:default} {{name=Cthulhu}} !modattr --silent --charid @{target|character\_id} --sanity|-{{Sanity damage=[[2d10+2]]}} --corruption|{{Corruption=Corruption increases by [[1]]}}!!! {{description=Text}} in the chat, and selecting a Token on the map, will decrease sanity by 2d10+2 and increase corruption by 1 for the character selected.

This is the ChatSetAttr API, which can be used standalone with the !modattr command, but more notably, can be incorporated into regular macros, resulting in you being able to both make rolls and have the result change the stats.

API Command Buttons

They have simple Markdown formatting:

[Attack Roll](!attackroll)

You can also send them into the chat for others to use, but them needs to use HTML Replacement like with Nesting:

[Attack Roll](!attackroll &#64;{target|token_id} &#91;[1d6+&#63;{Bonus|0}]&#93;)

API Command buttons do not actually use the API — anyone can make and use them. The Chat Menus trick by Keith, uses utilizes them to great length.

Tricks:

Relevant API

APIs that have lots of commands or have lot to do with dice rolling.

  • Script:ChatSetAttr - can be used inline & mixed in with other macros
  • PowerCards - API made to display stats in variety of way in the chat, essentially a sophisticated, API-based version of the Default Roll Template with massive amount of features. It can be used to call other API like ChatSetAttr or TokenMod
  • InsertArg & XRay script that gives you a way to interact with information in the game and feed it to the chat and/or other scripts, or to build your own output on the fly.
  • TokenMod API that can edit any info on tokens. If token's are linked to a character, the changes to token bars extends to the character sheet.
  • Combat Master Manages many facets of combat. It allows for API and Macro calls at various timing points (beginning of each round, beginning of each turn, when a condition is assigned, when a condition is removed).
  • Token Action Maker
  • Rollable Table Macros - a simple script that gets an item from a rollable table and enters its name as a chat message rather than showing it as a rollable table result
  • Script:Star Wars: Fantasy Flight Games - Dice Roller - API for rolling the custom dice system used in the game
  • It's A Trap! Can be used to create a Trap that can automate rolls related to the trap, both for the trap and for the character(such as saves). There exists a generic one, as well as a number of system-specific version designed with popular sheets in mind(D&D5e, Pathfinder 1E)

Character Sheet Creation

Info and links to things that are only relevant or usable for when you're Building/Editing Character Sheets. Consult the rest of the guide for general details.

Roll Button

The rest of this guide will help in creating more complicated macros, but the main Button#Roll_Button-page have some concrete examples of how macros are implemented in character sheets.

Sheetworkers

With the info from Macros, fairly complex outputs to the q Text Chat can be made, but to be able to construct complex and dynamic results based on various factors on your character sheet, you will need to use JavaScript to write Sheet Worker Scripts that modify & construct your roll output dynamically.

Roll Template

When you create/edit a character sheet, you can make your own Roll Templates to make your roll output look like you want, and to do some conditional things such as only showing some sections in case of a critical roll in another sections.

See Creating Roll Templates for how to make your own.

Helper_Functions describes what functions you can build into your sheets.

Related Pages

  • Complete Guide to Macros & Rolls‎
    • q Text Chat - where the roll results appear, & info on the common chat commands
    • Dice Reference - Comprehensive list of how the Roll20 dice-rolling syntax works, and list the features available
    • Macros - How to create macros, and other info on how the Roll20 qText Chat works, like referencing stats on character sheets, roll queries, nesting macros & initiative
    • Roll Templates - a method of formatting roll results in the chat, with some extra functions
    • Tokens
    • API(Pro Only) - API commands can be used in the qText Chat

Other Guides

Creating Macros in Roll20(Nick Olivo) YT

Creating Macros in Roll20 (Nick Olivo)

TODO

  • add image examples of macros used, input + output
  • at least one example for each mentioned concept
  • Roll Template examples
  • List rest of the examples from "Stupid Tricks" thread