Compare commits
4 Commits
ai/issue-1
...
dc6a04df8a
| Author | SHA1 | Date | |
|---|---|---|---|
| dc6a04df8a | |||
| 0799dec5b3 | |||
|
|
8378e9b3e7 | ||
|
|
7d19a22a4b |
51
AGENTS.md
51
AGENTS.md
@@ -12,8 +12,10 @@ dice widgets, shared markdown, sounds). It is a two-app monorepo:
|
||||
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth. CommonJS.
|
||||
- `frontend/` — **Nuxt 4 / Vue 3** client (Composition API, `<script setup>`), SCSS, axios, marked, mitt, motion.
|
||||
|
||||
There is **no** database seeding, no ORM migrations, no test suite, no linter/formatter config, no
|
||||
Pinia/Vuex, and no Vue Router pages (see §5.1 — the UI is a window manager, not routed pages).
|
||||
There is **no** database seeding, no ORM migrations, no linter/formatter config, no Pinia/Vuex, and no
|
||||
Vue Router pages (see §5.1 — the UI is a window manager, not routed pages). The only automated tests
|
||||
are `tests/*.test.js` (`npm test`, Node's built-in runner), which exercise the Foundry module's sync
|
||||
logic against stubbed Foundry globals.
|
||||
|
||||
Git: default branch `master`, hosted on a self-hosted Gitea (`git.aranroig.com/BinarySandia04/Dragonroll`).
|
||||
CI (`.gitea/workflows/deploy.yml`) builds two Docker images on every push to `master`, pushes them to
|
||||
@@ -26,12 +28,12 @@ CI (`.gitea/workflows/deploy.yml`) builds two Docker images on every push to `ma
|
||||
dragonroll/
|
||||
├── backend/ Express API (CommonJS, entry: src/index.js)
|
||||
├── frontend/ Nuxt 4 app (entry: app/app.vue)
|
||||
├── obsidian-plugin/ Plain JavaScript Obsidian plugin for campaign note import/push
|
||||
├── docker-compose.yml nginx :3000 -> frontend :3000, /api -> backend :5000
|
||||
├── nginx.conf reverse proxy rules for the compose stack
|
||||
├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9)
|
||||
├── .gitea/workflows/deploy.yml
|
||||
├── static/media/ README logo images only
|
||||
├── tests/ `node --test` tests (Foundry module sync toggle)
|
||||
├── package.json root: only `concurrently`, used by `npm run dev`
|
||||
└── README.md install/run instructions are STALE (see §9)
|
||||
```
|
||||
@@ -50,10 +52,13 @@ npm --prefix backend run dev # backend only
|
||||
npm --prefix frontend run dev # frontend only
|
||||
npm --prefix frontend run build # nuxt build --dotenv .env.production
|
||||
npm --prefix frontend run preview
|
||||
|
||||
npm test # node --test tests/ (Foundry module sync logic, no dependencies)
|
||||
```
|
||||
|
||||
There is no `start` script in either package, no test command, and no lint command.
|
||||
Verification = run the dev server and exercise the flow (`/api/test` returns a JSON hello).
|
||||
There is no `start` script in either package and no lint command.
|
||||
Verification = run the dev server and exercise the flow (`/api/test` returns a JSON hello);
|
||||
`npm test` covers the Foundry character/item sync toggle and per-actor force sync.
|
||||
|
||||
### Environment files
|
||||
|
||||
@@ -75,9 +80,9 @@ backend/src/
|
||||
├── index.js app bootstrap: dotenv, static uploads, json limits (50mb),
|
||||
│ passport init, CORS, route mounting, listen(5000)
|
||||
├── db.js connectDB() -> mongoose.connect(process.env.DB_URI)
|
||||
├── models/ User.js Campaign.js Note.js Folder.js Actor.js Item.js Map.js
|
||||
├── models/ User.js Campaign.js Note.js Folder.js Actor.js Item.js
|
||||
│ FoundryLinkRequest.js DiscordLinkRequest.js DiscordGuildLink.js
|
||||
├── routes/ user.js campaign.js note.js folder.js actor.js item.js map.js
|
||||
├── routes/ user.js campaign.js note.js folder.js actor.js item.js
|
||||
│ foundry-link.js (token sync, mounted BEFORE auth) foundry.js (bridge proxy)
|
||||
│ discord.js
|
||||
├── services/
|
||||
@@ -142,7 +147,6 @@ User ──< Campaign ──< Note ──?> Folder ──?> Folder (parentFolder
|
||||
└───────< Folder
|
||||
└───────< Actor (Foundry actors, when linked)
|
||||
└───────< Item (Foundry gear + hand-made items)
|
||||
└───────< Map (uploaded images + their grid settings)
|
||||
```
|
||||
|
||||
| Model | File | Fields |
|
||||
@@ -153,7 +157,6 @@ User ──< Campaign ──< Note ──?> Folder ──?> Folder (parentFolder
|
||||
| `Folder` | `models/Folder.js` | `name*`, `campaign*` → Campaign, `parentFolder` → Folder (null = root), `color` (hex string, sidebar entry background), `date` |
|
||||
| `Actor` | `models/Actor.js` | `name*`, `type` (`character`\|`npc`\|`creature`), `species`, `className`, `subclass`, `level`, `background`, `challengeRating`, `description`, `image`, `abilityScores{str..cha}`, `armorClass`, `speed`, `proficiencies`, `inventory[{name,quantity,weight}]` (flattened Foundry items, embedded — not `Item` docs), `traits`, `spells` (newline text), `campaign*` → Campaign, `foundryActorId` (unique per campaign), `date` |
|
||||
| `Item` | `models/Item.js` | `name*`, `category` (`weapon`\|`armor`\|`shield`\|`adventuring-gear`\|`magic-item`\|`consumable`\|`tool`\|`treasure`\|`other`), `rarity` (`common`…`artifact`), `quantity`, `weight`, `properties`, `description`, `campaign*` → Campaign, `foundryItemId` (unique per campaign), `foundryNames` (names Foundry uses for it, keeps dedup stable across a Dragonroll rename), `date` |
|
||||
| `Map` | `models/Map.js` | `name*`, `image` (filename in `src/uploads`), `gridSize` (cell size in image px), `offsetX`/`offsetY` (grid origin in image px), `scale` (distance one cell stands for), `campaign*` → Campaign, `date` |
|
||||
|
||||
`*` = required. Notes and folders are ordered by `date: -1` everywhere.
|
||||
|
||||
@@ -184,8 +187,7 @@ Fetch the file from `/api/public/<filename>`.
|
||||
`GET /api/campaign/list` → `{status:'ok',campaigns}`
|
||||
`GET /api/campaign/retrieve/:id` → `{status:'ok',campaign}` (401 when no `req.user.id`)
|
||||
|
||||
`GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots);
|
||||
folder entries include `parentFolder` so clients can rebuild nested folder paths
|
||||
`GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots)
|
||||
`GET /api/note/subfolder/list?campaign=&folder=` → `{status:'ok', subfolders, notes}`
|
||||
`POST /api/note/create` — `{title*,content,campaign*,folder?}` (folder validated against campaign)
|
||||
`POST /api/note/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked
|
||||
@@ -211,12 +213,6 @@ subfolders re-parented to null then deleted.
|
||||
`POST /api/item/update` — `{id*, name?, category?, rarity?, quantity?, weight?, properties?, description?}` — partial, ownership checked. `''` for `quantity`/`weight` is ignored, like `/item/create`.
|
||||
`POST /api/item/delete` — `{id}`
|
||||
|
||||
`GET /api/map/list?campaign=` → `{status:'ok',maps}`
|
||||
`POST /api/map/create` — multipart (`image`) or JSON `{name*,campaign*,gridSize?,offsetX?,offsetY?,scale?}` → `{status:'ok',map}`
|
||||
`POST /api/map/update` — `{id*, name?, gridSize?, offsetX?, offsetY?, scale?}`, partial, ownership checked. Send it as
|
||||
multipart with an `image` field to replace the photo (multer reads the other fields from the form; JSON works too).
|
||||
`POST /api/map/delete` — `{id}`
|
||||
|
||||
### 4.1 Foundry integration (actors, items)
|
||||
|
||||
`dragonroll-foundry/` holds the Foundry VTT module (`scripts/api.js`, loaded by `module.json`) and an
|
||||
@@ -250,6 +246,10 @@ Rules worth knowing before editing this:
|
||||
which the sync skips.
|
||||
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events
|
||||
overwrite. Item pruning requires the full snapshot, since only it sees world items and actor copies.
|
||||
- **Autosync is a Foundry-side switch** (`autoSync` client setting, on by default): when off, the
|
||||
module queues no CRUD push, runs no periodic reconcile and sends no startup snapshot; the actor
|
||||
directory's `Dragonroll: Force Sync` entry still pushes the selected actors as an upsert
|
||||
(`fullSync:false`, so it never prunes). The read-only bridge snapshot is not gated by it.
|
||||
- `Actor.inventory` stays a flattened copy of the actor's embedded items; it is not linked to `Item`.
|
||||
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only
|
||||
bridge, only useful when `FOUNDRY_API_URL` is configured.
|
||||
@@ -465,23 +465,6 @@ script; `WindowDefinitions` stores raw keys (`title: 'windows.login'`) and `Wind
|
||||
configured (`nuxt.config.ts`, `langDir: 'locales/'`, `vueI18n: './i18n.config.ts'`) but its locale files
|
||||
(`locales/en.json` etc.) are empty `{}` — the custom plugin is what components actually consume.
|
||||
|
||||
### 5.9 Obsidian plugin
|
||||
|
||||
`obsidian-plugin/` is a plain JavaScript community plugin; copy `main.js` and `manifest.json` into
|
||||
`<vault>/.obsidian/plugins/dragonroll-sync/` (details in its README). It signs in through
|
||||
`POST /api/user/login`, saves the 48-hour JWT token in plugin data, and does not save the password.
|
||||
The user selects a campaign from `GET /api/campaign/list`.
|
||||
|
||||
- **Import or refresh campaign notes** reads `/api/note/list` plus `/api/note/subfolder/list` and
|
||||
creates/updates Markdown files under `Dragonroll/<Campaign>/`, preserving Dragonroll's folder tree.
|
||||
- **Push active note to Dragonroll** creates a root campaign note or updates the note linked in its
|
||||
frontmatter.
|
||||
- `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` frontmatter properties link imported
|
||||
notes. They are omitted from content sent to Dragonroll. Per-note signatures detect local edits;
|
||||
imports preserve modified local files, and push is explicit.
|
||||
|
||||
The plugin uses Obsidian's `requestUrl` helper, so the request path does not depend on browser CORS.
|
||||
|
||||
## 6. Conventions
|
||||
|
||||
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/`
|
||||
|
||||
@@ -24,7 +24,6 @@ Dragonroll is an open source connector for role-playing games.
|
||||
- Play music during physical campaings
|
||||
- Plan different encounters
|
||||
- Manage different items and spells
|
||||
- Import and edit campaign notes in Obsidian with the [Dragonroll Sync plugin](obsidian-plugin/README.md)
|
||||
- And so much more!
|
||||
|
||||
## Installation 🛠️
|
||||
@@ -56,6 +55,7 @@ if you want to start the development environments
|
||||
|
||||
- Dragonroll <-> Foundry integration
|
||||
- Dragonroll <-> Discord Bot integration
|
||||
- Dragonroll <-> Obsidian integration
|
||||
|
||||
What to sync:
|
||||
|
||||
|
||||
@@ -79,10 +79,10 @@ app.use('/api/note', require('./routes/note'));
|
||||
app.use('/api/folder', require('./routes/folder'));
|
||||
app.use('/api/actor', require('./routes/actor'));
|
||||
app.use('/api/item', require('./routes/item'));
|
||||
app.use('/api/map', require('./routes/map'));
|
||||
app.use('/api/foundry', require('./routes/foundry'));
|
||||
/*
|
||||
app.use('/campaign', require('./routes/campaign'));
|
||||
app.use('/maps', require('./routes/map'));
|
||||
app.use('/datagen', require('./routes/datagen'));
|
||||
app.use('/admin', require('./routes/admin'));
|
||||
*/
|
||||
|
||||
@@ -1,23 +0,0 @@
|
||||
const mongoose = require('mongoose');
|
||||
const Schema = mongoose.Schema;
|
||||
|
||||
const MapSchema = new Schema({
|
||||
name: { type: String, required: true, trim: true },
|
||||
// Uploaded image, served from /api/public/<filename>
|
||||
image: { type: String, default: '' },
|
||||
// Grid cell size in image pixels
|
||||
gridSize: { type: Number, min: 1, default: 50 },
|
||||
// Grid origin, in image pixels from the top left corner of the image
|
||||
offsetX: { type: Number, default: 0 },
|
||||
offsetY: { type: Number, default: 0 },
|
||||
// Distance each grid cell stands for (feet, metres...)
|
||||
scale: { type: Number, min: 0.01, default: 5 },
|
||||
campaign: {
|
||||
type: Schema.Types.ObjectId,
|
||||
ref: 'Campaign',
|
||||
required: true
|
||||
},
|
||||
date: { type: Date, default: Date.now }
|
||||
});
|
||||
|
||||
module.exports = mongoose.model('Map', MapSchema);
|
||||
@@ -1,95 +0,0 @@
|
||||
const express = require('express');
|
||||
const router = express.Router();
|
||||
|
||||
const upload = require('../services/storage');
|
||||
|
||||
const Campaign = require('../models/Campaign');
|
||||
const Map = require('../models/Map');
|
||||
|
||||
async function userOwnsCampaign(campaignId, userId) {
|
||||
const campaign = await Campaign.findOne({ _id: campaignId, createdBy: userId }).lean();
|
||||
return Boolean(campaign);
|
||||
}
|
||||
|
||||
// Grid values arrive as strings when the request is a multipart form upload.
|
||||
function toNumber(value, fallback) {
|
||||
if (value === undefined || value === null || value === '') return fallback;
|
||||
const number = Number(value);
|
||||
return Number.isFinite(number) ? number : fallback;
|
||||
}
|
||||
|
||||
router.get('/list', async (req, res) => {
|
||||
try {
|
||||
const { campaign } = req.query;
|
||||
if (!campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||
|
||||
const maps = await Map.find({ campaign }).sort({ name: 1 }).lean();
|
||||
res.json({ status: 'ok', maps });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
}
|
||||
});
|
||||
|
||||
router.post('/create', upload.single('image'), async (req, res) => {
|
||||
try {
|
||||
const { name, campaign, gridSize, offsetX, offsetY, scale } = req.body;
|
||||
if (!name?.trim() || !campaign) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||
if (!(await userOwnsCampaign(campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||
|
||||
const map = await Map.create({
|
||||
name: name.trim(), campaign,
|
||||
image: req.file ? req.file.filename : '',
|
||||
gridSize: toNumber(gridSize, 50),
|
||||
offsetX: toNumber(offsetX, 0),
|
||||
offsetY: toNumber(offsetY, 0),
|
||||
scale: toNumber(scale, 5)
|
||||
});
|
||||
res.json({ status: 'ok', map });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
}
|
||||
});
|
||||
|
||||
router.post('/update', upload.single('image'), async (req, res) => {
|
||||
try {
|
||||
const { id, name, gridSize, offsetX, offsetY, scale } = req.body;
|
||||
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||
|
||||
const map = await Map.findById(id);
|
||||
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||
|
||||
if (name !== undefined) map.name = String(name).trim();
|
||||
if (gridSize !== undefined) map.gridSize = toNumber(gridSize, map.gridSize);
|
||||
if (offsetX !== undefined) map.offsetX = toNumber(offsetX, map.offsetX);
|
||||
if (offsetY !== undefined) map.offsetY = toNumber(offsetY, map.offsetY);
|
||||
if (scale !== undefined) map.scale = toNumber(scale, map.scale);
|
||||
if (req.file) map.image = req.file.filename;
|
||||
|
||||
await map.save();
|
||||
res.json({ status: 'ok', map });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
}
|
||||
});
|
||||
|
||||
router.post('/delete', async (req, res) => {
|
||||
try {
|
||||
const { id } = req.body;
|
||||
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||
const map = await Map.findById(id);
|
||||
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||
await map.deleteOne();
|
||||
res.json({ status: 'ok' });
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
res.json({ status: 'error', msg: 'errors.internal' });
|
||||
}
|
||||
});
|
||||
|
||||
module.exports = router;
|
||||
@@ -19,7 +19,7 @@ router.get('/list', async (req, res) => {
|
||||
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||
|
||||
const folders = await Folder.find({ campaign })
|
||||
.select('_id name parentFolder date color')
|
||||
.select('_id name date color')
|
||||
.sort({ date: -1 })
|
||||
.lean();
|
||||
|
||||
|
||||
@@ -53,6 +53,25 @@ within about five seconds. The module currently creates Dragonroll characters in
|
||||
worlds. After updating an already-linked world to a version with character sync, create a fresh
|
||||
pairing code and enter it in Foundry once to issue the sync token.
|
||||
|
||||
### Auto-sync, and sending one actor on purpose
|
||||
|
||||
**Dragonroll Auto-sync** in the module settings (on by default) is what keeps the campaign and this
|
||||
world in step: actors and world items the GM creates, updates or deletes are sent to Dragonroll, and
|
||||
both sides reconcile every few seconds. Turn it off to stop synchronizing altogether — nothing is
|
||||
sent to the campaign, and Dragonroll stops rewriting those documents in Foundry, so the campaign
|
||||
keeps whatever it already holds. Turn it back on to reconcile both sides again; the Foundry edits
|
||||
queued while it was off are sent as the world catches up.
|
||||
|
||||
With autosync off — or any time a single character needs to cross over right now — right-click an
|
||||
actor (or several selected ones) in the Foundry actor directory and pick **Dragonroll: Force Sync**.
|
||||
Those actors, together with the gear carried inside them, are pushed to the campaign immediately even
|
||||
when autosync is off. It is an upsert only: it never prunes the campaign's other actors, which a full
|
||||
snapshot does and a forced sync never claims to. Actors Dragonroll does not import (anything that is
|
||||
not a character, NPC or creature) are refused with a notification.
|
||||
|
||||
The optional read-only snapshot bridge is not affected: it keeps publishing the world snapshot behind
|
||||
`/api/foundry/*`, which is never written into the campaign.
|
||||
|
||||
### Items
|
||||
|
||||
The campaign's Item list is synchronized with the world's gear, both ways:
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
"id": "dragonroll-foundry",
|
||||
"title": "Dragonroll Foundry API",
|
||||
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
|
||||
"version": "0.3.0",
|
||||
"version": "0.4.0",
|
||||
"library": true,
|
||||
"compatibility": {
|
||||
"minimum": "12",
|
||||
|
||||
@@ -5,6 +5,7 @@ const SETTING_BRIDGE_CONFIG = "bridgeConfig";
|
||||
const SETTING_DRAGONROLL_API_URL = "dragonrollApiUrl";
|
||||
const SETTING_LINK_CODE = "linkCode";
|
||||
const SETTING_SYNC_TOKEN = "syncToken";
|
||||
const SETTING_AUTO_SYNC = "autoSync";
|
||||
let syncTimeout;
|
||||
let syncInProgress = false;
|
||||
let syncRequested = false;
|
||||
@@ -139,6 +140,16 @@ Hooks.once("init", () => {
|
||||
onChange: handleLinkCodeChange,
|
||||
});
|
||||
|
||||
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,
|
||||
});
|
||||
|
||||
const module = game.modules.get(MODULE_ID);
|
||||
if (!module) {
|
||||
console.warn(`${MODULE_ID} | Could not register the public API: module was not found.`);
|
||||
@@ -287,6 +298,35 @@ 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, and both sides reconcile on a timer. 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);
|
||||
return;
|
||||
}
|
||||
if (!game.user?.isGM || !getSyncToken()) return;
|
||||
|
||||
// Switching it back on converges both sides again, then the changes queued
|
||||
// while autosync was off are pushed so this world's state wins over them.
|
||||
initializeCharacterSync();
|
||||
reconcileDragonrollItems();
|
||||
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 || "";
|
||||
}
|
||||
@@ -380,6 +420,34 @@ async function deleteDragonrollActor(foundryActorId) {
|
||||
}, token);
|
||||
}
|
||||
|
||||
// Sending actors on purpose, whether or not autosync is on: this is the push the
|
||||
// GM asks for. It upserts those actors 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);
|
||||
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;
|
||||
@@ -389,6 +457,9 @@ function queueActorChange(kind, actor) {
|
||||
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");
|
||||
@@ -518,6 +589,8 @@ function queueFoundryItemChange(kind, item) {
|
||||
}
|
||||
|
||||
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");
|
||||
@@ -616,7 +689,7 @@ async function createFoundryWorldItem(entry) {
|
||||
|
||||
async function reconcileDragonrollItems() {
|
||||
const token = getSyncToken();
|
||||
if (!token || !game.user?.isGM || !game.world || itemSyncRunning) return;
|
||||
if (!token || !game.user?.isGM || !game.world || itemSyncRunning || !isAutoSyncEnabled()) return;
|
||||
itemSyncRunning = true;
|
||||
try {
|
||||
if (game.system.id !== "dnd5e") {
|
||||
@@ -847,7 +920,7 @@ async function createFoundryCharacter(entry) {
|
||||
|
||||
async function reconcileDragonrollCharacters() {
|
||||
const token = getSyncToken();
|
||||
if (!token || !game.user?.isGM || !game.world || characterSyncRunning) return;
|
||||
if (!token || !game.user?.isGM || !game.world || characterSyncRunning || !isAutoSyncEnabled()) return;
|
||||
characterSyncRunning = true;
|
||||
try {
|
||||
if (game.system.id !== "dnd5e") {
|
||||
@@ -887,7 +960,7 @@ async function reconcileDragonrollCharacters() {
|
||||
}
|
||||
|
||||
async function initializeCharacterSync() {
|
||||
if (!getSyncToken() || !game.user?.isGM || !game.world) return;
|
||||
if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return;
|
||||
try {
|
||||
await pushFoundryActors(game.actors.contents, true);
|
||||
await reconcileDragonrollCharacters();
|
||||
@@ -1016,3 +1089,21 @@ Hooks.once("ready", () => {
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
// A GM sends selected actors to Dragonroll from the actor directory's context
|
||||
// menu. This works with autosync on and off: it is the one push done on purpose.
|
||||
Hooks.on("getActorDirectoryEntryContext", (html, options) => {
|
||||
if (!game.user?.isGM || !getSyncToken()) return;
|
||||
|
||||
options.push({
|
||||
name: "Dragonroll: Force Sync",
|
||||
icon: '<i class="fa-solid fa-rotate"></i>',
|
||||
// Array.from: the selected entries are jQuery in Foundry 12 and a plain
|
||||
// array afterwards, and both are array-like.
|
||||
callback: (entries) => forceSyncActorsToDragonroll(
|
||||
Array.from(entries || [])
|
||||
.map((entry) => game.actors?.get(entry.dataset?.actorId))
|
||||
.filter(Boolean),
|
||||
),
|
||||
});
|
||||
});
|
||||
|
||||
@@ -15,8 +15,6 @@ const notes = ref([]);
|
||||
const folders = ref([]);
|
||||
const actors = ref([]);
|
||||
const items = ref([]);
|
||||
const maps = ref([]);
|
||||
const entryLists = { actor: actors, item: items, map: maps };
|
||||
const loadingNotes = ref(false);
|
||||
const loadingEntries = ref(false);
|
||||
const notesError = ref('');
|
||||
@@ -107,16 +105,14 @@ function handleFolderDeleted(folderId) {
|
||||
|
||||
function handleCampaignEntryCreated({ entityType, entry }) {
|
||||
if (!entry || (entry.campaign && String(entry.campaign) !== String(campaignId.value))) return;
|
||||
const list = entryLists[entityType];
|
||||
if (!list) return;
|
||||
const list = entityType === 'actor' ? actors : items;
|
||||
list.value = [...list.value.filter((current) => current._id !== entry._id), entry]
|
||||
.sort((a, b) => a.name.localeCompare(b.name));
|
||||
}
|
||||
|
||||
function handleCampaignEntryUpdated({ entityType, entry }) {
|
||||
if (!entry) return;
|
||||
const list = entryLists[entityType];
|
||||
if (!list) return;
|
||||
const list = entityType === 'actor' ? actors : items;
|
||||
list.value = list.value.map((current) => current._id === entry._id ? entry : current)
|
||||
.sort((a, b) => a.name.localeCompare(b.name));
|
||||
}
|
||||
@@ -162,34 +158,24 @@ async function fetchCampaignNotes() {
|
||||
}
|
||||
}
|
||||
|
||||
function entryEntityType(section) {
|
||||
if (section === 'actors') return 'actor';
|
||||
if (section === 'items') return 'item';
|
||||
if (section === 'maps') return 'map';
|
||||
return null;
|
||||
}
|
||||
|
||||
function isEntrySection(section) {
|
||||
return entryEntityType(section) !== null;
|
||||
}
|
||||
|
||||
async function fetchCampaignEntries(entityType = activeSection.value, silent = false) {
|
||||
const kind = entryEntityType(entityType);
|
||||
const list = entryLists[kind];
|
||||
if (!campaignId.value || !list) return;
|
||||
if (!campaignId.value || !['actors', 'items'].includes(entityType)) return;
|
||||
if (!silent) {
|
||||
loadingEntries.value = true;
|
||||
entriesError.value = '';
|
||||
}
|
||||
try {
|
||||
const response = await Server().get(`/${kind}/list`, { params: { campaign: campaignId.value } });
|
||||
const collection = entityType === 'actors' ? 'actor' : 'item';
|
||||
const response = await Server().get(`/${collection}/list`, { params: { campaign: campaignId.value } });
|
||||
if (response.data.status !== 'ok') {
|
||||
if (!silent) entriesError.value = response.data.msg ?? t('campaigns.errors.load');
|
||||
return;
|
||||
}
|
||||
|
||||
const kind = entityType === 'actors' ? 'actor' : 'item';
|
||||
const list = entityType === 'actors' ? actors : items;
|
||||
const previousById = new Map(list.value.map((entry) => [entry._id, entry]));
|
||||
list.value = response.data[entityType] ?? [];
|
||||
list.value = response.data[entityType];
|
||||
// Tell open windows about Foundry changes landing behind them.
|
||||
for (const entry of list.value) {
|
||||
const previous = previousById.get(entry._id);
|
||||
@@ -206,15 +192,11 @@ async function fetchCampaignEntries(entityType = activeSection.value, silent = f
|
||||
|
||||
function selectSection(section) {
|
||||
activeSection.value = section;
|
||||
if (isEntrySection(section)) fetchCampaignEntries(section);
|
||||
if (section === 'actors' || section === 'items') fetchCampaignEntries(section);
|
||||
}
|
||||
|
||||
function createEntry(entityType) {
|
||||
if (!campaignId.value) return;
|
||||
if (entityType === 'map') {
|
||||
CreateWindow('create_map', { campaign: campaignId.value });
|
||||
return;
|
||||
}
|
||||
CreateWindow('create_campaign_entry', { entityType, campaign: campaignId.value });
|
||||
}
|
||||
|
||||
@@ -231,37 +213,22 @@ function itemSummary(item) {
|
||||
return `${t(`campaigns.item.categories.${item.category}`)} · ${t(`campaigns.item.rarities.${item.rarity}`)} · ${t('campaigns.item.quantity-short')} ${item.quantity}`;
|
||||
}
|
||||
|
||||
function mapSummary(map) {
|
||||
return t('campaigns.map.summary', { size: map.gridSize, scale: map.scale });
|
||||
}
|
||||
|
||||
function editItem(entry) {
|
||||
if (!campaignId.value) return;
|
||||
CreateWindow('create_campaign_entry', { entityType: 'item', campaign: campaignId.value, entry });
|
||||
}
|
||||
|
||||
function editMap(map) {
|
||||
if (!campaignId.value) return;
|
||||
CreateWindow('create_map', { campaign: campaignId.value, entry: map });
|
||||
}
|
||||
|
||||
function showEntryMenu(entry, entityType) {
|
||||
const list = entryLists[entityType];
|
||||
const collection = entityType === 'actor' ? 'actor' : 'item';
|
||||
const menuItems = [];
|
||||
|
||||
// Characters are edited in their sheet; items and maps get their window in edit mode.
|
||||
if (entityType === 'item') {
|
||||
// Characters are edited in their sheet; items get the entry window in edit mode.
|
||||
if (entityType !== 'actor') {
|
||||
menuItems.push({
|
||||
name: t('campaigns.actions.edit'),
|
||||
icon: '/icons/iconoir/regular/edit.svg',
|
||||
action: () => { HideContextMenu(); editItem(entry); }
|
||||
});
|
||||
} else if (entityType === 'map') {
|
||||
menuItems.push({
|
||||
name: t('campaigns.actions.edit'),
|
||||
icon: '/icons/iconoir/regular/edit.svg',
|
||||
action: () => { HideContextMenu(); editMap(entry); }
|
||||
});
|
||||
}
|
||||
|
||||
menuItems.push({
|
||||
@@ -269,9 +236,10 @@ function showEntryMenu(entry, entityType) {
|
||||
icon: '/icons/iconoir/regular/trash.svg',
|
||||
action: async () => {
|
||||
try {
|
||||
const response = await Server().post(`/${entityType}/delete`, { id: entry._id });
|
||||
if (response.data.status === 'ok' && list) {
|
||||
list.value = list.value.filter((current) => current._id !== entry._id);
|
||||
const response = await Server().post(`/${collection}/delete`, { id: entry._id });
|
||||
if (response.data.status === 'ok') {
|
||||
if (entityType === 'actor') actors.value = actors.value.filter((actor) => actor._id !== entry._id);
|
||||
else items.value = items.value.filter((item) => item._id !== entry._id);
|
||||
}
|
||||
} catch (error) {} finally { HideContextMenu(); }
|
||||
}
|
||||
@@ -294,15 +262,6 @@ async function openCharacterSheet(actor) {
|
||||
CreateWindow('character_sheet', { actor });
|
||||
}
|
||||
|
||||
async function openMapViewer(map) {
|
||||
const existingWindowId = GetFirstWindowId('map_viewer');
|
||||
if (existingWindowId !== undefined) {
|
||||
ClearWindow({ id: existingWindowId });
|
||||
await nextTick();
|
||||
}
|
||||
CreateWindow('map_viewer', { map, campaign: campaignId.value });
|
||||
}
|
||||
|
||||
function createNote() {
|
||||
if (!Campaign.value) return;
|
||||
|
||||
@@ -323,15 +282,13 @@ watch(campaignId, (newVal) => {
|
||||
if (newVal) {
|
||||
actors.value = [];
|
||||
items.value = [];
|
||||
maps.value = [];
|
||||
fetchCampaignNotes();
|
||||
if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value);
|
||||
if (activeSection.value === 'actors' || activeSection.value === 'items') fetchCampaignEntries(activeSection.value);
|
||||
} else {
|
||||
notes.value = [];
|
||||
folders.value = [];
|
||||
actors.value = [];
|
||||
items.value = [];
|
||||
maps.value = [];
|
||||
notesError.value = '';
|
||||
entriesError.value = '';
|
||||
}
|
||||
@@ -418,16 +375,6 @@ onBeforeUnmount(() => {
|
||||
>
|
||||
<img class="sidebar-action-icon" src="/icons/iconoir/regular/box.svg" alt="" aria-hidden="true">
|
||||
</button>
|
||||
|
||||
<button
|
||||
class="sidebar-action"
|
||||
:class="{ selected: activeSection === 'maps' }"
|
||||
type="button" @click="selectSection('maps')"
|
||||
:title="t('campaigns.sections.maps')" :aria-label="t('campaigns.sections.maps')"
|
||||
:aria-pressed="(activeSection === 'maps').toString()"
|
||||
>
|
||||
<img class="sidebar-action-icon" src="/icons/iconoir/regular/map.svg" alt="" aria-hidden="true">
|
||||
</button>
|
||||
</nav>
|
||||
|
||||
<aside class="notes-sidebar" :class="{ collapsed: sidebarCollapsed }">
|
||||
@@ -449,7 +396,7 @@ onBeforeUnmount(() => {
|
||||
</button>
|
||||
</template>
|
||||
<template v-else>
|
||||
<button class="sidebar-action" type="button" @click="createEntry(entryEntityType(activeSection))" :disabled="!Campaign" :title="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })" :aria-label="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })">
|
||||
<button class="sidebar-action" type="button" @click="createEntry(activeSection === 'actors' ? 'actor' : 'item')" :disabled="!Campaign" :title="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })" :aria-label="t('campaigns.actions.create', { section: t(`campaigns.sections.${activeSection}`).toLowerCase() })">
|
||||
<img class="sidebar-action-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
||||
</button>
|
||||
<button class="sidebar-action" type="button" @click="fetchCampaignEntries(activeSection)" :disabled="!Campaign || loadingEntries" :title="t('campaigns.actions.refresh')" :aria-label="t('campaigns.actions.refresh')">
|
||||
@@ -480,7 +427,7 @@ onBeforeUnmount(() => {
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<template v-else-if="activeSection === 'items'">
|
||||
<template v-else>
|
||||
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
||||
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
||||
<div v-else-if="items.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-items') }}</div>
|
||||
@@ -497,17 +444,6 @@ onBeforeUnmount(() => {
|
||||
</template>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<template v-else>
|
||||
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
||||
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
||||
<div v-else-if="maps.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-maps') }}</div>
|
||||
<div v-for="map in maps" :key="map._id" class="entity-entry" role="button" tabindex="0" @click="openMapViewer(map)" @keydown.enter="openMapViewer(map)" @keydown.space.prevent="openMapViewer(map)" @contextmenu.prevent="showEntryMenu(map, 'map')">
|
||||
<span class="entity-entry-name">{{ map.name }}</span>
|
||||
<span class="entity-entry-meta">{{ mapSummary(map) }}</span>
|
||||
<span v-if="!map.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span>
|
||||
</div>
|
||||
</template>
|
||||
</div>
|
||||
</aside>
|
||||
</div>
|
||||
|
||||
@@ -1,184 +0,0 @@
|
||||
<script setup>
|
||||
import { onBeforeUnmount, onMounted, ref } from 'vue';
|
||||
import { useI18n } from 'vue-i18n';
|
||||
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
|
||||
import WindowHandle from './partials/WindowHandle.vue';
|
||||
import Server, { getBaseUrl } from '~/services/Server';
|
||||
import { emitter } from '~/services/Emitter';
|
||||
|
||||
const { t } = useI18n();
|
||||
const props = defineProps(['data']);
|
||||
const data = props.data;
|
||||
const id = data.id;
|
||||
const handle = ref(null);
|
||||
const wrapper = ref(null);
|
||||
const saving = ref(false);
|
||||
const error = ref('');
|
||||
const imageInput = ref(null);
|
||||
// Passing an entry edits an existing map; otherwise this window creates one.
|
||||
const editing = data.entry || null;
|
||||
|
||||
function initialForm() {
|
||||
return {
|
||||
name: editing?.name ?? '',
|
||||
gridSize: Number(editing?.gridSize ?? 50),
|
||||
offsetX: Number(editing?.offsetX ?? 0),
|
||||
offsetY: Number(editing?.offsetY ?? 0),
|
||||
scale: Number(editing?.scale ?? 5)
|
||||
};
|
||||
}
|
||||
|
||||
const form = ref(initialForm());
|
||||
const selectedImage = ref(null);
|
||||
let previewObjectUrl = null;
|
||||
|
||||
function serverImageUrl(image) {
|
||||
if (!image) return '';
|
||||
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
|
||||
}
|
||||
|
||||
const previewUrl = ref(serverImageUrl(editing?.image));
|
||||
|
||||
onMounted(() => {
|
||||
Top(wrapper);
|
||||
SetupHandle(id, handle);
|
||||
SetSize(id, { width: 500, height: 600 });
|
||||
ResetPosition(id, 'center');
|
||||
});
|
||||
|
||||
onBeforeUnmount(() => {
|
||||
ClearWindow({ type: 'create_map' });
|
||||
if (previewObjectUrl) URL.revokeObjectURL(previewObjectUrl);
|
||||
});
|
||||
|
||||
function pickImage() {
|
||||
imageInput.value?.click();
|
||||
}
|
||||
|
||||
function onImageSelected(event) {
|
||||
const file = event.target.files?.[0];
|
||||
event.target.value = '';
|
||||
if (!file) return;
|
||||
if (previewObjectUrl) URL.revokeObjectURL(previewObjectUrl);
|
||||
previewObjectUrl = URL.createObjectURL(file);
|
||||
selectedImage.value = file;
|
||||
previewUrl.value = previewObjectUrl;
|
||||
}
|
||||
|
||||
const numberFields = ['gridSize', 'offsetX', 'offsetY', 'scale'];
|
||||
|
||||
async function saveMap() {
|
||||
if (!form.value.name.trim() || saving.value) return;
|
||||
saving.value = true;
|
||||
error.value = '';
|
||||
try {
|
||||
const body = new FormData();
|
||||
body.append('name', form.value.name.trim());
|
||||
if (editing) body.append('id', editing._id);
|
||||
else body.append('campaign', data.campaign);
|
||||
for (const field of numberFields) {
|
||||
if (Number.isFinite(form.value[field])) body.append(field, String(form.value[field]));
|
||||
}
|
||||
if (selectedImage.value) body.append('image', selectedImage.value);
|
||||
|
||||
const response = await Server().post(editing ? '/map/update' : '/map/create', body, {
|
||||
headers: { "Content-Type": "multipart/form-data" }
|
||||
});
|
||||
if (response.data.status !== 'ok') {
|
||||
error.value = t('campaigns.map.save-error');
|
||||
return;
|
||||
}
|
||||
emitter.emit(editing ? 'campaign-entry-updated' : 'campaign-entry-created', { entityType: 'map', entry: response.data.map });
|
||||
ClearWindow({ id });
|
||||
} catch (requestError) {
|
||||
error.value = t('campaigns.map.save-error');
|
||||
} finally {
|
||||
saving.value = false;
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||
<WindowHandle :window="id" ref="handle" />
|
||||
<div class="body">
|
||||
<h3>{{ $t(editing ? 'campaigns.map.edit' : 'campaigns.map.new') }}</h3>
|
||||
<div v-if="error" class="form-error">{{ error }}</div>
|
||||
<form @submit.prevent="saveMap">
|
||||
<label class="form-field">
|
||||
<span>{{ $t('campaigns.fields.name') }}</span>
|
||||
<input v-model="form.name" required autofocus autocomplete="off">
|
||||
</label>
|
||||
|
||||
<div class="form-field">
|
||||
<span>{{ $t('campaigns.map.photo') }}</span>
|
||||
<div class="image-picker" :class="{ empty: !previewUrl }">
|
||||
<img v-if="previewUrl" :src="previewUrl" :alt="$t('campaigns.map.photo')">
|
||||
<button class="pick-image sound-click" type="button" :disabled="saving" @click="pickImage">
|
||||
{{ $t(previewUrl ? 'campaigns.map.change-photo' : 'campaigns.map.upload-photo') }}
|
||||
</button>
|
||||
</div>
|
||||
<small class="field-help">{{ $t('campaigns.map.photo-hint') }}</small>
|
||||
<input ref="imageInput" class="image-input" type="file" accept="image/*" @change="onImageSelected">
|
||||
</div>
|
||||
|
||||
<div class="form-grid">
|
||||
<label class="form-field">
|
||||
<span>{{ $t('campaigns.map.grid-size') }}</span>
|
||||
<input v-model.number="form.gridSize" type="number" min="1" step="1">
|
||||
</label>
|
||||
<label class="form-field">
|
||||
<span>{{ $t('campaigns.map.scale') }}</span>
|
||||
<input v-model.number="form.scale" type="number" min="0.01" step="0.5">
|
||||
</label>
|
||||
<label class="form-field">
|
||||
<span>{{ $t('campaigns.map.offset-x') }}</span>
|
||||
<input v-model.number="form.offsetX" type="number" step="1">
|
||||
</label>
|
||||
<label class="form-field">
|
||||
<span>{{ $t('campaigns.map.offset-y') }}</span>
|
||||
<input v-model.number="form.offsetY" type="number" step="1">
|
||||
</label>
|
||||
</div>
|
||||
<small class="field-help">{{ $t('campaigns.map.scale-help') }}</small>
|
||||
|
||||
<div class="form-actions">
|
||||
<button class="btn-primary sound-click" type="submit" :disabled="saving">
|
||||
{{ saving ? $t('campaigns.actions.saving') : $t('campaigns.actions.save') }}
|
||||
</button>
|
||||
</div>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
|
||||
.body { width: 100%; padding: 10px 18px 16px; overflow-y: auto; }
|
||||
h3 { margin: 0 0 12px; font-family: MrEavesRemake; }
|
||||
form { display: flex; flex-direction: column; gap: 10px; }
|
||||
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }
|
||||
.form-grid { display: grid; grid-template-columns: 1fr 1fr; gap: 10px; }
|
||||
input {
|
||||
box-sizing: border-box; width: 100%; padding: 7px 8px; border: 1px solid var(--color-border);
|
||||
border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); font: inherit;
|
||||
}
|
||||
input:focus { outline: none; border-color: var(--color-link); }
|
||||
.image-picker {
|
||||
min-height: 96px; display: flex; align-items: center; justify-content: center; overflow: hidden;
|
||||
border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft);
|
||||
}
|
||||
.image-picker.empty { border-style: dashed; }
|
||||
.image-picker img { max-width: 100%; max-height: 180px; object-fit: contain; }
|
||||
.pick-image {
|
||||
border: 1px solid var(--color-border); border-radius: 6px; padding: 5px 10px; margin: 6px;
|
||||
background: var(--color-background-light); color: var(--color-text); font-size: 12px; cursor: pointer;
|
||||
}
|
||||
.pick-image:hover { background: var(--color-button-hover); }
|
||||
.pick-image:disabled { opacity: .55; cursor: wait; }
|
||||
.image-input { display: none; }
|
||||
.field-help { font-size: 11px; opacity: .72; }
|
||||
.form-error { padding: 7px 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
||||
.form-actions { display: flex; justify-content: center; margin-top: 2px; }
|
||||
.form-actions button { width: 100%; max-width: 220px; }
|
||||
</style>
|
||||
@@ -1,224 +0,0 @@
|
||||
<script setup>
|
||||
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
||||
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateWindow } from '@/services/Windows';
|
||||
import WindowHandle from './partials/WindowHandle.vue';
|
||||
import { getBaseUrl } from '~/services/Server';
|
||||
import { emitter } from '~/services/Emitter';
|
||||
|
||||
const props = defineProps(['data']);
|
||||
const id = props.data.id;
|
||||
const campaignId = props.data.campaign;
|
||||
const handle = ref(null);
|
||||
const wrapper = ref(null);
|
||||
|
||||
const map = ref(props.data.map ? { ...props.data.map } : null);
|
||||
const viewport = ref(null);
|
||||
|
||||
const zoom = ref(1);
|
||||
const pan = ref({ x: 0, y: 0 });
|
||||
const imageSize = ref({ width: 0, height: 0 });
|
||||
const showGrid = ref(true);
|
||||
const dragging = ref(false);
|
||||
|
||||
const minZoom = 0.05;
|
||||
const maxZoom = 8;
|
||||
|
||||
const imageUrl = computed(() => {
|
||||
const image = map.value?.image;
|
||||
if (!image) return '';
|
||||
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
|
||||
});
|
||||
|
||||
const stageStyle = computed(() => ({
|
||||
transform: `translate3d(${pan.value.x}px, ${pan.value.y}px, 0) scale(${zoom.value})`
|
||||
}));
|
||||
|
||||
// The grid is drawn in screen space over the image so its lines stay one pixel wide at any zoom.
|
||||
const gridStyle = computed(() => {
|
||||
if (!showGrid.value || !imageSize.value.width) return { display: 'none' };
|
||||
const cell = `${Math.max(1, Number(map.value?.gridSize) || 50) * zoom.value}px`;
|
||||
return {
|
||||
width: `${imageSize.value.width * zoom.value}px`,
|
||||
height: `${imageSize.value.height * zoom.value}px`,
|
||||
transform: `translate3d(${pan.value.x + (Number(map.value?.offsetX) || 0) * zoom.value}px, ${pan.value.y + (Number(map.value?.offsetY) || 0) * zoom.value}px, 0)`,
|
||||
backgroundImage: `linear-gradient(to right, var(--color-link) 1px, transparent 1px), linear-gradient(to bottom, var(--color-link) 1px, transparent 1px)`,
|
||||
backgroundSize: `${cell} ${cell}`
|
||||
};
|
||||
});
|
||||
|
||||
const zoomPercent = computed(() => `${Math.round(zoom.value * 100)}%`);
|
||||
|
||||
function clampZoom(value) {
|
||||
if (!Number.isFinite(value)) return minZoom;
|
||||
return Math.min(maxZoom, Math.max(minZoom, value));
|
||||
}
|
||||
|
||||
function fitToWindow() {
|
||||
const bounds = viewport.value?.getBoundingClientRect();
|
||||
if (!bounds || !imageSize.value.width) return;
|
||||
zoom.value = clampZoom(Math.min(bounds.width / imageSize.value.width, bounds.height / imageSize.value.height));
|
||||
centerOn();
|
||||
}
|
||||
|
||||
function centerOn() {
|
||||
const bounds = viewport.value?.getBoundingClientRect();
|
||||
if (!bounds || !imageSize.value.width) return;
|
||||
pan.value = {
|
||||
x: (bounds.width - imageSize.value.width * zoom.value) / 2,
|
||||
y: (bounds.height - imageSize.value.height * zoom.value) / 2
|
||||
};
|
||||
}
|
||||
|
||||
function onImageLoaded(event) {
|
||||
imageSize.value = { width: event.target.naturalWidth, height: event.target.naturalHeight };
|
||||
fitToWindow();
|
||||
}
|
||||
|
||||
// Zoom keeping the map point under `point` where it is.
|
||||
function zoomAt(factor, point) {
|
||||
const next = clampZoom(zoom.value * factor);
|
||||
if (next === zoom.value) return;
|
||||
const ratio = next / zoom.value;
|
||||
pan.value = {
|
||||
x: point.x - (point.x - pan.value.x) * ratio,
|
||||
y: point.y - (point.y - pan.value.y) * ratio
|
||||
};
|
||||
zoom.value = next;
|
||||
}
|
||||
|
||||
function onWheel(event) {
|
||||
const bounds = viewport.value?.getBoundingClientRect();
|
||||
if (!bounds) return;
|
||||
zoomAt(event.deltaY < 0 ? 1.15 : 1 / 1.15, { x: event.clientX - bounds.left, y: event.clientY - bounds.top });
|
||||
}
|
||||
|
||||
function zoomFromToolbar(incoming) {
|
||||
const bounds = viewport.value?.getBoundingClientRect();
|
||||
if (!bounds) return;
|
||||
zoomAt(incoming ? 1.25 : 1 / 1.25, { x: bounds.width / 2, y: bounds.height / 2 });
|
||||
}
|
||||
|
||||
let pointerId = null;
|
||||
let lastPointer = { x: 0, y: 0 };
|
||||
|
||||
function onPointerDown(event) {
|
||||
if (event.button !== 0 || !viewport.value) return;
|
||||
dragging.value = true;
|
||||
pointerId = event.pointerId;
|
||||
lastPointer = { x: event.clientX, y: event.clientY };
|
||||
viewport.value.setPointerCapture?.(event.pointerId);
|
||||
}
|
||||
|
||||
function onPointerMove(event) {
|
||||
if (!dragging.value || event.pointerId !== pointerId) return;
|
||||
pan.value = { x: pan.value.x + (event.clientX - lastPointer.x), y: pan.value.y + (event.clientY - lastPointer.y) };
|
||||
lastPointer = { x: event.clientX, y: event.clientY };
|
||||
}
|
||||
|
||||
function onPointerUp(event) {
|
||||
if (event.pointerId !== pointerId) return;
|
||||
dragging.value = false;
|
||||
pointerId = null;
|
||||
viewport.value?.releasePointerCapture?.(event.pointerId);
|
||||
}
|
||||
|
||||
function editMap() {
|
||||
if (!map.value) return;
|
||||
CreateWindow('create_map', { campaign: campaignId, entry: map.value });
|
||||
}
|
||||
|
||||
function handleMapUpdated({ entityType, entry }) {
|
||||
if (entityType !== 'map' || entry?._id !== map.value?._id) return;
|
||||
const imageChanged = entry.image !== map.value.image;
|
||||
map.value = { ...entry };
|
||||
// A new image is fitted again by onImageLoaded; grid-only changes just move the overlay.
|
||||
if (imageChanged) imageSize.value = { width: 0, height: 0 };
|
||||
}
|
||||
|
||||
onMounted(() => {
|
||||
Top(wrapper);
|
||||
SetupHandle(id, handle);
|
||||
SetSize(id, {
|
||||
width: Math.max(480, Math.min(1100, window.innerWidth - 24)),
|
||||
height: Math.max(360, Math.min(760, window.innerHeight - 32))
|
||||
});
|
||||
ResetPosition(id, 'center');
|
||||
emitter.on('campaign-entry-updated', handleMapUpdated);
|
||||
});
|
||||
|
||||
onBeforeUnmount(() => {
|
||||
emitter.off('campaign-entry-updated', handleMapUpdated);
|
||||
});
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<div class="window-wrapper viewer-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||
<WindowHandle :window="id" ref="handle" />
|
||||
<div class="viewer-bar">
|
||||
<div class="viewer-identity">
|
||||
<strong>{{ map?.name }}</strong>
|
||||
<span class="viewer-meta">{{ $t('campaigns.map.summary', { size: map?.gridSize, scale: map?.scale }) }}</span>
|
||||
</div>
|
||||
<div class="viewer-tools">
|
||||
<button class="viewer-tool" :class="{ selected: showGrid }" type="button" :title="$t('campaigns.map.toggle-grid')"
|
||||
:aria-label="$t('campaigns.map.toggle-grid')" :aria-pressed="showGrid.toString()" @click="showGrid = !showGrid">
|
||||
<img class="tool-icon" src="/icons/iconoir/regular/view-grid.svg" alt="" aria-hidden="true">
|
||||
</button>
|
||||
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-out')" :aria-label="$t('campaigns.map.zoom-out')" @click="zoomFromToolbar(false)">
|
||||
<img class="tool-icon" src="/icons/iconoir/regular/minus.svg" alt="" aria-hidden="true">
|
||||
</button>
|
||||
<span class="zoom-readout">{{ zoomPercent }}</span>
|
||||
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-in')" :aria-label="$t('campaigns.map.zoom-in')" @click="zoomFromToolbar(true)">
|
||||
<img class="tool-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
||||
</button>
|
||||
<button class="viewer-tool" type="button" :title="$t('campaigns.map.fit')" :aria-label="$t('campaigns.map.fit')" @click="fitToWindow">
|
||||
<img class="tool-icon" src="/icons/iconoir/regular/expand.svg" alt="" aria-hidden="true">
|
||||
</button>
|
||||
<button class="viewer-tool" type="button" :title="$t('campaigns.map.edit')" :aria-label="$t('campaigns.map.edit')" @click="editMap">
|
||||
<img class="tool-icon" src="/icons/iconoir/regular/edit.svg" alt="" aria-hidden="true">
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div
|
||||
ref="viewport"
|
||||
class="map-viewport"
|
||||
:class="{ dragging }"
|
||||
@wheel.prevent="onWheel"
|
||||
@pointerdown="onPointerDown"
|
||||
@pointermove="onPointerMove"
|
||||
@pointerup="onPointerUp"
|
||||
@pointercancel="onPointerUp"
|
||||
>
|
||||
<template v-if="imageUrl">
|
||||
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
|
||||
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
|
||||
</template>
|
||||
<div v-else class="map-empty">
|
||||
{{ $t('campaigns.map.no-image') }}
|
||||
<button class="map-edit" type="button" @click="editMap">{{ $t('campaigns.map.upload-photo') }}</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<style scoped>
|
||||
.viewer-window { min-width: 320px; min-height: 0; }
|
||||
.viewer-bar { width: 100%; box-sizing: border-box; display: flex; align-items: center; justify-content: space-between; gap: 10px; padding: 8px 10px; border-bottom: 1px solid var(--color-border); background: var(--color-background-light); }
|
||||
.viewer-identity { min-width: 0; display: flex; flex-direction: column; gap: 2px; }
|
||||
.viewer-identity strong { font-family: MrEavesRemake; overflow-wrap: anywhere; }
|
||||
.viewer-meta { font-size: 11px; opacity: .72; }
|
||||
.viewer-tools { display: flex; align-items: center; gap: 4px; }
|
||||
.viewer-tool { width: 30px; height: 30px; margin: 0; padding: 0; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); display: flex; align-items: center; justify-content: center; cursor: pointer; }
|
||||
.viewer-tool:hover { background: var(--color-button-hover); }
|
||||
.viewer-tool.selected { border-color: var(--color-link); background: var(--color-button-hover); }
|
||||
.tool-icon { width: 16px; height: 16px; filter: invert(var(--color-icon-invert)); }
|
||||
.zoom-readout { min-width: 46px; text-align: center; font-size: 12px; }
|
||||
.map-viewport { position: relative; width: 100%; flex: 1; min-height: 0; overflow: hidden; background-color: var(--color-background); cursor: grab; touch-action: none; }
|
||||
.map-viewport.dragging { cursor: grabbing; }
|
||||
.map-image { position: absolute; top: 0; left: 0; max-width: none; transform-origin: top left; user-select: none; }
|
||||
.map-grid { position: absolute; top: 0; left: 0; opacity: .55; pointer-events: none; }
|
||||
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
|
||||
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
|
||||
.map-edit:hover { background: var(--color-button-hover); }
|
||||
</style>
|
||||
@@ -70,18 +70,6 @@ const defWindows = {
|
||||
component: () => import('~/components/windows/CharacterSheetWindow.vue'),
|
||||
close: () => ClearWindow({type: 'character_sheet'}),
|
||||
movable: true
|
||||
},
|
||||
create_map: {
|
||||
title: 'windows.create-map',
|
||||
component: () => import('~/components/windows/CreateMapWindow.vue'),
|
||||
close: () => ClearWindow({type: 'create_map'}),
|
||||
movable: true
|
||||
},
|
||||
map_viewer: {
|
||||
title: 'windows.map-viewer',
|
||||
component: () => import('~/components/windows/MapViewerWindow.vue'),
|
||||
close: () => ClearWindow({type: 'map_viewer'}),
|
||||
movable: true
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
"saved": "S'ha desat la configuració de la campanya.",
|
||||
"linked": "S'ha enllaçat el món de Foundry amb aquesta campanya.",
|
||||
"unlinked": "S'ha desenllaçat el món de Foundry d'aquesta campanya.",
|
||||
"copy-code": "Copia el codi",
|
||||
"code-copied": "S'ha copiat el codi d'enllaç.",
|
||||
"saving": "Desant...",
|
||||
"errors": {
|
||||
@@ -28,7 +29,7 @@
|
||||
},
|
||||
"sidebar-label": "Campanya",
|
||||
"synced": "Sincronitzat",
|
||||
"sections": { "notes": "Notes", "actors": "Actors i personatges", "items": "Objectes", "maps": "Mapes" },
|
||||
"sections": { "notes": "Notes", "actors": "Actors i personatges", "items": "Objectes" },
|
||||
"actions": {
|
||||
"new-note": "Nota nova", "new-folder": "Carpeta nova", "refresh": "Actualitza",
|
||||
"create": "Crea {section}", "submit": "Crea", "edit": "Edita", "save": "Desa", "delete": "Suprimeix", "saving": "Desant...",
|
||||
@@ -36,8 +37,7 @@
|
||||
},
|
||||
"states": {
|
||||
"loading": "Carregant...", "loading-notes": "Carregant notes...", "empty-notes": "Encara no hi ha notes en aquesta campanya.",
|
||||
"empty-actors": "Encara no hi ha actors ni personatges.", "empty-items": "Encara no hi ha objectes en aquesta campanya.",
|
||||
"empty-maps": "Encara no hi ha mapes en aquesta campanya."
|
||||
"empty-actors": "Encara no hi ha actors ni personatges.", "empty-items": "Encara no hi ha objectes en aquesta campanya."
|
||||
},
|
||||
"errors": { "load": "No s'han pogut carregar les entrades de la campanya." },
|
||||
"create-entry": "Crea una entrada de campanya",
|
||||
@@ -58,17 +58,6 @@
|
||||
},
|
||||
"rarities": { "common": "Comuna", "uncommon": "Poc comuna", "rare": "Rara", "very-rare": "Molt rara", "legendary": "Llegendària", "artifact": "Artefacte" }
|
||||
},
|
||||
"map": {
|
||||
"new": "Mapa nou", "edit": "Edita el mapa",
|
||||
"photo": "Imatge del mapa", "upload-photo": "Pujar imatge", "change-photo": "Canviar imatge",
|
||||
"photo-hint": "Una foto o una digitalització del mapa. Es manté la imatge actual si no en tries una de nova.",
|
||||
"grid-size": "Mida de la quadrícula (px)", "offset-x": "Desplaçament X (px)", "offset-y": "Desplaçament Y (px)",
|
||||
"scale": "Escala (distància per cel·la)", "scale-help": "La distància que representa una cel·la de la quadrícula, com ara 5 peus.",
|
||||
"summary": "Quadrícula de {size} px · {scale} per cel·la",
|
||||
"save-error": "No s'ha pogut desar aquest mapa.",
|
||||
"no-image": "Aquest mapa encara no té imatge.",
|
||||
"zoom-in": "Apropar", "zoom-out": "Allunyar", "fit": "Ajustar a la finestra", "toggle-grid": "Mostrar la quadrícula"
|
||||
},
|
||||
"character-sheet": {
|
||||
"title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir",
|
||||
"level": "Nivell", "species": "Espècie", "unset-species": "Espècie sense definir", "edit": "Edita la fitxa", "cancel": "Cancel·la",
|
||||
|
||||
@@ -5,7 +5,5 @@
|
||||
"example": "Finestra d'exemple",
|
||||
"edit-profile": "Editar perfil",
|
||||
"settings": "Configuració",
|
||||
"create-campaign": "Crear campanya",
|
||||
"create-map": "Crear mapa",
|
||||
"map-viewer": "Mapa"
|
||||
"create-campaign": "Crear campanya"
|
||||
}
|
||||
|
||||
@@ -21,6 +21,7 @@
|
||||
"saved": "Campaign settings saved.",
|
||||
"linked": "Foundry world linked to this campaign.",
|
||||
"unlinked": "Foundry world unlinked from this campaign.",
|
||||
"copy-code": "Copy code",
|
||||
"code-copied": "Pairing code copied.",
|
||||
"saving": "Saving...",
|
||||
"errors": {
|
||||
@@ -32,7 +33,7 @@
|
||||
},
|
||||
"sidebar-label": "Campaign",
|
||||
"synced": "Synced",
|
||||
"sections": { "notes": "Notes", "actors": "Actors & Characters", "items": "Items", "maps": "Maps" },
|
||||
"sections": { "notes": "Notes", "actors": "Actors & Characters", "items": "Items" },
|
||||
"actions": {
|
||||
"new-note": "New note", "new-folder": "New folder", "refresh": "Refresh",
|
||||
"create": "Create {section}", "submit": "Create", "edit": "Edit", "save": "Save", "delete": "Delete", "saving": "Saving...",
|
||||
@@ -40,8 +41,7 @@
|
||||
},
|
||||
"states": {
|
||||
"loading": "Loading...", "loading-notes": "Loading notes...", "empty-notes": "No notes in this campaign yet.",
|
||||
"empty-actors": "No actors or characters yet.", "empty-items": "No items in this campaign yet.",
|
||||
"empty-maps": "No maps in this campaign yet."
|
||||
"empty-actors": "No actors or characters yet.", "empty-items": "No items in this campaign yet."
|
||||
},
|
||||
"errors": { "load": "Unable to load campaign entries." },
|
||||
"create-entry": "Create campaign entry",
|
||||
@@ -62,17 +62,6 @@
|
||||
},
|
||||
"rarities": { "common": "Common", "uncommon": "Uncommon", "rare": "Rare", "very-rare": "Very rare", "legendary": "Legendary", "artifact": "Artifact" }
|
||||
},
|
||||
"map": {
|
||||
"new": "New map", "edit": "Edit map",
|
||||
"photo": "Map image", "upload-photo": "Upload image", "change-photo": "Change image",
|
||||
"photo-hint": "A photo or scan of the map. The current image is kept when you do not pick a new one.",
|
||||
"grid-size": "Grid size (px)", "offset-x": "Offset X (px)", "offset-y": "Offset Y (px)",
|
||||
"scale": "Scale (distance per cell)", "scale-help": "How much distance one grid cell stands for, like 5 feet.",
|
||||
"summary": "{size} px grid · {scale} per cell",
|
||||
"save-error": "Unable to save this map.",
|
||||
"no-image": "This map has no image yet.",
|
||||
"zoom-in": "Zoom in", "zoom-out": "Zoom out", "fit": "Fit to window", "toggle-grid": "Show grid"
|
||||
},
|
||||
"character-sheet": {
|
||||
"title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set",
|
||||
"level": "Level", "species": "Species", "unset-species": "Species not set", "edit": "Edit sheet", "cancel": "Cancel",
|
||||
|
||||
@@ -5,7 +5,5 @@
|
||||
"example": "Example Window",
|
||||
"edit-profile": "Edit Profile",
|
||||
"settings": "Settings",
|
||||
"create-campaign": "Create Campaign",
|
||||
"create-map": "Create Map",
|
||||
"map-viewer": "Map"
|
||||
"create-campaign": "Create Campaign"
|
||||
}
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
"saved": "Se han guardado los ajustes de la campaña.",
|
||||
"linked": "El mundo de Foundry se ha vinculado a esta campaña.",
|
||||
"unlinked": "Se ha desvinculado el mundo de Foundry de esta campaña.",
|
||||
"copy-code": "Copiar código",
|
||||
"code-copied": "Código de vinculación copiado.",
|
||||
"saving": "Guardando...",
|
||||
"errors": {
|
||||
@@ -28,7 +29,7 @@
|
||||
},
|
||||
"sidebar-label": "Campaña",
|
||||
"synced": "Sincronizado",
|
||||
"sections": { "notes": "Notas", "actors": "Actores y personajes", "items": "Objetos", "maps": "Mapas" },
|
||||
"sections": { "notes": "Notas", "actors": "Actores y personajes", "items": "Objetos" },
|
||||
"actions": {
|
||||
"new-note": "Nueva nota", "new-folder": "Nueva carpeta", "refresh": "Actualizar",
|
||||
"create": "Crear {section}", "submit": "Crear", "edit": "Editar", "save": "Guardar", "delete": "Eliminar", "saving": "Guardando...",
|
||||
@@ -36,8 +37,7 @@
|
||||
},
|
||||
"states": {
|
||||
"loading": "Cargando...", "loading-notes": "Cargando notas...", "empty-notes": "Aún no hay notas en esta campaña.",
|
||||
"empty-actors": "Aún no hay actores ni personajes.", "empty-items": "Aún no hay objetos en esta campaña.",
|
||||
"empty-maps": "Aún no hay mapas en esta campaña."
|
||||
"empty-actors": "Aún no hay actores ni personajes.", "empty-items": "Aún no hay objetos en esta campaña."
|
||||
},
|
||||
"errors": { "load": "No se pudieron cargar las entradas de la campaña." },
|
||||
"create-entry": "Crear entrada de campaña",
|
||||
@@ -58,17 +58,6 @@
|
||||
},
|
||||
"rarities": { "common": "Común", "uncommon": "Poco común", "rare": "Raro", "very-rare": "Muy raro", "legendary": "Legendario", "artifact": "Artefacto" }
|
||||
},
|
||||
"map": {
|
||||
"new": "Nuevo mapa", "edit": "Editar mapa",
|
||||
"photo": "Imagen del mapa", "upload-photo": "Subir imagen", "change-photo": "Cambiar imagen",
|
||||
"photo-hint": "Una foto o un escaneo del mapa. Se mantiene la imagen actual si no eliges una nueva.",
|
||||
"grid-size": "Tamaño de la cuadrícula (px)", "offset-x": "Desplazamiento X (px)", "offset-y": "Desplazamiento Y (px)",
|
||||
"scale": "Escala (distancia por celda)", "scale-help": "La distancia que representa una celda de la cuadrícula, como 5 pies.",
|
||||
"summary": "Cuadrícula de {size} px · {scale} por celda",
|
||||
"save-error": "No se pudo guardar este mapa.",
|
||||
"no-image": "Este mapa aún no tiene imagen.",
|
||||
"zoom-in": "Acercar", "zoom-out": "Alejar", "fit": "Ajustar a la ventana", "toggle-grid": "Mostrar cuadrícula"
|
||||
},
|
||||
"character-sheet": {
|
||||
"title": "Hoja de personaje", "name": "Nombre del personaje", "class": "Clase", "subclass": "Subclase", "unset-class": "Clase sin definir",
|
||||
"level": "Nivel", "species": "Especie", "unset-species": "Especie sin definir", "edit": "Editar hoja", "cancel": "Cancelar",
|
||||
|
||||
@@ -5,7 +5,5 @@
|
||||
"example": "Ventana de ejemplo",
|
||||
"edit-profile": "Editar perfil",
|
||||
"settings": "Configuración",
|
||||
"create-campaign": "Crear campanya",
|
||||
"create-map": "Crear mapa",
|
||||
"map-viewer": "Mapa"
|
||||
"create-campaign": "Crear campanya"
|
||||
}
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
# Dragonroll Sync for Obsidian
|
||||
|
||||
An Obsidian community plugin that imports notes from a Dragonroll campaign and pushes the active
|
||||
Markdown note back to Dragonroll.
|
||||
|
||||
## Install from this repository
|
||||
|
||||
Copy `main.js` and `manifest.json` into:
|
||||
|
||||
```text
|
||||
<vault>/.obsidian/plugins/dragonroll-sync/
|
||||
```
|
||||
|
||||
Then enable **Dragonroll Sync** in Obsidian's Community Plugins settings. The plugin is plain
|
||||
JavaScript and does not need a build step.
|
||||
|
||||
## Connect your account
|
||||
|
||||
Open **Settings → Community plugins → Dragonroll Sync**, enter the Dragonroll API URL and sign in
|
||||
with your Dragonroll username/email and password. The default API URL is
|
||||
`https://dragonroll.aranroig.com/api`; a local server can use `http://localhost:5000/api`.
|
||||
Choose a campaign after signing in. The plugin saves the Dragonroll session token in this vault;
|
||||
Dragonroll sessions expire after 48 hours. The password is not saved.
|
||||
|
||||
## Commands
|
||||
|
||||
- **Import or refresh campaign notes** fetches all campaign notes, including notes inside nested
|
||||
Dragonroll folders, into `Dragonroll/<Campaign>/`. Imported notes keep their folder hierarchy.
|
||||
- **Push active note to Dragonroll** creates the active Markdown note as a root campaign note, or
|
||||
updates its linked Dragonroll note. A note linked to a different campaign cannot be pushed while
|
||||
another campaign is selected.
|
||||
|
||||
The import command adds `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` properties to
|
||||
each imported note's frontmatter. These properties link the local file to its remote record and are
|
||||
omitted from the Markdown content sent back to Dragonroll. Pushing a new local note adds those
|
||||
properties as well.
|
||||
|
||||
Import protects local edits. It updates a linked note only when the local copy still matches the
|
||||
last imported/pushed version. If the local copy changed, or both copies changed since the last sync,
|
||||
the plugin keeps the local file and reports it for review. Push is explicit and updates Dragonroll
|
||||
with the active note's current title and content.
|
||||
|
||||
This is an explicit import/push workflow; it does not sync in the background or delete notes.
|
||||
@@ -1,497 +0,0 @@
|
||||
const {
|
||||
Notice,
|
||||
Plugin,
|
||||
PluginSettingTab,
|
||||
Setting,
|
||||
normalizePath,
|
||||
requestUrl,
|
||||
} = require('obsidian');
|
||||
|
||||
const DEFAULT_SETTINGS = {
|
||||
apiBaseUrl: 'https://dragonroll.aranroig.com/api',
|
||||
token: '',
|
||||
campaignId: '',
|
||||
snapshots: {},
|
||||
};
|
||||
|
||||
const NOTE_ID_PROPERTY = 'dragonrollId';
|
||||
const CAMPAIGN_PROPERTY = 'dragonrollCampaign';
|
||||
const REMOTE_TITLE_PROPERTY = 'dragonrollTitle';
|
||||
|
||||
module.exports = class DragonrollSyncPlugin extends Plugin {
|
||||
async onload() {
|
||||
await this.loadSettings();
|
||||
|
||||
this.status = this.addStatusBarItem();
|
||||
this.updateStatus();
|
||||
this.addRibbonIcon('refresh-cw', 'Import Dragonroll campaign notes', () => this.importCampaignNotes());
|
||||
this.addCommand({
|
||||
id: 'import-campaign-notes',
|
||||
name: 'Import or refresh campaign notes',
|
||||
callback: () => this.importCampaignNotes(),
|
||||
});
|
||||
this.addCommand({
|
||||
id: 'push-active-note',
|
||||
name: 'Push active note to Dragonroll',
|
||||
checkCallback: (checking) => {
|
||||
const file = this.app.workspace.getActiveFile();
|
||||
if (!file || file.extension !== 'md') return false;
|
||||
if (!checking) void this.pushActiveNote();
|
||||
return true;
|
||||
},
|
||||
});
|
||||
this.addSettingTab(new DragonrollSettingTab(this.app, this));
|
||||
|
||||
if (this.settings.token && this.settings.campaignId) {
|
||||
this.status.setText('Dragonroll: ready');
|
||||
}
|
||||
}
|
||||
|
||||
async loadSettings() {
|
||||
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
|
||||
if (!this.settings.snapshots || typeof this.settings.snapshots !== 'object') {
|
||||
this.settings.snapshots = {};
|
||||
}
|
||||
}
|
||||
|
||||
async saveSettings() {
|
||||
await this.saveData(this.settings);
|
||||
this.updateStatus();
|
||||
}
|
||||
|
||||
updateStatus() {
|
||||
if (!this.status) return;
|
||||
if (!this.settings.token) this.status.setText('Dragonroll: signed out');
|
||||
else if (!this.settings.campaignId) this.status.setText('Dragonroll: choose campaign');
|
||||
else this.status.setText('Dragonroll: ready');
|
||||
}
|
||||
|
||||
apiBaseUrl() {
|
||||
let url = String(this.settings.apiBaseUrl || '').trim().replace(/\/+$/, '');
|
||||
if (!url) throw new Error('Enter the Dragonroll API URL in settings.');
|
||||
if (!/\/api$/i.test(url)) url += '/api';
|
||||
return url;
|
||||
}
|
||||
|
||||
async request(path, { method = 'GET', body, authenticated = true } = {}) {
|
||||
const headers = { Accept: 'application/json' };
|
||||
if (authenticated && this.settings.token) {
|
||||
headers.Authorization = `Bearer ${this.settings.token}`;
|
||||
}
|
||||
if (body !== undefined) headers['Content-Type'] = 'application/json';
|
||||
|
||||
let response;
|
||||
try {
|
||||
response = await requestUrl({
|
||||
url: `${this.apiBaseUrl()}${path}`,
|
||||
method,
|
||||
headers,
|
||||
body: body === undefined ? undefined : JSON.stringify(body),
|
||||
throw: false,
|
||||
});
|
||||
} catch (error) {
|
||||
throw new Error(`Could not reach Dragonroll: ${error.message || error}`);
|
||||
}
|
||||
|
||||
let data;
|
||||
try {
|
||||
data = response.json;
|
||||
} catch {
|
||||
throw new Error(`Dragonroll returned an unreadable response (HTTP ${response.status}).`);
|
||||
}
|
||||
if (response.status < 200 || response.status >= 300 || data?.status !== 'ok') {
|
||||
const message = data?.msg || `HTTP ${response.status}`;
|
||||
if (response.status === 401 || message === 'unauthorized') {
|
||||
throw new Error('Dragonroll rejected this session. Sign in again in plugin settings.');
|
||||
}
|
||||
throw new Error(`Dragonroll: ${message}`);
|
||||
}
|
||||
return data;
|
||||
}
|
||||
|
||||
async login(usermail, password) {
|
||||
const data = await this.request('/user/login', {
|
||||
method: 'POST',
|
||||
body: { usermail, password },
|
||||
authenticated: false,
|
||||
});
|
||||
this.settings.token = data.token;
|
||||
this.settings.campaignId = '';
|
||||
await this.saveSettings();
|
||||
return this.getCampaigns();
|
||||
}
|
||||
|
||||
async getCampaigns() {
|
||||
const data = await this.request('/campaign/list');
|
||||
return data.campaigns || [];
|
||||
}
|
||||
|
||||
async selectedCampaign() {
|
||||
if (!this.settings.token) throw new Error('Sign in to Dragonroll in plugin settings first.');
|
||||
if (!this.settings.campaignId) throw new Error('Choose a campaign in plugin settings first.');
|
||||
const campaigns = await this.getCampaigns();
|
||||
const campaign = campaigns.find((item) => String(item._id) === String(this.settings.campaignId));
|
||||
if (!campaign) throw new Error('The selected campaign is unavailable. Choose a campaign in settings.');
|
||||
return campaign;
|
||||
}
|
||||
|
||||
async fetchCampaignNotes(campaignId) {
|
||||
const root = await this.request(`/note/list?campaign=${encodeURIComponent(campaignId)}`);
|
||||
const folders = root.folders || [];
|
||||
const folderById = new Map(folders.map((folder) => [String(folder._id), folder]));
|
||||
const pathCache = new Map();
|
||||
|
||||
const folderPath = (folderId, visiting = new Set()) => {
|
||||
const id = String(folderId || '');
|
||||
if (!id || !folderById.has(id)) return [];
|
||||
if (pathCache.has(id)) return pathCache.get(id);
|
||||
if (visiting.has(id)) return [];
|
||||
const folder = folderById.get(id);
|
||||
const nextVisiting = new Set(visiting);
|
||||
nextVisiting.add(id);
|
||||
const parent = folder.parentFolder ? String(folder.parentFolder) : '';
|
||||
const path = [...folderPath(parent, nextVisiting), safeSegment(folder.name, 'Folder')];
|
||||
pathCache.set(id, path);
|
||||
return path;
|
||||
};
|
||||
|
||||
const nestedResults = await Promise.all(folders.map(async (folder) => {
|
||||
const data = await this.request(
|
||||
`/note/subfolder/list?campaign=${encodeURIComponent(campaignId)}&folder=${encodeURIComponent(folder._id)}`
|
||||
);
|
||||
return (data.notes || []).map((note) => ({ note, folders: folderPath(folder._id) }));
|
||||
}));
|
||||
|
||||
const notes = (root.notes || []).map((note) => ({ note, folders: [] }));
|
||||
for (const result of nestedResults) notes.push(...result);
|
||||
return notes;
|
||||
}
|
||||
|
||||
async importCampaignNotes() {
|
||||
try {
|
||||
const campaign = await this.selectedCampaign();
|
||||
const notes = await this.fetchCampaignNotes(campaign._id);
|
||||
const existingById = await this.findFilesByDragonrollId();
|
||||
const baseFolder = normalizePath(`Dragonroll/${safeSegment(campaign.name, 'Campaign')}`);
|
||||
let created = 0;
|
||||
let updated = 0;
|
||||
let unchanged = 0;
|
||||
let protectedNotes = 0;
|
||||
|
||||
for (const entry of notes) {
|
||||
const remote = entry.note;
|
||||
const id = String(remote._id);
|
||||
const title = String(remote.title || 'Untitled');
|
||||
const content = String(remote.content || '');
|
||||
const remoteSignature = await signature(title, content);
|
||||
const file = existingById.get(id);
|
||||
|
||||
if (!file) {
|
||||
const targetFolder = normalizePath([baseFolder, ...entry.folders].join('/'));
|
||||
await this.ensureFolder(targetFolder);
|
||||
const path = await this.availableMarkdownPath(targetFolder, title, id);
|
||||
const newFile = await this.app.vault.create(path, content);
|
||||
await this.setNoteIdentity(newFile, id, campaign._id, title);
|
||||
this.settings.snapshots[id] = remoteSignature;
|
||||
created += 1;
|
||||
continue;
|
||||
}
|
||||
|
||||
const localContent = await this.app.vault.read(file);
|
||||
const frontmatter = this.app.metadataCache.getFileCache(file)?.frontmatter || {};
|
||||
const storedTitle = frontmatter[REMOTE_TITLE_PROPERTY];
|
||||
const localTitle = storedTitle && safeSegment(storedTitle, 'Untitled') === file.basename
|
||||
? String(storedTitle)
|
||||
: file.basename;
|
||||
const localSignature = await signature(localTitle, stripPluginMetadata(localContent));
|
||||
const baseline = this.settings.snapshots[id];
|
||||
|
||||
if (!baseline) {
|
||||
if (localSignature === remoteSignature) {
|
||||
this.settings.snapshots[id] = remoteSignature;
|
||||
unchanged += 1;
|
||||
} else {
|
||||
protectedNotes += 1;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
const localChanged = localSignature !== baseline;
|
||||
const remoteChanged = remoteSignature !== baseline;
|
||||
if (localChanged && remoteChanged) {
|
||||
protectedNotes += 1;
|
||||
continue;
|
||||
}
|
||||
if (localChanged) {
|
||||
protectedNotes += 1;
|
||||
continue;
|
||||
}
|
||||
if (!remoteChanged) {
|
||||
unchanged += 1;
|
||||
continue;
|
||||
}
|
||||
|
||||
await this.app.vault.modify(file, content);
|
||||
await this.setNoteIdentity(file, id, campaign._id, title);
|
||||
const renamed = await this.renameImportedFile(file, title, id);
|
||||
this.settings.snapshots[id] = remoteSignature;
|
||||
updated += 1;
|
||||
if (renamed) existingById.set(id, renamed);
|
||||
}
|
||||
|
||||
await this.saveSettings();
|
||||
const details = protectedNotes ? `; ${protectedNotes} local edit(s) kept for review` : '';
|
||||
new Notice(`Dragonroll import: ${created} added, ${updated} updated, ${unchanged} unchanged${details}.`);
|
||||
} catch (error) {
|
||||
new Notice(error.message || 'Could not import Dragonroll notes.');
|
||||
}
|
||||
}
|
||||
|
||||
async pushActiveNote() {
|
||||
try {
|
||||
const campaign = await this.selectedCampaign();
|
||||
const file = this.app.workspace.getActiveFile();
|
||||
if (!file || file.extension !== 'md') throw new Error('Open a Markdown note to push it.');
|
||||
|
||||
const cache = this.app.metadataCache.getFileCache(file);
|
||||
const frontmatter = cache?.frontmatter || {};
|
||||
const linkedCampaign = frontmatter[CAMPAIGN_PROPERTY];
|
||||
const noteId = frontmatter[NOTE_ID_PROPERTY];
|
||||
if (noteId && String(linkedCampaign || '') !== String(campaign._id)) {
|
||||
throw new Error('This note is linked to another Dragonroll campaign. Select that campaign to push it.');
|
||||
}
|
||||
|
||||
const markdown = stripPluginMetadata(await this.app.vault.read(file));
|
||||
let remote;
|
||||
if (noteId) {
|
||||
const data = await this.request('/note/update', {
|
||||
method: 'POST',
|
||||
body: { id: String(noteId), title: file.basename, content: markdown },
|
||||
});
|
||||
remote = data.note;
|
||||
} else {
|
||||
const data = await this.request('/note/create', {
|
||||
method: 'POST',
|
||||
body: { title: file.basename, content: markdown, campaign: campaign._id },
|
||||
});
|
||||
remote = data.note;
|
||||
}
|
||||
|
||||
const id = String(remote._id || noteId);
|
||||
await this.setNoteIdentity(file, id, campaign._id, file.basename);
|
||||
this.settings.snapshots[id] = await signature(file.basename, markdown);
|
||||
await this.saveSettings();
|
||||
new Notice(`Pushed “${file.basename}” to Dragonroll.`);
|
||||
} catch (error) {
|
||||
new Notice(error.message || 'Could not push this note to Dragonroll.');
|
||||
}
|
||||
}
|
||||
|
||||
async findFilesByDragonrollId() {
|
||||
const result = new Map();
|
||||
for (const file of this.app.vault.getMarkdownFiles()) {
|
||||
const frontmatter = this.app.metadataCache.getFileCache(file)?.frontmatter;
|
||||
const id = frontmatter?.[NOTE_ID_PROPERTY];
|
||||
if (id && !result.has(String(id))) result.set(String(id), file);
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
async setNoteIdentity(file, noteId, campaignId, title) {
|
||||
await this.app.fileManager.processFrontMatter(file, (frontmatter) => {
|
||||
frontmatter[NOTE_ID_PROPERTY] = String(noteId);
|
||||
frontmatter[CAMPAIGN_PROPERTY] = String(campaignId);
|
||||
frontmatter[REMOTE_TITLE_PROPERTY] = String(title || file.basename);
|
||||
});
|
||||
}
|
||||
|
||||
async ensureFolder(path) {
|
||||
const normalized = normalizePath(path);
|
||||
if (!normalized || normalized === '.') return;
|
||||
const parts = normalized.split('/');
|
||||
let current = '';
|
||||
for (const part of parts) {
|
||||
current = current ? `${current}/${part}` : part;
|
||||
if (!this.app.vault.getAbstractFileByPath(current)) {
|
||||
await this.app.vault.createFolder(current);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
async availableMarkdownPath(folder, title, noteId) {
|
||||
const base = safeSegment(title, 'Untitled');
|
||||
let path = normalizePath(`${folder}/${base}.md`);
|
||||
if (!this.app.vault.getAbstractFileByPath(path)) return path;
|
||||
const suffix = String(noteId).slice(-6);
|
||||
path = normalizePath(`${folder}/${base} (${suffix}).md`);
|
||||
let counter = 2;
|
||||
while (this.app.vault.getAbstractFileByPath(path)) {
|
||||
path = normalizePath(`${folder}/${base} (${suffix}-${counter}).md`);
|
||||
counter += 1;
|
||||
}
|
||||
return path;
|
||||
}
|
||||
|
||||
async renameImportedFile(file, title, noteId) {
|
||||
const parent = file.parent?.path || '';
|
||||
const base = safeSegment(title, 'Untitled');
|
||||
let targetPath = normalizePath(parent ? `${parent}/${base}.md` : `${base}.md`);
|
||||
if (targetPath === file.path) return file;
|
||||
if (this.app.vault.getAbstractFileByPath(targetPath)) {
|
||||
targetPath = await this.availableMarkdownPath(parent || '.', title, noteId);
|
||||
}
|
||||
await this.app.fileManager.renameFile(file, targetPath);
|
||||
return this.app.vault.getAbstractFileByPath(targetPath);
|
||||
}
|
||||
};
|
||||
|
||||
class DragonrollSettingTab extends PluginSettingTab {
|
||||
constructor(app, plugin) {
|
||||
super(app, plugin);
|
||||
this.plugin = plugin;
|
||||
this.campaigns = [];
|
||||
this.loginName = '';
|
||||
this.password = '';
|
||||
}
|
||||
|
||||
display() {
|
||||
const { containerEl } = this;
|
||||
containerEl.empty();
|
||||
containerEl.createEl('h2', { text: 'Dragonroll Sync' });
|
||||
containerEl.createEl('p', {
|
||||
text: 'Sign in with your Dragonroll account, choose a campaign, then use the import and push commands. Your password is used only to sign in; the 48-hour session token is stored in this vault.',
|
||||
});
|
||||
|
||||
new Setting(containerEl)
|
||||
.setName('Dragonroll API URL')
|
||||
.setDesc('Use the server address, with or without /api.')
|
||||
.addText((text) => text
|
||||
.setPlaceholder('https://dragonroll.aranroig.com/api')
|
||||
.setValue(this.plugin.settings.apiBaseUrl)
|
||||
.onChange(async (value) => {
|
||||
const previous = this.plugin.settings.apiBaseUrl.trim().replace(/\/+$/, '');
|
||||
const next = value.trim().replace(/\/+$/, '');
|
||||
if (previous !== next) {
|
||||
this.plugin.settings.token = '';
|
||||
this.plugin.settings.campaignId = '';
|
||||
this.campaigns = [];
|
||||
}
|
||||
this.plugin.settings.apiBaseUrl = value.trim();
|
||||
await this.plugin.saveSettings();
|
||||
}));
|
||||
|
||||
new Setting(containerEl)
|
||||
.setName('Username or email')
|
||||
.addText((text) => text
|
||||
.setPlaceholder('Dragonroll username or email')
|
||||
.onChange((value) => { this.loginName = value.trim(); }));
|
||||
|
||||
new Setting(containerEl)
|
||||
.setName('Password')
|
||||
.addText((text) => {
|
||||
text.inputEl.type = 'password';
|
||||
text.inputEl.autocomplete = 'off';
|
||||
text.onChange((value) => { this.password = value; });
|
||||
});
|
||||
|
||||
new Setting(containerEl)
|
||||
.setName(this.plugin.settings.token ? 'Session' : 'Sign in')
|
||||
.setDesc(this.plugin.settings.token ? 'The stored session expires after 48 hours.' : 'Password is not saved by this plugin.')
|
||||
.addButton((button) => button
|
||||
.setButtonText('Sign in')
|
||||
.setCta()
|
||||
.onClick(async () => {
|
||||
if (!this.loginName || !this.password) {
|
||||
new Notice('Enter your Dragonroll username/email and password.');
|
||||
return;
|
||||
}
|
||||
button.setDisabled(true);
|
||||
try {
|
||||
this.campaigns = await this.plugin.login(this.loginName, this.password);
|
||||
this.password = '';
|
||||
this.display();
|
||||
new Notice(`Signed in. Found ${this.campaigns.length} campaign(s).`);
|
||||
} catch (error) {
|
||||
new Notice(error.message || 'Could not sign in to Dragonroll.');
|
||||
} finally {
|
||||
button.setDisabled(false);
|
||||
}
|
||||
}));
|
||||
|
||||
if (this.plugin.settings.token) {
|
||||
new Setting(containerEl)
|
||||
.setName('Campaign')
|
||||
.setDesc('The campaign used by import and push commands.')
|
||||
.addDropdown((dropdown) => {
|
||||
dropdown.addOption('', 'Choose a campaign');
|
||||
for (const campaign of this.campaigns) {
|
||||
dropdown.addOption(String(campaign._id), campaign.name);
|
||||
}
|
||||
dropdown.setValue(this.plugin.settings.campaignId || '');
|
||||
dropdown.onChange(async (value) => {
|
||||
this.plugin.settings.campaignId = value;
|
||||
await this.plugin.saveSettings();
|
||||
});
|
||||
})
|
||||
.addButton((button) => button
|
||||
.setButtonText('Load campaigns')
|
||||
.onClick(async () => {
|
||||
button.setDisabled(true);
|
||||
try {
|
||||
this.campaigns = await this.plugin.getCampaigns();
|
||||
this.display();
|
||||
new Notice(`Loaded ${this.campaigns.length} campaign(s).`);
|
||||
} catch (error) {
|
||||
new Notice(error.message || 'Could not load campaigns.');
|
||||
} finally {
|
||||
button.setDisabled(false);
|
||||
}
|
||||
}));
|
||||
|
||||
new Setting(containerEl)
|
||||
.setName('Sign out')
|
||||
.setDesc('Remove the saved Dragonroll session from this vault.')
|
||||
.addButton((button) => button
|
||||
.setButtonText('Sign out')
|
||||
.onClick(async () => {
|
||||
this.plugin.settings.token = '';
|
||||
this.plugin.settings.campaignId = '';
|
||||
await this.plugin.saveSettings();
|
||||
this.display();
|
||||
}));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
function safeSegment(value, fallback) {
|
||||
const safe = String(value || '')
|
||||
.replace(/[\\\/:*?"<>|#^\[\]]/g, '-')
|
||||
.replace(/[. ]+$/g, '')
|
||||
.trim();
|
||||
return safe || fallback;
|
||||
}
|
||||
|
||||
function stripPluginMetadata(markdown) {
|
||||
const text = String(markdown || '');
|
||||
const match = text.match(/^(---\r?\n)([\s\S]*?)(\r?\n---(?:\r?\n|$))/);
|
||||
if (!match) return text;
|
||||
const keptLines = match[2].split(/\r?\n/).filter((line) =>
|
||||
!/^(dragonrollId|dragonrollCampaign|dragonrollTitle):\s*/.test(line)
|
||||
);
|
||||
const frontmatter = keptLines.join('\n').trim();
|
||||
const body = text.slice(match[0].length);
|
||||
return frontmatter ? `---\n${frontmatter}\n---\n${body}` : body;
|
||||
}
|
||||
|
||||
async function signature(title, content) {
|
||||
const value = `${title}\u0000${String(content).replace(/\r\n/g, '\n')}`;
|
||||
if (globalThis.crypto?.subtle) {
|
||||
const digest = await globalThis.crypto.subtle.digest('SHA-256', new TextEncoder().encode(value));
|
||||
return Array.from(new Uint8Array(digest), (byte) => byte.toString(16).padStart(2, '0')).join('');
|
||||
}
|
||||
let hash = 2166136261;
|
||||
for (let index = 0; index < value.length; index += 1) {
|
||||
hash = Math.imul(hash ^ value.charCodeAt(index), 16777619);
|
||||
}
|
||||
return (hash >>> 0).toString(16);
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
{
|
||||
"id": "dragonroll-sync",
|
||||
"name": "Dragonroll Sync",
|
||||
"version": "1.0.0",
|
||||
"minAppVersion": "1.5.0",
|
||||
"description": "Import Dragonroll campaign notes into Obsidian and push edits back.",
|
||||
"author": "Dragonroll",
|
||||
"isDesktopOnly": false
|
||||
}
|
||||
@@ -3,6 +3,7 @@
|
||||
"concurrently": "^9.2.1"
|
||||
},
|
||||
"scripts": {
|
||||
"dev": "concurrently -k -n BACKEND,FRONTEND,DISCORD-BOT,FOUNDRY -c blue,green,yellow,magenta \"DEBUG=* npm --prefix backend run dev\" \"npm --prefix frontend run dev\" \"npm --prefix discord-bot start\" \"node scripts/run-foundry.js\""
|
||||
"dev": "concurrently -k -n BACKEND,FRONTEND,DISCORD-BOT,FOUNDRY -c blue,green,yellow,magenta \"DEBUG=* npm --prefix backend run dev\" \"npm --prefix frontend run dev\" \"npm --prefix discord-bot start\" \"node scripts/run-foundry.js\"",
|
||||
"test": "node --test tests/"
|
||||
}
|
||||
}
|
||||
|
||||
309
tests/foundry-sync-toggle.test.js
Normal file
309
tests/foundry-sync-toggle.test.js
Normal file
@@ -0,0 +1,309 @@
|
||||
// Tests for the Dragonroll Foundry module's sync toggle and per-actor force sync
|
||||
// (Syndria98/dragonroll#8). The module is a Foundry client script with no module
|
||||
// wrapper, so it is loaded into a `node:vm` context holding stubbed Foundry
|
||||
// globals (`game`, `Hooks`, `ui`, `fetch`) with fake timers: that makes every
|
||||
// queued push, retry and reconcile observable without a running Foundry VTT.
|
||||
//
|
||||
// Run with `npm test` from the repository root, or `node --test tests/`.
|
||||
|
||||
const { test } = require("node:test");
|
||||
const assert = require("node:assert/strict");
|
||||
const fs = require("node:fs");
|
||||
const path = require("node:path");
|
||||
const vm = require("node:vm");
|
||||
|
||||
const MODULE_ID = "dragonroll-foundry";
|
||||
const MODULE_SOURCE = fs.readFileSync(
|
||||
path.join(__dirname, "..", "dragonroll-foundry", "scripts", "api.js"),
|
||||
"utf8",
|
||||
);
|
||||
|
||||
function stubDocument(id, name, extra = {}) {
|
||||
return {
|
||||
id,
|
||||
name,
|
||||
flags: {},
|
||||
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||
async update(data) {
|
||||
for (const [key, value] of Object.entries(data)) {
|
||||
const parts = key.split(".");
|
||||
const last = parts.pop();
|
||||
let target = this;
|
||||
for (const part of parts) target = target[part] ??= {};
|
||||
target[last] = value;
|
||||
}
|
||||
return this;
|
||||
},
|
||||
toObject() {
|
||||
return {
|
||||
_id: this.id,
|
||||
name: this.name,
|
||||
type: this.type,
|
||||
img: "icons/svg/mystery-man.svg",
|
||||
flags: this.flags,
|
||||
...(this.system ? { system: this.system } : {}),
|
||||
};
|
||||
},
|
||||
...extra,
|
||||
};
|
||||
}
|
||||
|
||||
function makeWorldItem(id, name) {
|
||||
return stubDocument(id, name, {
|
||||
documentName: "Item",
|
||||
type: "weapon",
|
||||
parent: null,
|
||||
system: { properties: { value: [] }, quantity: 1, weight: 3, rarity: "common" },
|
||||
});
|
||||
}
|
||||
|
||||
function makeStubWorld({ autoSync = true } = {}) {
|
||||
const state = {
|
||||
hooks: new Map(),
|
||||
registered: new Map(),
|
||||
requests: [],
|
||||
notifications: [],
|
||||
timers: new Map(),
|
||||
nextTimerId: 1,
|
||||
};
|
||||
|
||||
const actors = [
|
||||
stubDocument("actor-1", "Thalia", { documentName: "Actor", type: "character", items: { contents: [] } }),
|
||||
stubDocument("actor-2", "Grunt", { documentName: "Actor", type: "npc", items: { contents: [] } }),
|
||||
];
|
||||
const settingsStore = {
|
||||
autoSync,
|
||||
syncToken: "sync-token-1",
|
||||
dragonrollApiUrl: "http://backend.test:5000",
|
||||
};
|
||||
|
||||
const sandbox = {
|
||||
console: { log() {}, info() {}, warn() {}, error() {} },
|
||||
URL,
|
||||
CONFIG: {},
|
||||
window: { location: { origin: "http://vtt.test" } },
|
||||
ui: {
|
||||
notifications: {
|
||||
info: (text) => state.notifications.push(["info", text]),
|
||||
warn: (text) => state.notifications.push(["warn", text]),
|
||||
error: (text) => state.notifications.push(["error", text]),
|
||||
},
|
||||
},
|
||||
Hooks: {
|
||||
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||
on(name, fn) {
|
||||
const handlers = state.hooks.get(name) || [];
|
||||
handlers.push(fn);
|
||||
state.hooks.set(name, handlers);
|
||||
},
|
||||
},
|
||||
// Fake timers: the module debounces and retries with setTimeout, so the tests
|
||||
// decide when those callbacks run instead of waiting on the wall clock.
|
||||
setTimeout: (fn, delay = 0) => {
|
||||
const id = state.nextTimerId++;
|
||||
state.timers.set(id, { fn, delay });
|
||||
return id;
|
||||
},
|
||||
clearTimeout: (id) => state.timers.delete(id),
|
||||
setInterval: () => 0,
|
||||
clearInterval: () => {},
|
||||
fetch: async (url, options = {}) => {
|
||||
state.requests.push({
|
||||
href: String(url),
|
||||
method: options.method,
|
||||
body: options.body ? JSON.parse(options.body) : null,
|
||||
});
|
||||
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||
},
|
||||
Actor: { async create() { return null; } },
|
||||
Item: { async create() { return null; } },
|
||||
};
|
||||
|
||||
sandbox.game = {
|
||||
user: { isGM: true },
|
||||
world: { id: "world-1", title: "Test World" },
|
||||
system: { id: "dnd5e" },
|
||||
modules: { get: () => ({}) },
|
||||
actors: { contents: actors, get: (id) => actors.find((actor) => actor.id === id) },
|
||||
items: { contents: [], get: () => null },
|
||||
settings: {
|
||||
register(module, key, definition) {
|
||||
state.registered.set(key, definition);
|
||||
if (!(key in settingsStore)) settingsStore[key] = definition.default;
|
||||
},
|
||||
get(module, key) { return settingsStore[key]; },
|
||||
async set(module, key, value) {
|
||||
settingsStore[key] = value;
|
||||
await state.registered.get(key)?.onChange?.(value);
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
vm.createContext(sandbox);
|
||||
vm.runInContext(MODULE_SOURCE, sandbox);
|
||||
|
||||
state.game = sandbox.game;
|
||||
state.actor = (id) => actors.find((document) => document.id === id);
|
||||
state.syncRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync"));
|
||||
|
||||
state.fire = async (name, ...args) => {
|
||||
for (const handler of state.hooks.get(name) || []) await handler(...args);
|
||||
await drain();
|
||||
};
|
||||
|
||||
state.runTimers = async () => {
|
||||
for (let round = 0; round < 6; round += 1) {
|
||||
if (!state.timers.size && round > 2) break;
|
||||
const due = [...state.timers.values()];
|
||||
state.timers.clear();
|
||||
for (const timer of due) await timer.fn();
|
||||
await drain();
|
||||
}
|
||||
};
|
||||
|
||||
async function drain() {
|
||||
await new Promise((resolve) => setImmediate(resolve));
|
||||
}
|
||||
|
||||
state.linkedSetup = async () => {
|
||||
await state.fire("init");
|
||||
await state.fire("ready");
|
||||
await state.runTimers();
|
||||
state.requests.length = 0;
|
||||
return state;
|
||||
};
|
||||
|
||||
return state;
|
||||
}
|
||||
|
||||
async function forceSyncActors(world, ...actorIds) {
|
||||
const options = [];
|
||||
await world.fire("getActorDirectoryEntryContext", null, options);
|
||||
const entry = options.find((option) => option.name === "Dragonroll: Force Sync");
|
||||
assert.ok(entry, "Dragonroll: Force Sync is offered in the actor directory context menu");
|
||||
await entry.callback(actorIds.map((actorId) => ({ dataset: { actorId } })));
|
||||
await world.runTimers();
|
||||
}
|
||||
|
||||
test("auto-sync is a module setting that is on by default", async () => {
|
||||
const world = makeStubWorld();
|
||||
await world.fire("init");
|
||||
|
||||
const setting = world.registered.get("autoSync");
|
||||
assert.equal(setting.default, true, "autosync is on by default");
|
||||
assert.equal(setting.config, true, "autosync appears in the module settings");
|
||||
assert.equal(world.game.settings.get(MODULE_ID, "autoSync"), true);
|
||||
});
|
||||
|
||||
test("autosync on: Foundry CRUD events keep syncing with Dragonroll", async () => {
|
||||
const world = await makeStubWorld().linkedSetup();
|
||||
|
||||
await world.fire("updateActor", world.actor("actor-1"));
|
||||
await world.runTimers();
|
||||
|
||||
const pushes = world.syncRequests();
|
||||
assert.equal(pushes.length, 1);
|
||||
assert.equal(pushes[0].body.actors[0]._id, "actor-1");
|
||||
});
|
||||
|
||||
test("autosync off: CRUD requests stop syncing", async () => {
|
||||
const world = await makeStubWorld().linkedSetup();
|
||||
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", false);
|
||||
await world.fire("updateActor", world.actor("actor-1"));
|
||||
await world.fire("deleteActor", world.actor("actor-2"));
|
||||
await world.fire("createItem", makeWorldItem("item-1", "Longsword"));
|
||||
await world.runTimers();
|
||||
|
||||
assert.deepEqual(world.syncRequests(), []);
|
||||
});
|
||||
|
||||
test("edits made while autosync is off are delivered when it is turned back on", async () => {
|
||||
const world = await makeStubWorld().linkedSetup();
|
||||
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", false);
|
||||
await world.fire("updateActor", world.actor("actor-1"));
|
||||
await world.fire("createItem", makeWorldItem("item-1", "Longsword"));
|
||||
await world.runTimers();
|
||||
assert.deepEqual(world.syncRequests(), []);
|
||||
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", true);
|
||||
await world.runTimers();
|
||||
|
||||
const pushes = world.syncRequests();
|
||||
assert.ok(pushes.some((request) => request.body?.fullSync === false
|
||||
&& request.body.actors?.some((actor) => actor._id === "actor-1")),
|
||||
"the actor edit queued while autosync was off is sent");
|
||||
assert.ok(pushes.some((request) => request.href.includes("foundry/sync/item-snapshot")
|
||||
&& request.body.items.some((item) => item._id === "item-1")),
|
||||
"the item edit queued while autosync was off is sent");
|
||||
});
|
||||
|
||||
test("autosync off at world start: no snapshot and no reconcile", async () => {
|
||||
const world = makeStubWorld({ autoSync: false });
|
||||
await world.fire("init");
|
||||
await world.fire("ready");
|
||||
await world.runTimers();
|
||||
|
||||
assert.deepEqual(world.syncRequests(), []);
|
||||
});
|
||||
|
||||
test("force sync sends selected actors to Dragonroll even with autosync off", async () => {
|
||||
const world = await makeStubWorld().linkedSetup();
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", false);
|
||||
|
||||
await forceSyncActors(world, "actor-2");
|
||||
|
||||
const pushes = world.syncRequests();
|
||||
assert.equal(pushes.length, 1);
|
||||
assert.equal(pushes[0].body.fullSync, false, "a forced actor never prunes the campaign");
|
||||
assert.deepEqual(pushes[0].body.actors.map((actor) => actor._id), ["actor-2"]);
|
||||
assert.deepEqual(world.notifications.filter(([kind]) => kind !== "info"), []);
|
||||
});
|
||||
|
||||
test("force sync sends every selected actor in one push", async () => {
|
||||
const world = await makeStubWorld().linkedSetup();
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", false);
|
||||
|
||||
await forceSyncActors(world, "actor-1", "actor-2");
|
||||
|
||||
const pushes = world.syncRequests();
|
||||
assert.equal(pushes.length, 1);
|
||||
assert.deepEqual(pushes[0].body.actors.map((actor) => actor._id), ["actor-1", "actor-2"]);
|
||||
});
|
||||
|
||||
test("force sync also works while autosync is on", async () => {
|
||||
const world = await makeStubWorld().linkedSetup();
|
||||
|
||||
await forceSyncActors(world, "actor-1");
|
||||
|
||||
assert.deepEqual(world.syncRequests()[0]?.body.actors.map((actor) => actor._id), ["actor-1"]);
|
||||
});
|
||||
|
||||
test("force sync refuses an actor Dragonroll does not import", async () => {
|
||||
const world = makeStubWorld({ autoSync: false });
|
||||
await world.fire("init");
|
||||
const cart = stubDocument("actor-3", "Cart", { documentName: "Actor", type: "vehicle", items: { contents: [] } });
|
||||
world.game.actors.contents.push(cart);
|
||||
|
||||
await forceSyncActors(world, "actor-3");
|
||||
|
||||
assert.deepEqual(world.syncRequests(), []);
|
||||
assert.ok(world.notifications.some(([kind, text]) => kind === "warn" && text.includes("Cart")));
|
||||
});
|
||||
|
||||
test("turning autosync back on reconciles both sides again", async () => {
|
||||
const world = makeStubWorld({ autoSync: false });
|
||||
await world.fire("init");
|
||||
await world.fire("ready");
|
||||
await world.runTimers();
|
||||
assert.deepEqual(world.syncRequests(), []);
|
||||
|
||||
await world.game.settings.set(MODULE_ID, "autoSync", true);
|
||||
await world.runTimers();
|
||||
|
||||
assert.ok(world.syncRequests().some((request) => request.body?.fullSync === true),
|
||||
"the world sends its full snapshot again");
|
||||
assert.ok(world.requests.some((request) => request.href.includes("foundry/sync/characters")),
|
||||
"Dragonroll documents are applied back into the world");
|
||||
});
|
||||
Reference in New Issue
Block a user