Rollwright

Roll dice right in your notes. Write `dice: 1d20 + 5`, read the result, click to roll again. A natural 20 lands in gold.

Made by Thijs at Dortus for game masters and solo players who keep their sessions in Obsidian. It uses the dice: notation known from the Dice Roller plugin. All rolling is free. Optional skins are a one-time purchase.

_{Real plugin footage from version 0.3.3. The parchment note in this video was a custom CSS snippet on the free Classic skin. Since 0.3.4 the optional Parchment and Arcane skins style the whole note themselves, see Paid skins.}

What you can do

• Roll dice in a sentence. `dice: 1d20 + 4` becomes a result you can click to roll again. Supports keep highest, exploding, rerolls, success counting, Fudge and narrative dice.
• Roll on your own notes. Pick a random row from a table, an item from a list, a block from a note, a line, or a note with a tag.
• Lookup tables. Put a formula in the first header and Rollwright picks the matching row. Cells can hold rolls too.
• Keep or write a result. dice+: keeps a result after a restart, dice-mod: writes it into the note after you confirm.
• Roll log. A side panel shows what you rolled, grouped by note and session, and lets you roll again.
• Works where you write. Reading view and Live Preview look the same, in light and dark themes.

Quick start

1. Install Rollwright from Community plugins and turn it on.
2. In any note, type `dice: 2d6 + 3` (with the backticks).
3. Switch to reading view or move the cursor away. Click the result to roll again.

For a table, give it a block id such as ^loot and write `dice: [[Treasure^loot]]`.

Full reference

Everything below is detail for when you need it. Rollwright is at version 0.3.4. Before each release, automated tests run it in the real Obsidian app, in reading view and Live Preview.

Rolling dice

Write `dice: 2d6 + 3` in a note. It works in reading view and Live Preview. Hover to see the formula and the dice. Click to roll again. A result stays while you scroll or type elsewhere in the note. It is rolled again when you click, after a restart, and when lines above it are added or removed, because a result is tied to its line. A roll in a table cell can also roll again when the note is drawn again.

Keep a result

To keep a result after a restart, write `dice+: 2d6`. Rollwright saves it in its own plugin data, for that note and that place in it. A click rolls again and keeps the new result. Up to 500 kept results are saved; beyond that the oldest is dropped. `dice-: 2d6` never keeps a result and works like dice:. When Rollwright cannot tell which line a code is on, as can happen in a table cell of the note itself, dice+: works like dice: and keeps nothing. Inside a cell of a table you roll on, or as a lookup table header, dice+: and dice-: roll like dice:: the result is kept, or not, as part of the outer roll. Inside such a cell or header, dice-mod: is not rolled and stays as text.

Write a result into the note

To write a roll into the note for good, use `dice-mod: 3d100 + 12`. It shows a roll like dice:. A click, or Enter, does not roll again: it asks first and shows the text that goes in. Replace turns the code, backticks included, into the result you see, as in 3d100 + 12 -> [75, 20, 75] + 12 -> 182. A setting leaves out the formula: [75, 20, 75] + 12 -> 182. The total follows the number flags; labels such as |text(x) are not written. A roll on a table, list, note or tag writes only its result, on one line, and that other note is never changed. Characters that would change the line get a backslash, such as a backtick, a | in a table row, or a # or - at the start of a line. Rollwright only writes into the note that holds the code. It refuses inside an embedded note and when it cannot tell which line the code is on, as can happen in a table cell; then it says so and changes nothing. In Live Preview, undo takes the change back. In reading view the file is changed directly, and undo may not take that back, so check the window before you choose Replace.

Clicks with Ctrl or Alt

Ctrl-click (Cmd-click on a Mac) on a result from a table, list, section, line or tag opens the note it came from, in a new tab, without rolling. A tag roll over several notes has no single note to open, so it only says so. On a dice roll, Ctrl-click rolls again like a plain click. Alt-click (Option-click on a Mac) on a dice roll shows its average, as |avg does; it is not added to the roll log. Ctrl-click on a code with |none hides its result again and forgets it, also for dice+:. On dice-mod:, Ctrl-click opens the source of a table or section result; any other click opens the replace window. Phones have no Ctrl or Alt key, so there only a plain tap works.

Dice notation

Modifiers

Modifiers run from left to right. A number is optional and defaults to 1.

! explodes on the highest face and r rerolls the lowest, unless you add conditions: 1d4!=3, 1d4!i=!3, 1d4r<3, 1d4r<2>3. Conditions right after ! or r belong to that modifier.

Counting successes

A condition on dice turns each die into a score: 1 if it matches, otherwise 0. The result is the sum.

=, =! (not equal), >, <, >=, <=, and -= or =- to score -1. Example: 5d10>=8-=1. The first matching condition counts. The threshold can be dice too: 3d6>1d6.

Flags

Add flags after |, as in 1d20 + 2|nodice|text(Dexterity +2).

The number flags only change dice results, not picks from tables, lists or notes, and only what is shown: the tooltip still shows the exact roll. When two of them clash, the last one counts, so |round|noround does not round. A table column with the same name as a flag, such as Round, still wins.

Rolling on your notes

The forms [[Note#^id]] and [text](Note#^id) also work. For a table in the same note, write [[#^id]]; that keeps working when you rename the note.

A roll inside a block or section you draw is not rolled again: it shows as plain text, like 1d6. An embedded note in such a result becomes a link. Embedded images stay.

Lookup tables

If the first header is a formula, Rollwright rolls it and finds the matching row. Rows can be written as 1-2, 11, 13,14 or 51–60. A cell may hold another roll, such as `dice: 2d6` or dice: [[Note^id]].

| dice: 1d20 | Weather |
|---|---|
| 1-5 | Rain |
| 6,7 | Fog |
| 8–20 | `dice: [[Skies^clear]]` |
^weather

Side panel, commands and settings

• Roll log shows rolls you clicked or typed, grouped under the note and the time the session began, and lets you roll again. Rolls that happen by themselves when a note opens are not listed. The log is stored in the plugin's data file.
• Commands: "Open roll log" and "Roll a formula".
• Settings: default die, default number of dice, whether dice-mod: keeps the formula, and saved formulas. A saved formula works by name in any roll, such as `dice: attack` or 1d6 + bonus. A number in the frontmatter of the note works the same way: with str: 3 in the note, `dice: 1d20 + str` adds 3. A saved formula with the same name goes first. Only the note's own frontmatter counts, also for a code inside a table or section drawn from another note; inline fields such as str:: 3 and text that is not a number do not. Names that read as dice notation, such as d, dh, k, s or F, stay notation.
• Import: a button copies named formulas from the data file of the Dice Roller plugin, if you have it. That file is only read. Existing names are kept. The layout of that file was not verified, so an import may find nothing.

Paid skins

All rolling features are free. Two visual skins, Parchment and Arcane, are paid and need a license key. The Classic skin is free.

A paid skin changes more than the dice. Parchment turns a note with rolls into old parchment, Arcane into a torch-lit dungeon, and the Roll log follows. The rest of Obsidian keeps your theme. The setting "Skin the note too" picks which notes: Notes with rolls (default), All notes or Off. Per note, add rollwright-world or rollwright-plain to the cssclasses property.

You buy the skins once through Polar: press Buy for $6 in the settings, pay, then paste the license key from your Polar purchases in the settings and press Activate. One key works on all your devices.

Payments and network

The paid skins are sold through Polar. You need no account with Rollwright. The plugin only goes online to check your license key, at api.polar.sh: when you press Activate, and after that quietly at most once every 30 days. It sends your key, our organization id and our benefit id, nothing else. Polar sees your IP address. The plugin keeps only the key and the date of the last check; the name and e-mail that Polar sends back are not stored and not logged. If Polar cannot be reached, a key that is already active stays active. Read Polar's privacy policy.

Privacy

Rollwright has no telemetry and needs no account. Its only network connection is the license check described above, and only once you use a license key. It reads your notes to roll on them. Your notes are only changed when you confirm a dice-mod: code, and then only that code in that note. Outside the vault it touches nothing.

Limits

Up to 1000 dice per group, 10000 dice per formula, 1000000 sides, and 100 repeats per die for ! and r. One roll, nesting included, can use up to 10000 picks from notes. Beyond that you get a message. A broken formula is underlined and the tooltip gives the reason.

Support

Questions, ideas or a bug? Open an issue on GitHub or write to [email protected].

Development

npm install, then npm test, npm run build and npm run lint.

License

MIT, see LICENSE. The fonts in the paid skins (Cinzel, Cinzel Decorative, IM FELL English, Spectral, Uncial Antiqua) are under the SIL Open Font License 1.1, see OFL.txt.