-
Notifications
You must be signed in to change notification settings - Fork 3
Easy Reference
Easy Reference adds an SDX dropdown to Foundry's ProseMirror editor so journals, descriptions, and other rich-text fields can insert live game references without memorizing enricher syntax.
Five world settings are on by default:
- NPC cards;
- item cards;
- RollTables;
- checks/requests;
- dice rolls.
Disable a category to remove it from the editor menu for everyone.
Choose an NPC document, then insert:
@DisplayNpcCard[Actor.uuid]{Name}
The detailed variant is:
@DisplayNpcCardDetailed[Actor.uuid]{Name}
The compact card is best for inline encounters and rumors; the detailed card is better for a full keyed-area stat reference.
Insert an interactive item reference:
@DisplayItemCard[Item.uuid]{Name}
The stored UUID can point to a world item, owned item, or compendium item. If the source is deleted or moved, the reference no longer resolves.
Insert:
@DisplayTable[RollTable.uuid]{Name}
The rendered card can roll the referenced table subject to the user's permissions.
The custom dialog asks for:
- DC;
- ability;
- check or request.
It inserts Shadowdark's enriched syntax:
[[check 12 str]]
[[request 15 wis]]
Quick entries are available for STR, DEX, CON, INT, WIS, and CHA.
Enter a custom Roll formula:
[[/r 2d6+3]]
Quick buttons cover d4, d6, d8, d10, d12, and d20.
- References remain stable when a document is renamed.
- Moving a world document between folders is safe.
- Deleting/recreating a document changes its UUID.
- Copying a document creates a new UUID; existing journal syntax still points at the original.
- A module-compendium UUID remains stable only while that source document continues to ship under the same pack/document id.
Journal blockquotes receive a narration control when Enable Journal Narration is on. Use blockquotes for read-aloud text, then trigger the narration presentation from the rendered Journal page.
Menu is missing. Confirm you are editing with ProseMirror and the desired Easy Reference category is enabled.
Card displays a missing document. The saved UUID no longer resolves. Insert the current source document again.
Player cannot roll the table. Give the player observer permission to the RollTable/pack or have the GM roll it.
Check does not enrich. Use a valid Shadowdark ability key in lowercase and a numeric DC.
Related: Journal Tools & Pins · Compendium Packs