From 694ed44ba974fe73237b280074381c764aab0aec Mon Sep 17 00:00:00 2001 From: valentine195 <38669521+valentine195@users.noreply.github.com> Date: Wed, 12 Jan 2022 12:14:33 -0500 Subject: [PATCH] update readme --- README.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d3f3571f..de30b346 100644 --- a/README.md +++ b/README.md @@ -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 + +``` +```` + + + ### Parameters There are 3 parameters for each encounter, with more detail below. @@ -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.