Skip to content

Commit 3bf6bc9

Browse files
committed
update the readme for the beta
1 parent 9aa7b53 commit 3bf6bc9

1 file changed

Lines changed: 51 additions & 9 deletions

File tree

README.md

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,27 @@ reactions:
6565
```
6666
````
6767

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.
86+
87+
<img src="https://raw.githubusercontent.com/valentine195/obsidian-5e-statblocks/master/images/render.GIF">
88+
6889
### Overriding Fields
6990

7091
The `monster` field may be combined with other fields to override the field of the specified SRD monster. For example:
@@ -78,6 +99,10 @@ name: Paarthunax
7899

79100
<img src="https://raw.githubusercontent.com/valentine195/obsidian-5e-statblocks/master/images/override.PNG">
80101

102+
### Traits
103+
104+
Traits, such as Actions, Reactions and Legendary Actions,
105+
81106
### Spellcasting
82107

83108
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
204229
| Conditional | If a block is set to conditional, it won't be rendered if the property does not exist. |
205230
| Fallback | Fallback to display if property does not exist but the block is not conditioned. |
206231
| 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. |
208234
| Dice Callback\*| JavaScript code may be provided to determine how the string is parsed for dice. |
209235

210-
<sup>\* Requires the Dice Roller plugin.</sup><br/>
236+
<sup>\* Requires the <a href="https://github.com/valentine195/obsidian-dice-roller">Dice Roller</a> plugin.</sup><br/>
211237
<sup>† Advanced option.</sup>
212238

213239
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
295321
296322
### Using Dice Rollers in Layouts
297323
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 dice roller plugin in your statblocks, which will allow you to roll . This integration requires the following:
299325
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:
301331
302332
1. Rolling to hit (`+15 to hit`)
303333
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`)
305335
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`.
307337
308338
#### Dice Callback
309339
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.
311341
312342
The callback function will receive the `plugin`, `monster` and `property` parameters.
313343
314344
# Settings
315345
316346
## Enable Export to PNG
317347
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.
319353
320354
## Render Dice Rolls
321355
356+
Dice rolls will roll with graphical dice by default.
357+
322358
## Layouts
323359
324-
### Default Layouts
360+
### Default Layout
361+
362+
The plugin will use this layout by default when rendering a stat block.
325363
326364
### Show Advanced Options
327365
366+
Editing a layout block will show additional advanced options.
367+
328368
## Import Monsters
329369
370+
Homebrew monsters can be imported from various sources here.
371+
330372
# Installation
331373
332374
## From within Obsidian

0 commit comments

Comments
 (0)