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,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