Roll20 Wiki

{{revdate}}{{clear}}
{{NavMacroDocs}}
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]] 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.

{{#evp:youtube|SlwAXIDFveo|Creating [[Macros]] in Roll20 (Nick Olivo)|right|600}}
==[[Text Chat]]==
[[File:Basic-roll-example.png|left|thumbnail|400px|]]
The {{Text Chat}}-page shows the basic commands that can be used in the chat, such as <code>/roll</code>(<code>/r</code>) for making simple rolls, <code>/em</code> for emoting actions, <code>/w</code> for whispering to someone, and <code>/gmroll</code>( <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>.

See [[#Chat Commands|Chat Commands]]-sections for examples, or the 

'''Normal macros can't edit stats, only read them.''' To edit stats with a command, you need to use [[#API|API]] in some form. 
{{clear}}
===Formatting===
{{main|Macros/Formatting}}
{{:Macros/Formatting}}

==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> to send a regular chat message as any character, but with no avatar '''Ex.''' <code>/as "Sir Bearington" I'm going to eat you for breakfast.</code>
** <code>/emas</code> emote as any character, similar to <code>/em</code> but with no avatar '''Ex.''' <code>/emas Sir Bearington decides to have porridge instead.</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.
** '''Example:''' writing <code>#testmacro</code> in the chat will roll the macro with that name
* [[Roll Templates]] - <code><nowiki>&{template:name-of-roll-template} {{sectionname(optional)=content of roll template}}</nowiki></code>.
** 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 <code>&{template:simple}</code> when you have [[D&D 5E by Roll20]]-sheet in the game). 
** '''Example:''' <code><nowiki>&{template:default} {{name=Test Attack}} {{attack=[[1d20]]}} {{damage=[[2d6]]}}</nowiki></code>
** 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 <code>1d20</code> roll, and on the third row the <code>2d6</code> roll
* [[Character#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 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
** '''Example:''' writing <code>!setattr</code> in the chat will trigger an API that uses <code>setattr</code> as a keyword. Often these commands may have additional parameters, e.g. <code>!setattr --name John --hp|15</code>

===[[Dice Reference|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 [[Dice_Reference#FATE_Dice|Fate Dice]], or [[Dice_Reference#Target_Number_.28Successes.29|counting successes]] rather than the sum of the rolls. It also details when the green & red "[[Dice_Reference#Critical_Success_and_Fumble_Points|Critical Success/Failure]]"-highlights are shown. 

''Tricks:''
* {{fpl|9171656/ Comparing numbers, greater than or equal to}} - Mike deBoston
* {{fpl|7510681/ Bypass Blank Ability Call Math}} - Blue64
* {{fpl|6113861/ Summing "Success" Rolls}} - Usually you can't both coun't the success and sum up rolls, but this is a close workaround by Bryan P. 
* {{fpl|8068345/ Fake Crits Using Math Instead of Dice}} - Noon
* {{fpl|8717558/ Auto calculating level specific buffs. (Basic IF/THEN statement, no API)}} - Greg S.
* {{fpl|6003370/ Keep Crits/Fumbles from Display on Attack Rolls}} - [[Scott|Scott C.]]

====Inline Rolls====
{{main|Inline Rolls}}
[[File:Roll template default example2.JPG|right|thumb|350px|The output of a '''default template''' that shows an '''inline roll'''(yellow box) ]]
If you use simple roll commands/macros like <code>/roll 2d10+5</code>, the whole command is a dice roll. But when you use [[#Roll Templates|Roll Template]], or have embedded dice rolls with other commands like <code>/em</code>, you use '''inline rolls''', where you wrap <code><nowiki>[[ ]]</nowiki></code> around the calculation for it to be processed. The result of "Normal" dice rolls is shown as individual dice images displaying the result on each dice separately, along with the total result.

Inline rolls are just like regular rolls, with the following exceptions:

* You can use them in any chat message, not just a roll. For example, you can do a regular chat message, an emote(<code>/em</code>), or a whisper(<code>/w</code>), with an inline roll included.
* They are evaluated completely before any (<code>/roll</code>) commands, so you can use them as "random variables" in your rolls.
* You will only see the result of the total roll, and you can hover over the result to see the individual dice rolls.
* Highlights
** If an inline roll contains a '''critical success''', it will be highlighted with a green box.
** If there's a '''critical failure''', it's highlighted in red.
** If it has '''both''' (because there was more than one roll), it's in blue.

Also when you mouse-over the inline roll to see the details of the roll, it'll show red and green highlights for the rolls themselves for crits/fumbles.

With inline rolls, the numerical end result is shown in a (yellow) box, and if you hover your mouse over the result, you see the full equation of the roll, along with the result of each.

{{ex}}
<pre style="overflow:auto;white-space:pre-wrap;">
/em swings their sword and does [[2d6+2]] damage.
</pre>
<pre style="overflow:auto;white-space:pre-wrap;">
&{template:default} {{name=Test Attack}} {{attack=[[1d20+5]]}}
</pre>

====[[Inline Rolls#Inline Labels|Inline Labels]]====
If you want to include additional comments before the end of the roll (we call them &quot;inline labels&quot;), use square brackets. For example, <code>/roll 2d10+5[Fire Damage] + 3d6[Ice Damage]</code>. Inline labels works both with "normal" rolls and '''inline rolls'''. 

When these comments are applied directly after a die roll they show up as tool-tips on the dice:
<div class="diceroller">
/roll 2d10+5[Fire Damage] + 3d6[Ice Damage]
</div>

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

'''You can even use sheet attributes in labels.''' Especially useful if the name of the stat can be customized by the user, so the corresponding label should change to reflect the name.
{{ex}}
<pre style="overflow:auto;white-space:pre-wrap;">
/r @{selected|customskill1}d6[@{selected|customskill1name}] + @{selected|str}[str]
</pre>

===[[Order of Operations]]===
{{:Order of Operations}}

===[[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:
* 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
** {{forum|permalink/8048203/ Variable numbers of targets in an AoE attack}} - GenKitty
* Automatically add a roll to the [[Turn Tracker]]
* [[Reusing Rolls]]

====[[Roll Query|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 style="overflow:auto;white-space:pre-wrap;" data-language="javascript">
?{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
</pre>

=====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. If the content of the dropdown query includes characters like <code>|</code>,<code>{</code>,<code>}</code>, and<code>,</code>, you will likely need to use [[#HTML replacement|HTML replacement]] for them to make it work.

Syntax:
<pre style="overflow:auto;white-space:pre-wrap;">?{Name of Query|Option1|Option2|Option3|Option4|Option5}</pre>

Example:
<pre style="overflow:auto;white-space:pre-wrap;">/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 style="overflow:auto;white-space:pre-wrap;">?{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 style="overflow:auto;white-space:pre-wrap;">
/r d20+?{Stat:|Strength,2|Dexterity,1}
</pre>

If you place the drop-down query at the start of a macro, make sure there is no space after the <code>,</code>, as this will break any macro or command inside it.

<pre style="overflow:auto;white-space:pre-wrap;">?{Attack|Just roll,/r d20+5|Description,/em swings the sword with a result of [[d20+5]]}</pre>
{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
| non-functional version
|-
| <pre style="overflow:auto;white-space:pre-wrap;">?{Attack|Just roll, /r d20+5|Description, /em swings the sword with a result of [[d20+5]]}</pre>
|}

Repeating the same-named Roll Query within a macro will prompt the [[player]] only once, however the result will be evaluated wherever it is included.
<pre style="overflow:auto;white-space:pre-wrap;">&{template:default} {{name=Test Attack}} {{attack=[[1d20]]}} {{damage=[[2d6+?{Extra Damage?|0}]]}} {{Crit damage=[[12+?{Extra Damage?|0}]]}}</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 style="overflow:auto;white-space:pre-wrap;">
/roll 1d20 + ?{Choose an Attack|
   Melee,3[STR] |
   Ranged,2[DEX] |
   Magic,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 style="overflow:auto;white-space:pre-wrap;">
?{Choose an Attack|
   Melee,#str |
   Ranged,#dex |
   Magic,#int }
</pre>

* {{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]]====
To some degree, you can nest abilities, macros and queries. 

* [[Nesting#Nesting Queries|Nesting Queries]]
* [[Nesting#Nesting Macros|Nesting Macros]]
* [[Nesting#Nesting Abilities|Nesting Abilities]]
* [[#HTML replacement|HTML replacement]]

If you start nesting queries too much, you need to start using HTML replacement characters to 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. 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====
<small>{{main|Macros/Initiative}}</small>
<!-- TODO translcusion Macros/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 
<code>&{tracker}</code>-flag. You can also increase/decrease initiative by using <code>&{tracker:+}</code>/<code>&{tracker:-}</code>.
{{ex}}
* <code>/roll 1d20 + 5 &{tracker}</code>
* <code><nowiki>&{template:default} {{name=Initiative}} {{Roll=[[1d20+4 &{tracker}]]}} </nowiki></code>
* <code>/roll 1d4 + 1 '''&{tracker:+}'''</code> (increases the initiative by <code>1d4+1</code>)
* <code>/roll 2 '''&{tracker:-}'''</code> (decreases the initiative by a flat <code>2</code>)
* <code>[[5 &{tracker:-}]]</code> (inline roll that decreases the initiative by a flat <code>2</code>)

See also: [[Cards#Using_Cards_for_Initiative_Order|Using Cards for Initiative Order]]

'''Referencing values on the turn tracker:''' by calling  <code>@{Tracker|character_id}</code> <code>@{Tracker|character_name}</code>, you can check what values are on the turn tracker. ex. <code>Bobs initiative is @{tracker|Bob}.</code>

Tricks using the {{Turn Tracker}}:
{{:Turn Tracker/Tricks}}

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

'''[[Macros#Ability_Command_Buttons|Ability Command Buttons]]'''

Ability Command Buttons can be used to call [[Journal#Abilities|Abilities]] (or [[Character_Sheets#Sheet_Rolls|sheet button rolls]]) from a clickable button in the Text Chat. They are very closely related to [[API:Chat#API_Command_Buttons|API Command Buttons]].
<br><br>
Their syntax is as follows:
<pre style="overflow:auto;white-space:pre-wrap;">
[Label](~<keyword>|<ability name>)
[Dex Check](~Bob|dexterity)
[Dex Check](~selected|dexterity_save)
[Dex Check](~selected|repeating_attack_$0_attack)
</pre>
As with [[Journal#Attributes|Attribute]] and [[Journal#Abilities|Ability]] calls, the '''keyword''' is your choice of <code>selected</code>, <code>target</code> or a character_name. You can also use a character_id as a keyword.
<br><br>
If you have an Ability Command Button saved somewhere within one of the tabs of the [[Journal#Character_Window|Character Window]], you can choose to omit a keyword:
<pre style="overflow:auto;white-space:pre-wrap;">
[Label](~<ability name>)
[Dex Check](~dexterity)
</pre>

'''[[#API_Command_Buttons|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.
: <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]]===
If you have [[Roll Tables]] on your {{Collections}}-tab, they can be used in rolls & macros.

'''Example1:'''

Let's assume there exist a roll table with the name <code>fumble</code>.

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

'''Example 2:'''
To roll your &quot;crit-failure&quot; table two time, you would enter <code>/roll 2t[crit-failure]</code>. You can change <code>2</code> 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 <code>[[1t[table-name]]]</code>. Currently, any number beyond 1 does not display for the inline roll, the results are show on mouseover though.

* [https://app.roll20.net/forum/post/5899495/stupid-roll20-tricks-and-some-clever-ones/?pageforid=6948596#post-6948596 Nestable Rollable Tables (Free User Version)] - Blue64
* [https://app.roll20.net/forum/permalink/8724512/ Using Rollable Tables and Custom Handouts for Character Cards Using Rollable Tables and Custom Handouts for Character Cards] - Drew
* [https://app.roll20.net/forum/permalink/8851426/ Inline Rolls in Rollable Tables] - Eric B (plus followup posts)
* [https://app.roll20.net/forum/permalink/8788506/ Conditional Text] - Mike deBoston
* [https://app.roll20.net/forum/permalink/6852555/ Rollable Encounter Images] - Blue64
* {{forum|permalink/9898031/ Nesting Roll Tables}}


===[[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 <code>/roll</code>).
[[File:Roll template default example.JPG||right]]
<pre style="overflow:hidden;white-space:pre-wrap">
&{template:default} {{name=Test Attack}} {{attack=[[1d20]]}} {{damage=[[2d6]]}}
</pre>

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.

''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: <code><nowiki>&{template:default}{{name=[x](YOUR_IMAGE_URL#.png)}}{{test=foo}}</nowiki></code>
* '''[https://app.roll20.net/forum/permalink/9112320/ Overwriting Template Fields in Macros]''' - Oosh


===Advanced===

{{forum|permalink/5899495/ Roll20 Tips and Tricks (Innovative Solutions to Common Problems)}} contains a large amount of tricks and examples of clever uses for macros etc. that is a must to check out. 

* [[Hidden Rolls]] - have the player make blind rolls, and only the GM see the result.
* [[Macro Character Sheet]] - [[keithcurtis]]
* [[Reusing Rolls]] - clever trick to reuse rolls withing the same command. Was discovered in mid-2020.

Here under are mentioned a limited number of the list's tricks(more could be listed or copied entirely to the wiki):
* [[Toggleable template fields]]
* [https://app.roll20.net/forum/permalink/10693202/ Macro curiosities, or how to overcomplicate everything] by RainbowEncoder 
* {{forum|permalink/9663315/ Tooltips for links, roll buttons etc.}} - RainbowEncoder |{{forum|permalink/6397574/ Tooltip Hack (older)}} - Aranador
* {{forum|permalink/6356266/ DM whispers without breaks}}
* {{forum|permalink/8080373/ Dynamic Multitarget Roll without API}} - Barakka
* {{forum|permalink/6137639/ Prefix Trick to Variably Call Attributes}} - Kyle G.
* {{forum|permalink/8511142/ Hypertext Macro to Open a Linked Character Sheet}} - [[Vince]]
* {{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/9840963/ Skill check with text result]
* [https://app.roll20.net/forum/permalink/10557595/ Keep Nth; Select from sequence] - RainbowEncoder
====Images====
Various ways to use or show images in macros or the chat.

* {{forum|permalink/6814834/ Pictures and GIFs in Chat and Abilities}} - Blue64
* {{forum|permalink/6827714/ Monster Images in Chat}} - Kirsty
* {{forum|permalink/9031455/ Using Images as Links}} - [[Oosh]]
* {{forum|post/9209645/inserting-images-into-macros Inserting Images into Macros}}
* [https://app.roll20.net/forum/permalink/10377160/ Make gif loop infinitely] - [[Oosh]]
* [https://app.roll20.net/forum/permalink/10376893/ Displaying Images Based On Roll Results] - Fnux
====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 called with <code>@{bar1|max}</code>, <code>@{bar2|max}</code>, <code>@{bar3|max}</code>)''
* <code>token_name</code>
* <code>token_id</code>

If a character sheet is linked, and you have linked a sheet attribute to one of the bars, you can reference that stat either by targeting the token's bar, or the actual name of the attribute on the sheet.

{{ex}}
* <code>Token **"@{selected|token_name}"** has [[@{selected|bar1}]] out of [[@{selected|bar1|max}]] HP left.</code> - displays the token name and the current/max value of bar1
** token bar max values need to be referenced with <code>@{attrname|max}</code>, using <code>@{attrname_max}</code> doesn't work.
* <code><nowiki>&{template:default} {{name=**Character & Token ID**}} {{Character Name=@{selected|character_name} }}  {{**Character ID**= @{selected|character_id} }} {{**Token Name**= @{selected|token_name} }} {{**Token ID**= @{selected|token_id} }} {{**Bar 1**= @{selected|bar1} / @{selected|bar1|max} }} {{**Bar 2**= @{selected|bar2} / @{selected|bar2|max} }} {{**Bar 3**= @{selected|bar3} / @{selected|bar3|max} }}</nowiki></code>
** a macro that displays the <code>token_id</code>, <code>token_name</code> and token bar values, as well as the <code>character_id</code> & <code>character_name</code> if token is linked to a sheet.

===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>

On token bars, you must reference max values with the <code>@{selected|bar1|max}</code> syntax, while for character attributes, both <code>@{selected|attrname|max}</code> and <code>@{selected|attrname_max}</code> works.

===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 @{target|bar2}d6
/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 <code>target_name</code> is optional if you only have one 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|bar1|max}                                - token max values can only be referenced with "|max"
@{target|HP_max}                                  - max value of HP, from the linked character sheet
@{target|Target1|HP|max}                          - alternative method for the above
@{target|target 1|HP_max} @{target|target 2|HP_max} - check max HP of two tokens
@{target|target 1|HP|max} @{target|target 2|HP|max} - alternative method for the above
</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 [[Character#Abilities|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).

==Journal==
main page: [[Journal#Journal_Command_Buttons|Journal Command Buttons]]


===Character Attributes===
How to reference character/Character sheet Attributes: [[Journal#Attributes]]

Each character also have a few [[BCS/Pseudo-attributes|pseudo-attributes]] that always exists, even if there is no sheet or Attributes statted for them

From a custom command, anywhere:
<pre>
/r 1d20+@{Bob|str}
</pre>

If macro is saved to a character's [[Journal#Attributes_.26_Abilities_Tab|A&A]]-tab, to a [[Link Token|token linked]] to a sheet, or is embedded in the character sheet's button (code): 
<pre>
/me makes a Strength roll of [[1d20+@{str}]]
</pre>

====Repeating Section====
[[Macros#Referencing_Repeating_Attributes|Referencing Repeating Attributes]]

===Character Abilities/Roll Buttons===

'''Button'''
Most char sheets have roll buttons, which can be called directly with a <code>%</code>-command.

<pre style="overflow:auto;white-space:pre-wrap;">
%{Bob|dexterity} // call the dex roll for a character named bob
%{selected|dexterity} // call the dex roll for the character linked to the selected token
</pre>

'''[[Character#Abilities|Abilities]]'''

If you have saved custom Abilities to a character's [[A&A#Attributes_.26_Abilities_Tab|Attributes & Abilities]]-tab, you can call the ability with the same <code>%</code>-syntax as buttons. These are character-specific, so unless other characters have an ability with the same name, it wont work.

<pre style="overflow:auto;white-space:pre-wrap;">
%{Bob|customability}
%{selected|customability}
</pre>

When writing an ability macro, you dont have to specify the characters name, and can call attributes directly(<code>/r 1d20+@{dex}</code>)

===Handout===
You can add roll buttons with macros to [[Journal#Handouts|Handouts]], with the help of hyperlinks.

*  {{yt.be|pkDC-nP3vCE Running Commands from Handouts in Roll20}} 8min, Nick O.

* {{fpl|9283622/ handout link in macro}} - opens the handout in the [[Journal#External_Journal_Access|External Journal]]

==[[API]]==
{{pro only|section}}{{apiboxRec}}

'''[[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 embedded 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:'''
writing <code><nowiki>!wd [[4d6+2]]</nowiki></code> 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.

[[File:Wild-Dice-result-v3-4.png]]

'''Example 2:'''

writing <code>!group-init</code> in the chat will trigger the '''GroupInitiative'''(must be installed) API that uses <code>group-init</code> 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 <code><nowiki>&{template:default} {{name=Cthulhu}} !modattr --silent --charid @{target|character\_id} --sanity|-{{Sanity damage=[[2d10+2]]}} --corruption|{{Corruption=Corruption increases by [[1]]}}!!! {{description=Text}}</nowiki></code> 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 '''[[Script:ChatSetAttr|ChatSetAttr]]''' API, which can be used standalone with the <code>!modattr</code> 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:Chat#API_Command_Buttons|API Command Buttons]]===
{{main|API:Chat#API_Command_Buttons}}
{{notebox| '''You don't need Pro or API access to use API Command Buttons!''' They are heavily featured in [[Chat Menus]], which everyone can create.}}

They have simple Markdown formatting:

<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|Nesting]]:
 
<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 '''[[Chat Menus]]''' trick by [[Keith]], uses them at great length.

''Tricks:''
* {{forum|permalink/6009949/ 2 column API buttons in Default Roll Template}} - Bryan P
===Macros===
{{:Macros/API}}
===Relevant API===
APIs that have lots of commands or have lot to do with dice rolling.

* '''[[Script:ChatSetAttr|ChatSetAttr]]''' - can be used [[inline]] & mixed in with other macros, and can edit stats, which normal macros can't
* [[ScriptCards]] - 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
* [[APILogic]] -- Gives If/ElseIf/Else Processing, [[Inline]] Math operations, and Variable Muling to Other Scripts | {{forum|permalink/9771314/ APILogic}}
* {{fpl|9817678/ SelectManager}} - help other API with properly sharing token selection between other APIs. Often API that can call other APIs doesn't share what tokens are currently selected.
* {{forum|permalink/9770117/ libInline}} - provides an easy interface for inlinerolls
* {{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.
* [[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.
* {{forum|permalink/9441420/ CombatMaster}} 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). 
* {{forum|permalink/8458497/ Token Action Maker}}
* [[Script:Rollable_Table_Macros|Rollable Table Macros]] -- a simple script that gets an item from a [[Roll Table|rollable tables]] 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:It's a Trap|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)
* '''[[API:Script Index]]''' curated list of Roll20 APIs available

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

* [[Select Attributes for Sheet Roll]] - An advanced technique for creating a dynamic roll button on your sheet 

===[[Button#Roll_Button|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 {{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.

* [[Select Attributes for Sheet Roll]]

===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 '''[[Building_Character_Sheets/Roll_Templates|Creating Roll Templates]]''' for how to make your own.

[[Building_Character_Sheets/Roll_Templates#Helper_Functions|Helper Functions]] describes what functions you can build into your sheets.

==External Tools==
* '''[[VS_Code#Roll20_Syntax_Highlight|Roll20 Macros - a Visual Studio Code Extension]]''' by [[Andreas J.]]
** syntax highlight and autocomplete help for roll20 macro writing. Makes reading, writing, & identifying mistakes in macros easier with color-coding matching brackets and more. 
* [[Stylus]]
** Can be used for some advanced macro tricks, like [[Hidden Rolls]]
* [[Browser Developer Tools#Macros]] - can be used to figure out attribute & Repeating section names from character sheets

==Related Pages==
* '''[[Complete Guide to Macros & Rolls‎]]'''
** {{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 <span style="font-family:Pictos;">q</span>Text Chat works, like referencing stats on character sheets, roll queries, nesting macros & initiative
*** [[Reusing Rolls]]
*** [[Chat Menus]]
** [[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
* [[Forum Tricks]]
** [[Macro Sheet]]

==Other Guides==

==TODO==
* add image examples of every macros used, input + output
* at least one example for each mentioned concept
* Roll Template examples
* List rest of the examples from "Stupid Tricks" thread
* new sections
** Chat Tooltip
** [[Stylus|Stylus]], for tricks like the hidden rolls
* Split page:
** macro formatting
** HTML styling
* copy tips from [[Macros/Pathfinder Examples]]

=See Also=
* {{forum|permalink/5899495/ Roll20 Tips and Tricks (Innovative Solutions to Common Problems)}} - Well maintained List of good Roll20 Tricks.
* [https://cybersphere.me/roll20-dice/ Everything About Rolling Dice] - A comprehensive guide to rolling dice in Roll20.
* [[Macro Character Sheet]] - how to easily move all your macros between games
* {{Text Chat}}
* {{Collections}}
** [[Macros]]
** [[Roll Tables]]
** [[Cards]]
* [[Building Character Sheets]] - {{Pro}}
* [[API]] - {{Pro}}
* [[Campaign Management]]
** [[Link Token|Link Token to Sheet]]
** [[Add Character Sheet]]
** [[GM]] & [[Player]] tools & limits
* [[Browser#Stylus|Stylus Plugin]] - customize the looks of Roll20 for yourself
<br>
<br>
[[Category:Macros]]
[[Category:Character Sheet Creation]]
[[Category:Guides]]
[[Category:Featured articles]]