|
|
|
|
@@ -1,8 +1,8 @@
|
|
|
|
|
# Foundry VTT
|
|
|
|
|
|
|
|
|
|
The Foundry integration keeps a Dragonroll campaign and a Foundry world in step: the world's
|
|
|
|
|
characters, item directory and scenes arrive in the campaign, and what you change in Dragonroll of
|
|
|
|
|
those characters and items goes back to the world.
|
|
|
|
|
characters and item directory arrive in the campaign. Sync runs one way only — from Foundry to
|
|
|
|
|
Dragonroll — so nothing you change in the campaign is written back into the world.
|
|
|
|
|
|
|
|
|
|
There are two separate parts, and you only need the first of them:
|
|
|
|
|
|
|
|
|
|
@@ -56,56 +56,30 @@ Worth knowing:
|
|
|
|
|
| Character, NPC and creature actors | Actors with the same sheet: abilities, saving throws, skills, combat stats, proficiencies, tools, languages, traits, spells, carried gear with its icons, coins, portrait |
|
|
|
|
|
| The world's **item directory** (the items tab) | The campaign's item list, with category, rarity, quantity, weight, properties and description |
|
|
|
|
|
| The folders grouping that item directory | Item folders with the same names and nesting |
|
|
|
|
|
| A folder's colour | The campaign's folder colour — and the other way round, what you colour in Dragonroll lands on the world's folder |
|
|
|
|
|
| The world's **scenes** | The campaign's maps: the scene's background picture and the grid laid over it, in the scene's own cell size |
|
|
|
|
|
| A journal per note folder, named after its path — one page per note | Your campaign's notes. They arrive **from** Dragonroll: what you write in a journal does not go back |
|
|
|
|
|
| A folder's colour | The campaign's folder colour |
|
|
|
|
|
|
|
|
|
|
The item list is the world's item directory and nothing else. The gear a character carries is that
|
|
|
|
|
character's inventory: it travels with the character and stays on its sheet, so a sword a fighter owns
|
|
|
|
|
does not turn up in the campaign's item list. Spells, classes, subclasses, backgrounds, feats and
|
|
|
|
|
species are not gear and are not imported.
|
|
|
|
|
|
|
|
|
|
The world's scenes are the campaign's maps, and only their **background picture** and their **grid**
|
|
|
|
|
cross over: a map arrives with the scene's picture and its cell size, and with the grid where the
|
|
|
|
|
world shifts it. That is where the two stop — what one of your cells stands for, the folder a map
|
|
|
|
|
stands in, the notes pinned onto it and the characters standing on it as tokens stay in the campaign,
|
|
|
|
|
and nothing about a map is written back into the world. The scene list goes over when the world links
|
|
|
|
|
and when it loads, which is also when the map of a scene the GM deleted goes with it; scenes changed
|
|
|
|
|
afterwards arrive as they happen. A scene with no background picture makes no map, and the full list
|
|
|
|
|
leaves a map the campaign already had alone, so a grid you lined up yourself survives a reload.
|
|
|
|
|
|
|
|
|
|
An actor or item keeps the Dragonroll id it was given in a `dragonroll-foundry.actorId` /
|
|
|
|
|
`dragonroll-foundry.itemId` flag, and that is what makes the two sides recognise each other. A world
|
|
|
|
|
item that carries no flag is matched by name, so a hand-written item in Dragonroll is adopted instead of
|
|
|
|
|
doubled, and renaming it in either place does not resurrect a duplicate.
|
|
|
|
|
|
|
|
|
|
Changes flow both ways as they happen, and Dragonroll's own edits are applied back in Foundry within a
|
|
|
|
|
few seconds. A **full** snapshot — the one taken when the world links, or forced from the actor
|
|
|
|
|
directory — is the only thing that prunes: it is the only moment either side can see the whole list and
|
|
|
|
|
notice what is gone. Live edits never delete anything.
|
|
|
|
|
|
|
|
|
|
Notes are the exception that runs one way, because notes are written in Dragonroll: each folder
|
|
|
|
|
stands as a journal named after its path. Notes in the root of the campaign share the journal called
|
|
|
|
|
**Dragonroll**, while notes in a folder called *Sessions* with a subfolder *Arc 1* share the journal
|
|
|
|
|
**Sessions / Arc 1**; every note is a page of the journal of its folder. A note's dice widgets are
|
|
|
|
|
buttons there as well: press one in the journal and Foundry rolls it and posts the result to chat, so
|
|
|
|
|
advantage and disadvantage roll the way the campaign's notes describe them. The note's `[[links]]`
|
|
|
|
|
work in the page too: a link to a note page, a character, an item or a scene opens it in Foundry, and
|
|
|
|
|
`![[a character or item]]` is drawn as a sheet preview inside the page. Renaming a folder renames
|
|
|
|
|
its journal, and moving a note to another folder moves its page along. The module only pulls the notes
|
|
|
|
|
over when something has changed, checking every fifteen seconds, so a note you make, edit or move in
|
|
|
|
|
the app appears in its journal within that time, and deleting one takes its page with it. Pages the
|
|
|
|
|
campaign does not own — ones the GM made in those journals themselves — are left alone, and nothing
|
|
|
|
|
written in a journal travels back to the campaign. A folder journal whose notes have all left is
|
|
|
|
|
removed too, unless the GM keeps pages of their own in it.
|
|
|
|
|
Changes flow one way: as you create, change or delete actors and world items in Foundry, they reach
|
|
|
|
|
the campaign. Nothing is written back, so editing a character, an item, a map or a note in Dragonroll
|
|
|
|
|
leaves the world alone. A **full** snapshot — the one taken when the world links, or forced from the
|
|
|
|
|
actor directory — is the only thing that prunes: it is the only moment the campaign can see the whole
|
|
|
|
|
list and notice what is gone. Live edits never delete anything.
|
|
|
|
|
|
|
|
|
|
## Auto-sync, and sending one actor on purpose
|
|
|
|
|
|
|
|
|
|
**Dragonroll Auto-sync** is what keeps the two in step: actors and world items you create, change or
|
|
|
|
|
delete are sent to the campaign, and both sides reconcile every few seconds. Turning it off stops all
|
|
|
|
|
of it — nothing is sent, and Dragonroll stops rewriting your Foundry documents, so the campaign keeps
|
|
|
|
|
whatever it already holds. Turn it back on and both sides reconcile again, including the edits queued
|
|
|
|
|
while it was off.
|
|
|
|
|
delete are sent to the campaign. Turning it off stops all of it — nothing is sent, and the campaign
|
|
|
|
|
keeps whatever it already holds. Turn it back on and the world's current state is sent again, including
|
|
|
|
|
the edits queued while it was off.
|
|
|
|
|
|
|
|
|
|
To send one character across right now, or to cross over while autosync is off, right-click the actor
|
|
|
|
|
(or several) in the Foundry actor directory and pick **Dragonroll: Force Sync**. Those actors, with the
|
|
|
|
|
|