Fix issue #79: Implement documentation
All checks were successful
Test / test (push) Successful in 2s
All checks were successful
Test / test (push) Successful in 2s
This commit is contained in:
@@ -0,0 +1,45 @@
|
||||
# What is Dragonroll?
|
||||
|
||||
Dragonroll is a free and open-source helper for tabletop RPG campaigns. It keeps the things a group
|
||||
carries around a table in one place — the campaign's notes, its characters, its items, its maps — and
|
||||
lets the tools you already play with read and change them: Discord, Foundry VTT and Obsidian.
|
||||
|
||||
It is not a full virtual tabletop. There is no game loop, no combat tracker and no rule engine:
|
||||
Dragonroll is the shared memory of a campaign, and the place its characters and items are written
|
||||
down.
|
||||
|
||||
## What you get
|
||||
|
||||
- **Campaigns.** Every note, character, item and map belongs to one campaign, and each campaign has
|
||||
its own colour, description and integrations. [Start one](/docs/your-first-campaign).
|
||||
- **Notes in markdown.** The campaign's text lives in markdown notes, filed into folders that nest as
|
||||
deep as you need. Notes can hold a [dice widget](/docs/notes-and-markdown) that rolls when you
|
||||
look at it.
|
||||
- **Characters and items.** Actors (characters, NPCs and creatures) have a sheet with ability scores,
|
||||
combat stats, proficiencies, traits, spells and an inventory. Items have a category, a rarity and an
|
||||
icon. See [characters and items](/docs/characters-and-items).
|
||||
- **Maps.** Upload a map image with a grid, then pin notes onto the places they belong and stand your
|
||||
characters on the grid as [tokens](/docs/maps).
|
||||
- **Integrations.** Consult the campaign from [Discord](/docs/discord), keep a Foundry VTT world and
|
||||
a campaign [in step](/docs/foundry), and write campaign notes in [Obsidian](/docs/obsidian).
|
||||
|
||||
## How it is put together
|
||||
|
||||
Three pieces work together, and you only ever see the first of them:
|
||||
|
||||
| Piece | What it does |
|
||||
| --- | --- |
|
||||
| The web app | What you open: campaigns, notes, characters, items, maps, and the documentation you are reading |
|
||||
| The API | Stores everything the app shows and answers the integrations' requests |
|
||||
| The integrations | The Discord bot, the Foundry VTT module and the Obsidian plugin |
|
||||
|
||||
You sign in to the app with one account, and everything you create belongs to you. Integrations never
|
||||
hold a Dragonroll login: they ask you to authorize them for one campaign, which
|
||||
[you can take back](/docs/connecting-a-service) at any time.
|
||||
|
||||
## Where to go next
|
||||
|
||||
- New here? [Create your first campaign](/docs/your-first-campaign).
|
||||
- Writing the campaign down? [Notes and markdown](/docs/notes-and-markdown).
|
||||
- Playing on a screen? [Maps, pins and tokens](/docs/maps).
|
||||
- Connecting the tools you use? [Connecting a service](/docs/connecting-a-service).
|
||||
Reference in New Issue
Block a user