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).
|
||||
@@ -0,0 +1,67 @@
|
||||
# Your first campaign
|
||||
|
||||
## Signing in
|
||||
|
||||
The very first time you open a Dragonroll server there is no account yet, so the app asks you to
|
||||
create one: that first account becomes the server's **administrator**, which is the account that can
|
||||
later create or remove the other accounts. Everyone else is invited to register by whoever runs the
|
||||
server.
|
||||
|
||||
Sign in with your username or your email and your password. Sessions last 48 hours, after which the
|
||||
app asks you again. Under your name in the main menu you can change your profile — your name, your
|
||||
email and the avatar that shows up beside your characters.
|
||||
|
||||
## The main menu
|
||||
|
||||
The main menu is where you pick up where you left off:
|
||||
|
||||
- your campaigns, ready to open,
|
||||
- **Create campaign** to add one,
|
||||
- **Settings**, with your own appearance and language, and an *Administration* tab for
|
||||
administrators to manage the other accounts,
|
||||
- **Log out**.
|
||||
|
||||
## Creating a campaign
|
||||
|
||||
**Create campaign** asks for three things: a name, a short description and an accent colour. The
|
||||
colour follows the campaign wherever it shows up, so a group that runs two campaigns can tell them
|
||||
apart at a glance. Nothing else about a campaign is fixed: you can change the name, description and
|
||||
colour later in its settings.
|
||||
|
||||
## The campaign workspace
|
||||
|
||||
Opening a campaign replaces the menu with its workspace.
|
||||
|
||||
| Part | What it holds |
|
||||
| --- | --- |
|
||||
| Top bar | The campaign's name, the search, **Settings** and **Exit** |
|
||||
| Sidebar | The campaign's contents, in four sections: **Notes**, **Actors & Characters**, **Items** and **Maps** |
|
||||
| Note column | The notes you have open, side by side, or the map you have anchored |
|
||||
| Status bar | What the app is doing: saving, syncing, and errors when something fails |
|
||||
|
||||
The sidebar is the heart of it. Each of its sections lists the entries of that kind, and each entry
|
||||
can stand in a folder: folders nest, so a campaign can be organised however the group thinks of it.
|
||||
The sidebar itself collapses to give the notes room when you are showing a screen at the table.
|
||||
|
||||
## Finding things
|
||||
|
||||
The search in the top bar looks through the notes, characters, items and maps of the campaign you are
|
||||
in, and opens whatever you pick from the results. **Cmd+K** (or **Ctrl+K**) puts the cursor in it.
|
||||
|
||||
## Campaign settings
|
||||
|
||||
**Settings** in the top bar has two tabs:
|
||||
|
||||
- **Basic** — the campaign's name and colour.
|
||||
- **Integrations** — which external services are connected to this campaign and how to
|
||||
[connect one](/docs/connecting-a-service), plus the address of the Foundry VTT instance when the
|
||||
campaign reads icons from a linked world.
|
||||
|
||||
**Exit** leaves the campaign and returns to the main menu. Nothing is lost: the notes you had open and
|
||||
the campaign you were in are remembered for the next time you open the app.
|
||||
|
||||
## Next
|
||||
|
||||
- Write the campaign down in [notes and markdown](/docs/notes-and-markdown).
|
||||
- Write its characters and items on [sheets](/docs/characters-and-items).
|
||||
- Put it on a [map](/docs/maps).
|
||||
Reference in New Issue
Block a user