Wiki
Clone wiki5eShaped / Roll Template
Roll Template
The Shaped Character Sheet for 5e Roll Template is described by the following syntax
&{template:5e-shaped} {{field=value}} {{...}} ...
The table below describes the fields, their values, and their effect. The field and value must be set equal and enclosed in curly brackets as illustrated above. Certain fields require that other fields are present and have values. Below is a guide to what the types of values the fields can have.
Value | Meaning |------------|------------| empty|value not required in order to force field presence 1|typically used to force field presence but can actually be anything any|indicates typical value is text but value can be anything roll|value is typically an inline die roll but value can be anything set|The value can be anything, but works best if one is chosen from a specified set
The following code illustrates these values and shows the result
&{template:5e-shaped} {{title=Title}} {{show_character_name=1}} {{character_name=Character Name}} {{uses=5}} {{uses_max=10}} {{recharge=LONG_REST}}{{subheader=Subheader}} {{targetName=Target Name}} {{2d20kh1=1}} {{emote=This is the emote}} {{content=Content}} {{text_top=Text top}} {{roll1=[[1d20]]}} {{roll2=[[1d20]]}} {{targetAC=Target AC}} {{saving_throw_dc=13}} {{saving_throw_vs_ability=DEXTERITY}} {{saving_throw_success=Save success}} {{has_saving_throw_damage=1}} {{saving_throw_damage=[[1d8]]}} {{saving_throw_damage_type=Fire}} {{heal= [[20]]}} {{death_saving_throw_successes=2}} {{death_saving_throw_failures=1}} {{text_center=Text Center}} {{text=Text}} {{text_big=Text Big}} {{Custom1=Custom Template Section1}} {{freetext=Freetext}}
General Formatting Fields
Field | Value | Required Field | Effect
|-------------|--------------|--------------|-------------|
title|any||Value as template title
uses|any||Value as a subheader of the number of uses remaining out of uses_max. Displayed as “uses / uses_max”
uses_max|any|uses|The total number of uses possible for uses.
recharge|set||When the ability recharges, normal values (TURN, SHORT_OR_LONG_REST, LONG_REST, RECHARGE_2_6, RECHARGE_3_6, RECHARGE_4_6, RECHARGE_5_6, RECHARGE_6)
2d20kh1|1||Displays green circle in the top right of the roll template
2d20kl1|1||Displays red circle in the top right of the roll template
show_character_name|1||Toggle on character name in banner
character_name|any|show_character_name|Value as a subheader in the banner
subheader|any||Value as a subheader in the banner
emote|any||Framed value as an emote at the top of the template
text_top|any||Value as a row of text near the top in large font
roll1|roll||Main d20 roll for the template
roll2|roll|roll1|Second d20 roll for the template, used for roll2 style
death_saving_throw_successes|any||Displays value as “Successes VALUE / 3”. Use @{death_saving_throw_successes}
to access sheet value
death_saving_throw_failures|any||Displays value as “Failures VALUE / 3”. Use @{death_saving_throw_failures}
to access sheet value
content|any||Value as text in a row of the template.
text_center|any||Text that is centered in the roll template
text|any||Base left aligned text in the template
text_big|any||Bigger font size, left aligned text in the template
macros|any||A centered text in the template, great for adding ability buttons to outside of spells (spells currently uses this field for things like repeat)
CUSTOM_TITLE|any||Custom fields where the CUSTOM_TITLE and be anything and the value is shown next to it
freetext|any||Extra text towards the bottom of the template
hp_max|any||The max hp of the character displayed as (“/hp_max”)
hp|any|hp_max|The current hp of the character
temp_hp|any|hp_max|The temp hp displayed as “VALUE Temp HP”
hp_max_reduced|any|hp_max|The reduced max HP, displayed as “VALUE Reduced Max”
action|1||Indicates the output is an action
spell|1||Indicates the output is a spell
ability|1||Indicates the output is an ability
saving_throw|1||Indicates the output is a saving throw
ability|1||Indicates the output is an ability
trait|1||Indicates the output is a trait
ignore|any||Ignores the value of this field and is not output to the roll template
hide_ability_checks|1|ability|Hides the roll section of an ability check
hide_saving_throws|1|saving_throw|Hides the roll section of an saving throw
hide_attack|1||Hides the roll section in the template, displays with custom css
hide_damage|1|Any damage section|Hides the damage section in the template, displays with custom css
hide_saving_throw_dc|1|saving_throw_dc|Hides the saving throw DC section in the template, displays with custom css
hide_spell_content|1|content|Hides the content section in the template, displays with custom css
hide_freetext|1|freetext|Hides the freetext section in the template, displays with custom css
hide_saving_throw_failure|1|saving_throw_dc|Hides the saving throw failure section in the template, displays with custom css
hide_saving_throw_success|1|saving_throw_dc|Hides the saving throw success section in the template, displays with custom css
hide_recharge|1|recharge|Hides the recharge section in the template, displays with custom css
Spell Fields
Field | Value | Required Field | Effect |-------------|--------------|--------------|-------------| spell_level|any|spell|Value as spell level in italics as a subheader cast_as_level|any|spell|Value as the level the spell is cast as in the format “(as VALUE)” in italics as a subheader. Sheet uses a query for this school|any|spell|Value as the spell school in italics as a subheader ritual|1|spell|Display “(ritual)” next to spell school casting_time|any|spell|Value as the casting time of the spell range|any|spell|Value as the range of the spell components|any|spell|Value as the components of the spell materials|any|spell, materials|Value as the materials use in casting the spell, placed in parentheses duration|any|spell|Value as the duration of the spell higher_level|any|spell|Text that appears after content field for what the spell does at a higher level
For a spells attack and damage fields/heal fields, see the relevant sections below
Attack Fields
Field | Value | Required Field | Effect
|-------------|--------------|--------------|-------------|
attack1|roll||The first roll for the attack
attack2|roll|attack1|The second roll for the attack, using roll2 format
attack_type|set|attack1|The type of the attack. Values for best results: “MELEE_WEAPON_ATTACK”, “MELEE_OR_RANGE_WEAPON_ATTACK”, “RANGED_WEAPON_ATTACK”, “MELEE_SPELL_ATTACK”, “RANGED_SPELL_ATTACK”
targetName|any|attack1|The name of the target, to auto display, use @{target⎮token_name}
targetAC|any|attack1|The AC of the target, to auto display, use @{target⎮ac}
reach|any|attack1|The reach of the attack
range|any|attack1|The range of the attack
ammo|any|attack1|The ammo amount for the attack
ammo_name|any|attack1|The name of the ammo for the attack
has_attack_damage|1||Indicates the roll has attack damage, needed for the attack damage to show
attack_damage_macro|any||Displays the “Hit:” text at the top of the attack damage section of the template. Used for the ability command button when auto roll damage is off
attack_damage_crit_macro|any||Displays the “Crit:” text at the top of the attack damage section of the template in place of “Hit:” when the attack is a crit. Used for the ability command button when auto roll damage is off
attack_damage |roll||The damage of the attack
attack_damage_type |any|has_attack_damage, attack_damage |The type of the damage of the attack
attack_damage_crit |roll|has_attack_damage, attack_damage |The damage to roll on a crit
attack_second_damage |roll|has_attack_damage, attack_damage |The second damage of the attack
attack_second_damage_type |any|has_attack_damage, attack_damage , attack_second_damage |The type of the second damage
attack_second_damage_crit |roll|has_attack_damage, attack_damage , attack_second_damage| The crit damage for the secondary damage
crit_name|any|attack1|Extra field when the attack is a crit, this is the name of that field displayed in bold
crit_text|any|attack1|Extra field for when the attack is a crit, this is the text displayed
Saving Throw Fields
Field | Value | Required Field | Effect |-------------|--------------|--------------|-------------| saving_throw_dc |any||The DC of the saving throw saving_throw_vs_ability |set||The ability to save against. Use all caps as the value to get a button for it e.g. “DEXTERITY” saving_throw_success |any||What happens on a successful save has_saving_throw_damage|1||Indicates the template has damage for the saving throw, needed for the saving throw damage to show saving_throw_damage_macro|any|has_saving_throw_damage|Displays the “Save failure:” text at the top of the saving throw damage field. Also changed to an ability command button when auto roll damage is off saving_throw_damage |roll|has_saving_throw_damage|The damage a failed save could do saving_throw_damage_type |any|has_saving_throw_damage, saving_throw_damage |The type of damage of the save saving_throw_second_damage |roll|has_saving_throw_damage, saving_throw_damage |The second damage of the save saving_throw_second_damage_type |any|has_saving_throw_damage, saving_throw_damage, saving_throw_second_damage_type |The type of the second damage of the same targetName|any||The name of the target for the saving throw
Other Damage Fields
Field | Value | Required Field | Effect |-------------|--------------|--------------|-------------| other_damage |roll||The damage to roll for a damage field not tied to an attack or saving throw other_damage_type |any|other_damage |The type of the damage other_damage_crit |roll|other_damage |The damage to roll on a crit other_second_damage |roll|other_damage |The secondary damage other_second_damage_type |any|Other_damage, other_second_damage |The type of the secondary damage other_second_damage_crit |roll|Other_damage, other_second_damage |The crit damage of the secondary damage
Heal
Field | Value | Required Field | Effect |-------------|--------------|--------------|-------------| heal|roll||The amount rolled to heal a creature by
Updated