You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51-9Lines changed: 51 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,6 +65,27 @@ reactions:
65
65
```
66
66
````
67
67
68
+
### Using [Dice Roller](https://github.com/valentine195/obsidian-dice-roller)
69
+
70
+
You can integrate the dice roller plugin in your statblocks, which will allow you to roll dice inside stat blocks. This integration requires the following:
71
+
72
+
1. Install and enable the [Dice Roller](https://github.com/valentine195/obsidian-dice-roller) plugin.
73
+
2. Enable [Integrate Dice Roller](#integrate-dice-roller) in settings or add the `dice: true` parameter to a statblock in a note.
74
+
75
+
The plugin will then parse monster properties for common types of dice rolls. The plugin will create dice rollers for the following strings:
76
+
77
+
1. Rolling to hit (`+15 to hit`)
78
+
2. Damage / healing (`19 (2d10 + 8)`)
79
+
3. A save (`Strength +5`)
80
+
81
+
> Want to change how Dice Rollers are added? Create a [Custom Layout](#layouts) in settings.
82
+
83
+
#### Rendered Dice
84
+
85
+
Dice rollers added to stat blocks can roll 3D dice on the screen if the [Render Dice Rolls](#render-dice-rolls) setting is turned on or the `render: true` parameter is added to a stat block.
Traits, such as Actions, Reactions and Legendary Actions,
105
+
81
106
### Spellcasting
82
107
83
108
The spellcasting trait requires a special `spells` field using the following syntax:
@@ -204,10 +229,11 @@ All blocks (except [group](#group-blocks) and [inline](#inline-blocks)) will hav
204
229
| Conditional | If a block is set to conditional, it won't be rendered if the property does not exist. |
205
230
| Fallback | Fallback to display if property does not exist but the block is not conditioned. |
206
231
| Has Rule | A horizontal rule will be displayed after the property |
207
-
| Enable Dice\*| The plugin will attempt to parse for common dice roll strings from the block |
232
+
| Parse for Dice\*| The plugin will attempt to parse for common dice roll strings from the block |
233
+
| Link Dice to Property | The layout will use the property provided to generate the dice roller. |
208
234
| Dice Callback\*† | JavaScript code may be provided to determine how the string is parsed for dice. |
209
235
210
-
<sup>\* Requires the Dice Roller plugin.</sup><br/>
236
+
<sup>\* Requires the <ahref="https://github.com/valentine195/obsidian-dice-roller">Dice Roller</a> plugin.</sup><br/>
211
237
<sup>† Advanced option.</sup>
212
238
213
239
A specific block type may have additional property fields.
@@ -295,38 +321,54 @@ The traits block has an additional optional block property called "Section Headi
295
321
296
322
### Using Dice Rollers in Layouts
297
323
298
-
> Note: The [Dice Roller](https://github.com/valentine195/obsidian-dice-roller) plugin must be installed and the [Use Dice Roller](#use-dice-roller) Setting must be turned on to use dice rollers in layouts.
324
+
You can integrate the diceroller plugin in your statblocks, which will allow you to roll . This integration requires the following:
299
325
300
-
On any given block, if the Enable Dice property is turned on, the plugin will attempt to parse the property content for common dice roll strings. Currently, the plugin will parse for the following strings by default:
326
+
1. Install and enable the [Dice Roller](https://github.com/valentine195/obsidian-dice-roller) plugin.
327
+
2. Enable [Integrate Dice Roller](#integrate-dice-roller) in settings.
328
+
3. Toggle the [Parse for Dice](#block-properties) block property for the block you want to parse.
329
+
330
+
The plugin will then attempt to parse the property content for common dice roll strings. The plugin will parse the following strings by default:
301
331
302
332
1. Rolling to hit (`+15 to hit`)
303
333
2. Damage / healing (`19 (2d10 + 8)`)
304
-
3. A save (`Strength +5`) (note: the `saves` and `skillsaves` do not have dice enabled by default).
334
+
3. A save (`Strength +5`)
305
335
306
-
Alternatively, you may specify a property of a monster to use as the dice string in the `Link Dice to Property` block property. This should be a dice string, such as `5d10 + 50`.
336
+
Alternatively, you may specify a property of a monster to use as the dice string in the [Link Dice to Property](#block-properties) block property. This should be a dice string, such as `5d10 + 50`.
307
337
308
338
#### Dice Callback
309
339
310
-
If [Advanced Options](#show-advanced-options) is turned on, you also have the ability to provide a `Dice Callback` function to the block. This allows you to parse the property string for the *exact* dice roll you want.
340
+
If [Advanced Options](#show-advanced-options) is turned on, you also have the ability to provide a `Dice Callback` function to the block. This allows you to parse the property string for the _exact_ dice roll you want.
311
341
312
342
The callback function will receive the `plugin`, `monster` and `property` parameters.
313
343
314
344
# Settings
315
345
316
346
## Enable Export to PNG
317
347
318
-
## Use Dice Roller
348
+
The plugin will add an option to export rendered stat blocks as PNG files.
349
+
350
+
## Integrate Dice Roller
351
+
352
+
The plugin will integrate with the Dice Roller plugin and add dice rolls to rendered stat blocks.
319
353
320
354
## Render Dice Rolls
321
355
356
+
Dice rolls will roll with graphical dice by default.
357
+
322
358
## Layouts
323
359
324
-
### Default Layouts
360
+
### Default Layout
361
+
362
+
The plugin will use this layout by default when rendering a stat block.
325
363
326
364
### Show Advanced Options
327
365
366
+
Editing a layout block will show additional advanced options.
367
+
328
368
## Import Monsters
329
369
370
+
Homebrew monsters can be imported from various sources here.
0 commit comments