Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
valentine195 committed Jun 30, 2021
1 parent 3017d7e commit 4542456
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,26 @@ The creatures HP and status effects can be reset by clicking `Reset HP and Statu

A new encounter (just player characters) can be started by clicking `New Encounter`.

### Commands

The plugin registers several commands to Obsidian that can be assigned to hotkeys or used with the Command Palette (<kbd>Ctrl</kbd> / <kbd>Cmd</kbd> + <kbd>P</kbd>).

#### Open Initiative Tracker

If the initiative tracker view has been closed for any reason, use this command to add it back to the right pane.

#### Toggle Encounter

This command can be used to start or stop an encounter.

#### Next Combatant

If the encounter is active, this command can be used to make the next enabled combatant active (similar to clicking the `Next` button).

#### Previous Combatant

If the encounter is active, this command can be used to make the previous enabled combatant active (similar to clicking the `Previous` button).

## Players

Players may be added in settings. Players created in this way will be automatically added to encounters.
Expand All @@ -48,8 +68,18 @@ In the future, this will be used to display more information about the player du

## Homebrew Content

Homebrew monsters may be created and managed in settings. Homebrew monsters will be available in the monster picker when adding a creature to the combat.

### 5e Statblocks Plugin

If the [5e Statblocks](https://github.com/valentine195/obsidian-5e-statblocks) plugin is installed, the homebrew creatures saved to that plugin can be used in this plugin by enabling the sync in settings.

### Import Homebrew

**Only import content that you own.**

Homebrew monsters can be imported from DnDAppFile XML files or Improved Initiative JSON files in settings.

# Roadmap

This is a list of features that are planned for the plugin. Some of these may or may not be developed.
Expand Down

0 comments on commit 4542456

Please sign in to comment.