A web application designed to run locally on your machine to create a info display for your D&D players. It provides an admin view with display adjustment options and a quick reference using data from 5eTools.
First, install dependencies, followed by preparing the database:
npm install
npm run dbAfterwards you can test the environment using:
npm run devYou should now be able to access the following pages:
- Dungeon Master's Page or Admin Page http://localhost:3000/admin (The default password is
admin) - Display Page http://localhost:3000/
- Quick Compendium for Druid Beasts and Spells http://localhost:3000/compendium
- Print Pages for Spells (incomplete), Druid Beasts and Player Sidekick NPCs (from Falindrith's Monster Maker):
Per default there are two campaigns in the data directory. Each containing various files. The most interesting part is the meta.json file as it gives the application information about your current campaign. The diashow folder contains all images that will be displayed on the screen.
The calendar used to display day-time should be compatible with the Fantasy Calendar json. Sidekick NPCs follow the Schema from Falindrith's Monster Maker.
More information on how to style (might) follow.
This project is still in development and contains bugs. I already use it for my campaign Dracaiya and will therefore continue to improve it. I usually run the App on my MacBook Air (M1) and use it with Safari or Chrome.
The App contains partial Type Annotations for the 5eTools database, these are mostly written by hand and therefore might be faulty or incomplete. Same holds for the Fantasy Calendar type annotations.
If you want to contribute, feel free to open a pull request.
Almost all images from the demo campaigns are AI-generated. Except for the character images itself. These images I drew myself.