Files
dragonroll/README.md
2026-04-20 20:30:42 +02:00

52 lines
1.1 KiB
Markdown

<picture align="center">
<source media="(prefers-color-scheme: dark)" srcset="static/media/logo-splash.png">
<source media="(prefers-color-scheme: light)" srcset="static/media/logo-splash-light.png">
<img alt="Shows a black logo in light color mode and a white one in dark color mode." src="client/public/img/logo-splash.png">
</picture>
<hr>
<h3 align="center">
An open-source helper for role-playing games
</h3>
<p align="center">
<a href="https://git.aranroig.com/BinarySandia04/Dragonroll">Original web</a> |
<a href="">Documentation</a>
</p>
<br>
# Dragonroll
Dragonroll is an open source helper for role-playing games.
## Features
- Keep track of the campaing characters
- Share markdown notes with your players
- Play music during physical campaings
- Plan different encounters
- Manage different items and spells
- And so much more!
## Installation 🛠️
Run
```
./install.sh
```
This will install all the necesary npm packages both for the frontend and the backend
## Running 🚀
Run
```
./start.sh
```
or
```
./start-dev.sh
```
if you want to start the development environments