Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
valentine195 committed Jan 12, 2022
1 parent 4cd7404 commit 694ed44
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,39 @@ This will render like this in Preview:

Clicking on the button next to the encounter name will then launch the encounter in the Initiative Tracker.

### Launching Encounters

An encounter can be launched by clicking the "Begin Encounter" button. This will launch a **new encounter** as defined.

Alternatively, the "Add to Encounter" button can be used to add the specified creatures to an existing encounter.

### Encounter Tables

Alternatively to the encounter blocks shown above, you can create encounter tables using the `encounter-table` code block.

Each encounter defined using the [Multiple Encounters](#multiple-encounters) syntax will be added to the table as a row. Encounter tables supports the full list of parameters shown in [Parameters](#parameters) below.

For example:

````
```encounter-table
name: Example 1
creatures:
- Hobgoblin
- 3: Goblin
---
name: Example 2
creatures:
- 3: Hobgoblin
- Goblin
```
````

<img src="https://raw.githubusercontent.com/valentine195/obsidian-initiative-tracker/master/assets/encounter-table.PNG">

### Parameters

There are 3 parameters for each encounter, with more detail below.
Expand Down Expand Up @@ -139,8 +172,6 @@ creatures:
```
````

### Parameters

## Using the Initiative Tracker

Monsters may be added to the combat by clicking the `Add Creature` button, which will open a form where the creature's name, HP, AC and initiative can be set.
Expand Down

0 comments on commit 694ed44

Please sign in to comment.