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,51 @@
|
||||
# Connecting a service
|
||||
|
||||
Dragonroll talks to three services: [Discord](/docs/discord), [Foundry VTT](/docs/foundry) and
|
||||
[Obsidian](/docs/obsidian). They all connect the same way, and none of them is given your Dragonroll
|
||||
password.
|
||||
|
||||
## How a connection works
|
||||
|
||||
A service asks Dragonroll for a **sign-up link** and shows it to you. You open that link in your
|
||||
browser, sign in if you are not signed in already, and pick which of your campaigns the service may
|
||||
use. Only then does the service get its own credential, which lets it read and change that one
|
||||
campaign and nothing else.
|
||||
|
||||
| You see | What it means |
|
||||
| --- | --- |
|
||||
| A link in Discord, in the Foundry module or in the Obsidian plugin | The service is waiting for you to pick a campaign |
|
||||
| A campaign picker in your browser | Sign in and choose the campaign, and the service is connected |
|
||||
| "Connected" in the service | It picked up its credential and can start working |
|
||||
|
||||
The link is short-lived — it expires after ten minutes — and can only be used once. If you close it
|
||||
without choosing, ask the service for a new one. If a service loses the credential it was given, it
|
||||
asks for a new link too: nothing is kept that would let it back in.
|
||||
|
||||
## What a connection allows
|
||||
|
||||
What a service may do is decided by the campaign you pick, so check the name before you confirm. The
|
||||
screen tells you which service is asking, and what it wants:
|
||||
|
||||
- a **Discord server** reads the campaign's characters, so whoever is in that server can read them,
|
||||
- a **Foundry world** keeps its actors and items in step with the campaign, which means it writes into
|
||||
it, and Dragonroll writes into it,
|
||||
- **Obsidian** reads the campaign's notes and pushes the ones you tell it to.
|
||||
|
||||
A campaign holds one link per service: linking a second Foundry world, or a second Discord server,
|
||||
replaces the one it had. Authorizing a service with a different Dragonroll account replaces who the
|
||||
service answers to.
|
||||
|
||||
## Seeing and undoing a connection
|
||||
|
||||
Open the campaign and look at **Settings → Integrations**. It lists the three services and, for each
|
||||
one, whether it is connected, what is connected to it, and which Dragonroll account authorized it.
|
||||
|
||||
**Unlink** ends it. The service loses access the next time it asks — nothing it already wrote into the
|
||||
campaign is deleted, and nothing about your campaign changes. To use the service again, start a new
|
||||
link from its own side.
|
||||
|
||||
## Next
|
||||
|
||||
- [Discord](/docs/discord) — read characters and campaigns from a server.
|
||||
- [Foundry VTT](/docs/foundry) — keep a world and a campaign in step.
|
||||
- [Obsidian](/docs/obsidian) — write campaign notes in your vault.
|
||||
Reference in New Issue
Block a user