Paul-Ladyman / dnd-battle-tracker

D&D Battle Tracker is a combat management tool for Dungeons & Dragons 5th Edition.
https://dndbattletracker.com/
MIT License
21 stars 8 forks source link

D&D Battle Tracker

D&D Battle Tracker is an initiative and combat tracker tool for Dungeons & Dragons 5th Edition (D&D 5e). Track the initiative and status of all creatures involved in combat with this D&D combat tracker!

ko-fi

Feature ideas and general feedback welcome on Ko-fi. Bugs can be reported through Github issues.

Use

The D&D Battle Tracker is a web application designed to run in a browser but does not require an internet connection.

First, access the live D&D Battle Tracker. The application will then be saved in your browser for offline use. If your mobile or desktop browser supports it you can install the Battle Tracker as a Progressive Web App on your device so you can easily access it whenever you need to.

You can also download a specific release of D&D Battle Tracker below and open it in your favourite browser. This will be necessary if you have downloaded an in-progress battle that is no longer compatible with the live application:

For a particular release download the file dnd-battle-tracker.zip under Assets, unzip it and open the file index.html in a browser. For older releases you can download and open the dnd-battle-tracker.html file directly.

Motivation

As a new DM I found that I was frequently making mistakes during combat, such as:

It was clear that some automation would be helpful. There's a number of browser-based combat trackers out there at the time of writing, in no particular order:

Many of these systems are very feature rich and aim to provide tools beyond the combat tracker itself, which is great. However that does mean that they come with a learning curve and several are gated-off behind login screens.

This D&D Battle Tracker simply aims to automate the process of tracking combat using a pen and paper. It attempts to do this in a way that is as straight-forward and easy to use as possible. As such it does not do things like provide custom character creation tools, battle map creation tools or provide content from the Player's Hand Book. Instead it focuses on automating the smaller things that are prone to error and often distract a DM from the combat itself.

Features

License and Credits

Icons

Fonts

Development

Checkout and install

 $ git clone git@github.com:Paul-Ladyman/dnd-battle-tracker.git
 $ cd dnd-battle-tracker
 $ npm install

To run

 $ npm start

To test

Unit and integration tests:

 $ npm test

End to end tests:

 $ npx playwright install --with-deps
 $ npm run test:e2e

Architecture

D&D Battle Tracker architecture

Deployment Pipeline

Dependabot