All checks were successful
Build and Deploy Nuxt / build (push) Successful in 1m6s
69 lines
1.2 KiB
Markdown
69 lines
1.2 KiB
Markdown
<picture align="center">
|
|
<source media="(prefers-color-scheme: dark)" srcset="static/media/logo-splash.png">
|
|
<img alt="Shows a black logo in light color mode and a white one in dark color mode." src="static/media/logo-splash-light.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 connector 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
|
|
|
|
|
|
## TODO
|
|
|
|
- Dragonroll <-> Foundry integration
|
|
- Dragonroll <-> Discord Bot integration
|
|
- Dragonroll <-> Obsidian integration
|
|
|
|
What to sync:
|
|
|
|
- Actors
|
|
- Monsters
|
|
- Items
|
|
- Notes
|
|
- Maps
|
|
- Music ?
|
|
|