const MODULE_ID = "dragonroll-foundry"; const SETTING_BRIDGE_URL = "bridgeUrl"; const SETTING_PUSH_TOKEN = "pushToken"; const SETTING_BRIDGE_CONFIG = "bridgeConfig"; const SETTING_DRAGONROLL_API_URL = "dragonrollApiUrl"; const SETTING_LINK_CODE = "linkCode"; const SETTING_LINK_URL = "linkUrl"; const SETTING_PAIRING_STATUS = "pairingStatus"; const SETTING_SYNC_TOKEN = "syncToken"; const SETTING_AUTO_SYNC = "autoSync"; // How often a world asks Dragonroll whether its sign-up link has been answered. const LINK_POLL_MS = 5000; let syncTimeout; let syncInProgress = false; let syncRequested = false; let askingForLink = false; let checkingLink = false; let updatingLinkSetting = false; // Marks a pairing Dragonroll honoured once and no longer accepts: the campaign // unlinked this world, so the token this client holds is dead. const PAIRING_REVOKED = "revoked"; let updatingPairingStatus = false; let linkedCampaignName = ""; let linkProblem = ""; let actorSyncTimeout; let characterSyncRetryTimeout; let characterSyncRunning = false; let actorSyncErrorLogged = false; const syncingActorIds = new Set(); const queuedActorChanges = new Map(); let itemSyncTimeout; let itemSyncRunning = false; let itemSyncErrorLogged = false; let folderSyncTimeout; let folderSyncRunning = false; const syncingItemIds = new Set(); const queuedItemChanges = new Map(); function getCollectionContents(collection, collectionName) { if (!collection) { throw new Error(`Foundry ${collectionName} collection is not available yet.`); } return collection.contents; } function toPlainData(document) { return document?.toObject() ?? null; } const api = Object.freeze({ /** Return metadata for the currently loaded world. */ getWorld() { if (!game.world) return null; return { id: game.world.id, title: game.world.title, system: game.system.id, url: window.location.origin, }; }, /** Return plain data snapshots for all Actor documents in the active world. */ getActors() { return getCollectionContents(game.actors, "actor").map(toPlainData); }, /** Return plain data snapshots for Actors whose system type is `character`. */ getCharacters() { return getCollectionContents(game.actors, "actor") .filter((actor) => actor.type === "character") .map(toPlainData); }, /** Return one Actor snapshot, or null when its id is not in the active world. */ getActor(actorId) { return toPlainData(game.actors?.get(actorId)); }, /** Return plain data snapshots for world-level Item documents. */ getItems() { return getCollectionContents(game.items, "item").map(toPlainData); }, /** Return one world-level Item snapshot, or null when its id is not in the active world. */ getItem(itemId) { return toPlainData(game.items?.get(itemId)); }, /** Return embedded Item snapshots belonging to an Actor, or null if the Actor is missing. */ getActorItems(actorId) { const actor = game.actors?.get(actorId); if (!actor) return null; return getCollectionContents(actor.items, "actor item").map(toPlainData); }, }); Hooks.once("init", () => { game.settings.register(MODULE_ID, SETTING_BRIDGE_URL, { name: "Legacy bridge URL", scope: "client", config: false, type: String, default: "", }); game.settings.register(MODULE_ID, SETTING_PUSH_TOKEN, { name: "Legacy bridge publish token", scope: "client", config: false, type: String, default: "", }); game.settings.register(MODULE_ID, SETTING_BRIDGE_CONFIG, { name: "Bridge configuration", scope: "client", config: false, type: Object, default: {}, }); game.settings.register(MODULE_ID, SETTING_SYNC_TOKEN, { name: "Character sync token", scope: "client", config: false, type: String, default: "", }); game.settings.register(MODULE_ID, SETTING_DRAGONROLL_API_URL, { name: "Dragonroll Endpoint", hint: "The Dragonroll server URL. The API path is added automatically.", scope: "client", config: true, type: String, default: "https://dragonroll.aranroig.com", }); game.settings.register(MODULE_ID, SETTING_LINK_CODE, { name: "Dragonroll Connection Link Code", scope: "client", config: false, type: String, default: "", }); game.settings.register(MODULE_ID, SETTING_LINK_URL, { name: "Dragonroll Connection Link", scope: "client", config: false, type: String, default: "", }); game.settings.register(MODULE_ID, SETTING_PAIRING_STATUS, { name: "Dragonroll Pairing Status", hint: "Whether this world is connected to a Dragonroll campaign. The module keeps this text up to date: it asks Dragonroll for a sign-up link, and whoever opens that link picks the campaign. There is nothing to set here.", scope: "client", config: true, type: String, default: "", onChange: handlePairingStatusChange, }); game.settings.register(MODULE_ID, SETTING_AUTO_SYNC, { name: "Dragonroll Auto-sync", hint: "Keep the linked Dragonroll campaign in step with this world as its actors and items change. Turn this off to stop synchronizing; the actor directory's Dragonroll: Force Sync entry then sends an actor over only when you ask for it.", scope: "client", config: true, type: Boolean, default: true, onChange: handleAutoSyncChange, }); registerPairingMenu(); const module = game.modules.get(MODULE_ID); if (!module) { console.warn(`${MODULE_ID} | Could not register the public API: module was not found.`); return; } module.api = api; console.info(`${MODULE_ID} | Public API registered.`); }); function dragonrollEndpoint(path) { const endpoint = game.settings.get(MODULE_ID, SETTING_DRAGONROLL_API_URL)?.trim(); if (!endpoint) throw new Error("Set the Dragonroll endpoint in the Dragonroll Foundry module settings first."); const apiBase = new URL(endpoint); const basePath = apiBase.pathname.replace(/\/+$/, ""); const hasApiPath = basePath.endsWith("/api"); apiBase.pathname = `${hasApiPath ? basePath : `${basePath}/api`}/`; apiBase.search = ""; apiBase.hash = ""; return new URL(path.replace(/^\/+/, ""), apiBase); } // A Dragonroll that is not there, or a URL that points at the web app instead of // the API, answers with HTML. Say that plainly instead of a JSON parse error. async function readDragonrollJson(response, url) { try { return await response.json(); } catch { throw new Error(`Dragonroll answered HTTP ${response.status} at ${url} but not with JSON. Check the Dragonroll Endpoint setting.`); } } async function postDragonroll(path, body, token = "") { const headers = { "Content-Type": "application/json" }; if (token) headers.Authorization = `Bearer ${token}`; const url = dragonrollEndpoint(path); const response = await fetch(url, { method: "POST", headers, body: JSON.stringify(body), }); const result = await readDragonrollJson(response, url); if (!response.ok || result.status !== "ok") { throw new Error(result.msg || `Dragonroll returned HTTP ${response.status}.`); } return result; } async function getDragonroll(path, token) { const url = dragonrollEndpoint(path); const response = await fetch(url, { headers: { Authorization: `Bearer ${token}` }, }); const result = await readDragonrollJson(response, url); if (!response.ok || result.status !== "ok") { throw new Error(result.msg || `Dragonroll returned HTTP ${response.status}.`); } return result; } // --- Connecting a world ---------------------------------------------------- // A world does not paste a code into its settings any more: it asks Dragonroll // for the same sign-up link every service gets, the GM opens it and picks the // campaign this world may work on. That link then hands the world its token. function worldLinkRequest() { const world = api.getWorld(); return { service: "foundry", target: { id: world.id, name: world.title, user: game.user?.name || "", meta: { system: world.system, url: world.url }, }, }; } async function setLink(code, url) { updatingLinkSetting = true; try { await game.settings.set(MODULE_ID, SETTING_LINK_CODE, code); await game.settings.set(MODULE_ID, SETTING_LINK_URL, url); } finally { updatingLinkSetting = false; } } async function requestDragonrollLink() { if (askingForLink || !game.user?.isGM || !game.world) return; askingForLink = true; try { const result = await postDragonroll("link/start", worldLinkRequest()); linkProblem = ""; await setLink(String(result.code || ""), String(result.linkUrl || "")); ui.notifications?.info(`Open this link to pick the Dragonroll campaign for this world: ${result.linkUrl}`); } catch (error) { console.error(`${MODULE_ID} | Could not get a Dragonroll connection link.`, error); linkProblem = error.message; } finally { askingForLink = false; await setPairingStatus(pairingStatusText()); } } // What a link leaves this client with once a campaign has been picked: the token // its sync runs on, and the bridge settings that came with it. async function applyDragonrollLink(result) { let syncTokenStored = false; if (result.syncToken) { try { await game.settings.set(MODULE_ID, SETTING_SYNC_TOKEN, result.syncToken); syncTokenStored = true; } catch (error) { console.error(`${MODULE_ID} | Could not save the character sync token.`, error); } } if (result.bridgeConfig?.url && result.bridgeConfig?.pushToken) { try { await game.settings.set(MODULE_ID, SETTING_BRIDGE_CONFIG, result.bridgeConfig); } catch (error) { console.error(`${MODULE_ID} | Could not save the bridge configuration.`, error); ui.notifications?.warn("This world was linked, but its bridge settings could not be saved on this client."); } } linkedCampaignName = String(result.campaign?.name || "").trim(); await setLink("", ""); if (syncTokenStored) { ui.notifications?.info("This Foundry world is now linked to the Dragonroll campaign."); scheduleSnapshotSync(0); setTimeout(initializeCharacterSync, 0); } else { // Without a token this client cannot sync, and only a fresh link gives one. linkProblem = "this client could not save the token it was given"; ui.notifications?.warn("This world is linked to a Dragonroll campaign, but character sync is unavailable. Update Dragonroll and link the world again."); } } // Where the sign-up link stands: still waiting for the GM to pick a campaign, // finished and handing its token over, or gone, in which case there is a new // link to show instead of a world that quietly stops trying. async function advanceDragonrollLink() { if (askingForLink || checkingLink || !game.user?.isGM || !game.world || getSyncToken()) return; const code = game.settings.get(MODULE_ID, SETTING_LINK_CODE)?.trim(); if (!code) return requestDragonrollLink(); checkingLink = true; try { const result = await postDragonroll("link/pickup", { code }); if (result.state === "pending") return; if (result.state === "linked") await applyDragonrollLink(result); else if (result.state === "revoked") { linkProblem = PAIRING_REVOKED; await setLink("", ""); } else { await setLink("", ""); await requestDragonrollLink(); } } catch (error) { // Dragonroll may be restarting: the next check asks again. console.warn(`${MODULE_ID} | Could not check the Dragonroll connection link.`, error); } finally { checkingLink = false; await setPairingStatus(pairingStatusText()); } } // --- Pairing status -------------------------------------------------------- // The pairing status is the sentence the module settings show. Everything in it // comes from this client plus what Dragonroll last said about its token, so it // reads correctly from the first frame and is corrected by refreshPairingStatus. function pairingStatusText() { const link = game.settings.get(MODULE_ID, SETTING_LINK_URL)?.trim(); if (linkProblem === PAIRING_REVOKED) { return link ? `Not connected: this world is no longer linked to the Dragonroll campaign it was paired with. Open ${link} to pick a campaign again.` : "Not connected: this world is no longer linked to the Dragonroll campaign it was paired with. Its settings will show a link to pick one again."; } if (getSyncToken()) { return linkedCampaignName ? `Connected to the Dragonroll campaign "${linkedCampaignName}".` : "Connected to a Dragonroll campaign."; } if (linkProblem) return `Not connected: Dragonroll did not answer this world's link (${linkProblem})`; if (link) { return `Not connected yet: open ${link} in a browser, sign in and pick the campaign for this world.`; } return "Not connected to a Dragonroll campaign. Set the Dragonroll Endpoint in these settings, then reload this world to get a sign-up link."; } async function setPairingStatus(text) { if (game.settings.get(MODULE_ID, SETTING_PAIRING_STATUS) === text) return; updatingPairingStatus = true; try { await game.settings.set(MODULE_ID, SETTING_PAIRING_STATUS, text); } catch (error) { console.warn(`${MODULE_ID} | Could not store the Dragonroll pairing status.`, error); } finally { updatingPairingStatus = false; } } // Nothing is configured here: anything typed into the status is replaced by the // status the module actually has. function handlePairingStatusChange() { if (updatingPairingStatus) return; setPairingStatus(pairingStatusText()); } // A token in this client only proves the world was paired once. Ask Dragonroll // which campaign that token belongs to, and hear back when the campaign has // unlinked this world again in the meantime. async function refreshPairingStatus() { const token = getSyncToken(); if (!token) { linkedCampaignName = ""; await setPairingStatus(pairingStatusText()); return; } try { const result = await getDragonroll("foundry/sync/status", token); linkedCampaignName = String(result.campaign?.name || "").trim(); if (linkProblem === PAIRING_REVOKED) linkProblem = ""; } catch (error) { // An unauthorized token is a campaign that unlinked this world. Any other // failure (an unreachable Dragonroll, or one old enough to have no status // route) says nothing about the pairing, so keep showing what we know. if (error.message === "unauthorized") { linkProblem = PAIRING_REVOKED; linkedCampaignName = ""; // The dead token is dropped so the world stops pushing to a campaign that // no longer wants it, and its link check asks for a sign-up link again. await game.settings.set(MODULE_ID, SETTING_SYNC_TOKEN, ""); ui.notifications?.warn("This world is no longer linked to its Dragonroll campaign. Its settings show the link to pick one again."); } } await setPairingStatus(pairingStatusText()); } // --- Connection actions ---------------------------------------------------- // The module settings open a small window for the two things a GM does about a // pairing: hand its sign-up link to somebody, and let the campaign go again. // The sign-up link lives in a client setting, so copying it is how it reaches // the browser the user will open it in. async function copyPairingLink() { if (getSyncToken()) { ui.notifications?.info("This world is already linked to a Dragonroll campaign; there is no sign-up link to copy."); return; } if (!game.settings.get(MODULE_ID, SETTING_LINK_URL)?.trim()) await requestDragonrollLink(); const link = game.settings.get(MODULE_ID, SETTING_LINK_URL)?.trim(); if (!link) { ui.notifications?.warn("Dragonroll does not have a sign-up link for this world right now. Check the Dragonroll Endpoint setting."); return; } try { await navigator.clipboard.writeText(link); ui.notifications?.info("Dragonroll sign-up link copied to the clipboard."); } catch (error) { // A browser can refuse the clipboard; the link is still the GM's to copy. console.warn(`${MODULE_ID} | Could not copy the Dragonroll sign-up link.`, error); ui.notifications?.warn(`Copy the Dragonroll sign-up link yourself: ${link}`); } } // Letting the campaign go from this side: Dragonroll forgets the world and drops // the token, so this world can pair with a campaign again. An unreachable // Dragonroll keeps the token — dropping it here would leave the campaign still // listing a world that can no longer reach it. async function unlinkDragonrollCampaign() { if (!game.user?.isGM || !game.world) return; const token = getSyncToken(); try { if (token) await postDragonroll("foundry/sync/unlink", { worldId: game.world.id }, token); } catch (error) { if (error.message !== "unauthorized") { console.error(`${MODULE_ID} | Could not unlink this world from Dragonroll.`, error); ui.notifications?.warn(`Dragonroll could not unlink this world: ${error.message}`); return; } } await game.settings.set(MODULE_ID, SETTING_SYNC_TOKEN, ""); linkedCampaignName = ""; linkProblem = ""; await setLink("", ""); await setPairingStatus(pairingStatusText()); ui.notifications?.info("This Foundry world is no longer linked to its Dragonroll campaign."); await requestDragonrollLink(); } function registerPairingMenu() { const ApplicationV2 = globalThis.foundry?.applications?.api?.ApplicationV2; // The module is loaded without Foundry's settings UI in its tests, and no // Foundry this module runs on lacks ApplicationV2. if (typeof game.settings.registerMenu !== "function" || !ApplicationV2) return; class DragonrollPairingMenu extends ApplicationV2 { static DEFAULT_OPTIONS = { id: "dragonroll-pairing-menu", classes: [MODULE_ID], window: { title: "Dragonroll Connection", icon: "fa-solid fa-link" }, position: { width: 560 }, actions: { copyLink() { return copyPairingLink().then(() => this.render()); }, unlink() { return unlinkDragonrollCampaign().then(() => this.render()); }, }, }; async _renderHTML() { const link = game.settings.get(MODULE_ID, SETTING_LINK_URL)?.trim(); const root = document.createElement("div"); root.className = "dragonroll-pairing-menu"; const status = document.createElement("p"); status.textContent = pairingStatusText(); root.append(status); if (link) { const field = document.createElement("input"); field.type = "text"; field.readOnly = true; field.value = link; field.addEventListener("focus", () => field.select()); root.append(field); } const actions = document.createElement("div"); actions.className = "dragonroll-pairing-actions"; const copy = document.createElement("button"); copy.type = "button"; copy.dataset.action = "copyLink"; copy.innerHTML = ' Copy link'; copy.disabled = Boolean(getSyncToken()); const unlink = document.createElement("button"); unlink.type = "button"; unlink.dataset.action = "unlink"; unlink.innerHTML = ' Unlink campaign'; unlink.disabled = !getSyncToken(); actions.append(copy, unlink); root.append(actions); return root; } _replaceHTML(result, content) { content.replaceChildren(result); } } game.settings.registerMenu(MODULE_ID, "pairingMenu", { name: "Dragonroll Connection", label: "Copy link / Unlink", hint: "Copy this world's sign-up link, or unlink the Dragonroll campaign it was paired with.", icon: "fa-solid fa-link", type: DragonrollPairingMenu, restricted: true, }); } function scheduleSnapshotSync(delay = 500) { clearTimeout(syncTimeout); syncTimeout = setTimeout(publishSnapshot, delay); } function getBridgeConfig() { const configured = game.settings.get(MODULE_ID, SETTING_BRIDGE_CONFIG); if (configured?.url?.trim() && configured?.pushToken?.trim()) return configured; const legacy = { url: game.settings.get(MODULE_ID, SETTING_BRIDGE_URL)?.trim(), pushToken: game.settings.get(MODULE_ID, SETTING_PUSH_TOKEN)?.trim(), }; return legacy.url && legacy.pushToken ? legacy : null; } function getSyncToken() { return game.settings.get(MODULE_ID, SETTING_SYNC_TOKEN)?.trim() || ""; } // Autosync is what the module has always done: every Foundry create, update and // delete pushes to Dragonroll. When it is off, nothing syncs on its own and only a // forced actor sync reaches Dragonroll. function isAutoSyncEnabled() { return game.settings.get(MODULE_ID, SETTING_AUTO_SYNC) !== false; } function handleAutoSyncChange(value) { if (value === false) { clearTimeout(actorSyncTimeout); clearTimeout(itemSyncTimeout); clearTimeout(folderSyncTimeout); return; } if (!game.user?.isGM || !getSyncToken()) return; // Switching it back on sends everything this world holds, then the changes // queued while autosync was off. initializeCharacterSync(); queueFoundryItemFolders(400); if (queuedActorChanges.size) { clearTimeout(actorSyncTimeout); actorSyncTimeout = setTimeout(flushActorChanges, 400); } if (queuedItemChanges.size) { clearTimeout(itemSyncTimeout); itemSyncTimeout = setTimeout(flushItemChanges, 400); } } function dragonrollActorId(actor) { return actor.getFlag?.(MODULE_ID, "actorId") || actor.flags?.[MODULE_ID]?.actorId || ""; } function serializeFoundryActor(actor) { const data = { ...toPlainData(actor), // Embedded items go through serializeFoundryItem so their icons become // absolute URLs too: Dragonroll renders them outside of Foundry. items: (actor.items?.contents?.map(serializeFoundryItem) || []).filter(Boolean), }; if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) { data.img = new URL(data.img, window.location.origin).toString(); } // Tools and languages travel by their names: what the actor holds are proficiency // keys (and, since the third release of the system, language documents), which mean // nothing to a sheet outside Foundry. const names = { tools: foundryTraitNames(actor, "tools"), languages: foundryTraitNames(actor, "languages") }; if (names.tools || names.languages) data.dragonroll = { ...names }; return data; } // A proficiency list of `system.traits`: its keys resolved to the labels CONFIG gives // them, plus whatever the GM typed as a proficiency of their own. `null` for an actor // that has no such list, an empty array for one that has none of that kind. Dragonroll // names its lists in full, while the world keeps its tools under `system.traits.tool` // and its languages under `system.traits.languages`. const TRAIT_FIELDS = { tools: "tool", languages: "languages" }; function foundryTraitNames(actor, kind) { if (game.system?.id !== "dnd5e") return null; const trait = actor.system?.traits?.[TRAIT_FIELDS[kind] ?? kind]; if (!trait || typeof trait !== "object") return null; const names = (Array.isArray(trait.value) ? trait.value : []) .map((key) => foundryProficiencyLabel(kind, key)) .filter(Boolean); for (const custom of String(trait.custom ?? "").split(",")) { const name = custom.trim(); if (name) names.push(name); } return [...new Set(names)]; } function foundryProficiencyLabel(kind, key) { if (typeof key !== "string" || !key) return ""; const entry = CONFIG.DND5E?.[kind === "languages" ? "languages" : "tools"]?.[key]; const label = entry?.label ?? entry?.name; if (label) return String(label); // A language the world added itself stands as a document of its own rather than in // the system's config. const document = kind === "languages" ? game.items?.get?.(key) : null; if (document?.name) return String(document.name); // The key beats dropping a proficiency the character really has. return key; } function isSupportedCharacterActor(actor) { const savedType = actor.getFlag?.(MODULE_ID, "actorType") || actor.flags?.[MODULE_ID]?.actorType; return ["character", "npc", "creature"].includes(savedType || actor.type); } // Embedded documents the world owns outright (Syndria98/dragonroll#89): a feat is a trait // and a race is a species — they reach the campaign through its traits and species fields, // never through its inventory. Dragonroll must neither mark them as its own nor delete one // when it writes the character, and an older campaign still holding such a row in its // inventory must be let to write it out of the campaign without the document going with it. const WORLD_OWNED_EMBEDDED_TYPES = new Set(["feat", "race", "species", "status", "spellbook", "language"]); async function markActorItemsAsSynced(actor) { const updates = actor.items.contents .filter((item) => !item.getFlag?.(MODULE_ID, "syncedItem") && !WORLD_OWNED_EMBEDDED_TYPES.has(item.type)) .map((item) => ({ _id: item.id, [`flags.${MODULE_ID}.syncedItem`]: true, })); if (updates.length) { await withActorSyncSuppressed(actor, () => actor.updateEmbeddedDocuments("Item", updates)); } } async function withActorSyncSuppressed(actor, callback) { if (!actor?.id) return callback(); syncingActorIds.add(actor.id); try { return await callback(); } finally { syncingActorIds.delete(actor.id); } } async function setDragonrollActorId(actor, actorId) { if (!actor || !actorId) return; await withActorSyncSuppressed(actor, () => actor.update({ [`flags.${MODULE_ID}.actorId`]: String(actorId), [`flags.${MODULE_ID}.syncMutation`]: false, })); } function reportActorSyncError(error) { if (actorSyncErrorLogged) return; actorSyncErrorLogged = true; console.warn(`${MODULE_ID} | Character sync failed and will retry.`, error); } async function pushFoundryActors(actors, fullSync = false, replace = false) { const token = getSyncToken(); if (!token || !game.user?.isGM || !game.world || (!actors.length && !fullSync)) return; if (game.system.id !== "dnd5e") { throw new Error("Character sync currently requires the D&D 5e Foundry system."); } const supportedActors = actors.filter(isSupportedCharacterActor); for (const actor of supportedActors) await markActorItemsAsSynced(actor); const result = await postDragonroll("foundry/sync/snapshot", { worldId: game.world.id, actors: supportedActors.map(serializeFoundryActor), // The world item directory is what the campaign lists as its items // (Syndria98/dragonroll#67); the gear a character carries travels inside that // actor's snapshot as its inventory, not as campaign items. items: getWorldItemSnapshots(), // The folder tree those world items stand in (see worldItemFolderSnapshots). folders: worldItemFolderSnapshots(), fullSync, // A forced sync replaces the campaign's row for these actors outright; a live // change or a full snapshot never sets this, so the campaign keeps its edits. replace, }, token); for (const mapping of result.actors || []) { const actor = game.actors.get(mapping.foundryActorId); if (actor && dragonrollActorId(actor) !== mapping.actorId) { await setDragonrollActorId(actor, mapping.actorId); } } await rememberItemMappings(result.items); actorSyncErrorLogged = false; } async function deleteDragonrollActor(foundryActorId) { const token = getSyncToken(); if (!token || !game.world || !foundryActorId) return; await postDragonroll("foundry/sync/delete", { worldId: game.world.id, foundryActorId, }, token); } // Sending actors on purpose, whether or not autosync is on: this is the push the // GM asks for. It replaces everything the campaign holds for those actors (Syndria98/ // dragonroll#96), but it upserts them only, so unlike a full snapshot it never prunes // anything else the campaign holds. async function forceSyncActorsToDragonroll(actors) { if (!game.user?.isGM || !game.world || !actors.length) return; if (!getSyncToken()) { ui.notifications?.warn("Link this world to a Dragonroll campaign before syncing actors to it."); return; } const supported = actors.filter(isSupportedCharacterActor); const refused = actors.filter((actor) => !supported.includes(actor)); if (refused.length) { ui.notifications?.warn(`${refused.map((actor) => actor.name).join(", ")} ${refused.length === 1 ? "is" : "are"} not a character, NPC or creature: Dragonroll does not import ${refused.length === 1 ? "it" : "them"}.`); } if (!supported.length) return; try { await pushFoundryActors(supported, false, true); ui.notifications?.info(supported.length === 1 ? `${supported[0].name} was sent to the Dragonroll campaign.` : `${supported.length} actors were sent to the Dragonroll campaign.`); } catch (error) { console.error(`${MODULE_ID} | Could not force sync the selected actors.`, error); ui.notifications?.error(`Dragonroll sync failed: ${error.message}`); } } function queueActorChange(kind, actor) { if (!actor || !game.user?.isGM || !getSyncToken()) return; if (syncingActorIds.has(actor.id) || actor.flags?.[MODULE_ID]?.syncMutation) return; queuedActorChanges.set(actor.id, { kind, actor }); clearTimeout(actorSyncTimeout); actorSyncTimeout = setTimeout(flushActorChanges, 400); } async function flushActorChanges() { // Autosync may have been switched off while changes were queued: keep them // waiting so turning it back on still sends them. if (!isAutoSyncEnabled()) return; const changes = [...queuedActorChanges.values()]; queuedActorChanges.clear(); const deleted = changes.filter((change) => change.kind === "delete"); const changed = changes.filter((change) => change.kind !== "delete"); try { for (const change of deleted) await deleteDragonrollActor(change.actor.id); await pushFoundryActors(changed.map((change) => change.actor)); } catch (error) { reportActorSyncError(error); for (const change of changes) queuedActorChanges.set(change.actor.id, change); clearTimeout(actorSyncTimeout); actorSyncTimeout = setTimeout(flushActorChanges, 5000); } } // --- World item sync ------------------------------------------------------- // Items embedded in an actor travel with that actor's snapshot; the items below // send the world-level item directory (game.items) to the campaign. function itemPropertyLabels(item) { const values = item.system?.properties?.value; if (!Array.isArray(values) || !values.length || game.system?.id !== "dnd5e") return []; const propertyConfigs = [ CONFIG.DND5E?.weaponProperties, CONFIG.DND5E?.armorProperties, CONFIG.DND5E?.toolProperties, CONFIG.DND5E?.consumableProperties, ]; return values .map((key) => { for (const config of propertyConfigs) { const label = config?.[key]?.label; if (label) return String(label).toLowerCase(); } return typeof key === "string" ? key : ""; }) .filter(Boolean); } function serializeFoundryItem(item) { const data = toPlainData(item); if (!data) return null; if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) { data.img = new URL(data.img, window.location.origin).toString(); } // Dragonroll shows plain property text; send Foundry's own labels when present // so keys such as "ver" do not end up in its Item list. const properties = itemPropertyLabels(item); if (properties.length) data.dragonroll = { properties }; return data; } // --- Item folders ------------------------------------------------------------ // Dragonroll mirrors the folders the world's item directory is grouped into, so its // item list reads like Foundry's. `game.folders` also holds the folders an actor // keeps for its own inventory: those hang off the actor instead of the world, and // the campaign has no use for them, so only folders rooted in the world go over. // The folder a folder is nested in, or null when it is not nested in a folder. function itemFolderParent(folder) { const parent = typeof folder.parent === "string" ? game.folders?.get(folder.parent) : folder.parent; return parent?.documentName === "Folder" ? parent : null; } // Whether a folder belongs to the world's item directory: its whole ancestry has // to be folders, ending in one that nothing is above. function isWorldItemFolder(folder, seen = new Set()) { if (folder.type !== "Item" || seen.has(folder.id)) return false; seen.add(folder.id); const rawParent = folder.parent; const rawParentId = typeof rawParent === "string" ? rawParent : rawParent?.id; if (!rawParentId) return true; const parent = typeof rawParent === "string" ? game.folders?.get(rawParentId) : rawParent; if (parent?.documentName !== "Folder") return false; return isWorldItemFolder(parent, seen); } // A Foundry folder's colour, or null for one the GM left uncoloured. Null travels as null: // it tells Dragonroll to take a colour off the folder it was given before, whereas a module // that says nothing about colours at all leaves the campaign's own choice alone. function itemFolderColor(folder) { const color = typeof folder?.color === "string" ? folder.color.trim() : ""; return color || null; } function worldItemFolderSnapshots() { return (game.folders?.contents || []) .filter((folder) => isWorldItemFolder(folder)) .map((folder) => ({ id: folder.id, name: folder.name, parent: itemFolderParent(folder)?.id || null, color: itemFolderColor(folder), })); } // A world item travels with the folder it stands in, so Dragonroll can file it the // same way; `""` says the world keeps it at the root of the item directory. Items // embedded in an actor use serializeFoundryItem instead: their folders are the // actor's own, and the campaign's item list is deduplicated by name anyway. function serializeFoundryWorldItem(item) { const data = serializeFoundryItem(item); if (!data) return null; data.dragonroll = { ...data.dragonroll, folder: worldItemFolderId(item) }; return data; } // The folder id an item data carries is either the id or the Folder document // itself, depending on the Foundry version. function worldItemFolderId(item) { const folder = item?.folder; if (!folder) return ""; if (typeof folder === "string") return game.folders?.get(folder)?.documentName === "Folder" ? folder : ""; return folder.documentName === "Folder" ? String(folder.id || "") : ""; } function getWorldItemSnapshots() { return (game.items?.contents || []).map(serializeFoundryWorldItem).filter(Boolean); } // --- Item identities --------------------------------------------------------- function dragonrollItemIdOf(item) { return item.getFlag?.(MODULE_ID, "itemId") || item.flags?.[MODULE_ID]?.itemId || ""; } async function withItemSyncSuppressed(item, callback) { if (!item?.id) return callback(); syncingItemIds.add(item.id); try { return await callback(); } finally { syncingItemIds.delete(item.id); } } async function setDragonrollItemId(item, itemId) { if (!item || !itemId) return; await withItemSyncSuppressed(item, () => item.update({ [`flags.${MODULE_ID}.itemId`]: String(itemId), [`flags.${MODULE_ID}.syncMutation`]: false, })); } async function rememberItemMappings(mappings) { for (const mapping of mappings || []) { const item = game.items?.get(mapping.foundryItemId); if (item && String(dragonrollItemIdOf(item)) !== String(mapping.itemId)) { await setDragonrollItemId(item, mapping.itemId); } } } function reportItemSyncError(error) { if (itemSyncErrorLogged) return; itemSyncErrorLogged = true; console.warn(`${MODULE_ID} | Item sync failed and will retry.`, error); } // Item pushes are upserts only: the full world snapshot sent with the actors // owns pruning, because it is the only one that sees every embedded copy. async function pushFoundryItems(items) { const token = getSyncToken(); if (!token || !game.user?.isGM || !game.world || !items.length) return; const result = await postDragonroll("foundry/sync/item-snapshot", { worldId: game.world.id, items: items.map(serializeFoundryWorldItem).filter(Boolean), // The folder tree goes along, so an item that moved into or out of a folder // arrives with the folder it names. folders: worldItemFolderSnapshots(), }, token); await rememberItemMappings(result.items); itemSyncErrorLogged = false; } async function deleteDragonrollItem(foundryItemId) { const token = getSyncToken(); if (!token || !game.world || !foundryItemId) return; await postDragonroll("foundry/sync/item-delete", { worldId: game.world.id, foundryItemId, }, token); } function queueFoundryItemChange(kind, item) { if (!item || !game.user?.isGM || !getSyncToken()) return; if (syncingItemIds.has(item.id) || item.flags?.[MODULE_ID]?.syncMutation) return; queuedItemChanges.set(item.id, { kind, item }); clearTimeout(itemSyncTimeout); itemSyncTimeout = setTimeout(flushItemChanges, 400); } // A folder the GM made, renamed or nested has to reach the campaign even though no // item changed, so the tree goes over on its own without pushing the items in it. function queueFoundryItemFolders(delay = 400) { clearTimeout(folderSyncTimeout); folderSyncTimeout = setTimeout(pushFoundryItemFolders, delay); } async function pushFoundryItemFolders() { // Autosync off: folder changes wait, like the item edits do. if (!isAutoSyncEnabled()) return; const token = getSyncToken(); if (!token || !game.user?.isGM || !game.world || folderSyncRunning) return; folderSyncRunning = true; try { await postDragonroll("foundry/sync/item-snapshot", { worldId: game.world.id, items: [], folders: worldItemFolderSnapshots(), }, token); itemSyncErrorLogged = false; } catch (error) { reportItemSyncError(error); queueFoundryItemFolders(5000); } finally { folderSyncRunning = false; } } async function flushItemChanges() { // Autosync off: the queued edits wait here, like the actor changes do. if (!isAutoSyncEnabled()) return; const changes = [...queuedItemChanges.values()]; queuedItemChanges.clear(); const deleted = changes.filter((change) => change.kind === "delete"); const changed = changes.filter((change) => change.kind !== "delete"); try { for (const change of deleted) await deleteDragonrollItem(change.item.id); if (changed.length) await pushFoundryItems(changed.map((change) => change.item)); } catch (error) { reportItemSyncError(error); for (const change of changes) queuedItemChanges.set(change.item.id, change); clearTimeout(itemSyncTimeout); itemSyncTimeout = setTimeout(flushItemChanges, 5000); } } async function initializeCharacterSync() { if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return; try { await pushFoundryActors(game.actors.contents, true); } catch (error) { reportActorSyncError(error); clearTimeout(characterSyncRetryTimeout); characterSyncRetryTimeout = setTimeout(initializeCharacterSync, 15000); } } function queueFoundryActorChange(kind, actor) { if (kind !== "delete" && (actor.flags?.[MODULE_ID]?.syncMutation || syncingActorIds.has(actor.id))) return; queueActorChange(kind, actor); } async function publishSnapshot() { if (!game.user?.isGM || !game.world) return; if (syncInProgress) { syncRequested = true; return; } const bridgeConfig = getBridgeConfig(); if (!bridgeConfig) return; syncInProgress = true; try { const actorItems = Object.fromEntries( game.actors.contents.map((actor) => [ actor.id, actor.items.contents.map(toPlainData), ]), ); const response = await fetch(new URL("internal/snapshot", `${bridgeConfig.url.replace(/\/+$/, "")}/`), { method: "POST", headers: { "Authorization": `Bearer ${bridgeConfig.pushToken}`, "Content-Type": "application/json", }, body: JSON.stringify({ world: api.getWorld(), actors: api.getActors(), items: api.getItems(), actorItems, }), }); if (!response.ok) { throw new Error(`Bridge returned HTTP ${response.status}.`); } } catch (error) { console.error(`${MODULE_ID} | Could not publish the world snapshot.`, error); scheduleSnapshotSync(15000); } finally { syncInProgress = false; if (syncRequested) { syncRequested = false; scheduleSnapshotSync(); } } } async function publishHeartbeat() { if (!game.user?.isGM || !game.world) return; const bridgeConfig = getBridgeConfig(); if (!bridgeConfig) return; try { const response = await fetch(new URL("internal/heartbeat", `${bridgeConfig.url.replace(/\/+$/, "")}/`), { method: "POST", headers: { "Authorization": `Bearer ${bridgeConfig.pushToken}`, "Content-Type": "application/json", }, body: JSON.stringify({ worldId: game.world.id }), }); if (response.status === 409 || response.status === 503) { scheduleSnapshotSync(0); return; } if (!response.ok) throw new Error(`Bridge returned HTTP ${response.status}.`); } catch (error) { console.warn(`${MODULE_ID} | Bridge heartbeat failed.`, error); scheduleSnapshotSync(15000); } } Hooks.once("ready", () => { advanceDragonrollLink().then(refreshPairingStatus); // While this world has no campaign, its sign-up link is what the GM has to // work with: keep showing it and keep asking whether it has been answered. setInterval(() => { if (getSyncToken()) return; advanceDragonrollLink(); }, LINK_POLL_MS); setInterval(refreshPairingStatus, 60000); scheduleSnapshotSync(0); setInterval(publishHeartbeat, 60000); setTimeout(initializeCharacterSync, 1000); for (const event of [ "createActor", "updateActor", "deleteActor", "createItem", "updateItem", "deleteItem", "createFolder", "updateFolder", "deleteFolder", ]) { Hooks.on(event, (document) => { scheduleSnapshotSync(); const isDelete = event.startsWith("delete"); if (document.documentName === "Actor") { queueFoundryActorChange(isDelete ? "delete" : "upsert", document); return; } // An item folder the GM made, renamed or nested changes the tree the campaign // mirrors; nothing about the items themselves changed, so only the tree goes. if (document.documentName === "Folder") { if (document.type === "Item" && isWorldItemFolder(document)) queueFoundryItemFolders(); return; } if (document.documentName !== "Item") return; // Items embedded in an actor travel with that actor's snapshot: adding or // removing one only changes the actor, never deletes it. if (document.parent?.documentName === "Actor") { queueFoundryActorChange("upsert", document.parent); return; } queueFoundryItemChange(isDelete ? "delete" : "upsert", document); }); } }); // A GM sends selected actors to Dragonroll from the actor directory's context // menu, replacing whatever the campaign holds for them. This works with autosync on // and off: it is the one push done on purpose. // // Foundry 13 replaced getActorDirectoryEntryContext with getActorContextOptions, // which fires when the directory first renders, so the hook is registered here at // load time rather than inside "ready". The entry is always offered and hidden with // "visible" when it cannot apply, because the hook may only run once. Hooks.on("getActorContextOptions", (application, menuItems) => { menuItems.push({ label: "Dragonroll: Force Sync", icon: "fa-solid fa-rotate", visible: () => Boolean(game.user?.isGM && getSyncToken()), onClick: (event, target) => { // One entry is clicked at a time, but several can be selected: take every // selected actor directory entry, falling back to the one the menu was // opened for. const clicked = target?.closest?.("[data-entry-id]") ?? target; const ids = new Set( [...(application?.element?.querySelectorAll?.("[data-entry-id].selected") ?? [])] .map((entry) => entry.dataset?.entryId), ); if (clicked?.dataset?.entryId) ids.add(clicked.dataset.entryId); forceSyncActorsToDragonroll([...ids].map((id) => game.actors?.get(id)).filter(Boolean)); }, }); });