Journal and Custom Statblocks - cyruzzo/AboveVTT GitHub Wiki
For the following formatting much of it is done to automatically detect official formatting of stat blocks. Punctuation and space is often important for auto detection.
If auto formatting is not wanted for a section you can find an ignore AboveVTT auto formatting highlight/container in the formats->container menu.
HP, AC and Initiative will be auto detected in the following formats the first time they are detected in a stat block. Note: if no average hp is included it will set to 0 unless the token is set to roll or use Max hp and vice versa for if no roll is set.
These can also be manually set in formats -> abovevtt statblock stats if the auto detection fails to pick them up.
HP 60 (10d10+5) HP 60 HP (10d10+5)
Hit Points 60 (10d10+5) Hit Points 60 Hit Points (10d10+5)
AC 15
Armor Class 15
Initiative +4
Attack and ability titles will be detected as the first 1 to 7 words followed by a period. These will automatically be bolded and italicized.
Force Blast.
Abilities that have a recharge ability will detect the recharge in the following format. Recharge buttons currently only roll d6's, any number can replace the 5.
Breath Weapon (Recharge 5-6).
Breath Weapon (Recharge 6).
The follow will have auto formats applied
| Type | Phrases/Words |
|---|---|
| Italics when following an attack title |
Melee Weapon Attack:, Melee Spell Attack:, Melee Attack Roll:, Ranged Weapon Attack:, Ranged Spell Attack:, Ranged Attack Roll:, Melee or Ranged Weapon Attack:, Melee or Ranged Spell Attack:, Melee or Ranged Attack Roll:
|
| Always Italicized |
Hit:, Hit or Miss:, Trigger:, Response:, Failure:, Success:, Success or Failure:, Failure or Success:
|
These words are bolded when they are at the start of a paragraph/line. Some may require a number after them such as Speed 30ft as they are intended for the top of stat blocks |
Senses,Gear,Skills,Damage Resistances,Damage Immunites,Damage Vulnerabilities,Condition Immunities,Languages,Proficiency Bonus,Saving Throws,Speed,Hit Points,HP,AC,Armor Class,Challenge,CR
|
Simple rolls that follow the following formats will be auto converted to roll buttons. If these rolls are in the same paragraph as an ability title they will roll with that title as the roll name. Damage type will be picked up if damage type follows a damage roll.
| Type | Roll Format |
|---|---|
| Rolls with d20 context menu |
+5, -5, d20
|
| Roll with damage context menu |
1d6+10, 1d6+10 fire damage, (1d6+4), (1d6+4) fire damage, 1d20-10, 1d6
|
| Rolls with send to context menu only |
d4, d6, d8, d10, d12, d100
|
For more complex rolls see the shortcuts section at the bottom of this page.
The following formats will be detected for Aoe roll buttons. If the words [damage type] damage eg. lightning damage come later in the same paragraph the damage type will be used for the AoE style.
[shape] in the below can be replaced by cone, sphere, cube, cylinder, or line
# is any number
#-foot [shape]
#-foot-long, #-foot-wide [shape] - only line will respect the width here
#-foot-radius, #-foot-high [shape]
#-foot-radius [shape]
The following will always be detected.
Words or text in [] seperated by | are interchangeable [] is not detected just used to show groupings below.
# is any number
[the|a|an] [1 to 4 words (spell name)] spell[.|:|,]
If the text Spellcasting. is detected in the stat block spells after this will be auto tooltiped and tracked in the following formats. Note: auto tooltips currently point to 2014 spells as www.dndbeyond.com/fireball without an id points to 2014. For 2024 tooltips see how to add them manually below.
Spell names following - spells should be separated by ,
Cantrips (at will):
At Will:
#/Day:
#/Day Each:
# level (# slots):
Some words will be have tooltips auto applied. They list as follows:
| Type | Phrases/Words |
|---|---|
| Basic Actions | attack action, magic action, dash, disengage, dodge, help, hide, ready, search, utilize, opportunity attack, grapple, shove, improvise, two-weapon fighting, interact with an object, study, influence, opportunity attack(s) |
| Senses | truesight, blindsight, darkvision, tremorsense |
| Skills | athletics, acrobatics, sleight of hand, stealth, arcana, history, investigation, nature, religion, animal handling, insight, medicine, perception, survival, deception, intimidation, performance, persuasion |
| Conditions | blinded, charmed, deafened, exhaustion, frightened, grappled, incapacitated, invisible, paralyzed, petrified, poisoned, prone, restrained, stunned, unconscious |
| Rules | hit dice, temporary hit points, inspiration, half cover, three-quarters cover, total cover, difficult terrain, falling, suffocating, lightly obscured, heavily obscured, climbing swimming crawling, surprise, flying, underwater, concentration |
You can prevent auto tooltips or other abovevtt formatting by highlighting text then select formats->containers->ignore abovevtt auto formating.
You can add tooltips for various DDB items from the link tool. Enter the URL, text to display and select DDB Tooltip link in the class dropdown
Source book section links can also be tooltipped by clicking the link button found when hovering a section header in a book then copying the url in the url bar.
After creating a note you can right click it and select copy note link. This will copy a shortcut you can paste into other notes or statblocks to create a tooltip/link for that note.
There are also several shortcuts that can be used in notes, statblocks and chat. Several of these may require an item/page id, for example from a monster URL https://www.dndbeyond.com/monsters/4775801-ape the id would be the final part 4775801-ape. Text after a ; is generally the display text.
| Type | Example |
|---|---|
| Monster | [monster]monster id;display text[/monster] eg. [monster]4775801-ape;Ape[/monster] will display Ape and link/tooltip to the ape statblock above |
| Spell | [spell]spell id;display text[/spell] |
| Magic Item | [magicItem]magic item id;display text[/magicItem] |
| Source Section | [source]section link;display text[/source] eg. [source] https://www.dndbeyond.com/sources/dnd/free-rules/equipment#LifestyleExpenses;Lifestyle Expenses[/source] - you can find these links by hovering and clicking any link icon beside a header in a DDB source then copying from the url bar. |
| Language | [language=language name]Text to write in the selected language[/language] eg. [language=draconic]This will be only readable to those with the draconic language or the DM[/language] |
| Weapon Property | [wprop]weapon property[/wprop] eg.[wprop]Sap[/wprop] or [wprop]Light[/wprop] |
| Equipment | [item]equipment id;display text[/item] eg. [item]406-ball-bearings;Ball Bearings[/item] |
| Roll | Most simple rolls are auto detected but this can be used for adding complex roll buttons using chat roll commands eg. [roll]/r 2d20kh1+1d6+4[/roll] |
| Tracker | create a tracker for spells, abilities or other purposes. eg. [track]Rage 2[/track] will create a tracker beside the word rage with default value of 2 |
| Note | This will be created from the above when copying a note link but can also be used with notes that have unique names eg. [note]treasure[/note] would target either a note named treasure or treasure list, [note]treasure list[/note] would only target the latter |
| Note Embed | When used will embed another notes text directly into a note. This will be created from the above when copying note embed tags but can also be used with notes that have unique names eg. [note embed]treasure[/note] would target either a note named treasure or treasure list, [note embed]treasure list[/note] would only target the latter |
| Note Pins | This add DM moveable pins that will have hover text. Ids are used to save pin locations so need to be unique eg.[pin id=1] Text Visible on Hover[/pin]Adding a label tag will include the label below the note eg.[pin label=display text here id=2]Text Visible on hover[/pin]Can also have other existing notes links be used as the hover text eg. [pin id=3 label=Yawning Portal] [note]Yawning Portal[/note][/pin] |