README file from
GithubRPG Detect Dice Roll
RPG Detect Dice Roll is an Obsidian plugin for tabletop role-playing notes. It detects dice formulas in reading view, turns them into clickable roll controls, and keeps recent results in a roll history panel.
Use it for session notes, solo RPG journals, encounter prep, oracle tables, random events, and any note where you want 1d20 + 4 or 2d6 to roll directly from the page.
Features
- Detects dice formulas in reading view and makes them clickable.
- Supports formulas such as
d20,1d20 + 4,2d6 - 1,4d6kh3,2d20kl1,4d6dl1, and4d6dh1. - Shows optional roll result notices with the total, formula, and roll details.
- Adds a roll history side panel with recent results and timestamps.
- Provides quick buttons for common dice:
d4,d6,d8,d10,d12,d20, andd100. - Supports advantage and disadvantage rolls.
- Lets you create custom formula dice buttons.
- Lets you create custom narrative dice that choose from text outcomes, with optional weighting.
- Includes display, color, toast placement, history, and control visibility settings.
- Works offline and stores settings locally in your vault.
Open RPG Detect Dice Roll Logs History
To open the log history and the default + custom dice roll, open the command palette and type: PG Detect Dice Roll: Open roll history
How to use
Write dice formulas naturally in your notes, then switch to reading view. Detected formulas are styled as interactive text or buttons, depending on your settings.
- Select a detected formula to roll it normally.
- Right-click a detected formula to roll normally, with advantage, or with disadvantage.
- Select the dice ribbon icon or run Open roll history from the command palette to open the roll history panel.
- Use the roll history panel to build manual formulas with quick dice buttons, operators, advantage controls, and custom dice.
- Press Roll or Enter in the manual input to roll the typed formula.
Formula support
The plugin supports standard dice terms with optional modifiers:
d20
1d20 + 4
2d6 - 1
4d6kh3
2d20kl1
4d6dl1
4d6dh1
Keep/drop suffixes mean:
kh: keep highestkl: keep lowestdh: drop highestdl: drop lowest
For example, 4d6kh3 rolls four six-sided dice and keeps the highest three.
Settings
Open Settings → Community plugins → RPG Detect Dice Roll to configure the plugin.
- Formula display: choose inline styling or button styling for detected formulas.
- History limit: choose how many recent rolls are kept in the roll history panel.
- Show roll notices: show or hide toast notices when rolls complete. Enabled by default.
- Toast placement: choose where roll notices appear when notices are enabled.
- Manual roll controls: show or hide advantage and operator controls.
- Dice buttons: choose which built-in dice buttons appear.
- Custom dice: add custom formula buttons or narrative dice.
- UI and color settings: customize formula and notice colors separately for light and dark themes.
Custom dice
Custom formula dice add reusable buttons to the roll history panel. A formula die can be a full formula such as 1d3, 2d6 + 1, or a keep/drop suffix such as kh1.
Custom narrative dice choose from text outcomes instead of numeric totals. Each outcome can have optional relative odds, such as 1, 3, 40%, or 1/5. If weights are blank or invalid, the plugin treats those outcomes as equal odds.
Privacy
RPG Detect Dice Roll runs locally in Obsidian. It does not make network requests, collect analytics, or send vault contents to external services.
Support
License
This project is licensed under the terms in LICENSE.