Compare commits
55 Commits
ai/issue-6
...
ai/issue-1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
eead3c9be8 | ||
| b5d5e570d5 | |||
|
|
cd1e3cb125 | ||
| 013c3512fe | |||
| 3f2ac16394 | |||
| 55fbacbdd7 | |||
| 5efe43fd99 | |||
| 00ac1b16cd | |||
|
|
07dcf08616 | ||
|
|
967c704801 | ||
| c9ee16f2f2 | |||
|
|
abcec4d2ff | ||
| dcc6d7a14b | |||
| 227fff1351 | |||
| a64fe499e9 | |||
| b75ee05276 | |||
| bc7231a1da | |||
| 252ae2d6b2 | |||
|
|
30e23b643c | ||
|
|
8376acfc6b | ||
|
|
f8dae95563 | ||
| 98aa3be078 | |||
| 80c6b1b62f | |||
| 2cce19e032 | |||
| abacfeca40 | |||
| f925881a54 | |||
|
|
9aad484fe9 | ||
|
|
5ee7353123 | ||
|
|
f0ffa2f72b | ||
| 2c1cc970e6 | |||
| 72596c3d15 | |||
| d9d80c4eee | |||
| 4eda4a9d21 | |||
| b64d1e3089 | |||
| fefb1eba6e | |||
|
|
06144e1623 | ||
|
|
788f69efd3 | ||
|
|
f928f13544 | ||
| a8a1e0ca41 | |||
| fa82c933d6 | |||
|
|
299380d143 | ||
| 6df7d57376 | |||
| a8047e2814 | |||
|
|
37e6e44612 | ||
| b0cc98a452 | |||
| d35216c859 | |||
|
|
495e528124 | ||
|
|
dd4c9535d3 | ||
| 0caacf434f | |||
| d779d939f9 | |||
| eeaab7a910 | |||
| f9caff3100 | |||
|
|
0567096588 | ||
|
|
8418b5c254 | ||
|
|
09e9010729 |
56
AGENTS.md
56
AGENTS.md
@@ -10,11 +10,11 @@ Free/open-source helper for tabletop RPG campaigns (campaigns, markdown notes, f
|
|||||||
items, maps, dice widgets, sounds).
|
items, maps, dice widgets, sounds).
|
||||||
|
|
||||||
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth, CommonJS, entry `src/index.js`.
|
- `backend/` — Node + **Express 5** + **Mongoose 9** (MongoDB) REST API, JWT auth, CommonJS, entry `src/index.js`.
|
||||||
- `frontend/` — **Nuxt 4 / Vue 3** (`<script setup>`), SCSS, axios, marked, mitt, motion, entry `app/app.vue`. No routed pages (§5.1).
|
- `frontend/` — **Nuxt 4 / Vue 3** (`<script setup>`), SCSS, axios, marked, mitt, motion, entry `app/app.vue`. Two pages: the app and `/docs` (§5.1).
|
||||||
- `discord-bot/` — Discord bot (slash commands) that talks to the backend with a shared service secret, no login.
|
- `discord-bot/` — Discord bot (slash commands) that talks to the backend with a shared service secret, no login.
|
||||||
- `dragonroll-foundry/` — Foundry VTT module (`scripts/api.js`) + optional read-only snapshot bridge.
|
- `dragonroll-foundry/` — Foundry VTT module (`scripts/api.js`) + optional read-only snapshot bridge.
|
||||||
- `obsidian-plugin/` — plain JavaScript Obsidian plugin that imports/pushes campaign notes.
|
- `obsidian-plugin/` — plain JavaScript Obsidian plugin that imports/pushes campaign notes.
|
||||||
- `tests/` — `npm test` (`node --test`, no dependencies installed): Foundry sync toggle and pairing status, map pins and tokens, sidebar entries.
|
- `tests/` — `npm test` (`node --test`, no dependencies installed): Foundry sync toggle and pairing status, map pins and tokens, sidebar entries, the `/docs` pages.
|
||||||
|
|
||||||
No DB seeding, no migrations, no linter/formatter, no Pinia/Vuex. Git: default branch `master` on a
|
No DB seeding, no migrations, no linter/formatter, no Pinia/Vuex. Git: default branch `master` on a
|
||||||
self-hosted Gitea; `.gitea/workflows/deploy.yml` builds and deploys Docker images on push to `master`,
|
self-hosted Gitea; `.gitea/workflows/deploy.yml` builds and deploys Docker images on push to `master`,
|
||||||
@@ -83,11 +83,12 @@ campaign, and handlers check ownership with a `userOwnsCampaign(campaignId, user
|
|||||||
|
|
||||||
- `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
|
- `User` — `name*`, `username*`, `email*` (both unique), `password` (bcrypt, 10 rounds), `admin`, `image`, `setupCode`, `settings`
|
||||||
- `Campaign` — `name*`, `createdBy*`→User, `description`, `color`, `settings`, `foundryWorldId`/`foundryWorldTitle`/`foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId`
|
- `Campaign` — `name*`, `createdBy*`→User, `description`, `color`, `settings`, `foundryWorldId`/`foundryWorldTitle`/`foundrySystem`, `foundrySyncTokenHash` (`select: false`), `discordGuildId`
|
||||||
- `Note` — `title`, `content` (markdown source), `campaign*`, `folder` (null = root), `color`
|
- `Note` — `title`, `content` (markdown source), `campaign*`, `folder` (null = root), `color`, `foundryPageId`
|
||||||
- `Folder` — `name*`, `campaign*`, `parentFolder` (null = root, self-ref), `color`
|
- `Folder` — `name*`, `campaign*`, `parentFolder` (null = root, self-ref), `color`
|
||||||
- `Actor` — `name*`, `campaign*`, `foundryActorId` (unique per campaign), plus free-form sheet fields (`type`, `species`, `className`, `level`, `abilityScores`, `armorClass`, `speed`, `proficiencies`, `traits`, `spells`, `image`) and `inventory[{name,quantity,weight}]` (flattened Foundry items, **not** `Item` docs)
|
- `Actor` — `name*`, `campaign*`, `foundryActorId` (unique per campaign), `discordUserId` (the Discord player holding the character, unique per campaign — set only by `routes/discord.js`), plus free-form sheet fields (`type`, `species`, `className`, `level`, `abilityScores`, `armorClass`, `speed`, `proficiencies`, `traits`, `spells`, `image`) and `inventory[{name,quantity,weight}]` (flattened Foundry items, **not** `Item` docs)
|
||||||
- `Item` — `name*`, `campaign*`, `foundryItemId` (unique per campaign), `foundryNames`, `category`, `rarity`, `quantity`, `weight`, `properties`, `description`
|
- `Item` — `name*`, `campaign*`, `foundryItemId` (unique per campaign), `foundryNames`, `category`, `rarity`, `quantity`, `weight`, `properties`, `description`
|
||||||
- `Map` — `name*`, `campaign*`, `image` (filename in `src/uploads`), `gridSize`/`offsetX`/`offsetY`/`scale` (image px), `pins[{note→Note, x, y}]` (addressed by the pin's own `_id`), `tokens[{actor→Actor, x, y}]` (the centre of the grid cell the token stands in, also addressed by its own `_id`)
|
- `Map` — `name*`, `campaign*`, `image` (filename in `src/uploads`, or a full URL a synced scene's
|
||||||
|
picture arrives as), `gridSize`/`offsetX`/`offsetY`/`scale` (image px), `pins[{note→Note, x, y}]` (addressed by the pin's own `_id`), `tokens[{actor→Actor, x, y}]` (the centre of the grid cell the token stands in, also addressed by its own `_id`), `foundrySceneId` (the Foundry scene this map mirrors, unique per campaign)
|
||||||
- `ServiceLinkRequest` — the pending/completed service pairings of §4; `DiscordGuildLink` maps a Discord guild to the Dragonroll user who claimed it
|
- `ServiceLinkRequest` — the pending/completed service pairings of §4; `DiscordGuildLink` maps a Discord guild to the Dragonroll user who claimed it
|
||||||
|
|
||||||
**API surface** (all under `/api`, all `{status,msg}`):
|
**API surface** (all under `/api`, all `{status,msg}`):
|
||||||
@@ -99,7 +100,7 @@ campaign, and handlers check ownership with a `userOwnsCampaign(campaignId, user
|
|||||||
- `actor` — `list`, `create`, `update` (partial, ownership checked), `upload-image?actor=` (multipart), `delete`
|
- `actor` — `list`, `create`, `update` (partial, ownership checked), `upload-image?actor=` (multipart), `delete`
|
||||||
- `item` — `list`, `create`, `update` (partial), `delete`
|
- `item` — `list`, `create`, `update` (partial), `delete`
|
||||||
- `map` — `list`, `create` (multipart `image` or JSON), `update` (multipart to replace the photo), `delete`, `pin` (`{id,note,x,y}`, re-pinning moves the marker), `unpin` (`{id,pin}`), `place-token` (`{id,actor,x,y}`, snapped to a cell centre, re-placing moves the token), `remove-token` (`{id,token}`)
|
- `map` — `list`, `create` (multipart `image` or JSON), `update` (multipart to replace the photo), `delete`, `pin` (`{id,note,x,y}`, re-pinning moves the marker), `unpin` (`{id,pin}`), `place-token` (`{id,actor,x,y}`, snapped to a cell centre, re-placing moves the token), `remove-token` (`{id,token}`)
|
||||||
- `foundry` — read-only proxy over the bridge (`/world`, `/actors`, `/characters`, `/items`, `/actors/:id`, `/items/:id`, `/actors/:id/items`), needs `FOUNDRY_API_URL`
|
- `foundry` — read-only proxy over the bridge (`/world`, `/actors`, `/characters`, `/items`, `/actors/:id`, `/items/:id`, `/actors/:id/items`), needs `FOUNDRY_API_URL`; `POST /import` (`{campaign, kind: 'actors'|'items'}`, the sidebar's "force import from Foundry") pulls that world's whole list off the bridge through the sync's writers, so rows the campaign already has are written over, and answers `{imported, updated}`; `/icons?campaign=&dir=&offset=` lists one folder of the world's core `icons/` library (the bridge reads it from `DRAGONROLL_FOUNDRY_DATA_PATH`) and answers `{dir, parent, folders, files[{path,name,url}], next}`, the icons paged so the library stays lazy to load
|
||||||
|
|
||||||
## 4. Service integrations (Foundry, Discord, Obsidian)
|
## 4. Service integrations (Foundry, Discord, Obsidian)
|
||||||
|
|
||||||
@@ -114,24 +115,42 @@ rest, expire after 10 min, and Obsidian gets a long-lived (365 d) token back.
|
|||||||
|
|
||||||
Foundry then syncs with that token on `/api/foundry/sync/*` (`routes/foundry-link.js`, mounted before
|
Foundry then syncs with that token on `/api/foundry/sync/*` (`routes/foundry-link.js`, mounted before
|
||||||
the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync` also prunes),
|
the JWT guard; CORS opened for it): `snapshot` (actors + world items, `fullSync` also prunes),
|
||||||
`item-snapshot`, `item-delete`, `characters`, `items`, `status`, `map` / `map-item`, `delete`. Rules:
|
`item-snapshot`, `item-delete`, `scenes` (the world's scenes as the campaign's maps, `fullSync` also
|
||||||
|
prunes), `scene-delete`, `characters`, `items`, `notes` / `map-note`, `status`,
|
||||||
|
`map` / `map-item`, `delete`. Rules:
|
||||||
|
|
||||||
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
|
- **Identity** is `foundryActorId` / `foundryItemId` (unique per campaign, partial index); a Foundry document carrying the `dragonroll-foundry.actorId` / `.itemId` flag adopts the matching Dragonroll row.
|
||||||
- **Items are deduplicated by name** — Foundry keeps the same gear once per carrier, so one `Item` per name; `foundryNames` keeps Foundry's names so a Dragonroll rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
|
- **Only the world's item directory reaches the item list** (Syndria98/dragonroll#67) — `snapshotItemSources` reads `body.items` (`game.items`) alone; gear embedded in a character is that actor's `inventory` (see the `Actor` model), not an `Item`. A world item still folds into a hand-made or renamed row it matches by name (`foundryNames`), so a rename does not resurrect a duplicate. `services/item-foundry.js` returns `null` for non-gear types and those are skipped.
|
||||||
- **Item folders mirror the world's item directory** (`Folder.foundryFolderId`, target `item`): every push carries the whole tree and the world owns its names and nesting. `color` is the one field the campaign sets too, so it travels back with the folders `GET /foundry/sync/items` answers with (`{items, folders}`) and the module writes it onto the world's folder.
|
- **Item folders mirror the world's item directory** (`Folder.foundryFolderId`, target `item`): every push carries the whole tree and the world owns its names and nesting. `color` is the one field the campaign sets too, so it travels back with the folders `GET /foundry/sync/items` answers with (`{items, folders}`) and the module writes it onto the world's folder.
|
||||||
|
- **A world's scenes arrive as its campaign's maps** (Syndria98/dragonroll#99): `POST /foundry/sync/scenes` writes one `Map` per scene through `saveFoundryScene`, and only the scene's background picture and grid cross over (`services/map-foundry.js`: `gridSize` from `grid`/`grid.size`, the offsets from `flags.core.shiftX`/`.shiftY`) — `scale`, the folder, the pins and the tokens stay with the campaign and nothing of a map goes back to the world. Identity is `Map.foundrySceneId` (unique per campaign), a `dragonroll-foundry.mapId` flag or a hand-made unmapped map of the same name; a scene with no picture makes no map. `POST /foundry/sync/scene-delete` drops the map of a deleted scene, and only the full list the module sends when the world links or loads prunes.
|
||||||
|
- **Notes reach the world as journal pages, one way** (Syndria98/dragonroll#98): the module reads `GET /sync/notes` and stands every campaign note as a page of one world `JournalEntry` named Dragonroll — the page carries the note's id in a `dragonroll-foundry.noteId` flag, the note keeps the page's id in `foundryPageId` (`POST /sync/map-note`). The reconcile rewrites pages from the notes and drops the page of a deleted note; journal edits never travel back.
|
||||||
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune.
|
- **`fullSync` preserves Dragonroll edits** (only new rows are overwritten); live Foundry events overwrite. Only a full snapshot can prune.
|
||||||
- **Autosync is a Foundry-side setting** (`autoSync`, on by default): off = no CRUD push, no periodic reconcile, no startup snapshot; the actor directory's *Dragonroll: Force Sync* still upserts the selection (`fullSync:false`).
|
- **Autosync is a Foundry-side setting** (`autoSync`, on by default): off = no CRUD push, no periodic reconcile, no startup snapshot; the actor directory's *Dragonroll: Force Sync* still upserts the selection (`fullSync:false`).
|
||||||
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge.
|
- `GET /api/foundry/*` (`routes/foundry.js`) is unrelated: a JWT-protected proxy over the read-only bridge. Its one write, `POST /import`, pulls the bridge's actors or world items into the campaign through the same writers as a sync push.
|
||||||
|
|
||||||
## 5. Frontend
|
## 5. Frontend
|
||||||
|
|
||||||
### 5.1 Not a routed app
|
### 5.1 Two pages: the app and the documentation
|
||||||
|
|
||||||
There is no `app/pages/`. `app/app.vue` renders a shell of managers (`Window`, `Content`, `Toast`,
|
`app/pages/` routes the only two things the frontend is. `index.vue` and the `[...all].vue` catch-all
|
||||||
`Tooltip`, `ContextMenu`) and boots: `GetUser()` (JWT in localStorage) → `RestoreCampaign()` or open
|
both render `components/views/AppShell.vue` — the window app, which has no routes of its own — and
|
||||||
`main_menu`; no user → `HasAdmin() ? 'login' : 'register' {firstTime:true}`. The one real URL is
|
`docs/index.vue` + `docs/[slug].vue` render `views/DocsView.vue`, the documentation at `/docs`.
|
||||||
`/link/authorize` (and the legacy `/discord/authorize`), which renders the service link screen instead
|
`app.vue` holds only what is site-wide (the head, the theme) and `<NuxtPage>`. AppShell boots:
|
||||||
of the app.
|
`GetUser()` (JWT in localStorage) → `RestoreCampaign()` or open `main_menu`; no user →
|
||||||
|
`HasAdmin() ? 'login' : 'register' {firstTime:true}`. `/link/authorize` (and the legacy
|
||||||
|
`/discord/authorize`) is not a page either: AppShell checks the path and renders the service link
|
||||||
|
screen instead of the app.
|
||||||
|
|
||||||
|
The documentation is markdown files under `app/content/docs/<group>/<NN>-<page>.md`: the folder is the
|
||||||
|
sidebar group and its number orders the groups, the file's number orders its pages, the rest of its
|
||||||
|
name is the slug, and the first heading is the title. `services/Docs.js` reads them
|
||||||
|
(`import.meta.glob(..., {query:'?raw'})`), builds the sidebar and renders a page with marked;
|
||||||
|
`services/DocsMarkdown.js` holds the heading/slug helpers the sidebar and the anchors share and imports
|
||||||
|
nothing so `tests/docs.test.js` can load it. A new group's label goes in `docs.json` under
|
||||||
|
`groups.<folder>` **in all three locales**. The first page is served at `/docs` itself, and inside a
|
||||||
|
campaign the top bar opens the same pages in the `documentation` window
|
||||||
|
(`components/windows/DocumentationWindow.vue`), which holds the page it shows as its own state instead
|
||||||
|
of a route so the campaign stays behind it.
|
||||||
|
|
||||||
Two kinds of screens: **windows** (floating draggable/resizable overlays) and **content** — the
|
Two kinds of screens: **windows** (floating draggable/resizable overlays) and **content** — the
|
||||||
campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`), turned on when
|
campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`), turned on when
|
||||||
@@ -166,7 +185,7 @@ writes `localStorage.selectedCampaignId`, `RestoreCampaign`), `Content.js` (§5.
|
|||||||
(`mitt()` bus), `Toaster.js`, `Tooltip.js`, `ContextMenu.js`, `Sound.js` (`AddSound` binds
|
(`mitt()` bus), `Toaster.js`, `Tooltip.js`, `ContextMenu.js`, `Sound.js` (`AddSound` binds
|
||||||
`snap.wav` to `.sound-click`), `Marker.js` (marked + widgets), `ActionRegistry.js` (command palette:
|
`snap.wav` to `.sound-click`), `Marker.js` (marked + widgets), `ActionRegistry.js` (command palette:
|
||||||
`register/unregister/search/execute`), `Windows.js` / `WindowDefinitions.js`, `MapPins.js`, `MapTokens.js`,
|
`register/unregister/search/execute`), `Windows.js` / `WindowDefinitions.js`, `MapPins.js`, `MapTokens.js`,
|
||||||
`widgets/DiceParser.js`.
|
`Docs.js` + `DocsMarkdown.js` (§5.1), `widgets/DiceParser.js`.
|
||||||
|
|
||||||
### 5.4 Markdown → widgets
|
### 5.4 Markdown → widgets
|
||||||
|
|
||||||
@@ -199,7 +218,9 @@ variables: always style with `var(--color-…)`, never hardcode hex, and add a n
|
|||||||
i18n: `frontend/i18n/locales/<lang>/<namespace>.json` for `en` (default), `es`, `ca`; `plugins/i18n.ts`
|
i18n: `frontend/i18n/locales/<lang>/<namespace>.json` for `en` (default), `es`, `ca`; `plugins/i18n.ts`
|
||||||
nests each file under its filename, so the key is `<file>.<path>` (`$t('windows.login')`). **Add every
|
nests each file under its filename, so the key is `<file>.<path>` (`$t('windows.login')`). **Add every
|
||||||
new string to all three locales.** Namespaces in use: `general`, `login`, `register`, `main-menu`,
|
new string to all three locales.** Namespaces in use: `general`, `login`, `register`, `main-menu`,
|
||||||
`settings`, `windows`, `campaigns`, `link`, `foundry`, `discord`.
|
`settings`, `windows`, `campaigns`, `link`, `foundry`, `discord`, `docs`. (The `/docs` *content* is
|
||||||
|
markdown under `app/content/docs` and is written in English; only its chrome — sidebar labels, prev /
|
||||||
|
next — is translated.)
|
||||||
|
|
||||||
## 6. Conventions
|
## 6. Conventions
|
||||||
|
|
||||||
@@ -216,6 +237,7 @@ new string to all three locales.** Namespaces in use: `general`, `login`, `regis
|
|||||||
- **New widget**: component in `components/viewer/widgets/{inline,display}/` + `widget_map` entry in `Marker.js`.
|
- **New widget**: component in `components/viewer/widgets/{inline,display}/` + `widget_map` entry in `Marker.js`.
|
||||||
- **New palette action**: `register({id, label, description, execute, isActive?})` from `~/services/ActionRegistry` (palette: `Ctrl/Cmd+K` or `/`).
|
- **New palette action**: `register({id, label, description, execute, isActive?})` from `~/services/ActionRegistry` (palette: `Ctrl/Cmd+K` or `/`).
|
||||||
- **New theme color**: key in *both* `dark` and `light` maps in `colors.scss`, then `var(--color-<key>)`.
|
- **New theme color**: key in *both* `dark` and `light` maps in `colors.scss`, then `var(--color-<key>)`.
|
||||||
|
- **New documentation page**: `app/content/docs/<group>/NN-name.md` whose first heading is its title (§5.1); a brand-new group also needs `groups.<folder>` in `i18n/locales/*/docs.json` (all three locales).
|
||||||
|
|
||||||
## 8. Known landmines (verified in code — do not "fix" silently, never make them worse)
|
## 8. Known landmines (verified in code — do not "fix" silently, never make them worse)
|
||||||
|
|
||||||
|
|||||||
@@ -22,11 +22,69 @@ const ActorSchema = new Schema({
|
|||||||
},
|
},
|
||||||
armorClass: { type: Number, min: 0, default: 10 },
|
armorClass: { type: Number, min: 0, default: 10 },
|
||||||
speed: { type: Number, min: 0, default: 30 },
|
speed: { type: Number, min: 0, default: 30 },
|
||||||
|
// The two pools the sheet draws as bars under the portrait (Syndria98/dragonroll#64): the bar
|
||||||
|
// fills `current` of `max`, so both travel together. `current` is kept below `max` by whoever
|
||||||
|
// writes them (routes/actor.js), the same way the sheet clamps the bar.
|
||||||
|
hitPoints: {
|
||||||
|
current: { type: Number, min: 0, default: 10 },
|
||||||
|
max: { type: Number, min: 0, default: 10 }
|
||||||
|
},
|
||||||
|
hitDice: {
|
||||||
|
current: { type: Number, min: 0, default: 1 },
|
||||||
|
max: { type: Number, min: 0, default: 1 }
|
||||||
|
},
|
||||||
proficiencies: { type: String, default: '' },
|
proficiencies: { type: String, default: '' },
|
||||||
|
// The skills the character is proficient with (Syndria98/dragonroll#83). Dragonroll holds
|
||||||
|
// whole names; services/actor-foundry.js translates the short keys a Foundry world uses.
|
||||||
|
skills: {
|
||||||
|
acrobatics: { type: Boolean, default: false },
|
||||||
|
animalHandling: { type: Boolean, default: false },
|
||||||
|
arcana: { type: Boolean, default: false },
|
||||||
|
athletics: { type: Boolean, default: false },
|
||||||
|
deception: { type: Boolean, default: false },
|
||||||
|
history: { type: Boolean, default: false },
|
||||||
|
insight: { type: Boolean, default: false },
|
||||||
|
intimidation: { type: Boolean, default: false },
|
||||||
|
investigation: { type: Boolean, default: false },
|
||||||
|
medicine: { type: Boolean, default: false },
|
||||||
|
nature: { type: Boolean, default: false },
|
||||||
|
perception: { type: Boolean, default: false },
|
||||||
|
performance: { type: Boolean, default: false },
|
||||||
|
persuasion: { type: Boolean, default: false },
|
||||||
|
religion: { type: Boolean, default: false },
|
||||||
|
sleightOfHand: { type: Boolean, default: false },
|
||||||
|
stealth: { type: Boolean, default: false },
|
||||||
|
survival: { type: Boolean, default: false }
|
||||||
|
},
|
||||||
|
// Which of the six saving throws the character adds its proficiency bonus to.
|
||||||
|
savingThrows: {
|
||||||
|
str: { type: Boolean, default: false },
|
||||||
|
dex: { type: Boolean, default: false },
|
||||||
|
con: { type: Boolean, default: false },
|
||||||
|
int: { type: Boolean, default: false },
|
||||||
|
wis: { type: Boolean, default: false },
|
||||||
|
cha: { type: Boolean, default: false }
|
||||||
|
},
|
||||||
|
// Tool and language proficiencies: plain names, one per entry. The free-form
|
||||||
|
// `proficiencies` text keeps whatever else the character is proficient with
|
||||||
|
// (armour and weapons, say), which has no list of its own.
|
||||||
|
tools: [{ type: String, trim: true }],
|
||||||
|
languages: [{ type: String, trim: true }],
|
||||||
|
// The coins the character holds, in the five D&D denominations.
|
||||||
|
currency: {
|
||||||
|
pp: { type: Number, min: 0, default: 0 },
|
||||||
|
gp: { type: Number, min: 0, default: 0 },
|
||||||
|
ep: { type: Number, min: 0, default: 0 },
|
||||||
|
sp: { type: Number, min: 0, default: 0 },
|
||||||
|
cp: { type: Number, min: 0, default: 0 }
|
||||||
|
},
|
||||||
inventory: [{
|
inventory: [{
|
||||||
name: { type: String, trim: true, default: '' },
|
name: { type: String, trim: true, default: '' },
|
||||||
quantity: { type: Number, min: 1, default: 1 },
|
quantity: { type: Number, min: 1, default: 1 },
|
||||||
weight: { type: Number, min: 0, default: 0 }
|
weight: { type: Number, min: 0, default: 0 },
|
||||||
|
// The gear's own picture: what a Foundry world sends with the item it stands
|
||||||
|
// for, shown on the left of the inventory row.
|
||||||
|
icon: { type: String, default: '' }
|
||||||
}],
|
}],
|
||||||
traits: { type: String, default: '' },
|
traits: { type: String, default: '' },
|
||||||
spells: { type: String, default: '' },
|
spells: { type: String, default: '' },
|
||||||
@@ -43,6 +101,10 @@ const ActorSchema = new Schema({
|
|||||||
default: null
|
default: null
|
||||||
},
|
},
|
||||||
foundryActorId: { type: String },
|
foundryActorId: { type: String },
|
||||||
|
// The Discord player this character belongs to (Syndria98/dragonroll#72): each player
|
||||||
|
// of the server a campaign is linked to holds one character of it. Only
|
||||||
|
// routes/discord.js writes it, so the campaign keeps owning it whichever guild claimed it.
|
||||||
|
discordUserId: { type: String, default: null },
|
||||||
date: { type: Date, default: Date.now }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -51,4 +113,10 @@ ActorSchema.index(
|
|||||||
{ unique: true, partialFilterExpression: { foundryActorId: { $type: 'string' } } }
|
{ unique: true, partialFilterExpression: { foundryActorId: { $type: 'string' } } }
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// A player holds at most one character of a campaign: the id is unique within it.
|
||||||
|
ActorSchema.index(
|
||||||
|
{ campaign: 1, discordUserId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { discordUserId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
module.exports = mongoose.model('Actor', ActorSchema);
|
module.exports = mongoose.model('Actor', ActorSchema);
|
||||||
|
|||||||
@@ -39,7 +39,15 @@ const MapSchema = new Schema({
|
|||||||
ref: 'Folder',
|
ref: 'Folder',
|
||||||
default: null
|
default: null
|
||||||
},
|
},
|
||||||
|
// The Foundry scene this map mirrors, set by the scene sync only
|
||||||
|
// (see routes/foundry-link.js). Only the picture and the grid follow the world.
|
||||||
|
foundrySceneId: { type: String },
|
||||||
date: { type: Date, default: Date.now }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
|
MapSchema.index(
|
||||||
|
{ campaign: 1, foundrySceneId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { foundrySceneId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
module.exports = mongoose.model('Map', MapSchema);
|
module.exports = mongoose.model('Map', MapSchema);
|
||||||
|
|||||||
@@ -14,7 +14,16 @@ const NoteSchema = new Schema({
|
|||||||
ref: 'Folder'
|
ref: 'Folder'
|
||||||
},
|
},
|
||||||
color: { type: String },
|
color: { type: String },
|
||||||
|
// The journal page this note is written as in the linked Foundry world: the
|
||||||
|
// page of the one "Dragonroll" journal whose rows carry this note's id in
|
||||||
|
// their `dragonroll-foundry.noteId` flag (see the module's notes sync).
|
||||||
|
foundryPageId: { type: String },
|
||||||
date: { type: Date, default: Date.now }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
|
NoteSchema.index(
|
||||||
|
{ campaign: 1, foundryPageId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { foundryPageId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
module.exports = mongoose.model('Note', NoteSchema);
|
module.exports = mongoose.model('Note', NoteSchema);
|
||||||
@@ -13,6 +13,22 @@ async function userOwnsCampaign(campaignId, userId) {
|
|||||||
return Boolean(campaign);
|
return Boolean(campaign);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Hit points and hit dice travel as a bar the sheet fills (`current` of `max`, see models/Actor.js).
|
||||||
|
// A partial update keeps whatever half of the pair it did not send, and `current` never passes the
|
||||||
|
// maximum it ends up with.
|
||||||
|
function barPool(existing, value) {
|
||||||
|
const max = Math.max(0, Number(value?.max ?? existing?.max) || 0);
|
||||||
|
const current = Math.max(0, Math.min(Number(value?.current ?? existing?.current) || 0, max));
|
||||||
|
return { current, max };
|
||||||
|
}
|
||||||
|
|
||||||
|
// The tool and language lists (Syndria98/dragonroll#83): plain names, blank ones and
|
||||||
|
// repeats dropped.
|
||||||
|
function textList(value) {
|
||||||
|
if (!Array.isArray(value)) return [];
|
||||||
|
return [...new Set(value.map((name) => String(name).trim()).filter(Boolean))];
|
||||||
|
}
|
||||||
|
|
||||||
// Folders the campaign's actors are grouped into, in the shape the sidebar groups by
|
// Folders the campaign's actors are grouped into, in the shape the sidebar groups by
|
||||||
// (the notes, items and maps each keep a tree of their own, see models/Folder.js).
|
// (the notes, items and maps each keep a tree of their own, see models/Folder.js).
|
||||||
async function actorFolders(campaignId) {
|
async function actorFolders(campaignId) {
|
||||||
@@ -56,7 +72,10 @@ router.post('/create', async (req, res) => {
|
|||||||
|
|
||||||
router.post('/update', async (req, res) => {
|
router.post('/update', async (req, res) => {
|
||||||
try {
|
try {
|
||||||
const { id, name, species, className, subclass, level, abilityScores, armorClass, speed, proficiencies, inventory, traits, spells, image, folder } = req.body;
|
const {
|
||||||
|
id, name, species, className, subclass, level, abilityScores, armorClass, speed, hitPoints, hitDice,
|
||||||
|
proficiencies, skills, savingThrows, tools, languages, currency, inventory, traits, spells, image, folder
|
||||||
|
} = req.body;
|
||||||
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
if (!id) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
const actor = await Actor.findById(id);
|
const actor = await Actor.findById(id);
|
||||||
@@ -80,7 +99,17 @@ router.post('/update', async (req, res) => {
|
|||||||
if (abilityScores !== undefined) actor.abilityScores = abilityScores;
|
if (abilityScores !== undefined) actor.abilityScores = abilityScores;
|
||||||
if (armorClass !== undefined) actor.armorClass = Number(armorClass);
|
if (armorClass !== undefined) actor.armorClass = Number(armorClass);
|
||||||
if (speed !== undefined) actor.speed = Number(speed);
|
if (speed !== undefined) actor.speed = Number(speed);
|
||||||
|
if (hitPoints !== undefined) actor.hitPoints = barPool(actor.hitPoints, hitPoints);
|
||||||
|
if (hitDice !== undefined) actor.hitDice = barPool(actor.hitDice, hitDice);
|
||||||
if (proficiencies !== undefined) actor.proficiencies = proficiencies;
|
if (proficiencies !== undefined) actor.proficiencies = proficiencies;
|
||||||
|
// The lists the sheet toggles and fills in (Syndria98/dragonroll#83): which skills
|
||||||
|
// and saving throws the character is proficient with, its tools, its languages and
|
||||||
|
// the coins it carries.
|
||||||
|
if (skills !== undefined) actor.skills = skills;
|
||||||
|
if (savingThrows !== undefined) actor.savingThrows = savingThrows;
|
||||||
|
if (tools !== undefined) actor.tools = textList(tools);
|
||||||
|
if (languages !== undefined) actor.languages = textList(languages);
|
||||||
|
if (currency !== undefined) actor.currency = currency;
|
||||||
if (inventory !== undefined) actor.inventory = inventory;
|
if (inventory !== undefined) actor.inventory = inventory;
|
||||||
if (traits !== undefined) actor.traits = traits;
|
if (traits !== undefined) actor.traits = traits;
|
||||||
if (spells !== undefined) actor.spells = spells;
|
if (spells !== undefined) actor.spells = spells;
|
||||||
|
|||||||
@@ -16,6 +16,11 @@ function validGuildId(value) {
|
|||||||
return /^\d{5,25}$/.test(String(value ?? ''));
|
return /^\d{5,25}$/.test(String(value ?? ''));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Discord ids are snowflakes the same shape as guild ids.
|
||||||
|
function validUserId(value) {
|
||||||
|
return /^\d{5,25}$/.test(String(value ?? ''));
|
||||||
|
}
|
||||||
|
|
||||||
// Connecting a Discord server is the service link of issue: the bot asks
|
// Connecting a Discord server is the service link of issue: the bot asks
|
||||||
// /api/link/start for a sign-up link, and whoever opens it signs in and picks the
|
// /api/link/start for a sign-up link, and whoever opens it signs in and picks the
|
||||||
// campaign this server may read. What is left here is what the bot needs once
|
// campaign this server may read. What is left here is what the bot needs once
|
||||||
@@ -179,4 +184,92 @@ router.get('/bot/guild/:guildId/actors', requireBot, async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Who may take a character already held by somebody else is decided in Discord,
|
||||||
|
// where the server administrators are: the bot authenticates with the shared
|
||||||
|
// secret and says whether the person asking is one (`admin`). Everything else
|
||||||
|
// the backend still guards itself: only the guild's own campaign is reachable.
|
||||||
|
|
||||||
|
// One command per player link (Syndria98/dragonroll#72): assigning takes the
|
||||||
|
// character for `discordUserId`, and a player never holds two of them, so a
|
||||||
|
// second assign moves the player instead of doubling them up.
|
||||||
|
router.post('/bot/guild/:guildId/actors/assign', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const guildId = String(req.params.guildId);
|
||||||
|
const discordUserId = String(req.body.discordUserId ?? '');
|
||||||
|
if (!validGuildId(guildId) || !validUserId(discordUserId) || !req.body.actorId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const link = await DiscordGuildLink.findOne({ guildId }).lean();
|
||||||
|
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
|
||||||
|
const campaign = await Campaign.findOne({ discordGuildId: guildId, createdBy: link.dragonrollUser }).select('_id name').lean();
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const actor = await Actor.findOne({ _id: req.body.actorId, campaign: campaign._id });
|
||||||
|
if (!actor) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const holder = String(actor.discordUserId ?? '');
|
||||||
|
if (holder && holder !== discordUserId && !req.body.admin) {
|
||||||
|
return res.json({ status: 'error', msg: 'discord.errors.actor-held' });
|
||||||
|
}
|
||||||
|
|
||||||
|
// The character this player hands over to take the new one.
|
||||||
|
const previous = await Actor.findOne({ campaign: campaign._id, discordUserId, _id: { $ne: actor._id } }).lean();
|
||||||
|
if (previous) {
|
||||||
|
await Actor.updateMany(
|
||||||
|
{ campaign: campaign._id, discordUserId, _id: { $ne: actor._id } },
|
||||||
|
{ $set: { discordUserId: null } }
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
actor.discordUserId = discordUserId;
|
||||||
|
await actor.save();
|
||||||
|
|
||||||
|
res.json({
|
||||||
|
status: 'ok',
|
||||||
|
actor: { id: String(actor._id), name: actor.name, discordUserId },
|
||||||
|
previous: previous ? { id: String(previous._id), name: previous.name } : null
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Freeing a character: without `actorId` the player gives up their own, with
|
||||||
|
// one a server administrator frees anybody's.
|
||||||
|
router.post('/bot/guild/:guildId/actors/unassign', requireBot, async (req, res) => {
|
||||||
|
try {
|
||||||
|
const guildId = String(req.params.guildId);
|
||||||
|
const discordUserId = String(req.body.discordUserId ?? '');
|
||||||
|
if (!validGuildId(guildId) || !validUserId(discordUserId)) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const link = await DiscordGuildLink.findOne({ guildId }).lean();
|
||||||
|
if (!link) return res.json({ status: 'error', msg: 'discord.errors.not-connected' });
|
||||||
|
const campaign = await Campaign.findOne({ discordGuildId: guildId, createdBy: link.dragonrollUser }).select('_id name').lean();
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const filter = { campaign: campaign._id };
|
||||||
|
if (req.body.actorId) filter._id = req.body.actorId;
|
||||||
|
else filter.discordUserId = discordUserId;
|
||||||
|
const actor = await Actor.findOne(filter);
|
||||||
|
if (!actor || !actor.discordUserId) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const holder = String(actor.discordUserId);
|
||||||
|
if (holder !== discordUserId && !req.body.admin) {
|
||||||
|
return res.json({ status: 'error', msg: 'discord.errors.actor-held' });
|
||||||
|
}
|
||||||
|
|
||||||
|
actor.discordUserId = null;
|
||||||
|
await actor.save();
|
||||||
|
|
||||||
|
res.json({ status: 'ok', actor: { id: String(actor._id), name: actor.name }, wasYours: holder === discordUserId });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
module.exports = router;
|
module.exports = router;
|
||||||
|
|||||||
@@ -6,9 +6,14 @@ const router = express.Router();
|
|||||||
const Campaign = require('../models/Campaign');
|
const Campaign = require('../models/Campaign');
|
||||||
const Actor = require('../models/Actor');
|
const Actor = require('../models/Actor');
|
||||||
const Item = require('../models/Item');
|
const Item = require('../models/Item');
|
||||||
|
// Not `Map`: this route builds plain `Map`s of its own to mirror the world's folder tree.
|
||||||
|
const MapModel = require('../models/Map');
|
||||||
const Folder = require('../models/Folder');
|
const Folder = require('../models/Folder');
|
||||||
|
const Note = require('../models/Note');
|
||||||
const { foundryActorToCharacter } = require('../services/actor-foundry');
|
const { foundryActorToCharacter } = require('../services/actor-foundry');
|
||||||
const { foundryItemToItemData } = require('../services/item-foundry');
|
const { foundryItemToItemData } = require('../services/item-foundry');
|
||||||
|
const { foundrySceneToMapData } = require('../services/map-foundry');
|
||||||
|
const { joinFoundryAssetUrl } = require('../services/foundry-icons');
|
||||||
|
|
||||||
// Upper bound for the Foundry names remembered per synced item (see Item model).
|
// Upper bound for the Foundry names remembered per synced item (see Item model).
|
||||||
const MAX_FOUNDRY_NAMES = 20;
|
const MAX_FOUNDRY_NAMES = 20;
|
||||||
@@ -41,10 +46,33 @@ function requestMatchesWorld(campaign, worldId) {
|
|||||||
return typeof worldId === 'string' && worldId === campaign.foundryWorldId;
|
return typeof worldId === 'string' && worldId === campaign.foundryWorldId;
|
||||||
}
|
}
|
||||||
|
|
||||||
async function saveFoundryActor(campaign, source, fullSync = false) {
|
// Foundry serves its data directory from the world's own address, which is the one the
|
||||||
|
// campaign keeps under `settings.integrations.foundryUrl` — the icon window already loads
|
||||||
|
// the world's icons through it. The module sends the images it publishes as absolute URLs;
|
||||||
|
// the bridge's snapshot and older modules carry Foundry's relative paths, and a sheet
|
||||||
|
// reading one of those against Dragonroll's upload folder finds nothing, which is how the
|
||||||
|
// icons stopped loading (Syndria98/dragonroll#89). An absolute URL travels as it is, and so
|
||||||
|
// does a path when the campaign has no world address to read it against.
|
||||||
|
function worldAssetUrl(image, worldUrl) {
|
||||||
|
const value = String(image ?? '').trim();
|
||||||
|
if (!value || /^(https?:|data:|\/\/)/i.test(value)) return value;
|
||||||
|
return joinFoundryAssetUrl(worldUrl, value) || value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The images a world document arrives with, read against its world before they land.
|
||||||
|
function resolveWorldAssets(fields, campaign) {
|
||||||
|
const worldUrl = campaign?.settings?.integrations?.foundryUrl;
|
||||||
|
if (typeof fields.image === 'string') fields.image = worldAssetUrl(fields.image, worldUrl);
|
||||||
|
if (Array.isArray(fields.inventory)) {
|
||||||
|
for (const entry of fields.inventory) entry.icon = worldAssetUrl(entry.icon, worldUrl);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function saveFoundryActor(campaign, source, fullSync = false, replace = false) {
|
||||||
const foundryActorId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
const foundryActorId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||||
const fields = foundryActorToCharacter(source || {});
|
const fields = foundryActorToCharacter(source || {}, replace);
|
||||||
if (!foundryActorId || !fields.name) return null;
|
if (!foundryActorId || !fields.name) return null;
|
||||||
|
resolveWorldAssets(fields, campaign);
|
||||||
|
|
||||||
let actor = await Actor.findOne({ campaign: campaign._id, foundryActorId });
|
let actor = await Actor.findOne({ campaign: campaign._id, foundryActorId });
|
||||||
const dragonrollActorId = source?.flags?.['dragonroll-foundry']?.actorId;
|
const dragonrollActorId = source?.flags?.['dragonroll-foundry']?.actorId;
|
||||||
@@ -62,30 +90,30 @@ async function saveFoundryActor(campaign, source, fullSync = false) {
|
|||||||
: new Actor({ campaign: campaign._id });
|
: new Actor({ campaign: campaign._id });
|
||||||
}
|
}
|
||||||
actor.foundryActorId = foundryActorId;
|
actor.foundryActorId = foundryActorId;
|
||||||
|
// `created` says whether this row is new: whoever imports a whole world counts
|
||||||
|
// the rows it made apart from the ones it only wrote over.
|
||||||
|
const created = actor.isNew;
|
||||||
// A full snapshot runs when a GM reconnects. Preserve existing Dragonroll
|
// A full snapshot runs when a GM reconnects. Preserve existing Dragonroll
|
||||||
// edits then; live Foundry change events continue to overwrite normally.
|
// edits then; live Foundry change events continue to overwrite normally.
|
||||||
if (!fullSync || actor.isNew) Object.assign(actor, fields);
|
if (!fullSync || actor.isNew) Object.assign(actor, fields);
|
||||||
await actor.save();
|
await actor.save();
|
||||||
return { foundryActorId, actorId: actor.id };
|
return { foundryActorId, actorId: actor.id, created };
|
||||||
}
|
}
|
||||||
|
|
||||||
// A snapshot carries world-level items plus the items embedded in every actor it
|
// The campaign's item list mirrors the world's item directory and nothing else
|
||||||
// sends. World items are listed first so they own a name before its copies.
|
// (Syndria98/dragonroll#67). The items embedded in an actor are that character's own
|
||||||
|
// inventory: they travel with the actor document (see services/actor-foundry.js), so a
|
||||||
|
// snapshot feeds Item rows from the world directory (`body.items`) alone and gear a
|
||||||
|
// character merely carries stays on its sheet instead of standing in the item list.
|
||||||
function snapshotItemSources(body) {
|
function snapshotItemSources(body) {
|
||||||
const sources = [];
|
return Array.isArray(body.items) ? body.items : [];
|
||||||
if (Array.isArray(body.items)) sources.push(...body.items);
|
|
||||||
if (Array.isArray(body.actors)) {
|
|
||||||
for (const actor of body.actors) {
|
|
||||||
if (Array.isArray(actor?.items)) sources.push(...actor.items);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return sources;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async function saveFoundryItem(campaign, source, fullSync = false, folders = null) {
|
async function saveFoundryItem(campaign, source, fullSync = false, folders = null) {
|
||||||
const foundryItemId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
const foundryItemId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||||
const fields = foundryItemToItemData(source || {});
|
const fields = foundryItemToItemData(source || {});
|
||||||
if (!foundryItemId || !fields) return null;
|
if (!foundryItemId || !fields) return null;
|
||||||
|
resolveWorldAssets(fields, campaign);
|
||||||
|
|
||||||
let item = await Item.findOne({ campaign: campaign._id, foundryItemId });
|
let item = await Item.findOne({ campaign: campaign._id, foundryItemId });
|
||||||
const dragonrollItemId = source?.flags?.['dragonroll-foundry']?.itemId;
|
const dragonrollItemId = source?.flags?.['dragonroll-foundry']?.itemId;
|
||||||
@@ -95,9 +123,9 @@ async function saveFoundryItem(campaign, source, fullSync = false, folders = nul
|
|||||||
if (flagged && (!flagged.foundryItemId || flagged.foundryItemId === foundryItemId)) item = flagged;
|
if (flagged && (!flagged.foundryItemId || flagged.foundryItemId === foundryItemId)) item = flagged;
|
||||||
}
|
}
|
||||||
if (!item) {
|
if (!item) {
|
||||||
// The same gear exists more than once in Foundry: once in the world
|
// A world item can share its name with a Dragonroll row the campaign made by
|
||||||
// directory and once inside each actor carrying it. Keep a single
|
// hand, or with one it renamed away from. Keep a single item per name so a
|
||||||
// Dragonroll item per name so inventories do not flood the Item list.
|
// piece of gear the world sends folds into that row instead of doubling it.
|
||||||
const sameName = await Item.find({
|
const sameName = await Item.find({
|
||||||
campaign: campaign._id,
|
campaign: campaign._id,
|
||||||
$or: [{ name: fields.name }, { foundryNames: fields.name }]
|
$or: [{ name: fields.name }, { foundryNames: fields.name }]
|
||||||
@@ -109,6 +137,9 @@ async function saveFoundryItem(campaign, source, fullSync = false, folders = nul
|
|||||||
}
|
}
|
||||||
|
|
||||||
item.foundryItemId = foundryItemId;
|
item.foundryItemId = foundryItemId;
|
||||||
|
// `created` says whether this row is new: whoever imports a whole world counts
|
||||||
|
// the rows it made apart from the ones it only wrote over.
|
||||||
|
const created = item.isNew;
|
||||||
if (!fullSync || item.isNew) Object.assign(item, fields);
|
if (!fullSync || item.isNew) Object.assign(item, fields);
|
||||||
// Foundry's own icon is kept on every save, not only when the edits above
|
// Foundry's own icon is kept on every save, not only when the edits above
|
||||||
// land: the item window offers it back after the user picked their own.
|
// land: the item window offers it back after the user picked their own.
|
||||||
@@ -117,14 +148,14 @@ async function saveFoundryItem(campaign, source, fullSync = false, folders = nul
|
|||||||
item.foundryNames = [...item.foundryNames, fields.name].slice(-MAX_FOUNDRY_NAMES);
|
item.foundryNames = [...item.foundryNames, fields.name].slice(-MAX_FOUNDRY_NAMES);
|
||||||
}
|
}
|
||||||
// Which folder of the campaign's item tree the world says this item stands in.
|
// Which folder of the campaign's item tree the world says this item stands in.
|
||||||
// `undefined` means the push says nothing about folders — an item embedded in an
|
// `undefined` means the push says nothing about folders — an older module that
|
||||||
// actor, or a module that knows nothing about them — and the item stays where it
|
// knows nothing about them — and the item stays where it is. The world owns the
|
||||||
// is. The world owns the folder of its own directory, so a move it reports lands on
|
// folder of its own directory, so a move it reports lands on a full snapshot too
|
||||||
// a full snapshot too and wins over one a campaign made from its item list.
|
// and wins over one a campaign made from its item list.
|
||||||
const folder = resolveFoundryItemFolder(source, folders);
|
const folder = resolveFoundryItemFolder(source, folders);
|
||||||
if (folder !== undefined) item.folder = folder;
|
if (folder !== undefined) item.folder = folder;
|
||||||
await item.save();
|
await item.save();
|
||||||
return { foundryItemId, itemId: item.id };
|
return { foundryItemId, itemId: item.id, created };
|
||||||
}
|
}
|
||||||
|
|
||||||
async function syncFoundryItems(campaign, sources, fullSync = false, folders = null) {
|
async function syncFoundryItems(campaign, sources, fullSync = false, folders = null) {
|
||||||
@@ -140,9 +171,9 @@ async function syncFoundryItems(campaign, sources, fullSync = false, folders = n
|
|||||||
// A Foundry world groups its item directory into folders; the campaign mirrors that
|
// A Foundry world groups its item directory into folders; the campaign mirrors that
|
||||||
// tree as Folders of target 'item' so its item list reads like the world's. Every
|
// tree as Folders of target 'item' so its item list reads like the world's. Every
|
||||||
// push from a module that knows about folders carries the whole world tree, and
|
// push from a module that knows about folders carries the whole world tree, and
|
||||||
// names the folder each world item it sends stands in. Items embedded in an actor
|
// names the folder each world item it sends stands in. Only the world's item
|
||||||
// say nothing: the folders they carry belong to that actor's own inventory, and
|
// directory reaches the campaign's item list, so only its folders are mirrored; the
|
||||||
// Dragonroll keeps one item per piece of gear anyway.
|
// inventory folders an actor keeps for itself are none of the item list's business.
|
||||||
|
|
||||||
// The colour a pushed folder carries. `undefined` means the push says nothing about
|
// The colour a pushed folder carries. `undefined` means the push says nothing about
|
||||||
// colours — an older module, which knows nothing about them — and the colour the
|
// colours — an older module, which knows nothing about them — and the colour the
|
||||||
@@ -241,6 +272,47 @@ function resolveFoundryItemFolder(source, folders) {
|
|||||||
return folders.get(foundryFolderId.trim())?._id || null;
|
return folders.get(foundryFolderId.trim())?._id || null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Maps -------------------------------------------------------------------
|
||||||
|
// A scene of the world becomes one of the campaign's maps (Syndria98/dragonroll#99):
|
||||||
|
// services/map-foundry.js says what of a scene travels — its background picture and the
|
||||||
|
// grid laid over it, and nothing else, so the map's pins, its tokens, the folder it
|
||||||
|
// stands in and what one of its cells means stay the campaign's own.
|
||||||
|
|
||||||
|
async function saveFoundryScene(campaign, source, fullSync = false) {
|
||||||
|
const foundrySceneId = String(source?._id || source?.id || '').trim().slice(0, 120);
|
||||||
|
const fields = foundrySceneToMapData(source || {});
|
||||||
|
if (!foundrySceneId || !fields) return null;
|
||||||
|
resolveWorldAssets(fields, campaign);
|
||||||
|
|
||||||
|
let map = await MapModel.findOne({ campaign: campaign._id, foundrySceneId });
|
||||||
|
const dragonrollMapId = source?.flags?.['dragonroll-foundry']?.mapId;
|
||||||
|
if (!map && mongoose.isValidObjectId(dragonrollMapId)) {
|
||||||
|
const flagged = await MapModel.findOne({ _id: dragonrollMapId, campaign: campaign._id });
|
||||||
|
// Only adopt a flagged map while no other scene owns its mapping.
|
||||||
|
if (flagged && (!flagged.foundrySceneId || flagged.foundrySceneId === foundrySceneId)) map = flagged;
|
||||||
|
}
|
||||||
|
if (!map) {
|
||||||
|
// The campaign drew this place by hand before the scene of it ever arrived: a scene
|
||||||
|
// naming the one unmapped map the campaign holds folds into that row instead of
|
||||||
|
// adding a second copy of the same room.
|
||||||
|
const sameName = await MapModel.find({
|
||||||
|
campaign: campaign._id,
|
||||||
|
name: fields.name,
|
||||||
|
foundrySceneId: { $exists: false }
|
||||||
|
}).limit(2);
|
||||||
|
map = sameName.length === 1 ? sameName[0] : new MapModel({ campaign: campaign._id });
|
||||||
|
}
|
||||||
|
|
||||||
|
map.foundrySceneId = foundrySceneId;
|
||||||
|
// `created` says whether this row is new, like the actor and item writers answer it.
|
||||||
|
const created = map.isNew;
|
||||||
|
// A full snapshot runs when a GM reconnects: the grid the campaign lined up for a map
|
||||||
|
// it already has survives that. Live scene edits continue to overwrite normally.
|
||||||
|
if (!fullSync || map.isNew) Object.assign(map, fields);
|
||||||
|
await map.save();
|
||||||
|
return { foundrySceneId, mapId: map.id, created };
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
// Linking a world to a campaign happens through the sign-up link every service
|
// Linking a world to a campaign happens through the sign-up link every service
|
||||||
// uses (routes/service-link.js); what stays here is the sync that world keeps up
|
// uses (routes/service-link.js); what stays here is the sync that world keeps up
|
||||||
@@ -277,12 +349,16 @@ router.post('/sync/snapshot', async (req, res) => {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const fullSync = req.body.fullSync === true;
|
const fullSync = req.body.fullSync === true;
|
||||||
|
// A forced actor sync from the module's context menu replaces the campaign's
|
||||||
|
// row for the actors it sends entirely (Syndria98/dragonroll#96). It stays
|
||||||
|
// clear of fullSync: it never prunes, unlike a reconnect's full snapshot.
|
||||||
|
const replace = req.body.replace === true;
|
||||||
// A module that knows nothing about item folders sends neither the tree
|
// A module that knows nothing about item folders sends neither the tree
|
||||||
// nor the folder of an item, and then nothing here touches the folders.
|
// nor the folder of an item, and then nothing here touches the folders.
|
||||||
const folderSources = Array.isArray(req.body.folders) ? req.body.folders : null;
|
const folderSources = Array.isArray(req.body.folders) ? req.body.folders : null;
|
||||||
const actors = [];
|
const actors = [];
|
||||||
for (const source of actorSources || []) {
|
for (const source of actorSources || []) {
|
||||||
const mapping = await saveFoundryActor(campaign, source, fullSync);
|
const mapping = await saveFoundryActor(campaign, source, fullSync, replace);
|
||||||
if (mapping) actors.push(mapping);
|
if (mapping) actors.push(mapping);
|
||||||
}
|
}
|
||||||
const itemFolders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
|
const itemFolders = folderSources ? await syncFoundryItemFolders(campaign, folderSources) : null;
|
||||||
@@ -297,8 +373,8 @@ router.post('/sync/snapshot', async (req, res) => {
|
|||||||
foundryActorId: { $exists: true, $nin: currentIds }
|
foundryActorId: { $exists: true, $nin: currentIds }
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
// Pruning needs a full snapshot: only that request sees the world
|
// Pruning needs a full snapshot: only that request sees the whole world
|
||||||
// directory and every actor's copies at the same time.
|
// directory, so it alone knows which synced rows the world has let go of.
|
||||||
if (fullSync && itemSources) {
|
if (fullSync && itemSources) {
|
||||||
const currentIds = snapshotItemSources(req.body)
|
const currentIds = snapshotItemSources(req.body)
|
||||||
.map((source) => String(source?._id || source?.id || '').trim())
|
.map((source) => String(source?._id || source?.id || '').trim())
|
||||||
@@ -407,6 +483,59 @@ router.post('/sync/item-delete', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// The world's scenes, upserted as the campaign's maps (Syndria98/dragonroll#99). Like a
|
||||||
|
// world item push, this one prunes only when it is told it carries every scene: that push
|
||||||
|
// alone sees the whole scene list, so it alone knows which synced maps the world has let go
|
||||||
|
// of. A map the campaign made by hand has no scene of its own and is never pruned.
|
||||||
|
router.post('/sync/scenes', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
if (!requestMatchesWorld(campaign, req.body.worldId) || !Array.isArray(req.body.scenes)) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const fullSync = req.body.fullSync === true;
|
||||||
|
const maps = [];
|
||||||
|
for (const source of req.body.scenes) {
|
||||||
|
const mapping = await saveFoundryScene(campaign, source, fullSync);
|
||||||
|
if (mapping) maps.push(mapping);
|
||||||
|
}
|
||||||
|
if (fullSync) {
|
||||||
|
const currentIds = req.body.scenes
|
||||||
|
.map((source) => String(source?._id || source?.id || '').trim())
|
||||||
|
.filter(Boolean);
|
||||||
|
await MapModel.deleteMany({
|
||||||
|
campaign: campaign._id,
|
||||||
|
foundrySceneId: { $exists: true, $nin: currentIds }
|
||||||
|
});
|
||||||
|
}
|
||||||
|
res.json({ status: 'ok', maps });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// A scene the world deleted takes its map with it. Only the world says so; deleting a map
|
||||||
|
// in the campaign leaves the world's scene alone, which is the campaign's own to do.
|
||||||
|
router.post('/sync/scene-delete', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const foundrySceneId = String(req.body.foundrySceneId || '').trim();
|
||||||
|
if (!requestMatchesWorld(campaign, req.body.worldId) || !foundrySceneId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
await MapModel.deleteOne({ campaign: campaign._id, foundrySceneId });
|
||||||
|
res.json({ status: 'ok' });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
// The item list the world reconciles against, together with the folders its rows are
|
// The item list the world reconciles against, together with the folders its rows are
|
||||||
// grouped into — the same shape the campaign's own `/item/list` answers with. The folders
|
// grouped into — the same shape the campaign's own `/item/list` answers with. The folders
|
||||||
// travel back for their colour: the world owns the tree's name and nesting, while whoever
|
// travel back for their colour: the world owns the tree's name and nesting, while whoever
|
||||||
@@ -450,4 +579,61 @@ router.post('/sync/map-item', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// --- Note pages ------------------------------------------------------------
|
||||||
|
// The campaign's notes are read where their authors' table sits: every note
|
||||||
|
// stands as a page of the one journal the world calls "Dragonroll". Notes are
|
||||||
|
// written in Dragonroll, so this copy runs one way — the module reads the notes
|
||||||
|
// and rewrites their pages; nothing of the journal travels back. Its pages keep
|
||||||
|
// the note's id in a `dragonroll-foundry.noteId` flag, and the note keeps the
|
||||||
|
// page's id here, so either side recognises the pairing again after a restart.
|
||||||
|
|
||||||
|
// Every note of the campaign, content included: enough for the module to write
|
||||||
|
// each one as a page. Folders of the notes do not travel — the journal is flat.
|
||||||
|
router.get('/sync/notes', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const notes = await Note.find({ campaign: campaign._id })
|
||||||
|
.select('_id title content foundryPageId date')
|
||||||
|
.sort({ date: -1 })
|
||||||
|
.lean();
|
||||||
|
res.json({ status: 'ok', notes });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// The page the module made for a note, kept on the note so the next reconcile —
|
||||||
|
// or a world whose page flags were lost — writes that page instead of a second
|
||||||
|
// one under the same title.
|
||||||
|
router.post('/sync/map-note', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const { noteId, foundryPageId, worldId } = req.body;
|
||||||
|
if (!requestMatchesWorld(campaign, worldId) || !noteId || !foundryPageId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const note = await Note.findOne({ _id: noteId, campaign: campaign._id });
|
||||||
|
if (!note) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
const existing = await Note.findOne({ campaign: campaign._id, foundryPageId, _id: { $ne: note._id } });
|
||||||
|
if (existing) return res.json({ status: 'error', msg: 'foundry.errors.note-already-synced' });
|
||||||
|
|
||||||
|
note.foundryPageId = String(foundryPageId).trim().slice(0, 120);
|
||||||
|
await note.save();
|
||||||
|
res.json({ status: 'ok', note });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
module.exports = router;
|
module.exports = router;
|
||||||
|
// The writers every Foundry document goes through: the sync pushes above, and the
|
||||||
|
// force import a campaign asks for from its sidebar (routes/foundry.js). One set of
|
||||||
|
// rules decides which campaign row a world document owns, so pulling a world over
|
||||||
|
// twice updates its rows instead of doubling them.
|
||||||
|
module.exports.saveFoundryActor = saveFoundryActor;
|
||||||
|
module.exports.saveFoundryItem = saveFoundryItem;
|
||||||
|
|||||||
@@ -1,6 +1,21 @@
|
|||||||
const express = require('express');
|
const express = require('express');
|
||||||
const router = express.Router();
|
const router = express.Router();
|
||||||
const { requestFoundry } = require('../services/foundry');
|
const { requestFoundry } = require('../services/foundry');
|
||||||
|
const { normalizeIconDirectory, readIconListingPage, shapeIconListing } = require('../services/foundry-icons');
|
||||||
|
|
||||||
|
const Campaign = require('../models/Campaign');
|
||||||
|
// The writers a Foundry document is stored through, shared with the sync pushes the
|
||||||
|
// linked module sends (routes/foundry-link.js) so both write a world's rows by the
|
||||||
|
// same rules.
|
||||||
|
const { saveFoundryActor, saveFoundryItem } = require('./foundry-link');
|
||||||
|
|
||||||
|
// The world address the icons are loaded from is kept on the campaign, so an icon
|
||||||
|
// listing is always asked for one of the caller's own campaigns. The linked world's
|
||||||
|
// id travels along: an import has to know whose data it is pulling over.
|
||||||
|
async function findOwnedCampaign(campaignId, userId) {
|
||||||
|
if (!campaignId) return null;
|
||||||
|
return Campaign.findOne({ _id: campaignId, createdBy: userId }).select('settings foundryWorldId').lean();
|
||||||
|
}
|
||||||
|
|
||||||
async function proxy(path, res) {
|
async function proxy(path, res) {
|
||||||
try {
|
try {
|
||||||
@@ -24,4 +39,95 @@ router.get('/actors/:id/items', (req, res) => proxy(`api/actors/${encodeURICompo
|
|||||||
router.get('/actors/:id', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}`, res));
|
router.get('/actors/:id', (req, res) => proxy(`api/actors/${encodeURIComponent(req.params.id)}`, res));
|
||||||
router.get('/items/:id', (req, res) => proxy(`api/items/${encodeURIComponent(req.params.id)}`, res));
|
router.get('/items/:id', (req, res) => proxy(`api/items/${encodeURIComponent(req.params.id)}`, res));
|
||||||
|
|
||||||
|
// Force import (Syndria98/dragonroll#77): the sidebar's "force import from Foundry"
|
||||||
|
// pulls the whole actor list or item directory of the world the bridge is showing
|
||||||
|
// right now. The documents go through the writers the module's own snapshot push
|
||||||
|
// uses, so a world document lands on the row it owns: what the campaign already has
|
||||||
|
// is written over, not imported a second time. Nothing is pruned here — only a full
|
||||||
|
// snapshot from the module sees the whole world, so dropping rows the world let go of
|
||||||
|
// stays that snapshot's job.
|
||||||
|
router.post('/import', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const kind = ['actors', 'items'].includes(req.body?.kind) ? req.body.kind : null;
|
||||||
|
if (!kind) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const campaign = await findOwnedCampaign(req.body.campaign, req.user.id);
|
||||||
|
if (!campaign) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!campaign.foundryWorldId) {
|
||||||
|
return res.json({ status: 'error', msg: 'foundry.errors.import-not-linked' });
|
||||||
|
}
|
||||||
|
|
||||||
|
// The bridge answers `{status, data, world}`: `data` holds the world's actors
|
||||||
|
// or its world-level items, in the shape the module published them in.
|
||||||
|
let snapshot;
|
||||||
|
try {
|
||||||
|
snapshot = await requestFoundry(`api/${kind}`);
|
||||||
|
} catch (err) {
|
||||||
|
if (err.code !== 'FOUNDRY_NOT_CONFIGURED') console.error(err);
|
||||||
|
return res.json({ status: 'error', msg: 'foundry.errors.import-unavailable' });
|
||||||
|
}
|
||||||
|
if (snapshot.status !== 200 || snapshot.data?.status !== 'ok' || !Array.isArray(snapshot.data.data)) {
|
||||||
|
return res.json({ status: 'error', msg: 'foundry.errors.import-unavailable' });
|
||||||
|
}
|
||||||
|
// The bridge keeps one world's snapshot at a time, so a campaign linked to
|
||||||
|
// another world must not be filled with it. A bridge that does not say whose
|
||||||
|
// world it holds is taken at its word: only a known mismatch stops the import.
|
||||||
|
if (snapshot.data.world?.id && snapshot.data.world.id !== campaign.foundryWorldId) {
|
||||||
|
return res.json({ status: 'error', msg: 'foundry.errors.import-world-mismatch' });
|
||||||
|
}
|
||||||
|
|
||||||
|
let imported = 0;
|
||||||
|
let updated = 0;
|
||||||
|
for (const source of snapshot.data.data) {
|
||||||
|
// An actor without a name, or a world document that is not gear, maps to
|
||||||
|
// nothing and is skipped exactly like a sync push skips it.
|
||||||
|
const mapping = kind === 'actors'
|
||||||
|
? await saveFoundryActor(campaign, source)
|
||||||
|
: await saveFoundryItem(campaign, source);
|
||||||
|
if (!mapping) continue;
|
||||||
|
if (mapping.created) imported += 1;
|
||||||
|
else updated += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
res.json({ status: 'ok', kind, imported, updated });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Foundry's core icon library: the `icons/` folder of the world's data directory.
|
||||||
|
// One folder per request, and the icons inside it paged, because that library runs
|
||||||
|
// into the thousands and the window only ever shows where the user is standing.
|
||||||
|
// The bridge reads it on the Foundry host; the images themselves are loaded by the
|
||||||
|
// browser from the campaign's world address, the same way a synced item's icon is.
|
||||||
|
router.get('/icons', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await findOwnedCampaign(req.query.campaign, req.user.id);
|
||||||
|
if (!campaign) return res.status(404).json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
const base = campaign.settings?.integrations?.foundryUrl || '';
|
||||||
|
if (!base) return res.status(400).json({ status: 'error', msg: 'foundry.errors.icons-no-world-url' });
|
||||||
|
|
||||||
|
const dir = normalizeIconDirectory(req.query.dir);
|
||||||
|
if (!dir) return res.status(400).json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const { limit, offset } = readIconListingPage(req.query);
|
||||||
|
const query = new URLSearchParams({ dir, offset: String(offset), limit: String(limit) });
|
||||||
|
const result = await requestFoundry(`api/icons?${query}`);
|
||||||
|
if (result.status !== 200 || result.data?.status !== 'ok') {
|
||||||
|
return res.status(502).json({ status: 'error', msg: 'foundry.errors.icons-unavailable' });
|
||||||
|
}
|
||||||
|
|
||||||
|
res.json({ status: 'ok', ...shapeIconListing({ base, dir, listing: result.data }) });
|
||||||
|
} catch (err) {
|
||||||
|
if (err.code === 'FOUNDRY_NOT_CONFIGURED') {
|
||||||
|
return res.status(503).json({ status: 'error', msg: 'foundry.errors.icons-unavailable' });
|
||||||
|
}
|
||||||
|
|
||||||
|
console.error(err);
|
||||||
|
res.status(502).json({ status: 'error', msg: 'foundry.errors.icons-unavailable' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
module.exports = router;
|
module.exports = router;
|
||||||
|
|||||||
@@ -1,4 +1,5 @@
|
|||||||
const { numberOr, asText, plainText, stringList } = require('./foundry-fields');
|
const { numberOr, asText, plainText, stringList } = require('./foundry-fields');
|
||||||
|
const { isFoundryGearType } = require('./item-foundry');
|
||||||
|
|
||||||
// D&D 5e keeps an actor's background, species, class and subclass as a reference to an
|
// D&D 5e keeps an actor's background, species, class and subclass as a reference to an
|
||||||
// embedded item: `system.details.background` and friends hold that item's id, and the
|
// embedded item: `system.details.background` and friends hold that item's id, and the
|
||||||
@@ -23,7 +24,117 @@ function detailsName(value, items) {
|
|||||||
return looksLikeFoundryId(text) ? '' : text;
|
return looksLikeFoundryId(text) ? '' : text;
|
||||||
}
|
}
|
||||||
|
|
||||||
function foundryActorToCharacter(foundryActor) {
|
// --- Skills, saving throws, tools, languages and coins (Syndria98/dragonroll#83) ---
|
||||||
|
|
||||||
|
// The eighteen skills a 5e character has, as the system keys them and as Dragonroll
|
||||||
|
// names them. The short keys mean nothing outside Foundry, and Dragonroll's sheet holds
|
||||||
|
// the names it shows a user.
|
||||||
|
const FOUNDRY_SKILLS = {
|
||||||
|
acr: 'acrobatics', ani: 'animalHandling', arc: 'arcana', ath: 'athletics', dec: 'deception',
|
||||||
|
his: 'history', ins: 'insight', itm: 'intimidation', inv: 'investigation', med: 'medicine',
|
||||||
|
nat: 'nature', prc: 'perception', perf: 'performance', prs: 'persuasion', rel: 'religion',
|
||||||
|
sle: 'sleightOfHand', stl: 'stealth', sur: 'survival'
|
||||||
|
};
|
||||||
|
const ABILITIES = ['str', 'dex', 'con', 'int', 'wis', 'cha'];
|
||||||
|
const CURRENCIES = ['pp', 'gp', 'ep', 'sp', 'cp'];
|
||||||
|
|
||||||
|
// Whether one of the system's proficiency fields says the character has that
|
||||||
|
// proficiency. The system has held it several ways across its releases — a boolean, a
|
||||||
|
// number of proficiency steps, a list of proficiency modes ('prof', 'exp'), or one of
|
||||||
|
// those under `value`, `proficient` or `prof` — and worlds run different releases of
|
||||||
|
// it. Anything above nothing counts as proficient.
|
||||||
|
function isProficient(value, depth = 0) {
|
||||||
|
if (value === undefined || value === null || depth > 3) return false;
|
||||||
|
if (typeof value === 'boolean') return value;
|
||||||
|
if (typeof value === 'number') return value > 0;
|
||||||
|
if (typeof value === 'string') {
|
||||||
|
const text = value.trim();
|
||||||
|
if (!text) return false;
|
||||||
|
const number = Number(text);
|
||||||
|
return Number.isFinite(number) ? number > 0 : text.toLowerCase() !== 'none';
|
||||||
|
}
|
||||||
|
if (Array.isArray(value)) return value.some((entry) => isProficient(entry, depth + 1));
|
||||||
|
return ['value', 'proficient', 'prof'].some((key) => isProficient(value[key], depth + 1));
|
||||||
|
}
|
||||||
|
|
||||||
|
// A toggled map (skill name or ability → proficient) from whatever the actor lists.
|
||||||
|
// `null` says the actor says nothing about them at all, which is what keeps a live
|
||||||
|
// Foundry edit from clearing the toggles the campaign set by hand.
|
||||||
|
function toggleMap(sources) {
|
||||||
|
const toggled = {};
|
||||||
|
for (const [name, value] of Object.entries(sources)) {
|
||||||
|
if (value !== undefined) toggled[name] = isProficient(value);
|
||||||
|
}
|
||||||
|
return Object.keys(toggled).length ? toggled : null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundrySkills(system) {
|
||||||
|
const skills = system.skills && typeof system.skills === 'object' ? system.skills : {};
|
||||||
|
return toggleMap(Object.fromEntries(Object.entries(FOUNDRY_SKILLS)
|
||||||
|
.map(([key, name]) => [name, skills[key]])));
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundrySavingThrows(system) {
|
||||||
|
const saves = system.saves && typeof system.saves === 'object' ? system.saves : {};
|
||||||
|
return toggleMap(Object.fromEntries(ABILITIES.map((key) => [
|
||||||
|
key,
|
||||||
|
system.savingThrows?.[key] ?? system.abilities?.[key]?.save ?? saves[key]
|
||||||
|
])));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Tools and languages: the module sends the labels its own CONFIG holds, because a
|
||||||
|
// world's proficiency lists are keys — and, since the third system release, language
|
||||||
|
// documents — that mean nothing outside Foundry. Without them the keys are the best
|
||||||
|
// there is to name a proficiency with, and a bare Foundry document id is worse than
|
||||||
|
// nothing at all. `null` says the actor says nothing about the kind, `[]` that it has
|
||||||
|
// none of it. Dragonroll names its lists in full; the world keeps its tools under
|
||||||
|
// `system.traits.tool` and its languages under `system.traits.languages`.
|
||||||
|
const TRAIT_FIELDS = { tools: 'tool', languages: 'languages' };
|
||||||
|
|
||||||
|
function foundryTraitNames(actor, kind) {
|
||||||
|
const labels = actor.dragonroll?.[kind];
|
||||||
|
if (Array.isArray(labels)) {
|
||||||
|
return [...new Set(labels.map((label) => asText(label).trim()).filter(Boolean))];
|
||||||
|
}
|
||||||
|
const trait = actor.system?.traits?.[TRAIT_FIELDS[kind] ?? kind];
|
||||||
|
if (!trait || typeof trait !== 'object') return null;
|
||||||
|
const names = [
|
||||||
|
...stringList(trait.value),
|
||||||
|
...asText(trait.custom).split(',').map((name) => name.trim())
|
||||||
|
].filter((name) => name && !looksLikeFoundryId(name));
|
||||||
|
return [...new Set(names)];
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundryCurrency(system) {
|
||||||
|
const coins = system.currency;
|
||||||
|
if (!coins || typeof coins !== 'object') return null;
|
||||||
|
return Object.fromEntries(CURRENCIES.map((key) => [key, Math.max(0, numberOr(coins[key], 0))]));
|
||||||
|
}
|
||||||
|
|
||||||
|
// The character's traits as the world writes them: the free-text details field some
|
||||||
|
// system releases keep, or its trait items, which are how a monster's traits and a
|
||||||
|
// character's racial and class features are written. `undefined` says the world holds
|
||||||
|
// no traits to show.
|
||||||
|
function foundryTraits(source, items) {
|
||||||
|
const text = plainText(source.system?.details?.trait);
|
||||||
|
if (text) return text;
|
||||||
|
const features = items
|
||||||
|
.filter((item) => item.type === 'feat' && stringList(item.system?.featType?.value ?? item.system?.featType)
|
||||||
|
.some((type) => asText(type).toLowerCase().startsWith('tr')))
|
||||||
|
.map((item) => {
|
||||||
|
const name = asText(item.name).trim();
|
||||||
|
const description = plainText(item.system?.description?.value ?? item.system?.description);
|
||||||
|
return name ? `${name}\n${description}`.trim() : '';
|
||||||
|
})
|
||||||
|
.filter(Boolean);
|
||||||
|
return features.length ? features.join('\n\n') : undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
// `replace` is a forced actor sync from the module's context menu (Syndria98/dragonroll#96):
|
||||||
|
// it replaces everything the campaign holds for this actor, so the fields a live edit
|
||||||
|
// leaves out when the world says nothing are written empty instead of kept. A live Foundry
|
||||||
|
// change passes `false` and keeps the campaign's own toggles and text.
|
||||||
|
function foundryActorToCharacter(foundryActor, replace = false) {
|
||||||
const system = foundryActor.system || {};
|
const system = foundryActor.system || {};
|
||||||
const details = system.details || {};
|
const details = system.details || {};
|
||||||
const abilities = system.abilities || {};
|
const abilities = system.abilities || {};
|
||||||
@@ -43,7 +154,7 @@ function foundryActorToCharacter(foundryActor) {
|
|||||||
...stringList(traits.tool?.value)
|
...stringList(traits.tool?.value)
|
||||||
].join(', ');
|
].join(', ');
|
||||||
|
|
||||||
return {
|
const fields = {
|
||||||
name: asText(foundryActor.name).trim(),
|
name: asText(foundryActor.name).trim(),
|
||||||
type: ['character', 'npc', 'creature'].includes(savedDragonrollType)
|
type: ['character', 'npc', 'creature'].includes(savedDragonrollType)
|
||||||
? savedDragonrollType
|
? savedDragonrollType
|
||||||
@@ -56,24 +167,62 @@ function foundryActorToCharacter(foundryActor) {
|
|||||||
challengeRating: String(details.cr ?? ''),
|
challengeRating: String(details.cr ?? ''),
|
||||||
description: plainText(details.biography?.value || details.biography),
|
description: plainText(details.biography?.value || details.biography),
|
||||||
image: asText(foundryActor.img || foundryActor.image),
|
image: asText(foundryActor.img || foundryActor.image),
|
||||||
abilityScores: Object.fromEntries(['str', 'dex', 'con', 'int', 'wis', 'cha'].map((key) => [
|
abilityScores: Object.fromEntries(ABILITIES.map((key) => [
|
||||||
key,
|
key,
|
||||||
numberOr(abilities[key]?.value, 10)
|
numberOr(abilities[key]?.value, 10)
|
||||||
])),
|
])),
|
||||||
armorClass: numberOr(attributes.ac?.value ?? attributes.ac, 10),
|
armorClass: numberOr(attributes.ac?.value ?? attributes.ac, 10),
|
||||||
speed: numberOr(movement.walk ?? movement.value, 30),
|
speed: numberOr(movement.walk ?? movement.value, 30),
|
||||||
proficiencies: foundryProficiencies || asText(savedDragonrollFields.proficiencies),
|
// A replace takes the world's text even when it has none, so what Dragonroll
|
||||||
traits: asText(savedDragonrollFields.traits),
|
// cached on the actor's flag does not survive it; a live edit keeps that text.
|
||||||
|
proficiencies: foundryProficiencies || (replace ? '' : asText(savedDragonrollFields.proficiencies)),
|
||||||
|
// What the character carries: gear, and gear only (Syndria98/dragonroll#89). A feat
|
||||||
|
// is a trait — its tab shows it — and a race is the species; standing them in the
|
||||||
|
// inventory next to the longswords is how traits and items got mixed up.
|
||||||
inventory: items
|
inventory: items
|
||||||
.filter((item) => !['class', 'subclass', 'background', 'spell'].includes(item.type))
|
.filter((item) => isFoundryGearType(item.type))
|
||||||
.map((item) => ({
|
.map((item) => ({
|
||||||
name: asText(item.name).trim(),
|
name: asText(item.name).trim(),
|
||||||
quantity: numberOr(item.system?.quantity, 1),
|
quantity: numberOr(item.system?.quantity, 1),
|
||||||
weight: numberOr(item.system?.weight?.value ?? item.system?.weight, 0)
|
weight: numberOr(item.system?.weight?.value ?? item.system?.weight, 0),
|
||||||
|
icon: asText(item.img).trim()
|
||||||
}))
|
}))
|
||||||
.filter((item) => item.name),
|
.filter((item) => item.name),
|
||||||
spells: items.filter((item) => item.type === 'spell').map((item) => asText(item.name)).filter(Boolean).join('\n')
|
spells: items.filter((item) => item.type === 'spell').map((item) => asText(item.name)).filter(Boolean).join('\n')
|
||||||
};
|
};
|
||||||
|
|
||||||
|
// What the world says about each of these, when it says anything: leaving a field
|
||||||
|
// out of the character is what keeps a live Foundry edit from clearing what the
|
||||||
|
// campaign toggled or wrote for it. Traits lead from the world when it has them, the
|
||||||
|
// way the proficiencies do; the text the module carries back on its flag is what the
|
||||||
|
// tab shows for an actor the world says nothing about.
|
||||||
|
const skills = foundrySkills(system);
|
||||||
|
if (skills) fields.skills = skills;
|
||||||
|
const savingThrows = foundrySavingThrows(system);
|
||||||
|
if (savingThrows) fields.savingThrows = savingThrows;
|
||||||
|
const tools = foundryTraitNames(foundryActor, 'tools');
|
||||||
|
if (tools) fields.tools = tools;
|
||||||
|
const languages = foundryTraitNames(foundryActor, 'languages');
|
||||||
|
if (languages) fields.languages = languages;
|
||||||
|
const currency = foundryCurrency(system);
|
||||||
|
if (currency) fields.currency = currency;
|
||||||
|
const worldTraits = foundryTraits(foundryActor, items);
|
||||||
|
const campaignTraits = replace ? '' : asText(savedDragonrollFields.traits);
|
||||||
|
if (worldTraits || campaignTraits) fields.traits = worldTraits || campaignTraits;
|
||||||
|
|
||||||
|
// A replace writes the fields a live edit would leave out when the world says
|
||||||
|
// nothing, so the campaign's toggles, lists and text for this actor go with it and
|
||||||
|
// the row reads as the Foundry actor alone (Syndria98/dragonroll#96).
|
||||||
|
if (replace) {
|
||||||
|
if (fields.skills === undefined) fields.skills = {};
|
||||||
|
if (fields.savingThrows === undefined) fields.savingThrows = {};
|
||||||
|
if (fields.tools === undefined) fields.tools = [];
|
||||||
|
if (fields.languages === undefined) fields.languages = [];
|
||||||
|
if (fields.currency === undefined) fields.currency = {};
|
||||||
|
if (fields.traits === undefined) fields.traits = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
return fields;
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { foundryActorToCharacter };
|
module.exports = { foundryActorToCharacter };
|
||||||
|
|||||||
110
backend/src/services/foundry-icons.js
Normal file
110
backend/src/services/foundry-icons.js
Normal file
@@ -0,0 +1,110 @@
|
|||||||
|
// Foundry's core icon library is the `icons/` folder of its data directory: a few
|
||||||
|
// thousand images spread over its own folder tree. Dragonroll never reads that
|
||||||
|
// tree itself — the bridge on the Foundry host lists one folder per request (see
|
||||||
|
// dragonroll-foundry/bridge/server.js) — but everything that goes over the wire is
|
||||||
|
// normalised here first, so a caller cannot ask for a folder outside the icon root.
|
||||||
|
|
||||||
|
const ICON_ROOT = 'icons';
|
||||||
|
|
||||||
|
// Image formats Foundry's own file picker offers.
|
||||||
|
const ICON_EXTENSIONS = ['.svg', '.png', '.webp', '.jpg', '.jpeg', '.gif', '.avif'];
|
||||||
|
|
||||||
|
// How many icons one request lists. The window asks again for the next page, so a
|
||||||
|
// folder with hundreds of them is never sent or rendered all at once.
|
||||||
|
const DEFAULT_ICON_PAGE_SIZE = 120;
|
||||||
|
const MAX_ICON_PAGE_SIZE = 500;
|
||||||
|
|
||||||
|
// The folder a listing request asks for, inside the icon root: `icons`, `icons/svg`,
|
||||||
|
// ... Empty asks for the root. Anything that tries to leave the root is invalid.
|
||||||
|
function normalizeIconDirectory(input) {
|
||||||
|
const raw = String(input ?? '').trim().replace(/\\/g, '/').replace(/^\/+|\/+$/g, '');
|
||||||
|
if (!raw || raw === '.') return ICON_ROOT;
|
||||||
|
|
||||||
|
const segments = raw.split('/').filter((segment) => segment && segment !== '.');
|
||||||
|
if (!segments.length || segments.includes('..')) return null;
|
||||||
|
if (segments[0] !== ICON_ROOT) return null;
|
||||||
|
return segments.join('/');
|
||||||
|
}
|
||||||
|
|
||||||
|
// The folder above an icon folder, or null at the root.
|
||||||
|
function parentIconDirectory(dir) {
|
||||||
|
const normalized = normalizeIconDirectory(dir);
|
||||||
|
if (!normalized || normalized === ICON_ROOT) return null;
|
||||||
|
return normalized.slice(0, normalized.lastIndexOf('/'));
|
||||||
|
}
|
||||||
|
function iconName(filePath) {
|
||||||
|
const path = String(filePath ?? '');
|
||||||
|
return path.slice(path.lastIndexOf('/') + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
function isIconFile(filePath) {
|
||||||
|
const lower = String(filePath ?? '').toLowerCase();
|
||||||
|
return ICON_EXTENSIONS.some((extension) => lower.endsWith(extension));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Where the browser loads a Foundry data file from: Foundry serves its data
|
||||||
|
// directory over the world's own address, which is the one the campaign keeps
|
||||||
|
// (settings.integrations.foundryUrl). Items store icons as these absolute URLs,
|
||||||
|
// the same way a synced Foundry item's icon arrives as one.
|
||||||
|
function joinFoundryAssetUrl(baseUrl, filePath) {
|
||||||
|
const base = String(baseUrl ?? '').trim();
|
||||||
|
const file = String(filePath ?? '').trim().replace(/^\/+/, '');
|
||||||
|
if (!base || !file) return '';
|
||||||
|
return `${base.replace(/\/+$/, '')}/${encodeURI(file)}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The page a request asks for. Directories are always listed whole — the window
|
||||||
|
// needs every subfolder to navigate — so paging only ever covers the icons.
|
||||||
|
function readIconListingPage(query) {
|
||||||
|
const requestedLimit = Number(query?.limit);
|
||||||
|
const limit = Number.isFinite(requestedLimit)
|
||||||
|
? Math.min(MAX_ICON_PAGE_SIZE, Math.max(1, Math.trunc(requestedLimit)))
|
||||||
|
: DEFAULT_ICON_PAGE_SIZE;
|
||||||
|
const requestedOffset = Number(query?.offset);
|
||||||
|
const offset = Number.isFinite(requestedOffset) ? Math.max(0, Math.trunc(requestedOffset)) : 0;
|
||||||
|
|
||||||
|
return { limit, offset };
|
||||||
|
}
|
||||||
|
|
||||||
|
// The bridge answers with plain relative paths; this is the shape the icon window
|
||||||
|
// works with: the folder it shows, the one above it, its subfolders, and its icons
|
||||||
|
// with a url to load. `next` is the offset of the next page, null once it is all
|
||||||
|
// listed, which is what keeps a big library lazy to load.
|
||||||
|
function shapeIconListing({ base = '', dir, listing = {} } = {}) {
|
||||||
|
const current = normalizeIconDirectory(dir ?? listing.dir) || ICON_ROOT;
|
||||||
|
|
||||||
|
const folders = [];
|
||||||
|
const seenFolders = new Set();
|
||||||
|
for (const entry of Array.isArray(listing.directories) ? listing.directories : []) {
|
||||||
|
const path = normalizeIconDirectory(typeof entry === 'string' ? entry : entry?.path);
|
||||||
|
if (!path || path === current || seenFolders.has(path)) continue;
|
||||||
|
seenFolders.add(path);
|
||||||
|
folders.push({ path, name: iconName(path) });
|
||||||
|
}
|
||||||
|
|
||||||
|
const files = (Array.isArray(listing.files) ? listing.files : [])
|
||||||
|
.map((entry) => String(typeof entry === 'string' ? entry : entry?.path ?? '').trim().replace(/^\/+/, ''))
|
||||||
|
.filter((entry) => entry.startsWith(`${ICON_ROOT}/`) && isIconFile(entry))
|
||||||
|
.map((entry) => ({ path: entry, name: iconName(entry), url: joinFoundryAssetUrl(base, entry) }));
|
||||||
|
|
||||||
|
const offset = Number.isFinite(Number(listing.offset)) ? Math.max(0, Math.trunc(Number(listing.offset))) : 0;
|
||||||
|
const next = Number.isFinite(Number(listing.next)) && Number(listing.next) > offset
|
||||||
|
? Math.trunc(Number(listing.next))
|
||||||
|
: null;
|
||||||
|
|
||||||
|
return { dir: current, parent: parentIconDirectory(current), folders, files, offset, next };
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
ICON_ROOT,
|
||||||
|
ICON_EXTENSIONS,
|
||||||
|
DEFAULT_ICON_PAGE_SIZE,
|
||||||
|
MAX_ICON_PAGE_SIZE,
|
||||||
|
normalizeIconDirectory,
|
||||||
|
parentIconDirectory,
|
||||||
|
iconName,
|
||||||
|
isIconFile,
|
||||||
|
joinFoundryAssetUrl,
|
||||||
|
readIconListingPage,
|
||||||
|
shapeIconListing
|
||||||
|
};
|
||||||
@@ -1,5 +1,11 @@
|
|||||||
async function requestFoundry(path) {
|
async function requestFoundry(path) {
|
||||||
const baseUrl = process.env.FOUNDRY_API_URL;
|
// The bridge a campaign's icon and world reads go to is the very one that
|
||||||
|
// world already pushes its snapshot to. It is often configured under
|
||||||
|
// FOUNDRY_API_CLIENT_URL alone — the address the Foundry client reaches —
|
||||||
|
// while FOUNDRY_API_URL is the optional private one the backend prefers.
|
||||||
|
// Falling back to it keeps a connected, syncing world's reads working
|
||||||
|
// instead of reporting its bridge as unset (Syndria98/dragonroll#74).
|
||||||
|
const baseUrl = process.env.FOUNDRY_API_URL || process.env.FOUNDRY_API_CLIENT_URL;
|
||||||
const token = process.env.FOUNDRY_API_TOKEN;
|
const token = process.env.FOUNDRY_API_TOKEN;
|
||||||
|
|
||||||
if (!baseUrl || !token) {
|
if (!baseUrl || !token) {
|
||||||
|
|||||||
@@ -23,6 +23,14 @@ const NON_GEAR_FOUNDRY_TYPES = new Set([
|
|||||||
'spell', 'class', 'subclass', 'background', 'feat', 'race', 'species', 'status', 'spellbook', 'language'
|
'spell', 'class', 'subclass', 'background', 'feat', 'race', 'species', 'status', 'spellbook', 'language'
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
// Whether a Foundry document of this type is gear: something a character carries. Traits,
|
||||||
|
// species, spells and the rest are documents of the world that mean something else on a
|
||||||
|
// Dragonroll sheet — a feat is a trait and a race is a species — so they stand in the
|
||||||
|
// character's own fields, never in its inventory (Syndria98/dragonroll#89).
|
||||||
|
function isFoundryGearType(type) {
|
||||||
|
return !NON_GEAR_FOUNDRY_TYPES.has(asText(type).toLowerCase().trim());
|
||||||
|
}
|
||||||
|
|
||||||
// Item categories the Dragonroll Item model accepts.
|
// Item categories the Dragonroll Item model accepts.
|
||||||
const CATEGORIES = ['weapon', 'armor', 'shield', 'adventuring-gear', 'magic-item', 'consumable', 'tool', 'treasure', 'other'];
|
const CATEGORIES = ['weapon', 'armor', 'shield', 'adventuring-gear', 'magic-item', 'consumable', 'tool', 'treasure', 'other'];
|
||||||
|
|
||||||
@@ -107,4 +115,4 @@ function foundryItemToItemData(foundryItem) {
|
|||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { foundryItemToItemData };
|
module.exports = { foundryItemToItemData, isFoundryGearType };
|
||||||
|
|||||||
49
backend/src/services/map-foundry.js
Normal file
49
backend/src/services/map-foundry.js
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
const { numberOr, asText } = require('./foundry-fields');
|
||||||
|
|
||||||
|
// A Foundry scene is one of the campaign's maps (Syndria98/dragonroll#99): its background
|
||||||
|
// picture and the grid laid over it travel to Dragonroll. Everything else a scene holds —
|
||||||
|
// its padding, its lighting, the tokens standing on it — belongs to the world's table, and
|
||||||
|
// so does what one of its cells stands for (`gridDistance` with its units): the campaign
|
||||||
|
// sets its own scale and keeps it.
|
||||||
|
|
||||||
|
// The scene's background picture: `background.src` since Foundry V13, plain `img` before.
|
||||||
|
function sceneImage(scene) {
|
||||||
|
return asText(scene?.background?.src).trim() || asText(scene?.img).trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
// How many pixels of the picture one grid cell covers. Foundry keeps it under `grid.size`
|
||||||
|
// since V13 and under plain `grid` before; 50 px is its own default cell size, and
|
||||||
|
// Dragonroll's is the same, so a scene that says nothing gets the grid it draws.
|
||||||
|
function sceneGridSize(scene) {
|
||||||
|
const size = numberOr(scene?.grid?.size ?? scene?.grid, 0);
|
||||||
|
return size >= 1 ? Math.round(size) : 50;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Where that grid starts on the picture. A world shifts it with the core flags of its own
|
||||||
|
// (`flags.core.shiftX` / `.shiftY`, what it uses to line a hexagonal grid up); one that says
|
||||||
|
// nothing has its grid at the corner of the picture. The scene's padding is blank canvas
|
||||||
|
// *outside* the picture, so it is no part of the grid the campaign lays on the picture itself.
|
||||||
|
function sceneGridOffset(scene, axis) {
|
||||||
|
return Math.round(numberOr(scene?.flags?.core?.[`shift${axis}`], 0));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Returns null for a scene that is not a map: one with no name, or with no background
|
||||||
|
// picture. A Dragonroll map without a picture is an empty viewer, so those scenes stay in
|
||||||
|
// the world — their id is still listed by the snapshot that carries them, so nothing of the
|
||||||
|
// campaign is pruned because of one.
|
||||||
|
function foundrySceneToMapData(scene) {
|
||||||
|
const name = asText(scene?.name).trim();
|
||||||
|
const image = sceneImage(scene);
|
||||||
|
if (!name || !image) return null;
|
||||||
|
|
||||||
|
return {
|
||||||
|
name,
|
||||||
|
// The module sends Foundry's picture as an absolute URL, like actors do.
|
||||||
|
image,
|
||||||
|
gridSize: sceneGridSize(scene),
|
||||||
|
offsetX: sceneGridOffset(scene, 'X'),
|
||||||
|
offsetY: sceneGridOffset(scene, 'Y')
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
module.exports = { foundrySceneToMapData };
|
||||||
@@ -13,12 +13,14 @@ Discord server B ──link──▶ Dragonroll campaign "Silang" (account g
|
|||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
- `/characters [type]` lists the linked campaign's actors, optionally filtered to characters, NPCs, or creatures.
|
- `/characters [type]` lists the linked campaign's actors, optionally filtered to characters, NPCs, or creatures. Each one that a player has claimed with `/dragonroll assign` shows that player next to it.
|
||||||
- `/character name public:true` shows the matching actor's portrait (when one has been uploaded), profile, ability scores, combat stats, proficiencies, traits, spells, and inventory. Type part of a name to pick it from the campaign's current roster. Set `public` to `true` to show the reply to everyone in the channel.
|
- `/character name public:true` shows the matching actor's portrait (when one has been uploaded), profile, ability scores, combat stats, proficiencies, traits, spells, and inventory. Type part of a name to pick it from the campaign's current roster. Set `public` to `true` to show the reply to everyone in the channel.
|
||||||
- `/dragonroll connect` starts a short-lived Dragonroll sign-in and authorization link, and confirms here once somebody authorizes the server.
|
- `/dragonroll connect` starts a short-lived Dragonroll sign-in and authorization link, and confirms here once somebody authorizes the server.
|
||||||
- `/dragonroll link` lets a server administrator choose a campaign owned by the connected Dragonroll account. Type part of a campaign name to filter the choices.
|
- `/dragonroll link` lets a server administrator choose a campaign owned by the connected Dragonroll account. Type part of a campaign name to filter the choices.
|
||||||
- `/dragonroll unlink` removes this server’s campaign link.
|
- `/dragonroll unlink` removes this server’s campaign link.
|
||||||
- `/dragonroll status` shows the campaign linked to this server.
|
- `/dragonroll status` shows the campaign linked to this server, and the character linked to your Discord account on it.
|
||||||
|
- `/dragonroll assign character` links that character of the campaign to your Discord account: each player holds one character, so claiming a second one frees the first. Anyone can take a free character; only a server administrator can take a character another player already holds.
|
||||||
|
- `/dragonroll unassign [character]` removes a character link. Without the option you give up your own character; naming somebody else’s character takes it off them, which only a server administrator can do.
|
||||||
- `/dragonroll refresh` rechecks the current connection and campaign in Dragonroll.
|
- `/dragonroll refresh` rechecks the current connection and campaign in Dragonroll.
|
||||||
|
|
||||||
Replies are private by default. `/character` can be made public with its `public` option, so everyone in the channel can see the character sheet.
|
Replies are private by default. `/character` can be made public with its `public` option, so everyone in the channel can see the character sheet.
|
||||||
|
|||||||
@@ -51,7 +51,24 @@ const commands = [
|
|||||||
.setDescription('Show the campaign linked to this server.'))
|
.setDescription('Show the campaign linked to this server.'))
|
||||||
.addSubcommand((subcommand) => subcommand
|
.addSubcommand((subcommand) => subcommand
|
||||||
.setName('refresh')
|
.setName('refresh')
|
||||||
.setDescription('Refresh this server’s Dragonroll connection status.')))
|
.setDescription('Refresh this server’s Dragonroll connection status.'))
|
||||||
|
.addSubcommand((subcommand) => subcommand
|
||||||
|
.setName('assign')
|
||||||
|
.setDescription('Link one character of the campaign to your Discord account.')
|
||||||
|
.addStringOption((option) => option
|
||||||
|
.setName('character')
|
||||||
|
.setDescription('Character to play (pick it from the campaign roster).')
|
||||||
|
.setRequired(true)
|
||||||
|
.setMaxLength(100)
|
||||||
|
.setAutocomplete(true)))
|
||||||
|
.addSubcommand((subcommand) => subcommand
|
||||||
|
.setName('unassign')
|
||||||
|
.setDescription('Remove the link between a character and a Discord player.')
|
||||||
|
.addStringOption((option) => option
|
||||||
|
.setName('character')
|
||||||
|
.setDescription('Character to free (yours by default, anyone’s as a server administrator).')
|
||||||
|
.setMaxLength(100)
|
||||||
|
.setAutocomplete(true))))
|
||||||
];
|
];
|
||||||
|
|
||||||
module.exports = commands;
|
module.exports = commands;
|
||||||
|
|||||||
@@ -123,7 +123,32 @@ function createDragonrollApi(config) {
|
|||||||
return { campaign, actors: payload.actors };
|
return { campaign, actors: payload.actors };
|
||||||
}
|
}
|
||||||
|
|
||||||
return { startAuthorization, claimLinkNotifications, getStatus, getCampaign, listCampaigns, linkCampaign, unlinkCampaign, listActors };
|
// Linking players to characters (Syndria98/dragonroll#72). `admin` says
|
||||||
|
// whether the Discord side already checked the person is a server
|
||||||
|
// administrator, who may move a character somebody else holds.
|
||||||
|
async function assignActor(guildId, { actorId, discordUserId, admin = false }) {
|
||||||
|
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/actors/assign`, {
|
||||||
|
method: 'POST',
|
||||||
|
body: JSON.stringify({ actorId, discordUserId: String(discordUserId), admin })
|
||||||
|
});
|
||||||
|
if (!payload.actor) throw new Error('Dragonroll returned an invalid character link.');
|
||||||
|
return { actor: payload.actor, previous: payload.previous ?? null };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function unassignActor(guildId, { actorId, discordUserId, admin = false }) {
|
||||||
|
const payload = await request(`/discord/bot/guild/${encodeURIComponent(guildId)}/actors/unassign`, {
|
||||||
|
method: 'POST',
|
||||||
|
body: JSON.stringify({
|
||||||
|
discordUserId: String(discordUserId),
|
||||||
|
...(actorId ? { actorId } : {}),
|
||||||
|
admin
|
||||||
|
})
|
||||||
|
});
|
||||||
|
if (!payload.actor) throw new Error('Dragonroll returned an invalid character link.');
|
||||||
|
return { actor: payload.actor, wasYours: payload.wasYours === true };
|
||||||
|
}
|
||||||
|
|
||||||
|
return { startAuthorization, claimLinkNotifications, getStatus, getCampaign, listCampaigns, linkCampaign, unlinkCampaign, listActors, assignActor, unassignActor };
|
||||||
}
|
}
|
||||||
|
|
||||||
module.exports = { createDragonrollApi, CampaignNotLinkedError, DragonrollNotConnectedError };
|
module.exports = { createDragonrollApi, CampaignNotLinkedError, DragonrollNotConnectedError };
|
||||||
|
|||||||
@@ -234,6 +234,20 @@ async function main() {
|
|||||||
: 'Not linked yet.' }
|
: 'Not linked yet.' }
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// The campaign's character linked to this Discord account (#72), when there is one.
|
||||||
|
if (status.campaign) {
|
||||||
|
try {
|
||||||
|
const { actors } = await dragonroll.listActors(guildId);
|
||||||
|
const yours = actors.find((actor) => String(actor.discordUserId ?? '') === interaction.user.id);
|
||||||
|
embed.addFields({
|
||||||
|
name: 'Your character',
|
||||||
|
value: yours ? safeField(yours.name, 100) : 'None. Run /dragonroll assign to link one to your Discord account.'
|
||||||
|
});
|
||||||
|
} catch {
|
||||||
|
// The roster is a bonus of this card, which stays useful without it.
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if (!status.connected) {
|
if (!status.connected) {
|
||||||
embed.setDescription('A server administrator can run /dragonroll connect to connect a Dragonroll account.');
|
embed.setDescription('A server administrator can run /dragonroll connect to connect a Dragonroll account.');
|
||||||
} else if (!status.campaign) {
|
} else if (!status.campaign) {
|
||||||
@@ -243,6 +257,78 @@ async function main() {
|
|||||||
await respond(interaction, { embeds: [embed] });
|
await respond(interaction, { embeds: [embed] });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// /dragonroll assign and unassign (Syndria98/dragonroll#72): each player of the
|
||||||
|
// server holds one character of the linked campaign. Anyone claims a free
|
||||||
|
// character for themselves; server administrators also move and free the ones
|
||||||
|
// somebody else holds.
|
||||||
|
async function handleActorAssignment(interaction, guildId, subcommand) {
|
||||||
|
const isAdmin = interaction.memberPermissions?.has(PermissionFlagsBits.Administrator) === true;
|
||||||
|
const name = interaction.options.getString('character');
|
||||||
|
const { actors } = await dragonroll.listActors(guildId);
|
||||||
|
|
||||||
|
// Unassign without a character gives up the one linked to you.
|
||||||
|
if (subcommand === 'unassign' && !name) {
|
||||||
|
const mine = actors.find((actor) => String(actor.discordUserId ?? '') === interaction.user.id);
|
||||||
|
if (!mine) {
|
||||||
|
await respond(interaction, { content: 'You do not have a character linked to your Discord account here. Run `/dragonroll assign` to claim one.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await dragonroll.unassignActor(guildId, { discordUserId: interaction.user.id });
|
||||||
|
await respond(interaction, { content: `You are no longer linked to **${safeField(mine.name, 100)}**.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = findActor(actors, name);
|
||||||
|
if (!result.actor) {
|
||||||
|
await respond(interaction, {
|
||||||
|
content: result.matches?.length
|
||||||
|
? safeField(`Several characters match **${name}**: ${result.matches.slice(0, 15).map((actor) => actor.name).join(', ')}. Try a more specific name.`, 1800)
|
||||||
|
: safeField(`I couldn't find a character named **${name}**. Try \`/characters\` to see the campaign roster.`, 1800)
|
||||||
|
});
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const actor = result.actor;
|
||||||
|
const holder = String(actor.discordUserId ?? '');
|
||||||
|
|
||||||
|
if (subcommand === 'assign') {
|
||||||
|
if (holder === interaction.user.id) {
|
||||||
|
await respond(interaction, { content: `You are already linked to **${safeField(actor.name, 100)}**.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (holder && !isAdmin) {
|
||||||
|
await respond(interaction, { content: `**${safeField(actor.name, 100)}** is already linked to <@${holder}>. A server administrator can give it away and take it with the same command.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const { previous } = await dragonroll.assignActor(guildId, {
|
||||||
|
actorId: String(actor._id),
|
||||||
|
discordUserId: interaction.user.id,
|
||||||
|
admin: isAdmin
|
||||||
|
});
|
||||||
|
const lines = [`You are now linked to **${safeField(actor.name, 100)}**.`];
|
||||||
|
if (holder) lines.push(`That character was linked to <@${holder}>; the link is removed.`);
|
||||||
|
if (previous) lines.push(`Your previous character, **${safeField(previous.name, 100)}**, is free again.`);
|
||||||
|
await respond(interaction, { content: safeField(lines.join('\n'), 1800) });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Unassign with a character named: your own, or anybody's as an administrator.
|
||||||
|
if (!holder) {
|
||||||
|
await respond(interaction, { content: `**${safeField(actor.name, 100)}** does not have a linked Discord player.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (holder !== interaction.user.id && !isAdmin) {
|
||||||
|
await respond(interaction, { content: `**${safeField(actor.name, 100)}** is linked to <@${holder}>. Only a server administrator can unlink it.` });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
await dragonroll.unassignActor(guildId, { actorId: String(actor._id), discordUserId: interaction.user.id, admin: isAdmin });
|
||||||
|
await respond(interaction, {
|
||||||
|
content: holder === interaction.user.id
|
||||||
|
? `You are no longer linked to **${safeField(actor.name, 100)}**.`
|
||||||
|
: `**${safeField(actor.name, 100)}** is no longer linked to <@${holder}>.`
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
client.once(Events.ClientReady, (readyClient) => {
|
client.once(Events.ClientReady, (readyClient) => {
|
||||||
console.log(`Dragonroll character bot is online as ${readyClient.user.tag}, in ${readyClient.guilds.cache.size} servers.`);
|
console.log(`Dragonroll character bot is online as ${readyClient.user.tag}, in ${readyClient.guilds.cache.size} servers.`);
|
||||||
// Guild commands registered when the bot joined shadow global ones and
|
// Guild commands registered when the bot joined shadow global ones and
|
||||||
@@ -331,9 +417,16 @@ async function main() {
|
|||||||
await respondActorChoices(interaction, guildId);
|
await respondActorChoices(interaction, guildId);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (interaction.commandName === 'dragonroll' && interaction.options.getSubcommand() === 'link') {
|
if (interaction.commandName === 'dragonroll') {
|
||||||
await respondCampaignChoices(interaction, guildId);
|
const subcommand = interaction.options.getSubcommand();
|
||||||
return;
|
if (subcommand === 'link') {
|
||||||
|
await respondCampaignChoices(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (['assign', 'unassign'].includes(subcommand)) {
|
||||||
|
await respondActorChoices(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
}
|
}
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@@ -412,6 +505,34 @@ async function main() {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Players link themselves to a character of the campaign (Syndria98/dragonroll#72).
|
||||||
|
if (['assign', 'unassign'].includes(subcommand)) {
|
||||||
|
await interaction.deferReply({ flags: MessageFlags.Ephemeral });
|
||||||
|
try {
|
||||||
|
await handleActorAssignment(interaction, guildId, subcommand);
|
||||||
|
} catch (error) {
|
||||||
|
if (error instanceof DragonrollNotConnectedError) {
|
||||||
|
await explainNotConnected(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (error instanceof CampaignNotLinkedError) {
|
||||||
|
await explainMissingCampaign(interaction, guildId);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (error.code === 'discord.errors.actor-held') {
|
||||||
|
await respond(interaction, { content: 'That character is already linked to another player. A server administrator can give it away and take it with the same command.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (error.status === 401 || error.message.includes('DRAGONROLL_DISCORD_BOT_SECRET')) {
|
||||||
|
await respond(interaction, { content: 'The bot API secret is missing or does not match the backend. Contact the bot operator.' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
console.error(`Could not ${subcommand} a character link in Discord server ${guildId}:`, error.message);
|
||||||
|
await respond(interaction, { content: 'I could not change that character link right now. Please try again.' });
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
await interaction.deferReply({ flags: MessageFlags.Ephemeral });
|
await interaction.deferReply({ flags: MessageFlags.Ephemeral });
|
||||||
await showStatus(interaction, guildId);
|
await showStatus(interaction, guildId);
|
||||||
return;
|
return;
|
||||||
@@ -442,7 +563,10 @@ async function main() {
|
|||||||
const details = [actor.species, actor.className, actor.level ? `Lv. ${actor.level}` : null]
|
const details = [actor.species, actor.className, actor.level ? `Lv. ${actor.level}` : null]
|
||||||
.filter(Boolean)
|
.filter(Boolean)
|
||||||
.join(' · ');
|
.join(' · ');
|
||||||
return `• **${actor.name}**${details ? ` — ${details}` : ''}`;
|
// The player a character is linked to (#72); mentions never ping
|
||||||
|
// here, the replies parse no mentions.
|
||||||
|
const player = actor.discordUserId ? ` 🎮 <@${actor.discordUserId}>` : '';
|
||||||
|
return `• **${actor.name}**${details ? ` — ${details}` : ''}${player}`;
|
||||||
});
|
});
|
||||||
const embed = new EmbedBuilder()
|
const embed = new EmbedBuilder()
|
||||||
.setTitle(`Characters of ${campaign.name}`)
|
.setTitle(`Characters of ${campaign.name}`)
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
Foundry modules run in the game client, so the module cannot bind an HTTP port on the Foundry host.
|
Foundry modules run in the game client, so the module cannot bind an HTTP port on the Foundry host.
|
||||||
This integration uses a small companion bridge process on that host:
|
This integration uses a small companion bridge process on that host:
|
||||||
|
|
||||||
1. A linked GM client syncs character Actors and world Items directly with the Dragonroll campaign.
|
1. A linked GM client syncs character Actors, world Items and Scenes directly with the Dragonroll campaign.
|
||||||
2. The module publishes the active world's actor and item snapshot to the optional bridge.
|
2. The module publishes the active world's actor and item snapshot to the optional bridge.
|
||||||
3. The bridge serves authenticated HTTP read endpoints that Dragonroll proxies under `/api/foundry/*`.
|
3. The bridge serves authenticated HTTP read endpoints that Dragonroll proxies under `/api/foundry/*`.
|
||||||
|
|
||||||
@@ -73,25 +73,27 @@ 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
|
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**.
|
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
|
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
|
when autosync is off, **replacing everything that campaign holds for them** (Syndria98/dragonroll#96):
|
||||||
snapshot does and a forced sync never claims to. Actors Dragonroll does not import (anything that is
|
what the campaign had edited on those actors is written over by what the world says. It replaces
|
||||||
not a character, NPC or creature) are refused with a notification.
|
those actors 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
|
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.
|
`/api/foundry/*`, which is never written into the campaign.
|
||||||
|
|
||||||
### Items
|
### Items
|
||||||
|
|
||||||
The campaign's Item list is synchronized with the world's gear, both ways:
|
The campaign's Item list mirrors the world's item directory (Foundry's **items tab**) and nothing
|
||||||
|
else (Syndria98/dragonroll#67):
|
||||||
|
|
||||||
- The GM sends the world item directory (`game.items`) with every snapshot, and world items created,
|
- The GM sends the world item directory (`game.items`) with every snapshot, and world items created,
|
||||||
changed or deleted in Foundry are pushed as they happen. Items embedded in a character travel with
|
changed or deleted in Foundry are pushed as they happen. The items embedded in a character are that
|
||||||
that character's snapshot instead.
|
character's own inventory: they travel with its snapshot and stay on its sheet, so gear a character
|
||||||
- Gear is deduplicated by name: the same sword in the world directory and in three characters'
|
merely carries does not stand in the campaign's item list.
|
||||||
inventories becomes one Dragonroll item. Names Dragonroll renames away from are remembered on the
|
- A world item folds into a Dragonroll row that already carries its name — one a campaign made by hand,
|
||||||
item (`foundryNames`), so Foundry's copies keep folding into it rather than coming back as a
|
or one it renamed away from and remembers (`foundryNames`) — instead of doubling it. Spells, classes,
|
||||||
duplicate. Spells, classes, subclasses, backgrounds, feats and species are not gear and are not
|
subclasses, backgrounds, feats and species are not gear and are not imported.
|
||||||
imported.
|
|
||||||
- Foundry owns the fields it sends (category from the item type, rarity, quantity, weight, weapon
|
- Foundry owns the fields it sends (category from the item type, rarity, quantity, weight, weapon
|
||||||
properties, description). An item made by hand in Dragonroll is created in the world's item
|
properties, description). An item made by hand in Dragonroll is created in the world's item
|
||||||
directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry
|
directory on the next reconcile, mapped afterwards, and editing it in Dragonroll updates the Foundry
|
||||||
@@ -101,10 +103,45 @@ The campaign's Item list is synchronized with the world's gear, both ways:
|
|||||||
what the GM colours in Foundry shows on the campaign's folder, and what the campaign colours lands on
|
what the GM colours in Foundry shows on the campaign's folder, and what the campaign colours lands on
|
||||||
the world's folder on the next reconcile (the world's document keeps its name and nesting either way).
|
the world's folder on the next reconcile (the world's document keeps its name and nesting either way).
|
||||||
- A full snapshot keeps Dragonroll edits on reconnect; live Foundry edits overwrite. Item removal is
|
- A full snapshot keeps Dragonroll edits on reconnect; live Foundry edits overwrite. Item removal is
|
||||||
pruned only by a full snapshot, so a live item push never deletes anything. Deleting a synced item in
|
pruned only by a full snapshot, so a live item push never deletes anything: only a full snapshot sees
|
||||||
Dragonroll removes its Foundry world copy on the next reconcile. Items that live only in an actor's
|
the whole world directory and can tell which synced rows it has let go of. Deleting a synced item in
|
||||||
inventory are owned by that actor's snapshot: editing such an item in Dragonroll does not rewrite the
|
Dragonroll removes its Foundry world copy on the next reconcile.
|
||||||
actor's copy.
|
|
||||||
|
### Maps
|
||||||
|
|
||||||
|
A scene of the world is one of the campaign's maps (Syndria98/dragonroll#99), and only two things
|
||||||
|
about it cross over: the scene's **background picture** and the **grid** laid over it.
|
||||||
|
|
||||||
|
- The picture is sent as an absolute URL of this world, the way an actor's portrait is, so the
|
||||||
|
campaign draws the same battle map the table is looking at. Its cell size is the scene's own
|
||||||
|
(`grid`, and `grid.size` since Foundry V13), and the grid starts where the world shifts it
|
||||||
|
(`flags.core.shiftX` / `.shiftY`). A scene with no background picture makes no map.
|
||||||
|
- Everything else a scene holds stays in the world, and everything else a map holds stays in the
|
||||||
|
campaign: what one of its cells stands for, the folder it stands in, the notes pinned onto it and
|
||||||
|
the actors standing on it as tokens are the campaign's own. Nothing of a map is written back into
|
||||||
|
the world — scene sync runs one way, so a map deleted in the campaign comes back with its scene on
|
||||||
|
the next full list, and taking the scene off is what ends the map.
|
||||||
|
- A scene is matched to a map by its Foundry id, kept on the map as `foundrySceneId` (unique within
|
||||||
|
the campaign). A campaign that drew the same place by hand before its scene arrived is adopted
|
||||||
|
instead of doubled: the scene takes over the unmapped map holding its name.
|
||||||
|
- Live scene edits overwrite the map, including a picture and grid the campaign had set itself; a
|
||||||
|
full snapshot (the world linking or loading) leaves a map it already has alone. The maps of scenes
|
||||||
|
the world let go of are pruned by a full snapshot only, and a scene deleted in the world is
|
||||||
|
reported on `foundry/sync/scene-delete`.
|
||||||
|
- Autosync covers maps like everything else: turned off, no scene crosses over at all, and the ones
|
||||||
|
queued while it was off go over when it is turned back on.
|
||||||
|
|
||||||
|
### Notes
|
||||||
|
|
||||||
|
The campaign's notes read like the campaign's journal in the world (Syndria98/dragonroll#98): every
|
||||||
|
note stands as a page of one JournalEntry named **Dragonroll**. The module creates that journal — or
|
||||||
|
adopts one the GM already made under that name, marking it as the notes' journal — and renders each
|
||||||
|
note's markdown into page HTML with Foundry's own renderer. Notes are written in Dragonroll, so this
|
||||||
|
copy runs one way: a note made or edited in the campaign rewrites its page on the next reconcile, and
|
||||||
|
a note deleted there takes its page with it. A page standing under a note's title but carrying no
|
||||||
|
Dragonroll mark is claimed as that note's page, so a lost pairing does not double it. Any other page in
|
||||||
|
that journal — the GM's own — is left alone, and nothing written in the journal travels back. Autosync
|
||||||
|
off stops it too, like the rest of the sync.
|
||||||
|
|
||||||
The module calls these Dragonroll routes with the campaign sync token (no Dragonroll login):
|
The module calls these Dragonroll routes with the campaign sync token (no Dragonroll login):
|
||||||
|
|
||||||
@@ -113,14 +150,20 @@ The module calls these Dragonroll routes with the campaign sync token (no Dragon
|
|||||||
| `POST /api/foundry/sync/snapshot` | Actors and world items upsert; `fullSync` also prunes |
|
| `POST /api/foundry/sync/snapshot` | Actors and world items upsert; `fullSync` also prunes |
|
||||||
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
|
| `POST /api/foundry/sync/item-snapshot` | Live world item edits, upsert only |
|
||||||
| `POST /api/foundry/sync/item-delete` | A world item was deleted |
|
| `POST /api/foundry/sync/item-delete` | A world item was deleted |
|
||||||
|
| `POST /api/foundry/sync/scenes` | The world's scenes upsert as the campaign's maps; `fullSync` also prunes |
|
||||||
|
| `POST /api/foundry/sync/scene-delete` | A scene was deleted |
|
||||||
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
|
| `GET /api/foundry/sync/characters` | Characters to apply back in Foundry |
|
||||||
| `GET /api/foundry/sync/items` | Items, and the item folders with their Dragonroll colours, to apply back in Foundry |
|
| `GET /api/foundry/sync/items` | Items, and the item folders with their Dragonroll colours, to apply back in Foundry |
|
||||||
|
| `GET /api/foundry/sync/notes` | The campaign's notes, markdown and all, and the journal page each stands as |
|
||||||
|
| `POST /api/foundry/sync/map-note` | Store a note's journal page id after creating that page |
|
||||||
| `GET /api/foundry/sync/status` | The campaign this world's token belongs to, for the module's pairing status |
|
| `GET /api/foundry/sync/status` | The campaign this world's token belongs to, for the module's pairing status |
|
||||||
| `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document |
|
| `POST /api/foundry/sync/map` / `map-item` | Store an id mapping after creating a document |
|
||||||
| `POST /api/foundry/sync/delete` | An actor was deleted |
|
| `POST /api/foundry/sync/delete` | An actor was deleted |
|
||||||
|
|
||||||
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId`
|
Foundry documents keep the Dragonroll id in the `dragonroll-foundry.actorId` / `dragonroll-foundry.itemId`
|
||||||
flag, and world items are marked with `dragonroll-foundry.syncMutation` while Dragonroll writes them so
|
flag, and a journal page the module made for a note keeps its note's id in the `dragonroll-foundry.noteId`
|
||||||
|
flag, so the notes reconcile recognises its own pages. World items are marked with
|
||||||
|
`dragonroll-foundry.syncMutation` while Dragonroll writes them so
|
||||||
the write is not echoed back. A folder colour is written with that folder held in the client's set of
|
the write is not echoed back. A folder colour is written with that folder held in the client's set of
|
||||||
folders being synced, for the same reason.
|
folders being synced, for the same reason.
|
||||||
|
|
||||||
@@ -135,6 +178,9 @@ export DRAGONROLL_FOUNDRY_PUSH_TOKEN='replace-with-a-different-long-random-publi
|
|||||||
export DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS='https://vtt.example.com'
|
export DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS='https://vtt.example.com'
|
||||||
export DRAGONROLL_FOUNDRY_HOST='0.0.0.0'
|
export DRAGONROLL_FOUNDRY_HOST='0.0.0.0'
|
||||||
export DRAGONROLL_FOUNDRY_PORT='8787'
|
export DRAGONROLL_FOUNDRY_PORT='8787'
|
||||||
|
# Optional: the Foundry Data directory. With it the bridge can list the core
|
||||||
|
# `icons/` library Dragonroll's item icon browser shows.
|
||||||
|
export DRAGONROLL_FOUNDRY_DATA_PATH='/home/foundry/Foundry Data'
|
||||||
npm start --prefix foundry/bridge
|
npm start --prefix foundry/bridge
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -170,6 +216,7 @@ The backend exposes these JWT-protected routes when the optional snapshot bridge
|
|||||||
| `GET /api/foundry/actors/:id/items` | Items embedded in an actor |
|
| `GET /api/foundry/actors/:id/items` | Items embedded in an actor |
|
||||||
| `GET /api/foundry/items` | World-level items |
|
| `GET /api/foundry/items` | World-level items |
|
||||||
| `GET /api/foundry/items/:id` | One world-level item |
|
| `GET /api/foundry/items/:id` | One world-level item |
|
||||||
|
| `GET /api/foundry/icons?campaign=&dir=&offset=` | One folder of Foundry's core icon library |
|
||||||
|
|
||||||
The bridge exposes the matching routes under `/api/*`, plus `GET /health`. Data routes require
|
The bridge exposes the matching routes under `/api/*`, plus `GET /health`. Data routes require
|
||||||
`Authorization: Bearer <read-token>`. Responses contain `{ status: "ok", data, world, syncedAt,
|
`Authorization: Bearer <read-token>`. Responses contain `{ status: "ok", data, world, syncedAt,
|
||||||
@@ -177,6 +224,13 @@ ageSeconds, stale }`. The snapshot stays in memory; `stale` becomes true when th
|
|||||||
received a GM heartbeat for more than two minutes. The bridge returns `503 foundry.not-ready` until a
|
received a GM heartbeat for more than two minutes. The bridge returns `503 foundry.not-ready` until a
|
||||||
configured GM client has published its first snapshot.
|
configured GM client has published its first snapshot.
|
||||||
|
|
||||||
|
The icon library is the one route that reads the disk instead of the snapshot: with
|
||||||
|
`DRAGONROLL_FOUNDRY_DATA_PATH` set, `GET /api/icons?dir=icons/svg&offset=120&limit=120` answers one
|
||||||
|
folder at a time — `{ status: "ok", dir, directories, files, offset, next }` of paths relative to the
|
||||||
|
data directory — and never reads outside `icons/`. `next` is the offset of the next page of icons, or
|
||||||
|
null once the folder is listed, which is how the campaign's icon browser keeps a library of thousands
|
||||||
|
lazy to load. Without that variable the route answers `503 foundry.errors.icons-unavailable`.
|
||||||
|
|
||||||
World-level items come from Foundry's `game.items`; actor inventories come from each actor's embedded
|
World-level items come from Foundry's `game.items`; actor inventories come from each actor's embedded
|
||||||
items collection. The API returns plain document data snapshots. This is a read-only integration: it
|
items collection. The API returns plain document data snapshots. This is a read-only integration: it
|
||||||
does not create or update Foundry documents, and it does not persist the bridge cache across restarts.
|
does not create or update Foundry documents, and it does not persist the bridge cache across restarts.
|
||||||
|
|||||||
@@ -1,4 +1,6 @@
|
|||||||
const http = require("node:http");
|
const http = require("node:http");
|
||||||
|
const fs = require("node:fs");
|
||||||
|
const path = require("node:path");
|
||||||
const { timingSafeEqual } = require("node:crypto");
|
const { timingSafeEqual } = require("node:crypto");
|
||||||
|
|
||||||
const host = process.env.DRAGONROLL_FOUNDRY_HOST || "0.0.0.0";
|
const host = process.env.DRAGONROLL_FOUNDRY_HOST || "0.0.0.0";
|
||||||
@@ -12,6 +14,9 @@ const allowedOrigins = new Set(
|
|||||||
.filter(Boolean),
|
.filter(Boolean),
|
||||||
);
|
);
|
||||||
const maxBodySize = 50 * 1024 * 1024;
|
const maxBodySize = 50 * 1024 * 1024;
|
||||||
|
// The Foundry Data directory, for listing the core `icons/` library. Optional:
|
||||||
|
// without it the bridge simply cannot answer icon listing requests.
|
||||||
|
const dataPath = (process.env.DRAGONROLL_FOUNDRY_DATA_PATH || "").trim();
|
||||||
|
|
||||||
if (!readToken || !pushToken) {
|
if (!readToken || !pushToken) {
|
||||||
throw new Error("Set DRAGONROLL_FOUNDRY_READ_TOKEN and DRAGONROLL_FOUNDRY_PUSH_TOKEN before starting the bridge.");
|
throw new Error("Set DRAGONROLL_FOUNDRY_READ_TOKEN and DRAGONROLL_FOUNDRY_PUSH_TOKEN before starting the bridge.");
|
||||||
@@ -106,6 +111,80 @@ function decodePathSegment(segment) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Core icon library -----------------------------------------------------
|
||||||
|
// Foundry keeps the icons it ships in the `icons/` folder of its data directory:
|
||||||
|
// thousands of images over a folder tree of their own. The campaign's icon window
|
||||||
|
// browses that tree, so the bridge lists one folder per request and pages the
|
||||||
|
// icons inside it. It never reads outside `icons/`.
|
||||||
|
|
||||||
|
const iconRoot = "icons";
|
||||||
|
const iconExtensions = new Set([".svg", ".png", ".webp", ".jpg", ".jpeg", ".gif", ".avif"]);
|
||||||
|
const defaultIconPageSize = 120;
|
||||||
|
const maxIconPageSize = 500;
|
||||||
|
|
||||||
|
function normalizeIconDirectory(input) {
|
||||||
|
const raw = String(input ?? "").trim().replace(/\\/g, "/").replace(/^\/+|\/+$/g, "");
|
||||||
|
if (!raw || raw === ".") return iconRoot;
|
||||||
|
|
||||||
|
const segments = raw.split("/").filter((segment) => segment && segment !== ".");
|
||||||
|
if (!segments.length || segments.includes("..") || segments[0] !== iconRoot) return null;
|
||||||
|
return segments.join("/");
|
||||||
|
}
|
||||||
|
|
||||||
|
function readIconDirectory(dir, offset, limit) {
|
||||||
|
const root = path.resolve(dataPath, iconRoot);
|
||||||
|
const target = path.resolve(dataPath, dir);
|
||||||
|
if (target !== root && !target.startsWith(root + path.sep)) return null;
|
||||||
|
|
||||||
|
const directories = [];
|
||||||
|
const files = [];
|
||||||
|
for (const entry of fs.readdirSync(target, { withFileTypes: true })) {
|
||||||
|
const entryPath = path.posix.join(dir, entry.name);
|
||||||
|
if (entry.isDirectory()) directories.push(entryPath);
|
||||||
|
else if (entry.isFile() && iconExtensions.has(path.extname(entry.name).toLowerCase())) files.push(entryPath);
|
||||||
|
}
|
||||||
|
directories.sort((a, b) => a.localeCompare(b));
|
||||||
|
files.sort((a, b) => a.localeCompare(b));
|
||||||
|
|
||||||
|
const page = files.slice(offset, offset + limit);
|
||||||
|
return {
|
||||||
|
// Subfolders always come back whole: the window needs every one of them to
|
||||||
|
// navigate, and there are never many. Paging covers the icons.
|
||||||
|
directories,
|
||||||
|
files: page,
|
||||||
|
offset,
|
||||||
|
next: offset + page.length < files.length ? offset + page.length : null,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function sendIconListing(request, response) {
|
||||||
|
if (!dataPath) return sendJson(response, 503, { status: "error", msg: "foundry.errors.icons-unavailable" });
|
||||||
|
|
||||||
|
const params = new URL(request.url, "http://localhost").searchParams;
|
||||||
|
const dir = normalizeIconDirectory(params.get("dir"));
|
||||||
|
if (!dir) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
|
||||||
|
|
||||||
|
const requestedLimit = Number(params.get("limit"));
|
||||||
|
const limit = Number.isFinite(requestedLimit)
|
||||||
|
? Math.min(maxIconPageSize, Math.max(1, Math.trunc(requestedLimit)))
|
||||||
|
: defaultIconPageSize;
|
||||||
|
const requestedOffset = Number(params.get("offset"));
|
||||||
|
const offset = Number.isFinite(requestedOffset) ? Math.max(0, Math.trunc(requestedOffset)) : 0;
|
||||||
|
|
||||||
|
try {
|
||||||
|
const listing = readIconDirectory(dir, offset, limit);
|
||||||
|
if (!listing) return sendJson(response, 400, { status: "error", msg: "errors.missing-data" });
|
||||||
|
sendJson(response, 200, { status: "ok", dir, ...listing });
|
||||||
|
} catch (error) {
|
||||||
|
if (error.code === "ENOENT" || error.code === "ENOTDIR") {
|
||||||
|
sendJson(response, 404, { status: "error", msg: "errors.notfound" });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
console.error(`Could not list the Foundry icon folder ${dir}.`, error);
|
||||||
|
sendJson(response, 500, { status: "error", msg: "foundry.errors.icons-unavailable" });
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const server = http.createServer(async (request, response) => {
|
const server = http.createServer(async (request, response) => {
|
||||||
if (!setCorsHeaders(request, response)) {
|
if (!setCorsHeaders(request, response)) {
|
||||||
sendJson(response, 403, { status: "error", msg: "foundry.origin-not-allowed" });
|
sendJson(response, 403, { status: "error", msg: "foundry.origin-not-allowed" });
|
||||||
@@ -188,6 +267,10 @@ const server = http.createServer(async (request, response) => {
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The icon library is on disk, not in the world snapshot, so it answers whether
|
||||||
|
// or not a GM client has published one yet.
|
||||||
|
if (pathname === "/api/icons") return sendIconListing(request, response);
|
||||||
|
|
||||||
const current = currentSnapshot(response);
|
const current = currentSnapshot(response);
|
||||||
if (!current) return;
|
if (!current) return;
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
"id": "dragonroll-foundry",
|
"id": "dragonroll-foundry",
|
||||||
"title": "Dragonroll Foundry API",
|
"title": "Dragonroll Foundry API",
|
||||||
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
|
"description": "Links a Foundry world to a Dragonroll campaign and exposes a client-side API for world data.",
|
||||||
"version": "0.4.0",
|
"version": "0.6.0",
|
||||||
"library": true,
|
"library": true,
|
||||||
"compatibility": {
|
"compatibility": {
|
||||||
"minimum": "12",
|
"minimum": "12",
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ let updatingPairingStatus = false;
|
|||||||
let linkedCampaignName = "";
|
let linkedCampaignName = "";
|
||||||
let linkProblem = "";
|
let linkProblem = "";
|
||||||
let actorSyncTimeout;
|
let actorSyncTimeout;
|
||||||
|
let characterSyncRetryTimeout;
|
||||||
let characterSyncRunning = false;
|
let characterSyncRunning = false;
|
||||||
let actorSyncErrorLogged = false;
|
let actorSyncErrorLogged = false;
|
||||||
const syncingActorIds = new Set();
|
const syncingActorIds = new Set();
|
||||||
@@ -32,9 +33,13 @@ let itemSyncRunning = false;
|
|||||||
let itemSyncErrorLogged = false;
|
let itemSyncErrorLogged = false;
|
||||||
let folderSyncTimeout;
|
let folderSyncTimeout;
|
||||||
let folderSyncRunning = false;
|
let folderSyncRunning = false;
|
||||||
|
let sceneSyncTimeout;
|
||||||
|
let sceneSyncRetryTimeout;
|
||||||
|
let sceneSyncErrorLogged = false;
|
||||||
const syncingItemIds = new Set();
|
const syncingItemIds = new Set();
|
||||||
const syncingFolderIds = new Set();
|
const syncingFolderIds = new Set();
|
||||||
const queuedItemChanges = new Map();
|
const queuedItemChanges = new Map();
|
||||||
|
const queuedSceneChanges = new Map();
|
||||||
|
|
||||||
function getCollectionContents(collection, collectionName) {
|
function getCollectionContents(collection, collectionName) {
|
||||||
if (!collection) {
|
if (!collection) {
|
||||||
@@ -299,6 +304,7 @@ async function applyDragonrollLink(result) {
|
|||||||
scheduleSnapshotSync(0);
|
scheduleSnapshotSync(0);
|
||||||
setTimeout(initializeCharacterSync, 0);
|
setTimeout(initializeCharacterSync, 0);
|
||||||
setTimeout(reconcileDragonrollItems, 2000);
|
setTimeout(reconcileDragonrollItems, 2000);
|
||||||
|
setTimeout(initializeSceneSync, 1000);
|
||||||
} else {
|
} else {
|
||||||
// Without a token this client cannot sync, and only a fresh link gives one.
|
// Without a token this client cannot sync, and only a fresh link gives one.
|
||||||
linkProblem = "this client could not save the token it was given";
|
linkProblem = "this client could not save the token it was given";
|
||||||
@@ -440,6 +446,8 @@ function handleAutoSyncChange(value) {
|
|||||||
clearTimeout(actorSyncTimeout);
|
clearTimeout(actorSyncTimeout);
|
||||||
clearTimeout(itemSyncTimeout);
|
clearTimeout(itemSyncTimeout);
|
||||||
clearTimeout(folderSyncTimeout);
|
clearTimeout(folderSyncTimeout);
|
||||||
|
clearTimeout(sceneSyncTimeout);
|
||||||
|
clearTimeout(sceneSyncRetryTimeout);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (!game.user?.isGM || !getSyncToken()) return;
|
if (!game.user?.isGM || !getSyncToken()) return;
|
||||||
@@ -449,6 +457,8 @@ function handleAutoSyncChange(value) {
|
|||||||
initializeCharacterSync();
|
initializeCharacterSync();
|
||||||
reconcileDragonrollItems();
|
reconcileDragonrollItems();
|
||||||
queueFoundryItemFolders(400);
|
queueFoundryItemFolders(400);
|
||||||
|
reconcileDragonrollNotes();
|
||||||
|
initializeSceneSync();
|
||||||
if (queuedActorChanges.size) {
|
if (queuedActorChanges.size) {
|
||||||
clearTimeout(actorSyncTimeout);
|
clearTimeout(actorSyncTimeout);
|
||||||
actorSyncTimeout = setTimeout(flushActorChanges, 400);
|
actorSyncTimeout = setTimeout(flushActorChanges, 400);
|
||||||
@@ -457,6 +467,10 @@ function handleAutoSyncChange(value) {
|
|||||||
clearTimeout(itemSyncTimeout);
|
clearTimeout(itemSyncTimeout);
|
||||||
itemSyncTimeout = setTimeout(flushItemChanges, 400);
|
itemSyncTimeout = setTimeout(flushItemChanges, 400);
|
||||||
}
|
}
|
||||||
|
if (queuedSceneChanges.size) {
|
||||||
|
clearTimeout(sceneSyncTimeout);
|
||||||
|
sceneSyncTimeout = setTimeout(flushSceneChanges, 400);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function dragonrollActorId(actor) {
|
function dragonrollActorId(actor) {
|
||||||
@@ -473,17 +487,65 @@ function serializeFoundryActor(actor) {
|
|||||||
if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) {
|
if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) {
|
||||||
data.img = new URL(data.img, window.location.origin).toString();
|
data.img = new URL(data.img, window.location.origin).toString();
|
||||||
}
|
}
|
||||||
|
// Tools and languages travel by their names: what the actor holds are proficiency
|
||||||
|
// keys (and, since the third release of the system, language documents), which mean
|
||||||
|
// nothing to a sheet outside Foundry.
|
||||||
|
const names = { tools: foundryTraitNames(actor, "tools"), languages: foundryTraitNames(actor, "languages") };
|
||||||
|
if (names.tools || names.languages) data.dragonroll = { ...names };
|
||||||
return data;
|
return data;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A proficiency list of `system.traits`: its keys resolved to the labels CONFIG gives
|
||||||
|
// them, plus whatever the GM typed as a proficiency of their own. `null` for an actor
|
||||||
|
// that has no such list, an empty array for one that has none of that kind. Dragonroll
|
||||||
|
// names its lists in full, while the world keeps its tools under `system.traits.tool`
|
||||||
|
// and its languages under `system.traits.languages`.
|
||||||
|
const TRAIT_FIELDS = { tools: "tool", languages: "languages" };
|
||||||
|
|
||||||
|
function foundryTraitNames(actor, kind) {
|
||||||
|
if (game.system?.id !== "dnd5e") return null;
|
||||||
|
const trait = actor.system?.traits?.[TRAIT_FIELDS[kind] ?? kind];
|
||||||
|
if (!trait || typeof trait !== "object") return null;
|
||||||
|
|
||||||
|
const names = (Array.isArray(trait.value) ? trait.value : [])
|
||||||
|
.map((key) => foundryProficiencyLabel(kind, key))
|
||||||
|
.filter(Boolean);
|
||||||
|
for (const custom of String(trait.custom ?? "").split(",")) {
|
||||||
|
const name = custom.trim();
|
||||||
|
if (name) names.push(name);
|
||||||
|
}
|
||||||
|
return [...new Set(names)];
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundryProficiencyLabel(kind, key) {
|
||||||
|
if (typeof key !== "string" || !key) return "";
|
||||||
|
|
||||||
|
const entry = CONFIG.DND5E?.[kind === "languages" ? "languages" : "tools"]?.[key];
|
||||||
|
const label = entry?.label ?? entry?.name;
|
||||||
|
if (label) return String(label);
|
||||||
|
// A language the world added itself stands as a document of its own rather than in
|
||||||
|
// the system's config.
|
||||||
|
const document = kind === "languages" ? game.items?.get?.(key) : null;
|
||||||
|
if (document?.name) return String(document.name);
|
||||||
|
// The key beats dropping a proficiency the character really has.
|
||||||
|
return key;
|
||||||
|
}
|
||||||
|
|
||||||
function isSupportedCharacterActor(actor) {
|
function isSupportedCharacterActor(actor) {
|
||||||
const savedType = actor.getFlag?.(MODULE_ID, "actorType") || actor.flags?.[MODULE_ID]?.actorType;
|
const savedType = actor.getFlag?.(MODULE_ID, "actorType") || actor.flags?.[MODULE_ID]?.actorType;
|
||||||
return ["character", "npc", "creature"].includes(savedType || actor.type);
|
return ["character", "npc", "creature"].includes(savedType || actor.type);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Embedded documents the world owns outright (Syndria98/dragonroll#89): a feat is a trait
|
||||||
|
// and a race is a species — they reach the campaign through its traits and species fields,
|
||||||
|
// never through its inventory. Dragonroll must neither mark them as its own nor delete one
|
||||||
|
// when it writes the character, and an older campaign still holding such a row in its
|
||||||
|
// inventory must be let to write it out of the campaign without the document going with it.
|
||||||
|
const WORLD_OWNED_EMBEDDED_TYPES = new Set(["feat", "race", "species", "status", "spellbook", "language"]);
|
||||||
|
|
||||||
async function markActorItemsAsSynced(actor) {
|
async function markActorItemsAsSynced(actor) {
|
||||||
const updates = actor.items.contents
|
const updates = actor.items.contents
|
||||||
.filter((item) => !item.getFlag?.(MODULE_ID, "syncedItem"))
|
.filter((item) => !item.getFlag?.(MODULE_ID, "syncedItem") && !WORLD_OWNED_EMBEDDED_TYPES.has(item.type))
|
||||||
.map((item) => ({
|
.map((item) => ({
|
||||||
_id: item.id,
|
_id: item.id,
|
||||||
[`flags.${MODULE_ID}.syncedItem`]: true,
|
[`flags.${MODULE_ID}.syncedItem`]: true,
|
||||||
@@ -517,7 +579,7 @@ function reportActorSyncError(error) {
|
|||||||
console.warn(`${MODULE_ID} | Character sync failed and will retry.`, error);
|
console.warn(`${MODULE_ID} | Character sync failed and will retry.`, error);
|
||||||
}
|
}
|
||||||
|
|
||||||
async function pushFoundryActors(actors, fullSync = false) {
|
async function pushFoundryActors(actors, fullSync = false, replace = false) {
|
||||||
const token = getSyncToken();
|
const token = getSyncToken();
|
||||||
if (!token || !game.user?.isGM || !game.world || (!actors.length && !fullSync)) return;
|
if (!token || !game.user?.isGM || !game.world || (!actors.length && !fullSync)) return;
|
||||||
if (game.system.id !== "dnd5e") {
|
if (game.system.id !== "dnd5e") {
|
||||||
@@ -529,12 +591,16 @@ async function pushFoundryActors(actors, fullSync = false) {
|
|||||||
const result = await postDragonroll("foundry/sync/snapshot", {
|
const result = await postDragonroll("foundry/sync/snapshot", {
|
||||||
worldId: game.world.id,
|
worldId: game.world.id,
|
||||||
actors: supportedActors.map(serializeFoundryActor),
|
actors: supportedActors.map(serializeFoundryActor),
|
||||||
// Dragonroll deduplicates by name, so sending the world directory next to
|
// The world item directory is what the campaign lists as its items
|
||||||
// the actor copies keeps a single Item per piece of gear.
|
// (Syndria98/dragonroll#67); the gear a character carries travels inside that
|
||||||
|
// actor's snapshot as its inventory, not as campaign items.
|
||||||
items: getWorldItemSnapshots(),
|
items: getWorldItemSnapshots(),
|
||||||
// The folder tree those world items stand in (see worldItemFolderSnapshots).
|
// The folder tree those world items stand in (see worldItemFolderSnapshots).
|
||||||
folders: worldItemFolderSnapshots(),
|
folders: worldItemFolderSnapshots(),
|
||||||
fullSync,
|
fullSync,
|
||||||
|
// A forced sync replaces the campaign's row for these actors outright; a live
|
||||||
|
// change or a full snapshot never sets this, so the campaign keeps its edits.
|
||||||
|
replace,
|
||||||
}, token);
|
}, token);
|
||||||
|
|
||||||
for (const mapping of result.actors || []) {
|
for (const mapping of result.actors || []) {
|
||||||
@@ -557,8 +623,9 @@ async function deleteDragonrollActor(foundryActorId) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Sending actors on purpose, whether or not autosync is on: this is the push the
|
// 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
|
// GM asks for. It replaces everything the campaign holds for those actors (Syndria98/
|
||||||
// prunes anything else the campaign holds.
|
// dragonroll#96), but it upserts them only, so unlike a full snapshot it never prunes
|
||||||
|
// anything else the campaign holds.
|
||||||
async function forceSyncActorsToDragonroll(actors) {
|
async function forceSyncActorsToDragonroll(actors) {
|
||||||
if (!game.user?.isGM || !game.world || !actors.length) return;
|
if (!game.user?.isGM || !game.world || !actors.length) return;
|
||||||
if (!getSyncToken()) {
|
if (!getSyncToken()) {
|
||||||
@@ -574,7 +641,7 @@ async function forceSyncActorsToDragonroll(actors) {
|
|||||||
if (!supported.length) return;
|
if (!supported.length) return;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
await pushFoundryActors(supported);
|
await pushFoundryActors(supported, false, true);
|
||||||
ui.notifications?.info(supported.length === 1
|
ui.notifications?.info(supported.length === 1
|
||||||
? `${supported[0].name} was sent to the Dragonroll campaign.`
|
? `${supported[0].name} was sent to the Dragonroll campaign.`
|
||||||
: `${supported.length} actors were sent to the Dragonroll campaign.`);
|
: `${supported.length} actors were sent to the Dragonroll campaign.`);
|
||||||
@@ -1151,7 +1218,19 @@ async function reconcileEmbeddedItems(actor, entry) {
|
|||||||
const existing = actor.items.contents.find((item) => item.name === wanted.name
|
const existing = actor.items.contents.find((item) => item.name === wanted.name
|
||||||
&& item.type === wanted.type && item.getFlag?.(MODULE_ID, "syncedItem"))
|
&& item.type === wanted.type && item.getFlag?.(MODULE_ID, "syncedItem"))
|
||||||
|| actor.items.contents.find((item) => item.name === wanted.name
|
|| actor.items.contents.find((item) => item.name === wanted.name
|
||||||
&& item.getFlag?.(MODULE_ID, "syncedItem"));
|
&& item.getFlag?.(MODULE_ID, "syncedItem") && !WORLD_OWNED_EMBEDDED_TYPES.has(item.type));
|
||||||
|
// A carried row holding the name of one of the world's own trait or species documents
|
||||||
|
// — a trait a campaign that synced before #89 still has in its inventory — stands in
|
||||||
|
// the world as that document: no loot is made after its name, and the document itself
|
||||||
|
// is let be. Writing it out of the campaign is the campaign's to do, keeping it is the world's.
|
||||||
|
if (!existing && wanted.type === "loot") {
|
||||||
|
const worldOwned = actor.items.contents.find((item) => item.name === wanted.name
|
||||||
|
&& WORLD_OWNED_EMBEDDED_TYPES.has(item.type));
|
||||||
|
if (worldOwned) {
|
||||||
|
retainedIds.add(worldOwned.id);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
if (existing) {
|
if (existing) {
|
||||||
retainedIds.add(existing.id);
|
retainedIds.add(existing.id);
|
||||||
const update = { _id: existing.id };
|
const update = { _id: existing.id };
|
||||||
@@ -1177,7 +1256,8 @@ async function reconcileEmbeddedItems(actor, entry) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
const staleItemIds = actor.items.contents
|
const staleItemIds = actor.items.contents
|
||||||
.filter((item) => item.getFlag?.(MODULE_ID, "syncedItem") && !retainedIds.has(item.id))
|
.filter((item) => item.getFlag?.(MODULE_ID, "syncedItem") && !retainedIds.has(item.id)
|
||||||
|
&& !WORLD_OWNED_EMBEDDED_TYPES.has(item.type))
|
||||||
.map((item) => item.id);
|
.map((item) => item.id);
|
||||||
if (staleItemIds.length) await actor.deleteEmbeddedDocuments("Item", staleItemIds);
|
if (staleItemIds.length) await actor.deleteEmbeddedDocuments("Item", staleItemIds);
|
||||||
}
|
}
|
||||||
@@ -1269,6 +1349,14 @@ async function reconcileDragonrollCharacters() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Both sides converge on a timer that only runs while the world is open, so a
|
||||||
|
// round that could not reach Dragonroll is asked for again in a while instead of
|
||||||
|
// leaving the campaign with whatever it happened to receive.
|
||||||
|
function scheduleDragonrollCharacterSync(delay = 15000) {
|
||||||
|
clearTimeout(characterSyncRetryTimeout);
|
||||||
|
characterSyncRetryTimeout = setTimeout(reconcileDragonrollCharacters, delay);
|
||||||
|
}
|
||||||
|
|
||||||
async function initializeCharacterSync() {
|
async function initializeCharacterSync() {
|
||||||
if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return;
|
if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return;
|
||||||
try {
|
try {
|
||||||
@@ -1285,6 +1373,276 @@ function queueFoundryActorChange(kind, actor) {
|
|||||||
queueActorChange(kind, actor);
|
queueActorChange(kind, actor);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Scene sync ---------------------------------------------------------------
|
||||||
|
// A scene of this world is one of the campaign's maps (Syndria98/dragonroll#99): its
|
||||||
|
// background picture and the grid laid over it travel to Dragonroll, which keeps a map per
|
||||||
|
// scene. That is all of a scene that crosses over — pinning notes on a map, standing tokens
|
||||||
|
// on it and saying how far one of its cells goes are the campaign's own business, so none
|
||||||
|
// of it comes back to the world.
|
||||||
|
|
||||||
|
// A scene travels as plain document data with its picture read from this world: Dragonroll
|
||||||
|
// draws it outside Foundry, so the path becomes an absolute URL the way a portrait does.
|
||||||
|
// Since V13 the picture sits under `background.src`, and under plain `img` before that.
|
||||||
|
function serializeFoundryScene(scene) {
|
||||||
|
const data = toPlainData(scene);
|
||||||
|
if (!data) return null;
|
||||||
|
|
||||||
|
const absolute = (path) => new URL(path, window.location.origin).toString();
|
||||||
|
if (data.background?.src && !/^(https?:|data:|\/\/)/i.test(data.background.src)) {
|
||||||
|
data.background = { ...data.background, src: absolute(data.background.src) };
|
||||||
|
} else if (data.img && !/^(https?:|data:|\/\/)/i.test(data.img)) {
|
||||||
|
data.img = absolute(data.img);
|
||||||
|
}
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The scenes the campaign mirrors as its maps. Every scene goes, including one with no
|
||||||
|
// picture: Dragonroll decides what of a scene is a map and, since such a scene's id is
|
||||||
|
// still listed, no map of the campaign is pruned because of it.
|
||||||
|
async function pushFoundryScenes(scenes, fullSync = false) {
|
||||||
|
const token = getSyncToken();
|
||||||
|
// A full push travels even with no scenes left: it is the one that tells the campaign
|
||||||
|
// which of the maps it mirrors from this world the world has let go of.
|
||||||
|
if (!token || !game.user?.isGM || !game.world || (!scenes.length && !fullSync)) return;
|
||||||
|
|
||||||
|
await postDragonroll("foundry/sync/scenes", {
|
||||||
|
worldId: game.world.id,
|
||||||
|
scenes: scenes.map(serializeFoundryScene).filter(Boolean),
|
||||||
|
fullSync,
|
||||||
|
}, token);
|
||||||
|
sceneSyncErrorLogged = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function deleteDragonrollScene(foundrySceneId) {
|
||||||
|
const token = getSyncToken();
|
||||||
|
if (!token || !game.world || !foundrySceneId) return;
|
||||||
|
await postDragonroll("foundry/sync/scene-delete", {
|
||||||
|
worldId: game.world.id,
|
||||||
|
foundrySceneId,
|
||||||
|
}, token);
|
||||||
|
}
|
||||||
|
|
||||||
|
function reportSceneSyncError(error) {
|
||||||
|
if (sceneSyncErrorLogged) return;
|
||||||
|
sceneSyncErrorLogged = true;
|
||||||
|
console.warn(`${MODULE_ID} | Map sync failed and will retry.`, error);
|
||||||
|
}
|
||||||
|
|
||||||
|
function queueFoundrySceneChange(kind, scene) {
|
||||||
|
if (!scene || !game.user?.isGM || !getSyncToken()) return;
|
||||||
|
|
||||||
|
queuedSceneChanges.set(scene.id, { kind, scene });
|
||||||
|
clearTimeout(sceneSyncTimeout);
|
||||||
|
sceneSyncTimeout = setTimeout(flushSceneChanges, 400);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function flushSceneChanges() {
|
||||||
|
// Autosync off: the scene edits wait here, like the actor and item changes do.
|
||||||
|
if (!isAutoSyncEnabled()) return;
|
||||||
|
const changes = [...queuedSceneChanges.values()];
|
||||||
|
queuedSceneChanges.clear();
|
||||||
|
const deleted = changes.filter((change) => change.kind === "delete");
|
||||||
|
const changed = changes.filter((change) => change.kind !== "delete");
|
||||||
|
|
||||||
|
try {
|
||||||
|
for (const change of deleted) await deleteDragonrollScene(change.scene.id);
|
||||||
|
if (changed.length) await pushFoundryScenes(changed.map((change) => change.scene));
|
||||||
|
} catch (error) {
|
||||||
|
reportSceneSyncError(error);
|
||||||
|
for (const change of changes) queuedSceneChanges.set(change.scene.id, change);
|
||||||
|
clearTimeout(sceneSyncTimeout);
|
||||||
|
sceneSyncTimeout = setTimeout(flushSceneChanges, 5000);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The whole scene list travels when the world links and when it loads: the campaign's map
|
||||||
|
// list mirrors this world's scenes, and only a push holding every scene can say which of
|
||||||
|
// those maps the world has let go of.
|
||||||
|
async function initializeSceneSync() {
|
||||||
|
if (!getSyncToken() || !game.user?.isGM || !game.world || !isAutoSyncEnabled()) return;
|
||||||
|
try {
|
||||||
|
await pushFoundryScenes(game.scenes?.contents || [], true);
|
||||||
|
} catch (error) {
|
||||||
|
reportSceneSyncError(error);
|
||||||
|
clearTimeout(sceneSyncRetryTimeout);
|
||||||
|
sceneSyncRetryTimeout = setTimeout(initializeSceneSync, 15000);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- Note pages ------------------------------------------------------------
|
||||||
|
// The campaign's notes read like the campaign's journal in the world: every note
|
||||||
|
// stands as a page of one JournalEntry named "Dragonroll". Notes are written in
|
||||||
|
// Dragonroll, so this copy runs one way — the reconcile writes each note into its
|
||||||
|
// page and drops the page of a note the campaign deleted. Nothing of the journal
|
||||||
|
// is read back. A page the module made carries the `dragonroll-foundry.noteId`
|
||||||
|
// flag; one without it that stands under a note's title is claimed as that note's
|
||||||
|
// page rather than doubled, and any other page is the GM's own and left alone.
|
||||||
|
|
||||||
|
const NOTES_JOURNAL_NAME = "Dragonroll";
|
||||||
|
let noteSyncRunning = false;
|
||||||
|
let noteSyncErrorLogged = false;
|
||||||
|
|
||||||
|
function dragonrollNoteId(page) {
|
||||||
|
return page.getFlag?.(MODULE_ID, "noteId") || page.flags?.[MODULE_ID]?.noteId || "";
|
||||||
|
}
|
||||||
|
|
||||||
|
// A note is markdown, a journal page is HTML. Foundry's own renderer keeps the
|
||||||
|
// page readable in the journal and in its styles; where this Foundry does not
|
||||||
|
// offer one, escaped paragraphs keep the text legible until it does.
|
||||||
|
function notePageHtml(content) {
|
||||||
|
const markdown = String(content ?? "");
|
||||||
|
if (!markdown.trim()) return "";
|
||||||
|
if (typeof TextEditor !== "undefined" && typeof TextEditor._getMarkdown === "function") {
|
||||||
|
const html = TextEditor._getMarkdown(markdown);
|
||||||
|
if (html) return html;
|
||||||
|
}
|
||||||
|
return markdown
|
||||||
|
.split(/\n\s*\n/)
|
||||||
|
.map((block) => `<p>${escapeNoteHtml(block.trim()).replace(/\n/g, "<br />")}</p>`)
|
||||||
|
.join("\n");
|
||||||
|
}
|
||||||
|
|
||||||
|
function escapeNoteHtml(value) {
|
||||||
|
return String(value).replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">");
|
||||||
|
}
|
||||||
|
|
||||||
|
function notePageTitle(entry) {
|
||||||
|
return String(entry.title || "").trim() || "Untitled note";
|
||||||
|
}
|
||||||
|
|
||||||
|
// The journal this module writes the campaign's notes into: the one it flagged as
|
||||||
|
// its own, or one the GM already made under that name. An unflagged one is
|
||||||
|
// flagged on use, so renaming it afterwards still leaves the notes' home findable.
|
||||||
|
function notesJournal() {
|
||||||
|
const journals = game.journals?.contents || [];
|
||||||
|
return journals.find((journal) => journal.getFlag?.(MODULE_ID, "notesJournal"))
|
||||||
|
|| journals.find((journal) => journal.name === NOTES_JOURNAL_NAME)
|
||||||
|
|| null;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function ensureNotesJournal() {
|
||||||
|
const existing = notesJournal();
|
||||||
|
if (existing) {
|
||||||
|
if (!existing.getFlag?.(MODULE_ID, "notesJournal")) {
|
||||||
|
await existing.update({ [`flags.${MODULE_ID}.notesJournal`]: true });
|
||||||
|
}
|
||||||
|
return existing;
|
||||||
|
}
|
||||||
|
const created = await JournalEntry.create(
|
||||||
|
{ name: NOTES_JOURNAL_NAME, flags: { [MODULE_ID]: { notesJournal: true } } },
|
||||||
|
{ renderSheet: false },
|
||||||
|
);
|
||||||
|
return Array.isArray(created) ? created[0] : created;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The page a note stands as: rewrite what the campaign changed, and claim a page
|
||||||
|
// the campaign mapped by id but whose flag was lost.
|
||||||
|
async function applyDragonrollNotePage(page, entry) {
|
||||||
|
const title = notePageTitle(entry);
|
||||||
|
const html = notePageHtml(entry.content);
|
||||||
|
const updates = {};
|
||||||
|
if (String(page.name ?? "") !== title) updates.name = title;
|
||||||
|
if (String(page.text?.content ?? "") !== html) updates["text.content"] = html;
|
||||||
|
if (!dragonrollNoteId(page)) updates[`flags.${MODULE_ID}.noteId`] = String(entry._id);
|
||||||
|
if (Object.keys(updates).length) await page.update(updates);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function createDragonrollNotePage(journal, entry) {
|
||||||
|
const pages = await journal.createEmbeddedDocuments("JournalEntryPage", [{
|
||||||
|
// A page's display title is its `name`; `title` only holds the table-of-contents
|
||||||
|
// flags (`show`/`level`). Missing `name` fails the document's validation.
|
||||||
|
name: notePageTitle(entry),
|
||||||
|
text: { content: notePageHtml(entry.content) },
|
||||||
|
flags: { [MODULE_ID]: { noteId: String(entry._id) } },
|
||||||
|
}], { renderSheet: false });
|
||||||
|
return Array.isArray(pages) ? pages[0] : pages;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function mapDragonrollNote(noteId, foundryPageId) {
|
||||||
|
const token = getSyncToken();
|
||||||
|
return postDragonroll("foundry/sync/map-note", {
|
||||||
|
worldId: game.world.id,
|
||||||
|
noteId: String(noteId),
|
||||||
|
foundryPageId: String(foundryPageId),
|
||||||
|
}, token);
|
||||||
|
}
|
||||||
|
|
||||||
|
function reportNoteSyncError(error) {
|
||||||
|
if (noteSyncErrorLogged) return;
|
||||||
|
noteSyncErrorLogged = true;
|
||||||
|
console.warn(`${MODULE_ID} | Note journal sync failed and will retry.`, error);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function reconcileDragonrollNotes() {
|
||||||
|
const token = getSyncToken();
|
||||||
|
if (!token || !game.user?.isGM || !game.world || noteSyncRunning || !isAutoSyncEnabled()) return;
|
||||||
|
noteSyncRunning = true;
|
||||||
|
try {
|
||||||
|
const result = await getDragonroll("foundry/sync/notes", token);
|
||||||
|
const remoteNotes = result.notes || [];
|
||||||
|
// A campaign without notes gets no journal of its own — but one it once had
|
||||||
|
// stays, so the pages of notes it deleted can go with them.
|
||||||
|
if (!remoteNotes.length && !notesJournal()) return;
|
||||||
|
const journal = await ensureNotesJournal();
|
||||||
|
if (!journal) return;
|
||||||
|
|
||||||
|
const remoteById = new Map(remoteNotes.map((entry) => [String(entry._id), entry]));
|
||||||
|
const localByRemoteId = new Map((journal.pages?.contents || [])
|
||||||
|
.map((page) => [String(dragonrollNoteId(page)), page])
|
||||||
|
.filter(([noteId]) => noteId));
|
||||||
|
const retainedPageIds = new Set();
|
||||||
|
|
||||||
|
for (const entry of remoteNotes) {
|
||||||
|
let page = entry.foundryPageId ? journal.pages?.get(entry.foundryPageId) : null;
|
||||||
|
if (!page) page = localByRemoteId.get(String(entry._id));
|
||||||
|
if (page) {
|
||||||
|
retainedPageIds.add(page.id);
|
||||||
|
await applyDragonrollNotePage(page, entry);
|
||||||
|
if (!entry.foundryPageId) await mapDragonrollNote(entry._id, page.id);
|
||||||
|
} else {
|
||||||
|
// A page under the note's title that carries no Dragonroll mark — one the
|
||||||
|
// module made before the campaign kept its mapping, or one whose flag was
|
||||||
|
// lost — is claimed as that note's page instead of adding a second page of
|
||||||
|
// the same name. Like the item sync's same-name adoption, this is what keeps
|
||||||
|
// a note from being written as a new page on every reconcile.
|
||||||
|
const sameName = (journal.pages?.contents || []).find((candidate) => (
|
||||||
|
String(candidate.name ?? "") === notePageTitle(entry)
|
||||||
|
&& !dragonrollNoteId(candidate)
|
||||||
|
&& !retainedPageIds.has(candidate.id)
|
||||||
|
));
|
||||||
|
if (sameName) {
|
||||||
|
retainedPageIds.add(sameName.id);
|
||||||
|
await applyDragonrollNotePage(sameName, entry);
|
||||||
|
await mapDragonrollNote(entry._id, sameName.id);
|
||||||
|
} else {
|
||||||
|
const created = await createDragonrollNotePage(journal, entry);
|
||||||
|
if (created) {
|
||||||
|
retainedPageIds.add(created.id);
|
||||||
|
// The create carries the note's flag, but a world that drops it would leave
|
||||||
|
// the page unclaimed and the next reconcile would make another: mark it
|
||||||
|
// again the way the rest of the sync marks its documents.
|
||||||
|
await applyDragonrollNotePage(created, entry);
|
||||||
|
await mapDragonrollNote(entry._id, created.id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Pages whose note the campaign deleted go with it. Only pages this module
|
||||||
|
// made are its business: an unflagged page is the GM's own.
|
||||||
|
for (const page of journal.pages?.contents || []) {
|
||||||
|
const noteId = dragonrollNoteId(page);
|
||||||
|
if (!noteId || retainedPageIds.has(page.id) || remoteById.has(String(noteId))) continue;
|
||||||
|
await page.delete();
|
||||||
|
}
|
||||||
|
noteSyncErrorLogged = false;
|
||||||
|
} catch (error) {
|
||||||
|
reportNoteSyncError(error);
|
||||||
|
} finally {
|
||||||
|
noteSyncRunning = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
async function publishSnapshot() {
|
async function publishSnapshot() {
|
||||||
if (!game.user?.isGM || !game.world) return;
|
if (!game.user?.isGM || !game.world) return;
|
||||||
if (syncInProgress) {
|
if (syncInProgress) {
|
||||||
@@ -1377,6 +1735,14 @@ Hooks.once("ready", () => {
|
|||||||
// already seen the world directory when it starts sending its own items back.
|
// already seen the world directory when it starts sending its own items back.
|
||||||
setTimeout(reconcileDragonrollItems, 2000);
|
setTimeout(reconcileDragonrollItems, 2000);
|
||||||
setInterval(reconcileDragonrollItems, 5000);
|
setInterval(reconcileDragonrollItems, 5000);
|
||||||
|
// The campaign's notes arrive as pages of the world's Dragonroll journal on
|
||||||
|
// the same rhythm: a note written in the app is on the journal within seconds.
|
||||||
|
setTimeout(reconcileDragonrollNotes, 3000);
|
||||||
|
setInterval(reconcileDragonrollNotes, 5000);
|
||||||
|
// The campaign's maps mirror this world's scenes: the whole list goes once the world is
|
||||||
|
// loaded, and that push alone tells the campaign which of its synced maps this world has
|
||||||
|
// let go of.
|
||||||
|
setTimeout(initializeSceneSync, 3000);
|
||||||
|
|
||||||
for (const event of [
|
for (const event of [
|
||||||
"createActor", "updateActor", "deleteActor",
|
"createActor", "updateActor", "deleteActor",
|
||||||
@@ -1410,10 +1776,18 @@ Hooks.once("ready", () => {
|
|||||||
queueFoundryItemChange(isDelete ? "delete" : "upsert", document);
|
queueFoundryItemChange(isDelete ? "delete" : "upsert", document);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A scene the GM makes, renames or throws away is one of the campaign's maps being drawn
|
||||||
|
// or let go of (Syndria98/dragonroll#99). Only its picture and grid cross over, so this
|
||||||
|
// goes one way and needs no snapshot of the world behind it.
|
||||||
|
for (const event of ["createScene", "updateScene", "deleteScene"]) {
|
||||||
|
Hooks.on(event, (document) => queueFoundrySceneChange(event.startsWith("delete") ? "delete" : "upsert", document));
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// A GM sends selected actors to Dragonroll from the actor directory's context
|
// 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.
|
// menu, replacing whatever the campaign holds for them. This works with autosync on
|
||||||
|
// and off: it is the one push done on purpose.
|
||||||
Hooks.on("getActorDirectoryEntryContext", (html, options) => {
|
Hooks.on("getActorDirectoryEntryContext", (html, options) => {
|
||||||
if (!game.user?.isGM || !getSyncToken()) return;
|
if (!game.user?.isGM || !getSyncToken()) return;
|
||||||
|
|
||||||
|
|||||||
@@ -1,43 +1,6 @@
|
|||||||
<script setup lang="ts">
|
<script setup lang="ts">
|
||||||
import ContentManager from './components/managers/ContentManager.vue';
|
// El que es veu és la pàgina que toca (app/pages): /docs porta la documentació, i la
|
||||||
import ToastManager from './components/managers/ToastManager.vue';
|
// resta de rutes obren l'aplicació de finestres. Aquí només hi ha el que és de tot el lloc.
|
||||||
import WindowManager from './components/managers/WindowManager.vue';
|
|
||||||
import ServiceLinkAuthorize from './components/views/ServiceLinkAuthorize.vue';
|
|
||||||
|
|
||||||
import { CreateWindow } from '@/services/Windows'
|
|
||||||
import { GetUser, HasAdmin } from './services/User';
|
|
||||||
import TooltipManager from './components/managers/TooltipManager.vue';
|
|
||||||
import ContextMenuManager from './components/managers/ContextMenuManager.vue';
|
|
||||||
import { useCampaignService } from './services/Campaign';
|
|
||||||
|
|
||||||
const { RestoreCampaign } = useCampaignService();
|
|
||||||
|
|
||||||
// Els serveis (Discord, Foundry, Obsidian) enllacen amb aquesta pantalla única; no són part
|
|
||||||
// de l'aplicació i no han d'arrencar les finestres normals. La ruta antiga de Discord també
|
|
||||||
// hi porta, perquè els enllaços que ja corren per Discord no queden morts.
|
|
||||||
const requestUrl = useRequestURL();
|
|
||||||
const isServiceLink = computed(() => {
|
|
||||||
const path = requestUrl.pathname.replace(/\/+$/, '');
|
|
||||||
return path === '/link/authorize' || path === '/discord/authorize';
|
|
||||||
});
|
|
||||||
|
|
||||||
async function start(){
|
|
||||||
if(GetUser()){
|
|
||||||
const restoredCampaign = await RestoreCampaign();
|
|
||||||
if (!restoredCampaign) {
|
|
||||||
CreateWindow('main_menu');
|
|
||||||
}
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
if(await HasAdmin()){
|
|
||||||
CreateWindow('login');
|
|
||||||
} else {
|
|
||||||
CreateWindow('register', {firstTime: true});
|
|
||||||
}
|
|
||||||
// DisplayToast('aqua', 'All plugins loaded successfully');
|
|
||||||
}
|
|
||||||
|
|
||||||
useHead({
|
useHead({
|
||||||
title: 'Dragonroll',
|
title: 'Dragonroll',
|
||||||
meta: [
|
meta: [
|
||||||
@@ -50,29 +13,9 @@ useHead({
|
|||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
setupTheme();
|
setupTheme();
|
||||||
setTheme('dark');
|
setTheme('dark');
|
||||||
if(!isServiceLink.value){
|
|
||||||
start();
|
|
||||||
}
|
|
||||||
})
|
})
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<ServiceLinkAuthorize v-if="isServiceLink"></ServiceLinkAuthorize>
|
<NuxtPage></NuxtPage>
|
||||||
<div v-else class="viewer">
|
|
||||||
<ToastManager></ToastManager>
|
|
||||||
<TooltipManager></TooltipManager>
|
|
||||||
<ContextMenuManager></ContextMenuManager>
|
|
||||||
<WindowManager></WindowManager>
|
|
||||||
<ContentManager></ContentManager>
|
|
||||||
<!-- Managers -->
|
|
||||||
</div>
|
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<style scoped>
|
|
||||||
.viewer {
|
|
||||||
display: flex;
|
|
||||||
flex-direction: column;
|
|
||||||
width: 100%;
|
|
||||||
height: 100vh;
|
|
||||||
}
|
|
||||||
</style>
|
|
||||||
|
|||||||
@@ -30,9 +30,19 @@ $themes: (
|
|||||||
container-shadow: #151d28,
|
container-shadow: #151d28,
|
||||||
sticky-header-bg: #20202077,
|
sticky-header-bg: #20202077,
|
||||||
|
|
||||||
red: #e06c75,
|
// Quoted: red/green/gray are also Sass colour keywords, so unquoted they are parsed as
|
||||||
green: #98c379,
|
// colour values, and interpolating one into `--color-#{$name}` warns
|
||||||
gray: #cccccc,
|
// (Syndria98/dragonroll#71).
|
||||||
|
"red": #e06c75,
|
||||||
|
"green": #98c379,
|
||||||
|
"gray": #cccccc,
|
||||||
|
|
||||||
|
// The rarity of an item colours its row in the sidebar (Syndria98/dragonroll#63).
|
||||||
|
rarity-common: #ffffff,
|
||||||
|
rarity-uncommon: #1eff00,
|
||||||
|
rarity-rare: #2f81f7,
|
||||||
|
rarity-very-rare: #a855f7,
|
||||||
|
rarity-legendary: #ff8000,
|
||||||
|
|
||||||
icon-invert: 100%,
|
icon-invert: 100%,
|
||||||
|
|
||||||
@@ -68,9 +78,17 @@ $themes: (
|
|||||||
container-shadow: #5f6774,
|
container-shadow: #5f6774,
|
||||||
sticky-header-bg: #fff,
|
sticky-header-bg: #fff,
|
||||||
|
|
||||||
red: #e06c75,
|
// Quoted for the same reason as in the dark map.
|
||||||
green: #98c379,
|
"red": #e06c75,
|
||||||
gray: #cccccc,
|
"green": #98c379,
|
||||||
|
"gray": #cccccc,
|
||||||
|
|
||||||
|
// Same rarities as the dark map, darkened to stay readable on a light background.
|
||||||
|
rarity-common: #1e1e1e,
|
||||||
|
rarity-uncommon: #157f2b,
|
||||||
|
rarity-rare: #1d4ed8,
|
||||||
|
rarity-very-rare: #7e22ce,
|
||||||
|
rarity-legendary: #c05621,
|
||||||
|
|
||||||
icon-invert: 0%,
|
icon-invert: 0%,
|
||||||
|
|
||||||
|
|||||||
@@ -417,4 +417,89 @@ span.artifact {
|
|||||||
|
|
||||||
.fold.is-collapsed > .fold-body {
|
.fold.is-collapsed > .fold-body {
|
||||||
display: none;
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* El markdown renderitzat de la documentació: tot dins de .docs-markdown, que ve de v-html.
|
||||||
|
Va aquí perquè la pàgina de /docs (views/DocsView.vue) i la finestra de documentació
|
||||||
|
(windows/DocumentationWindow.vue) se'l serveixen plegades. */
|
||||||
|
.docs-markdown h1 {
|
||||||
|
margin: 0 0 14px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 2rem;
|
||||||
|
font-weight: normal;
|
||||||
|
line-height: 1.2;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown h2 {
|
||||||
|
margin: 30px 0 10px 0;
|
||||||
|
padding-bottom: 4px;
|
||||||
|
border-bottom: 1px solid var(--color-border);
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 1.35rem;
|
||||||
|
font-weight: normal;
|
||||||
|
scroll-margin-top: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown h3 {
|
||||||
|
margin: 22px 0 8px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 1.1rem;
|
||||||
|
font-weight: normal;
|
||||||
|
scroll-margin-top: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown p,
|
||||||
|
.docs-markdown li {
|
||||||
|
line-height: 1.65;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown ul,
|
||||||
|
.docs-markdown ol {
|
||||||
|
margin: 10px 0;
|
||||||
|
padding-left: 1.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown a {
|
||||||
|
color: var(--color-link);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown code {
|
||||||
|
padding: 1px 5px;
|
||||||
|
border-radius: 4px;
|
||||||
|
background-color: var(--color-background-light);
|
||||||
|
font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;
|
||||||
|
font-size: 0.9em;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown pre {
|
||||||
|
margin: 14px 0;
|
||||||
|
padding: 12px 14px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 8px;
|
||||||
|
background-color: var(--color-background-light);
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown pre code {
|
||||||
|
padding: 0;
|
||||||
|
background-color: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown table {
|
||||||
|
margin: 14px 0;
|
||||||
|
border-collapse: collapse;
|
||||||
|
width: 100%;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown th,
|
||||||
|
.docs-markdown td {
|
||||||
|
padding: 7px 10px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
text-align: left;
|
||||||
|
vertical-align: top;
|
||||||
|
line-height: 1.5;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-markdown th {
|
||||||
|
background-color: var(--color-background-light);
|
||||||
}
|
}
|
||||||
@@ -8,6 +8,7 @@ import { emitter } from '~/services/Emitter';
|
|||||||
import { BuildColorMenu } from '~/services/EntryColors';
|
import { BuildColorMenu } from '~/services/EntryColors';
|
||||||
import { BuildItemRows } from '~/services/ItemFolders';
|
import { BuildItemRows } from '~/services/ItemFolders';
|
||||||
import Server, { getBaseUrl } from '~/services/Server';
|
import Server, { getBaseUrl } from '~/services/Server';
|
||||||
|
import { DisplayToast } from '~/services/Toaster';
|
||||||
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
|
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
|
||||||
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
|
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
|
||||||
import { ACTOR_DRAG_TYPE } from '~/services/MapTokens';
|
import { ACTOR_DRAG_TYPE } from '~/services/MapTokens';
|
||||||
@@ -29,6 +30,9 @@ const entryFolders = { actor: ref([]), item: ref([]), map: ref([]) };
|
|||||||
const collapsedFolderIds = ref([]);
|
const collapsedFolderIds = ref([]);
|
||||||
const loadingNotes = ref(false);
|
const loadingNotes = ref(false);
|
||||||
const loadingEntries = ref(false);
|
const loadingEntries = ref(false);
|
||||||
|
// An import of the whole linked world takes a moment, and clicking the row again while
|
||||||
|
// it runs must not start a second one.
|
||||||
|
const importingFoundry = ref(false);
|
||||||
const notesError = ref('');
|
const notesError = ref('');
|
||||||
const entriesError = ref('');
|
const entriesError = ref('');
|
||||||
const sidebarCollapsed = ref(false);
|
const sidebarCollapsed = ref(false);
|
||||||
@@ -279,8 +283,13 @@ function entrySummary(actor) {
|
|||||||
return bits.join(' · ');
|
return bits.join(' · ');
|
||||||
}
|
}
|
||||||
|
|
||||||
function itemSummary(item) {
|
// The rarity of an item colours the text of its row instead of listing category, rarity and
|
||||||
return `${t(`campaigns.item.categories.${item.category}`)} · ${t(`campaigns.item.rarities.${item.rarity}`)} · ${t('campaigns.item.quantity-short')} ${item.quantity}`;
|
// quantity (Syndria98/dragonroll#63): common white, uncommon green, rare blue, very rare purple,
|
||||||
|
// legendary orange. Anything else (artifact) keeps the default text colour.
|
||||||
|
function rarityClass(item) {
|
||||||
|
return ['common', 'uncommon', 'rare', 'very-rare', 'legendary'].includes(item.rarity)
|
||||||
|
? `rarity-${item.rarity}`
|
||||||
|
: '';
|
||||||
}
|
}
|
||||||
|
|
||||||
// An item's icon in the sidebar: an uploaded filename served from /api/public, or a full URL
|
// An item's icon in the sidebar: an uploaded filename served from /api/public, or a full URL
|
||||||
@@ -304,6 +313,35 @@ function editMap(map) {
|
|||||||
CreateWindow('create_map', { campaign: campaignId.value, entry: map });
|
CreateWindow('create_map', { campaign: campaignId.value, entry: map });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The one sidebar action that asks the linked world instead of the campaign's own rows
|
||||||
|
// (Syndria98/dragonroll#77): the backend reads what the Foundry bridge is showing and
|
||||||
|
// writes every actor or item of it through the writers a sync push uses, so the rows
|
||||||
|
// the campaign already has are written over and only the world's new ones are made.
|
||||||
|
// The list is read back once the answer is in, so whatever arrived is on screen, and
|
||||||
|
// the toast says how the world landed.
|
||||||
|
async function forceImportFromFoundry(entityType) {
|
||||||
|
const section = sectionForTarget(entityType);
|
||||||
|
if (!campaignId.value || !section || importingFoundry.value) return;
|
||||||
|
|
||||||
|
importingFoundry.value = true;
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/foundry/import', { campaign: campaignId.value, kind: section });
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
DisplayToast('red', t(response.data.msg || 'campaigns.foundry-import.error'), 3000);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
DisplayToast('green', t('campaigns.foundry-import.done', {
|
||||||
|
imported: response.data.imported ?? 0,
|
||||||
|
updated: response.data.updated ?? 0
|
||||||
|
}), 3000);
|
||||||
|
await fetchCampaignEntries(section);
|
||||||
|
} catch (error) {
|
||||||
|
DisplayToast('red', t('campaigns.foundry-import.error'), 3000);
|
||||||
|
} finally {
|
||||||
|
importingFoundry.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
function showEntryMenu(entry, entityType) {
|
function showEntryMenu(entry, entityType) {
|
||||||
const list = entryLists[entityType];
|
const list = entryLists[entityType];
|
||||||
const menuItems = [];
|
const menuItems = [];
|
||||||
@@ -323,6 +361,18 @@ function showEntryMenu(entry, entityType) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// The actor and item lists mirror a linked Foundry world, so their rows also offer
|
||||||
|
// to pull the whole world over: this row is not sent or fetched on its own, the
|
||||||
|
// section's whole list is imported and the rows already in it are only updated.
|
||||||
|
if (entityType === 'actor' || entityType === 'item') {
|
||||||
|
menuItems.push({ divider: true });
|
||||||
|
menuItems.push({
|
||||||
|
name: t('campaigns.foundry-import.run'),
|
||||||
|
icon: '/icons/iconoir/regular/import.svg',
|
||||||
|
action: () => { HideContextMenu(); forceImportFromFoundry(entityType); }
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
// Rows of every section can be filed into a folder of their own list, like a note
|
// Rows of every section can be filed into a folder of their own list, like a note
|
||||||
// into a folder of the note tree.
|
// into a folder of the note tree.
|
||||||
menuItems.push({
|
menuItems.push({
|
||||||
@@ -681,9 +731,8 @@ onBeforeUnmount(() => {
|
|||||||
<span v-if="row.item.image" class="entity-entry-image" aria-hidden="true">
|
<span v-if="row.item.image" class="entity-entry-image" aria-hidden="true">
|
||||||
<img :src="itemImageUrl(row.item.image)" alt="">
|
<img :src="itemImageUrl(row.item.image)" alt="">
|
||||||
</span>
|
</span>
|
||||||
<span class="entity-entry-name">{{ row.item.name }}</span>
|
<span class="entity-entry-name" :class="rarityClass(row.item)">{{ row.item.name }}</span>
|
||||||
</span>
|
</span>
|
||||||
<span class="entity-entry-meta">{{ itemSummary(row.item) }}</span>
|
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
</template>
|
</template>
|
||||||
@@ -877,6 +926,13 @@ onBeforeUnmount(() => {
|
|||||||
/* An item row leads with the item's own icon on the left of its name, standing in for the
|
/* An item row leads with the item's own icon on the left of its name, standing in for the
|
||||||
"SYNCED" text it used to show (Syndria98/dragonroll#53). */
|
"SYNCED" text it used to show (Syndria98/dragonroll#53). */
|
||||||
.entity-entry-title { display: flex; align-items: center; gap: 9px; min-width: 0; }
|
.entity-entry-title { display: flex; align-items: center; gap: 9px; min-width: 0; }
|
||||||
|
/* The rarity of an item colours the text of its row (Syndria98/dragonroll#63): common white,
|
||||||
|
uncommon green, rare blue, very rare purple, legendary orange. */
|
||||||
|
.entity-entry-name.rarity-common { color: var(--color-rarity-common); }
|
||||||
|
.entity-entry-name.rarity-uncommon { color: var(--color-rarity-uncommon); }
|
||||||
|
.entity-entry-name.rarity-rare { color: var(--color-rarity-rare); }
|
||||||
|
.entity-entry-name.rarity-very-rare { color: var(--color-rarity-very-rare); }
|
||||||
|
.entity-entry-name.rarity-legendary { color: var(--color-rarity-legendary); }
|
||||||
.entity-entry-image {
|
.entity-entry-image {
|
||||||
flex: 0 0 30px; width: 30px; height: 30px; box-sizing: border-box;
|
flex: 0 0 30px; width: 30px; height: 30px; box-sizing: border-box;
|
||||||
display: grid; place-items: center; overflow: hidden;
|
display: grid; place-items: center; overflow: hidden;
|
||||||
|
|||||||
@@ -13,6 +13,13 @@ function OpenCampaignSettings() {
|
|||||||
CreateWindow('campaign_settings', { campaign: Campaign.value });
|
CreateWindow('campaign_settings', { campaign: Campaign.value });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function OpenDocumentation() {
|
||||||
|
// La documentació és una finestra que va davant de l'espai de treball, així que les notes
|
||||||
|
// obertes no es perden. CreateWindow deixa sola una finestra que ja és oberta: tornar a
|
||||||
|
// prémer el botó no la torna a la primera pàgina.
|
||||||
|
CreateWindow('documentation');
|
||||||
|
}
|
||||||
|
|
||||||
function ExitCampaign() {
|
function ExitCampaign() {
|
||||||
// Torn al menú principal: neteja la campanya (i el localStorage), amaga
|
// Torn al menú principal: neteja la campanya (i el localStorage), amaga
|
||||||
// l'espai de treball i reobre el menú
|
// l'espai de treball i reobre el menú
|
||||||
@@ -35,6 +42,11 @@ function ExitCampaign() {
|
|||||||
<TopSearchBar></TopSearchBar>
|
<TopSearchBar></TopSearchBar>
|
||||||
</div>
|
</div>
|
||||||
<div class="right">
|
<div class="right">
|
||||||
|
<!-- La documentació s'obre en una finestra seva, davant de la campanya: les notes
|
||||||
|
obertes no es perden i no cal obrir una pestanya nova. -->
|
||||||
|
<button class="btn-primary settings-button docs-button sound-click" type="button" @click="OpenDocumentation">
|
||||||
|
{{ $t('main-menu.documentation') }}
|
||||||
|
</button>
|
||||||
<button class="btn-primary settings-button sound-click" type="button" @click="OpenCampaignSettings">
|
<button class="btn-primary settings-button sound-click" type="button" @click="OpenCampaignSettings">
|
||||||
{{ $t('main-menu.settings') }}
|
{{ $t('main-menu.settings') }}
|
||||||
</button>
|
</button>
|
||||||
|
|||||||
@@ -436,6 +436,14 @@ async function onTokenPointerUp(event) {
|
|||||||
await placeToken(token.actor, { x, y });
|
await placeToken(token.actor, { x, y });
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Double clicking a token (or Enter on a focused one) opens the sheet of the actor it stands for.
|
||||||
|
// A single click cannot be the trigger: the click that ends a drag lands on the token too, so
|
||||||
|
// dragging a token over the map would open its sheet every time.
|
||||||
|
function openTokenSheet(token) {
|
||||||
|
const actor = tokenActor(token);
|
||||||
|
if (actor) openActorSheet(actor);
|
||||||
|
}
|
||||||
|
|
||||||
const CELL_STEPS = {
|
const CELL_STEPS = {
|
||||||
ArrowLeft: [-1, 0],
|
ArrowLeft: [-1, 0],
|
||||||
ArrowRight: [1, 0],
|
ArrowRight: [1, 0],
|
||||||
@@ -443,7 +451,8 @@ const CELL_STEPS = {
|
|||||||
ArrowDown: [0, 1]
|
ArrowDown: [0, 1]
|
||||||
};
|
};
|
||||||
|
|
||||||
// A focused token answers to the keyboard too: arrows walk it over the grid, Delete takes it off.
|
// A focused token answers to the keyboard too: arrows walk it over the grid, Delete takes it off
|
||||||
|
// and Enter opens its sheet, the way a double click does.
|
||||||
async function onTokenKeydown(event, token) {
|
async function onTokenKeydown(event, token) {
|
||||||
const step = CELL_STEPS[event.key];
|
const step = CELL_STEPS[event.key];
|
||||||
if (step) {
|
if (step) {
|
||||||
@@ -456,6 +465,7 @@ async function onTokenKeydown(event, token) {
|
|||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
await removeToken(token);
|
await removeToken(token);
|
||||||
}
|
}
|
||||||
|
if (event.key === 'Enter') openTokenSheet(token);
|
||||||
}
|
}
|
||||||
|
|
||||||
function onTokenContextMenu(token) {
|
function onTokenContextMenu(token) {
|
||||||
@@ -609,6 +619,7 @@ onBeforeUnmount(() => {
|
|||||||
@pointermove="onTokenPointerMove"
|
@pointermove="onTokenPointerMove"
|
||||||
@pointerup="onTokenPointerUp"
|
@pointerup="onTokenPointerUp"
|
||||||
@pointercancel="onTokenPointerUp"
|
@pointercancel="onTokenPointerUp"
|
||||||
|
@dblclick="openTokenSheet(token)"
|
||||||
@contextmenu.stop.prevent="onTokenContextMenu(token)"
|
@contextmenu.stop.prevent="onTokenContextMenu(token)"
|
||||||
@keydown="onTokenKeydown($event, token)"
|
@keydown="onTokenKeydown($event, token)"
|
||||||
>
|
>
|
||||||
|
|||||||
67
frontend/app/components/views/AppShell.vue
Normal file
67
frontend/app/components/views/AppShell.vue
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
<script setup>
|
||||||
|
import ContentManager from '../managers/ContentManager.vue';
|
||||||
|
import ToastManager from '../managers/ToastManager.vue';
|
||||||
|
import WindowManager from '../managers/WindowManager.vue';
|
||||||
|
import ServiceLinkAuthorize from './ServiceLinkAuthorize.vue';
|
||||||
|
|
||||||
|
import { CreateWindow } from '@/services/Windows'
|
||||||
|
import { GetUser, HasAdmin } from '@/services/User';
|
||||||
|
import TooltipManager from '../managers/TooltipManager.vue';
|
||||||
|
import ContextMenuManager from '../managers/ContextMenuManager.vue';
|
||||||
|
import { useCampaignService } from '@/services/Campaign';
|
||||||
|
|
||||||
|
const { RestoreCampaign } = useCampaignService();
|
||||||
|
|
||||||
|
// Els serveis (Discord, Foundry, Obsidian) enllacen amb aquesta pantalla única; no són part
|
||||||
|
// de l'aplicació i no han d'arrencar les finestres normals. La ruta antiga de Discord també
|
||||||
|
// hi porta, perquè els enllaços que ja corren per Discord no queden morts.
|
||||||
|
const requestUrl = useRequestURL();
|
||||||
|
const isServiceLink = computed(() => {
|
||||||
|
const path = requestUrl.pathname.replace(/\/+$/, '');
|
||||||
|
return path === '/link/authorize' || path === '/discord/authorize';
|
||||||
|
});
|
||||||
|
|
||||||
|
async function start(){
|
||||||
|
if(GetUser()){
|
||||||
|
const restoredCampaign = await RestoreCampaign();
|
||||||
|
if (!restoredCampaign) {
|
||||||
|
CreateWindow('main_menu');
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if(await HasAdmin()){
|
||||||
|
CreateWindow('login');
|
||||||
|
} else {
|
||||||
|
CreateWindow('register', {firstTime: true});
|
||||||
|
}
|
||||||
|
// DisplayToast('aqua', 'All plugins loaded successfully');
|
||||||
|
}
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
if(!isServiceLink.value){
|
||||||
|
start();
|
||||||
|
}
|
||||||
|
})
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<ServiceLinkAuthorize v-if="isServiceLink"></ServiceLinkAuthorize>
|
||||||
|
<div v-else class="viewer">
|
||||||
|
<ToastManager></ToastManager>
|
||||||
|
<TooltipManager></TooltipManager>
|
||||||
|
<ContextMenuManager></ContextMenuManager>
|
||||||
|
<WindowManager></WindowManager>
|
||||||
|
<ContentManager></ContentManager>
|
||||||
|
<!-- Managers -->
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.viewer {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
width: 100%;
|
||||||
|
height: 100vh;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
343
frontend/app/components/views/DocsView.vue
Normal file
343
frontend/app/components/views/DocsView.vue
Normal file
@@ -0,0 +1,343 @@
|
|||||||
|
<script setup>
|
||||||
|
import { computed } from 'vue';
|
||||||
|
import { GetDocsFirstSlug, GetDocsNav, GetDocsPage } from '~/services/Docs';
|
||||||
|
|
||||||
|
// La documentació pública, a /docs: el sumari a l'esquerra, la pàgina al centre i els
|
||||||
|
// apartats d'aquesta pàgina a la dreta. Tot el que hi ha escrit ve dels markdown de
|
||||||
|
// app/content/docs (mira ~/services/Docs.js), i cada enllaç del sumari és una ruta,
|
||||||
|
// així que moure-s'hi no recarrega la pàgina.
|
||||||
|
const route = useRoute();
|
||||||
|
|
||||||
|
const slug = computed(() => String(route.params.slug || GetDocsFirstSlug()));
|
||||||
|
const page = computed(() => GetDocsPage(slug.value));
|
||||||
|
const nav = GetDocsNav();
|
||||||
|
|
||||||
|
useHead({
|
||||||
|
title: computed(() => `${page.value?.title || 'Documentation'} · Dragonroll`)
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="docs">
|
||||||
|
<aside class="docs-sidebar">
|
||||||
|
<NuxtLink class="docs-brand" to="/">
|
||||||
|
<img src="/img/logo.png" alt="Dragonroll logo" class="docs-logo" draggable="false">
|
||||||
|
<span>{{ $t('docs.title') }}</span>
|
||||||
|
</NuxtLink>
|
||||||
|
|
||||||
|
<nav class="docs-contents" :aria-label="$t('docs.contents')">
|
||||||
|
<section v-for="group in nav" :key="group.key" class="docs-group">
|
||||||
|
<h2 class="docs-group-title">{{ $t(`docs.groups.${group.key}`) }}</h2>
|
||||||
|
<ul>
|
||||||
|
<li v-for="entry in group.pages" :key="entry.slug">
|
||||||
|
<NuxtLink
|
||||||
|
:to="entry.href"
|
||||||
|
class="docs-nav-link"
|
||||||
|
:class="{ active: entry.slug === slug }"
|
||||||
|
>{{ entry.title }}</NuxtLink>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<NuxtLink class="docs-open" to="/">{{ $t('docs.open-app') }}</NuxtLink>
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
<main class="docs-main">
|
||||||
|
<template v-if="page">
|
||||||
|
<article class="docs-article">
|
||||||
|
<p class="docs-kicker">{{ $t(`docs.groups.${page.group}`) }}</p>
|
||||||
|
<!-- El contingut és markdown nostre, de app/content/docs -->
|
||||||
|
<div class="docs-markdown" v-html="page.html"></div>
|
||||||
|
</article>
|
||||||
|
|
||||||
|
<nav class="docs-pager">
|
||||||
|
<NuxtLink
|
||||||
|
v-if="page.previous"
|
||||||
|
:to="page.previous.href"
|
||||||
|
class="docs-pager-link"
|
||||||
|
>
|
||||||
|
<span class="docs-pager-label">{{ $t('docs.previous') }}</span>
|
||||||
|
<strong>{{ page.previous.title }}</strong>
|
||||||
|
</NuxtLink>
|
||||||
|
<NuxtLink
|
||||||
|
v-if="page.next"
|
||||||
|
:to="page.next.href"
|
||||||
|
class="docs-pager-link next"
|
||||||
|
>
|
||||||
|
<span class="docs-pager-label">{{ $t('docs.next') }}</span>
|
||||||
|
<strong>{{ page.next.title }}</strong>
|
||||||
|
</NuxtLink>
|
||||||
|
</nav>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<article v-else class="docs-article">
|
||||||
|
<h1>{{ $t('docs.title') }}</h1>
|
||||||
|
<p>{{ $t('docs.not-found', { page: slug }) }}</p>
|
||||||
|
<p><NuxtLink to="/docs">{{ $t('docs.back-to-docs') }}</NuxtLink></p>
|
||||||
|
</article>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<aside
|
||||||
|
v-if="page && page.headings.length"
|
||||||
|
class="docs-sections"
|
||||||
|
:aria-label="$t('docs.on-this-page')"
|
||||||
|
>
|
||||||
|
<h2>{{ $t('docs.on-this-page') }}</h2>
|
||||||
|
<ul>
|
||||||
|
<li
|
||||||
|
v-for="heading in page.headings"
|
||||||
|
:key="heading.slug"
|
||||||
|
:class="`depth-${heading.depth}`"
|
||||||
|
>
|
||||||
|
<a :href="`#${heading.slug}`">{{ heading.text }}</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</aside>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped lang="scss">
|
||||||
|
.docs {
|
||||||
|
display: flex;
|
||||||
|
align-items: flex-start;
|
||||||
|
width: 100%;
|
||||||
|
min-height: 100vh;
|
||||||
|
box-sizing: border-box;
|
||||||
|
background-color: var(--color-background);
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Els dos aside fan la pàgina sencera avall: amb alçada d'una pantalla i enganxats a
|
||||||
|
dalt, el fons i la vora arriben sempre fins a baix, per molt llarg que sigui el text. */
|
||||||
|
.docs-sidebar,
|
||||||
|
.docs-sections {
|
||||||
|
position: sticky;
|
||||||
|
top: 0;
|
||||||
|
height: 100vh;
|
||||||
|
overflow-y: auto;
|
||||||
|
box-sizing: border-box;
|
||||||
|
padding: 18px 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sidebar {
|
||||||
|
flex: 0 0 268px;
|
||||||
|
width: 268px;
|
||||||
|
border-right: 1px solid var(--color-border);
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-brand {
|
||||||
|
display: flex;
|
||||||
|
align-items: center;
|
||||||
|
gap: 10px;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 1.15rem;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-logo {
|
||||||
|
width: 30px;
|
||||||
|
height: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-contents {
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-group-title {
|
||||||
|
margin: 0 0 6px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
font-weight: normal;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-contents ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link {
|
||||||
|
display: block;
|
||||||
|
padding: 6px 9px;
|
||||||
|
border-radius: 6px;
|
||||||
|
font-size: 0.97rem;
|
||||||
|
line-height: 1.35;
|
||||||
|
color: var(--color-text);
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link:hover {
|
||||||
|
background-color: var(--color-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link.active {
|
||||||
|
background-color: var(--color-background-soft);
|
||||||
|
color: var(--color-link);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-open {
|
||||||
|
margin-top: auto;
|
||||||
|
padding: 8px 9px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 6px;
|
||||||
|
background-color: var(--color-button-background);
|
||||||
|
font-size: 0.95rem;
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-open:hover {
|
||||||
|
background-color: var(--color-button-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-main {
|
||||||
|
flex: 1;
|
||||||
|
min-width: 0;
|
||||||
|
padding: 26px 34px 60px 34px;
|
||||||
|
box-sizing: border-box;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* La columna de lectura, centrada dins l'espai que deixa la barra lateral: en una finestra
|
||||||
|
ampla el text queda al mig, no enganxat a l'esquerra. */
|
||||||
|
.docs-article,
|
||||||
|
.docs-pager {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 760px;
|
||||||
|
margin-inline: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-kicker {
|
||||||
|
margin: 0 0 4px 0;
|
||||||
|
font-size: 0.8rem;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager {
|
||||||
|
margin-top: 34px;
|
||||||
|
padding-top: 18px;
|
||||||
|
border-top: 1px solid var(--color-border);
|
||||||
|
display: flex;
|
||||||
|
gap: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-link {
|
||||||
|
flex: 1 1 0;
|
||||||
|
min-width: 0;
|
||||||
|
padding: 10px 12px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 8px;
|
||||||
|
color: var(--color-text);
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-link:hover {
|
||||||
|
background-color: var(--color-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-link.next {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-label {
|
||||||
|
display: block;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
letter-spacing: 0.06em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections {
|
||||||
|
flex: 0 0 240px;
|
||||||
|
width: 240px;
|
||||||
|
/* Més aire al voltant dels apartats, que ara mateix van clavats a la vora. */
|
||||||
|
padding: 26px 22px 26px 18px;
|
||||||
|
border-left: 1px solid var(--color-border);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections h2 {
|
||||||
|
margin: 0 0 8px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
font-weight: normal;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections li.depth-3 {
|
||||||
|
padding-left: 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections a {
|
||||||
|
display: block;
|
||||||
|
padding: 3px 0;
|
||||||
|
font-size: 0.9rem;
|
||||||
|
line-height: 1.35;
|
||||||
|
color: var(--color-gray);
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sections a:hover {
|
||||||
|
color: var(--color-link);
|
||||||
|
}
|
||||||
|
|
||||||
|
/* El markdown renderitzat ve estilat a assets/css/main.scss, sota .docs-markdown, perquè la
|
||||||
|
finestra de documentació (windows/DocumentationWindow.vue) se'l serveix igualment. */
|
||||||
|
|
||||||
|
/* Finestra molt ampla: tot el conjunt va al mig, així els apartats queden a prop del
|
||||||
|
text en lloc d'estirats cap al cantó dret de la pantalla. */
|
||||||
|
@media (min-width: 1440px) {
|
||||||
|
.docs {
|
||||||
|
justify-content: center;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-main {
|
||||||
|
flex: 0 1 860px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 1200px) {
|
||||||
|
.docs-sections {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@media (max-width: 900px) {
|
||||||
|
.docs {
|
||||||
|
flex-direction: column;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-sidebar,
|
||||||
|
.docs-sections {
|
||||||
|
position: static;
|
||||||
|
height: auto;
|
||||||
|
width: 100%;
|
||||||
|
border-left: none;
|
||||||
|
border-right: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-main {
|
||||||
|
padding: 20px 18px 40px 18px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
@@ -24,6 +24,23 @@ const abilityStats = [
|
|||||||
{ key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' }
|
{ key: 'int', label: 'INT' }, { key: 'wis', label: 'WIS' }, { key: 'cha', label: 'CHA' }
|
||||||
];
|
];
|
||||||
|
|
||||||
|
// Les habilitats del 5e. Cada una té un cercle que s'encén quan el personatge hi és
|
||||||
|
// proficient, i la modificadora que tira és la de la característica que mana.
|
||||||
|
const skillList = [
|
||||||
|
{ key: 'acrobatics', ability: 'dex' }, { key: 'animalHandling', ability: 'wis' },
|
||||||
|
{ key: 'arcana', ability: 'int' }, { key: 'athletics', ability: 'str' },
|
||||||
|
{ key: 'deception', ability: 'cha' }, { key: 'history', ability: 'int' },
|
||||||
|
{ key: 'insight', ability: 'wis' }, { key: 'intimidation', ability: 'cha' },
|
||||||
|
{ key: 'investigation', ability: 'int' }, { key: 'medicine', ability: 'wis' },
|
||||||
|
{ key: 'nature', ability: 'int' }, { key: 'perception', ability: 'wis' },
|
||||||
|
{ key: 'performance', ability: 'cha' }, { key: 'persuasion', ability: 'cha' },
|
||||||
|
{ key: 'religion', ability: 'int' }, { key: 'sleightOfHand', ability: 'dex' },
|
||||||
|
{ key: 'stealth', ability: 'dex' }, { key: 'survival', ability: 'wis' }
|
||||||
|
];
|
||||||
|
|
||||||
|
// Les cinc monedes que un personatge porta al damunt.
|
||||||
|
const currencyUnits = ['pp', 'gp', 'ep', 'sp', 'cp'];
|
||||||
|
|
||||||
// Les pestanyes del lateral dret reparteixen la fitxa: característiques i combat,
|
// Les pestanyes del lateral dret reparteixen la fitxa: característiques i combat,
|
||||||
// inventari, trets i conjurs. Són pestanyes de marcadors, no una pàgina nova.
|
// inventari, trets i conjurs. Són pestanyes de marcadors, no una pàgina nova.
|
||||||
const tabs = [
|
const tabs = [
|
||||||
@@ -34,6 +51,22 @@ const tabs = [
|
|||||||
];
|
];
|
||||||
const activeTab = ref('abilities');
|
const activeTab = ref('abilities');
|
||||||
|
|
||||||
|
// Les pestanyes pengen del marc de la finestra, per fora del contingent (vegeu .sheet-tabs). La
|
||||||
|
// finestra es fa més estreta perquè el marge que la centra sigui prou ample per aguantar-les;
|
||||||
|
// per sota de 760px el marc les fa estar a dins i el marge deixa de fer falta.
|
||||||
|
const TAB_RAIL_WIDTH = 150;
|
||||||
|
|
||||||
|
// Les eines i els idiomes viatgen com a llista i el formulari els edita com un quadre
|
||||||
|
// de text: un nom per línia. Les comes també separen, que és com s'escriuen en una frase.
|
||||||
|
function proficiencyText(value) {
|
||||||
|
const names = Array.isArray(value) ? value : String(value ?? '').split(/[\n,]/);
|
||||||
|
return [...new Set(names.map((name) => String(name).trim()).filter(Boolean))].join('\n');
|
||||||
|
}
|
||||||
|
|
||||||
|
function proficiencyList(text) {
|
||||||
|
return [...new Set(String(text ?? '').split(/[\n,]/).map((name) => String(name).trim()).filter(Boolean))];
|
||||||
|
}
|
||||||
|
|
||||||
function normalizeActor(actor) {
|
function normalizeActor(actor) {
|
||||||
return {
|
return {
|
||||||
name: actor?.name ?? '',
|
name: actor?.name ?? '',
|
||||||
@@ -44,9 +77,28 @@ function normalizeActor(actor) {
|
|||||||
abilityScores: Object.fromEntries(abilityStats.map(({ key }) => [key, Number(actor?.abilityScores?.[key] ?? 10)])),
|
abilityScores: Object.fromEntries(abilityStats.map(({ key }) => [key, Number(actor?.abilityScores?.[key] ?? 10)])),
|
||||||
armorClass: Number(actor?.armorClass ?? 10),
|
armorClass: Number(actor?.armorClass ?? 10),
|
||||||
speed: Number(actor?.speed ?? 30),
|
speed: Number(actor?.speed ?? 30),
|
||||||
|
// Les barres sota la imatge: `current` de `max`. Un personatge que encara no en té
|
||||||
|
// rep un dau de cop per nivell, que és el que D&D compta.
|
||||||
|
hitPoints: {
|
||||||
|
current: Number(actor?.hitPoints?.current ?? actor?.hitPoints?.max ?? 10),
|
||||||
|
max: Number(actor?.hitPoints?.max ?? actor?.hitPoints?.current ?? 10)
|
||||||
|
},
|
||||||
|
hitDice: {
|
||||||
|
current: Number(actor?.hitDice?.current ?? actor?.level ?? 1),
|
||||||
|
max: Number(actor?.hitDice?.max ?? actor?.level ?? 1)
|
||||||
|
},
|
||||||
proficiencies: actor?.proficiencies ?? '',
|
proficiencies: actor?.proficiencies ?? '',
|
||||||
|
// El que el personatge sap fer i el que porta: les habilitats i les tirades de
|
||||||
|
// salvació són cercles que s'encenen, les eines i els idiomes són noms que el
|
||||||
|
// formulari edita com un text d'una línia per nom, i la moneda són cinc xifres.
|
||||||
|
skills: Object.fromEntries(skillList.map(({ key }) => [key, Boolean(actor?.skills?.[key])])),
|
||||||
|
savingThrows: Object.fromEntries(abilityStats.map(({ key }) => [key, Boolean(actor?.savingThrows?.[key])])),
|
||||||
|
tools: proficiencyText(actor?.tools),
|
||||||
|
languages: proficiencyText(actor?.languages),
|
||||||
|
currency: Object.fromEntries(currencyUnits.map((unit) => [unit, Number(actor?.currency?.[unit] ?? 0) || 0])),
|
||||||
inventory: (actor?.inventory ?? []).map((item) => ({
|
inventory: (actor?.inventory ?? []).map((item) => ({
|
||||||
name: item.name ?? '', quantity: Number(item.quantity ?? 1), weight: Number(item.weight ?? 0)
|
name: item.name ?? '', quantity: Number(item.quantity ?? 1), weight: Number(item.weight ?? 0),
|
||||||
|
icon: item.icon ?? ''
|
||||||
})),
|
})),
|
||||||
traits: actor?.traits ?? '',
|
traits: actor?.traits ?? '',
|
||||||
spells: actor?.spells ?? '',
|
spells: actor?.spells ?? '',
|
||||||
@@ -60,8 +112,11 @@ original.value = normalizeActor(props.data.actor);
|
|||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
Top(wrapper);
|
Top(wrapper);
|
||||||
SetupHandle(id, handle);
|
SetupHandle(id, handle);
|
||||||
|
// Les pestanyes pengen del marc per fora del cos: com que la finestra es centra, el marge que
|
||||||
|
// li queda a la dreta és la meitat del que li sobra, i cal reservar-nos el doble.
|
||||||
|
const railRoom = window.innerWidth > 760 ? 2 * TAB_RAIL_WIDTH : 0;
|
||||||
SetSize(id, {
|
SetSize(id, {
|
||||||
width: Math.max(320, Math.min(900, window.innerWidth - 24)),
|
width: Math.max(320, Math.min(900, window.innerWidth - 24 - railRoom)),
|
||||||
height: Math.max(360, Math.min(700, window.innerHeight - 32))
|
height: Math.max(360, Math.min(700, window.innerHeight - 32))
|
||||||
});
|
});
|
||||||
ResetPosition(id, 'center');
|
ResetPosition(id, 'center');
|
||||||
@@ -79,21 +134,50 @@ onMounted(() => emitter.on('campaign-entry-updated', handleActorSync));
|
|||||||
onBeforeUnmount(() => emitter.off('campaign-entry-updated', handleActorSync));
|
onBeforeUnmount(() => emitter.off('campaign-entry-updated', handleActorSync));
|
||||||
|
|
||||||
const proficiencyBonus = computed(() => Math.ceil(form.value.level / 4) + 1);
|
const proficiencyBonus = computed(() => Math.ceil(form.value.level / 4) + 1);
|
||||||
|
// La iniciativa és el modificador de DESTÀ, que és el que D&D compta quan el personatge no
|
||||||
|
// porta cap do extra que l'augmenti.
|
||||||
|
const initiativeBonus = computed(() => abilityModifier(form.value.abilityScores.dex));
|
||||||
|
// Quina part del màxim representa la barra; buida (màxim 0) o per sobre, tot tallat.
|
||||||
|
function barPercent(current, max) {
|
||||||
|
return max > 0 ? Math.min(100, Math.max(0, ((Number(current) || 0) / max) * 100)) : 0;
|
||||||
|
}
|
||||||
|
const hitPointsPercent = computed(() => barPercent(form.value.hitPoints.current, form.value.hitPoints.max));
|
||||||
|
const hitDicePercent = computed(() => barPercent(form.value.hitDice.current, form.value.hitDice.max));
|
||||||
const carryingCapacity = computed(() => form.value.abilityScores.str * 15);
|
const carryingCapacity = computed(() => form.value.abilityScores.str * 15);
|
||||||
const carriedWeight = computed(() => form.value.inventory.reduce((total, item) => total + (Number(item.quantity) || 0) * (Number(item.weight) || 0), 0));
|
const carriedWeight = computed(() => form.value.inventory.reduce((total, item) => total + (Number(item.quantity) || 0) * (Number(item.weight) || 0), 0));
|
||||||
const carryPercent = computed(() => Math.min(100, carryingCapacity.value ? (carriedWeight.value / carryingCapacity.value) * 100 : 0));
|
const carryPercent = computed(() => Math.min(100, carryingCapacity.value ? (carriedWeight.value / carryingCapacity.value) * 100 : 0));
|
||||||
|
|
||||||
function abilityModifier(score) {
|
// `bonus` és el bonificador de proficiència, per a les habilitats i les tirades de
|
||||||
const modifier = Math.floor((Number(score) - 10) / 2);
|
// salvació del personatge que hi està entrenat.
|
||||||
|
function abilityModifier(score, bonus = 0) {
|
||||||
|
const modifier = Math.floor((Number(score) - 10) / 2) + (Number(bonus) || 0);
|
||||||
return modifier >= 0 ? `+${modifier}` : String(modifier);
|
return modifier >= 0 ? `+${modifier}` : String(modifier);
|
||||||
}
|
}
|
||||||
|
|
||||||
const imageUrl = computed(() => {
|
function skillModifier(skill) {
|
||||||
if (!form.value.image) return '';
|
return abilityModifier(form.value.abilityScores[skill.ability], form.value.skills[skill.key] ? proficiencyBonus.value : 0);
|
||||||
return /^(https?:|data:|\/\/)/i.test(form.value.image)
|
}
|
||||||
? form.value.image
|
|
||||||
: `${getBaseUrl()}/public/${form.value.image}`;
|
function savingThrowModifier(stat) {
|
||||||
});
|
return abilityModifier(form.value.abilityScores[stat.key], form.value.savingThrows[stat.key] ? proficiencyBonus.value : 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
// El cercle d'una habilitat o d'una salvació: s'encén i s'apaga, i es desa amb tota la
|
||||||
|
// fitxa, com la resta del que s'edita.
|
||||||
|
function toggleProficiency(group, key) {
|
||||||
|
form.value[group][key] = !form.value[group][key];
|
||||||
|
}
|
||||||
|
|
||||||
|
// Una imatge pot ser una adreça sencera (la que Foundry dona a un objecte, per
|
||||||
|
// exemple) o un fitxer pujat aquí, que es serveix per `/api/public`.
|
||||||
|
function resolveImage(image) {
|
||||||
|
if (!image) return '';
|
||||||
|
return /^(https?:|data:|\/\/)/i.test(image)
|
||||||
|
? image
|
||||||
|
: `${getBaseUrl()}/public/${image}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
const imageUrl = computed(() => resolveImage(form.value.image));
|
||||||
|
|
||||||
function pickPhoto() {
|
function pickPhoto() {
|
||||||
photoInput.value?.click();
|
photoInput.value?.click();
|
||||||
@@ -157,6 +241,9 @@ async function saveSheet() {
|
|||||||
const payload = {
|
const payload = {
|
||||||
id: actorId,
|
id: actorId,
|
||||||
...form.value,
|
...form.value,
|
||||||
|
// Les eines i els idiomes van a l'API com a llista, que és com està desats.
|
||||||
|
tools: proficiencyList(form.value.tools),
|
||||||
|
languages: proficiencyList(form.value.languages),
|
||||||
inventory: form.value.inventory.filter((item) => item.name.trim())
|
inventory: form.value.inventory.filter((item) => item.name.trim())
|
||||||
};
|
};
|
||||||
const response = await Server().post('/actor/update', payload);
|
const response = await Server().post('/actor/update', payload);
|
||||||
@@ -179,6 +266,21 @@ async function saveSheet() {
|
|||||||
<template>
|
<template>
|
||||||
<div class="window-wrapper sheet-window" :id="'window-wrapper-' + id" ref="wrapper">
|
<div class="window-wrapper sheet-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
<WindowHandle :window="id" ref="handle" />
|
<WindowHandle :window="id" ref="handle" />
|
||||||
|
|
||||||
|
<!-- Pestilletes del marc de la finestra: pengen del cantó dret, per fora del
|
||||||
|
contingent, i no s'enrolen quan la fitxa desfila. -->
|
||||||
|
<nav class="sheet-tabs" role="tablist" aria-orientation="vertical">
|
||||||
|
<button
|
||||||
|
v-for="tab in tabs"
|
||||||
|
:key="tab.key"
|
||||||
|
class="sheet-tab"
|
||||||
|
:class="{ active: activeTab === tab.key }"
|
||||||
|
type="button"
|
||||||
|
role="tab"
|
||||||
|
:aria-selected="activeTab === tab.key"
|
||||||
|
@click="activeTab = tab.key"
|
||||||
|
>{{ $t(tab.label) }}</button>
|
||||||
|
</nav>
|
||||||
<div class="sheet-body">
|
<div class="sheet-body">
|
||||||
<header class="sheet-hero">
|
<header class="sheet-hero">
|
||||||
<div class="character-mark" aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</div>
|
<div class="character-mark" aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</div>
|
||||||
@@ -217,123 +319,218 @@ async function saveSheet() {
|
|||||||
|
|
||||||
<div v-if="error" class="sheet-error">{{ error }}</div>
|
<div v-if="error" class="sheet-error">{{ error }}</div>
|
||||||
|
|
||||||
|
<!-- La columna del personatge no penja de cap pestanya: la imatge i el que es mira
|
||||||
|
d'anada i tornada — classe d'armadura, velocitat, bonificadors i les barres de
|
||||||
|
cops — es queden a la vista des de qualsevol pestanya de la fitxa. -->
|
||||||
<div class="sheet-layout">
|
<div class="sheet-layout">
|
||||||
<div class="sheet-content">
|
<div class="character-column">
|
||||||
<main v-show="activeTab === 'abilities'" class="sheet-grid">
|
<div v-if="form.image || editing" class="sheet-portrait" :class="{ empty: !form.image }">
|
||||||
<div v-if="form.image || editing" class="sheet-portrait" :class="{ empty: !form.image }">
|
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.character-sheet.photo')">
|
||||||
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.character-sheet.photo')">
|
<button v-if="editing && !form.image" class="portrait-upload" type="button" :disabled="uploadingPhoto" @click="pickPhoto">
|
||||||
<button v-if="editing && !form.image" class="portrait-upload" type="button" :disabled="uploadingPhoto" @click="pickPhoto">
|
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.upload-photo') }}
|
||||||
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.upload-photo') }}
|
</button>
|
||||||
|
<div v-if="editing && form.image" class="portrait-controls">
|
||||||
|
<button type="button" :disabled="uploadingPhoto" @click="pickPhoto">
|
||||||
|
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.change-photo') }}
|
||||||
</button>
|
</button>
|
||||||
<div v-if="editing && form.image" class="portrait-controls">
|
<button type="button" :disabled="uploadingPhoto" :aria-label="$t('campaigns.character-sheet.remove-photo')" @click="removePhoto">×</button>
|
||||||
<button type="button" :disabled="uploadingPhoto" @click="pickPhoto">
|
|
||||||
{{ uploadingPhoto ? $t('campaigns.character-sheet.uploading-photo') : $t('campaigns.character-sheet.change-photo') }}
|
|
||||||
</button>
|
|
||||||
<button type="button" :disabled="uploadingPhoto" :aria-label="$t('campaigns.character-sheet.remove-photo')" @click="removePhoto">×</button>
|
|
||||||
</div>
|
|
||||||
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onPhotoSelected">
|
|
||||||
</div>
|
</div>
|
||||||
|
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onPhotoSelected">
|
||||||
|
</div>
|
||||||
|
|
||||||
<section class="sheet-panel abilities-panel">
|
<!-- El que es mira primer: classe d'armadura, velocitat i els bonificadors
|
||||||
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
|
que acompanyen els cops, tot just sota la imatge. -->
|
||||||
<div class="ability-grid">
|
<section class="sheet-panel vitals-panel">
|
||||||
<div v-for="stat in abilityStats" :key="stat.key" class="ability-card">
|
<div class="vital-stats">
|
||||||
<span class="ability-label">{{ stat.label }}</span>
|
<div class="vital-stat">
|
||||||
<input v-if="editing" v-model.number="form.abilityScores[stat.key]" type="number" min="1" max="30" :aria-label="stat.label">
|
<span>{{ $t('campaigns.character-sheet.armor-class') }}</span>
|
||||||
<strong v-else class="ability-score">{{ form.abilityScores[stat.key] }}</strong>
|
<input v-if="editing" v-model.number="form.armorClass" type="number" min="0" :aria-label="$t('campaigns.character-sheet.armor-class')">
|
||||||
<span class="ability-modifier">{{ abilityModifier(form.abilityScores[stat.key]) }}</span>
|
<strong v-else>{{ form.armorClass }}</strong>
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
<div class="proficiency-badge">
|
<div class="vital-stat">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.speed') }}</span>
|
||||||
|
<label v-if="editing" class="number-with-unit"><input v-model.number="form.speed" type="number" min="0" :aria-label="$t('campaigns.character-sheet.speed')"><small>ft</small></label>
|
||||||
|
<strong v-else>{{ form.speed }} <small>ft</small></strong>
|
||||||
|
</div>
|
||||||
|
<div class="vital-stat">
|
||||||
<span>{{ $t('campaigns.character-sheet.proficiency-bonus') }}</span>
|
<span>{{ $t('campaigns.character-sheet.proficiency-bonus') }}</span>
|
||||||
<strong>+{{ proficiencyBonus }}</strong>
|
<strong>+{{ proficiencyBonus }}</strong>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
<div class="vital-stat">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.initiative') }}</span>
|
||||||
<section class="sheet-panel combat-panel">
|
<strong>{{ initiativeBonus }}</strong>
|
||||||
<h2>{{ $t('campaigns.character-sheet.combat') }}</h2>
|
|
||||||
<div class="combat-stats">
|
|
||||||
<div class="combat-stat">
|
|
||||||
<span>{{ $t('campaigns.character-sheet.armor-class') }}</span>
|
|
||||||
<input v-if="editing" v-model.number="form.armorClass" type="number" min="0">
|
|
||||||
<strong v-else>{{ form.armorClass }}</strong>
|
|
||||||
</div>
|
|
||||||
<div class="combat-stat">
|
|
||||||
<span>{{ $t('campaigns.character-sheet.speed') }}</span>
|
|
||||||
<label v-if="editing" class="number-with-unit"><input v-model.number="form.speed" type="number" min="0"><small>ft</small></label>
|
|
||||||
<strong v-else>{{ form.speed }} <small>ft</small></strong>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
<h3>{{ $t('campaigns.character-sheet.proficiencies') }}</h3>
|
</div>
|
||||||
<textarea v-if="editing" v-model="form.proficiencies" rows="5" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" />
|
|
||||||
<p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
|
|
||||||
<main v-show="activeTab === 'inventory'" class="sheet-tab-body">
|
<div class="vital-bar hit-points-bar">
|
||||||
<section class="sheet-panel inventory-panel">
|
<div class="vital-bar-head">
|
||||||
<div class="panel-title-row">
|
<span>{{ $t('campaigns.character-sheet.hit-points') }}</span>
|
||||||
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
|
<strong v-if="!editing">{{ form.hitPoints.current }} / {{ form.hitPoints.max }}</strong>
|
||||||
<button v-if="editing" class="sheet-button secondary compact" type="button" @click="addInventoryItem">{{ $t('campaigns.character-sheet.add-item') }}</button>
|
<label v-else class="vital-bar-inputs">
|
||||||
|
<input v-model.number="form.hitPoints.current" type="number" min="0" :aria-label="$t('campaigns.character-sheet.hit-points')">
|
||||||
|
<span>/</span>
|
||||||
|
<input v-model.number="form.hitPoints.max" type="number" min="0" :aria-label="$t('campaigns.character-sheet.max-hit-points')">
|
||||||
|
</label>
|
||||||
</div>
|
</div>
|
||||||
<div class="weight-summary">
|
<div class="vital-bar-track"><div class="vital-bar-fill" :style="{ width: `${hitPointsPercent}%` }" /></div>
|
||||||
<span>{{ $t('campaigns.character-sheet.carried-weight') }}</span>
|
</div>
|
||||||
<strong>{{ carriedWeight.toFixed(1) }} / {{ carryingCapacity }} lb</strong>
|
|
||||||
</div>
|
|
||||||
<div class="weight-track"><div class="weight-fill" :style="{ width: `${carryPercent}%` }" /></div>
|
|
||||||
<div class="inventory-table-wrap">
|
|
||||||
<table class="inventory-table">
|
|
||||||
<thead><tr>
|
|
||||||
<th>{{ $t('campaigns.character-sheet.item-name') }}</th>
|
|
||||||
<th>{{ $t('campaigns.character-sheet.quantity') }}</th>
|
|
||||||
<th>{{ $t('campaigns.character-sheet.weight-each') }}</th>
|
|
||||||
<th>{{ $t('campaigns.character-sheet.total-weight') }}</th>
|
|
||||||
<th v-if="editing"><span class="sr-only">{{ $t('campaigns.character-sheet.actions') }}</span></th>
|
|
||||||
</tr></thead>
|
|
||||||
<tbody>
|
|
||||||
<tr v-for="(item, index) in form.inventory" :key="index">
|
|
||||||
<td><input v-if="editing" v-model="item.name" :aria-label="$t('campaigns.character-sheet.item-name')"><span v-else>{{ item.name }}</span></td>
|
|
||||||
<td><input v-if="editing" v-model.number="item.quantity" type="number" min="1" :aria-label="$t('campaigns.character-sheet.quantity')"><span v-else>{{ item.quantity }}</span></td>
|
|
||||||
<td><input v-if="editing" v-model.number="item.weight" type="number" min="0" step="0.1" :aria-label="$t('campaigns.character-sheet.weight-each')"><span v-else>{{ Number(item.weight).toFixed(1) }} lb</span></td>
|
|
||||||
<td>{{ ((Number(item.quantity) || 0) * (Number(item.weight) || 0)).toFixed(1) }} lb</td>
|
|
||||||
<td v-if="editing"><button class="remove-item" type="button" @click="removeInventoryItem(index)">×</button></td>
|
|
||||||
</tr>
|
|
||||||
<tr v-if="form.inventory.length === 0"><td :colspan="editing ? 5 : 4" class="empty-inventory">{{ $t('campaigns.character-sheet.empty-inventory') }}</td></tr>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
|
|
||||||
<main v-show="activeTab === 'traits'" class="sheet-tab-body">
|
<div class="vital-bar hit-dice-bar">
|
||||||
<section class="sheet-panel traits-panel">
|
<div class="vital-bar-head">
|
||||||
<h2>{{ $t('campaigns.character-sheet.traits') }}</h2>
|
<span>{{ $t('campaigns.character-sheet.hit-dice') }}</span>
|
||||||
<textarea v-if="editing" v-model="form.traits" rows="12" :placeholder="$t('campaigns.character-sheet.traits-placeholder')" />
|
<strong v-if="!editing">{{ form.hitDice.current }} / {{ form.hitDice.max }}</strong>
|
||||||
<p v-else class="sheet-copy">{{ form.traits || $t('campaigns.character-sheet.empty-traits') }}</p>
|
<label v-else class="vital-bar-inputs">
|
||||||
</section>
|
<input v-model.number="form.hitDice.current" type="number" min="0" :aria-label="$t('campaigns.character-sheet.hit-dice')">
|
||||||
</main>
|
<span>/</span>
|
||||||
|
<input v-model.number="form.hitDice.max" type="number" min="0" :aria-label="$t('campaigns.character-sheet.max-hit-dice')">
|
||||||
<main v-show="activeTab === 'spells'" class="sheet-tab-body">
|
</label>
|
||||||
<section class="sheet-panel spells-panel">
|
</div>
|
||||||
<h2>{{ $t('campaigns.character-sheet.spells') }}</h2>
|
<div class="vital-bar-track"><div class="vital-bar-fill" :style="{ width: `${hitDicePercent}%` }" /></div>
|
||||||
<textarea v-if="editing" v-model="form.spells" rows="12" :placeholder="$t('campaigns.character-sheet.spells-placeholder')" />
|
</div>
|
||||||
<p v-else class="sheet-copy">{{ form.spells || $t('campaigns.character-sheet.empty-spells') }}</p>
|
</section>
|
||||||
</section>
|
|
||||||
</main>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<nav class="sheet-tabs" role="tablist" aria-orientation="vertical">
|
<main v-show="activeTab === 'abilities'" class="sheet-tab-body">
|
||||||
<button
|
<section class="sheet-panel abilities-panel">
|
||||||
v-for="tab in tabs"
|
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
|
||||||
:key="tab.key"
|
<div class="ability-grid">
|
||||||
class="sheet-tab"
|
<div v-for="stat in abilityStats" :key="stat.key" class="ability-card">
|
||||||
:class="{ active: activeTab === tab.key }"
|
<span class="ability-label">{{ stat.label }}</span>
|
||||||
type="button"
|
<input v-if="editing" v-model.number="form.abilityScores[stat.key]" type="number" min="1" max="30" :aria-label="stat.label">
|
||||||
role="tab"
|
<strong v-else class="ability-score">{{ form.abilityScores[stat.key] }}</strong>
|
||||||
:aria-selected="activeTab === tab.key"
|
<span class="ability-modifier">{{ abilityModifier(form.abilityScores[stat.key]) }}</span>
|
||||||
@click="activeTab = tab.key"
|
</div>
|
||||||
>{{ $t(tab.label) }}</button>
|
</div>
|
||||||
</nav>
|
|
||||||
|
<!-- Les tirades de salvació van just a sota de les característiques, que
|
||||||
|
són les que les manen: el cercle diu si el personatge hi està entrenat. -->
|
||||||
|
<h3>{{ $t('campaigns.character-sheet.saving-throws') }}</h3>
|
||||||
|
<div class="saving-throw-grid">
|
||||||
|
<button
|
||||||
|
v-for="stat in abilityStats"
|
||||||
|
:key="stat.key"
|
||||||
|
class="proficiency-row"
|
||||||
|
type="button"
|
||||||
|
role="switch"
|
||||||
|
:aria-checked="form.savingThrows[stat.key]"
|
||||||
|
:disabled="!editing"
|
||||||
|
@click="toggleProficiency('savingThrows', stat.key)"
|
||||||
|
>
|
||||||
|
<span class="proficiency-dot" :class="{ proficient: form.savingThrows[stat.key] }" aria-hidden="true" />
|
||||||
|
<span class="proficiency-name">{{ $t(`campaigns.character-sheet.abilities.${stat.key}`) }}</span>
|
||||||
|
<span class="proficiency-modifier">{{ savingThrowModifier(stat) }}</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="sheet-panel skills-panel">
|
||||||
|
<h2>{{ $t('campaigns.character-sheet.skills') }}</h2>
|
||||||
|
<div class="skill-grid">
|
||||||
|
<button
|
||||||
|
v-for="skill in skillList"
|
||||||
|
:key="skill.key"
|
||||||
|
class="proficiency-row"
|
||||||
|
type="button"
|
||||||
|
role="switch"
|
||||||
|
:aria-checked="form.skills[skill.key]"
|
||||||
|
:disabled="!editing"
|
||||||
|
@click="toggleProficiency('skills', skill.key)"
|
||||||
|
>
|
||||||
|
<span class="proficiency-dot" :class="{ proficient: form.skills[skill.key] }" aria-hidden="true" />
|
||||||
|
<span class="proficiency-name">{{ $t(`campaigns.character-sheet.skill-names.${skill.key}`) }}</span>
|
||||||
|
<span class="proficiency-ability">{{ skill.ability.toUpperCase() }}</span>
|
||||||
|
<span class="proficiency-modifier">{{ skillModifier(skill) }}</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section class="sheet-panel proficiencies-panel">
|
||||||
|
<h2>{{ $t('campaigns.character-sheet.proficiencies') }}</h2>
|
||||||
|
<textarea v-if="editing" v-model="form.proficiencies" rows="7" :placeholder="$t('campaigns.character-sheet.proficiencies-placeholder')" />
|
||||||
|
<p v-else class="sheet-copy">{{ form.proficiencies || $t('campaigns.character-sheet.empty-proficiencies') }}</p>
|
||||||
|
|
||||||
|
<!-- Les eines i els idiomes tenen llista pròpia; el text de dalt guarda
|
||||||
|
el que no en té, com les armadures i les armes. -->
|
||||||
|
<div class="proficiency-lists">
|
||||||
|
<div class="proficiency-list">
|
||||||
|
<h3>{{ $t('campaigns.character-sheet.tools') }}</h3>
|
||||||
|
<textarea v-if="editing" v-model="form.tools" rows="4" :placeholder="$t('campaigns.character-sheet.tools-placeholder')" />
|
||||||
|
<p v-else class="sheet-copy">{{ form.tools || $t('campaigns.character-sheet.empty-tools') }}</p>
|
||||||
|
</div>
|
||||||
|
<div class="proficiency-list">
|
||||||
|
<h3>{{ $t('campaigns.character-sheet.languages') }}</h3>
|
||||||
|
<textarea v-if="editing" v-model="form.languages" rows="4" :placeholder="$t('campaigns.character-sheet.languages-placeholder')" />
|
||||||
|
<p v-else class="sheet-copy">{{ form.languages || $t('campaigns.character-sheet.empty-languages') }}</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<main v-show="activeTab === 'inventory'" class="sheet-tab-body">
|
||||||
|
<section class="sheet-panel inventory-panel">
|
||||||
|
<div class="panel-title-row">
|
||||||
|
<h2>{{ $t('campaigns.character-sheet.inventory') }}</h2>
|
||||||
|
<button v-if="editing" class="sheet-button secondary compact" type="button" @click="addInventoryItem">{{ $t('campaigns.character-sheet.add-item') }}</button>
|
||||||
|
</div>
|
||||||
|
<div class="weight-summary">
|
||||||
|
<span>{{ $t('campaigns.character-sheet.carried-weight') }}</span>
|
||||||
|
<strong>{{ carriedWeight.toFixed(1) }} / {{ carryingCapacity }} lb</strong>
|
||||||
|
</div>
|
||||||
|
<div class="weight-track"><div class="weight-fill" :style="{ width: `${carryPercent}%` }" /></div>
|
||||||
|
|
||||||
|
<!-- La moneda que el personatge porta a sobre, en les cinc monedes del joc. -->
|
||||||
|
<h3>{{ $t('campaigns.character-sheet.currency') }}</h3>
|
||||||
|
<div class="currency-row">
|
||||||
|
<label v-for="unit in currencyUnits" :key="unit" class="currency-field">
|
||||||
|
<span>{{ $t(`campaigns.character-sheet.currency-units.${unit}`) }}</span>
|
||||||
|
<input v-if="editing" v-model.number="form.currency[unit]" type="number" min="0" :aria-label="$t(`campaigns.character-sheet.currency-units.${unit}`)">
|
||||||
|
<strong v-else>{{ form.currency[unit] }}</strong>
|
||||||
|
</label>
|
||||||
|
</div>
|
||||||
|
<div class="inventory-table-wrap">
|
||||||
|
<table class="inventory-table">
|
||||||
|
<thead><tr>
|
||||||
|
<th><span class="sr-only">{{ $t('campaigns.character-sheet.item-icon') }}</span></th>
|
||||||
|
<th class="item-name-cell">{{ $t('campaigns.character-sheet.item-name') }}</th>
|
||||||
|
<th>{{ $t('campaigns.character-sheet.quantity') }}</th>
|
||||||
|
<th>{{ $t('campaigns.character-sheet.weight-each') }}</th>
|
||||||
|
<th>{{ $t('campaigns.character-sheet.total-weight') }}</th>
|
||||||
|
<th v-if="editing"><span class="sr-only">{{ $t('campaigns.character-sheet.actions') }}</span></th>
|
||||||
|
</tr></thead>
|
||||||
|
<tbody>
|
||||||
|
<tr v-for="(item, index) in form.inventory" :key="index">
|
||||||
|
<td class="item-icon-cell">
|
||||||
|
<img v-if="item.icon" :src="resolveImage(item.icon)" :alt="$t('campaigns.character-sheet.item-icon')">
|
||||||
|
<span v-else class="item-icon-blank" aria-hidden="true" />
|
||||||
|
</td>
|
||||||
|
<td class="item-name-cell"><input v-if="editing" v-model="item.name" :aria-label="$t('campaigns.character-sheet.item-name')"><span v-else>{{ item.name }}</span></td>
|
||||||
|
<td><input v-if="editing" v-model.number="item.quantity" type="number" min="1" :aria-label="$t('campaigns.character-sheet.quantity')"><span v-else>{{ item.quantity }}</span></td>
|
||||||
|
<td><input v-if="editing" v-model.number="item.weight" type="number" min="0" step="0.1" :aria-label="$t('campaigns.character-sheet.weight-each')"><span v-else>{{ Number(item.weight).toFixed(1) }} lb</span></td>
|
||||||
|
<td>{{ ((Number(item.quantity) || 0) * (Number(item.weight) || 0)).toFixed(1) }} lb</td>
|
||||||
|
<td v-if="editing"><button class="remove-item" type="button" @click="removeInventoryItem(index)">×</button></td>
|
||||||
|
</tr>
|
||||||
|
<tr v-if="form.inventory.length === 0"><td :colspan="editing ? 6 : 5" class="empty-inventory">{{ $t('campaigns.character-sheet.empty-inventory') }}</td></tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<main v-show="activeTab === 'traits'" class="sheet-tab-body">
|
||||||
|
<section class="sheet-panel traits-panel">
|
||||||
|
<h2>{{ $t('campaigns.character-sheet.traits') }}</h2>
|
||||||
|
<textarea v-if="editing" v-model="form.traits" rows="12" :placeholder="$t('campaigns.character-sheet.traits-placeholder')" />
|
||||||
|
<p v-else class="sheet-copy">{{ form.traits || $t('campaigns.character-sheet.empty-traits') }}</p>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
|
|
||||||
|
<main v-show="activeTab === 'spells'" class="sheet-tab-body">
|
||||||
|
<section class="sheet-panel spells-panel">
|
||||||
|
<h2>{{ $t('campaigns.character-sheet.spells') }}</h2>
|
||||||
|
<textarea v-if="editing" v-model="form.spells" rows="12" :placeholder="$t('campaigns.character-sheet.spells-placeholder')" />
|
||||||
|
<p v-else class="sheet-copy">{{ form.spells || $t('campaigns.character-sheet.empty-spells') }}</p>
|
||||||
|
</section>
|
||||||
|
</main>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -358,16 +555,18 @@ async function saveSheet() {
|
|||||||
.sheet-button.primary { background: var(--color-link); color: var(--color-background); border-color: var(--color-link); }
|
.sheet-button.primary { background: var(--color-link); color: var(--color-background); border-color: var(--color-link); }
|
||||||
.sheet-button:disabled { opacity: .55; cursor: wait; }
|
.sheet-button:disabled { opacity: .55; cursor: wait; }
|
||||||
.sheet-button.compact { padding: 5px 9px; font-size: 12px; }
|
.sheet-button.compact { padding: 5px 9px; font-size: 12px; }
|
||||||
.sheet-grid { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr) minmax(0, 1fr); grid-template-rows: auto auto; gap: 11px; align-items: start; }
|
/* El marc de la fitxa: la columna del personatge, sempre a la vista, i al seu costat el contingent
|
||||||
.sheet-layout { display: flex; align-items: flex-start; gap: 10px; }
|
de la pestanya oberta. */
|
||||||
.sheet-content { flex: 1 1 auto; min-width: 0; }
|
.sheet-layout { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr); gap: 11px; align-items: start; }
|
||||||
.sheet-tab-body { display: block; }
|
.sheet-tab-body { grid-column: 2; grid-row: 1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
||||||
.sheet-tabs { flex: 0 0 auto; display: flex; flex-direction: column; gap: 6px; position: sticky; top: 0; align-self: flex-start; }
|
/* Pestilletes del marc: arrencen del cantó dret de la finestra, per fora del cos, i queden
|
||||||
|
fora del contingent que desfila. Per sota de 760px no hi ha lloc fora (vegeu a sota). */
|
||||||
|
.sheet-tabs { position: absolute; left: 100%; top: 34px; display: flex; flex-direction: column; align-items: flex-start; gap: 5px; padding-top: 6px; }
|
||||||
.sheet-tab {
|
.sheet-tab {
|
||||||
text-align: left;
|
text-align: left;
|
||||||
padding: 9px 14px 9px 11px;
|
padding: 9px 14px 9px 11px;
|
||||||
border: 1px solid var(--color-border);
|
border: 1px solid var(--color-border);
|
||||||
border-left-width: 3px;
|
border-left: 0;
|
||||||
border-radius: 0 9px 9px 0;
|
border-radius: 0 9px 9px 0;
|
||||||
background: var(--color-background-soft);
|
background: var(--color-background-soft);
|
||||||
color: var(--color-text);
|
color: var(--color-text);
|
||||||
@@ -378,11 +577,11 @@ async function saveSheet() {
|
|||||||
transition: background .15s ease, border-color .15s ease, color .15s ease;
|
transition: background .15s ease, border-color .15s ease, color .15s ease;
|
||||||
}
|
}
|
||||||
.sheet-tab:hover { background: var(--color-button-hover); }
|
.sheet-tab:hover { background: var(--color-button-hover); }
|
||||||
.sheet-tab.active { background: var(--color-background-light); color: var(--color-link); border-left-color: var(--color-link); box-shadow: 0 3px 12px var(--color-window-shadow); }
|
.sheet-tab.active { background: var(--color-background-light); color: var(--color-link); border-color: var(--color-link); box-shadow: 0 3px 12px var(--color-window-shadow); }
|
||||||
.sheet-panel { min-width: 0; padding: 13px; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-light); box-shadow: 0 3px 12px var(--color-window-shadow); }
|
.sheet-panel { min-width: 0; padding: 13px; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-light); box-shadow: 0 3px 12px var(--color-window-shadow); }
|
||||||
.sheet-panel h2 { margin: 0 0 12px; padding-bottom: 7px; border-bottom: 1px solid var(--color-border); font: 17px MrEavesRemake; letter-spacing: .03em; }
|
.sheet-panel h2 { margin: 0 0 12px; padding-bottom: 7px; border-bottom: 1px solid var(--color-border); font: 17px MrEavesRemake; letter-spacing: .03em; }
|
||||||
.sheet-panel h3 { margin: 13px 0 7px; font: 14px MrEavesRemake; }
|
.sheet-panel h3 { margin: 13px 0 7px; font: 14px MrEavesRemake; }
|
||||||
.sheet-portrait { grid-column: 1; grid-row: 1 / -1; position: relative; overflow: hidden; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-soft); }
|
.sheet-portrait { position: relative; overflow: hidden; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-soft); }
|
||||||
.sheet-portrait.empty { display: grid; place-items: center; min-height: 220px; border-style: dashed; }
|
.sheet-portrait.empty { display: grid; place-items: center; min-height: 220px; border-style: dashed; }
|
||||||
.sheet-portrait img { display: block; width: 100%; height: auto; }
|
.sheet-portrait img { display: block; width: 100%; height: auto; }
|
||||||
.portrait-upload { border: 0; padding: 8px 10px; background: transparent; color: var(--color-link); font-size: 12px; cursor: pointer; }
|
.portrait-upload { border: 0; padding: 8px 10px; background: transparent; color: var(--color-link); font-size: 12px; cursor: pointer; }
|
||||||
@@ -392,21 +591,46 @@ async function saveSheet() {
|
|||||||
.portrait-controls button:hover { background: var(--color-button-hover); }
|
.portrait-controls button:hover { background: var(--color-button-hover); }
|
||||||
.portrait-controls button:disabled { opacity: .55; cursor: wait; }
|
.portrait-controls button:disabled { opacity: .55; cursor: wait; }
|
||||||
.photo-input { display: none; }
|
.photo-input { display: none; }
|
||||||
.abilities-panel { grid-column: 2 / -1; grid-row: 1; }
|
/* La columna de la fitxa: la imatge dalt i, just a sota, el que es consulta d'anada i
|
||||||
.combat-panel { grid-column: 2 / -1; grid-row: 2; }
|
tornada — classe d'armadura, velocitat, bonificadors i les barres de cops. No penja de
|
||||||
|
cap pestanya: es queda al seu lloc mentre se'n canvia. */
|
||||||
|
.character-column { grid-column: 1; grid-row: 1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
||||||
.ability-grid { display: grid; grid-template-columns: repeat(6, minmax(0, 1fr)); gap: 7px; }
|
.ability-grid { display: grid; grid-template-columns: repeat(6, minmax(0, 1fr)); gap: 7px; }
|
||||||
.ability-card { min-height: 83px; padding: 8px 5px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 3px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
.ability-card { min-height: 83px; padding: 8px 5px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 3px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
||||||
.ability-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; }
|
.ability-label { font-size: 11px; font-weight: 700; letter-spacing: .08em; opacity: .75; }
|
||||||
.ability-score { font: 25px MrEavesRemake; }
|
.ability-score { font: 25px MrEavesRemake; }
|
||||||
.ability-modifier { min-width: 33px; text-align: center; padding: 2px 5px; border-radius: 999px; background: var(--color-background); font-size: 12px; }
|
.ability-modifier { min-width: 33px; text-align: center; padding: 2px 5px; border-radius: 999px; background: var(--color-background); font-size: 12px; }
|
||||||
.ability-card input { width: 55px; text-align: center; font-size: 21px; }
|
.ability-card input { width: 55px; text-align: center; font-size: 21px; }
|
||||||
.proficiency-badge { display: flex; justify-content: space-between; align-items: center; margin-top: 9px; padding: 8px; border-radius: 8px; background: var(--color-background-soft); font-size: 12px; }
|
/* Les habilitats i les tirades de salvació: el cercle diu si el personatge hi està
|
||||||
.proficiency-badge strong { font-size: 15px; color: var(--color-link); }
|
entrenat, al costat la característica que mana i la modificadora que tira. */
|
||||||
.combat-stats { display: grid; grid-template-columns: 1fr 1fr; gap: 8px; }
|
.saving-throw-grid { display: grid; grid-template-columns: repeat(3, minmax(0, 1fr)); gap: 5px; }
|
||||||
.combat-stat { min-height: 72px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 5px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
.skill-grid { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 5px; }
|
||||||
.combat-stat > span { font-size: 11px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
|
.proficiency-row { display: flex; align-items: center; gap: 6px; min-width: 0; padding: 5px 7px; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); color: var(--color-text); font: inherit; font-size: 12px; text-align: left; cursor: pointer; }
|
||||||
.combat-stat > strong { font: 25px MrEavesRemake; }
|
.proficiency-row:hover:not(:disabled) { border-color: var(--color-link); }
|
||||||
.combat-stat small { font-size: 11px; opacity: .7; }
|
.proficiency-row:disabled { cursor: default; }
|
||||||
|
.proficiency-dot { width: 14px; height: 14px; flex: 0 0 14px; border: 2px solid var(--color-border); border-radius: 50%; }
|
||||||
|
.proficiency-dot.proficient { border-color: var(--color-link); background: var(--color-link); box-shadow: inset 0 0 0 2px var(--color-background-soft); }
|
||||||
|
.proficiency-name { flex: 1; min-width: 0; overflow-wrap: anywhere; }
|
||||||
|
.proficiency-ability { font-size: 10px; letter-spacing: .06em; opacity: .6; }
|
||||||
|
.proficiency-modifier { font-size: 11px; opacity: .8; }
|
||||||
|
.proficiency-lists { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); gap: 11px; }
|
||||||
|
.vitals-panel { display: flex; flex-direction: column; gap: 11px; }
|
||||||
|
.vital-stats { display: grid; grid-template-columns: 1fr 1fr; gap: 7px; }
|
||||||
|
.vital-stat { min-height: 68px; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 4px; padding: 6px 4px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); text-align: center; }
|
||||||
|
.vital-stat > span { font-size: 10px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
|
||||||
|
.vital-stat > strong { font: 25px MrEavesRemake; }
|
||||||
|
.vital-stat small { font-size: 11px; opacity: .7; }
|
||||||
|
.vital-stat input { width: 57px; text-align: center; }
|
||||||
|
/* Les dues barres: punts de cop i daus de cop, plenes fins on arriben. */
|
||||||
|
.vital-bar-head { display: flex; justify-content: space-between; align-items: center; gap: 8px; }
|
||||||
|
.vital-bar-head > span { font-size: 10px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
|
||||||
|
.vital-bar-head > strong { font: 15px MrEavesRemake; white-space: nowrap; }
|
||||||
|
.vital-bar-inputs { display: flex; align-items: center; gap: 4px; }
|
||||||
|
.vital-bar-inputs input { width: 52px; text-align: center; }
|
||||||
|
.vital-bar-track { height: 8px; margin-top: 5px; overflow: hidden; border-radius: 999px; background: var(--color-background); }
|
||||||
|
.vital-bar-fill { height: 100%; border-radius: inherit; transition: width .2s ease; }
|
||||||
|
.hit-points-bar .vital-bar-fill { background: var(--color-red); }
|
||||||
|
.hit-dice-bar .vital-bar-fill { background: var(--color-link); }
|
||||||
.number-with-unit { display: flex; align-items: center; gap: 4px; }
|
.number-with-unit { display: flex; align-items: center; gap: 4px; }
|
||||||
.number-with-unit input { width: 57px; }
|
.number-with-unit input { width: 57px; }
|
||||||
.sheet-copy { min-height: 74px; margin: 0; white-space: pre-wrap; overflow-wrap: anywhere; font-size: 13px; line-height: 1.45; opacity: .85; }
|
.sheet-copy { min-height: 74px; margin: 0; white-space: pre-wrap; overflow-wrap: anywhere; font-size: 13px; line-height: 1.45; opacity: .85; }
|
||||||
@@ -421,29 +645,42 @@ textarea { resize: vertical; width: 100%; min-height: 88px; font-size: 12px; }
|
|||||||
.weight-track { height: 5px; margin-bottom: 10px; overflow: hidden; border-radius: 999px; background: var(--color-background-soft); }
|
.weight-track { height: 5px; margin-bottom: 10px; overflow: hidden; border-radius: 999px; background: var(--color-background-soft); }
|
||||||
.weight-fill { height: 100%; border-radius: inherit; background: var(--color-link); transition: width .2s ease; }
|
.weight-fill { height: 100%; border-radius: inherit; background: var(--color-link); transition: width .2s ease; }
|
||||||
.inventory-table-wrap { overflow-x: auto; }
|
.inventory-table-wrap { overflow-x: auto; }
|
||||||
|
/* La moneda que el personatge porta a sobre, en les cinc del joc. */
|
||||||
|
.currency-row { display: grid; grid-template-columns: repeat(5, minmax(0, 1fr)); gap: 7px; margin-bottom: 11px; }
|
||||||
|
.currency-field { display: flex; flex-direction: column; align-items: center; gap: 3px; padding: 6px 4px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); text-align: center; }
|
||||||
|
.currency-field > span { font-size: 10px; letter-spacing: .05em; opacity: .72; }
|
||||||
|
.currency-field > strong { font: 15px MrEavesRemake; }
|
||||||
|
.currency-field input { width: 58px; text-align: center; }
|
||||||
.inventory-table { width: 100%; border-collapse: collapse; font-size: 12px; }
|
.inventory-table { width: 100%; border-collapse: collapse; font-size: 12px; }
|
||||||
.inventory-table th { padding: 6px 7px; text-align: left; font-weight: 600; opacity: .7; }
|
.inventory-table th { padding: 6px 7px; text-align: left; font-weight: 600; opacity: .7; }
|
||||||
.inventory-table td { padding: 5px 7px; border-top: 1px solid var(--color-border); }
|
.inventory-table td { padding: 5px 7px; border-top: 1px solid var(--color-border); }
|
||||||
.inventory-table td input { width: 100%; min-width: 54px; }
|
.inventory-table td input { width: 100%; min-width: 54px; }
|
||||||
.inventory-table td:first-child input { min-width: 100px; }
|
.inventory-table td.item-name-cell input { min-width: 100px; }
|
||||||
.inventory-table th:not(:first-child), .inventory-table td:not(:first-child) { text-align: center; }
|
/* La icona de cada objecte obre la filera; el nom continua alineat a l'esquerra i la
|
||||||
|
quantitat i els pesos van al centre. */
|
||||||
|
.inventory-table .item-icon-cell { width: 40px; padding-right: 0; }
|
||||||
|
.item-icon-cell img { display: block; width: 26px; height: 26px; object-fit: contain; border-radius: 5px; }
|
||||||
|
.item-icon-blank { display: block; width: 26px; height: 26px; border: 1px dashed var(--color-border); border-radius: 5px; opacity: .35; }
|
||||||
|
.inventory-table th:not(:first-child):not(.item-name-cell), .inventory-table td:not(:first-child):not(.item-name-cell) { text-align: center; }
|
||||||
.empty-inventory { text-align: center !important; opacity: .65; }
|
.empty-inventory { text-align: center !important; opacity: .65; }
|
||||||
.remove-item { width: 24px; height: 24px; border: 0; border-radius: 5px; background: transparent; color: var(--color-text); font-size: 20px; cursor: pointer; }
|
.remove-item { width: 24px; height: 24px; border: 0; border-radius: 5px; background: transparent; color: var(--color-text); font-size: 20px; cursor: pointer; }
|
||||||
.remove-item:hover { background: var(--color-button-hover); }
|
.remove-item:hover { background: var(--color-button-hover); }
|
||||||
.sheet-error { padding: 7px 10px; margin-bottom: 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
.sheet-error { padding: 7px 10px; margin-bottom: 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
||||||
.sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0; }
|
.sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); white-space: nowrap; border: 0; }
|
||||||
@media (max-width: 760px) {
|
@media (max-width: 760px) {
|
||||||
.sheet-grid { grid-template-columns: 1fr; grid-template-rows: none; }
|
.sheet-layout { grid-template-columns: 1fr; }
|
||||||
.sheet-portrait, .abilities-panel, .combat-panel { grid-column: 1 / -1; grid-row: auto; }
|
.character-column, .sheet-tab-body { grid-column: 1 / -1; grid-row: auto; }
|
||||||
|
/* El cantó dret no dona prou per penjar-hi les pestanyes: llavors es queden al marc, per
|
||||||
|
dins, en una filera sota la barra de la finestra. */
|
||||||
|
.sheet-tabs { position: static; align-self: stretch; flex-direction: row; flex-wrap: wrap; gap: 4px; padding: 6px 8px 0; }
|
||||||
|
.sheet-tab { flex: 1 1 auto; text-align: center; border-left: 1px solid var(--color-border); border-radius: 8px 8px 0 0; }
|
||||||
}
|
}
|
||||||
@media (max-width: 520px) {
|
@media (max-width: 520px) {
|
||||||
.sheet-body { padding: 10px; }
|
.sheet-body { padding: 10px; }
|
||||||
.sheet-hero { align-items: flex-start; flex-wrap: wrap; }
|
.sheet-hero { align-items: flex-start; flex-wrap: wrap; }
|
||||||
.sheet-actions { margin-left: auto; }
|
.sheet-actions { margin-left: auto; }
|
||||||
.ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
.ability-grid { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
||||||
.sheet-layout { flex-direction: column; }
|
.skill-grid, .saving-throw-grid, .proficiency-lists { grid-template-columns: 1fr; }
|
||||||
.sheet-tabs { flex-direction: row; flex-wrap: wrap; order: -1; }
|
.currency-row { grid-template-columns: repeat(3, minmax(0, 1fr)); }
|
||||||
.sheet-tab { flex: 1 1 auto; text-align: center; border-radius: 7px; border-left-width: 1px; border-top-width: 3px; }
|
|
||||||
.sheet-tab.active { border-left-color: var(--color-border); border-top-color: var(--color-link); }
|
|
||||||
}
|
}
|
||||||
</style>
|
</style>
|
||||||
|
|||||||
@@ -20,13 +20,13 @@ function initialForm() {
|
|||||||
if (!editing) {
|
if (!editing) {
|
||||||
return {
|
return {
|
||||||
name: '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
name: '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
||||||
category: 'adventuring-gear', rarity: 'common', quantity: 1, weight: '', properties: '', description: ''
|
category: 'adventuring-gear', rarity: 'common', weight: '', properties: '', description: ''
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
return {
|
return {
|
||||||
name: editing.name ?? '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
name: editing.name ?? '', type: 'character', species: '', className: '', level: '', background: '', challengeRating: '',
|
||||||
category: editing.category ?? 'adventuring-gear', rarity: editing.rarity ?? 'common',
|
category: editing.category ?? 'adventuring-gear', rarity: editing.rarity ?? 'common',
|
||||||
quantity: editing.quantity ?? 1, weight: editing.weight ?? '', properties: editing.properties ?? '',
|
weight: editing.weight ?? '', properties: editing.properties ?? '',
|
||||||
description: editing.description ?? ''
|
description: editing.description ?? ''
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
@@ -49,7 +49,7 @@ async function saveEntry() {
|
|||||||
? { name: form.value.name.trim(), campaign: data.campaign }
|
? { name: form.value.name.trim(), campaign: data.campaign }
|
||||||
: { name: form.value.name.trim(), ...(editing ? { id: editing._id } : { campaign: data.campaign }) };
|
: { name: form.value.name.trim(), ...(editing ? { id: editing._id } : { campaign: data.campaign }) };
|
||||||
if (!isActor) {
|
if (!isActor) {
|
||||||
for (const field of ['category', 'rarity', 'quantity', 'weight', 'properties', 'description']) {
|
for (const field of ['category', 'rarity', 'weight', 'properties', 'description']) {
|
||||||
payload[field] = form.value[field];
|
payload[field] = form.value[field];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -105,10 +105,6 @@ async function saveEntry() {
|
|||||||
<option value="artifact">{{ $t('campaigns.item.rarities.artifact') }}</option>
|
<option value="artifact">{{ $t('campaigns.item.rarities.artifact') }}</option>
|
||||||
</select>
|
</select>
|
||||||
</label>
|
</label>
|
||||||
<label class="form-field">
|
|
||||||
<span>{{ $t('campaigns.item.quantity') }}</span>
|
|
||||||
<input v-model.number="form.quantity" type="number" min="1" required>
|
|
||||||
</label>
|
|
||||||
<label class="form-field">
|
<label class="form-field">
|
||||||
<span>{{ $t('campaigns.item.weight') }}</span>
|
<span>{{ $t('campaigns.item.weight') }}</span>
|
||||||
<input v-model="form.weight" type="number" min="0" step="0.1">
|
<input v-model="form.weight" type="number" min="0" step="0.1">
|
||||||
|
|||||||
261
frontend/app/components/windows/DocumentationWindow.vue
Normal file
261
frontend/app/components/windows/DocumentationWindow.vue
Normal file
@@ -0,0 +1,261 @@
|
|||||||
|
<script setup>
|
||||||
|
import { computed, nextTick, onMounted, ref } from 'vue';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, Top, SetResizable, SetMinSize } from '@/services/Windows';
|
||||||
|
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import { GetDocsFirstSlug, GetDocsNav, GetDocsPage } from '~/services/Docs';
|
||||||
|
|
||||||
|
// La documentació dins d'una finestra: el sumari a l'esquerra i la pàgina al centre, amb el
|
||||||
|
// mateix contingut de app/content/docs que la pàgina pública de /docs (mira ~/services/Docs.js).
|
||||||
|
// El sumari no porta enlloc amb rutes sinó amb estat propi, així obrir la documentació dins
|
||||||
|
// d'una campanya no deixa les notes obertes enrere.
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const id = props.data.id;
|
||||||
|
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
const reading = ref(null);
|
||||||
|
|
||||||
|
const nav = GetDocsNav();
|
||||||
|
const slug = ref(GetDocsFirstSlug());
|
||||||
|
const page = computed(() => GetDocsPage(slug.value));
|
||||||
|
|
||||||
|
function GoTo(target) {
|
||||||
|
if (!GetDocsPage(target)) return;
|
||||||
|
slug.value = target;
|
||||||
|
// Cada pàgina es comença a dalt, com faria el navegador.
|
||||||
|
nextTick(() => { if (reading.value) reading.value.scrollTop = 0; });
|
||||||
|
}
|
||||||
|
|
||||||
|
// Els enllaços que el markdown porta a dins (`[Foundry](/docs/foundry)`) i els seus apartats
|
||||||
|
// s'han de seguir dins la finestra: sortir-ne per via d'una ruta deixaria la campanya enrere.
|
||||||
|
function OnContentClick(event) {
|
||||||
|
const link = event.target?.closest?.('a');
|
||||||
|
if (!link) return;
|
||||||
|
|
||||||
|
const href = link.getAttribute('href') || '';
|
||||||
|
|
||||||
|
// Un apartat de la pàgina: el que fila és la columna de lectura, no la pantalla.
|
||||||
|
if (href.startsWith('#')) {
|
||||||
|
if (href.length < 2) return;
|
||||||
|
const heading = reading.value?.querySelector('#' + CSS.escape(href.slice(1)));
|
||||||
|
if (!heading) return;
|
||||||
|
event.preventDefault();
|
||||||
|
heading.scrollIntoView({ block: 'start' });
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const inside = /^\/docs\/?([a-z0-9-]*)$/.exec(href);
|
||||||
|
if (inside) {
|
||||||
|
event.preventDefault();
|
||||||
|
GoTo(inside[1] || GetDocsFirstSlug());
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fora de la documentació: una pestanya nova, que la campanya no es mou d'aquí.
|
||||||
|
if (href && !href.startsWith('/')) {
|
||||||
|
event.preventDefault();
|
||||||
|
window.open(href, '_blank', 'noopener');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper);
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, {
|
||||||
|
width: Math.max(620, Math.min(1000, window.innerWidth - 24)),
|
||||||
|
height: Math.max(420, Math.min(780, window.innerHeight - 32))
|
||||||
|
});
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
SetResizable(id, true);
|
||||||
|
SetMinSize(id, { width: 620, height: 420 });
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle"></WindowHandle>
|
||||||
|
|
||||||
|
<!-- Body -->
|
||||||
|
<div class="docs-body">
|
||||||
|
<aside class="docs-contents" :aria-label="$t('docs.contents')">
|
||||||
|
<section v-for="group in nav" :key="group.key" class="docs-group">
|
||||||
|
<h2 class="docs-group-title">{{ $t(`docs.groups.${group.key}`) }}</h2>
|
||||||
|
<ul>
|
||||||
|
<li v-for="entry in group.pages" :key="entry.slug">
|
||||||
|
<button
|
||||||
|
type="button"
|
||||||
|
class="docs-nav-link sound-click"
|
||||||
|
:class="{ active: entry.slug === slug }"
|
||||||
|
v-on:click="GoTo(entry.slug)"
|
||||||
|
>{{ entry.title }}</button>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
</aside>
|
||||||
|
|
||||||
|
<div class="docs-reading" ref="reading">
|
||||||
|
<template v-if="page">
|
||||||
|
<article class="docs-article" v-on:click="OnContentClick">
|
||||||
|
<p class="docs-kicker">{{ $t(`docs.groups.${page.group}`) }}</p>
|
||||||
|
<!-- El contingut és markdown nostre, de app/content/docs -->
|
||||||
|
<div class="docs-markdown" v-html="page.html"></div>
|
||||||
|
</article>
|
||||||
|
|
||||||
|
<nav class="docs-pager">
|
||||||
|
<button
|
||||||
|
v-if="page.previous"
|
||||||
|
type="button"
|
||||||
|
class="docs-pager-link sound-click"
|
||||||
|
v-on:click="GoTo(page.previous.slug)"
|
||||||
|
>
|
||||||
|
<span class="docs-pager-label">{{ $t('docs.previous') }}</span>
|
||||||
|
<strong>{{ page.previous.title }}</strong>
|
||||||
|
</button>
|
||||||
|
<button
|
||||||
|
v-if="page.next"
|
||||||
|
type="button"
|
||||||
|
class="docs-pager-link next sound-click"
|
||||||
|
v-on:click="GoTo(page.next.slug)"
|
||||||
|
>
|
||||||
|
<span class="docs-pager-label">{{ $t('docs.next') }}</span>
|
||||||
|
<strong>{{ page.next.title }}</strong>
|
||||||
|
</button>
|
||||||
|
</nav>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<article v-else class="docs-article">
|
||||||
|
<h1>{{ $t('docs.title') }}</h1>
|
||||||
|
<p>{{ $t('docs.not-found', { page: slug }) }}</p>
|
||||||
|
</article>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
|
||||||
|
<style scoped lang="scss">
|
||||||
|
/* El sumari i la lectura són les dues columnes d'una finestra: cada una fila per la seva,
|
||||||
|
res d'una pantalla d'alçada ni de sticky, que la finestra ja és el que es mou. */
|
||||||
|
.docs-body {
|
||||||
|
display: flex;
|
||||||
|
flex: 1;
|
||||||
|
width: 100%;
|
||||||
|
min-height: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-contents {
|
||||||
|
flex: 0 0 212px;
|
||||||
|
min-width: 0;
|
||||||
|
box-sizing: border-box;
|
||||||
|
padding: 14px 10px;
|
||||||
|
border-right: 1px solid var(--color-border);
|
||||||
|
overflow-y: auto;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 16px;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-group-title {
|
||||||
|
margin: 0 0 6px 0;
|
||||||
|
font-family: 'MrEavesRemake', serif;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
font-weight: normal;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-contents ul {
|
||||||
|
margin: 0;
|
||||||
|
padding: 0;
|
||||||
|
list-style: none;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
gap: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Les pàgines del sumari són botons: una finestra no té rutes a seguir. */
|
||||||
|
.docs-nav-link {
|
||||||
|
width: 100%;
|
||||||
|
margin: 0;
|
||||||
|
padding: 6px 9px;
|
||||||
|
border: none;
|
||||||
|
border-radius: 6px;
|
||||||
|
box-shadow: none;
|
||||||
|
background-color: transparent;
|
||||||
|
font-size: 0.95rem;
|
||||||
|
line-height: 1.35;
|
||||||
|
text-align: left;
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link:hover {
|
||||||
|
background-color: var(--color-hover);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-nav-link.active {
|
||||||
|
background-color: var(--color-background-soft);
|
||||||
|
color: var(--color-link);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-reading {
|
||||||
|
flex: 1;
|
||||||
|
min-width: 0;
|
||||||
|
box-sizing: border-box;
|
||||||
|
padding: 20px 26px 40px 26px;
|
||||||
|
overflow-y: auto;
|
||||||
|
/* El que es llegeix es pot seleccionar, encara que una finestra no ho permeti per defecte. */
|
||||||
|
user-select: text;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* La columna de lectura, centrada dins l'espai que deixa el sumari. */
|
||||||
|
.docs-article,
|
||||||
|
.docs-pager {
|
||||||
|
width: 100%;
|
||||||
|
max-width: 720px;
|
||||||
|
margin-inline: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-kicker {
|
||||||
|
margin: 0 0 4px 0;
|
||||||
|
font-size: 0.8rem;
|
||||||
|
letter-spacing: 0.08em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager {
|
||||||
|
margin-top: 30px;
|
||||||
|
padding-top: 16px;
|
||||||
|
border-top: 1px solid var(--color-border);
|
||||||
|
display: flex;
|
||||||
|
gap: 14px;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Són els botons d'abans i després, no botons d'un formulari: van plans, com a /docs. */
|
||||||
|
.docs-pager-link {
|
||||||
|
flex: 1 1 0;
|
||||||
|
min-width: 0;
|
||||||
|
margin: 0;
|
||||||
|
padding: 10px 12px;
|
||||||
|
border: 1px solid var(--color-border);
|
||||||
|
border-radius: 8px;
|
||||||
|
box-shadow: none;
|
||||||
|
text-align: left;
|
||||||
|
color: var(--color-text);
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-link.next {
|
||||||
|
text-align: right;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-pager-label {
|
||||||
|
display: block;
|
||||||
|
font-size: 0.78rem;
|
||||||
|
letter-spacing: 0.06em;
|
||||||
|
text-transform: uppercase;
|
||||||
|
color: var(--color-gray);
|
||||||
|
}
|
||||||
|
</style>
|
||||||
171
frontend/app/components/windows/FoundryIconPickerWindow.vue
Normal file
171
frontend/app/components/windows/FoundryIconPickerWindow.vue
Normal file
@@ -0,0 +1,171 @@
|
|||||||
|
<script setup>
|
||||||
|
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
|
import { useI18n } from 'vue-i18n';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, SetResizable, SetMinSize } from '@/services/Windows';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import Server from '~/services/Server';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const id = props.data.id;
|
||||||
|
const itemId = props.data.item?._id;
|
||||||
|
const campaign = props.data.campaign || '';
|
||||||
|
const ICON_ROOT = 'icons';
|
||||||
|
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
const loading = ref(false);
|
||||||
|
const error = ref('');
|
||||||
|
const applying = ref('');
|
||||||
|
// What the window is standing on: one folder of Foundry's icon library at a time.
|
||||||
|
const listing = ref({ dir: ICON_ROOT, parent: null, folders: [], files: [], next: null });
|
||||||
|
const { t } = useI18n();
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper);
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, { width: 560, height: 540 });
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
SetResizable(id, true);
|
||||||
|
SetMinSize(id, { width: 420, height: 340 });
|
||||||
|
Load(ICON_ROOT);
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => ClearWindow({ type: 'foundry_icons' }));
|
||||||
|
|
||||||
|
// One request per folder, and the icons inside it a page at a time: that library
|
||||||
|
// runs into the thousands, so the window only ever asks for what it shows.
|
||||||
|
async function Load(dir, offset = 0) {
|
||||||
|
if (loading.value) return;
|
||||||
|
if (!campaign) {
|
||||||
|
error.value = t('foundry.errors.icons-no-world-url');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
loading.value = true;
|
||||||
|
error.value = '';
|
||||||
|
try {
|
||||||
|
const params = new URLSearchParams({ campaign, dir });
|
||||||
|
if (offset) params.set('offset', String(offset));
|
||||||
|
const response = await Server().get(`/foundry/icons?${params.toString()}`);
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
error.value = t(response.data.msg || 'foundry.errors.icons-unavailable');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const page = {
|
||||||
|
dir: response.data.dir || dir,
|
||||||
|
parent: response.data.parent ?? null,
|
||||||
|
folders: response.data.folders || [],
|
||||||
|
files: response.data.files || [],
|
||||||
|
next: response.data.next ?? null,
|
||||||
|
};
|
||||||
|
listing.value = offset
|
||||||
|
? { ...page, files: [...listing.value.files, ...page.files] }
|
||||||
|
: page;
|
||||||
|
} catch (requestError) {
|
||||||
|
// The route answers every real failure with an i18n key in `msg`, but
|
||||||
|
// axios rejects a non-2xx response, so this catch would otherwise blame
|
||||||
|
// the bridge for anything at all — a campaign without a world address,
|
||||||
|
// a folder that went missing. Read the reason off the response and say
|
||||||
|
// that instead (Syndria98/dragonroll#74).
|
||||||
|
error.value = t(requestError.response?.data?.msg || 'foundry.errors.icons-unavailable');
|
||||||
|
} finally {
|
||||||
|
loading.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const trail = computed(() => {
|
||||||
|
const parts = String(listing.value.dir || ICON_ROOT).split('/').filter(Boolean);
|
||||||
|
return parts.map((name, index) => ({ name, path: parts.slice(0, index + 1).join('/') }));
|
||||||
|
});
|
||||||
|
|
||||||
|
const empty = computed(() => !loading.value && !listing.value.folders.length && !listing.value.files.length);
|
||||||
|
|
||||||
|
function GoUp() {
|
||||||
|
Load(listing.value.parent || ICON_ROOT);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The icon is stored as the url the browser loads it from, the same shape a synced
|
||||||
|
// Foundry item's icon has; the item window follows the event this leaves behind.
|
||||||
|
async function Choose(icon) {
|
||||||
|
if (applying.value) return;
|
||||||
|
applying.value = icon.path;
|
||||||
|
error.value = '';
|
||||||
|
try {
|
||||||
|
const response = await Server().post('/item/update', { id: itemId, image: icon.url });
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
error.value = t('campaigns.item.sheet.save-error');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
emitter.emit('campaign-entry-updated', { entityType: 'item', entry: response.data.item });
|
||||||
|
ClearWindow({ type: 'foundry_icons' });
|
||||||
|
ClearWindow({ type: 'item_icon_source' });
|
||||||
|
} catch (requestError) {
|
||||||
|
error.value = t('campaigns.item.sheet.save-error');
|
||||||
|
} finally {
|
||||||
|
applying.value = '';
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper foundry-icons-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle" />
|
||||||
|
<div class="icons-body">
|
||||||
|
<nav class="icons-trail" :aria-label="$t('foundry.icons.path')">
|
||||||
|
<button class="trail-up" type="button" :disabled="loading || !listing.parent" :aria-label="$t('foundry.icons.up')" @click="GoUp">
|
||||||
|
<img class="icon" src="/icons/iconoir/regular/arrow-up.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<template v-for="crumb in trail" :key="crumb.path">
|
||||||
|
<span class="trail-separator" aria-hidden="true">/</span>
|
||||||
|
<button class="trail-crumb" type="button" :disabled="loading" @click="Load(crumb.path)">{{ crumb.name }}</button>
|
||||||
|
</template>
|
||||||
|
</nav>
|
||||||
|
|
||||||
|
<div v-if="error" class="icons-error">{{ error }}</div>
|
||||||
|
<p v-if="loading" class="icons-state">{{ $t('foundry.icons.loading') }}</p>
|
||||||
|
<p v-else-if="empty" class="icons-state">{{ $t('foundry.icons.empty') }}</p>
|
||||||
|
|
||||||
|
<div v-if="listing.folders.length" class="icon-tiles">
|
||||||
|
<button v-for="folder in listing.folders" :key="folder.path" class="icon-tile folder" type="button" :disabled="loading" @click="Load(folder.path)">
|
||||||
|
<img class="icon" src="/icons/iconoir/regular/folder.svg" alt="" aria-hidden="true">
|
||||||
|
<span class="tile-name">{{ folder.name }}</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div v-if="listing.files.length" class="icon-tiles">
|
||||||
|
<button v-for="icon in listing.files" :key="icon.path" class="icon-tile" type="button"
|
||||||
|
:disabled="applying !== ''" :title="icon.name" @click="Choose(icon)">
|
||||||
|
<img class="tile-image" :src="icon.url" :alt="icon.name" loading="lazy">
|
||||||
|
<span class="tile-name">{{ icon.name }}</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<button v-if="listing.next" class="icons-more sheet-button" type="button" :disabled="loading" @click="Load(listing.dir, listing.next)">
|
||||||
|
{{ $t('foundry.icons.load-more') }}
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.foundry-icons-window { min-width: 0; min-height: 0; }
|
||||||
|
.icons-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 12px 14px 16px; box-sizing: border-box; display: flex; flex-direction: column; gap: 10px; }
|
||||||
|
.icons-trail { display: flex; align-items: center; flex-wrap: wrap; gap: 4px; position: sticky; top: 0; padding-bottom: 8px; background: var(--color-window-background); font-size: 12px; }
|
||||||
|
.trail-up, .trail-crumb { display: inline-flex; align-items: center; padding: 4px 7px; border: 1px solid var(--color-border); border-radius: 6px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; font-size: 12px; }
|
||||||
|
.trail-up:hover, .trail-crumb:hover { background: var(--color-button-hover); }
|
||||||
|
.trail-up:disabled, .trail-crumb:disabled { opacity: .5; cursor: wait; }
|
||||||
|
.trail-separator { opacity: .45; }
|
||||||
|
.icons-error { padding: 7px 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
||||||
|
.icons-state { margin: 0; font-size: 12px; opacity: .7; }
|
||||||
|
.icon-tiles { display: grid; grid-template-columns: repeat(auto-fill, minmax(78px, 1fr)); gap: 8px; }
|
||||||
|
.icon-tile { display: flex; flex-direction: column; align-items: center; gap: 5px; padding: 8px 6px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; }
|
||||||
|
.icon-tile:hover { background: var(--color-button-hover); border-color: var(--color-link); }
|
||||||
|
.icon-tile:disabled { opacity: .55; cursor: wait; }
|
||||||
|
.icon-tile.folder { justify-content: center; }
|
||||||
|
.icon-tile .icon { width: 22px; height: 22px; }
|
||||||
|
.tile-image { width: 40px; height: 40px; object-fit: contain; }
|
||||||
|
.tile-name { max-width: 100%; overflow: hidden; text-overflow: ellipsis; white-space: nowrap; font-size: 10px; opacity: .75; }
|
||||||
|
.icons-more { align-self: center; border: 1px solid var(--color-border); border-radius: 7px; padding: 7px 12px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; white-space: nowrap; font-size: 13px; }
|
||||||
|
.icons-more:hover { background: var(--color-button-hover); }
|
||||||
|
.icons-more:disabled { opacity: .55; cursor: wait; }
|
||||||
|
</style>
|
||||||
128
frontend/app/components/windows/ItemIconSourceWindow.vue
Normal file
128
frontend/app/components/windows/ItemIconSourceWindow.vue
Normal file
@@ -0,0 +1,128 @@
|
|||||||
|
<script setup>
|
||||||
|
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
|
import { useI18n } from 'vue-i18n';
|
||||||
|
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateChildWindow } from '@/services/Windows';
|
||||||
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
|
import Server, { getBaseUrl } from '~/services/Server';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
|
||||||
|
const props = defineProps(['data']);
|
||||||
|
const id = props.data.id;
|
||||||
|
const item = props.data.item || {};
|
||||||
|
const itemId = item._id;
|
||||||
|
const campaign = props.data.campaign || '';
|
||||||
|
const handle = ref(null);
|
||||||
|
const wrapper = ref(null);
|
||||||
|
const error = ref('');
|
||||||
|
const uploading = ref(false);
|
||||||
|
const photoInput = ref(null);
|
||||||
|
const image = ref(item.image || '');
|
||||||
|
const { t } = useI18n();
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
Top(wrapper);
|
||||||
|
SetupHandle(id, handle);
|
||||||
|
SetSize(id, { width: 430, height: 320 });
|
||||||
|
ResetPosition(id, 'center');
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => ClearWindow({ type: 'item_icon_source' }));
|
||||||
|
|
||||||
|
// An uploaded icon is a file of the backend's uploads folder and a Foundry one an
|
||||||
|
// absolute url of the world; both are drawn the way the item window draws them.
|
||||||
|
const imageUrl = computed(() => {
|
||||||
|
if (!image.value) return '';
|
||||||
|
return /^(https?:|data:|\/\/)/i.test(image.value)
|
||||||
|
? image.value
|
||||||
|
: `${getBaseUrl()}/public/${image.value}`;
|
||||||
|
});
|
||||||
|
|
||||||
|
function pickLocalIcon() {
|
||||||
|
photoInput.value?.click();
|
||||||
|
}
|
||||||
|
|
||||||
|
// The icon browser opens on top of this window, as its child: closing the chooser
|
||||||
|
// takes the browser with it, like every other child window here.
|
||||||
|
function openFoundryIcons() {
|
||||||
|
CreateChildWindow(id, 'foundry_icons', { item: { _id: itemId, name: item.name }, campaign });
|
||||||
|
}
|
||||||
|
|
||||||
|
async function onIconSelected(event) {
|
||||||
|
const file = event.target.files?.[0];
|
||||||
|
event.target.value = '';
|
||||||
|
if (!file || uploading.value) return;
|
||||||
|
uploading.value = true;
|
||||||
|
error.value = '';
|
||||||
|
try {
|
||||||
|
const formData = new FormData();
|
||||||
|
formData.append('image', file);
|
||||||
|
const response = await Server().post(`/item/upload-image?item=${itemId}`, formData, {
|
||||||
|
headers: { "Content-Type": "multipart/form-data" }
|
||||||
|
});
|
||||||
|
if (response.data.status !== 'ok') {
|
||||||
|
error.value = t('campaigns.item.sheet.upload-error');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// The item window follows this event and shows the new icon.
|
||||||
|
emitter.emit('campaign-entry-updated', { entityType: 'item', entry: response.data.item });
|
||||||
|
ClearWindow({ id });
|
||||||
|
} catch (requestError) {
|
||||||
|
error.value = t('campaigns.item.sheet.upload-error');
|
||||||
|
} finally {
|
||||||
|
uploading.value = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="window-wrapper icon-source-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
|
<WindowHandle :window="id" ref="handle" />
|
||||||
|
<div class="source-body">
|
||||||
|
<header class="source-hero">
|
||||||
|
<div class="source-icon" :class="{ empty: !image }">
|
||||||
|
<img v-if="imageUrl" :src="imageUrl" :alt="$t('campaigns.item.sheet.icon')">
|
||||||
|
<span v-else aria-hidden="true">{{ (item.name || '?').slice(0, 1).toUpperCase() }}</span>
|
||||||
|
</div>
|
||||||
|
<p class="source-intro">{{ $t('campaigns.item.icon-picker.intro') }}</p>
|
||||||
|
</header>
|
||||||
|
|
||||||
|
<div v-if="error" class="source-error">{{ error }}</div>
|
||||||
|
|
||||||
|
<div class="source-options">
|
||||||
|
<button class="source-option" type="button" :disabled="uploading" @click="pickLocalIcon">
|
||||||
|
<img class="icon" src="/icons/iconoir/regular/cloud-upload.svg" alt="" aria-hidden="true">
|
||||||
|
<span class="source-option-title">{{ uploading
|
||||||
|
? $t('campaigns.item.sheet.uploading')
|
||||||
|
: $t('campaigns.item.icon-picker.upload') }}</span>
|
||||||
|
<span class="source-option-hint">{{ $t('campaigns.item.icon-picker.upload-hint') }}</span>
|
||||||
|
</button>
|
||||||
|
<button class="source-option" type="button" @click="openFoundryIcons">
|
||||||
|
<img class="icon" src="/icons/iconoir/regular/media-image.svg" alt="" aria-hidden="true">
|
||||||
|
<span class="source-option-title">{{ $t('campaigns.item.icon-picker.foundry') }}</span>
|
||||||
|
<span class="source-option-hint">{{ $t('campaigns.item.icon-picker.foundry-hint') }}</span>
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onIconSelected">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.icon-source-window { min-width: 0; min-height: 0; }
|
||||||
|
.source-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 14px 16px 16px; box-sizing: border-box; display: flex; flex-direction: column; gap: 12px; }
|
||||||
|
.source-hero { display: flex; align-items: center; gap: 13px; padding-bottom: 12px; border-bottom: 1px solid var(--color-border); }
|
||||||
|
.source-icon { width: 56px; height: 56px; flex: 0 0 56px; display: grid; place-items: center; overflow: hidden; border-radius: 10px; border: 1px solid var(--color-border); background: var(--color-background-soft); color: var(--color-link); font: 26px MrEavesRemake; }
|
||||||
|
.source-icon.empty { border-style: dashed; }
|
||||||
|
.source-icon img { width: 100%; height: 100%; object-fit: contain; }
|
||||||
|
.source-intro { margin: 0; font-size: 13px; opacity: .85; }
|
||||||
|
.source-error { padding: 7px 10px; border-radius: 6px; color: var(--color-red); background: var(--color-background-soft); font-size: 12px; }
|
||||||
|
.source-options { display: flex; flex-direction: column; gap: 10px; }
|
||||||
|
.source-option { display: grid; grid-template-columns: 26px 1fr; align-items: center; gap: 4px 10px; padding: 12px 14px; text-align: left; border: 1px solid var(--color-border); border-radius: 10px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; }
|
||||||
|
.source-option:hover { background: var(--color-button-hover); }
|
||||||
|
.source-option:disabled { opacity: .55; cursor: wait; }
|
||||||
|
.source-option .icon { width: 20px; height: 20px; grid-row: span 2; }
|
||||||
|
.source-option-title { font: 15px MrEavesRemake; }
|
||||||
|
.source-option-hint { font-size: 12px; opacity: .7; }
|
||||||
|
.photo-input { display: none; }
|
||||||
|
</style>
|
||||||
@@ -1,9 +1,10 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
||||||
import { useI18n } from 'vue-i18n';
|
import { useI18n } from 'vue-i18n';
|
||||||
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top } from '@/services/Windows';
|
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateChildWindow } from '@/services/Windows';
|
||||||
import WindowHandle from './partials/WindowHandle.vue';
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
import Server, { getBaseUrl } from '~/services/Server';
|
import Server, { getBaseUrl } from '~/services/Server';
|
||||||
|
import { useCampaignService } from '~/services/Campaign.js';
|
||||||
import { emitter } from '~/services/Emitter';
|
import { emitter } from '~/services/Emitter';
|
||||||
|
|
||||||
const props = defineProps(['data']);
|
const props = defineProps(['data']);
|
||||||
@@ -12,9 +13,10 @@ const itemId = props.data.item?._id;
|
|||||||
const handle = ref(null);
|
const handle = ref(null);
|
||||||
const wrapper = ref(null);
|
const wrapper = ref(null);
|
||||||
const error = ref('');
|
const error = ref('');
|
||||||
const uploadingIcon = ref(false);
|
// Set while this window writes the item's icon, so a Foundry sync landing behind
|
||||||
const applyingFoundryIcon = ref(false);
|
// the window does not rewrite the form under the change being made.
|
||||||
const photoInput = ref(null);
|
const applyingIcon = ref(false);
|
||||||
|
const { Campaign } = useCampaignService();
|
||||||
const { t } = useI18n();
|
const { t } = useI18n();
|
||||||
|
|
||||||
function normalizeItem(item) {
|
function normalizeItem(item) {
|
||||||
@@ -22,7 +24,6 @@ function normalizeItem(item) {
|
|||||||
name: item?.name ?? '',
|
name: item?.name ?? '',
|
||||||
category: item?.category ?? 'adventuring-gear',
|
category: item?.category ?? 'adventuring-gear',
|
||||||
rarity: item?.rarity ?? 'common',
|
rarity: item?.rarity ?? 'common',
|
||||||
quantity: Number(item?.quantity ?? 1),
|
|
||||||
weight: item?.weight ?? '',
|
weight: item?.weight ?? '',
|
||||||
properties: item?.properties ?? '',
|
properties: item?.properties ?? '',
|
||||||
description: item?.description ?? '',
|
description: item?.description ?? '',
|
||||||
@@ -44,9 +45,10 @@ onMounted(() => {
|
|||||||
onBeforeUnmount(() => ClearWindow({ type: 'item_sheet' }));
|
onBeforeUnmount(() => ClearWindow({ type: 'item_sheet' }));
|
||||||
|
|
||||||
// The sidebar keeps this entry fresh (Foundry sync lands in the background);
|
// The sidebar keeps this entry fresh (Foundry sync lands in the background);
|
||||||
// follow along unless the window is mid-icon-upload.
|
// follow along unless this window is mid-icon-change. The icon windows leave
|
||||||
|
// their result here, on the same event.
|
||||||
function handleItemSync({ entityType, entry }) {
|
function handleItemSync({ entityType, entry }) {
|
||||||
if (entityType !== 'item' || entry?._id !== itemId || uploadingIcon.value) return;
|
if (entityType !== 'item' || entry?._id !== itemId || applyingIcon.value) return;
|
||||||
form.value = normalizeItem(entry);
|
form.value = normalizeItem(entry);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -70,40 +72,22 @@ async function updateItem(payload) {
|
|||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
function pickIcon() {
|
// Choosing an icon is a window of its own: upload one from this device, or browse
|
||||||
photoInput.value?.click();
|
// the icon library of the linked Foundry world. Both leave their result on the
|
||||||
|
// `campaign-entry-updated` event, which this window follows.
|
||||||
|
function chooseIcon() {
|
||||||
|
CreateChildWindow(id, 'item_icon_source', {
|
||||||
|
item: { _id: itemId, name: form.value.name, image: form.value.image },
|
||||||
|
campaign: Campaign.value?._id || ''
|
||||||
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
async function onIconSelected(event) {
|
// The world's own icon for this item: the module keeps it on the item, so this
|
||||||
const file = event.target.files?.[0];
|
// just switches back to it. Picking one of the world's other icons is what the
|
||||||
event.target.value = '';
|
// icon browser is for.
|
||||||
if (!file || uploadingIcon.value) return;
|
|
||||||
uploadingIcon.value = true;
|
|
||||||
error.value = '';
|
|
||||||
try {
|
|
||||||
const formData = new FormData();
|
|
||||||
formData.append('image', file);
|
|
||||||
const response = await Server().post(`/item/upload-image?item=${itemId}`, formData, {
|
|
||||||
headers: { "Content-Type": "multipart/form-data" }
|
|
||||||
});
|
|
||||||
if (response.data.status !== 'ok') {
|
|
||||||
error.value = t('campaigns.item.sheet.upload-error');
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
form.value = normalizeItem(response.data.item);
|
|
||||||
emitter.emit('campaign-entry-updated', { entityType: 'item', entry: response.data.item });
|
|
||||||
} catch (requestError) {
|
|
||||||
error.value = t('campaigns.item.sheet.upload-error');
|
|
||||||
} finally {
|
|
||||||
uploadingIcon.value = false;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// "Fetch from Foundry's icons": the module keeps the world's own icon on the
|
|
||||||
// item, so this just switches back to it.
|
|
||||||
async function useFoundryIcon() {
|
async function useFoundryIcon() {
|
||||||
if (!canUseFoundryIcon.value || applyingFoundryIcon.value) return;
|
if (!canUseFoundryIcon.value || applyingIcon.value) return;
|
||||||
applyingFoundryIcon.value = true;
|
applyingIcon.value = true;
|
||||||
error.value = '';
|
error.value = '';
|
||||||
try {
|
try {
|
||||||
const done = await updateItem({ image: form.value.foundryImage });
|
const done = await updateItem({ image: form.value.foundryImage });
|
||||||
@@ -111,18 +95,21 @@ async function useFoundryIcon() {
|
|||||||
} catch (requestError) {
|
} catch (requestError) {
|
||||||
error.value = t('campaigns.item.sheet.save-error');
|
error.value = t('campaigns.item.sheet.save-error');
|
||||||
} finally {
|
} finally {
|
||||||
applyingFoundryIcon.value = false;
|
applyingIcon.value = false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
async function removeIcon() {
|
async function removeIcon() {
|
||||||
if (!form.value.image) return;
|
if (!form.value.image || applyingIcon.value) return;
|
||||||
|
applyingIcon.value = true;
|
||||||
error.value = '';
|
error.value = '';
|
||||||
try {
|
try {
|
||||||
const done = await updateItem({ image: '' });
|
const done = await updateItem({ image: '' });
|
||||||
if (!done) error.value = t('campaigns.item.sheet.save-error');
|
if (!done) error.value = t('campaigns.item.sheet.save-error');
|
||||||
} catch (requestError) {
|
} catch (requestError) {
|
||||||
error.value = t('campaigns.item.sheet.save-error');
|
error.value = t('campaigns.item.sheet.save-error');
|
||||||
|
} finally {
|
||||||
|
applyingIcon.value = false;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
</script>
|
</script>
|
||||||
@@ -132,10 +119,12 @@ async function removeIcon() {
|
|||||||
<WindowHandle :window="id" ref="handle" />
|
<WindowHandle :window="id" ref="handle" />
|
||||||
<div class="item-body">
|
<div class="item-body">
|
||||||
<header class="item-hero">
|
<header class="item-hero">
|
||||||
<div class="item-icon" :class="{ empty: !form.image }">
|
<button class="item-icon" :class="{ empty: !form.image }" type="button"
|
||||||
|
:aria-label="$t(form.image ? 'campaigns.item.sheet.change-icon' : 'campaigns.item.sheet.choose-icon')"
|
||||||
|
@click="chooseIcon">
|
||||||
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.item.sheet.icon')">
|
<img v-if="form.image" :src="imageUrl" :alt="$t('campaigns.item.sheet.icon')">
|
||||||
<span v-else aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</span>
|
<span v-else aria-hidden="true">{{ form.name.slice(0, 1).toUpperCase() }}</span>
|
||||||
</div>
|
</button>
|
||||||
<div class="item-identity">
|
<div class="item-identity">
|
||||||
<h1>{{ form.name }}</h1>
|
<h1>{{ form.name }}</h1>
|
||||||
<div class="item-tags">
|
<div class="item-tags">
|
||||||
@@ -149,23 +138,18 @@ async function removeIcon() {
|
|||||||
<div v-if="error" class="item-error">{{ error }}</div>
|
<div v-if="error" class="item-error">{{ error }}</div>
|
||||||
|
|
||||||
<div class="icon-controls">
|
<div class="icon-controls">
|
||||||
<button class="sheet-button" type="button" :disabled="uploadingIcon" @click="pickIcon">
|
<button class="sheet-button" type="button" @click="chooseIcon">
|
||||||
{{ uploadingIcon
|
{{ form.image ? $t('campaigns.item.sheet.change-icon') : $t('campaigns.item.sheet.choose-icon') }}
|
||||||
? $t('campaigns.item.sheet.uploading')
|
|
||||||
: (form.image ? $t('campaigns.item.sheet.change-icon') : $t('campaigns.item.sheet.choose-icon')) }}
|
|
||||||
</button>
|
</button>
|
||||||
<button v-if="canUseFoundryIcon" class="sheet-button secondary" type="button" :disabled="applyingFoundryIcon" @click="useFoundryIcon">
|
<button v-if="canUseFoundryIcon" class="sheet-button secondary" type="button" :disabled="applyingIcon" @click="useFoundryIcon">
|
||||||
{{ $t('campaigns.item.sheet.foundry-icon') }}
|
{{ $t('campaigns.item.sheet.foundry-icon') }}
|
||||||
</button>
|
</button>
|
||||||
<button v-if="form.image" class="sheet-button secondary" type="button" :disabled="uploadingIcon" :aria-label="$t('campaigns.item.sheet.remove-icon')" @click="removeIcon">×</button>
|
<button v-if="form.image" class="sheet-button secondary" type="button" :disabled="applyingIcon" :aria-label="$t('campaigns.item.sheet.remove-icon')" @click="removeIcon">×</button>
|
||||||
<input ref="photoInput" class="photo-input" type="file" accept="image/*" @change="onIconSelected">
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<!-- Quantity is the actor inventory's business (Syndria98/dragonroll#63); the item
|
||||||
|
sheet only states what the item itself is. -->
|
||||||
<dl class="item-facts">
|
<dl class="item-facts">
|
||||||
<div class="item-fact">
|
|
||||||
<dt>{{ $t('campaigns.item.quantity') }}</dt>
|
|
||||||
<dd>{{ form.quantity }}</dd>
|
|
||||||
</div>
|
|
||||||
<div v-if="form.weight !== '' && form.weight !== undefined" class="item-fact">
|
<div v-if="form.weight !== '' && form.weight !== undefined" class="item-fact">
|
||||||
<dt>{{ $t('campaigns.item.weight') }}</dt>
|
<dt>{{ $t('campaigns.item.weight') }}</dt>
|
||||||
<dd>{{ Number(form.weight).toFixed(1) }} lb</dd>
|
<dd>{{ Number(form.weight).toFixed(1) }} lb</dd>
|
||||||
@@ -189,7 +173,8 @@ async function removeIcon() {
|
|||||||
.item-window { min-width: 0; min-height: 0; }
|
.item-window { min-width: 0; min-height: 0; }
|
||||||
.item-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 14px 16px 16px; box-sizing: border-box; }
|
.item-body { width: 100%; min-height: 0; flex: 1; overflow: auto; padding: 14px 16px 16px; box-sizing: border-box; }
|
||||||
.item-hero { display: flex; align-items: center; gap: 13px; padding: 2px 2px 13px; margin-bottom: 11px; border-bottom: 1px solid var(--color-border); }
|
.item-hero { display: flex; align-items: center; gap: 13px; padding: 2px 2px 13px; margin-bottom: 11px; border-bottom: 1px solid var(--color-border); }
|
||||||
.item-icon { width: 64px; height: 64px; flex: 0 0 64px; display: grid; place-items: center; overflow: hidden; border-radius: 10px; border: 1px solid var(--color-border); background: var(--color-background-soft); color: var(--color-link); font: 30px MrEavesRemake; }
|
.item-icon { width: 64px; height: 64px; flex: 0 0 64px; display: grid; place-items: center; overflow: hidden; border-radius: 10px; border: 1px solid var(--color-border); background: var(--color-background-soft); color: var(--color-link); font: 30px MrEavesRemake; padding: 0; cursor: pointer; }
|
||||||
|
.item-icon:hover { border-color: var(--color-link); }
|
||||||
.item-icon.empty { border-style: dashed; }
|
.item-icon.empty { border-style: dashed; }
|
||||||
.item-icon img { width: 100%; height: 100%; object-fit: contain; }
|
.item-icon img { width: 100%; height: 100%; object-fit: contain; }
|
||||||
.item-identity { min-width: 0; }
|
.item-identity { min-width: 0; }
|
||||||
@@ -202,7 +187,6 @@ async function removeIcon() {
|
|||||||
.sheet-button { border: 1px solid var(--color-border); border-radius: 7px; padding: 7px 12px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; white-space: nowrap; font-size: 13px; }
|
.sheet-button { border: 1px solid var(--color-border); border-radius: 7px; padding: 7px 12px; background: var(--color-background-soft); color: var(--color-text); cursor: pointer; white-space: nowrap; font-size: 13px; }
|
||||||
.sheet-button:hover { background: var(--color-button-hover); }
|
.sheet-button:hover { background: var(--color-button-hover); }
|
||||||
.sheet-button:disabled { opacity: .55; cursor: wait; }
|
.sheet-button:disabled { opacity: .55; cursor: wait; }
|
||||||
.photo-input { display: none; }
|
|
||||||
.item-facts { display: flex; flex-wrap: wrap; gap: 8px; margin: 0 0 13px; }
|
.item-facts { display: flex; flex-wrap: wrap; gap: 8px; margin: 0 0 13px; }
|
||||||
.item-fact { flex: 1 1 120px; min-width: 0; padding: 9px 11px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
.item-fact { flex: 1 1 120px; min-width: 0; padding: 9px 11px; border: 1px solid var(--color-border); border-radius: 8px; background: var(--color-background-soft); }
|
||||||
.item-fact dt { font-size: 11px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
|
.item-fact dt { font-size: 11px; text-transform: uppercase; letter-spacing: .05em; opacity: .72; }
|
||||||
|
|||||||
@@ -76,6 +76,7 @@ onMounted(() => {
|
|||||||
<div class="vert bot">
|
<div class="vert bot">
|
||||||
<div class="button-container">
|
<div class="button-container">
|
||||||
<button class="btn-primary button-expand sound-click" v-on:click="CreateCampaignWindow" ref="campaignButton">{{ $t("main-menu.create-campaign") }}</button>
|
<button class="btn-primary button-expand sound-click" v-on:click="CreateCampaignWindow" ref="campaignButton">{{ $t("main-menu.create-campaign") }}</button>
|
||||||
|
<a class="btn-primary button-expand docs-link" href="/docs">{{ $t("main-menu.documentation") }}</a>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
@@ -145,6 +146,24 @@ h2, h3 {
|
|||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* L'enllaç a la documentació és un `<a>` i els botons estan estilats per element, així
|
||||||
|
que li toca portar el mateix look. */
|
||||||
|
.docs-link {
|
||||||
|
display: block;
|
||||||
|
padding: 14px;
|
||||||
|
border-radius: 6px;
|
||||||
|
border: solid 1px var(--color-border);
|
||||||
|
background-color: var(--color-button-background);
|
||||||
|
color: var(--color-text);
|
||||||
|
text-align: center;
|
||||||
|
text-decoration: none;
|
||||||
|
transition: 300ms background-color;
|
||||||
|
}
|
||||||
|
|
||||||
|
.docs-link:hover {
|
||||||
|
background-color: var(--color-button-hover);
|
||||||
|
}
|
||||||
|
|
||||||
p {
|
p {
|
||||||
user-select: none;
|
user-select: none;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
# What is Dragonroll?
|
||||||
|
|
||||||
|
Dragonroll is a free and open-source helper for tabletop RPG campaigns. It keeps the things a group
|
||||||
|
carries around a table in one place — the campaign's notes, its characters, its items, its maps — and
|
||||||
|
lets the tools you already play with read and change them: Discord, Foundry VTT and Obsidian.
|
||||||
|
|
||||||
|
It is not a full virtual tabletop. There is no game loop, no combat tracker and no rule engine:
|
||||||
|
Dragonroll is the shared memory of a campaign, and the place its characters and items are written
|
||||||
|
down.
|
||||||
|
|
||||||
|
## What you get
|
||||||
|
|
||||||
|
- **Campaigns.** Every note, character, item and map belongs to one campaign, and each campaign has
|
||||||
|
its own colour, description and integrations. [Start one](/docs/your-first-campaign).
|
||||||
|
- **Notes in markdown.** The campaign's text lives in markdown notes, filed into folders that nest as
|
||||||
|
deep as you need. Notes can hold a [dice widget](/docs/notes-and-markdown) that rolls when you
|
||||||
|
look at it.
|
||||||
|
- **Characters and items.** Actors (characters, NPCs and creatures) have a sheet with ability scores,
|
||||||
|
combat stats, proficiencies, traits, spells and an inventory. Items have a category, a rarity and an
|
||||||
|
icon. See [characters and items](/docs/characters-and-items).
|
||||||
|
- **Maps.** Upload a map image with a grid, then pin notes onto the places they belong and stand your
|
||||||
|
characters on the grid as [tokens](/docs/maps).
|
||||||
|
- **Integrations.** Consult the campaign from [Discord](/docs/discord), keep a Foundry VTT world and
|
||||||
|
a campaign [in step](/docs/foundry), and write campaign notes in [Obsidian](/docs/obsidian).
|
||||||
|
|
||||||
|
## How it is put together
|
||||||
|
|
||||||
|
Three pieces work together, and you only ever see the first of them:
|
||||||
|
|
||||||
|
| Piece | What it does |
|
||||||
|
| --- | --- |
|
||||||
|
| The web app | What you open: campaigns, notes, characters, items, maps, and the documentation you are reading |
|
||||||
|
| The API | Stores everything the app shows and answers the integrations' requests |
|
||||||
|
| The integrations | The Discord bot, the Foundry VTT module and the Obsidian plugin |
|
||||||
|
|
||||||
|
You sign in to the app with one account, and everything you create belongs to you. Integrations never
|
||||||
|
hold a Dragonroll login: they ask you to authorize them for one campaign, which
|
||||||
|
[you can take back](/docs/connecting-a-service) at any time.
|
||||||
|
|
||||||
|
## Where to go next
|
||||||
|
|
||||||
|
- New here? [Create your first campaign](/docs/your-first-campaign).
|
||||||
|
- Writing the campaign down? [Notes and markdown](/docs/notes-and-markdown).
|
||||||
|
- Playing on a screen? [Maps, pins and tokens](/docs/maps).
|
||||||
|
- Connecting the tools you use? [Connecting a service](/docs/connecting-a-service).
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
# Your first campaign
|
||||||
|
|
||||||
|
## Signing in
|
||||||
|
|
||||||
|
The very first time you open a Dragonroll server there is no account yet, so the app asks you to
|
||||||
|
create one: that first account becomes the server's **administrator**, which is the account that can
|
||||||
|
later create or remove the other accounts. Everyone else is invited to register by whoever runs the
|
||||||
|
server.
|
||||||
|
|
||||||
|
Sign in with your username or your email and your password. Sessions last 48 hours, after which the
|
||||||
|
app asks you again. Under your name in the main menu you can change your profile — your name, your
|
||||||
|
email and the avatar that shows up beside your characters.
|
||||||
|
|
||||||
|
## The main menu
|
||||||
|
|
||||||
|
The main menu is where you pick up where you left off:
|
||||||
|
|
||||||
|
- your campaigns, ready to open,
|
||||||
|
- **Create campaign** to add one,
|
||||||
|
- **Settings**, with your own appearance and language, and an *Administration* tab for
|
||||||
|
administrators to manage the other accounts,
|
||||||
|
- **Log out**.
|
||||||
|
|
||||||
|
## Creating a campaign
|
||||||
|
|
||||||
|
**Create campaign** asks for three things: a name, a short description and an accent colour. The
|
||||||
|
colour follows the campaign wherever it shows up, so a group that runs two campaigns can tell them
|
||||||
|
apart at a glance. Nothing else about a campaign is fixed: you can change the name, description and
|
||||||
|
colour later in its settings.
|
||||||
|
|
||||||
|
## The campaign workspace
|
||||||
|
|
||||||
|
Opening a campaign replaces the menu with its workspace.
|
||||||
|
|
||||||
|
| Part | What it holds |
|
||||||
|
| --- | --- |
|
||||||
|
| Top bar | The campaign's name, the search, **Settings** and **Exit** |
|
||||||
|
| Sidebar | The campaign's contents, in four sections: **Notes**, **Actors & Characters**, **Items** and **Maps** |
|
||||||
|
| Note column | The notes you have open, side by side, or the map you have anchored |
|
||||||
|
| Status bar | What the app is doing: saving, syncing, and errors when something fails |
|
||||||
|
|
||||||
|
The sidebar is the heart of it. Each of its sections lists the entries of that kind, and each entry
|
||||||
|
can stand in a folder: folders nest, so a campaign can be organised however the group thinks of it.
|
||||||
|
The sidebar itself collapses to give the notes room when you are showing a screen at the table.
|
||||||
|
|
||||||
|
## Finding things
|
||||||
|
|
||||||
|
The search in the top bar looks through the notes, characters, items and maps of the campaign you are
|
||||||
|
in, and opens whatever you pick from the results. **Cmd+K** (or **Ctrl+K**) puts the cursor in it.
|
||||||
|
|
||||||
|
## Campaign settings
|
||||||
|
|
||||||
|
**Settings** in the top bar has two tabs:
|
||||||
|
|
||||||
|
- **Basic** — the campaign's name and colour.
|
||||||
|
- **Integrations** — which external services are connected to this campaign and how to
|
||||||
|
[connect one](/docs/connecting-a-service), plus the address of the Foundry VTT instance when the
|
||||||
|
campaign reads icons from a linked world.
|
||||||
|
|
||||||
|
**Exit** leaves the campaign and returns to the main menu. Nothing is lost: the notes you had open and
|
||||||
|
the campaign you were in are remembered for the next time you open the app.
|
||||||
|
|
||||||
|
## Next
|
||||||
|
|
||||||
|
- Write the campaign down in [notes and markdown](/docs/notes-and-markdown).
|
||||||
|
- Write its characters and items on [sheets](/docs/characters-and-items).
|
||||||
|
- Put it on a [map](/docs/maps).
|
||||||
@@ -0,0 +1,89 @@
|
|||||||
|
# Notes and markdown
|
||||||
|
|
||||||
|
Notes are where a campaign is written down: sessions, NPCs, the lore of a city, the ritual the party
|
||||||
|
found in a dungeon. They are plain markdown, so anything you already know from README files and
|
||||||
|
Obsidian works as it is.
|
||||||
|
|
||||||
|
## Opening and editing a note
|
||||||
|
|
||||||
|
Clicking a note in the sidebar opens it in the note column, where you can have several open side by
|
||||||
|
side. A note opens in **display mode**, showing its formatted markdown. Press **Cmd+E** (**Ctrl+E**)
|
||||||
|
to edit its source, and **Cmd+S** (**Ctrl+S**) to save it; a dot in the note's title bar reminds you
|
||||||
|
that there is something to save. The cross in the title bar closes the note — it does not delete it.
|
||||||
|
|
||||||
|
## Folders
|
||||||
|
|
||||||
|
The sidebar's sections hold notes in folders, and folders hold folders, so a campaign can be nested as
|
||||||
|
deep as it needs. Right-clicking gives the commands:
|
||||||
|
|
||||||
|
| Right-click on… | You get |
|
||||||
|
| --- | --- |
|
||||||
|
| a note | Open, Rename, a colour, the folder to move it to, Delete |
|
||||||
|
| a folder | New note in it, Rename, a colour, Delete folder |
|
||||||
|
|
||||||
|
Dragging a note onto a folder moves it there, and dropping it at the bottom of the list takes it back
|
||||||
|
to the root. Colouring a note or a folder tints its row in the sidebar, which is a quick way to mark
|
||||||
|
what matters.
|
||||||
|
|
||||||
|
Deleting a folder does not delete your notes: the notes it held move up to its parent folder, its
|
||||||
|
sub-folders move up with them, and only the empty folders go away.
|
||||||
|
|
||||||
|
## Markdown
|
||||||
|
|
||||||
|
Headings, **bold**, *italic*, lists, quotes, tables, code and links all work:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## The Wreck of the Salt Gull
|
||||||
|
|
||||||
|
- [ ] Burn the manifest
|
||||||
|
- [x] Ask the harbourmaster
|
||||||
|
|
||||||
|
| Cargo | Worth |
|
||||||
|
| --- | --- |
|
||||||
|
| Salted fish | 20 gp |
|
||||||
|
```
|
||||||
|
|
||||||
|
Clicking a heading **folds** the section under it — handy when you are reading a long note on a
|
||||||
|
projector and only want the part you are talking about. Sub-headings fold with their parent.
|
||||||
|
|
||||||
|
## Rolling dice in a note
|
||||||
|
|
||||||
|
A note can hold a dice widget: a button that rolls and shows the result right there, so the book of a
|
||||||
|
spell does not need a second app next to it.
|
||||||
|
|
||||||
|
Write `@roll` and the expression in square brackets to drop it in the middle of a sentence:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
The goblin attacks with @roll[1d20+4].
|
||||||
|
```
|
||||||
|
|
||||||
|
Or in a block of its own, between `@roll` and `@end`, when the roll is worth showing on its own line:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
@roll
|
||||||
|
8d6
|
||||||
|
@end
|
||||||
|
```
|
||||||
|
|
||||||
|
Either way the widget shows the expression as a button: press it and the dice land, with every die and
|
||||||
|
the total spelled out. Press it again to roll again. Only the expression itself goes between `@roll`
|
||||||
|
and `@end` — write the note about the roll next to the widget, not inside it.
|
||||||
|
|
||||||
|
The expression understands:
|
||||||
|
|
||||||
|
| Written | Meaning |
|
||||||
|
| --- | --- |
|
||||||
|
| `d20`, `1d20` | one die; the number in front is how many, so `4d6` |
|
||||||
|
| `d20adv`, `d20dis` | roll twice and keep the higher / the lower |
|
||||||
|
| `4d6kh1`, `4d6kl1` | keep the highest / lowest one of four (any number after `kh` / `kl`) |
|
||||||
|
| `+`, `-`, `*`, `/` | arithmetic; `2d6+3`, `1d8/2` |
|
||||||
|
| `( )` | grouping, as in `(1d8+4)*2` |
|
||||||
|
| `-3` | a negative number |
|
||||||
|
|
||||||
|
Division rounds down, the way damage does. Spaces between the parts of an expression do not matter, but
|
||||||
|
a modifier belongs right after the dice: write `4d6kh1`, not `4d6 kh 1`.
|
||||||
|
|
||||||
|
## Next
|
||||||
|
|
||||||
|
- Put the people and things of your notes on [sheets](/docs/characters-and-items).
|
||||||
|
- Pin a note onto a spot on a [map](/docs/maps).
|
||||||
@@ -0,0 +1,50 @@
|
|||||||
|
# Characters and items
|
||||||
|
|
||||||
|
The **Actors & Characters** and **Items** sections of the sidebar hold the people and things of a
|
||||||
|
campaign as entries of their own, with a sheet each. They can be written by hand, and they are also
|
||||||
|
what a linked [Foundry VTT](/docs/foundry) world keeps itself in step with.
|
||||||
|
|
||||||
|
## Actors
|
||||||
|
|
||||||
|
An actor is anyone the campaign can point at: a **Character**, an **NPC** or a **Creature**. Creating
|
||||||
|
one asks for the few fields that identify it — type, species, class, level, background, and a challenge
|
||||||
|
rating for the monsters — and the rest is filled in on its sheet.
|
||||||
|
|
||||||
|
Opening an actor opens its **character sheet**, in tabs:
|
||||||
|
|
||||||
|
| Tab | What it holds |
|
||||||
|
| --- | --- |
|
||||||
|
| Ability Scores | Strength, Dexterity, Constitution, Intelligence, Wisdom, Charisma, and the proficiency bonus. Under them the six saving throws and the eighteen skills, each with a circle that stands lit when the character is proficient with it, next to the modifier it rolls. The proficiencies follow: the character's tools, its languages, and whatever else it is proficient with as text |
|
||||||
|
| Inventory | What it carries: every item with its icon, quantity and weight each, the total carried weight added up, and the coins the character holds |
|
||||||
|
| Traits | Features, traits and other details, as text |
|
||||||
|
| Spells | The spells it knows, one per line |
|
||||||
|
|
||||||
|
Toggling a skill, a saving throw, or writing a tool or a language is done like everything else on the
|
||||||
|
sheet: **Edit**, change it, **Save sheet**.
|
||||||
|
|
||||||
|
Combat lives above the tabs: armor class, speed, initiative, current and maximum hit points, and hit
|
||||||
|
dice. The photo at the top of the sheet is what shows up next to the character everywhere else —
|
||||||
|
including in [Discord](/docs/discord), where players can read the sheet of the character they hold.
|
||||||
|
|
||||||
|
**Edit** turns the sheet into fields you can change; **Save sheet** writes them back. Characters are
|
||||||
|
filed in folders like notes are, so a campaign can keep its party, its villains and its bestiary
|
||||||
|
apart.
|
||||||
|
|
||||||
|
## Items
|
||||||
|
|
||||||
|
An item is anything the campaign names: a weapon, a potion, a piece of treasure. Its sheet holds a
|
||||||
|
name, a description, a **category** (weapon, armor, shield, adventuring gear, magic item, consumable,
|
||||||
|
tool, treasure, other), a **rarity** from common to artifact, a weight in pounds, and its properties
|
||||||
|
("finesse, versatile").
|
||||||
|
|
||||||
|
The rarity colours the item's row in the sidebar — common white, uncommon green, rare blue, very rare
|
||||||
|
purple, legendary orange — so what is worth something stands out while you scroll.
|
||||||
|
|
||||||
|
Every item can have an icon. Upload an image, or pick one out of the icon library your linked Foundry
|
||||||
|
world ships with, browsing its folders one at a time.
|
||||||
|
|
||||||
|
## Characters on the table
|
||||||
|
|
||||||
|
Drag an actor out of the sidebar and drop it on a map and it stands there as a
|
||||||
|
[token](/docs/maps), sized to the map's grid. Drag a note instead and it is filed into whatever folder
|
||||||
|
you drop it on.
|
||||||
66
frontend/app/content/docs/02-using-dragonroll/03-maps.md
Normal file
66
frontend/app/content/docs/02-using-dragonroll/03-maps.md
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
# Maps, pins and tokens
|
||||||
|
|
||||||
|
A map is a picture of a place — a dungeon floor, a town, a combat encounter — with a grid laid over
|
||||||
|
it. On top of the picture you can pin the notes that belong to a spot and stand the campaign's
|
||||||
|
characters on its cells.
|
||||||
|
|
||||||
|
## Creating a map
|
||||||
|
|
||||||
|
**Maps → New map** asks for an image and the grid that goes with it:
|
||||||
|
|
||||||
|
| Setting | What it is |
|
||||||
|
| --- | --- |
|
||||||
|
| Map image | A photo or scan of the map. Uploading a new one replaces it, and leaving it empty keeps the current image |
|
||||||
|
| Grid size (px) | How wide one grid cell is in the image, in image pixels |
|
||||||
|
| Offset X / Offset Y | Where the grid starts in the image, so the grid can be lined up with the drawing |
|
||||||
|
| Scale | How much distance one cell stands for, like 5 feet |
|
||||||
|
|
||||||
|
The grid size, offsets and scale are what let the app turn a point on the screen into a cell of the
|
||||||
|
map, so a token stands where it should and pins stay put when you zoom.
|
||||||
|
|
||||||
|
## Looking at a map
|
||||||
|
|
||||||
|
Clicking a map in the sidebar anchors it in the place the open notes occupy, and **Open in window**
|
||||||
|
puts it in a window of its own, which you can drag next to the notes. Once a map is on screen:
|
||||||
|
|
||||||
|
- scroll to zoom towards the cursor, or use the zoom buttons and **Fit to window**,
|
||||||
|
- drag to pan,
|
||||||
|
- **Show grid** turns the grid overlay on and off. The grid is drawn over the image, so its lines stay
|
||||||
|
crisp whatever the zoom.
|
||||||
|
|
||||||
|
## Pinning notes
|
||||||
|
|
||||||
|
Right-click anywhere on a map and pick **Pin a note here**, then choose the note: a marker appears on
|
||||||
|
that spot, and clicking the marker opens the note. A pinned note can be read straight off the map
|
||||||
|
without hunting for it in the sidebar, which is what makes a town map usable at the table.
|
||||||
|
|
||||||
|
**Remove pin** takes the marker off; the note itself is untouched. Deleting a note that is pinned drops
|
||||||
|
its pins.
|
||||||
|
|
||||||
|
## Tokens
|
||||||
|
|
||||||
|
Drag an actor from the sidebar onto a map and it stands there as a token: it snaps to the centre of the
|
||||||
|
cell you dropped it on and is sized by that cell, so a huge creature can be given more than one cell by
|
||||||
|
sizing it up on the map's settings.
|
||||||
|
|
||||||
|
Once a token is on the map you can drag it to another cell, step it across the grid one cell at a time
|
||||||
|
with the **arrow keys**, and take it off with **Delete**. Double-clicking a token opens the sheet of
|
||||||
|
the actor it stands for, and **Enter** does the same on a token focused with the keyboard.
|
||||||
|
|
||||||
|
Tokens belong to the map, not to the actor: the same character can stand on several maps, and taking a
|
||||||
|
token off does not remove the character from the campaign.
|
||||||
|
|
||||||
|
## Maps from a linked Foundry world
|
||||||
|
|
||||||
|
With a Foundry world linked to the campaign, its scenes arrive as maps of their own: each one with the
|
||||||
|
scene's background picture and the grid laid over it, in the scene's own cell size and where the world
|
||||||
|
shifts that grid onto the picture. That is all a scene lends a map — what one of your cells stands
|
||||||
|
for, the folder a map stands in, and whatever you pin or stand on it stay yours, and nothing about a
|
||||||
|
map goes back to the world.
|
||||||
|
|
||||||
|
A scene renamed in Foundry, or its grid moved, updates its map. Take the background picture off a
|
||||||
|
scene and its map keeps the one it has; delete the scene and its map goes with it the next time the
|
||||||
|
world sends its whole scene list, which is when the world loads. For the same reason a map you delete
|
||||||
|
in the campaign comes back on the next world load while its scene is still there — take the scene off
|
||||||
|
in Foundry to be rid of the map. A map you made yourself is never doubled by the scene of it: a scene
|
||||||
|
arriving with the name of an unmapped map adopts that one. See [Foundry VTT](/docs/foundry).
|
||||||
@@ -0,0 +1,51 @@
|
|||||||
|
# Connecting a service
|
||||||
|
|
||||||
|
Dragonroll talks to three services: [Discord](/docs/discord), [Foundry VTT](/docs/foundry) and
|
||||||
|
[Obsidian](/docs/obsidian). They all connect the same way, and none of them is given your Dragonroll
|
||||||
|
password.
|
||||||
|
|
||||||
|
## How a connection works
|
||||||
|
|
||||||
|
A service asks Dragonroll for a **sign-up link** and shows it to you. You open that link in your
|
||||||
|
browser, sign in if you are not signed in already, and pick which of your campaigns the service may
|
||||||
|
use. Only then does the service get its own credential, which lets it read and change that one
|
||||||
|
campaign and nothing else.
|
||||||
|
|
||||||
|
| You see | What it means |
|
||||||
|
| --- | --- |
|
||||||
|
| A link in Discord, in the Foundry module or in the Obsidian plugin | The service is waiting for you to pick a campaign |
|
||||||
|
| A campaign picker in your browser | Sign in and choose the campaign, and the service is connected |
|
||||||
|
| "Connected" in the service | It picked up its credential and can start working |
|
||||||
|
|
||||||
|
The link is short-lived — it expires after ten minutes — and can only be used once. If you close it
|
||||||
|
without choosing, ask the service for a new one. If a service loses the credential it was given, it
|
||||||
|
asks for a new link too: nothing is kept that would let it back in.
|
||||||
|
|
||||||
|
## What a connection allows
|
||||||
|
|
||||||
|
What a service may do is decided by the campaign you pick, so check the name before you confirm. The
|
||||||
|
screen tells you which service is asking, and what it wants:
|
||||||
|
|
||||||
|
- a **Discord server** reads the campaign's characters, so whoever is in that server can read them,
|
||||||
|
- a **Foundry world** keeps its actors and items in step with the campaign, which means it writes into
|
||||||
|
it, and Dragonroll writes into it,
|
||||||
|
- **Obsidian** reads the campaign's notes and pushes the ones you tell it to.
|
||||||
|
|
||||||
|
A campaign holds one link per service: linking a second Foundry world, or a second Discord server,
|
||||||
|
replaces the one it had. Authorizing a service with a different Dragonroll account replaces who the
|
||||||
|
service answers to.
|
||||||
|
|
||||||
|
## Seeing and undoing a connection
|
||||||
|
|
||||||
|
Open the campaign and look at **Settings → Integrations**. It lists the three services and, for each
|
||||||
|
one, whether it is connected, what is connected to it, and which Dragonroll account authorized it.
|
||||||
|
|
||||||
|
**Unlink** ends it. The service loses access the next time it asks — nothing it already wrote into the
|
||||||
|
campaign is deleted, and nothing about your campaign changes. To use the service again, start a new
|
||||||
|
link from its own side.
|
||||||
|
|
||||||
|
## Next
|
||||||
|
|
||||||
|
- [Discord](/docs/discord) — read characters and campaigns from a server.
|
||||||
|
- [Foundry VTT](/docs/foundry) — keep a world and a campaign in step.
|
||||||
|
- [Obsidian](/docs/obsidian) — write campaign notes in your vault.
|
||||||
62
frontend/app/content/docs/03-integrations/02-discord.md
Normal file
62
frontend/app/content/docs/03-integrations/02-discord.md
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
# Discord
|
||||||
|
|
||||||
|
The Dragonroll Discord bot lets a server read the characters of a campaign without anyone leaving
|
||||||
|
Discord: the roster, a character's sheet with its portrait, and who plays whom. It is a read-only bot —
|
||||||
|
it never changes your campaign.
|
||||||
|
|
||||||
|
## Connecting a server
|
||||||
|
|
||||||
|
1. Invite the bot to the server with the `bot` and `applications.commands` scopes.
|
||||||
|
2. A Discord **administrator** runs `/dragonroll connect`. The bot answers with a *Sign in to
|
||||||
|
Dragonroll* button.
|
||||||
|
3. Whoever opens it signs in to the Dragonroll account that owns the campaign and picks that campaign.
|
||||||
|
The server is now linked to it, and the bot says so.
|
||||||
|
4. From then on anybody in the server can look the campaign's characters up.
|
||||||
|
|
||||||
|
The authorization link lasts ten minutes and works once. A campaign is linked to one Discord server at
|
||||||
|
a time, and a server to one campaign; authorizing the server with a different Dragonroll account takes
|
||||||
|
over the connection.
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
| Command | Who | What it does |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `/characters [type]` | everybody | Lists the characters of the campaign this server is linked to. `type` narrows the list to **Characters**, **NPCs** or **Creatures**. Every character a player has claimed shows up next to that player. |
|
||||||
|
| `/character name [public]` | everybody | Shows one actor's sheet: its portrait, description, race, class and level, background, armor class and speed, ability scores, proficiencies, traits, spells and inventory. Start typing a name and Discord offers the campaign's roster. Set `public` to `true` to show the sheet to the whole channel instead of only to you. |
|
||||||
|
| `/dragonroll connect` | administrators | Asks Dragonroll for the sign-up link that connects this server, and confirms here once somebody has authorized it. |
|
||||||
|
| `/dragonroll link campaign:` | administrators | Moves this server to another campaign of the connected Dragonroll account. Type part of a name to filter the choices. |
|
||||||
|
| `/dragonroll unlink` | administrators | Removes this server's campaign link. The campaign is untouched; the commands simply have nothing to read until one is linked again. |
|
||||||
|
| `/dragonroll status` | everybody | Shows which campaign this server reads, and which character your Discord account holds on it. |
|
||||||
|
| `/dragonroll refresh` | everybody | Asks Dragonroll again where the connection stands, and shows what it answered. |
|
||||||
|
| `/dragonroll assign character:` | everybody | Links a character of the campaign to your Discord account, so the bot knows it is yours and `/characters` says so. You can take a character nobody holds; a character somebody else holds can only be moved by an administrator. |
|
||||||
|
| `/dragonroll unassign [character]` | everybody | Drops a character link. Without the option you give up your own character; naming somebody else's takes it off them, which only an administrator can do. |
|
||||||
|
|
||||||
|
Replies are private: only you see them, so a player can look up their character in a busy channel. The
|
||||||
|
one exception is `/character` with `public:true`, which posts the sheet where everyone can read it — for
|
||||||
|
the villain the party is talking to, or the magic item they just found.
|
||||||
|
|
||||||
|
## Characters and their players
|
||||||
|
|
||||||
|
`/dragonroll assign` is how a player says *this one is mine*:
|
||||||
|
|
||||||
|
- each account holds one character, so claiming a second one frees the first,
|
||||||
|
- a free character can be taken by anybody,
|
||||||
|
- a character somebody holds can only be taken or freed by a server administrator,
|
||||||
|
- the pairing shows up in `/characters` and in `/dragonroll status`, which is what lets the table see
|
||||||
|
who is playing whom.
|
||||||
|
|
||||||
|
Assigning a character does not hide anything: the bot is read-only and every member of the server can
|
||||||
|
already read the campaign's characters with `/character`.
|
||||||
|
|
||||||
|
## When something goes wrong
|
||||||
|
|
||||||
|
| The bot says | What is going on |
|
||||||
|
| --- | --- |
|
||||||
|
| "Connect a Dragonroll account first with /dragonroll connect." | Nobody has authorized this server yet, or the authorization expired before anyone opened it. |
|
||||||
|
| "Only Discord server administrators can connect Dragonroll or change this campaign link." | The command changes the server's connection, so it needs the Discord Administrator permission. |
|
||||||
|
| "The bot API secret is missing or does not match the backend." | Whoever runs the bot has to set the same `DRAGONROLL_DISCORD_BOT_SECRET` in the bot and in the Dragonroll backend. |
|
||||||
|
| "This server does not have a linked campaign." | The link was removed; an administrator has to pick a campaign with `/dragonroll link`. |
|
||||||
|
|
||||||
|
Character portraits are read from Dragonroll's public upload folder, so the bot needs to be able to
|
||||||
|
reach the server Dragonroll runs on. Whoever hosts the bot finds its setup in `discord-bot/README.md`
|
||||||
|
in the source repository.
|
||||||
132
frontend/app/content/docs/03-integrations/03-foundry.md
Normal file
132
frontend/app/content/docs/03-integrations/03-foundry.md
Normal file
@@ -0,0 +1,132 @@
|
|||||||
|
# Foundry VTT
|
||||||
|
|
||||||
|
The Foundry integration keeps a Dragonroll campaign and a Foundry world in step: the world's
|
||||||
|
characters, item directory and scenes arrive in the campaign, and what you change in Dragonroll of
|
||||||
|
those characters and items goes back to the world.
|
||||||
|
|
||||||
|
There are two separate parts, and you only need the first of them:
|
||||||
|
|
||||||
|
| Part | What it is |
|
||||||
|
| --- | --- |
|
||||||
|
| The **Dragonroll Foundry API** module | Installed in the world. Links it to a campaign and keeps its actors and items synced. Runs in the game client. |
|
||||||
|
| The optional **snapshot bridge** | A small process on the Foundry host that publishes a read-only snapshot of the world for Dragonroll to browse. Only for reading world data over the API. |
|
||||||
|
|
||||||
|
Character and item sync works without the bridge.
|
||||||
|
|
||||||
|
## Installing the module
|
||||||
|
|
||||||
|
Foundry VTT v12 to v14. Copy the `dragonroll-foundry` folder into
|
||||||
|
`{Foundry user data}/Data/modules/dragonroll-foundry/`, restart Foundry, and enable **Dragonroll
|
||||||
|
Foundry API** in the world's module settings.
|
||||||
|
|
||||||
|
The module's own settings hold two things you set: the **Dragonroll Endpoint** — the address of your
|
||||||
|
Dragonroll server, `https://dragonroll.aranroig.com` by default — and **Dragonroll Auto-sync**, which
|
||||||
|
is on.
|
||||||
|
|
||||||
|
## Linking a world
|
||||||
|
|
||||||
|
Open the world with a GM account. The module asks Dragonroll for a sign-up link and prints it in a
|
||||||
|
notification: open it, sign in, and pick the campaign this world belongs to. **Dragonroll Pairing
|
||||||
|
Status** in the module settings always says where things stand — waiting for a link, connected to a
|
||||||
|
named campaign, or why a link could not be used.
|
||||||
|
|
||||||
|
Worth knowing:
|
||||||
|
|
||||||
|
- The link expires after ten minutes and works once. If it goes unused, reload the world to get a new
|
||||||
|
one.
|
||||||
|
- A world links to one campaign, and a campaign to one Foundry world: linking a second world replaces
|
||||||
|
the first.
|
||||||
|
- The link, the sync token it hands back and the pairing status are all **client** settings: the
|
||||||
|
browser that completed the link is the one that syncs. Another browser on the same world reads as not
|
||||||
|
paired until it links too.
|
||||||
|
- **Dragonroll Pairing Status** is written by the module. It is not a field to fill in.
|
||||||
|
- The campaign shows the linked world's title and system under **Settings → Integrations**, where
|
||||||
|
**Unlink** ends the pairing.
|
||||||
|
|
||||||
|
## What syncs
|
||||||
|
|
||||||
|
| In Foundry | In the campaign |
|
||||||
|
| --- | --- |
|
||||||
|
| Character, NPC and creature actors | Actors with the same sheet: abilities, saving throws, skills, combat stats, proficiencies, tools, languages, traits, spells, carried gear with its icons, coins, portrait |
|
||||||
|
| The world's **item directory** (the items tab) | The campaign's item list, with category, rarity, quantity, weight, properties and description |
|
||||||
|
| The folders grouping that item directory | Item folders with the same names and nesting |
|
||||||
|
| A folder's colour | The campaign's folder colour — and the other way round, what you colour in Dragonroll lands on the world's folder |
|
||||||
|
| The world's **scenes** | The campaign's maps: the scene's background picture and the grid laid over it, in the scene's own cell size |
|
||||||
|
| A journal called **Dragonroll** — one page per note | Your campaign's notes. They arrive **from** Dragonroll: what you write in the journal does not go back |
|
||||||
|
|
||||||
|
The item list is the world's item directory and nothing else. The gear a character carries is that
|
||||||
|
character's inventory: it travels with the character and stays on its sheet, so a sword a fighter owns
|
||||||
|
does not turn up in the campaign's item list. Spells, classes, subclasses, backgrounds, feats and
|
||||||
|
species are not gear and are not imported.
|
||||||
|
|
||||||
|
The world's scenes are the campaign's maps, and only their **background picture** and their **grid**
|
||||||
|
cross over: a map arrives with the scene's picture and its cell size, and with the grid where the
|
||||||
|
world shifts it. That is where the two stop — what one of your cells stands for, the folder a map
|
||||||
|
stands in, the notes pinned onto it and the characters standing on it as tokens stay in the campaign,
|
||||||
|
and nothing about a map is written back into the world. The scene list goes over when the world links
|
||||||
|
and when it loads, which is also when the map of a scene the GM deleted goes with it; scenes changed
|
||||||
|
afterwards arrive as they happen. A scene with no background picture makes no map, and the full list
|
||||||
|
leaves a map the campaign already had alone, so a grid you lined up yourself survives a reload.
|
||||||
|
|
||||||
|
An actor or item keeps the Dragonroll id it was given in a `dragonroll-foundry.actorId` /
|
||||||
|
`dragonroll-foundry.itemId` flag, and that is what makes the two sides recognise each other. A world
|
||||||
|
item that carries no flag is matched by name, so a hand-written item in Dragonroll is adopted instead of
|
||||||
|
doubled, and renaming it in either place does not resurrect a duplicate.
|
||||||
|
|
||||||
|
Changes flow both ways as they happen, and Dragonroll's own edits are applied back in Foundry within a
|
||||||
|
few seconds. A **full** snapshot — the one taken when the world links, or forced from the actor
|
||||||
|
directory — is the only thing that prunes: it is the only moment either side can see the whole list and
|
||||||
|
notice what is gone. Live edits never delete anything.
|
||||||
|
|
||||||
|
Notes are the exception that runs one way, because notes are written in Dragonroll: every note stands
|
||||||
|
as a page of a single journal called **Dragonroll**. A note you make or edit in the app appears on that
|
||||||
|
journal within a few seconds, and deleting one takes its page with it. A page that stands under a note's
|
||||||
|
title but carries no Dragonroll mark is claimed as that note's page, so a pairing that was lost does not
|
||||||
|
double it. Any other page — one the GM made in that journal themselves — is left alone, and nothing
|
||||||
|
written in the journal travels back to the campaign.
|
||||||
|
|
||||||
|
## Auto-sync, and sending one actor on purpose
|
||||||
|
|
||||||
|
**Dragonroll Auto-sync** is what keeps the two in step: actors and world items you create, change or
|
||||||
|
delete are sent to the campaign, and both sides reconcile every few seconds. Turning it off stops all
|
||||||
|
of it — nothing is sent, and Dragonroll stops rewriting your Foundry documents, so the campaign keeps
|
||||||
|
whatever it already holds. Turn it back on and both sides reconcile again, including the edits queued
|
||||||
|
while it was off.
|
||||||
|
|
||||||
|
To send one character across right now, or to cross over while autosync is off, right-click the actor
|
||||||
|
(or several) in the Foundry actor directory and pick **Dragonroll: Force Sync**. Those actors, with the
|
||||||
|
gear inside them, are pushed immediately. It only upserts: it never prunes the campaign's other actors.
|
||||||
|
Actors Dragonroll does not import — anything that is not a character, NPC or creature — are refused with
|
||||||
|
a notification saying so.
|
||||||
|
|
||||||
|
## Foundry's icons in Dragonroll
|
||||||
|
|
||||||
|
With a world linked, Dragonroll's item icon browser can page through the icon library that world ships
|
||||||
|
with, one folder at a time. If it says the world has no address, set it under **Settings → Integrations
|
||||||
|
→ Foundry VTT URL** in the campaign.
|
||||||
|
|
||||||
|
## The optional snapshot bridge
|
||||||
|
|
||||||
|
The bridge is a small Node.js (18 or newer) process that runs beside Foundry. A GM client publishes the
|
||||||
|
world's actor and item snapshot to it, and Dragonroll reads that snapshot back through its own API, so
|
||||||
|
a server can ask what a world holds without touching the game. It is read-only, it keeps nothing across
|
||||||
|
restarts, and character sync does not depend on it.
|
||||||
|
|
||||||
|
It needs its own tokens — separate ones for publishing and for reading — and an origin allow-list for
|
||||||
|
the Foundry client:
|
||||||
|
|
||||||
|
| Variable | What it is |
|
||||||
|
| --- | --- |
|
||||||
|
| `DRAGONROLL_FOUNDRY_PUSH_TOKEN` | The token the Foundry client publishes with; the backend's `FOUNDRY_API_PUSH_TOKEN` must match it |
|
||||||
|
| `DRAGONROLL_FOUNDRY_READ_TOKEN` | The token reads with; the backend's `FOUNDRY_API_TOKEN` must match it |
|
||||||
|
| `DRAGONROLL_FOUNDRY_ALLOWED_ORIGINS` | The browser origins allowed to publish, comma separated |
|
||||||
|
| `DRAGONROLL_FOUNDRY_HOST` / `DRAGONROLL_FOUNDRY_PORT` | Where the bridge listens; `0.0.0.0:8787` by default |
|
||||||
|
| `DRAGONROLL_FOUNDRY_DATA_PATH` | The Foundry Data directory, which lets the bridge list the core `icons/` library |
|
||||||
|
|
||||||
|
The backend points at it with `FOUNDRY_API_URL` (and `FOUNDRY_API_CLIENT_URL` when the Foundry clients
|
||||||
|
reach it under a different address than the backend does). Once it is set up, Dragonroll answers
|
||||||
|
`GET /api/foundry/world`, `/actors`, `/characters`, `/items`, one of each by id, an actor's embedded
|
||||||
|
items, and `/icons` — all for a signed-in Dragonroll user, and all read-only.
|
||||||
|
|
||||||
|
`dragonroll-foundry/README.md` in the source repository documents the bridge, its routes and its
|
||||||
|
heartbeat in full.
|
||||||
77
frontend/app/content/docs/03-integrations/04-obsidian.md
Normal file
77
frontend/app/content/docs/03-integrations/04-obsidian.md
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
# Obsidian
|
||||||
|
|
||||||
|
The **Dragonroll Sync** plugin moves campaign notes between a Dragonroll campaign and an Obsidian
|
||||||
|
vault: import the campaign so you can read and write it with your own notes, and push the note you are
|
||||||
|
working on back to the campaign.
|
||||||
|
|
||||||
|
It is an explicit, you-ask-for-it workflow. Nothing happens in the background, and the plugin never
|
||||||
|
deletes a note.
|
||||||
|
|
||||||
|
## Installing
|
||||||
|
|
||||||
|
Copy `main.js` and `manifest.json` into your vault:
|
||||||
|
|
||||||
|
```text
|
||||||
|
<vault>/.obsidian/plugins/dragonroll-sync/
|
||||||
|
```
|
||||||
|
|
||||||
|
Then enable **Dragonroll Sync** under Settings → Community plugins. It is plain JavaScript, so there is
|
||||||
|
nothing to build, and it runs on desktop and mobile alike.
|
||||||
|
|
||||||
|
## Connecting
|
||||||
|
|
||||||
|
Under **Settings → Community plugins → Dragonroll Sync**:
|
||||||
|
|
||||||
|
1. Set the **Dragonroll API URL** — `https://dragonroll.aranroig.com/api` by default, or your own
|
||||||
|
server, such as `http://localhost:5000/api`.
|
||||||
|
2. **Sign in** with your Dragonroll username or email and your password. The password is used once to
|
||||||
|
sign in and is not saved; what the plugin keeps is the session token, in this vault, and it expires
|
||||||
|
after 48 hours like any other Dragonroll session.
|
||||||
|
3. Pick the **campaign**. Every import and push works against that campaign.
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
Both are in Obsidian's command palette:
|
||||||
|
|
||||||
|
| Command | What it does |
|
||||||
|
| --- | --- |
|
||||||
|
| **Import or refresh campaign notes** | Brings every note of the campaign into `Dragonroll/<Campaign>/`, folders and nesting included, and updates the ones already there. Imported notes keep their place in the campaign's folder tree. |
|
||||||
|
| **Push active note to Dragonroll** | Sends the note you are in to the campaign: a new root note if it is not linked yet, or an update of the note it is linked to. |
|
||||||
|
|
||||||
|
## How a note knows where it belongs
|
||||||
|
|
||||||
|
An imported note carries three properties in its frontmatter:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
dragonrollId: 665f1c…
|
||||||
|
dragonrollCampaign: 665f0a…
|
||||||
|
dragonrollTitle: The Salt Gull
|
||||||
|
---
|
||||||
|
```
|
||||||
|
|
||||||
|
They are what ties the file to its note in the campaign: they survive renames, and they are stripped
|
||||||
|
from the markdown the plugin sends back, so they never show up in Dragonroll. Pushing a brand new local
|
||||||
|
note adds them too, which is how the next push updates the same note instead of creating a copy.
|
||||||
|
|
||||||
|
Renaming the note's title in Dragonroll renames the imported file on the next import; renaming the file
|
||||||
|
in Obsidian renames the note in Dragonroll on the next push.
|
||||||
|
|
||||||
|
## Your edits are not overwritten
|
||||||
|
|
||||||
|
The plugin remembers how a note looked the last time it was imported or pushed, and uses that as the
|
||||||
|
baseline:
|
||||||
|
|
||||||
|
| Since the last sync | What the import does |
|
||||||
|
| --- | --- |
|
||||||
|
| Only the campaign's copy changed | The local file is updated |
|
||||||
|
| Only your local file changed | Your file is kept as it is, and reported for you to look at |
|
||||||
|
| Both changed | Your file is kept as it is, and reported for you to look at |
|
||||||
|
| Neither changed | Nothing is touched |
|
||||||
|
|
||||||
|
So a note you were rewriting in Obsidian is never quietly replaced: the plugin leaves it alone and tells
|
||||||
|
you it is waiting. Pushing is the deliberate direction — it writes the active note's current title and
|
||||||
|
content into Dragonroll.
|
||||||
|
|
||||||
|
A note that is linked to a different campaign cannot be pushed while another campaign is selected:
|
||||||
|
switch the campaign in the plugin settings first.
|
||||||
9
frontend/app/pages/[...all].vue
Normal file
9
frontend/app/pages/[...all].vue
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
<script setup>
|
||||||
|
// L'aplicació de finestres no té rutes pròpies: qualsevol adreça que no sigui la
|
||||||
|
// documentació l'obre, i /link/authorize se n'encarrega dins d'AppShell.
|
||||||
|
import AppShell from '~/components/views/AppShell.vue';
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<AppShell></AppShell>
|
||||||
|
</template>
|
||||||
8
frontend/app/pages/docs/[slug].vue
Normal file
8
frontend/app/pages/docs/[slug].vue
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
<script setup>
|
||||||
|
// `/docs/<slug>`, amb el slug del fitxer de markdown (mira ~/services/Docs.js).
|
||||||
|
import DocsView from '~/components/views/DocsView.vue';
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<DocsView></DocsView>
|
||||||
|
</template>
|
||||||
7
frontend/app/pages/docs/index.vue
Normal file
7
frontend/app/pages/docs/index.vue
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
<script setup>
|
||||||
|
import DocsView from '~/components/views/DocsView.vue';
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<DocsView></DocsView>
|
||||||
|
</template>
|
||||||
7
frontend/app/pages/index.vue
Normal file
7
frontend/app/pages/index.vue
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
<script setup>
|
||||||
|
import AppShell from '~/components/views/AppShell.vue';
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<AppShell></AppShell>
|
||||||
|
</template>
|
||||||
114
frontend/app/services/Docs.js
Normal file
114
frontend/app/services/Docs.js
Normal file
@@ -0,0 +1,114 @@
|
|||||||
|
import { Marked } from "marked";
|
||||||
|
import { CreateHeadingSlugger, HeadingsFromMarkdown, TitleFromMarkdown } from "./DocsMarkdown";
|
||||||
|
|
||||||
|
/*
|
||||||
|
The documentation served at /docs is markdown files under app/content/docs, so writing a page means
|
||||||
|
adding a file. The layout of a page's path says everything the sidebar needs:
|
||||||
|
|
||||||
|
app/content/docs/<group>/<NN>-<page>.md
|
||||||
|
|
||||||
|
The folder is the sidebar group and its own number orders the groups, the number in front of the file
|
||||||
|
orders the pages inside its group, and the rest of the file name is the page's slug (`02-discord.md`
|
||||||
|
is `/docs/discord`). A page's title is its first heading, and the first page of the first group is
|
||||||
|
served at `/docs` itself.
|
||||||
|
|
||||||
|
A group's label is looked up under `docs.groups.<folder>` in the locale files of
|
||||||
|
`i18n/locales/en/docs.json` and its siblings, so a new group needs that label in every locale.
|
||||||
|
*/
|
||||||
|
const markdownFiles = import.meta.glob("../content/docs/*/*.md", { query: "?raw", eager: true, import: "default" });
|
||||||
|
|
||||||
|
const Numbered = /^(\d+)-/;
|
||||||
|
const WithoutNumber = (name) => name.replace(Numbered, "");
|
||||||
|
// A name without a number in front sorts after every numbered one in its folder.
|
||||||
|
const OrderOf = (name) => {
|
||||||
|
const numbered = Numbered.exec(name);
|
||||||
|
return numbered ? Number(numbered[1]) : Number.MAX_SAFE_INTEGER;
|
||||||
|
};
|
||||||
|
|
||||||
|
const pages = Object.entries(markdownFiles)
|
||||||
|
.map(([file, source]) => {
|
||||||
|
const [folder, filename] = file.split("/").slice(-2);
|
||||||
|
const markdown = String(source ?? "");
|
||||||
|
|
||||||
|
return {
|
||||||
|
group: WithoutNumber(folder),
|
||||||
|
groupOrder: OrderOf(folder),
|
||||||
|
slug: WithoutNumber(filename).replace(/\.md$/, ""),
|
||||||
|
order: OrderOf(filename),
|
||||||
|
title: TitleFromMarkdown(markdown),
|
||||||
|
headings: HeadingsFromMarkdown(markdown),
|
||||||
|
markdown,
|
||||||
|
};
|
||||||
|
})
|
||||||
|
.sort((left, right) =>
|
||||||
|
left.groupOrder - right.groupOrder || left.order - right.order || left.slug.localeCompare(right.slug)
|
||||||
|
);
|
||||||
|
|
||||||
|
// `/docs` is the first page of the documentation, the rest hang under it by their slug.
|
||||||
|
function GetDocsHref(slug) {
|
||||||
|
return pages.length && slug === pages[0].slug ? "/docs" : `/docs/${slug}`;
|
||||||
|
}
|
||||||
|
|
||||||
|
function GetDocsFirstSlug() {
|
||||||
|
return pages.length ? pages[0].slug : "";
|
||||||
|
}
|
||||||
|
|
||||||
|
// The sidebar: one entry per group folder, in reading order, holding its pages.
|
||||||
|
function GetDocsNav() {
|
||||||
|
const nav = [];
|
||||||
|
|
||||||
|
for (const page of pages) {
|
||||||
|
let group = nav.find((entry) => entry.key === page.group);
|
||||||
|
if (!group) {
|
||||||
|
group = { key: page.group, pages: [] };
|
||||||
|
nav.push(group);
|
||||||
|
}
|
||||||
|
group.pages.push({ slug: page.slug, title: page.title, href: GetDocsHref(page.slug) });
|
||||||
|
}
|
||||||
|
|
||||||
|
return nav;
|
||||||
|
}
|
||||||
|
|
||||||
|
const marked = new Marked();
|
||||||
|
|
||||||
|
// Every heading gets the anchor the sidebar and the "on this page" list link to. The slugger is
|
||||||
|
// replaced at the start of a parse so each page numbers its repeated headings on its own: marked
|
||||||
|
// parses one document at a time and does it synchronously, so no other parse can cut in.
|
||||||
|
let slugHeadings = CreateHeadingSlugger();
|
||||||
|
|
||||||
|
marked.use({
|
||||||
|
renderer: {
|
||||||
|
heading({ tokens, depth }) {
|
||||||
|
const content = this.parser.parseInline(tokens);
|
||||||
|
return `<h${depth} id="${slugHeadings(content)}">${content}</h${depth}>`;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
function RenderDocsMarkdown(markdown) {
|
||||||
|
slugHeadings = CreateHeadingSlugger();
|
||||||
|
return String(marked.parse(markdown || ""));
|
||||||
|
}
|
||||||
|
|
||||||
|
// What the /docs page shows: a rendered page with the headings it holds and whichever pages come
|
||||||
|
// before and after it, or null when nothing is published under that slug.
|
||||||
|
function GetDocsPage(slug) {
|
||||||
|
const index = pages.findIndex((page) => page.slug === slug);
|
||||||
|
if (index === -1) return null;
|
||||||
|
|
||||||
|
const page = pages[index];
|
||||||
|
const neighbours = (page) => (page ? { slug: page.slug, title: page.title, href: GetDocsHref(page.slug) } : null);
|
||||||
|
|
||||||
|
return {
|
||||||
|
slug: page.slug,
|
||||||
|
group: page.group,
|
||||||
|
title: page.title,
|
||||||
|
// The page's own h1 is in the body already; the list is for its sections.
|
||||||
|
headings: page.headings.filter((heading) => heading.depth > 1 && heading.depth <= 3),
|
||||||
|
html: RenderDocsMarkdown(page.markdown),
|
||||||
|
previous: neighbours(pages[index - 1]),
|
||||||
|
next: neighbours(pages[index + 1]),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export { GetDocsFirstSlug, GetDocsHref, GetDocsNav, GetDocsPage, RenderDocsMarkdown };
|
||||||
90
frontend/app/services/DocsMarkdown.js
Normal file
90
frontend/app/services/DocsMarkdown.js
Normal file
@@ -0,0 +1,90 @@
|
|||||||
|
/*
|
||||||
|
String helpers for the documentation under /docs: the words a heading shows, the anchor it gets, and
|
||||||
|
the headings the sidebar lists. They import nothing at all, not even marked, because the repository
|
||||||
|
root installs no dependencies and `tests/docs.test.js` loads this file straight from source.
|
||||||
|
*/
|
||||||
|
|
||||||
|
// What marked escapes, back to the character it stands for: an anchor has to be the same whether it
|
||||||
|
// was written as `'` or arrived as `'`.
|
||||||
|
const Entities = {
|
||||||
|
amp: "&",
|
||||||
|
lt: "<",
|
||||||
|
gt: ">",
|
||||||
|
quot: '"',
|
||||||
|
apos: "'",
|
||||||
|
nbsp: " ",
|
||||||
|
"#39": "'",
|
||||||
|
"#x27": "'",
|
||||||
|
};
|
||||||
|
|
||||||
|
function DecodeEntities(value) {
|
||||||
|
return value.replace(/&(#?[a-z0-9]+);/gi, (entity, body) => (Entities[body.toLowerCase()] ?? ""));
|
||||||
|
}
|
||||||
|
|
||||||
|
// A heading's anchor is built from its markdown source when the sidebar is built, and from the HTML
|
||||||
|
// marked has rendered when the page is. This drops everything the two forms disagree on — the tags
|
||||||
|
// marked adds, the entities it escapes, and the characters markdown uses for emphasis and links — so
|
||||||
|
// both keep the same words and land on the same anchor.
|
||||||
|
function HeadingText(value) {
|
||||||
|
return DecodeEntities(
|
||||||
|
String(value ?? "")
|
||||||
|
.replace(/<[^>]*>/g, "") // <code>, <em>, <a> … around the heading's words
|
||||||
|
.replace(/!?\[([^\]]*)\]\([^)]*\)/g, "$1") // a link keeps the label it shows, not its target
|
||||||
|
.replace(/[*_`~]/g, "") // emphasis
|
||||||
|
).trim();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Lower case letters, numbers and dashes: what a url fragment and a query selector both accept.
|
||||||
|
function Slugify(value) {
|
||||||
|
return HeadingText(value)
|
||||||
|
.toLowerCase()
|
||||||
|
.replace(/[^a-z0-9]+/g, "-")
|
||||||
|
.replace(/^-+|-+$/g, "");
|
||||||
|
}
|
||||||
|
|
||||||
|
// Two headings with the same words cannot share an anchor: the second becomes `words-1`, the third
|
||||||
|
// `words-2`. The sidebar and the renderer both walk a page's headings in document order, so the
|
||||||
|
// numbers they hand out are the same.
|
||||||
|
function CreateHeadingSlugger() {
|
||||||
|
const seen = new Map();
|
||||||
|
|
||||||
|
return (value) => {
|
||||||
|
const base = Slugify(value) || "section";
|
||||||
|
const times = seen.get(base) || 0;
|
||||||
|
seen.set(base, times + 1);
|
||||||
|
return times === 0 ? base : `${base}-${times}`;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// The headings of a markdown document, in order, each with the anchor its renderer will give it:
|
||||||
|
// `{ depth: 2, text: "Link a world", slug: "link-a-world" }`. Lines inside a fenced code block are
|
||||||
|
// skipped — a `# comment` there is shell, not a heading.
|
||||||
|
function HeadingsFromMarkdown(source) {
|
||||||
|
const slug = CreateHeadingSlugger();
|
||||||
|
const headings = [];
|
||||||
|
let inFence = false;
|
||||||
|
|
||||||
|
for (const line of String(source ?? "").split(/\r?\n/)) {
|
||||||
|
if (/^ {0,3}(```|~~~)/.test(line)) {
|
||||||
|
inFence = !inFence;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (inFence) continue;
|
||||||
|
|
||||||
|
const heading = /^ {0,3}(#{1,6})\s+(.*?)\s*#*\s*$/.exec(line);
|
||||||
|
if (!heading) continue;
|
||||||
|
|
||||||
|
const text = HeadingText(heading[2]);
|
||||||
|
headings.push({ depth: heading[1].length, text, slug: slug(text) });
|
||||||
|
}
|
||||||
|
|
||||||
|
return headings;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A documentation page's title is its first heading.
|
||||||
|
function TitleFromMarkdown(source) {
|
||||||
|
const [first] = HeadingsFromMarkdown(source);
|
||||||
|
return first ? first.text : "";
|
||||||
|
}
|
||||||
|
|
||||||
|
export { CreateHeadingSlugger, HeadingsFromMarkdown, HeadingText, Slugify, TitleFromMarkdown };
|
||||||
@@ -88,6 +88,21 @@ const defWindows = {
|
|||||||
close: () => ClearWindow({type: 'item_sheet'}),
|
close: () => ClearWindow({type: 'item_sheet'}),
|
||||||
movable: true
|
movable: true
|
||||||
},
|
},
|
||||||
|
item_icon_source: {
|
||||||
|
title: 'windows.icon-source',
|
||||||
|
component: () => import('~/components/windows/ItemIconSourceWindow.vue'),
|
||||||
|
close: () => ClearWindow({ type: 'item_icon_source' }),
|
||||||
|
movable: true
|
||||||
|
},
|
||||||
|
foundry_icons: {
|
||||||
|
title: 'windows.foundry-icons',
|
||||||
|
component: () => import('~/components/windows/FoundryIconPickerWindow.vue'),
|
||||||
|
// Back closes the icon browser and leaves the chooser it was opened from,
|
||||||
|
// which is still open behind it.
|
||||||
|
back: () => ClearWindow({ type: 'foundry_icons' }),
|
||||||
|
close: () => ClearWindow({ type: 'foundry_icons' }),
|
||||||
|
movable: true
|
||||||
|
},
|
||||||
create_map: {
|
create_map: {
|
||||||
title: 'windows.create-map',
|
title: 'windows.create-map',
|
||||||
component: () => import('~/components/windows/CreateMapWindow.vue'),
|
component: () => import('~/components/windows/CreateMapWindow.vue'),
|
||||||
@@ -105,6 +120,12 @@ const defWindows = {
|
|||||||
component: () => import('~/components/windows/PinnedNoteWindow.vue'),
|
component: () => import('~/components/windows/PinnedNoteWindow.vue'),
|
||||||
close: () => ClearWindow({type: 'pinned_note'}),
|
close: () => ClearWindow({type: 'pinned_note'}),
|
||||||
movable: true
|
movable: true
|
||||||
|
},
|
||||||
|
documentation: {
|
||||||
|
title: 'windows.documentation',
|
||||||
|
component: () => import('~/components/windows/DocumentationWindow.vue'),
|
||||||
|
close: () => ClearWindow({type: 'documentation'}),
|
||||||
|
movable: true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -49,6 +49,11 @@
|
|||||||
"rename": "Canvia el nom", "color": "Color", "default": "Per defecte", "delete": "Suprimeix la carpeta",
|
"rename": "Canvia el nom", "color": "Color", "default": "Per defecte", "delete": "Suprimeix la carpeta",
|
||||||
"move-to": "Mou a carpeta...", "root": "Arrel"
|
"move-to": "Mou a carpeta...", "root": "Arrel"
|
||||||
},
|
},
|
||||||
|
"foundry-import": {
|
||||||
|
"run": "Força la importació des del Foundry",
|
||||||
|
"done": "Importat del Foundry: {imported} nous, {updated} actualitzats.",
|
||||||
|
"error": "No s'ha pogut importar des del món del Foundry vinculat."
|
||||||
|
},
|
||||||
"states": {
|
"states": {
|
||||||
"loading": "Carregant...", "loading-notes": "Carregant notes...", "empty-notes": "Encara no hi ha notes en aquesta campanya.",
|
"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-actors": "Encara no hi ha actors ni personatges.", "empty-items": "Encara no hi ha objectes en aquesta campanya.",
|
||||||
@@ -65,14 +70,19 @@
|
|||||||
},
|
},
|
||||||
"item": {
|
"item": {
|
||||||
"new": "Objecte nou", "edit": "Edita l'objecte", "foundry-sync-note": "Els canvis en aquest objecte també s'apliquen al món del Foundry vinculat.",
|
"new": "Objecte nou", "edit": "Edita l'objecte", "foundry-sync-note": "Els canvis en aquest objecte també s'apliquen al món del Foundry vinculat.",
|
||||||
"category": "Categoria", "rarity": "Raresa", "quantity": "Quantitat",
|
"category": "Categoria", "rarity": "Raresa",
|
||||||
"quantity-short": "Quant.", "weight": "Pes (lb)", "properties": "Propietats", "properties-placeholder": "Per exemple, versàtil, subtil",
|
"weight": "Pes (lb)", "properties": "Propietats", "properties-placeholder": "Per exemple, versàtil, subtil",
|
||||||
"sheet": {
|
"sheet": {
|
||||||
"icon": "Icona de l'objecte", "choose-icon": "Tria la teva pròpia icona", "change-icon": "Canvia la icona",
|
"icon": "Icona de l'objecte", "choose-icon": "Tria la teva pròpia icona", "change-icon": "Canvia la icona",
|
||||||
"uploading": "Pujant...", "upload-error": "No s'ha pogut pujar aquesta icona.",
|
"uploading": "Pujant...", "upload-error": "No s'ha pogut pujar aquesta icona.",
|
||||||
"foundry-icon": "Fes servir la icona del Foundry", "remove-icon": "Treu la icona", "save-error": "No s'ha pogut desar aquest objecte.",
|
"foundry-icon": "Fes servir la icona del Foundry", "remove-icon": "Treu la icona", "save-error": "No s'ha pogut desar aquest objecte.",
|
||||||
"no-description": "Sense descripció afegida."
|
"no-description": "Sense descripció afegida."
|
||||||
},
|
},
|
||||||
|
"icon-picker": {
|
||||||
|
"intro": "D'on ha de sortir la icona d'aquest objecte?",
|
||||||
|
"upload": "Pujar una icona", "upload-hint": "Tria una imatge d'aquest dispositiu.",
|
||||||
|
"foundry": "Carregar del Foundry", "foundry-hint": "Recorre les icones que inclou el teu món del Foundry."
|
||||||
|
},
|
||||||
"categories": {
|
"categories": {
|
||||||
"weapon": "Arma", "armor": "Armadura", "shield": "Escut", "adventuring-gear": "Equip d'aventura",
|
"weapon": "Arma", "armor": "Armadura", "shield": "Escut", "adventuring-gear": "Equip d'aventura",
|
||||||
"magic-item": "Objecte màgic", "consumable": "Consumible", "tool": "Eina", "treasure": "Tresor", "other": "Altre"
|
"magic-item": "Objecte màgic", "consumable": "Consumible", "tool": "Eina", "treasure": "Tresor", "other": "Altre"
|
||||||
@@ -108,11 +118,24 @@
|
|||||||
"tabs": { "abilities": "Característiques", "inventory": "Inventari", "traits": "Trets", "spells": "Conjurs" },
|
"tabs": { "abilities": "Característiques", "inventory": "Inventari", "traits": "Trets", "spells": "Conjurs" },
|
||||||
"level": "Nivell", "species": "Espècie", "unset-species": "Espècie sense definir", "edit": "Edita la fitxa", "cancel": "Cancel·la",
|
"level": "Nivell", "species": "Espècie", "unset-species": "Espècie sense definir", "edit": "Edita la fitxa", "cancel": "Cancel·la",
|
||||||
"saving": "Desant...", "save": "Desa la fitxa", "save-error": "No s'ha pogut desar aquesta fitxa de personatge.", "photo": "Foto", "upload-photo": "Pujar foto", "change-photo": "Canviar foto", "remove-photo": "Treure foto", "uploading-photo": "Pujant...", "photo-error": "No s'ha pogut pujar aquesta foto.", "ability-scores": "Característiques", "proficiency-bonus": "Bonificador de competència",
|
"saving": "Desant...", "save": "Desa la fitxa", "save-error": "No s'ha pogut desar aquesta fitxa de personatge.", "photo": "Foto", "upload-photo": "Pujar foto", "change-photo": "Canviar foto", "remove-photo": "Treure foto", "uploading-photo": "Pujant...", "photo-error": "No s'ha pogut pujar aquesta foto.", "ability-scores": "Característiques", "proficiency-bonus": "Bonificador de competència",
|
||||||
"combat": "Combat", "armor-class": "Classe d'armadura", "speed": "Velocitat", "proficiencies": "Competències",
|
"combat": "Combat", "armor-class": "Classe d'armadura", "speed": "Velocitat", "initiative": "Iniciativa",
|
||||||
"proficiencies-placeholder": "Afegeix salvacions, habilitats, armadures, armes, eines i idiomes...", "empty-proficiencies": "No hi ha competències afegides.",
|
"hit-points": "Punts de cop", "max-hit-points": "Punts de cop màxims", "hit-dice": "Daus de cop", "max-hit-dice": "Daus de cop màxims", "proficiencies": "Competències",
|
||||||
|
"proficiencies-placeholder": "Afegeix armadures, armes i qualsevol altra competència del personatge...", "empty-proficiencies": "No hi ha competències afegides.",
|
||||||
|
"saving-throws": "Tirades de salvació", "skills": "Habilitats",
|
||||||
|
"abilities": { "str": "Força", "dex": "Destresa", "con": "Constitució", "int": "Intel·ligència", "wis": "Saviesa", "cha": "Carisma" },
|
||||||
|
"skill-names": {
|
||||||
|
"acrobatics": "Acrobàcies", "animalHandling": "Tracte amb els animals", "arcana": "Arcan", "athletics": "Atletisme",
|
||||||
|
"deception": "Engany", "history": "Història", "insight": "Penetració", "intimidation": "Intimidació",
|
||||||
|
"investigation": "Investigació", "medicine": "Medicina", "nature": "Naturalesa", "perception": "Percepció",
|
||||||
|
"performance": "Actuació", "persuasion": "Persuasió", "religion": "Religió", "sleightOfHand": "Jocs de mans",
|
||||||
|
"stealth": "Furtivitat", "survival": "Supervivència"
|
||||||
|
},
|
||||||
|
"tools": "Eines", "tools-placeholder": "Escriu les eines, una per línia...", "empty-tools": "Cap competència amb eines.",
|
||||||
|
"languages": "Idiomes", "languages-placeholder": "Escriu els idiomes, un per línia...", "empty-languages": "Cap idioma.",
|
||||||
"traits": "Trets", "traits-placeholder": "Afegeix trets, capacitats i altres detalls...", "empty-traits": "No hi ha trets afegits.",
|
"traits": "Trets", "traits-placeholder": "Afegeix trets, capacitats i altres detalls...", "empty-traits": "No hi ha trets afegits.",
|
||||||
"spells": "Conjurs", "spells-placeholder": "Escriu els conjurs, un per línia...", "empty-spells": "No hi ha conjurs afegits.",
|
"spells": "Conjurs", "spells-placeholder": "Escriu els conjurs, un per línia...", "empty-spells": "No hi ha conjurs afegits.",
|
||||||
"inventory": "Inventari", "add-item": "Afegeix un objecte", "carried-weight": "Pes transportat", "item-name": "Objecte",
|
"inventory": "Inventari", "add-item": "Afegeix un objecte", "carried-weight": "Pes transportat", "item-name": "Objecte",
|
||||||
"quantity": "Quant.", "weight-each": "Unitat (lb)", "total-weight": "Total (lb)", "actions": "Accions", "empty-inventory": "L'inventari és buit."
|
"quantity": "Quant.", "weight-each": "Unitat (lb)", "total-weight": "Total (lb)", "actions": "Accions", "empty-inventory": "L'inventari és buit.",
|
||||||
|
"currency": "Monedes", "currency-units": { "pp": "PP", "gp": "GP", "ep": "EP", "sp": "SP", "cp": "CP" }, "item-icon": "Icona"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
15
frontend/i18n/locales/ca/docs.json
Normal file
15
frontend/i18n/locales/ca/docs.json
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"title": "Documentació",
|
||||||
|
"contents": "Contingut",
|
||||||
|
"on-this-page": "En aquesta pàgina",
|
||||||
|
"open-app": "Obrir Dragonroll",
|
||||||
|
"previous": "Anterior",
|
||||||
|
"next": "Següent",
|
||||||
|
"not-found": "No hi ha cap pàgina de la documentació que es digui «{page}».",
|
||||||
|
"back-to-docs": "Tornar a la documentació",
|
||||||
|
"groups": {
|
||||||
|
"getting-started": "Primers passos",
|
||||||
|
"using-dragonroll": "Fer servir Dragonroll",
|
||||||
|
"integrations": "Integracions"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,6 +3,18 @@
|
|||||||
"link-expired": "El codi d'enllaç de Foundry no és vàlid, ha caducat o ja s'ha utilitzat.",
|
"link-expired": "El codi d'enllaç de Foundry no és vàlid, ha caducat o ja s'ha utilitzat.",
|
||||||
"world-already-linked": "Aquest món de Foundry ja està enllaçat amb una altra campanya.",
|
"world-already-linked": "Aquest món de Foundry ja està enllaçat amb una altra campanya.",
|
||||||
"actor-already-synced": "Un altre actor d'aquesta campanya ja està sincronitzat amb aquell actor del Foundry.",
|
"actor-already-synced": "Un altre actor d'aquesta campanya ja està sincronitzat amb aquell actor del Foundry.",
|
||||||
"item-already-synced": "Un altre objecte d'aquesta campanya ja està sincronitzat amb aquell objecte del Foundry."
|
"item-already-synced": "Un altre objecte d'aquesta campanya ja està sincronitzat amb aquell objecte del Foundry.",
|
||||||
|
"icons-unavailable": "Les icones del Foundry no són disponibles: el seu bridge no està configurat o ara mateix no hi arriba.",
|
||||||
|
"icons-no-world-url": "Aquesta campanya no té adreça del món del Foundry. Definiu-la als ajustos de la campanya, a la pestanya d'integracions.",
|
||||||
|
"import-not-linked": "Aquesta campanya no té cap món del Foundry vinculat. Connecteu-ne un als ajustos de la campanya, a la pestanya d'integracions.",
|
||||||
|
"import-unavailable": "Les dades del Foundry no són disponibles: el seu bridge no està configurat, ara mateix no hi arriba o el seu món encara no ha publicat res.",
|
||||||
|
"import-world-mismatch": "El bridge del Foundry està mostrant un món diferent del que aquesta campanya té vinculat."
|
||||||
|
},
|
||||||
|
"icons": {
|
||||||
|
"path": "Carpeta d'icones",
|
||||||
|
"up": "Una carpeta amunt",
|
||||||
|
"loading": "Carregant icones...",
|
||||||
|
"empty": "No hi ha icones per triar en aquesta carpeta.",
|
||||||
|
"load-more": "Carregar més icones"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
"main-menu": "Menú principal",
|
"main-menu": "Menú principal",
|
||||||
"edit-profile": "Editar perfil",
|
"edit-profile": "Editar perfil",
|
||||||
"create-campaign": "Crear campanya",
|
"create-campaign": "Crear campanya",
|
||||||
|
"documentation": "Documentació",
|
||||||
"log-out": "Tanca la sessió",
|
"log-out": "Tanca la sessió",
|
||||||
"settings": "Configuració",
|
"settings": "Configuració",
|
||||||
"exit": "Sortir"
|
"exit": "Sortir"
|
||||||
|
|||||||
@@ -10,5 +10,8 @@
|
|||||||
"create-map": "Crear mapa",
|
"create-map": "Crear mapa",
|
||||||
"map-viewer": "Mapa",
|
"map-viewer": "Mapa",
|
||||||
"pinned-note": "Nota fixada",
|
"pinned-note": "Nota fixada",
|
||||||
"item-sheet": "Objecte"
|
"documentation": "Documentació",
|
||||||
|
"item-sheet": "Objecte",
|
||||||
|
"icon-source": "Tria una icona",
|
||||||
|
"foundry-icons": "Icones del Foundry"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -53,6 +53,11 @@
|
|||||||
"rename": "Rename", "color": "Color", "default": "Default", "delete": "Delete folder",
|
"rename": "Rename", "color": "Color", "default": "Default", "delete": "Delete folder",
|
||||||
"move-to": "Move to folder...", "root": "Root"
|
"move-to": "Move to folder...", "root": "Root"
|
||||||
},
|
},
|
||||||
|
"foundry-import": {
|
||||||
|
"run": "Force import from Foundry",
|
||||||
|
"done": "Imported from Foundry: {imported} new, {updated} updated.",
|
||||||
|
"error": "Unable to import from the linked Foundry world."
|
||||||
|
},
|
||||||
"states": {
|
"states": {
|
||||||
"loading": "Loading...", "loading-notes": "Loading notes...", "empty-notes": "No notes in this campaign yet.",
|
"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-actors": "No actors or characters yet.", "empty-items": "No items in this campaign yet.",
|
||||||
@@ -69,14 +74,19 @@
|
|||||||
},
|
},
|
||||||
"item": {
|
"item": {
|
||||||
"new": "New item", "edit": "Edit item", "foundry-sync-note": "Changes to this item are also applied in the linked Foundry world.",
|
"new": "New item", "edit": "Edit item", "foundry-sync-note": "Changes to this item are also applied in the linked Foundry world.",
|
||||||
"category": "Category", "rarity": "Rarity", "quantity": "Quantity",
|
"category": "Category", "rarity": "Rarity",
|
||||||
"quantity-short": "Qty", "weight": "Weight (lb)", "properties": "Properties", "properties-placeholder": "For example, versatile, finesse",
|
"weight": "Weight (lb)", "properties": "Properties", "properties-placeholder": "For example, versatile, finesse",
|
||||||
"sheet": {
|
"sheet": {
|
||||||
"icon": "Item icon", "choose-icon": "Choose your own icon", "change-icon": "Change icon",
|
"icon": "Item icon", "choose-icon": "Choose your own icon", "change-icon": "Change icon",
|
||||||
"uploading": "Uploading...", "upload-error": "Unable to upload this icon.",
|
"uploading": "Uploading...", "upload-error": "Unable to upload this icon.",
|
||||||
"foundry-icon": "Use Foundry icon", "remove-icon": "Remove icon", "save-error": "Unable to save this item.",
|
"foundry-icon": "Use Foundry icon", "remove-icon": "Remove icon", "save-error": "Unable to save this item.",
|
||||||
"no-description": "No description added."
|
"no-description": "No description added."
|
||||||
},
|
},
|
||||||
|
"icon-picker": {
|
||||||
|
"intro": "Where should this item's icon come from?",
|
||||||
|
"upload": "Upload icon", "upload-hint": "Choose an image from this device.",
|
||||||
|
"foundry": "Load from Foundry", "foundry-hint": "Browse the icons your Foundry world ships with."
|
||||||
|
},
|
||||||
"categories": {
|
"categories": {
|
||||||
"weapon": "Weapon", "armor": "Armor", "shield": "Shield", "adventuring-gear": "Adventuring gear",
|
"weapon": "Weapon", "armor": "Armor", "shield": "Shield", "adventuring-gear": "Adventuring gear",
|
||||||
"magic-item": "Magic item", "consumable": "Consumable", "tool": "Tool", "treasure": "Treasure", "other": "Other"
|
"magic-item": "Magic item", "consumable": "Consumable", "tool": "Tool", "treasure": "Treasure", "other": "Other"
|
||||||
@@ -114,11 +124,24 @@
|
|||||||
"saving": "Saving...", "save": "Save sheet", "save-error": "Unable to save this character sheet.",
|
"saving": "Saving...", "save": "Save sheet", "save-error": "Unable to save this character sheet.",
|
||||||
"photo": "Photo", "upload-photo": "Upload photo", "change-photo": "Change photo", "remove-photo": "Remove photo",
|
"photo": "Photo", "upload-photo": "Upload photo", "change-photo": "Change photo", "remove-photo": "Remove photo",
|
||||||
"uploading-photo": "Uploading...", "photo-error": "Unable to upload this photo.", "ability-scores": "Ability Scores", "proficiency-bonus": "Proficiency Bonus",
|
"uploading-photo": "Uploading...", "photo-error": "Unable to upload this photo.", "ability-scores": "Ability Scores", "proficiency-bonus": "Proficiency Bonus",
|
||||||
"combat": "Combat", "armor-class": "Armor Class", "speed": "Speed", "proficiencies": "Proficiencies",
|
"combat": "Combat", "armor-class": "Armor Class", "speed": "Speed", "initiative": "Initiative",
|
||||||
"proficiencies-placeholder": "Add saving throws, skills, armor, weapons, tools, and languages...", "empty-proficiencies": "No proficiencies added.",
|
"hit-points": "Hit Points", "max-hit-points": "Maximum hit points", "hit-dice": "Hit Dice", "max-hit-dice": "Maximum hit dice", "proficiencies": "Proficiencies",
|
||||||
|
"proficiencies-placeholder": "Add armor, weapons, and anything else the character is proficient with...", "empty-proficiencies": "No proficiencies added.",
|
||||||
|
"saving-throws": "Saving Throws", "skills": "Skills",
|
||||||
|
"abilities": { "str": "Strength", "dex": "Dexterity", "con": "Constitution", "int": "Intelligence", "wis": "Wisdom", "cha": "Charisma" },
|
||||||
|
"skill-names": {
|
||||||
|
"acrobatics": "Acrobatics", "animalHandling": "Animal Handling", "arcana": "Arcana", "athletics": "Athletics",
|
||||||
|
"deception": "Deception", "history": "History", "insight": "Insight", "intimidation": "Intimidation",
|
||||||
|
"investigation": "Investigation", "medicine": "Medicine", "nature": "Nature", "perception": "Perception",
|
||||||
|
"performance": "Performance", "persuasion": "Persuasion", "religion": "Religion", "sleightOfHand": "Sleight of Hand",
|
||||||
|
"stealth": "Stealth", "survival": "Survival"
|
||||||
|
},
|
||||||
|
"tools": "Tools", "tools-placeholder": "List tools, one per line...", "empty-tools": "No tool proficiencies.",
|
||||||
|
"languages": "Languages", "languages-placeholder": "List languages, one per line...", "empty-languages": "No languages.",
|
||||||
"traits": "Traits", "traits-placeholder": "Add features, traits, and other character details...", "empty-traits": "No traits added.",
|
"traits": "Traits", "traits-placeholder": "Add features, traits, and other character details...", "empty-traits": "No traits added.",
|
||||||
"spells": "Spells", "spells-placeholder": "List spells, one per line...", "empty-spells": "No spells added.",
|
"spells": "Spells", "spells-placeholder": "List spells, one per line...", "empty-spells": "No spells added.",
|
||||||
"inventory": "Inventory", "add-item": "Add item", "carried-weight": "Carried weight", "item-name": "Item",
|
"inventory": "Inventory", "add-item": "Add item", "carried-weight": "Carried weight", "item-name": "Item",
|
||||||
"quantity": "Qty", "weight-each": "Each (lb)", "total-weight": "Total (lb)", "actions": "Actions", "empty-inventory": "Inventory is empty."
|
"quantity": "Qty", "weight-each": "Each (lb)", "total-weight": "Total (lb)", "actions": "Actions", "empty-inventory": "Inventory is empty.",
|
||||||
|
"currency": "Currency", "currency-units": { "pp": "PP", "gp": "GP", "ep": "EP", "sp": "SP", "cp": "CP" }, "item-icon": "Icon"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
15
frontend/i18n/locales/en/docs.json
Normal file
15
frontend/i18n/locales/en/docs.json
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"title": "Documentation",
|
||||||
|
"contents": "Contents",
|
||||||
|
"on-this-page": "On this page",
|
||||||
|
"open-app": "Open Dragonroll",
|
||||||
|
"previous": "Previous",
|
||||||
|
"next": "Next",
|
||||||
|
"not-found": "There is no documentation page called “{page}”.",
|
||||||
|
"back-to-docs": "Back to the documentation",
|
||||||
|
"groups": {
|
||||||
|
"getting-started": "Getting started",
|
||||||
|
"using-dragonroll": "Using Dragonroll",
|
||||||
|
"integrations": "Integrations"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,6 +3,18 @@
|
|||||||
"link-expired": "This Foundry pairing code is invalid, expired, or already used.",
|
"link-expired": "This Foundry pairing code is invalid, expired, or already used.",
|
||||||
"world-already-linked": "This Foundry world is already linked to another campaign.",
|
"world-already-linked": "This Foundry world is already linked to another campaign.",
|
||||||
"actor-already-synced": "Another actor in this campaign is already synced with that Foundry actor.",
|
"actor-already-synced": "Another actor in this campaign is already synced with that Foundry actor.",
|
||||||
"item-already-synced": "Another item in this campaign is already synced with that Foundry item."
|
"item-already-synced": "Another item in this campaign is already synced with that Foundry item.",
|
||||||
|
"icons-unavailable": "Foundry's icons are not available: its bridge is not set up, or it cannot be reached right now.",
|
||||||
|
"icons-no-world-url": "This campaign has no Foundry world address. Set it under campaign settings, in the Integrations tab.",
|
||||||
|
"import-not-linked": "This campaign has no Foundry world linked to it. Connect one under campaign settings, in the Integrations tab.",
|
||||||
|
"import-unavailable": "Foundry's data is not available: its bridge is not set up, it cannot be reached right now, or its world has not published anything yet.",
|
||||||
|
"import-world-mismatch": "The Foundry bridge is showing another world than the one this campaign is linked to."
|
||||||
|
},
|
||||||
|
"icons": {
|
||||||
|
"path": "Icon folder",
|
||||||
|
"up": "One folder up",
|
||||||
|
"loading": "Loading icons...",
|
||||||
|
"empty": "No icons to pick in this folder.",
|
||||||
|
"load-more": "Load more icons"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
"main-menu": "Main menu",
|
"main-menu": "Main menu",
|
||||||
"edit-profile": "Edit profile",
|
"edit-profile": "Edit profile",
|
||||||
"create-campaign": "Create Campaign",
|
"create-campaign": "Create Campaign",
|
||||||
|
"documentation": "Documentation",
|
||||||
"log-out": "Log out",
|
"log-out": "Log out",
|
||||||
"settings": "Settings",
|
"settings": "Settings",
|
||||||
"exit": "Exit"
|
"exit": "Exit"
|
||||||
|
|||||||
@@ -10,5 +10,8 @@
|
|||||||
"create-map": "Create Map",
|
"create-map": "Create Map",
|
||||||
"map-viewer": "Map",
|
"map-viewer": "Map",
|
||||||
"pinned-note": "Pinned note",
|
"pinned-note": "Pinned note",
|
||||||
"item-sheet": "Item"
|
"documentation": "Documentation",
|
||||||
|
"item-sheet": "Item",
|
||||||
|
"icon-source": "Choose an icon",
|
||||||
|
"foundry-icons": "Foundry icons"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -49,6 +49,11 @@
|
|||||||
"rename": "Renombrar", "color": "Color", "default": "Por defecto", "delete": "Eliminar carpeta",
|
"rename": "Renombrar", "color": "Color", "default": "Por defecto", "delete": "Eliminar carpeta",
|
||||||
"move-to": "Mover a carpeta...", "root": "Raíz"
|
"move-to": "Mover a carpeta...", "root": "Raíz"
|
||||||
},
|
},
|
||||||
|
"foundry-import": {
|
||||||
|
"run": "Forzar importación desde Foundry",
|
||||||
|
"done": "Importado desde Foundry: {imported} nuevos, {updated} actualizados.",
|
||||||
|
"error": "No se ha podido importar desde el mundo de Foundry vinculado."
|
||||||
|
},
|
||||||
"states": {
|
"states": {
|
||||||
"loading": "Cargando...", "loading-notes": "Cargando notas...", "empty-notes": "Aún no hay notas en esta campaña.",
|
"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-actors": "Aún no hay actores ni personajes.", "empty-items": "Aún no hay objetos en esta campaña.",
|
||||||
@@ -65,14 +70,19 @@
|
|||||||
},
|
},
|
||||||
"item": {
|
"item": {
|
||||||
"new": "Nuevo objeto", "edit": "Editar objeto", "foundry-sync-note": "Los cambios en este objeto también se aplican al mundo de Foundry vinculado.",
|
"new": "Nuevo objeto", "edit": "Editar objeto", "foundry-sync-note": "Los cambios en este objeto también se aplican al mundo de Foundry vinculado.",
|
||||||
"category": "Categoría", "rarity": "Rareza", "quantity": "Cantidad",
|
"category": "Categoría", "rarity": "Rareza",
|
||||||
"quantity-short": "Cant.", "weight": "Peso (lb)", "properties": "Propiedades", "properties-placeholder": "Por ejemplo, versátil, sutil",
|
"weight": "Peso (lb)", "properties": "Propiedades", "properties-placeholder": "Por ejemplo, versátil, sutil",
|
||||||
"sheet": {
|
"sheet": {
|
||||||
"icon": "Icono del objeto", "choose-icon": "Elegir tu propio icono", "change-icon": "Cambiar icono",
|
"icon": "Icono del objeto", "choose-icon": "Elegir tu propio icono", "change-icon": "Cambiar icono",
|
||||||
"uploading": "Subiendo...", "upload-error": "No se pudo subir este icono.",
|
"uploading": "Subiendo...", "upload-error": "No se pudo subir este icono.",
|
||||||
"foundry-icon": "Usar el icono de Foundry", "remove-icon": "Quitar el icono", "save-error": "No se pudo guardar este objeto.",
|
"foundry-icon": "Usar el icono de Foundry", "remove-icon": "Quitar el icono", "save-error": "No se pudo guardar este objeto.",
|
||||||
"no-description": "Sin descripción añadida."
|
"no-description": "Sin descripción añadida."
|
||||||
},
|
},
|
||||||
|
"icon-picker": {
|
||||||
|
"intro": "¿De dónde debe salir el icono de este objeto?",
|
||||||
|
"upload": "Subir icono", "upload-hint": "Elige una imagen de este dispositivo.",
|
||||||
|
"foundry": "Cargar desde Foundry", "foundry-hint": "Recorre los iconos que incluye tu mundo de Foundry."
|
||||||
|
},
|
||||||
"categories": {
|
"categories": {
|
||||||
"weapon": "Arma", "armor": "Armadura", "shield": "Escudo", "adventuring-gear": "Equipo de aventura",
|
"weapon": "Arma", "armor": "Armadura", "shield": "Escudo", "adventuring-gear": "Equipo de aventura",
|
||||||
"magic-item": "Objeto mágico", "consumable": "Consumible", "tool": "Herramienta", "treasure": "Tesoro", "other": "Otro"
|
"magic-item": "Objeto mágico", "consumable": "Consumible", "tool": "Herramienta", "treasure": "Tesoro", "other": "Otro"
|
||||||
@@ -108,11 +118,24 @@
|
|||||||
"tabs": { "abilities": "Características", "inventory": "Inventario", "traits": "Rasgos", "spells": "Conjuros" },
|
"tabs": { "abilities": "Características", "inventory": "Inventario", "traits": "Rasgos", "spells": "Conjuros" },
|
||||||
"level": "Nivel", "species": "Especie", "unset-species": "Especie sin definir", "edit": "Editar hoja", "cancel": "Cancelar",
|
"level": "Nivel", "species": "Especie", "unset-species": "Especie sin definir", "edit": "Editar hoja", "cancel": "Cancelar",
|
||||||
"saving": "Guardando...", "save": "Guardar hoja", "save-error": "No se pudo guardar esta hoja de personaje.", "photo": "Foto", "upload-photo": "Subir foto", "change-photo": "Cambiar foto", "remove-photo": "Quitar foto", "uploading-photo": "Subiendo...", "photo-error": "No se pudo subir esta foto.", "ability-scores": "Características", "proficiency-bonus": "Bonificador por competencia",
|
"saving": "Guardando...", "save": "Guardar hoja", "save-error": "No se pudo guardar esta hoja de personaje.", "photo": "Foto", "upload-photo": "Subir foto", "change-photo": "Cambiar foto", "remove-photo": "Quitar foto", "uploading-photo": "Subiendo...", "photo-error": "No se pudo subir esta foto.", "ability-scores": "Características", "proficiency-bonus": "Bonificador por competencia",
|
||||||
"combat": "Combate", "armor-class": "Clase de armadura", "speed": "Velocidad", "proficiencies": "Competencias",
|
"combat": "Combate", "armor-class": "Clase de armadura", "speed": "Velocidad", "initiative": "Iniciativa",
|
||||||
"proficiencies-placeholder": "Añade salvaciones, habilidades, armaduras, armas, herramientas e idiomas...", "empty-proficiencies": "No hay competencias añadidas.",
|
"hit-points": "Puntos de golpe", "max-hit-points": "Puntos de golpe máximos", "hit-dice": "Dados de golpe", "max-hit-dice": "Dados de golpe máximos", "proficiencies": "Competencias",
|
||||||
|
"proficiencies-placeholder": "Añade armaduras, armas y cualquier otra competencia del personaje...", "empty-proficiencies": "No hay competencias añadidas.",
|
||||||
|
"saving-throws": "Tiradas de salvación", "skills": "Habilidades",
|
||||||
|
"abilities": { "str": "Fuerza", "dex": "Destreza", "con": "Constitución", "int": "Inteligencia", "wis": "Sabiduría", "cha": "Carisma" },
|
||||||
|
"skill-names": {
|
||||||
|
"acrobatics": "Acrobacias", "animalHandling": "Trato con animales", "arcana": "Arcano", "athletics": "Atletismo",
|
||||||
|
"deception": "Engaño", "history": "Historia", "insight": "Perspicacia", "intimidation": "Intimidación",
|
||||||
|
"investigation": "Investigación", "medicine": "Medicina", "nature": "Naturaleza", "perception": "Percepción",
|
||||||
|
"performance": "Interpretación", "persuasion": "Persuasión", "religion": "Religión", "sleightOfHand": "Manualidades",
|
||||||
|
"stealth": "Sigilo", "survival": "Supervivencia"
|
||||||
|
},
|
||||||
|
"tools": "Herramientas", "tools-placeholder": "Escribe las herramientas, una por línea...", "empty-tools": "Sin competencias con herramientas.",
|
||||||
|
"languages": "Idiomas", "languages-placeholder": "Escribe los idiomas, uno por línea...", "empty-languages": "Sin idiomas.",
|
||||||
"traits": "Rasgos", "traits-placeholder": "Añade rasgos, capacidades y otros detalles...", "empty-traits": "No hay rasgos añadidos.",
|
"traits": "Rasgos", "traits-placeholder": "Añade rasgos, capacidades y otros detalles...", "empty-traits": "No hay rasgos añadidos.",
|
||||||
"spells": "Conjuros", "spells-placeholder": "Escribe los conjuros, uno por línea...", "empty-spells": "No hay conjuros añadidos.",
|
"spells": "Conjuros", "spells-placeholder": "Escribe los conjuros, uno por línea...", "empty-spells": "No hay conjuros añadidos.",
|
||||||
"inventory": "Inventario", "add-item": "Añadir objeto", "carried-weight": "Peso transportado", "item-name": "Objeto",
|
"inventory": "Inventario", "add-item": "Añadir objeto", "carried-weight": "Peso transportado", "item-name": "Objeto",
|
||||||
"quantity": "Cant.", "weight-each": "Unidad (lb)", "total-weight": "Total (lb)", "actions": "Acciones", "empty-inventory": "El inventario está vacío."
|
"quantity": "Cant.", "weight-each": "Unidad (lb)", "total-weight": "Total (lb)", "actions": "Acciones", "empty-inventory": "El inventario está vacío.",
|
||||||
|
"currency": "Monedas", "currency-units": { "pp": "PP", "gp": "GP", "ep": "EP", "sp": "SP", "cp": "CP" }, "item-icon": "Icono"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
15
frontend/i18n/locales/es/docs.json
Normal file
15
frontend/i18n/locales/es/docs.json
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"title": "Documentación",
|
||||||
|
"contents": "Contenido",
|
||||||
|
"on-this-page": "En esta página",
|
||||||
|
"open-app": "Abrir Dragonroll",
|
||||||
|
"previous": "Anterior",
|
||||||
|
"next": "Siguiente",
|
||||||
|
"not-found": "No hay ninguna página de la documentación que se llame «{page}».",
|
||||||
|
"back-to-docs": "Volver a la documentación",
|
||||||
|
"groups": {
|
||||||
|
"getting-started": "Primeros pasos",
|
||||||
|
"using-dragonroll": "Usar Dragonroll",
|
||||||
|
"integrations": "Integraciones"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -3,6 +3,18 @@
|
|||||||
"link-expired": "El código de vinculación de Foundry no es válido, ha caducado o ya se ha usado.",
|
"link-expired": "El código de vinculación de Foundry no es válido, ha caducado o ya se ha usado.",
|
||||||
"world-already-linked": "Este mundo de Foundry ya está vinculado a otra campaña.",
|
"world-already-linked": "Este mundo de Foundry ya está vinculado a otra campaña.",
|
||||||
"actor-already-synced": "Otro actor de esta campaña ya está sincronizado con ese actor de Foundry.",
|
"actor-already-synced": "Otro actor de esta campaña ya está sincronizado con ese actor de Foundry.",
|
||||||
"item-already-synced": "Otro objeto de esta campaña ya está sincronizado con ese objeto de Foundry."
|
"item-already-synced": "Otro objeto de esta campaña ya está sincronizado con ese objeto de Foundry.",
|
||||||
|
"icons-unavailable": "Los iconos de Foundry no están disponibles: su bridge no está configurado o no es accesible ahora.",
|
||||||
|
"icons-no-world-url": "Esta campaña no tiene dirección del mundo de Foundry. Defínala en los ajustes de la campaña, en la pestaña de integraciones.",
|
||||||
|
"import-not-linked": "Esta campaña no tiene ningún mundo de Foundry vinculado. Conecte uno en los ajustes de la campaña, en la pestaña de integraciones.",
|
||||||
|
"import-unavailable": "Los datos de Foundry no están disponibles: su bridge no está configurado, no es accesible ahora o su mundo todavía no ha publicado nada.",
|
||||||
|
"import-world-mismatch": "El bridge de Foundry está mostrando un mundo distinto del que esta campaña tiene vinculado."
|
||||||
|
},
|
||||||
|
"icons": {
|
||||||
|
"path": "Carpeta de iconos",
|
||||||
|
"up": "Una carpeta arriba",
|
||||||
|
"loading": "Cargando iconos...",
|
||||||
|
"empty": "No hay iconos para elegir en esta carpeta.",
|
||||||
|
"load-more": "Cargar más iconos"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
"main-menu": "Menú principal",
|
"main-menu": "Menú principal",
|
||||||
"edit-profile": "Editar perfil",
|
"edit-profile": "Editar perfil",
|
||||||
"create-campaign": "Crear campanya",
|
"create-campaign": "Crear campanya",
|
||||||
|
"documentation": "Documentación",
|
||||||
"log-out": "Cerrar sesión",
|
"log-out": "Cerrar sesión",
|
||||||
"settings": "Configuración",
|
"settings": "Configuración",
|
||||||
"exit": "Salir"
|
"exit": "Salir"
|
||||||
|
|||||||
@@ -10,5 +10,8 @@
|
|||||||
"create-map": "Crear mapa",
|
"create-map": "Crear mapa",
|
||||||
"map-viewer": "Mapa",
|
"map-viewer": "Mapa",
|
||||||
"pinned-note": "Nota fijada",
|
"pinned-note": "Nota fijada",
|
||||||
"item-sheet": "Objeto"
|
"documentation": "Documentación",
|
||||||
|
"item-sheet": "Objeto",
|
||||||
|
"icon-source": "Elegir icono",
|
||||||
|
"foundry-icons": "Iconos de Foundry"
|
||||||
}
|
}
|
||||||
|
|||||||
604
tests/character-sheet-details.test.js
Normal file
604
tests/character-sheet-details.test.js
Normal file
@@ -0,0 +1,604 @@
|
|||||||
|
// Tests for Syndria98/dragonroll#83, the things the character sheet did not hold:
|
||||||
|
// * the eighteen skills down the ability scores tab, each with a circle that stands lit
|
||||||
|
// when the character is proficient with it, and the six saving throws beside them,
|
||||||
|
// * proficiencies with tools and with languages,
|
||||||
|
// * the coins a character carries and the icon of each item it carries,
|
||||||
|
// * and traits that reach the campaign from the linked Foundry world.
|
||||||
|
//
|
||||||
|
// The window is a `.vue` file and the repository root installs no dependencies for it, so
|
||||||
|
// its template, styles and plain functions are read out of the source the way
|
||||||
|
// tests/character-sheet-tabs.test.js and tests/character-sheet-portrait-column.test.js
|
||||||
|
// read them. The Foundry mapper is plain CommonJS and is required for real; the actor
|
||||||
|
// route runs in a stubbed `require` against fake models, like tests/foundry-force-import.test.js.
|
||||||
|
// The Foundry module goes into a `node:vm` context with stubbed globals, like
|
||||||
|
// tests/foundry-sync-toggle.test.js, so what its actor snapshot carries is observable.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
const MODULE_ID = "dragonroll-foundry";
|
||||||
|
|
||||||
|
const sheetSource = read("frontend", "app", "components", "windows", "CharacterSheetWindow.vue");
|
||||||
|
const script = /<script setup>([\s\S]*?)<\/script>/.exec(sheetSource)?.[1] ?? "";
|
||||||
|
const template = /<template>([\s\S]*)<\/template>/.exec(sheetSource)?.[1] ?? "";
|
||||||
|
const actorModelSource = read("backend", "src", "models", "Actor.js");
|
||||||
|
|
||||||
|
// `fromSource` hands back one top-level declaration as a value, like the other character
|
||||||
|
// sheet tests do it.
|
||||||
|
function fromSource(source, pattern, locals = {}) {
|
||||||
|
const declaration = pattern.exec(source)?.[0];
|
||||||
|
assert.ok(declaration, `expected ${pattern} in the source`);
|
||||||
|
const name = /(?:const|function)\s+(\w+)/.exec(declaration)[1];
|
||||||
|
return new Function(...Object.keys(locals), `${declaration}\n;return ${name};`)(...Object.values(locals));
|
||||||
|
}
|
||||||
|
|
||||||
|
const abilityStats = fromSource(script, /const abilityStats = \[[\s\S]*?\];/);
|
||||||
|
const skillList = fromSource(script, /const skillList = \[[\s\S]*?\];/);
|
||||||
|
const currencyUnits = fromSource(script, /const currencyUnits = \[[\s\S]*?\];/);
|
||||||
|
const proficiencyText = fromSource(script, /function proficiencyText\(value\) \{[\s\S]*?\n\}/);
|
||||||
|
const proficiencyList = fromSource(script, /function proficiencyList\(text\) \{[\s\S]*?\n\}/);
|
||||||
|
const normalizeActor = fromSource(script, /function normalizeActor\(actor\) \{[\s\S]*?\n\}/, {
|
||||||
|
abilityStats, skillList, currencyUnits, proficiencyText
|
||||||
|
});
|
||||||
|
|
||||||
|
const skillKeys = skillList.map(({ key }) => key);
|
||||||
|
|
||||||
|
// --- The sheet: skills and saving throws on the ability scores tab -----------------
|
||||||
|
|
||||||
|
test("the sheet knows the eighteen skills, each under the ability that manages it", () => {
|
||||||
|
assert.deepEqual(skillKeys, [
|
||||||
|
"acrobatics", "animalHandling", "arcana", "athletics", "deception", "history", "insight",
|
||||||
|
"intimidation", "investigation", "medicine", "nature", "perception", "performance",
|
||||||
|
"persuasion", "religion", "sleightOfHand", "stealth", "survival"
|
||||||
|
]);
|
||||||
|
assert.deepEqual(
|
||||||
|
skillList.map(({ ability }) => ability),
|
||||||
|
["dex", "wis", "int", "str", "cha", "int", "wis", "cha", "int", "wis", "int", "wis", "cha", "cha", "int", "dex", "dex", "wis"],
|
||||||
|
"each skill stands with the ability D&D counts for it"
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every skill stands with a circle that toggles whether the character is proficient", () => {
|
||||||
|
const panel = /<section class="sheet-panel skills-panel">([\s\S]*?)<\/section>/.exec(template)?.[1] ?? "";
|
||||||
|
assert.match(panel, /campaigns\.character-sheet\.skills/, "the panel is named for the skills");
|
||||||
|
assert.match(panel, /v-for="skill in skillList"/);
|
||||||
|
assert.match(panel, /:aria-checked="form\.skills\[skill\.key\]"/, "the circle says what it holds");
|
||||||
|
assert.match(panel, /@click="toggleProficiency\('skills', skill\.key\)"/);
|
||||||
|
assert.match(panel, /class="proficiency-dot"/);
|
||||||
|
assert.match(panel, /\{ proficient: form\.skills\[skill\.key\] \}/, "the circle stands lit for a proficiency");
|
||||||
|
assert.match(panel, /campaigns\.character-sheet\.skill-names\.\$\{skill\.key\}/, "the skill is called by its name");
|
||||||
|
assert.match(panel, /\{\{ skillModifier\(skill\) \}\}/, "and it shows the modifier the character rolls with it");
|
||||||
|
|
||||||
|
const toggle = /function toggleProficiency\(group, key\) \{[\s\S]*?\n\}/.exec(script)?.[0];
|
||||||
|
assert.match(toggle, /form\.value\[group\]\[key\] = !form\.value\[group\]\[key\]/, "the circle flips the toggle");
|
||||||
|
// The toggles belong to an edit in progress, like every other field of the sheet.
|
||||||
|
assert.match(panel, /:disabled="!editing"/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the six saving throws ride with the ability scores", () => {
|
||||||
|
const abilities = /<section class="sheet-panel abilities-panel">([\s\S]*?)<\/section>/.exec(template)?.[1] ?? "";
|
||||||
|
assert.match(abilities, /campaigns\.character-sheet\.saving-throws/);
|
||||||
|
assert.match(abilities, /v-for="stat in abilityStats"/, "one save per ability score");
|
||||||
|
assert.match(abilities, /:aria-checked="form\.savingThrows\[stat\.key\]"/);
|
||||||
|
assert.match(abilities, /@click="toggleProficiency\('savingThrows', stat\.key\)"/);
|
||||||
|
assert.match(abilities, /\{\{ savingThrowModifier\(stat\) \}\}/);
|
||||||
|
// The ability scores themselves are untouched, and the saves stand under them.
|
||||||
|
assert.match(abilities, /v-model\.number="form\.abilityScores\[stat\.key\]"/);
|
||||||
|
assert.ok(
|
||||||
|
abilities.indexOf("ability-grid") < abilities.indexOf("saving-throw-grid"),
|
||||||
|
"the saving throws follow the scores they come from"
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a skill's form entry starts off, and the world's toggles carry over", () => {
|
||||||
|
const fresh = normalizeActor({});
|
||||||
|
assert.deepEqual(fresh.skills.acrobatics, false);
|
||||||
|
assert.deepEqual(fresh.savingThrows.str, false);
|
||||||
|
assert.deepEqual(Object.keys(fresh.skills).length, 18, "every skill stands in the form, toggled or not");
|
||||||
|
assert.deepEqual(Object.keys(fresh.savingThrows).sort(), ["cha", "con", "dex", "int", "str", "wis"]);
|
||||||
|
|
||||||
|
const trained = normalizeActor({ skills: { stealth: true }, savingThrows: { con: true } });
|
||||||
|
assert.equal(trained.skills.stealth, true);
|
||||||
|
assert.equal(trained.savingThrows.con, true);
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- Tools and languages ----------------------------------------------------------
|
||||||
|
|
||||||
|
test("tools and languages have a list of their own under the proficiencies", () => {
|
||||||
|
const panel = /<section class="sheet-panel proficiencies-panel">([\s\S]*?)<\/section>/.exec(template)?.[1] ?? "";
|
||||||
|
for (const [key, field] of [["tools", "form.tools"], ["languages", "form.languages"]]) {
|
||||||
|
assert.match(panel, new RegExp(`campaigns\\.character-sheet\\.${key}`), `the ${key} are named`);
|
||||||
|
assert.match(panel, new RegExp(`v-model="${field}"`), `the ${key} are edited as text`);
|
||||||
|
assert.match(panel, new RegExp(`\\{\\{ ${field} \\|\\| \\$t\\('campaigns\\.character-sheet\\.empty-${key}'\\) \\}\\}`));
|
||||||
|
}
|
||||||
|
// The free text keeps what has no list of its own, so it no longer asks for these.
|
||||||
|
const placeholder = /"proficiencies-placeholder": "([^"]+)"/.exec(read("frontend", "i18n", "locales", "en", "campaigns.json"))[1];
|
||||||
|
assert.doesNotMatch(placeholder, /skills|saving throws|tools|languages/i, "the text field does not ask for what has its own list");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the tools and languages lists travel as a list and edit as one name per line", () => {
|
||||||
|
assert.deepEqual(normalizeActor({ tools: ["Thieves tools", "Dice set"] }).tools, "Thieves tools\nDice set");
|
||||||
|
assert.deepEqual(normalizeActor({ languages: [] }).languages, "");
|
||||||
|
assert.deepEqual(
|
||||||
|
normalizeActor({ tools: [" Thieves tools ", "Thieves tools", "", "Dice set"] }).tools,
|
||||||
|
"Thieves tools\nDice set",
|
||||||
|
"blanks, spaces and repeats are not kept"
|
||||||
|
);
|
||||||
|
assert.deepEqual(proficiencyList("Thieves tools\nDice set"), ["Thieves tools", "Dice set"]);
|
||||||
|
assert.deepEqual(proficiencyList("Common, Elvish, Common"), ["Common", "Elvish"], "a comma separates too");
|
||||||
|
assert.deepEqual(proficiencyList(""), []);
|
||||||
|
assert.deepEqual(proficiencyList(proficiencyText(["Cartographer's supplies"])), ["Cartographer's supplies"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- Currency and item icons on the inventory tab ---------------------------------
|
||||||
|
|
||||||
|
test("the inventory shows the coins the character carries", () => {
|
||||||
|
assert.deepEqual(currencyUnits, ["pp", "gp", "ep", "sp", "cp"]);
|
||||||
|
const panel = /<main v-show="activeTab === 'inventory'"[\s\S]*?<\/main>/.exec(template)?.[0] ?? "";
|
||||||
|
assert.match(panel, /campaigns\.character-sheet\.currency/);
|
||||||
|
assert.match(panel, /v-for="unit in currencyUnits"/);
|
||||||
|
assert.match(panel, /v-model\.number="form\.currency\[unit\]"/, "each coin can be counted in");
|
||||||
|
assert.match(panel, /\{\{ form\.currency\[unit\] \}\}/, "and reads back outside of editing");
|
||||||
|
|
||||||
|
assert.deepEqual(normalizeActor({}).currency, { pp: 0, gp: 0, ep: 0, sp: 0, cp: 0 });
|
||||||
|
assert.deepEqual(normalizeActor({ currency: { gp: 12, cp: "40" } }).currency, { pp: 0, gp: 12, ep: 0, sp: 0, cp: 40 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every inventory row opens with the item's icon", () => {
|
||||||
|
const panel = /<main v-show="activeTab === 'inventory'"[\s\S]*?<\/main>/.exec(template)?.[0] ?? "";
|
||||||
|
const iconCell = /<td class="item-icon-cell">([\s\S]*?)<\/td>/.exec(panel)?.[1] ?? "";
|
||||||
|
assert.match(iconCell, /v-if="item\.icon"/);
|
||||||
|
assert.match(iconCell, /:src="resolveImage\(item\.icon\)"/, "a world's own icon and an upload both resolve");
|
||||||
|
assert.match(iconCell, /item-icon-blank/, "and a row without one leaves the place marked");
|
||||||
|
|
||||||
|
// The icon comes first, and the name it stands in front of keeps reading left.
|
||||||
|
const firstCells = /<tr v-for="\(item, index\) in form\.inventory" :key="index">([\s\S]*?)<\/td>\s*([\s\S]*?)<\/td>/.exec(panel);
|
||||||
|
assert.match(firstCells[1], /item-icon-cell/);
|
||||||
|
assert.match(firstCells[2], /item-name-cell/);
|
||||||
|
const aligns = /\.inventory-table th:not\(:first-child\):not\(\.item-name-cell\)/.exec(sheetSource)?.[0];
|
||||||
|
assert.ok(aligns, "the name column is let go of the centred columns");
|
||||||
|
|
||||||
|
assert.equal(normalizeActor({ inventory: [{ name: "Torch" }] }).inventory[0].icon, "");
|
||||||
|
assert.equal(
|
||||||
|
normalizeActor({ inventory: [{ name: "Torch", icon: "http://vtt.test/icons/torch.svg" }] }).inventory[0].icon,
|
||||||
|
"http://vtt.test/icons/torch.svg"
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The model and the route ------------------------------------------------------
|
||||||
|
|
||||||
|
test("the Actor model holds the skills, the saves, the tools, the languages and the coins", () => {
|
||||||
|
for (const key of skillKeys) {
|
||||||
|
assert.match(actorModelSource, new RegExp(`${key}: \\{ type: Boolean, default: false \\}`), `${key} is a toggle`);
|
||||||
|
}
|
||||||
|
for (const key of ["str", "dex", "con", "int", "wis", "cha"]) {
|
||||||
|
assert.ok(
|
||||||
|
new RegExp(`savingThrows: \\{[\\s\\S]*?${key}: \\{ type: Boolean, default: false \\}`).test(actorModelSource),
|
||||||
|
`the ${key} saving throw stands in the model`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
assert.match(actorModelSource, /tools: \[\{ type: String, trim: true \}\]/);
|
||||||
|
assert.match(actorModelSource, /languages: \[\{ type: String, trim: true \}\]/);
|
||||||
|
for (const unit of currencyUnits) {
|
||||||
|
assert.ok(
|
||||||
|
new RegExp(`currency: \\{[\\s\\S]*?${unit}: \\{ type: Number, min: 0, default: 0 \\}`).test(actorModelSource),
|
||||||
|
`${unit} counts among the coins`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
assert.match(actorModelSource, /icon: \{ type: String, default: '' \}/, "a carried item keeps its icon");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The actor update route with every require stubbed, the way
|
||||||
|
// tests/foundry-force-import.test.js runs the import route.
|
||||||
|
function loadActorRoute(actor) {
|
||||||
|
const routes = new Map();
|
||||||
|
const router = {
|
||||||
|
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||||
|
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||||
|
};
|
||||||
|
const requireStub = (id) => {
|
||||||
|
if (id === "express") return { Router: () => router };
|
||||||
|
if (id === "../services/storage") return { single: () => (req, res, next) => next() };
|
||||||
|
if (id === "../models/Campaign") {
|
||||||
|
return { findOne: () => ({ lean: () => Promise.resolve({ _id: "campaign-1" }) }) };
|
||||||
|
}
|
||||||
|
if (id === "../models/Actor") return { findById: async () => actor };
|
||||||
|
if (id === "../models/Folder") return { belongsToSection: async () => true };
|
||||||
|
if (id === "../models/Map") return { updateMany: async () => ({}) };
|
||||||
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
|
};
|
||||||
|
|
||||||
|
const moduleStub = { exports: {} };
|
||||||
|
vm.compileFunction(read("backend", "src", "routes", "actor.js"), ["require", "module", "exports"])(
|
||||||
|
requireStub, moduleStub, moduleStub.exports
|
||||||
|
);
|
||||||
|
|
||||||
|
async function update(body, user = { id: "user-1" }) {
|
||||||
|
const handlers = routes.get("POST /update");
|
||||||
|
assert.ok(handlers, "POST /update is not mounted");
|
||||||
|
let payload = null;
|
||||||
|
await handlers[handlers.length - 1]({ body, user }, { json: (sent) => { payload = sent; } });
|
||||||
|
return payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { update };
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the actor update writes the skills, the saves, the tools, the languages and the coins", async () => {
|
||||||
|
const actor = { _id: "actor-1", campaign: "campaign-1", save: async () => {} };
|
||||||
|
const route = loadActorRoute(actor);
|
||||||
|
|
||||||
|
const response = await route.update({
|
||||||
|
id: "actor-1",
|
||||||
|
skills: { acrobatics: true, stealth: false },
|
||||||
|
savingThrows: { con: true },
|
||||||
|
tools: [" Thieves tools ", "Thieves tools", "", "Dice set"],
|
||||||
|
languages: ["Elvish", "Undercommon"],
|
||||||
|
currency: { gp: 12, cp: 40 },
|
||||||
|
inventory: [{ name: "Torch", quantity: 2, weight: 0.5, icon: "icons/torch.svg" }],
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.deepEqual(actor.skills, { acrobatics: true, stealth: false });
|
||||||
|
assert.deepEqual(actor.savingThrows, { con: true });
|
||||||
|
assert.deepEqual(actor.tools, ["Thieves tools", "Dice set"], "blanks and repeats are written out of the lists");
|
||||||
|
assert.deepEqual(actor.languages, ["Elvish", "Undercommon"]);
|
||||||
|
assert.deepEqual(actor.currency, { gp: 12, cp: 40 });
|
||||||
|
assert.deepEqual(actor.inventory, [{ name: "Torch", quantity: 2, weight: 0.5, icon: "icons/torch.svg" }]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an update that says nothing about them leaves the toggles and lists where they are", async () => {
|
||||||
|
const actor = {
|
||||||
|
_id: "actor-1",
|
||||||
|
campaign: "campaign-1",
|
||||||
|
skills: { acrobatics: true },
|
||||||
|
tools: ["Disguise kit"],
|
||||||
|
currency: { gp: 3 },
|
||||||
|
save: async () => {},
|
||||||
|
};
|
||||||
|
const route = loadActorRoute(actor);
|
||||||
|
|
||||||
|
const response = await route.update({ id: "actor-1", name: "Thalia" });
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.equal(actor.name, "Thalia");
|
||||||
|
assert.deepEqual(actor.skills, { acrobatics: true });
|
||||||
|
assert.deepEqual(actor.tools, ["Disguise kit"]);
|
||||||
|
assert.deepEqual(actor.currency, { gp: 3 });
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The Foundry world fills them in ---------------------------------------------
|
||||||
|
|
||||||
|
const { foundryActorToCharacter } = require(path.join(__dirname, "..", "backend", "src", "services", "actor-foundry.js"));
|
||||||
|
|
||||||
|
test("a world's skill and saving throw proficiencies arrive toggled", () => {
|
||||||
|
const character = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
system: {
|
||||||
|
skills: { acr: { value: 1 }, stl: { value: 0 }, prc: { value: 2 }, arc: { value: ["exp"] }, his: { value: [] } },
|
||||||
|
savingThrows: { str: { value: 1 }, dex: { value: 0 }, con: { prof: { value: 2 } } },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(character.skills, {
|
||||||
|
acrobatics: true, stealth: false, arcana: true, history: false, perception: true,
|
||||||
|
});
|
||||||
|
assert.deepEqual(character.savingThrows, { str: true, dex: false, con: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an older world holding its saves under the abilities is read the same way", () => {
|
||||||
|
const character = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
system: { abilities: { str: { save: 0 }, dex: { save: 1 } }, saves: { con: { proficient: true } } },
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(character.savingThrows, { str: false, dex: true, con: true });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a world that says nothing about skills or saves leaves what the campaign toggled", () => {
|
||||||
|
const character = foundryActorToCharacter({ name: "Thalia", system: { abilities: { str: { value: 16 } } } });
|
||||||
|
|
||||||
|
assert.ok(!("skills" in character), "no skills to report is not the same as none proficient");
|
||||||
|
assert.ok(!("savingThrows" in character));
|
||||||
|
assert.ok(!("currency" in character));
|
||||||
|
assert.ok(!("tools" in character), "and neither are the tool and language lists");
|
||||||
|
assert.ok(!("languages" in character));
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the tools and languages the module names come over as they are named", () => {
|
||||||
|
const character = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
system: { traits: { tool: { value: ["xyz12abc345def67"] }, languages: { value: ["aB3cD9eF1gH2iJ4k"] } } },
|
||||||
|
dragonroll: { tools: ["Thieves' tools", "Dice set"], languages: ["Elvish", "Deep Speech"] },
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(character.tools, ["Thieves' tools", "Dice set"]);
|
||||||
|
assert.deepEqual(character.languages, ["Elvish", "Deep Speech"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("without the module's names the proficiency keys are read off the actor", () => {
|
||||||
|
const character = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
system: {
|
||||||
|
traits: {
|
||||||
|
tool: { value: ["thieves", "alchemist"], custom: "Dice set, Playing cards" },
|
||||||
|
languages: { value: ["common", "aB3cD9eF1gH2iJ4k"], custom: "Thieves' cant" },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(character.tools, ["thieves", "alchemist", "Dice set", "Playing cards"]);
|
||||||
|
assert.deepEqual(
|
||||||
|
character.languages,
|
||||||
|
["common", "Thieves' cant"],
|
||||||
|
"a language the sheet cannot name is dropped rather than shown as a document id"
|
||||||
|
);
|
||||||
|
|
||||||
|
const none = foundryActorToCharacter({ name: "Thalia", system: { traits: { tool: { value: [] } } } });
|
||||||
|
assert.deepEqual(none.tools, [], "a world with no tool proficiency says so");
|
||||||
|
assert.ok(!("languages" in none), "and says nothing at all about the ones it does not list");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the coins of the world are the coins of the campaign", () => {
|
||||||
|
const character = foundryActorToCharacter({ name: "Thalia", system: { currency: { pp: 1, gp: 25, sp: -3 } } });
|
||||||
|
|
||||||
|
assert.deepEqual(character.currency, { pp: 1, gp: 25, ep: 0, sp: 0, cp: 0 }, "and never a debt");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a carried item brings its own icon", () => {
|
||||||
|
const character = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
items: [
|
||||||
|
{ name: "Longsword", type: "weapon", img: "http://vtt.test/icons/sword.svg", system: { quantity: 1, weight: { value: 3 } } },
|
||||||
|
{ name: "Rope", type: "equipment", system: { quantity: 2 } },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(character.inventory, [
|
||||||
|
{ name: "Longsword", quantity: 1, weight: 3, icon: "http://vtt.test/icons/sword.svg" },
|
||||||
|
{ name: "Rope", quantity: 2, weight: 0, icon: "" },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The traits tab syncs --------------------------------------------------------
|
||||||
|
|
||||||
|
test("the world's own traits reach the campaign", () => {
|
||||||
|
const fromText = foundryActorToCharacter({ name: "Thalia", system: { details: { trait: "Spellcaster.<br>Light sleeper." } } });
|
||||||
|
assert.equal(fromText.traits, "Spellcaster.\nLight sleeper.");
|
||||||
|
|
||||||
|
const fromFeatures = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
system: {},
|
||||||
|
items: [
|
||||||
|
{ name: "Darkvision", type: "feat", system: { featType: "trs", description: { value: "<p>See in the dark.</p>" } } },
|
||||||
|
{ name: "Brave", type: "feat", system: { featType: ["tr"], description: { value: "Advantage on saves." } } },
|
||||||
|
{ name: "Alert", type: "feat", system: { featType: "feat", description: { value: "Never surprised." } } },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
assert.equal(fromFeatures.traits, "Darkvision\nSee in the dark.\n\nBrave\nAdvantage on saves.");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the world leads the traits tab, and what the campaign wrote fills in when it has none", () => {
|
||||||
|
// The module carries whatever the campaign shows for the traits back to the world on
|
||||||
|
// its flag, and the actor's own traits lead from there: a world keeps its traits in
|
||||||
|
// step the same way it keeps its proficiencies in step, while a character the world
|
||||||
|
// says nothing about keeps what the campaign wrote for it.
|
||||||
|
const fromWorld = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
system: { details: { trait: "The world's own traits" } },
|
||||||
|
flags: { [MODULE_ID]: { traits: "What the campaign typed" } },
|
||||||
|
});
|
||||||
|
assert.equal(fromWorld.traits, "The world's own traits");
|
||||||
|
|
||||||
|
const fromCampaign = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
system: {},
|
||||||
|
flags: { [MODULE_ID]: { traits: "What the campaign typed" } },
|
||||||
|
});
|
||||||
|
assert.equal(fromCampaign.traits, "What the campaign typed");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an actor that holds no traits does not clear what the campaign has", () => {
|
||||||
|
const character = foundryActorToCharacter({ name: "Thalia", system: {}, items: [], flags: {} });
|
||||||
|
|
||||||
|
assert.ok(!("traits" in character), "a live edit that knows nothing about traits leaves the tab as it is");
|
||||||
|
});
|
||||||
|
|
||||||
|
// A forced actor sync from the module's context menu replaces everything the campaign
|
||||||
|
// holds for that actor (Syndria98/dragonroll#96): the fields a live edit leaves out when
|
||||||
|
// the world says nothing are written empty instead of kept, and the campaign's own text
|
||||||
|
// on the actor's flag does not survive it.
|
||||||
|
test("a forced sync writes empty the fields a live edit would leave out", () => {
|
||||||
|
const actor = {
|
||||||
|
name: "Thalia",
|
||||||
|
system: {},
|
||||||
|
items: [],
|
||||||
|
flags: { [MODULE_ID]: { traits: "What the campaign typed", proficiencies: "Armour, tools" } },
|
||||||
|
};
|
||||||
|
|
||||||
|
const live = foundryActorToCharacter(actor);
|
||||||
|
assert.equal(live.traits, "What the campaign typed", "a live edit fills the traits tab from the actor's flag");
|
||||||
|
assert.equal(live.proficiencies, "Armour, tools", "and the free-text proficiencies from it too");
|
||||||
|
assert.ok(
|
||||||
|
!("tools" in live) && !("languages" in live) && !("skills" in live) && !("savingThrows" in live) && !("currency" in live),
|
||||||
|
"and says nothing about the toggles and lists the world has no data for"
|
||||||
|
);
|
||||||
|
|
||||||
|
const replaced = foundryActorToCharacter(actor, true);
|
||||||
|
assert.equal(replaced.traits, "", "a forced sync clears the traits the campaign typed");
|
||||||
|
assert.equal(replaced.proficiencies, "", "down to the free-text proficiencies");
|
||||||
|
assert.deepEqual(replaced.tools, []);
|
||||||
|
assert.deepEqual(replaced.languages, []);
|
||||||
|
assert.deepEqual(replaced.skills, {});
|
||||||
|
assert.deepEqual(replaced.savingThrows, {});
|
||||||
|
assert.deepEqual(replaced.currency, {});
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The module sends the names a sheet outside Foundry can read -----------------
|
||||||
|
|
||||||
|
function makeWorld({ actor, config = {}, worldItems = [] }) {
|
||||||
|
const state = { hooks: new Map(), requests: [], timers: new Map(), nextTimerId: 1 };
|
||||||
|
const documents = [actor];
|
||||||
|
const settingsStore = { autoSync: true, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
|
||||||
|
|
||||||
|
const sandbox = {
|
||||||
|
console: { log() {}, info() {}, warn() {}, error() {} },
|
||||||
|
URL,
|
||||||
|
CONFIG: config,
|
||||||
|
window: { location: { origin: "http://vtt.test" } },
|
||||||
|
ui: { notifications: { info() {}, warn() {}, error() {} } },
|
||||||
|
Hooks: {
|
||||||
|
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||||
|
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
|
||||||
|
},
|
||||||
|
setTimeout: (fn) => { const id = state.nextTimerId++; state.timers.set(id, { fn }); return id; },
|
||||||
|
clearTimeout: (id) => state.timers.delete(id),
|
||||||
|
setInterval: () => 0,
|
||||||
|
clearInterval: () => {},
|
||||||
|
fetch: async (url, options = {}) => {
|
||||||
|
state.requests.push({ href: String(url), 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: documents, get: (id) => documents.find((document) => document.id === id) },
|
||||||
|
items: { contents: worldItems, get: (id) => worldItems.find((document) => document.id === id) },
|
||||||
|
folders: { contents: [], get: () => null },
|
||||||
|
settings: {
|
||||||
|
register(module, key, definition) {
|
||||||
|
if (!(key in settingsStore)) settingsStore[key] = definition.default;
|
||||||
|
},
|
||||||
|
get(module, key) { return settingsStore[key]; },
|
||||||
|
async set(module, key, value) { settingsStore[key] = value; },
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
vm.createContext(sandbox);
|
||||||
|
vm.runInContext(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||||
|
|
||||||
|
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||||
|
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) {
|
||||||
|
const due = [...state.timers.values()];
|
||||||
|
state.timers.clear();
|
||||||
|
for (const timer of due) await timer.fn();
|
||||||
|
await drain();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
// Only the pushes of an actor count here: the world start sends one, and what an
|
||||||
|
// actor changed sends the next.
|
||||||
|
state.actorPushes = () => state.requests
|
||||||
|
.filter((request) => request.href.includes("foundry/sync/snapshot"))
|
||||||
|
.map((request) => request.body.actors[0]);
|
||||||
|
|
||||||
|
return state;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeStubActor(id, name, system = {}, items = []) {
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
name,
|
||||||
|
type: "character",
|
||||||
|
documentName: "Actor",
|
||||||
|
img: "icons/svg/mystery-man.svg",
|
||||||
|
system,
|
||||||
|
flags: {},
|
||||||
|
items: { contents: items },
|
||||||
|
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||||
|
async update(data) { return data; },
|
||||||
|
toObject() { return { _id: this.id, name: this.name, type: this.type, img: this.img, flags: this.flags, system: this.system }; },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// A world document of its own — a language since the third release of the system —
|
||||||
|
// plain enough to serialize like any other item of the world.
|
||||||
|
function makeWorldItem(id, name) {
|
||||||
|
return {
|
||||||
|
id,
|
||||||
|
name,
|
||||||
|
type: "loot",
|
||||||
|
documentName: "Item",
|
||||||
|
parent: null,
|
||||||
|
folder: null,
|
||||||
|
flags: {},
|
||||||
|
system: {},
|
||||||
|
getFlag() { return undefined; },
|
||||||
|
toObject() { return { _id: this.id, name: this.name, type: this.type, flags: this.flags, system: this.system }; },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
async function pushAfterEdit(actor, options) {
|
||||||
|
const world = makeWorld(options);
|
||||||
|
await world.fire("init");
|
||||||
|
await world.fire("ready");
|
||||||
|
await world.runTimers();
|
||||||
|
await world.fire("updateActor", actor);
|
||||||
|
await world.runTimers();
|
||||||
|
return world.actorPushes().at(-1);
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the actor snapshot names the world's tools and languages", async () => {
|
||||||
|
const actor = makeStubActor("actor-1", "Thalia", {
|
||||||
|
traits: {
|
||||||
|
tool: { value: ["thieves"], custom: "Dice set" },
|
||||||
|
languages: { value: ["common", "lang-1"] },
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const sent = await pushAfterEdit(actor, {
|
||||||
|
config: {
|
||||||
|
DND5E: {
|
||||||
|
tools: { thieves: { label: "Thieves' tools" } },
|
||||||
|
languages: { common: { name: "Common" } },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
worldItems: [makeWorldItem("lang-1", "Deep Speech")],
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(sent._id, "actor-1", "the actor the world edited is the one that was sent");
|
||||||
|
assert.deepEqual(sent.dragonroll.tools, ["Thieves' tools", "Dice set"]);
|
||||||
|
assert.deepEqual(sent.dragonroll.languages, ["Common", "Deep Speech"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an actor listing no tools or languages says nothing about them", async () => {
|
||||||
|
const actor = makeStubActor("actor-1", "Grunt", { details: { level: 1 } });
|
||||||
|
|
||||||
|
const sent = await pushAfterEdit(actor, { config: { DND5E: { tools: { thieves: { label: "Thieves' tools" } } } } });
|
||||||
|
|
||||||
|
assert.equal(sent.dragonroll, undefined, "no dragonroll block is what tells the campaign nothing was said");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- Every locale says it ------------------------------------------------------
|
||||||
|
|
||||||
|
test("every locale names the skills, the saving throws, the tools, the languages and the coins", () => {
|
||||||
|
for (const locale of ["en", "es", "ca"]) {
|
||||||
|
const sheet = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"))["character-sheet"];
|
||||||
|
for (const key of ["skills", "saving-throws", "tools", "languages", "currency", "item-icon"]) {
|
||||||
|
assert.ok(sheet[key], `${locale} is missing campaigns.character-sheet.${key}`);
|
||||||
|
}
|
||||||
|
for (const [group, keys] of [["abilities", ["str", "dex", "con", "int", "wis", "cha"]], ["skill-names", skillKeys], ["currency-units", currencyUnits]]) {
|
||||||
|
for (const key of keys) {
|
||||||
|
assert.ok(sheet[group]?.[key], `${locale} is missing campaigns.character-sheet.${group}.${key}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assert.deepEqual(Object.keys(sheet["skill-names"]).sort(), [...skillKeys].sort(), `${locale} names every skill the sheet lists`);
|
||||||
|
assert.notEqual(sheet["skill-names"].acrobatics, "acrobatics", `${locale} spells the skill out, not its key`);
|
||||||
|
}
|
||||||
|
});
|
||||||
111
tests/character-sheet-persistent-column.test.js
Normal file
111
tests/character-sheet-persistent-column.test.js
Normal file
@@ -0,0 +1,111 @@
|
|||||||
|
// Tests for Syndria98/dragonroll#91: the column that opens the character sheet — the portrait with
|
||||||
|
// the armor class, the speed, the bonuses and both pools under it — stays on screen whoever's tab is
|
||||||
|
// open, instead of being the ability scores tab's own content and disappearing when the sheet moves
|
||||||
|
// to the inventory, the traits or the spells.
|
||||||
|
//
|
||||||
|
// The window is a `.vue` file and the repository root installs no dependencies for the frontend, so
|
||||||
|
// the template and the styles are read out of the source the way tests/character-sheet-tabs.test.js
|
||||||
|
// and tests/character-sheet-portrait-column.test.js read them.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
|
||||||
|
const sheetSource = read("frontend", "app", "components", "windows", "CharacterSheetWindow.vue");
|
||||||
|
const template = /<template>([\s\S]*)<\/template>/.exec(sheetSource)?.[1] ?? "";
|
||||||
|
const TAB_KEYS = ["abilities", "inventory", "traits", "spells"];
|
||||||
|
|
||||||
|
const COLUMN = '<div class="character-column">';
|
||||||
|
|
||||||
|
function tabBody(key) {
|
||||||
|
const block = new RegExp(`<main v-show="activeTab === '${key}'"[\\s\\S]*?</main>`).exec(template)?.[0];
|
||||||
|
assert.ok(block, `expected a body for the ${key} tab`);
|
||||||
|
return block;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The column, taken whole: it stands ahead of the tab bodies, which are its siblings.
|
||||||
|
function characterColumn() {
|
||||||
|
const start = template.indexOf(COLUMN);
|
||||||
|
const end = template.indexOf('<main v-show="activeTab');
|
||||||
|
assert.ok(start !== -1 && end > start, "expected the character column ahead of the tab bodies");
|
||||||
|
return template.slice(start, end);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The classes wrapping a tag, worked out by walking the blocks of the template in order the way a
|
||||||
|
// browser nests them, so a tab cannot hide the column by wrapping it.
|
||||||
|
function ancestorsOf(needle) {
|
||||||
|
const at = template.indexOf(needle);
|
||||||
|
assert.ok(at !== -1, `expected ${needle} in the template`);
|
||||||
|
const stack = [];
|
||||||
|
for (const match of template.matchAll(/<(\/?)(div|main|section|header|nav)\b([^>]*)>/g)) {
|
||||||
|
if (match.index > at) break;
|
||||||
|
const [, closed, , attrs] = match;
|
||||||
|
if (closed) stack.pop();
|
||||||
|
else if (!attrs.trimEnd().endsWith("/")) {
|
||||||
|
const classes = /\bclass="([^"]*)"/.exec(attrs);
|
||||||
|
stack.push(classes ? classes[1].trim().split(/\s+/) : []);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return stack.slice(0, -1).map((classes) => classes.join(" "));
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the character column belongs to no tab", () => {
|
||||||
|
const column = characterColumn();
|
||||||
|
assert.ok(column.includes('class="sheet-portrait"'), "the portrait is part of the column");
|
||||||
|
assert.ok(column.includes('class="sheet-panel vitals-panel"'), "and so is the panel of readouts and bars");
|
||||||
|
// Nothing toggles the column: no tab decides whether it shows.
|
||||||
|
assert.doesNotMatch(column, /v-show=/, "the column never hides behind a tab");
|
||||||
|
|
||||||
|
for (const key of TAB_KEYS) {
|
||||||
|
const body = tabBody(key);
|
||||||
|
assert.doesNotMatch(body, /class="character-column"/, `the ${key} tab does not own the column`);
|
||||||
|
assert.doesNotMatch(body, /sheet-portrait|vitals-panel/, `the ${key} tab does not hold the column's contents`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the column and the tab that is open stand beside each other", () => {
|
||||||
|
const columnWrappers = ancestorsOf(COLUMN);
|
||||||
|
assert.equal(columnWrappers.at(-1), "sheet-layout", "the column stands in the sheet's own layout");
|
||||||
|
for (const key of TAB_KEYS) {
|
||||||
|
assert.deepEqual(
|
||||||
|
ancestorsOf(`<main v-show="activeTab === '${key}'"`),
|
||||||
|
columnWrappers,
|
||||||
|
`the ${key} tab is a sibling of the column, so it is never wrapped around it`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const layout = /\.sheet-layout\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
||||||
|
assert.match(layout, /display:\s*grid/, "the layout puts the column and the open tab side by side");
|
||||||
|
assert.match(
|
||||||
|
layout,
|
||||||
|
/grid-template-columns:\s*minmax\(200px,\s*34%\)\s+minmax\(0,\s*1fr\)/,
|
||||||
|
"the character keeps its own column and the tab has all the room left"
|
||||||
|
);
|
||||||
|
const columnRule = /\.character-column\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
||||||
|
assert.match(columnRule, /grid-column:\s*1/, "the character stands in the first column");
|
||||||
|
const bodyRule = /\.sheet-tab-body\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
||||||
|
assert.match(bodyRule, /grid-column:\s*2/, "the open tab takes the space beside it");
|
||||||
|
assert.match(bodyRule, /grid-row:\s*1/, "and on the same row, so switching a tab leaves the column where it was");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a narrow window stacks the column over the tab instead of hiding it", () => {
|
||||||
|
const narrow = /@media \(max-width: 760px\)\s*\{([\s\S]*?)\n\}/.exec(sheetSource)?.[1] ?? "";
|
||||||
|
assert.match(narrow, /\.sheet-layout\s*\{[^}]*grid-template-columns:\s*1fr/, "the two columns become one");
|
||||||
|
assert.match(
|
||||||
|
narrow,
|
||||||
|
/\.character-column,\s*\.sheet-tab-body\s*\{[^}]*grid-column:\s*1 \/ -1;[^}]*grid-row:\s*auto/,
|
||||||
|
"the column goes over the tab, it does not go away with it"
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("what stays on screen is what the sheet is read for", () => {
|
||||||
|
const column = characterColumn();
|
||||||
|
for (const key of ["armor-class", "speed", "proficiency-bonus", "initiative", "hit-points", "hit-dice"]) {
|
||||||
|
assert.ok(column.includes(`campaigns.character-sheet.${key}`), `the ${key} stays visible from any tab`);
|
||||||
|
}
|
||||||
|
});
|
||||||
176
tests/character-sheet-portrait-column.test.js
Normal file
176
tests/character-sheet-portrait-column.test.js
Normal file
@@ -0,0 +1,176 @@
|
|||||||
|
// Tests for Syndria98/dragonroll#64, the second round of modifications to the character sheet:
|
||||||
|
// * the tab rail hangs off the border of the window instead of standing inside the sheet body,
|
||||||
|
// * the armor class, the speed, the proficiency bonus and the initiative bonus stand under the
|
||||||
|
// portrait, together with the hit points and the hit dice, both drawn as bars.
|
||||||
|
//
|
||||||
|
// The window is a `.vue` file and the repository root installs no dependencies for it, so its
|
||||||
|
// template and styles are read out of the source the way tests/character-sheet-tabs.test.js reads
|
||||||
|
// them. The plain functions the sheet and the route work out their numbers with are lifted out of
|
||||||
|
// those sources and called, the way tests/map-viewer.test.js runs a service it cannot import.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
|
||||||
|
const sheetSource = read("frontend", "app", "components", "windows", "CharacterSheetWindow.vue");
|
||||||
|
const script = /<script setup>([\s\S]*?)<\/script>/.exec(sheetSource)?.[1] ?? "";
|
||||||
|
const template = /<template>([\s\S]*)<\/template>/.exec(sheetSource)?.[1] ?? "";
|
||||||
|
const actorModelSource = read("backend", "src", "models", "Actor.js");
|
||||||
|
const actorRouteSource = read("backend", "src", "routes", "actor.js");
|
||||||
|
|
||||||
|
// `fromSource` hands back one top-level declaration as a value. Imports and refs are module scope
|
||||||
|
// the test does not have, so the few names a declaration reads are passed in as arguments. The
|
||||||
|
// declaration runs in this realm, so the objects it builds compare with the ones the test builds.
|
||||||
|
function fromSource(source, pattern, locals = {}) {
|
||||||
|
const declaration = pattern.exec(source)?.[0];
|
||||||
|
assert.ok(declaration, `expected ${pattern} in the source`);
|
||||||
|
const name = /(?:const|function)\s+(\w+)/.exec(declaration)[1];
|
||||||
|
return new Function(...Object.keys(locals), `${declaration}\n;return ${name};`)(...Object.values(locals));
|
||||||
|
}
|
||||||
|
|
||||||
|
const abilityStats = fromSource(script, /const abilityStats = \[[\s\S]*?\];/);
|
||||||
|
// #83 put the skills, the saving throws, the tools, the languages and the coins into the
|
||||||
|
// sheet form, so reading that form out of the source reads their names along with it.
|
||||||
|
const skillList = fromSource(script, /const skillList = \[[\s\S]*?\];/);
|
||||||
|
const currencyUnits = fromSource(script, /const currencyUnits = \[[\s\S]*?\];/);
|
||||||
|
const proficiencyText = fromSource(script, /function proficiencyText\(value\) \{[\s\S]*?\n\}/);
|
||||||
|
const normalizeActor = fromSource(script, /function normalizeActor\(actor\) \{[\s\S]*?\n\}/, { abilityStats, skillList, currencyUnits, proficiencyText });
|
||||||
|
const barPercent = fromSource(script, /function barPercent\(current, max\) \{[\s\S]*?\n\}/);
|
||||||
|
const barPool = fromSource(actorRouteSource, /function barPool\(existing, value\) \{[\s\S]*?\n\}/);
|
||||||
|
|
||||||
|
// The column that stands beside every tab: the portrait with everything under it.
|
||||||
|
function portraitColumn() {
|
||||||
|
const start = template.indexOf('<div class="character-column">');
|
||||||
|
const end = template.indexOf('<section class="sheet-panel abilities-panel">');
|
||||||
|
assert.ok(start !== -1 && end > start, "expected a character column ahead of the ability scores");
|
||||||
|
return template.slice(start, end);
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the tab rail hangs off the border of the window, outside the sheet body", () => {
|
||||||
|
const rail = /\.sheet-tabs\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
||||||
|
assert.match(rail, /position:\s*absolute/, "the rail is mounted on the window frame");
|
||||||
|
assert.match(rail, /left:\s*100%/, "it starts at the right border and reaches outwards");
|
||||||
|
assert.ok(
|
||||||
|
template.indexOf('<nav class="sheet-tabs"') < template.indexOf('<div class="sheet-body">'),
|
||||||
|
"the rail is a child of the window, ahead of the body it hangs beside"
|
||||||
|
);
|
||||||
|
const body = /\.sheet-body\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
||||||
|
assert.match(body, /overflow:\s*auto/, "the sheet body scrolls on its own, the rail stays put");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the armor class, the speed and both bonuses stand under the portrait", () => {
|
||||||
|
const column = portraitColumn();
|
||||||
|
assert.ok(column.includes('class="sheet-portrait"'), "the portrait opens the column");
|
||||||
|
assert.ok(column.includes('class="sheet-panel vitals-panel"'), "the readouts follow the image");
|
||||||
|
assert.ok(
|
||||||
|
column.indexOf('class="sheet-portrait"') < column.indexOf("vitals-panel"),
|
||||||
|
"the readouts stand under the image, not above it"
|
||||||
|
);
|
||||||
|
for (const key of ["armor-class", "speed", "proficiency-bonus", "initiative"]) {
|
||||||
|
assert.ok(
|
||||||
|
column.includes(`campaigns.character-sheet.${key}`),
|
||||||
|
`the ${key} belongs under the image`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Gone from where they were: the combat panel is nothing but proficiencies left over, and the
|
||||||
|
// ability scores panel keeps the six scores only.
|
||||||
|
assert.doesNotMatch(template, /combat-panel/, "the combat panel went with the combat stats");
|
||||||
|
const abilities = template
|
||||||
|
.slice(template.indexOf('<section class="sheet-panel abilities-panel">'))
|
||||||
|
.split("</section>")[0];
|
||||||
|
assert.doesNotMatch(abilities, /proficiency-bonus/, "the proficiency bonus moved down the column");
|
||||||
|
assert.match(abilities, /campaigns\.character-sheet\.ability-scores/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the hit points and the hit dice stand as bars under the portrait", () => {
|
||||||
|
const column = portraitColumn();
|
||||||
|
assert.match(column, /class="vital-bar hit-points-bar"/);
|
||||||
|
assert.match(column, /class="vital-bar hit-dice-bar"/);
|
||||||
|
for (const pool of ["hitPoints", "hitDice"]) {
|
||||||
|
assert.match(column, new RegExp(`v-model\\.number="form\\.${pool}\\.current"`), `${pool} is editable`);
|
||||||
|
assert.match(column, new RegExp(`v-model\\.number="form\\.${pool}\\.max"`), `${pool} has a maximum to set`);
|
||||||
|
assert.match(
|
||||||
|
column,
|
||||||
|
new RegExp(`\\{\\{ form\\.${pool}\\.current \\}\\} / \\{\\{ form\\.${pool}\\.max \\}\\}`),
|
||||||
|
`${pool} reads current of max outside of editing`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
// Each bar fills what its own maximum allows, and each is painted its own colour.
|
||||||
|
assert.match(column, /:style="\{ width: `\$\{hitPointsPercent\}%` \}"/);
|
||||||
|
assert.match(column, /:style="\{ width: `\$\{hitDicePercent\}%` \}"/);
|
||||||
|
assert.match(sheetSource, /\.hit-points-bar \.vital-bar-fill\s*\{[^}]*var\(--color-red\)/);
|
||||||
|
assert.match(sheetSource, /\.hit-dice-bar \.vital-bar-fill\s*\{[^}]*var\(--color-link\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a bar fills what its maximum allows, no more and no less", () => {
|
||||||
|
assert.equal(barPercent(5, 10), 50);
|
||||||
|
assert.equal(barPercent(12, 10), 100, "healed past the maximum does not overflow the track");
|
||||||
|
assert.equal(barPercent(-3, 10), 0, "nothing left stands empty");
|
||||||
|
assert.equal(barPercent(4, 0), 0, "a maximum of nothing is no bar either");
|
||||||
|
assert.equal(barPercent("", 10), 0, "an input cleared mid-edit is read as nothing");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the initiative bonus is the modifier of dexterity", () => {
|
||||||
|
assert.match(
|
||||||
|
script,
|
||||||
|
/const initiativeBonus = computed\(\(\) => abilityModifier\(form\.value\.abilityScores\.dex\)\)/,
|
||||||
|
"D&D counts initiative as the dexterity modifier while the character carries no extra bonus"
|
||||||
|
);
|
||||||
|
// #83 gave the helper an optional proficiency bonus, for the skills and the saving
|
||||||
|
// throws the character is proficient with; the bare modifier is unchanged.
|
||||||
|
const abilityModifier = fromSource(script, /function abilityModifier\(score[^{]*\) \{[\s\S]*?\n\}/);
|
||||||
|
assert.equal(abilityModifier(16), "+3");
|
||||||
|
assert.equal(abilityModifier(10), "+0", "the sheet writes a flat modifier with its sign, as the ability cards do");
|
||||||
|
assert.equal(abilityModifier(9), "-1");
|
||||||
|
assert.equal(abilityModifier(16, 3), "+6", "a proficient skill adds the proficiency bonus to its modifier");
|
||||||
|
assert.equal(abilityModifier(8, 2), "+1", "and one below 10 counts its own negative modifier first");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an actor carries its pools, and one without them starts on its level", () => {
|
||||||
|
assert.deepEqual(normalizeActor({ level: 3 }).hitPoints, { current: 10, max: 10 });
|
||||||
|
assert.deepEqual(normalizeActor({ level: 3 }).hitDice, { current: 3, max: 3 }, "one die per level");
|
||||||
|
const wounded = normalizeActor({
|
||||||
|
level: 5,
|
||||||
|
hitPoints: { current: 4, max: 44 },
|
||||||
|
hitDice: { current: 2, max: 5 }
|
||||||
|
});
|
||||||
|
assert.deepEqual(wounded.hitPoints, { current: 4, max: 44 });
|
||||||
|
assert.deepEqual(wounded.hitDice, { current: 2, max: 5 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the Actor model stores both pools as current of a maximum", () => {
|
||||||
|
for (const pool of ["hitPoints", "hitDice"]) {
|
||||||
|
assert.match(
|
||||||
|
actorModelSource,
|
||||||
|
new RegExp(`${pool}:\\s*\\{\\s*current:\\s*\\{\\s*type:\\s*Number[^}]*\\},\\s*max:\\s*\\{\\s*type:\\s*Number[^}]*\\}`),
|
||||||
|
`${pool} holds a current and a maximum`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the actor update takes both pools and never lets one pass its maximum", () => {
|
||||||
|
assert.match(actorRouteSource, /const \{[^}]*hitPoints[^}]*hitDice[^}]*\} = req\.body;/, "the update reads them off the body");
|
||||||
|
assert.match(actorRouteSource, /if \(hitPoints !== undefined\) actor\.hitPoints = barPool\(actor\.hitPoints, hitPoints\)/);
|
||||||
|
assert.match(actorRouteSource, /if \(hitDice !== undefined\) actor\.hitDice = barPool\(actor\.hitDice, hitDice\)/);
|
||||||
|
|
||||||
|
assert.deepEqual(barPool({ current: 5, max: 20 }, { current: 8, max: 30 }), { current: 8, max: 30 });
|
||||||
|
assert.deepEqual(barPool({ current: 5, max: 20 }, { current: 40 }), { current: 20, max: 20 }, "a current over its maximum stops at the maximum");
|
||||||
|
assert.deepEqual(barPool({ current: 5, max: 20 }, { max: 4 }), { current: 4, max: 4 }, "a maximum lowered below the current pulls it down");
|
||||||
|
assert.deepEqual(barPool({ current: 5, max: 20 }, { current: 12 }), { current: 12, max: 20 }, "half a pair keeps the half it did not send");
|
||||||
|
assert.deepEqual(barPool({ current: 5, max: 20 }, { current: -2, max: 20 }), { current: 0, max: 20 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every locale names the readouts that moved under the portrait", () => {
|
||||||
|
for (const locale of ["en", "es", "ca"]) {
|
||||||
|
const sheet = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"))["character-sheet"];
|
||||||
|
for (const key of ["initiative", "hit-points", "max-hit-points", "hit-dice", "max-hit-dice"]) {
|
||||||
|
assert.ok(sheet[key], `${locale} is missing campaigns.character-sheet.${key}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -37,9 +37,10 @@ test("the tabs sit on the right as a vertical bookmark rail", () => {
|
|||||||
assert.match(template, /v-for="tab in tabs"[\s\S]*?:aria-selected="activeTab === tab\.key"/);
|
assert.match(template, /v-for="tab in tabs"[\s\S]*?:aria-selected="activeTab === tab\.key"/);
|
||||||
const rail = /\.sheet-tabs\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
const rail = /\.sheet-tabs\s*\{[^}]*\}/.exec(sheetSource)?.[0] ?? "";
|
||||||
assert.match(rail, /flex-direction:\s*column/, "the bookmarks stack down the right edge");
|
assert.match(rail, /flex-direction:\s*column/, "the bookmarks stack down the right edge");
|
||||||
// content column and rail sit side by side, the rail hugging the right
|
// #64 moved the rail out of the content: it hangs off the window border itself, so it is not
|
||||||
assert.match(sheetSource, /\.sheet-layout\s*\{[^}]*display:\s*flex[^}]*\}/, "content and rail share a row");
|
// swept along when the sheet scrolls (see tests/character-sheet-portrait-column.test.js).
|
||||||
assert.match(sheetSource, /\.sheet-content\s*\{[^}]*flex:\s*1[^}]*\}/, "the content takes the room, the rail stays slim");
|
assert.match(rail, /position:\s*absolute/, "the rail is mounted on the window frame");
|
||||||
|
assert.match(rail, /left:\s*100%/, "the rail stands outside the window's right border");
|
||||||
});
|
});
|
||||||
|
|
||||||
// Each tab shows only its own panels; the rest are hidden with v-show so an in-progress edit is
|
// Each tab shows only its own panels; the rest are hidden with v-show so an in-progress edit is
|
||||||
@@ -52,9 +53,8 @@ function tabBody(key) {
|
|||||||
|
|
||||||
test("every tab shows only its own content and hides the others", () => {
|
test("every tab shows only its own content and hides the others", () => {
|
||||||
const abilities = tabBody("abilities");
|
const abilities = tabBody("abilities");
|
||||||
assert.match(abilities, /class="sheet-portrait"/, "the portrait stays with ability scores");
|
|
||||||
assert.match(abilities, /class="sheet-panel abilities-panel"/);
|
assert.match(abilities, /class="sheet-panel abilities-panel"/);
|
||||||
assert.match(abilities, /class="sheet-panel combat-panel"/, "combat rides with the ability scores");
|
assert.match(abilities, /class="sheet-panel proficiencies-panel"/, "the proficiencies ride with the ability scores");
|
||||||
for (const other of ["inventory-panel", "traits-panel", "spells-panel"]) {
|
for (const other of ["inventory-panel", "traits-panel", "spells-panel"]) {
|
||||||
assert.doesNotMatch(abilities, new RegExp(other));
|
assert.doesNotMatch(abilities, new RegExp(other));
|
||||||
}
|
}
|
||||||
@@ -62,7 +62,12 @@ test("every tab shows only its own content and hides the others", () => {
|
|||||||
for (const [key, panel] of [["inventory", "inventory-panel"], ["traits", "traits-panel"], ["spells", "spells-panel"]]) {
|
for (const [key, panel] of [["inventory", "inventory-panel"], ["traits", "traits-panel"], ["spells", "spells-panel"]]) {
|
||||||
const body = tabBody(key);
|
const body = tabBody(key);
|
||||||
assert.ok(body.includes(panel), `the ${key} tab shows the ${panel}`);
|
assert.ok(body.includes(panel), `the ${key} tab shows the ${panel}`);
|
||||||
assert.doesNotMatch(body, /class="sheet-portrait"/);
|
}
|
||||||
|
|
||||||
|
// #91 took the character column out of the tabs: it stands beside every one of them, so no tab
|
||||||
|
// body holds the portrait (see tests/character-sheet-persistent-column.test.js).
|
||||||
|
for (const key of ["abilities", "inventory", "traits", "spells"]) {
|
||||||
|
assert.doesNotMatch(tabBody(key), /class="sheet-portrait"/, `the portrait is not the ${key} tab's to hide`);
|
||||||
}
|
}
|
||||||
|
|
||||||
// the panels are toggled, not unmounted, so editing on one tab and flipping away keeps the draft
|
// the panels are toggled, not unmounted, so editing on one tab and flipping away keeps the draft
|
||||||
|
|||||||
525
tests/character-sheet-traits-items.test.js
Normal file
525
tests/character-sheet-traits-items.test.js
Normal file
@@ -0,0 +1,525 @@
|
|||||||
|
// Tests for Syndria98/dragonroll#89: on the character sheet traits and items were all
|
||||||
|
// displayed together and the icons did not load. The world's mapper put every embedded
|
||||||
|
// document that was not a class, subclass, background or spell into the character's
|
||||||
|
// inventory — so its traits (feat items) and its species (the race item) stood in the
|
||||||
|
// inventory list beside the gear, while the sheet already shows both in fields of their
|
||||||
|
// own. And a world image that arrives as a Foundry path — the bridge's snapshot and older
|
||||||
|
// modules send those, where the module sends absolute URLs — was read against Dragonroll's
|
||||||
|
// uploads folder, where nothing of that name is, so nothing loaded.
|
||||||
|
//
|
||||||
|
// The mapper is plain CommonJS and is required for real. The writers run in a stubbed
|
||||||
|
// `require` against fake models, like tests/foundry-force-import.test.js runs them. And
|
||||||
|
// since the campaign's inventory no longer claims trait and species documents, the module
|
||||||
|
// must stop deleting ones earlier syncs marked as its own: the Foundry module goes into a
|
||||||
|
// `node:vm` context holding stubbed Foundry globals with fake timers, like
|
||||||
|
// tests/foundry-actor-details.test.js, so what writing a character leaves behind is observable.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
const repoRequire = (relative) => require(path.join(__dirname, "..", relative));
|
||||||
|
const MODULE_ID = "dragonroll-foundry";
|
||||||
|
|
||||||
|
// --- What the world's mapper keeps where -------------------------------------------------
|
||||||
|
|
||||||
|
const { foundryActorToCharacter } = require(path.join(__dirname, "..", "backend", "src", "services", "actor-foundry.js"));
|
||||||
|
|
||||||
|
test("traits and species stand in their own fields, not among the carried items", () => {
|
||||||
|
const character = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
system: { details: {} },
|
||||||
|
items: [
|
||||||
|
{ name: "Longsword", type: "weapon", img: "http://vtt.test/icons/sword.svg", system: { quantity: 1, weight: { value: 3 } } },
|
||||||
|
{ name: "Rope", type: "equipment", system: { quantity: 2 } },
|
||||||
|
{ name: "Darkvision", type: "feat", system: { featType: "trs", description: { value: "<p>See in the dark.</p>" } } },
|
||||||
|
{ name: "Human", type: "race" },
|
||||||
|
{ name: "Spellbook", type: "spellbook" },
|
||||||
|
{ name: "Magic Missile", type: "spell" },
|
||||||
|
{ name: "Fighter", type: "class" },
|
||||||
|
{ name: "Oracle", type: "subclass" },
|
||||||
|
{ name: "Soldier", type: "background" },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(character.inventory.map((item) => item.name), ["Longsword", "Rope"],
|
||||||
|
"the inventory holds what the character carries, and nothing else");
|
||||||
|
assert.deepEqual(character.inventory[0],
|
||||||
|
{ name: "Longsword", quantity: 1, weight: 3, icon: "http://vtt.test/icons/sword.svg" });
|
||||||
|
assert.equal(character.traits, "Darkvision\nSee in the dark.", "the feat is read as a trait, where the sheet shows it");
|
||||||
|
assert.equal(character.spells, "Magic Missile", "and the spell where its tab shows it");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("gear of a type the mapper has never seen is still carried", () => {
|
||||||
|
const character = foundryActorToCharacter({
|
||||||
|
name: "Thalia",
|
||||||
|
items: [{ name: "Strange Relic", type: "loot", system: { quantity: 1 } }],
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(character.inventory.map((item) => item.name), ["Strange Relic"],
|
||||||
|
"only the listed non-gear types are let out of the inventory");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The writers read a world's paths off the world's address ----------------------------
|
||||||
|
|
||||||
|
function mongooseQuery(value) {
|
||||||
|
const result = {
|
||||||
|
select: () => result,
|
||||||
|
sort: () => result,
|
||||||
|
limit: (count) => mongooseQuery(value.slice(0, count)),
|
||||||
|
lean: () => Promise.resolve(value),
|
||||||
|
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||||
|
};
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enough of the query language the writers use: equality and $or.
|
||||||
|
function matches(document, filter = {}) {
|
||||||
|
return Object.entries(filter).every(([key, expected]) => {
|
||||||
|
if (key === "$or") return expected.some((part) => matches(document, part));
|
||||||
|
const value = document?.[key];
|
||||||
|
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
|
||||||
|
return Object.entries(expected).every(([operator, wanted]) => {
|
||||||
|
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
|
||||||
|
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return String(value ?? "") === String(expected ?? "");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function fakeModel(table, seed = [], campaignId) {
|
||||||
|
const rows = [];
|
||||||
|
let counter = 0;
|
||||||
|
|
||||||
|
function Document(data = {}) {
|
||||||
|
counter += 1;
|
||||||
|
this._id = `${table}-${counter}`;
|
||||||
|
this.isNew = true;
|
||||||
|
this.foundryNames = [];
|
||||||
|
Object.assign(this, data);
|
||||||
|
}
|
||||||
|
Document.prototype.save = async function save() {
|
||||||
|
if (this.isNew) rows.push(this);
|
||||||
|
this.isNew = false;
|
||||||
|
return this;
|
||||||
|
};
|
||||||
|
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||||
|
|
||||||
|
for (const data of seed) {
|
||||||
|
const row = new Document({ campaign: campaignId, ...data });
|
||||||
|
row.isNew = false;
|
||||||
|
rows.push(row);
|
||||||
|
}
|
||||||
|
|
||||||
|
const model = function Model(data) { return new Document(data); };
|
||||||
|
model.rows = rows;
|
||||||
|
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
|
||||||
|
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
|
||||||
|
return model;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The sync writers against fake models. `settings` is what the campaign keeps — the world
|
||||||
|
// address the icons are loaded from stands in it, as it does in the real one.
|
||||||
|
function loadFoundryWriters({ seed = {}, settings } = {}) {
|
||||||
|
const campaign = { _id: "campaign-1", id: "campaign-1", foundryWorldId: "world-1", ...(settings ? { settings } : {}) };
|
||||||
|
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||||
|
const models = {
|
||||||
|
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||||
|
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||||
|
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||||
|
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||||
|
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||||
|
};
|
||||||
|
|
||||||
|
const requireStub = (id) => {
|
||||||
|
if (id === "express") return { Router: () => ({ get: () => {}, post: () => {} }) };
|
||||||
|
if (id.startsWith("node:")) return require(id);
|
||||||
|
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||||
|
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||||
|
if (id === "../services/actor-foundry") return repoRequire(path.join("backend", "src", "services", "actor-foundry.js"));
|
||||||
|
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||||
|
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||||
|
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||||
|
if (models[id]) return models[id];
|
||||||
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
|
};
|
||||||
|
|
||||||
|
const moduleStub = { exports: {} };
|
||||||
|
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
|
||||||
|
requireStub, moduleStub, moduleStub.exports
|
||||||
|
);
|
||||||
|
return { campaign, models, writers: moduleStub.exports };
|
||||||
|
}
|
||||||
|
|
||||||
|
test("a world image that arrives as a path is stored as the address the sheet can load", async () => {
|
||||||
|
const sync = loadFoundryWriters({ settings: { integrations: { foundryUrl: "http://vtt.test:30000/" } } });
|
||||||
|
|
||||||
|
await sync.writers.saveFoundryActor(sync.campaign, {
|
||||||
|
_id: "actor-1",
|
||||||
|
name: "Thalia",
|
||||||
|
type: "character",
|
||||||
|
img: "icons/actors/thalia.svg",
|
||||||
|
items: [
|
||||||
|
{ name: "Torch", type: "loot", img: "icons/tools/torch torch.svg", system: { quantity: 2 } },
|
||||||
|
{ name: "Darkvision", type: "feat", img: "icons/svg/eye.svg" },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
|
||||||
|
const actor = sync.models["../models/Actor"].rows[0];
|
||||||
|
assert.equal(actor.image, "http://vtt.test:30000/icons/actors/thalia.svg", "the portrait is read off the world's address");
|
||||||
|
assert.deepEqual(actor.inventory.map((item) => item.name), ["Torch"], "the feat is not carried into the inventory");
|
||||||
|
assert.equal(actor.inventory[0].icon, "http://vtt.test:30000/icons/tools/torch%20torch.svg", "and the gear's icon is");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the absolute addresses the module sends travel as they are", async () => {
|
||||||
|
const sync = loadFoundryWriters({ settings: { integrations: { foundryUrl: "http://vtt.test:30000" } } });
|
||||||
|
|
||||||
|
await sync.writers.saveFoundryActor(sync.campaign, {
|
||||||
|
_id: "actor-1",
|
||||||
|
name: "Thalia",
|
||||||
|
img: "http://elsewhere.test/portraits/thalia.png",
|
||||||
|
items: [{ name: "Torch", type: "loot", img: "data:image/png;base64,TgA=" }],
|
||||||
|
});
|
||||||
|
|
||||||
|
const actor = sync.models["../models/Actor"].rows[0];
|
||||||
|
assert.equal(actor.image, "http://elsewhere.test/portraits/thalia.png");
|
||||||
|
assert.equal(actor.inventory[0].icon, "data:image/png;base64,TgA=");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a campaign with no world address keeps the path as it came", async () => {
|
||||||
|
const sync = loadFoundryWriters();
|
||||||
|
|
||||||
|
await sync.writers.saveFoundryActor(sync.campaign, {
|
||||||
|
_id: "actor-1", name: "Thalia", img: "icons/actors/thalia.svg",
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(sync.models["../models/Actor"].rows[0].image, "icons/actors/thalia.svg",
|
||||||
|
"with no world to read it against, nothing is invented for it");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a world item's icon is read off the world's address the same way", async () => {
|
||||||
|
const sync = loadFoundryWriters({ settings: { integrations: { foundryUrl: "http://vtt.test:30000" } } });
|
||||||
|
|
||||||
|
await sync.writers.saveFoundryItem(sync.campaign, {
|
||||||
|
_id: "item-1", name: "Longsword", type: "weapon", img: "icons/equipment/sword.svg",
|
||||||
|
});
|
||||||
|
|
||||||
|
const item = sync.models["../models/Item"].rows[0];
|
||||||
|
assert.equal(item.image, "http://vtt.test:30000/icons/equipment/sword.svg");
|
||||||
|
assert.equal(item.foundryImage, "http://vtt.test:30000/icons/equipment/sword.svg",
|
||||||
|
"the icon the item window offers back is the loadable one too");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The module leaves the world's own documents alone ------------------------------------
|
||||||
|
|
||||||
|
function makeStubItem(id, { name, type, system = {}, flags = {} }) {
|
||||||
|
return {
|
||||||
|
_id: id,
|
||||||
|
id,
|
||||||
|
name,
|
||||||
|
type,
|
||||||
|
system,
|
||||||
|
flags,
|
||||||
|
parent: { documentName: "Actor" },
|
||||||
|
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||||
|
toObject() {
|
||||||
|
return { _id: this.id, name: this.name, type: this.type, system: this.system, flags: this.flags };
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function writeDotted(target, data) {
|
||||||
|
for (const [key, value] of Object.entries(data)) {
|
||||||
|
const parts = key.split(".");
|
||||||
|
const last = parts.pop();
|
||||||
|
let node = target;
|
||||||
|
for (const part of parts) node = node[part] ??= {};
|
||||||
|
node[last] = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let stubCounter = 0;
|
||||||
|
|
||||||
|
function makeStubActor(name, { type = "character", system = {}, flags = {}, items = [] } = {}) {
|
||||||
|
stubCounter += 1;
|
||||||
|
const id = `actor-${stubCounter}`;
|
||||||
|
const contents = items.map((item, index) => makeStubItem(item._id || `embedded-${stubCounter}-${index}`, item));
|
||||||
|
const actor = {
|
||||||
|
id,
|
||||||
|
name,
|
||||||
|
type,
|
||||||
|
documentName: "Actor",
|
||||||
|
img: "icons/svg/mystery-man.svg",
|
||||||
|
system,
|
||||||
|
flags,
|
||||||
|
items: { contents },
|
||||||
|
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||||
|
async update(data) {
|
||||||
|
writeDotted(this, data);
|
||||||
|
return this;
|
||||||
|
},
|
||||||
|
async updateEmbeddedDocuments(documentName, updates) {
|
||||||
|
for (const update of updates) {
|
||||||
|
const item = contents.find((candidate) => candidate.id === update._id);
|
||||||
|
if (item) writeDotted(item, update);
|
||||||
|
}
|
||||||
|
return updates.map((update) => contents.find((candidate) => candidate.id === update._id));
|
||||||
|
},
|
||||||
|
async createEmbeddedDocuments(documentName, datas) {
|
||||||
|
const created = datas.map((data) => {
|
||||||
|
const item = makeStubItem(`embedded-${stubCounter}-${contents.length}`, data);
|
||||||
|
contents.push(item);
|
||||||
|
return item;
|
||||||
|
});
|
||||||
|
return created;
|
||||||
|
},
|
||||||
|
async deleteEmbeddedDocuments(documentName, ids) {
|
||||||
|
for (const id of ids) {
|
||||||
|
const index = contents.findIndex((item) => item.id === id);
|
||||||
|
if (index >= 0) contents.splice(index, 1);
|
||||||
|
}
|
||||||
|
return ids;
|
||||||
|
},
|
||||||
|
toObject() {
|
||||||
|
return {
|
||||||
|
_id: this.id,
|
||||||
|
name: this.name,
|
||||||
|
type: this.type,
|
||||||
|
img: this.img,
|
||||||
|
flags: this.flags,
|
||||||
|
system: this.system,
|
||||||
|
};
|
||||||
|
},
|
||||||
|
};
|
||||||
|
return actor;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeWorld({ actors = [], remoteActors = [] } = {}) {
|
||||||
|
const state = {
|
||||||
|
hooks: new Map(),
|
||||||
|
registered: new Map(),
|
||||||
|
requests: [],
|
||||||
|
timers: new Map(),
|
||||||
|
nextTimerId: 1,
|
||||||
|
logs: [],
|
||||||
|
};
|
||||||
|
|
||||||
|
const settingsStore = { autoSync: true, syncToken: "sync-token-1", dragonrollApiUrl: "http://backend.test:5000" };
|
||||||
|
const sandbox = {
|
||||||
|
console: {
|
||||||
|
log() {},
|
||||||
|
info() {},
|
||||||
|
warn: (...args) => state.logs.push(args.map(String).join(" ")),
|
||||||
|
error: (...args) => state.logs.push(args.map(String).join(" ")),
|
||||||
|
},
|
||||||
|
URL,
|
||||||
|
CONFIG: {},
|
||||||
|
window: { location: { origin: "http://vtt.test" } },
|
||||||
|
ui: { notifications: { info() {}, warn() {}, error() {} } },
|
||||||
|
Hooks: {
|
||||||
|
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||||
|
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
|
||||||
|
},
|
||||||
|
setTimeout: (fn, delay = 0) => {
|
||||||
|
const timerId = state.nextTimerId++;
|
||||||
|
state.timers.set(timerId, { fn, delay });
|
||||||
|
return timerId;
|
||||||
|
},
|
||||||
|
clearTimeout: (timerId) => state.timers.delete(timerId),
|
||||||
|
setInterval: () => 0,
|
||||||
|
clearInterval: () => {},
|
||||||
|
fetch: async (url, options = {}) => {
|
||||||
|
const href = String(url);
|
||||||
|
state.requests.push({ href, method: options.method, body: options.body ? JSON.parse(options.body) : null });
|
||||||
|
if (href.includes("foundry/sync/characters")) return { ok: true, status: 200, json: async () => ({ status: "ok", actors: remoteActors }) };
|
||||||
|
if (href.includes("foundry/sync/items")) return { ok: true, status: 200, json: async () => ({ status: "ok", items: [] }) };
|
||||||
|
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||||
|
},
|
||||||
|
Item: { async create() { return null; } },
|
||||||
|
Actor: {
|
||||||
|
async create(data) {
|
||||||
|
const actor = makeStubActor(data.name, {
|
||||||
|
type: data.type,
|
||||||
|
system: structuredClone(data.system || {}),
|
||||||
|
flags: structuredClone(data.flags || {}),
|
||||||
|
items: (data.items || []).map((item) => ({ name: item.name, type: item.type, system: item.system })),
|
||||||
|
});
|
||||||
|
actors.push(actor);
|
||||||
|
return actor;
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
sandbox.game = {
|
||||||
|
user: { isGM: true },
|
||||||
|
world: { id: "world-1", title: "Test World" },
|
||||||
|
system: { id: "dnd5e" },
|
||||||
|
modules: { get: () => ({}) },
|
||||||
|
actors: { contents: actors, get: (actorId) => actors.find((actor) => actor.id === actorId) },
|
||||||
|
items: { contents: [], get: () => null },
|
||||||
|
folders: { 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(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||||
|
|
||||||
|
state.game = sandbox.game;
|
||||||
|
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||||
|
|
||||||
|
// World start: the actors are pushed, then the campaign's characters are applied.
|
||||||
|
state.start = async () => {
|
||||||
|
await state.fire("init");
|
||||||
|
await state.fire("ready");
|
||||||
|
await state.runTimers();
|
||||||
|
return state;
|
||||||
|
};
|
||||||
|
|
||||||
|
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();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
state.itemNames = (actor) => actor.items.contents.map((item) => [item.type, item.name]);
|
||||||
|
state.actorPushes = () => state.requests
|
||||||
|
.filter((request) => request.href.includes("foundry/sync/snapshot"))
|
||||||
|
.map((request) => request.body.actors[0]);
|
||||||
|
|
||||||
|
return state;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The campaign's character for `actor`, holding what Dragonroll keeps for it.
|
||||||
|
function campaignCharacter(actor, over = {}) {
|
||||||
|
return {
|
||||||
|
_id: "dr-actor-1",
|
||||||
|
name: "Thalia",
|
||||||
|
type: "character",
|
||||||
|
species: "",
|
||||||
|
className: "",
|
||||||
|
subclass: "",
|
||||||
|
level: 1,
|
||||||
|
background: "",
|
||||||
|
challengeRating: "",
|
||||||
|
description: "",
|
||||||
|
image: "",
|
||||||
|
abilityScores: {},
|
||||||
|
armorClass: 10,
|
||||||
|
speed: 30,
|
||||||
|
traits: "",
|
||||||
|
proficiencies: "",
|
||||||
|
spells: "",
|
||||||
|
inventory: [],
|
||||||
|
foundryActorId: actor?.id ?? null,
|
||||||
|
...over,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
test("a trait row an older campaign left in the inventory does not become a loot duplicate", async () => {
|
||||||
|
// A campaign that synced before #89 still carries its world's traits as inventory
|
||||||
|
// rows. Writing the character must neither make a piece of loot after a trait's name
|
||||||
|
// nor touch the world's feat it holds that name — the row is the campaign's to write
|
||||||
|
// off, and the document is the world's to keep.
|
||||||
|
const actor = makeStubActor("Thalia", {
|
||||||
|
system: { details: {} },
|
||||||
|
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||||
|
items: [{ _id: "feat-1", name: "Darkvision", type: "feat", system: { featType: "trs" } }],
|
||||||
|
});
|
||||||
|
const world = await makeWorld({
|
||||||
|
actors: [actor],
|
||||||
|
remoteActors: [campaignCharacter(actor, {
|
||||||
|
traits: "Darkvision\nSee in the dark.",
|
||||||
|
inventory: [{ name: "Darkvision", quantity: 1, weight: 0 }],
|
||||||
|
})],
|
||||||
|
}).start();
|
||||||
|
|
||||||
|
assert.deepEqual(world.itemNames(actor), [["feat", "Darkvision"]],
|
||||||
|
"no gear made after the trait's name, and the feat stands where it was");
|
||||||
|
assert.equal(actor.items.contents[0].system.quantity, undefined, "the world's feat is not written as gear");
|
||||||
|
assert.deepEqual(world.logs, [], "applying the character did not warn");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("writing the character leaves the world's trait and species documents where they stand", async () => {
|
||||||
|
// An earlier sync marked everything in the actor as its own. The campaign no longer
|
||||||
|
// carries traits and species in the inventory, so those marks must not cost the world
|
||||||
|
// its documents — while loot the campaign truly dropped still goes.
|
||||||
|
const actor = makeStubActor("Thalia", {
|
||||||
|
system: { details: {} },
|
||||||
|
flags: { [MODULE_ID]: { actorId: "dr-actor-1" } },
|
||||||
|
items: [
|
||||||
|
{ _id: "feat-1", name: "Darkvision", type: "feat", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||||
|
{ _id: "race-1", name: "Human", type: "race", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||||
|
{ _id: "loot-old", name: "Torch", type: "loot", flags: { [MODULE_ID]: { syncedItem: true } } },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
const world = await makeWorld({
|
||||||
|
actors: [actor],
|
||||||
|
remoteActors: [campaignCharacter(actor, {
|
||||||
|
species: "Human",
|
||||||
|
traits: "Darkvision\nSee in the dark.",
|
||||||
|
inventory: [{ name: "Rations", quantity: 1, weight: 0.5 }],
|
||||||
|
})],
|
||||||
|
}).start();
|
||||||
|
|
||||||
|
assert.deepEqual(world.itemNames(actor), [
|
||||||
|
["feat", "Darkvision"],
|
||||||
|
["race", "Human"],
|
||||||
|
["loot", "Rations"],
|
||||||
|
], "the trait and the species survive, the carried gear follows the campaign");
|
||||||
|
assert.equal(actor.system.details.race, "race-1", "the species reference still resolves to the surviving item");
|
||||||
|
assert.deepEqual(world.logs, [], "applying the character did not warn");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the snapshot marks the carried gear and no longer the world's own documents", async () => {
|
||||||
|
const actor = makeStubActor("Grimnir", {
|
||||||
|
system: { details: {} },
|
||||||
|
items: [
|
||||||
|
{ name: "Longsword", type: "weapon" },
|
||||||
|
{ name: "Darkvision", type: "feat" },
|
||||||
|
{ name: "Giant", type: "race" },
|
||||||
|
],
|
||||||
|
});
|
||||||
|
await makeWorld({ actors: [actor], remoteActors: [] }).start();
|
||||||
|
|
||||||
|
const [sword, feat, race] = actor.items.contents;
|
||||||
|
assert.equal(sword.getFlag(MODULE_ID, "syncedItem"), true, "the gear the campaign carries is marked as its own");
|
||||||
|
assert.equal(feat.getFlag(MODULE_ID, "syncedItem"), undefined, "a trait is not");
|
||||||
|
assert.equal(race.getFlag(MODULE_ID, "syncedItem"), undefined, "neither is a species");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an actor snapshot still sends the feats its traits are made of", async () => {
|
||||||
|
// Leaving feats out of the inventory must not leave them out of the snapshot: they are
|
||||||
|
// what the campaign's traits tab reads.
|
||||||
|
const actor = makeStubActor("Thalia", {
|
||||||
|
system: { details: {} },
|
||||||
|
items: [{ name: "Darkvision", type: "feat", system: { featType: "trs" } }],
|
||||||
|
});
|
||||||
|
const world = await makeWorld({ actors: [actor], remoteActors: [] }).start();
|
||||||
|
|
||||||
|
const sent = world.actorPushes().at(-1);
|
||||||
|
assert.deepEqual(sent.items.map((item) => [item.type, item.name]), [["feat", "Darkvision"]],
|
||||||
|
"the feat still travels with its actor, as the traits text is read off it");
|
||||||
|
});
|
||||||
290
tests/discord-actor-links.test.js
Normal file
290
tests/discord-actor-links.test.js
Normal file
@@ -0,0 +1,290 @@
|
|||||||
|
// Tests for linking the characters of a campaign to the Discord players of the server it is
|
||||||
|
// linked to (Syndria98/dragonroll#72): each player holds one character, anybody claims a free
|
||||||
|
// one for themselves, and only a server administrator moves or frees one somebody else holds.
|
||||||
|
//
|
||||||
|
// Same set-up as tests/map-tokens.test.js, which the repository root runs without installing
|
||||||
|
// anything: the express router of routes/discord.js is loaded into `node:vm` with its models
|
||||||
|
// stubbed, and the last checks read the sources of the bot, whose command wiring is what has
|
||||||
|
// to stay right.
|
||||||
|
//
|
||||||
|
// 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");
|
||||||
|
|
||||||
|
function readRepoFile(...parts) {
|
||||||
|
return fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
}
|
||||||
|
|
||||||
|
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and lets `select()`
|
||||||
|
// and `sort()` sit in between.
|
||||||
|
function mongooseQuery(value) {
|
||||||
|
const result = {
|
||||||
|
select: () => result,
|
||||||
|
sort: () => result,
|
||||||
|
lean: () => Promise.resolve(value),
|
||||||
|
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||||
|
};
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
const GUILD_ID = "12345678901234567";
|
||||||
|
const PLAYER = "1111111111111111111";
|
||||||
|
const OTHER_PLAYER = "2222222222222222222";
|
||||||
|
|
||||||
|
// The pieces of a filter the routes build against actors: the campaign, the player holding the
|
||||||
|
// character, and plain or `$ne` ids.
|
||||||
|
function actorMatches(actor, filter = {}) {
|
||||||
|
if (filter.campaign !== undefined && String(actor.campaign) !== String(filter.campaign)) return false;
|
||||||
|
if (filter.discordUserId !== undefined && String(actor.discordUserId ?? null) !== String(filter.discordUserId ?? null)) return false;
|
||||||
|
if (filter._id !== undefined) {
|
||||||
|
if (filter._id && typeof filter._id === "object" && filter._id.$ne !== undefined) {
|
||||||
|
if (String(actor._id) === String(filter._id.$ne)) return false;
|
||||||
|
} else if (String(actor._id) !== String(filter._id)) return false;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Loads routes/discord.js over a store of actors, a guild link and the campaign that guild holds.
|
||||||
|
function loadDiscordRoutes({ guildLink = { guildId: GUILD_ID, dragonrollUser: "user-1" }, campaign = { _id: "campaign-1", name: "Katlum" }, actors = [] } = {}) {
|
||||||
|
const store = actors.map((actor) => ({ campaign: "campaign-1", discordUserId: null, save: async () => {}, ...actor }));
|
||||||
|
|
||||||
|
const routes = new Map();
|
||||||
|
const router = {
|
||||||
|
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||||
|
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||||
|
delete: () => {},
|
||||||
|
};
|
||||||
|
|
||||||
|
const requireStub = (id) => {
|
||||||
|
if (id === "express") return { Router: () => router };
|
||||||
|
if (id === "../models/Actor") return {
|
||||||
|
findOne: (filter) => {
|
||||||
|
const actor = store.find((candidate) => actorMatches(candidate, filter));
|
||||||
|
return mongooseQuery(actor ?? null);
|
||||||
|
},
|
||||||
|
find: (filter) => mongooseQuery(store.filter((candidate) => actorMatches(candidate, filter))
|
||||||
|
.slice()
|
||||||
|
.sort((a, b) => String(a.name).localeCompare(String(b.name)))),
|
||||||
|
updateMany: async (filter, update) => {
|
||||||
|
let modifiedCount = 0;
|
||||||
|
for (const actor of store) {
|
||||||
|
if (!actorMatches(actor, filter)) continue;
|
||||||
|
if (update.$set && "discordUserId" in update.$set) actor.discordUserId = update.$set.discordUserId;
|
||||||
|
modifiedCount += 1;
|
||||||
|
}
|
||||||
|
return { modifiedCount };
|
||||||
|
},
|
||||||
|
};
|
||||||
|
if (id === "../models/Campaign") return { findOne: () => mongooseQuery(campaign) };
|
||||||
|
if (id === "../models/DiscordGuildLink") return { findOne: () => mongooseQuery(guildLink) };
|
||||||
|
if (id === "../models/ServiceLinkRequest") return {};
|
||||||
|
if (id === "../models/User") return {};
|
||||||
|
if (id === "../services/service-links") return { requireDiscordBot: (req, res, next) => next(), NOTIFICATION_WINDOW_MS: 1 };
|
||||||
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
|
};
|
||||||
|
|
||||||
|
const moduleStub = { exports: {} };
|
||||||
|
vm.compileFunction(readRepoFile("backend", "src", "routes", "discord.js"), ["require", "module", "exports"])(
|
||||||
|
requireStub, moduleStub, moduleStub.exports
|
||||||
|
);
|
||||||
|
|
||||||
|
async function call(route, { body = {}, params = {} } = {}) {
|
||||||
|
const handlers = routes.get(route);
|
||||||
|
assert.ok(handlers, `${route} is not mounted`);
|
||||||
|
const res = { payload: null, json(payload) { this.payload = payload; } };
|
||||||
|
// The last handler of the chain, skipping the bot-secret gate the harness stands behind.
|
||||||
|
await handlers[handlers.length - 1]({ body, params: { guildId: GUILD_ID, ...params } }, res);
|
||||||
|
return res.payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
function actor(id) {
|
||||||
|
return store.find((candidate) => candidate._id === id);
|
||||||
|
}
|
||||||
|
|
||||||
|
return { call, actor };
|
||||||
|
}
|
||||||
|
|
||||||
|
const ASSIGN = "POST /bot/guild/:guildId/actors/assign";
|
||||||
|
const UNASSIGN = "POST /bot/guild/:guildId/actors/unassign";
|
||||||
|
|
||||||
|
function assignmentRouteTests() {
|
||||||
|
test("assigning links one campaign character to a Discord player", async () => {
|
||||||
|
const api = loadDiscordRoutes({ actors: [{ _id: "actor-1", name: "Katlum" }] });
|
||||||
|
|
||||||
|
const response = await api.call(ASSIGN, { body: { actorId: "actor-1", discordUserId: PLAYER } });
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.deepEqual(response.actor, { id: "actor-1", name: "Katlum", discordUserId: PLAYER });
|
||||||
|
assert.equal(api.actor("actor-1").discordUserId, PLAYER);
|
||||||
|
assert.equal(response.previous, null);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a player never holds two characters: taking a second one frees the first", async () => {
|
||||||
|
const api = loadDiscordRoutes({
|
||||||
|
actors: [
|
||||||
|
{ _id: "actor-1", name: "Katlum", discordUserId: PLAYER },
|
||||||
|
{ _id: "actor-2", name: "Solus" }
|
||||||
|
]
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await api.call(ASSIGN, { body: { actorId: "actor-2", discordUserId: PLAYER } });
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.equal(api.actor("actor-1").discordUserId, null);
|
||||||
|
assert.equal(api.actor("actor-2").discordUserId, PLAYER);
|
||||||
|
assert.deepEqual(response.previous, { id: "actor-1", name: "Katlum" });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a player cannot take a character another player already holds", async () => {
|
||||||
|
const api = loadDiscordRoutes({
|
||||||
|
actors: [{ _id: "actor-1", name: "Katlum", discordUserId: OTHER_PLAYER }]
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await api.call(ASSIGN, { body: { actorId: "actor-1", discordUserId: PLAYER } });
|
||||||
|
|
||||||
|
assert.equal(response.msg, "discord.errors.actor-held");
|
||||||
|
assert.equal(api.actor("actor-1").discordUserId, OTHER_PLAYER);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a server administrator moves a held character to themselves", async () => {
|
||||||
|
const api = loadDiscordRoutes({
|
||||||
|
actors: [
|
||||||
|
{ _id: "actor-1", name: "Katlum", discordUserId: OTHER_PLAYER },
|
||||||
|
{ _id: "actor-2", name: "Solus", discordUserId: PLAYER }
|
||||||
|
]
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await api.call(ASSIGN, { body: { actorId: "actor-1", discordUserId: PLAYER, admin: true } });
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.equal(api.actor("actor-1").discordUserId, PLAYER);
|
||||||
|
assert.equal(api.actor("actor-2").discordUserId, null);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("unassigning without a character frees the one linked to the player", async () => {
|
||||||
|
const api = loadDiscordRoutes({
|
||||||
|
actors: [
|
||||||
|
{ _id: "actor-1", name: "Katlum", discordUserId: PLAYER },
|
||||||
|
{ _id: "actor-2", name: "Silang", discordUserId: OTHER_PLAYER }
|
||||||
|
]
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await api.call(UNASSIGN, { body: { discordUserId: PLAYER } });
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.deepEqual(response.actor, { id: "actor-1", name: "Katlum" });
|
||||||
|
assert.equal(response.wasYours, true);
|
||||||
|
assert.equal(api.actor("actor-1").discordUserId, null);
|
||||||
|
assert.equal(api.actor("actor-2").discordUserId, OTHER_PLAYER);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a player cannot unassign a character held by somebody else", async () => {
|
||||||
|
const api = loadDiscordRoutes({
|
||||||
|
actors: [{ _id: "actor-1", name: "Katlum", discordUserId: OTHER_PLAYER }]
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await api.call(UNASSIGN, { body: { actorId: "actor-1", discordUserId: PLAYER } });
|
||||||
|
|
||||||
|
assert.equal(response.msg, "discord.errors.actor-held");
|
||||||
|
assert.equal(api.actor("actor-1").discordUserId, OTHER_PLAYER);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a server administrator frees anybody's character", async () => {
|
||||||
|
const api = loadDiscordRoutes({
|
||||||
|
actors: [{ _id: "actor-1", name: "Katlum", discordUserId: OTHER_PLAYER }]
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await api.call(UNASSIGN, { body: { actorId: "actor-1", discordUserId: PLAYER, admin: true } });
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.equal(response.wasYours, false);
|
||||||
|
assert.equal(api.actor("actor-1").discordUserId, null);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function assignmentGuardTests() {
|
||||||
|
test("linking needs a guild with a connected account and a linked campaign", async () => {
|
||||||
|
const connected = loadDiscordRoutes({ actors: [{ _id: "actor-1", name: "Katlum" }] });
|
||||||
|
assert.equal((await connected.call(ASSIGN, { body: { actorId: "actor-1", discordUserId: PLAYER } })).status, "ok");
|
||||||
|
|
||||||
|
const notLinked = loadDiscordRoutes({ guildLink: null });
|
||||||
|
assert.equal((await notLinked.call(ASSIGN, { body: { actorId: "actor-1", discordUserId: PLAYER } })).msg, "discord.errors.not-connected");
|
||||||
|
assert.equal((await notLinked.call(UNASSIGN, { body: { discordUserId: PLAYER } })).msg, "discord.errors.not-connected");
|
||||||
|
|
||||||
|
const noCampaign = loadDiscordRoutes({ campaign: null });
|
||||||
|
assert.equal((await noCampaign.call(ASSIGN, { body: { actorId: "actor-1", discordUserId: PLAYER } })).msg, "errors.notfound");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("linking needs a whole player and one of the campaign's own characters", async () => {
|
||||||
|
const api = loadDiscordRoutes({ actors: [{ _id: "actor-1", name: "Katlum", campaign: "campaign-1" }] });
|
||||||
|
|
||||||
|
assert.equal((await api.call(ASSIGN, { body: { discordUserId: PLAYER } })).msg, "errors.missing-data");
|
||||||
|
assert.equal((await api.call(ASSIGN, { body: { actorId: "actor-1" } })).msg, "errors.missing-data");
|
||||||
|
assert.equal((await api.call(ASSIGN, { body: { actorId: "actor-1", discordUserId: "bob" } })).msg, "errors.missing-data");
|
||||||
|
assert.equal((await api.call(UNASSIGN, { body: {} })).msg, "errors.missing-data");
|
||||||
|
|
||||||
|
const otherCampaign = loadDiscordRoutes({ actors: [{ _id: "actor-9", name: "Stranger", campaign: "campaign-2" }] });
|
||||||
|
assert.equal((await otherCampaign.call(ASSIGN, { body: { actorId: "actor-9", discordUserId: PLAYER } })).msg, "errors.notfound");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the bot roster carries the player linked to each character", async () => {
|
||||||
|
const api = loadDiscordRoutes({
|
||||||
|
actors: [
|
||||||
|
{ _id: "actor-1", name: "Katlum", discordUserId: PLAYER },
|
||||||
|
{ _id: "actor-2", name: "Solus" }
|
||||||
|
]
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await api.call("GET /bot/guild/:guildId/actors");
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.deepEqual(response.actors.map((actor) => actor.discordUserId), [PLAYER, null]);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function botWiringTests() {
|
||||||
|
const commands = readRepoFile("discord-bot", "src", "commands.js");
|
||||||
|
const api = readRepoFile("discord-bot", "src", "dragonroll-api.js");
|
||||||
|
const bot = readRepoFile("discord-bot", "src", "index.js");
|
||||||
|
|
||||||
|
test("the dragonroll command carries assign and unassign with a character choice", () => {
|
||||||
|
assert.match(commands, /setName\('assign'\)[\s\S]*setName\('character'\)[\s\S]*setRequired\(true\)[\s\S]*setAutocomplete\(true\)/);
|
||||||
|
assert.match(commands, /setName\('unassign'\)[\s\S]*setName\('character'\)[\s\S]*setAutocomplete\(true\)/);
|
||||||
|
// The unassign character is optional, so a player can free their own without naming it.
|
||||||
|
const unassign = /setName\('unassign'\)([\s\S]*)$/.exec(commands)?.[1] ?? "";
|
||||||
|
assert.doesNotMatch(unassign, /setRequired\(true\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the bot client calls the new routes and answers the new subcommands", () => {
|
||||||
|
assert.match(api, /\/actors\/assign/);
|
||||||
|
assert.match(api, /\/actors\/unassign/);
|
||||||
|
assert.match(bot, /\['assign', 'unassign'\]\.includes\(subcommand\)/);
|
||||||
|
assert.match(bot, /dragonroll\.assignActor\(guildId/);
|
||||||
|
assert.match(bot, /dragonroll\.unassignActor\(guildId/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the character choices autocomplete both new subcommands", () => {
|
||||||
|
const autocomplete = /if \(interaction\.commandName === 'dragonroll'\) \{([\s\S]*?)\n \}\n/.exec(bot)?.[1] ?? "";
|
||||||
|
assert.match(autocomplete, /\['assign', 'unassign'\]\.includes\(subcommand\)/);
|
||||||
|
assert.match(autocomplete, /respondActorChoices\(interaction, guildId\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the roster shows the player and the status card shows your character", () => {
|
||||||
|
assert.match(bot, /actor\.discordUserId \? ` 🎮 <@\$\{actor\.discordUserId\}>`/);
|
||||||
|
assert.match(bot, /name: 'Your character'/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the actor model holds one Discord player per character and per campaign", () => {
|
||||||
|
const model = readRepoFile("backend", "src", "models", "Actor.js");
|
||||||
|
assert.match(model, /discordUserId: \{ type: String, default: null \}/);
|
||||||
|
assert.match(model, /\{ campaign: 1, discordUserId: 1 \},\s*\{ unique: true, partialFilterExpression: \{ discordUserId: \{ \$type: 'string' \} \} \}/);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
assignmentRouteTests();
|
||||||
|
assignmentGuardTests();
|
||||||
|
botWiringTests();
|
||||||
564
tests/docs.test.js
Normal file
564
tests/docs.test.js
Normal file
@@ -0,0 +1,564 @@
|
|||||||
|
// Tests for the documentation under /docs (Syndria98/dragonroll#79): the markdown pages are the
|
||||||
|
// documentation, so what has to stay right is (1) the pages are well formed — a title, a slug, a
|
||||||
|
// numbered group, translations for the group's label, and no link pointing at a page that does not
|
||||||
|
// exist, (2) the page about an integration really documents what that integration offers, which is
|
||||||
|
// checked against the sources that define it: the slash commands of discord-bot/src/commands.js and
|
||||||
|
// the commands the Obsidian plugin registers, (3) the routes: /docs and /docs/<slug> render the
|
||||||
|
// documentation and every other address still opens the window app, and (4) inside a campaign the
|
||||||
|
// same documentation opens as a window of its own instead of a trip to /docs
|
||||||
|
// (Syndria98/dragonroll#95).
|
||||||
|
//
|
||||||
|
// `frontend/app/services/DocsMarkdown.js` is the pure part of the docs (headings, slugs, titles) and
|
||||||
|
// is loaded straight from source, the way the other tests load the frontend services; it imports
|
||||||
|
// nothing, so the repository root's no-dependencies rule holds. `Docs.js` itself is not loaded: it
|
||||||
|
// reads the markdown through `import.meta.glob`, which only Vite can answer.
|
||||||
|
//
|
||||||
|
// 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");
|
||||||
|
|
||||||
|
function readRepoFile(...parts) {
|
||||||
|
return fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadDocsMarkdown() {
|
||||||
|
const source = readRepoFile("frontend", "app", "services", "DocsMarkdown.js");
|
||||||
|
return vm.compileFunction(source.replace("export {", "return {") , [], {
|
||||||
|
parsingContext: vm.createContext({}),
|
||||||
|
})();
|
||||||
|
}
|
||||||
|
|
||||||
|
const docs = loadDocsMarkdown();
|
||||||
|
|
||||||
|
// The documentation pages, as the folder layout defines them.
|
||||||
|
const docsRoot = path.join(__dirname, "..", "frontend", "app", "content", "docs");
|
||||||
|
const docPages = fs.readdirSync(docsRoot, { withFileTypes: true })
|
||||||
|
.filter((entry) => entry.isDirectory())
|
||||||
|
.sort((left, right) => left.name.localeCompare(right.name))
|
||||||
|
.flatMap((group) => fs.readdirSync(path.join(docsRoot, group.name))
|
||||||
|
.filter((file) => file.endsWith(".md"))
|
||||||
|
.sort()
|
||||||
|
.map((file) => ({
|
||||||
|
group: group.name.replace(/^\d+-/, ""),
|
||||||
|
slug: file.replace(/^\d+-/, "").replace(/\.md$/, ""),
|
||||||
|
markdown: fs.readFileSync(path.join(docsRoot, group.name, file), "utf8"),
|
||||||
|
}))
|
||||||
|
);
|
||||||
|
|
||||||
|
const slugs = new Set(docPages.map((page) => page.slug));
|
||||||
|
const groups = [...new Set(docPages.map((page) => page.group))];
|
||||||
|
|
||||||
|
const pageAbout = (slug) => docPages.find((page) => page.slug === slug);
|
||||||
|
|
||||||
|
// --- The heading helpers the sidebar and the anchors are built from ---
|
||||||
|
|
||||||
|
test("a heading's slug comes out of its words, whatever form they arrive in", () => {
|
||||||
|
assert.equal(docs.Slugify("Link a world"), "link-a-world");
|
||||||
|
assert.equal(docs.Slugify(" Auto-sync, and one actor "), "auto-sync-and-one-actor");
|
||||||
|
assert.equal(docs.Slugify("Dragonroll: Force Sync!"), "dragonroll-force-sync");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the anchor built from a heading's markdown is the one built from its HTML", () => {
|
||||||
|
// The sidebar slugs the markdown source and the renderer slugs what marked produced, so the two
|
||||||
|
// have to land on the same anchor for a sidebar link to land on its section.
|
||||||
|
const pairs = [
|
||||||
|
["**Link** a `world`", "<strong>Link</strong> a <code>world</code>"],
|
||||||
|
["Commands & characters", "Commands & characters"],
|
||||||
|
["[Foundry](/docs/foundry) worlds", '<a href="/docs/foundry">Foundry</a> worlds'],
|
||||||
|
["It's here", "It's here"],
|
||||||
|
];
|
||||||
|
|
||||||
|
for (const [markdown, html] of pairs) {
|
||||||
|
assert.equal(docs.Slugify(markdown), docs.Slugify(html), `slug of ${markdown}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("repeated headings get distinct anchors, in the order they are written", () => {
|
||||||
|
const slug = docs.CreateHeadingSlugger();
|
||||||
|
assert.equal(slug("Setup"), "setup");
|
||||||
|
assert.equal(slug("setup"), "setup-1");
|
||||||
|
assert.equal(slug("Setup"), "setup-2");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the headings of a page are listed in order, with their anchors", () => {
|
||||||
|
const headings = docs.HeadingsFromMarkdown([
|
||||||
|
"# Connecting a service",
|
||||||
|
"",
|
||||||
|
"## How a connection works",
|
||||||
|
"text",
|
||||||
|
"### What it allows",
|
||||||
|
"```sh",
|
||||||
|
"# not a heading",
|
||||||
|
"```",
|
||||||
|
"## Next",
|
||||||
|
].join("\n"));
|
||||||
|
|
||||||
|
// The service is loaded from another realm, so the values are copied out before being compared.
|
||||||
|
assert.deepEqual(
|
||||||
|
JSON.parse(JSON.stringify(headings.map(({ depth, text, slug }) => ({ depth, text, slug })))),
|
||||||
|
[
|
||||||
|
{ depth: 1, text: "Connecting a service", slug: "connecting-a-service" },
|
||||||
|
{ depth: 2, text: "How a connection works", slug: "how-a-connection-works" },
|
||||||
|
{ depth: 3, text: "What it allows", slug: "what-it-allows" },
|
||||||
|
{ depth: 2, text: "Next", slug: "next" },
|
||||||
|
]
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a page takes its title from its first heading", () => {
|
||||||
|
assert.equal(docs.TitleFromMarkdown("# Your first campaign\n\n## Signing in"), "Your first campaign");
|
||||||
|
assert.equal(docs.TitleFromMarkdown("no heading here"), "");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The pages themselves ---
|
||||||
|
|
||||||
|
test("the documentation has pages, in numbered groups", () => {
|
||||||
|
assert.ok(docPages.length >= 5, `expected several documentation pages, found ${docPages.length}`);
|
||||||
|
|
||||||
|
for (const page of docPages) {
|
||||||
|
const folder = `${page.group}`;
|
||||||
|
assert.ok(folder.length > 0, `${page.slug} sits in an oddly named folder`);
|
||||||
|
assert.match(page.slug, /^[a-z0-9]+(-[a-z0-9]+)*$/, `${page.slug} is not a url-friendly slug`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every page has a title, and no two pages share a slug", () => {
|
||||||
|
const seen = new Set();
|
||||||
|
|
||||||
|
for (const page of docPages) {
|
||||||
|
const title = docs.TitleFromMarkdown(page.markdown);
|
||||||
|
assert.ok(title, `${page.slug} has no heading to title it`);
|
||||||
|
assert.ok(!seen.has(page.slug), `${page.slug} is published twice`);
|
||||||
|
seen.add(page.slug);
|
||||||
|
}
|
||||||
|
assert.equal(seen.size, docPages.length);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every page has sections, which is what the sidebar lists beside it", () => {
|
||||||
|
for (const page of docPages) {
|
||||||
|
const sections = docs.HeadingsFromMarkdown(page.markdown).filter((heading) => heading.depth > 1);
|
||||||
|
assert.ok(sections.length, `${page.slug} has no section headings to list`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every group has a sidebar label in every locale", () => {
|
||||||
|
const labels = ["en", "es", "ca"].map((locale) =>
|
||||||
|
JSON.parse(readRepoFile("frontend", "i18n", "locales", locale, "docs.json"))
|
||||||
|
);
|
||||||
|
|
||||||
|
assert.ok(labels.every((label) => label.groups), "each docs.json namespace needs a `groups` object");
|
||||||
|
|
||||||
|
for (const group of groups) {
|
||||||
|
for (const label of labels) {
|
||||||
|
const text = label.groups[group];
|
||||||
|
assert.ok(text, `the "${group}" group has no label in its docs.json`);
|
||||||
|
assert.notEqual(text, group, `the "${group}" label is untranslated`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the pages only link to pages that are published", () => {
|
||||||
|
for (const page of docPages) {
|
||||||
|
for (const link of page.markdown.matchAll(/\]\((\/docs\/?[a-z0-9-]*)\)/g)) {
|
||||||
|
const target = link[1].replace("/docs/", "");
|
||||||
|
if (!target) continue; // /docs itself
|
||||||
|
assert.ok(slugs.has(target), `${page.slug} links to ${link[1]}, which is not published`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the three integrations each have their own page", () => {
|
||||||
|
for (const slug of ["discord", "foundry", "obsidian"]) {
|
||||||
|
assert.ok(pageAbout(slug), `${slug} has no documentation page`);
|
||||||
|
}
|
||||||
|
assert.ok(pageAbout("connecting-a-service"), "the shared way of connecting a service is undocumented");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The integrations pages describe what the integrations actually offer ---
|
||||||
|
|
||||||
|
// discord-bot/src/commands.js builds the slash commands with discord.js, which the repository root
|
||||||
|
// does not install: the builder is stubbed by one that records the names it is given.
|
||||||
|
function loadSlashCommands() {
|
||||||
|
const registered = [];
|
||||||
|
|
||||||
|
class Builder {
|
||||||
|
constructor() {
|
||||||
|
this.name = "";
|
||||||
|
this.parent = null;
|
||||||
|
this.children = [];
|
||||||
|
this.optionNames = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
setName(name) { this.name = name; return this; }
|
||||||
|
setDescription() { return this; }
|
||||||
|
setContexts() { return this; }
|
||||||
|
setRequired() { return this; }
|
||||||
|
setMaxLength() { return this; }
|
||||||
|
setAutocomplete() { return this; }
|
||||||
|
addChoices() { return this; }
|
||||||
|
addStringOption(configure) { configure(new Builder()); return this; }
|
||||||
|
addBooleanOption(configure) { configure(new Builder()); return this; }
|
||||||
|
addSubcommand(configure) {
|
||||||
|
const sub = new Builder();
|
||||||
|
sub.parent = this;
|
||||||
|
configure(sub);
|
||||||
|
this.children.push(sub);
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class SlashCommandBuilder extends Builder {
|
||||||
|
constructor() {
|
||||||
|
super();
|
||||||
|
registered.push(this);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const moduleStub = { exports: {} };
|
||||||
|
vm.compileFunction(readRepoFile("discord-bot", "src", "commands.js"), ["require", "module", "exports"])(
|
||||||
|
(id) => {
|
||||||
|
if (id === "discord.js") return { InteractionContextType: { Guild: 0 }, SlashCommandBuilder };
|
||||||
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
|
},
|
||||||
|
moduleStub,
|
||||||
|
moduleStub.exports
|
||||||
|
);
|
||||||
|
|
||||||
|
const names = [];
|
||||||
|
for (const command of registered) {
|
||||||
|
names.push(command.name);
|
||||||
|
for (const sub of command.children) names.push(`${command.name} ${sub.name}`);
|
||||||
|
}
|
||||||
|
return names;
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the Discord page lists every command the bot declares", () => {
|
||||||
|
const about = pageAbout("discord");
|
||||||
|
const commands = loadSlashCommands();
|
||||||
|
|
||||||
|
// Sanity check on the stub before it is trusted to list anything.
|
||||||
|
assert.ok(commands.includes("characters"), `expected the bot's commands, got ${commands.join(", ")}`);
|
||||||
|
assert.ok(commands.includes("dragonroll connect"));
|
||||||
|
|
||||||
|
for (const command of commands) {
|
||||||
|
assert.ok(
|
||||||
|
about.markdown.includes("`/" + command),
|
||||||
|
`the Discord page does not document /${command}`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// The Obsidian plugin registers each command palette entry with `this.addCommand({ id, name, … })`.
|
||||||
|
function loadObsidianCommands() {
|
||||||
|
const source = readRepoFile("obsidian-plugin", "main.js");
|
||||||
|
const commands = [...source.matchAll(
|
||||||
|
/this\.addCommand\(\{\s*id:\s*["']([^"']+)["'],\s*name:\s*["']([^"']+)["']/g
|
||||||
|
)].map((match) => ({ id: match[1], name: match[2] }));
|
||||||
|
|
||||||
|
// Sanity check on the extraction before it is trusted to list anything.
|
||||||
|
assert.ok(commands.length >= 2, `expected the plugin's commands, got ${commands.length}`);
|
||||||
|
|
||||||
|
return commands;
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the Obsidian page lists the commands the plugin registers", () => {
|
||||||
|
const about = pageAbout("obsidian");
|
||||||
|
|
||||||
|
for (const command of loadObsidianCommands()) {
|
||||||
|
assert.ok(
|
||||||
|
about.markdown.includes(`**${command.name}**`),
|
||||||
|
`the Obsidian page does not document "${command.name}" (${command.id})`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the Foundry page covers what the world and the campaign do with each other", () => {
|
||||||
|
const about = pageAbout("foundry").markdown;
|
||||||
|
|
||||||
|
for (const topic of ["Auto-sync", "Force Sync", "item directory", "Pairing Status"]) {
|
||||||
|
assert.ok(about.includes(topic), `the Foundry page never mentions ${topic}`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The routes ---
|
||||||
|
|
||||||
|
test("the app renders whichever page the address asks for", () => {
|
||||||
|
const root = readRepoFile("frontend", "app", "app.vue");
|
||||||
|
assert.match(root, /<NuxtPage\s*\/?>/, "app.vue has to render the matched page");
|
||||||
|
assert.doesNotMatch(root, /CreateWindow/, "the window app boots from AppShell, not from app.vue");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the documentation has a route of its own, and the app keeps the rest", () => {
|
||||||
|
const pages = path.join("frontend", "app", "pages");
|
||||||
|
const docsRoutes = ["docs/index.vue", "docs/[slug].vue"];
|
||||||
|
|
||||||
|
for (const route of docsRoutes) {
|
||||||
|
assert.match(
|
||||||
|
readRepoFile(pages, route),
|
||||||
|
/<DocsView\s*\/?>/,
|
||||||
|
`${route} has to render the documentation`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const route of ["index.vue", "[...all].vue"]) {
|
||||||
|
assert.match(
|
||||||
|
readRepoFile(pages, route),
|
||||||
|
/<AppShell\s*\/?>/,
|
||||||
|
`${route} has to open the window app`
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The catch-all is what keeps /link/authorize, and every path a service already links to, alive.
|
||||||
|
const shell = readRepoFile("frontend", "app", "components", "views", "AppShell.vue");
|
||||||
|
assert.ok(shell.includes("/link/authorize"), "the service link screen has to stay reachable");
|
||||||
|
assert.ok(shell.includes("/discord/authorize"), "the legacy Discord link has to stay reachable");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the main menu points at the documentation", () => {
|
||||||
|
const menu = readRepoFile("frontend", "app", "components", "windows", "MainMenuWindow.vue");
|
||||||
|
assert.match(menu, /href="\/docs"/, "the main menu has to link to /docs");
|
||||||
|
assert.match(menu, /main-menu\.documentation/);
|
||||||
|
|
||||||
|
for (const locale of ["en", "es", "ca"]) {
|
||||||
|
const strings = JSON.parse(readRepoFile("frontend", "i18n", "locales", locale, "main-menu.json"));
|
||||||
|
assert.ok(strings.documentation, `${locale} has no label for the documentation link`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Inside a campaign the documentation is reached from the top bar, on the left of the campaign
|
||||||
|
// settings button (Syndria98/dragonroll#90), and it opens as a window of its own in front of the
|
||||||
|
// workspace rather than as a trip to /docs (Syndria98/dragonroll#95).
|
||||||
|
test("the campaign top bar opens the documentation as a window", () => {
|
||||||
|
const topBar = readRepoFile("frontend", "app", "components", "viewer", "TopBar.vue");
|
||||||
|
const right = /<div class="right">([\s\S]*?)<\/div>/.exec(topBar)?.[1];
|
||||||
|
assert.ok(right, "expected the top bar to have its buttons in a right-hand group");
|
||||||
|
|
||||||
|
assert.match(right, /OpenDocumentation/, "the top bar has a button for the documentation");
|
||||||
|
assert.match(right, /main-menu\.documentation/, "under the same label the main menu uses");
|
||||||
|
assert.match(topBar, /CreateWindow\('documentation'\)/, "the button opens the documentation window");
|
||||||
|
|
||||||
|
// To the left of the settings button: the group is read left to right, so the button has to
|
||||||
|
// come first in it.
|
||||||
|
const docsAt = right.indexOf("OpenDocumentation");
|
||||||
|
const settingsAt = right.indexOf("OpenCampaignSettings");
|
||||||
|
assert.ok(
|
||||||
|
docsAt !== -1 && settingsAt !== -1 && docsAt < settingsAt,
|
||||||
|
"the documentation button sits on the left of the settings button"
|
||||||
|
);
|
||||||
|
|
||||||
|
// The open notes of the campaign live only in memory, so nothing the top bar does may leave
|
||||||
|
// the app: a window comes to the front, an address would take the campaign away with it.
|
||||||
|
assert.doesNotMatch(topBar, /href="\/docs"/, "the top bar does not send the campaign to /docs");
|
||||||
|
assert.doesNotMatch(topBar, /target="_blank"/, "…nor opens a tab out of it");
|
||||||
|
});
|
||||||
|
|
||||||
|
// The window the button opens (Syndria98/dragonroll#95): registered like every other window, and
|
||||||
|
// reading its pages without ever leaving the window it is drawn in.
|
||||||
|
test("the documentation is registered as a window", () => {
|
||||||
|
const definitions = readRepoFile("frontend", "app", "services", "WindowDefinitions.js");
|
||||||
|
const definition = /\n\s*documentation:\s*\{([\s\S]*?)\n\s{2}\}/.exec(definitions);
|
||||||
|
assert.ok(definition, "the documentation is not registered as a window");
|
||||||
|
|
||||||
|
assert.match(definition[1], /title:\s*'windows\.documentation'/, "its title is an i18n key");
|
||||||
|
assert.match(definition[1], /movable:\s*true/);
|
||||||
|
assert.match(definition[1], /close:\s*\(\)\s*=>\s*ClearWindow\(\{\s*type:\s*'documentation'\s*\}\)/);
|
||||||
|
|
||||||
|
const component = /component:\s*\(\)\s*=>\s*import\(['"]~\/components\/windows\/([^'"]+)['"]\)/.exec(definition[1]);
|
||||||
|
assert.ok(component, "the documentation window names no component of its own");
|
||||||
|
assert.ok(
|
||||||
|
fs.existsSync(path.join(__dirname, "..", "frontend", "app", "components", "windows", component[1])),
|
||||||
|
`the documentation window points at a component that does not exist: ${component[1]}`
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the documentation window reads the published pages without leaving itself", () => {
|
||||||
|
const source = readRepoFile("frontend", "app", "components", "windows", "DocumentationWindow.vue");
|
||||||
|
|
||||||
|
// The pages are the ones of app/content/docs, read through the same service the /docs page uses.
|
||||||
|
assert.match(source, /from '~\/services\/Docs'/, "the window reads the documentation through the docs service");
|
||||||
|
for (const lookup of ["GetDocsNav", "GetDocsPage", "GetDocsFirstSlug"]) {
|
||||||
|
assert.match(source, new RegExp(lookup), `the window does not use ${lookup}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Resizable, with a floor low enough to read the two columns on a small screen.
|
||||||
|
assert.match(source, /SetResizable\(id,\s*true\)/, "the window is resizable");
|
||||||
|
assert.match(source, /SetMinSize\(id,\s*\{\s*width:\s*\d+,\s*height:\s*\d+\s*\}\)/, "…and it says how small it goes");
|
||||||
|
|
||||||
|
// Nothing in it is a route: the window holds the page it shows, so following the sidebar
|
||||||
|
// leaves the campaign behind it exactly as it was.
|
||||||
|
assert.doesNotMatch(source, /NuxtLink|useRoute|navigateTo/, "the documentation window does not navigate the app");
|
||||||
|
|
||||||
|
// Which means the links the markdown carries (`[Foundry](/docs/foundry)`) and the sections of
|
||||||
|
// a page have to be answered inside the window.
|
||||||
|
assert.match(source, /\\\/docs/, "the markdown's links to the other pages are followed in the window");
|
||||||
|
assert.match(source, /scrollIntoView/, "so are the sections of the page it is showing");
|
||||||
|
assert.match(source, /preventDefault/, "…and none of them reaches the app's address");
|
||||||
|
|
||||||
|
// A window is not a page: the reading column is what scrolls, nothing is as tall as the viewport.
|
||||||
|
const reading = /\.docs-reading\s*\{[^}]*\}/.exec(source)?.[0];
|
||||||
|
assert.ok(reading, "the window has a reading column of its own");
|
||||||
|
assert.match(reading, /overflow-y:\s*auto/, "…and that is what scrolls");
|
||||||
|
assert.doesNotMatch(source, /100vh/, "a window fills itself, not the viewport");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the documentation window is titled in every locale", () => {
|
||||||
|
for (const locale of ["en", "es", "ca"]) {
|
||||||
|
const strings = JSON.parse(readRepoFile("frontend", "i18n", "locales", locale, "windows.json"));
|
||||||
|
const title = strings.documentation;
|
||||||
|
assert.ok(title, `${locale} has no title for the documentation window`);
|
||||||
|
if (locale !== "en") {
|
||||||
|
assert.notEqual(title.toLowerCase(), "documentation", `the ${locale} window title is untranslated`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- How the documentation is laid out (Syndria98/dragonroll#85) ---
|
||||||
|
|
||||||
|
// The `<style>` of DocsView.vue read as `{ selector, media, declarations }` rules: the block is
|
||||||
|
// flat — every rule is a top level selector and the only nesting is the media queries — so pairing
|
||||||
|
// braces is enough, and the test does not need a stylesheet parser the repository root lacks.
|
||||||
|
function DocsStyleRules() {
|
||||||
|
const source = readRepoFile("frontend", "app", "components", "views", "DocsView.vue");
|
||||||
|
const css = source
|
||||||
|
.slice(source.indexOf(">", source.indexOf("<style")) + 1, source.indexOf("</style>"))
|
||||||
|
.replace(/\/\*[\s\S]*?\*\//g, "");
|
||||||
|
|
||||||
|
const rules = [];
|
||||||
|
|
||||||
|
function scan(text, media) {
|
||||||
|
let index = 0;
|
||||||
|
for (;;) {
|
||||||
|
const brace = text.indexOf("{", index);
|
||||||
|
if (brace === -1) return rules;
|
||||||
|
|
||||||
|
const selector = text.slice(index, brace).trim();
|
||||||
|
let depth = 1;
|
||||||
|
let cursor = brace + 1;
|
||||||
|
while (cursor < text.length && depth > 0) {
|
||||||
|
if (text[cursor] === "{") depth += 1;
|
||||||
|
else if (text[cursor] === "}") depth -= 1;
|
||||||
|
cursor += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
const body = text.slice(brace + 1, cursor - 1);
|
||||||
|
if (selector.startsWith("@")) scan(body, selector);
|
||||||
|
else rules.push({ selector, media, declarations: body });
|
||||||
|
index = cursor;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return scan(css, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
const styleRules = DocsStyleRules();
|
||||||
|
|
||||||
|
// The rules that name a class, with `media` null for the plain ones and "min-width" / "max-width"
|
||||||
|
// for the ones a media query switches on. The last one wins where they overlap, as in a stylesheet.
|
||||||
|
function RulesFor(className, media = null) {
|
||||||
|
return styleRules.filter((rule) =>
|
||||||
|
rule.selector.split(",").some((name) => name.trim() === className) &&
|
||||||
|
(media === null ? rule.media === null : Boolean(rule.media) && rule.media.includes(media))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
// A `padding:` shorthand spread over its four sides, the way the browser reads it.
|
||||||
|
function PaddingOf(rule) {
|
||||||
|
const shorthand = rule.declarations.match(/(?:^|[;\s])padding:\s*([^;]+)/);
|
||||||
|
assert.ok(shorthand, `the ${rule.selector} rule sets no padding to compare`);
|
||||||
|
|
||||||
|
const values = shorthand[1].trim().split(/\s+/).map((value) => parseFloat(value));
|
||||||
|
assert.ok(
|
||||||
|
values.length <= 4 && values.every((value) => Number.isFinite(value)),
|
||||||
|
`only px padding is compared here, ${rule.selector} has "${shorthand[1].trim()}"`
|
||||||
|
);
|
||||||
|
|
||||||
|
return {
|
||||||
|
top: values[0],
|
||||||
|
right: values[1] ?? values[0],
|
||||||
|
bottom: values[2] ?? values[0],
|
||||||
|
left: values[3] ?? values[1] ?? values[0],
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the two asides are as tall as the page they stand beside", () => {
|
||||||
|
for (const className of [".docs-sidebar", ".docs-sections"]) {
|
||||||
|
const aside = RulesFor(className).find((rule) => /position:\s*sticky/.test(rule.declarations));
|
||||||
|
assert.ok(aside, `${className} has to stay beside the text while the page scrolls`);
|
||||||
|
assert.match(aside.declarations, /height:\s*100vh/, `${className} has to fill the page, not just its own contents`);
|
||||||
|
assert.doesNotMatch(aside.declarations, /max-height/, `${className} is capped at a screen height by 'height'`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a narrow window stacks the columns and lets each one be its own height", () => {
|
||||||
|
const stacked = RulesFor(".docs-sidebar", "max-width");
|
||||||
|
assert.equal(stacked.length, 1, "the stacked layout is set by one rule");
|
||||||
|
assert.match(stacked[0].declarations, /position:\s*static/, "a stacked sidebar does not follow the scroll");
|
||||||
|
assert.match(stacked[0].declarations, /height:\s*auto/, "…and it is not held at a screen height either");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the reading column is centred in the space left beside the sidebar", () => {
|
||||||
|
const reading = RulesFor(".docs-article").find((rule) => /max-width:/.test(rule.declarations));
|
||||||
|
assert.ok(reading, "the text has to be capped in width to be readable");
|
||||||
|
assert.match(reading.declarations, /margin-inline:\s*auto/, "…and centred in the space left beside the sidebar");
|
||||||
|
assert.match(reading.selector, /\.docs-pager/, "the pager under the text follows the same column");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a very wide window keeps the sections next to the text, not at the edge of the screen", () => {
|
||||||
|
const centred = RulesFor(".docs", "min-width");
|
||||||
|
assert.equal(centred.length, 1, "one wide window rule centres the documentation");
|
||||||
|
assert.match(centred[0].declarations, /justify-content:\s*center/);
|
||||||
|
|
||||||
|
const wider = Number(centred[0].media.match(/min-width:\s*(\d+)/)[1]);
|
||||||
|
assert.ok(wider >= 1400, `${wider}px is not a wide window: the layout breaks before that`);
|
||||||
|
|
||||||
|
const main = RulesFor(".docs-main", "min-width");
|
||||||
|
assert.equal(main.length, 1, "the main column is capped once the window is wide");
|
||||||
|
assert.match(main[0].declarations, /flex:\s*0 1 \d+px/, "…so it stops growing and the sections sit next to it");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the sections aside has more room around its links than the sidebar has", () => {
|
||||||
|
const shared = RulesFor(".docs-sidebar").find((rule) => /padding:/.test(rule.declarations));
|
||||||
|
const sections = RulesFor(".docs-sections").filter((rule) => /padding:/.test(rule.declarations)).pop();
|
||||||
|
assert.ok(sections && sections !== shared, "the sections aside sets its own padding");
|
||||||
|
|
||||||
|
const room = PaddingOf(sections);
|
||||||
|
const sidebar = PaddingOf(shared);
|
||||||
|
|
||||||
|
for (const side of ["top", "right", "bottom", "left"]) {
|
||||||
|
assert.ok(room[side] >= sidebar[side], `the sections aside is tighter than the sidebar on the ${side}`);
|
||||||
|
}
|
||||||
|
assert.ok(
|
||||||
|
["top", "right", "bottom", "left"].some((side) => room[side] > sidebar[side]),
|
||||||
|
"the sections aside asks for more padding than the two asides share"
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
// The /docs page and the documentation window render the very same HTML, so the markdown it renders
|
||||||
|
// is styled once, in the stylesheet both of them load, rather than in whichever one asked for it
|
||||||
|
// first (Syndria98/dragonroll#95).
|
||||||
|
test("the rendered markdown is styled once, where both readers reach it", () => {
|
||||||
|
const styles = readRepoFile("frontend", "app", "assets", "css", "main.scss");
|
||||||
|
const markdown = styles.slice(styles.indexOf(".docs-markdown h1"));
|
||||||
|
|
||||||
|
for (const selector of [
|
||||||
|
".docs-markdown h1",
|
||||||
|
".docs-markdown h2",
|
||||||
|
".docs-markdown h3",
|
||||||
|
".docs-markdown p",
|
||||||
|
".docs-markdown a",
|
||||||
|
".docs-markdown code",
|
||||||
|
".docs-markdown pre",
|
||||||
|
".docs-markdown table",
|
||||||
|
]) {
|
||||||
|
assert.ok(markdown.includes(selector), `${selector} has to be styled for both readers of the docs`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Theme colours, as everywhere: the window and the page are read on either theme.
|
||||||
|
for (const colour of ["var\\(--color-border\\)", "var\\(--color-link\\)", "var\\(--color-background-light\\)"]) {
|
||||||
|
assert.match(markdown, new RegExp(colour), "the markdown's look uses the theme's colours");
|
||||||
|
}
|
||||||
|
});
|
||||||
429
tests/foundry-force-import.test.js
Normal file
429
tests/foundry-force-import.test.js
Normal file
@@ -0,0 +1,429 @@
|
|||||||
|
// Tests for the sidebar's "force import from Foundry" button (Syndria98/dragonroll#77):
|
||||||
|
// right-clicking an actor or an item offers to pull the whole actor list or item
|
||||||
|
// directory of the linked world over. The campaign asks its own backend, which reads
|
||||||
|
// the world's snapshot off the bridge and writes every document through the writers a
|
||||||
|
// sync push uses — so a row the campaign already holds is written over instead of
|
||||||
|
// imported a second time, and the answer counts the rows it made apart from the ones it
|
||||||
|
// wrote over, which is what the confirmation toast says.
|
||||||
|
//
|
||||||
|
// The repository root installs no dependencies, so nothing here is required the way the
|
||||||
|
// backend itself does it. The import route runs in a stubbed `require` against a fake
|
||||||
|
// bridge and fake writers, and those writers are then loaded for real and run against
|
||||||
|
// fake models, like tests/item-folder-sync.test.js does. The sidebar is a Vue component
|
||||||
|
// this repository cannot build, so its checks read the source, like
|
||||||
|
// tests/item-sheet-window.test.js does.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
const repoRequire = (relative) => require(path.join(__dirname, "..", relative));
|
||||||
|
|
||||||
|
const sidebarSource = read("frontend", "app", "components", "partials", "ContentSidebar.vue");
|
||||||
|
|
||||||
|
// --- The import route, against a fake bridge and fake writers ---------------------
|
||||||
|
|
||||||
|
const LINKED_CAMPAIGN = { _id: "campaign-1", id: "campaign-1", foundryWorldId: "world-1" };
|
||||||
|
|
||||||
|
// What the bridge answers for a whole list: the bridge wraps what the world published
|
||||||
|
// in `{status, data, world}`, and the route unwraps `data` again.
|
||||||
|
function bridgeSnapshot(data, world = { id: "world-1", title: "Curse of Strahd" }) {
|
||||||
|
return { status: 200, data: { status: "ok", data, world, syncedAt: "2026-10-15T10:00:00.000Z" } };
|
||||||
|
}
|
||||||
|
|
||||||
|
// The foundry route with every require stubbed. `campaign` is what the caller owns
|
||||||
|
// (`null` for a campaign that is not theirs), `answers` maps the bridge path to its
|
||||||
|
// answer — an Error stands for a bridge that cannot be reached — and `mapping` says
|
||||||
|
// what a world document becomes in the campaign: a new row or one it already had.
|
||||||
|
function loadImportRoute({
|
||||||
|
campaign = LINKED_CAMPAIGN,
|
||||||
|
answers = {},
|
||||||
|
mapping = () => ({ created: true }),
|
||||||
|
} = {}) {
|
||||||
|
const routes = new Map();
|
||||||
|
const router = {
|
||||||
|
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||||
|
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||||
|
};
|
||||||
|
const asked = { bridgePaths: [], campaignFilters: [] };
|
||||||
|
const written = { actors: [], items: [] };
|
||||||
|
|
||||||
|
const requireStub = (id) => {
|
||||||
|
if (id === "express") return { Router: () => router };
|
||||||
|
if (id === "../services/foundry") {
|
||||||
|
return {
|
||||||
|
requestFoundry: async (bridgePath) => {
|
||||||
|
asked.bridgePaths.push(bridgePath);
|
||||||
|
const answer = answers[bridgePath];
|
||||||
|
if (answer instanceof Error) throw answer;
|
||||||
|
// A bridge with nothing to answer is one no GM client has published to.
|
||||||
|
return answer ?? { status: 503, data: { status: "error", msg: "foundry.not-ready" } };
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||||
|
if (id === "../models/Campaign") {
|
||||||
|
return {
|
||||||
|
findOne: (filter) => {
|
||||||
|
asked.campaignFilters.push(filter);
|
||||||
|
const query = { select: () => query, lean: () => Promise.resolve(campaign ?? null) };
|
||||||
|
return query;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
}
|
||||||
|
if (id === "./foundry-link") {
|
||||||
|
return {
|
||||||
|
saveFoundryActor: async (own, source) => { written.actors.push(source); return mapping(source); },
|
||||||
|
saveFoundryItem: async (own, source) => { written.items.push(source); return mapping(source); },
|
||||||
|
};
|
||||||
|
}
|
||||||
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
|
};
|
||||||
|
|
||||||
|
const moduleStub = { exports: {} };
|
||||||
|
vm.compileFunction(read("backend", "src", "routes", "foundry.js"), ["require", "module", "exports"])(
|
||||||
|
requireStub, moduleStub, moduleStub.exports
|
||||||
|
);
|
||||||
|
|
||||||
|
async function importFrom(body, user = { id: "user-1" }) {
|
||||||
|
const handlers = routes.get("POST /import");
|
||||||
|
assert.ok(handlers, "POST /import is not mounted");
|
||||||
|
const res = { payload: null, json(payload) { this.payload = payload; } };
|
||||||
|
await handlers[handlers.length - 1]({ body, user }, res);
|
||||||
|
return res.payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { importFrom, asked, written };
|
||||||
|
}
|
||||||
|
|
||||||
|
const TWO_ACTORS = [
|
||||||
|
{ _id: "actor-1", name: "Thalia", type: "character" },
|
||||||
|
{ _id: "actor-2", name: "Grimnir", type: "npc" },
|
||||||
|
];
|
||||||
|
|
||||||
|
test("the import pulls the world's actors and counts them new against updated", async () => {
|
||||||
|
const route = loadImportRoute({
|
||||||
|
answers: { "api/actors": bridgeSnapshot(TWO_ACTORS) },
|
||||||
|
mapping: (source) => ({ created: source._id === "actor-2" }),
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await route.importFrom({ campaign: "campaign-1", kind: "actors" });
|
||||||
|
|
||||||
|
assert.deepEqual(route.asked.bridgePaths, ["api/actors"], "the actors are read off the bridge");
|
||||||
|
assert.deepEqual(route.asked.campaignFilters[0], { _id: "campaign-1", createdBy: "user-1" },
|
||||||
|
"only the campaign the caller holds is imported");
|
||||||
|
assert.deepEqual(route.written.actors.map((source) => source.name), ["Thalia", "Grimnir"]);
|
||||||
|
assert.deepEqual(response, { status: "ok", kind: "actors", imported: 1, updated: 1 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the item import pulls the world's item directory", async () => {
|
||||||
|
const route = loadImportRoute({
|
||||||
|
answers: { "api/items": bridgeSnapshot([{ _id: "item-1", name: "Longsword", type: "weapon" }]) },
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await route.importFrom({ campaign: "campaign-1", kind: "items" });
|
||||||
|
|
||||||
|
assert.deepEqual(route.asked.bridgePaths, ["api/items"], "the bridge's world items, not its actors");
|
||||||
|
assert.equal(route.written.items.length, 1);
|
||||||
|
assert.equal(route.written.actors.length, 0);
|
||||||
|
assert.deepEqual(response, { status: "ok", kind: "items", imported: 1, updated: 0 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("only the actor and item lists can be imported", async () => {
|
||||||
|
for (const kind of [undefined, "maps", "notes", "everything"]) {
|
||||||
|
const route = loadImportRoute();
|
||||||
|
const response = await route.importFrom({ campaign: "campaign-1", kind });
|
||||||
|
assert.equal(response.msg, "errors.missing-data", `"${kind}" is not a list to import`);
|
||||||
|
assert.deepEqual(route.asked.bridgePaths, [], "nothing is asked of the bridge for it");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a campaign the caller does not hold is not imported", async () => {
|
||||||
|
const route = loadImportRoute({ campaign: null });
|
||||||
|
|
||||||
|
const response = await route.importFrom({ campaign: "someone-elses-campaign", kind: "actors" });
|
||||||
|
|
||||||
|
assert.equal(response.msg, "errors.notfound");
|
||||||
|
assert.deepEqual(route.asked.bridgePaths, [], "the bridge is not asked for somebody else's world");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a campaign with no linked world is told so, and nothing is written", async () => {
|
||||||
|
const route = loadImportRoute({ campaign: { _id: "campaign-1" } });
|
||||||
|
|
||||||
|
const response = await route.importFrom({ campaign: "campaign-1", kind: "items" });
|
||||||
|
|
||||||
|
assert.equal(response.msg, "foundry.errors.import-not-linked");
|
||||||
|
assert.deepEqual(route.asked.bridgePaths, []);
|
||||||
|
assert.deepEqual(route.written.items, []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("another world's snapshot is not written into the campaign", async () => {
|
||||||
|
const route = loadImportRoute({
|
||||||
|
answers: { "api/actors": bridgeSnapshot(TWO_ACTORS, { id: "world-2", title: "Another World" }) },
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await route.importFrom({ campaign: "campaign-1", kind: "actors" });
|
||||||
|
|
||||||
|
assert.equal(response.msg, "foundry.errors.import-world-mismatch");
|
||||||
|
assert.deepEqual(route.written.actors, [], "the bridge keeps one world's snapshot at a time");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a bridge that is not there says so instead of importing nothing", async () => {
|
||||||
|
const notSetUp = loadImportRoute({
|
||||||
|
answers: { "api/actors": Object.assign(new Error("Foundry API is not configured."), { code: "FOUNDRY_NOT_CONFIGURED" }) },
|
||||||
|
});
|
||||||
|
const unreachable = loadImportRoute({ answers: { "api/actors": new Error("ECONNREFUSED") } });
|
||||||
|
const noSnapshotYet = loadImportRoute(); // answers nothing → the bridge's own 503
|
||||||
|
|
||||||
|
for (const route of [notSetUp, unreachable, noSnapshotYet]) {
|
||||||
|
const response = await route.importFrom({ campaign: "campaign-1", kind: "actors" });
|
||||||
|
assert.equal(response.msg, "foundry.errors.import-unavailable");
|
||||||
|
assert.deepEqual(route.written.actors, []);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a world document that maps to nothing is not counted", async () => {
|
||||||
|
const route = loadImportRoute({
|
||||||
|
answers: { "api/items": bridgeSnapshot([
|
||||||
|
{ _id: "item-1", name: "Longsword", type: "weapon" },
|
||||||
|
{ _id: "spell-1", name: "Magic Missile", type: "spell" },
|
||||||
|
]) },
|
||||||
|
// what is not gear maps to nothing, exactly like a sync push skips it
|
||||||
|
mapping: (source) => (source.type === "spell" ? null : { created: true }),
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await route.importFrom({ campaign: "campaign-1", kind: "items" });
|
||||||
|
|
||||||
|
assert.equal(route.written.items.length, 2, "every world document is offered to the writer");
|
||||||
|
assert.deepEqual(response, { status: "ok", kind: "items", imported: 1, updated: 0 });
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The writers, against fake models: existing rows are written over, not doubled ---
|
||||||
|
|
||||||
|
function mongooseQuery(value) {
|
||||||
|
const result = {
|
||||||
|
select: () => result,
|
||||||
|
sort: () => result,
|
||||||
|
limit: (count) => mongooseQuery(value.slice(0, count)),
|
||||||
|
lean: () => Promise.resolve(value),
|
||||||
|
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||||
|
};
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enough of the query language the writers use: equality, $or and $exists.
|
||||||
|
function matches(document, filter = {}) {
|
||||||
|
return Object.entries(filter).every(([key, expected]) => {
|
||||||
|
if (key === "$or") return expected.some((part) => matches(document, part));
|
||||||
|
const value = document?.[key];
|
||||||
|
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
|
||||||
|
return Object.entries(expected).every(([operator, wanted]) => {
|
||||||
|
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
|
||||||
|
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return String(value ?? "") === String(expected ?? "");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function fakeModel(table, seed = [], campaignId) {
|
||||||
|
const rows = [];
|
||||||
|
let counter = 0;
|
||||||
|
|
||||||
|
function Document(data = {}) {
|
||||||
|
counter += 1;
|
||||||
|
this._id = `${table}-${counter}`;
|
||||||
|
this.isNew = true;
|
||||||
|
this.foundryNames = [];
|
||||||
|
Object.assign(this, data);
|
||||||
|
}
|
||||||
|
Document.prototype.save = async function save() {
|
||||||
|
if (this.isNew) rows.push(this);
|
||||||
|
this.isNew = false;
|
||||||
|
return this;
|
||||||
|
};
|
||||||
|
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||||
|
|
||||||
|
for (const data of seed) {
|
||||||
|
const row = new Document({ campaign: campaignId, ...data });
|
||||||
|
row.isNew = false;
|
||||||
|
rows.push(row);
|
||||||
|
}
|
||||||
|
|
||||||
|
const model = function Model(data) { return new Document(data); };
|
||||||
|
model.rows = rows;
|
||||||
|
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
|
||||||
|
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
|
||||||
|
return model;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The sync route loaded for its writers: the same functions the world's pushes and the
|
||||||
|
// campaign's import run through, here against rows the campaign already holds.
|
||||||
|
function loadFoundryWriters({ seed = {} } = {}) {
|
||||||
|
const campaign = { _id: "campaign-1", id: "campaign-1", foundryWorldId: "world-1" };
|
||||||
|
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||||
|
const models = {
|
||||||
|
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||||
|
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||||
|
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||||
|
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||||
|
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||||
|
};
|
||||||
|
|
||||||
|
const requireStub = (id) => {
|
||||||
|
if (id === "express") return { Router: () => ({ get: () => {}, post: () => {} }) };
|
||||||
|
if (id.startsWith("node:")) return require(id);
|
||||||
|
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||||
|
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||||
|
if (id === "../services/actor-foundry") return repoRequire(path.join("backend", "src", "services", "actor-foundry.js"));
|
||||||
|
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||||
|
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||||
|
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||||
|
if (models[id]) return models[id];
|
||||||
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
|
};
|
||||||
|
|
||||||
|
const moduleStub = { exports: {} };
|
||||||
|
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
|
||||||
|
requireStub, moduleStub, moduleStub.exports
|
||||||
|
);
|
||||||
|
return { campaign, models, writers: moduleStub.exports };
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the writers a sync push uses are the ones an import writes through", () => {
|
||||||
|
const { writers } = loadFoundryWriters();
|
||||||
|
|
||||||
|
assert.equal(typeof writers.saveFoundryActor, "function");
|
||||||
|
assert.equal(typeof writers.saveFoundryItem, "function");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an imported actor the campaign already has is written over, not made again", async () => {
|
||||||
|
const sync = loadFoundryWriters({
|
||||||
|
seed: { actors: [{ _id: "actor-1", name: "Thalia the old", foundryActorId: "actor-1", level: 1 }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const worldActor = { _id: "actor-1", name: "Thalia", type: "character", system: { details: { level: 3 } } };
|
||||||
|
const first = await sync.writers.saveFoundryActor(sync.campaign, worldActor);
|
||||||
|
const second = await sync.writers.saveFoundryActor(sync.campaign, worldActor);
|
||||||
|
|
||||||
|
assert.equal(sync.models["../models/Actor"].rows.length, 1, "the world's actor stands in one row");
|
||||||
|
assert.equal(first.created, false, "the row was already there");
|
||||||
|
assert.equal(second.created, false);
|
||||||
|
assert.equal(sync.models["../models/Actor"].rows[0].name, "Thalia", "a force import writes the world over the row");
|
||||||
|
assert.equal(sync.models["../models/Actor"].rows[0].level, 3);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an actor the world has never been seen as becomes one row, and the next import updates it", async () => {
|
||||||
|
const sync = loadFoundryWriters();
|
||||||
|
|
||||||
|
const worldActor = { _id: "actor-9", name: "Grimnir", type: "npc", system: { details: { cr: 2 } } };
|
||||||
|
const made = await sync.writers.saveFoundryActor(sync.campaign, worldActor);
|
||||||
|
const again = await sync.writers.saveFoundryActor(sync.campaign, worldActor);
|
||||||
|
|
||||||
|
assert.equal(made.created, true, "the first import makes the row");
|
||||||
|
assert.equal(again.created, false, "the one after it only writes it over");
|
||||||
|
assert.equal(sync.models["../models/Actor"].rows.length, 1);
|
||||||
|
assert.equal(sync.models["../models/Actor"].rows[0].foundryActorId, "actor-9");
|
||||||
|
});
|
||||||
|
|
||||||
|
// A forced sync from the module's context menu (Syndria98/dragonroll#96) replaces
|
||||||
|
// everything the campaign holds for the actor; a live change is a merge and leaves the
|
||||||
|
// fields the world says nothing about to the campaign.
|
||||||
|
test("a forced actor sync clears what the campaign wrote; a live change keeps it", async () => {
|
||||||
|
const sync = loadFoundryWriters({
|
||||||
|
seed: { actors: [{
|
||||||
|
_id: "actor-1",
|
||||||
|
name: "Thalia",
|
||||||
|
foundryActorId: "actor-1",
|
||||||
|
traits: "A trait the campaign wrote",
|
||||||
|
tools: ["Thieves' tools"],
|
||||||
|
languages: ["Elvish"],
|
||||||
|
skills: { perception: true },
|
||||||
|
savingThrows: { dex: true },
|
||||||
|
currency: { gp: 50 },
|
||||||
|
}] },
|
||||||
|
});
|
||||||
|
// The world says nothing about any of those: the fields a live edit leaves out.
|
||||||
|
const worldActor = { _id: "actor-1", name: "Thalia", type: "character", system: {} };
|
||||||
|
|
||||||
|
await sync.writers.saveFoundryActor(sync.campaign, worldActor, false, false);
|
||||||
|
let row = sync.models["../models/Actor"].rows[0];
|
||||||
|
assert.equal(row.traits, "A trait the campaign wrote", "a live push leaves what the campaign wrote alone");
|
||||||
|
assert.deepEqual(row.tools, ["Thieves' tools"]);
|
||||||
|
assert.deepEqual(row.languages, ["Elvish"]);
|
||||||
|
assert.deepEqual(row.skills, { perception: true });
|
||||||
|
assert.deepEqual(row.savingThrows, { dex: true });
|
||||||
|
assert.deepEqual(row.currency, { gp: 50 });
|
||||||
|
|
||||||
|
await sync.writers.saveFoundryActor(sync.campaign, worldActor, false, true);
|
||||||
|
row = sync.models["../models/Actor"].rows[0];
|
||||||
|
assert.equal(row.name, "Thalia", "the actor is still the one the world sent");
|
||||||
|
assert.equal(row.traits, "", "a forced sync clears the trait the campaign wrote");
|
||||||
|
assert.deepEqual(row.tools, [], "and the tools, languages, skills, saving throws and coin it held");
|
||||||
|
assert.deepEqual(row.languages, []);
|
||||||
|
assert.deepEqual(row.skills, {});
|
||||||
|
assert.deepEqual(row.savingThrows, {});
|
||||||
|
assert.deepEqual(row.currency, {});
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a hand-made item folds into the import instead of doubling, and keeps being updated", async () => {
|
||||||
|
const sync = loadFoundryWriters({
|
||||||
|
seed: { items: [{ _id: "item-1", name: "Longsword", quantity: 1 }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const worldItem = { _id: "sword-9", name: "Longsword", type: "weapon", system: { quantity: 4, weight: 3, rarity: "rare" } };
|
||||||
|
const made = await sync.writers.saveFoundryItem(sync.campaign, worldItem);
|
||||||
|
const again = await sync.writers.saveFoundryItem(sync.campaign, worldItem);
|
||||||
|
|
||||||
|
const rows = sync.models["../models/Item"].rows;
|
||||||
|
assert.equal(rows.length, 1, "the campaign's own row is the world item's row");
|
||||||
|
assert.equal(made.created, false, "adopting a row the campaign made is not importing it new");
|
||||||
|
assert.equal(again.created, false);
|
||||||
|
assert.equal(rows[0].foundryItemId, "sword-9");
|
||||||
|
assert.equal(rows[0].quantity, 4, "and the force import writes the world over it");
|
||||||
|
assert.equal(rows[0].rarity, "rare");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The sidebar: the button, and the toast it leaves behind ----------------------
|
||||||
|
|
||||||
|
const entryMenu = /function showEntryMenu[\s\S]*?\n\}/.exec(sidebarSource)?.[0] ?? "";
|
||||||
|
const importer = /async function forceImportFromFoundry[\s\S]*?\n\}/.exec(sidebarSource)?.[0] ?? "";
|
||||||
|
|
||||||
|
test("the actor and item rows offer a force import in their right-click menu", () => {
|
||||||
|
assert.ok(entryMenu, "the sidebar has an entry menu");
|
||||||
|
assert.match(entryMenu, /if \(entityType === ['"]actor['"] \|\| entityType === ['"]item['"]\)/,
|
||||||
|
"the offer belongs to the two lists mirroring a world, not the maps");
|
||||||
|
assert.match(entryMenu, /t\(['"]campaigns\.foundry-import\.run['"]\)/);
|
||||||
|
assert.match(entryMenu, /action: \(\) => \{ HideContextMenu\(\); forceImportFromFoundry\(entityType\); \}/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the import is asked for once, says what landed, and reads the list back", async () => {
|
||||||
|
assert.ok(importer, "the sidebar has the import");
|
||||||
|
assert.match(importer, /if \(!campaignId\.value \|\| !section \|\| importingFoundry\.value\) return;/,
|
||||||
|
"clicking a row again while the world is on its way does not start a second import");
|
||||||
|
assert.match(importer, /Server\(\)\.post\(['"]\/foundry\/import['"], \{ campaign: campaignId\.value, kind: section \}\)/);
|
||||||
|
assert.match(importer, /DisplayToast\(['"]green['"], t\(['"]campaigns\.foundry-import\.done['"]/);
|
||||||
|
assert.match(importer, /imported: response\.data\.imported \?\? 0/);
|
||||||
|
assert.match(importer, /updated: response\.data\.updated \?\? 0/);
|
||||||
|
assert.match(importer, /await fetchCampaignEntries\(section\)/, "what arrived is read back into the list");
|
||||||
|
// the failed import says what the backend said, the way the other windows do
|
||||||
|
assert.match(importer, /DisplayToast\(['"]red['"], t\(response\.data\.msg \|\| ['"]campaigns\.foundry-import\.error['"]\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every locale has the strings of the button, its toast and its errors", () => {
|
||||||
|
for (const locale of ["en", "es", "ca"]) {
|
||||||
|
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
|
||||||
|
for (const key of ["run", "done", "error"]) {
|
||||||
|
assert.ok(campaigns["foundry-import"]?.[key], `${locale} is missing campaigns.foundry-import.${key}`);
|
||||||
|
}
|
||||||
|
const foundry = JSON.parse(read("frontend", "i18n", "locales", locale, "foundry.json"));
|
||||||
|
for (const key of ["import-not-linked", "import-unavailable", "import-world-mismatch"]) {
|
||||||
|
assert.ok(foundry.errors?.[key], `${locale} is missing foundry.errors.${key}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
239
tests/foundry-icon-picker.test.js
Normal file
239
tests/foundry-icon-picker.test.js
Normal file
@@ -0,0 +1,239 @@
|
|||||||
|
// Tests for Syndria98/dragonroll#65: picking an item's icon opens a window that asks
|
||||||
|
// where the icon comes from — upload one from this device, or load one from the icon
|
||||||
|
// library the linked Foundry world ships in its data directory's `icons/` folder.
|
||||||
|
// That library runs into the thousands, so it is listed one folder per request, with
|
||||||
|
// its icons paged and its thumbnails lazy to load.
|
||||||
|
//
|
||||||
|
// The icon listing helpers are a pure CommonJS service, so they are required and called
|
||||||
|
// directly. The windows and the bridge live in files this repository installs no
|
||||||
|
// dependencies for, so those checks read the sources, like tests/map-viewer.test.js does.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
const iconService = require(path.join(__dirname, "..", "backend", "src", "services", "foundry-icons"));
|
||||||
|
const foundryService = require(path.join(__dirname, "..", "backend", "src", "services", "foundry"));
|
||||||
|
const http = require("node:http");
|
||||||
|
|
||||||
|
const windowDefsSource = read("frontend", "app", "services", "WindowDefinitions.js");
|
||||||
|
const itemWindowSource = read("frontend", "app", "components", "windows", "ItemSheetWindow.vue");
|
||||||
|
const sourceWindowSource = read("frontend", "app", "components", "windows", "ItemIconSourceWindow.vue");
|
||||||
|
const foundryIconsSource = read("frontend", "app", "components", "windows", "FoundryIconPickerWindow.vue");
|
||||||
|
const foundryRouteSource = read("backend", "src", "routes", "foundry.js");
|
||||||
|
const bridgeSource = read("dragonroll-foundry", "bridge", "server.js");
|
||||||
|
|
||||||
|
// --- The listing service: what the browser may ask for, and what it gets back ------
|
||||||
|
|
||||||
|
test("icon listings always stay inside Foundry's icon root", () => {
|
||||||
|
assert.equal(iconService.ICON_ROOT, "icons");
|
||||||
|
assert.equal(iconService.normalizeIconDirectory(""), "icons");
|
||||||
|
assert.equal(iconService.normalizeIconDirectory(undefined), "icons");
|
||||||
|
assert.equal(iconService.normalizeIconDirectory("/icons/svg/"), "icons/svg");
|
||||||
|
assert.equal(iconService.normalizeIconDirectory("icons/sfdcc/axes"), "icons/sfdcc/axes");
|
||||||
|
assert.equal(iconService.normalizeIconDirectory("icons/./svg"), "icons/svg");
|
||||||
|
// nothing that leaves `icons/` is a folder this route will list
|
||||||
|
assert.equal(iconService.normalizeIconDirectory("icons/../secret"), null);
|
||||||
|
assert.equal(iconService.normalizeIconDirectory("../etc"), null);
|
||||||
|
assert.equal(iconService.normalizeIconDirectory("systems/dnd5e/icons"), null);
|
||||||
|
assert.equal(iconService.parentIconDirectory("icons/svg/axes"), "icons/svg");
|
||||||
|
assert.equal(iconService.parentIconDirectory("icons"), null);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("icons are listed a page at a time, bounded", () => {
|
||||||
|
assert.deepEqual(iconService.readIconListingPage({}), { limit: iconService.DEFAULT_ICON_PAGE_SIZE, offset: 0 });
|
||||||
|
assert.deepEqual(iconService.readIconListingPage({ limit: "20", offset: "240" }), { limit: 20, offset: 240 });
|
||||||
|
// a caller cannot ask for the whole library at once, or for a page before the first
|
||||||
|
assert.equal(iconService.readIconListingPage({ limit: "99999" }).limit, iconService.MAX_ICON_PAGE_SIZE);
|
||||||
|
assert.equal(iconService.readIconListingPage({ offset: "-10" }).offset, 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("only image files become icons, and they load from the world's own address", () => {
|
||||||
|
const listing = iconService.shapeIconListing({
|
||||||
|
base: "https://vtt.example.com/",
|
||||||
|
dir: "icons/svg",
|
||||||
|
listing: {
|
||||||
|
directories: ["icons/svg/creature", "icons/svg/creature", "icons/svg"],
|
||||||
|
files: ["icons/svg/dice.svg", "icons/svg/sword.png", "icons/svg/readme.txt", "stray.md"],
|
||||||
|
offset: 0,
|
||||||
|
next: 120,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(listing.dir, "icons/svg");
|
||||||
|
assert.equal(listing.parent, "icons");
|
||||||
|
assert.deepEqual(listing.folders.map((folder) => folder.path), ["icons/svg/creature"]);
|
||||||
|
assert.deepEqual(listing.folders.map((folder) => folder.name), ["creature"]);
|
||||||
|
assert.deepEqual(listing.files.map((icon) => icon.path), ["icons/svg/dice.svg", "icons/svg/sword.png"]);
|
||||||
|
assert.equal(listing.files[0].name, "dice.svg");
|
||||||
|
assert.equal(listing.files[0].url, "https://vtt.example.com/icons/svg/dice.svg");
|
||||||
|
assert.equal(listing.next, 120);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an icon path with spaces still gives the browser a loadable url", () => {
|
||||||
|
assert.equal(
|
||||||
|
iconService.joinFoundryAssetUrl("http://vtt.test:30000", "icons/sfdcc/axes/halberd sword.svg"),
|
||||||
|
"http://vtt.test:30000/icons/sfdcc/axes/halberd%20sword.svg"
|
||||||
|
);
|
||||||
|
assert.equal(iconService.joinFoundryAssetUrl("", "icons/svg/dice.svg"), "");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The backend route ------------------------------------------------------------
|
||||||
|
|
||||||
|
test("the foundry proxy lists one icon folder for one of the caller's campaigns", () => {
|
||||||
|
assert.match(foundryRouteSource, /router\.get\(["']\/icons["'], async \(req, res\)/);
|
||||||
|
const route = /router\.get\(["']\/icons[\s\S]*?module\.exports/.exec(foundryRouteSource)?.[0] ?? foundryRouteSource;
|
||||||
|
// the campaign is where the world address is kept, so it has to be the caller's own
|
||||||
|
assert.match(route, /findOwnedCampaign\(req\.query\.campaign, req\.user\.id\)/);
|
||||||
|
assert.match(foundryRouteSource, /Campaign\.findOne\(\{\s*_id:\s*campaignId,\s*createdBy:\s*userId\s*\}\)/);
|
||||||
|
assert.match(route, /campaign\.settings\?\.integrations\?\.foundryUrl/);
|
||||||
|
assert.match(route, /requestFoundry\(`api\/icons\?\$\{query\}`\)/);
|
||||||
|
// a folder outside the icon root is refused before it reaches the Foundry host
|
||||||
|
assert.match(route, /const dir = normalizeIconDirectory\(req\.query\.dir\);/);
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The bridge on the Foundry host ------------------------------------------------
|
||||||
|
|
||||||
|
test("the bridge lists a core icon folder and never leaves the icon root", () => {
|
||||||
|
assert.match(bridgeSource, /const dataPath = \(process\.env\.DRAGONROLL_FOUNDRY_DATA_PATH \|\| ""\)\.trim\(\);/);
|
||||||
|
assert.match(bridgeSource, /if \(pathname === "\/api\/icons"\) return sendIconListing\(request, response\);/);
|
||||||
|
assert.match(bridgeSource, /if \(!dataPath\) return sendJson\(response, 503, \{ status: "error", msg: "foundry\.errors\.icons-unavailable" \}\);/);
|
||||||
|
const normalize = /function normalizeIconDirectory\(input\) \{[\s\S]*?\n\}/.exec(bridgeSource)?.[0] ?? "";
|
||||||
|
assert.match(normalize, /segments\.includes\("\.\."\) \|\| segments\[0\] !== iconRoot/);
|
||||||
|
// the answer is one folder plus the offset of the next page of its icons
|
||||||
|
assert.match(bridgeSource, /directories\.sort\(\(a, b\) => a\.localeCompare\(b\)\);/);
|
||||||
|
assert.match(bridgeSource, /const page = files\.slice\(offset, offset \+ limit\);/);
|
||||||
|
assert.match(bridgeSource, /next: offset \+ page\.length < files\.length \? offset \+ page\.length : null,/);
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The windows -------------------------------------------------------------------
|
||||||
|
|
||||||
|
test("choosing an icon opens its own window from the item sheet", () => {
|
||||||
|
assert.match(windowDefsSource, /item_icon_source:\s*{\s*title:[^}]*ItemIconSourceWindow\.vue/s);
|
||||||
|
assert.match(windowDefsSource, /foundry_icons:\s*{\s*title:[^}]*FoundryIconPickerWindow\.vue/s);
|
||||||
|
// the item window asks where the icon comes from instead of opening a file dialog
|
||||||
|
assert.match(itemWindowSource, /CreateChildWindow\(id, ['"]item_icon_source['"]/);
|
||||||
|
assert.doesNotMatch(itemWindowSource, /type="file"/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the icon source window offers uploading and Foundry, and uploads the local file", () => {
|
||||||
|
assert.match(sourceWindowSource, /\$t\(['"]campaigns\.item\.icon-picker\.upload['"]\)/);
|
||||||
|
assert.match(sourceWindowSource, /\$t\(['"]campaigns\.item\.icon-picker\.foundry['"]\)/);
|
||||||
|
// upload: a local file, sent through the item route like the character sheet does its photo
|
||||||
|
assert.match(sourceWindowSource, /type="file" accept="image\/\*"/);
|
||||||
|
assert.match(sourceWindowSource, /\/item\/upload-image\?item=\$\{itemId\}/);
|
||||||
|
assert.match(sourceWindowSource, /formData\.append\(['"]image['"], file\)/);
|
||||||
|
// and it hands the item over to the icon browser, as its child window
|
||||||
|
assert.match(sourceWindowSource, /CreateChildWindow\(id, ['"]foundry_icons['"]/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the icon browser browses the world's icons folder by folder", () => {
|
||||||
|
assert.match(foundryIconsSource, /\/foundry\/icons\?\$\{params\.toString\(\)\}/);
|
||||||
|
// one folder per request: navigating a folder asks for it, and going up asks for its parent
|
||||||
|
assert.match(foundryIconsSource, /Load\(ICON_ROOT\)/);
|
||||||
|
assert.match(foundryIconsSource, /@click="Load\(folder\.path\)"/);
|
||||||
|
assert.match(foundryIconsSource, /Load\(listing\.value\.parent \|\| ICON_ROOT\)/);
|
||||||
|
// lazy in every way that matters: a page of icons at a time, thumbnails fetched when seen
|
||||||
|
assert.match(foundryIconsSource, /if \(offset\) params\.set\(['"]offset['"], String\(offset\)\)/);
|
||||||
|
assert.match(foundryIconsSource, /@click="Load\(listing\.dir, listing\.next\)"/);
|
||||||
|
assert.match(foundryIconsSource, /loading="lazy"/);
|
||||||
|
// picking an icon stores the world's url and tells the item window about it
|
||||||
|
assert.match(foundryIconsSource, /Server\(\)\.post\(['"]\/item\/update['"], \{ id: itemId, image: icon\.url \}\)/);
|
||||||
|
assert.match(foundryIconsSource, /emitter\.emit\(['"]campaign-entry-updated['"], \{ entityType: ['"]item['"], entry: response\.data\.item \}\)/);
|
||||||
|
assert.match(foundryIconsSource, /ClearWindow\(\{ type: ['"]item_icon_source['"] \}\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The bridge the backend reads the icon library through (issue #74) --------
|
||||||
|
//
|
||||||
|
// The icon window reaches the world's `icons/` folder through the backend, which
|
||||||
|
// in turn reads the bridge that the world already pushes its snapshot to. When
|
||||||
|
// that push works the campaign reads as connected, so a read that still reports
|
||||||
|
// the bridge as unset is the bug this guards against.
|
||||||
|
|
||||||
|
// Set the bridge environment for one call and put it back exactly as it was.
|
||||||
|
function withBridgeEnv(env, run) {
|
||||||
|
const keys = ["FOUNDRY_API_URL", "FOUNDRY_API_CLIENT_URL", "FOUNDRY_API_TOKEN"];
|
||||||
|
const saved = Object.fromEntries(keys.map((key) => [key, process.env[key]]));
|
||||||
|
for (const key of keys) {
|
||||||
|
if (env[key] === undefined) delete process.env[key];
|
||||||
|
else process.env[key] = env[key];
|
||||||
|
}
|
||||||
|
return Promise.resolve()
|
||||||
|
.then(run)
|
||||||
|
.finally(() => {
|
||||||
|
for (const key of keys) {
|
||||||
|
if (saved[key] === undefined) delete process.env[key];
|
||||||
|
else process.env[key] = saved[key];
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
test("a connected world answers icon reads through the bridge set under the client URL", async () => {
|
||||||
|
// A world that connects and syncs is often configured with FOUNDRY_API_CLIENT_URL
|
||||||
|
// alone — the address its own client reaches. The backend read falls back to it,
|
||||||
|
// so the icon window is not told its bridge is unset while the world is right there.
|
||||||
|
const answers = [];
|
||||||
|
const bridge = http.createServer((request, response) => {
|
||||||
|
answers.push(request.url);
|
||||||
|
response.writeHead(200, { "Content-Type": "application/json" });
|
||||||
|
response.end(JSON.stringify({ status: "ok", dir: "icons", directories: ["icons/svg"], files: [], offset: 0, next: null }));
|
||||||
|
});
|
||||||
|
await new Promise((resolve) => bridge.listen(0, "127.0.0.1", resolve));
|
||||||
|
const clientUrl = `http://127.0.0.1:${bridge.address().port}/`;
|
||||||
|
try {
|
||||||
|
const result = await withBridgeEnv(
|
||||||
|
{ FOUNDRY_API_URL: undefined, FOUNDRY_API_CLIENT_URL: clientUrl, FOUNDRY_API_TOKEN: "read-token" },
|
||||||
|
() => foundryService.requestFoundry("api/icons?dir=icons&offset=0&limit=120"),
|
||||||
|
);
|
||||||
|
assert.equal(result.status, 200);
|
||||||
|
assert.equal(result.data.status, "ok");
|
||||||
|
assert.equal(answers.length, 1);
|
||||||
|
assert.match(answers[0], /^\/api\/icons\?/);
|
||||||
|
} finally {
|
||||||
|
await new Promise((resolve) => bridge.close(resolve));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("without a bridge under either name a read says it is not configured", async () => {
|
||||||
|
const error = await withBridgeEnv(
|
||||||
|
{ FOUNDRY_API_URL: undefined, FOUNDRY_API_CLIENT_URL: undefined, FOUNDRY_API_TOKEN: undefined },
|
||||||
|
() => foundryService.requestFoundry("api/icons?dir=icons").then(() => null, (err) => err),
|
||||||
|
);
|
||||||
|
assert.equal(error?.code, "FOUNDRY_NOT_CONFIGURED");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the icon window says what actually failed instead of always blaming the bridge", () => {
|
||||||
|
// axios rejects a non-2xx answer, so the catch reads the route's own i18n key
|
||||||
|
// off the response: a campaign with no world address is told as much rather
|
||||||
|
// than as a bridge that is not set up.
|
||||||
|
assert.match(foundryIconsSource, /requestError\.response\?\.data\?\.msg/);
|
||||||
|
assert.match(foundryIconsSource, /requestError\.response\?\.data\?\.msg \|\| ['"]foundry\.errors\.icons-unavailable['"]/);
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- Strings -----------------------------------------------------------------------
|
||||||
|
|
||||||
|
test("every locale names the icon windows and their controls", () => {
|
||||||
|
for (const locale of ["en", "es", "ca"]) {
|
||||||
|
const windows = JSON.parse(read("frontend", "i18n", "locales", locale, "windows.json"));
|
||||||
|
for (const key of ["icon-source", "foundry-icons"]) {
|
||||||
|
assert.ok(windows[key], `${locale} is missing the ${key} window title`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
|
||||||
|
for (const key of ["intro", "upload", "upload-hint", "foundry", "foundry-hint"]) {
|
||||||
|
assert.ok(campaigns.item?.["icon-picker"]?.[key], `${locale} is missing campaigns.item.icon-picker.${key}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const foundry = JSON.parse(read("frontend", "i18n", "locales", locale, "foundry.json"));
|
||||||
|
for (const key of ["loading", "empty", "load-more", "up"]) {
|
||||||
|
assert.ok(foundry.icons?.[key], `${locale} is missing foundry.icons.${key}`);
|
||||||
|
}
|
||||||
|
for (const key of ["icons-unavailable", "icons-no-world-url"]) {
|
||||||
|
assert.ok(foundry.errors?.[key], `${locale} is missing foundry.errors.${key}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
605
tests/foundry-note-journal.test.js
Normal file
605
tests/foundry-note-journal.test.js
Normal file
@@ -0,0 +1,605 @@
|
|||||||
|
// Tests for the campaign's notes reaching the Foundry world as journal pages
|
||||||
|
// (Syndria98/dragonroll#98): every Dragonroll note stands as a page of the one
|
||||||
|
// journal the world calls "Dragonroll", written by the module and kept in step with
|
||||||
|
// the campaign. The copy runs one way — notes are written in Dragonroll — so the
|
||||||
|
// backend answers with the notes and remembers each note's page; the module reads
|
||||||
|
// them, renders the markdown, and prunes the page of a note the campaign deleted.
|
||||||
|
//
|
||||||
|
// Both sides are loaded the way the other Foundry tests do it: the sync route runs
|
||||||
|
// against a stubbed `require` (models answer with plain objects and a small filter
|
||||||
|
// matcher), and the Foundry module is loaded into a `node:vm` context holding
|
||||||
|
// stubbed Foundry globals (`game.journals` and `JournalEntry` included) with fake
|
||||||
|
// timers, like tests/item-folder-sync.test.js.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
const repoRequire = (relative) => require(path.join(__dirname, "..", relative));
|
||||||
|
|
||||||
|
// --- The sync route against stubbed models -------------------------------------
|
||||||
|
|
||||||
|
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and
|
||||||
|
// lets `select()`, `sort()` and `limit()` sit in between.
|
||||||
|
function mongooseQuery(value) {
|
||||||
|
const result = {
|
||||||
|
select: () => result,
|
||||||
|
sort: () => result,
|
||||||
|
limit: (count) => mongooseQuery(value.slice(0, count)),
|
||||||
|
lean: () => Promise.resolve(value),
|
||||||
|
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||||
|
};
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enough of the query language the note routes use: equality, $or, $in, $nin,
|
||||||
|
// $exists, $ne. Anything else is a filter this test did not expect and says so.
|
||||||
|
function matches(document, filter = {}) {
|
||||||
|
return Object.entries(filter).every(([key, expected]) => {
|
||||||
|
if (key === "$or") return expected.some((part) => matches(document, part));
|
||||||
|
const value = document?.[key];
|
||||||
|
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
|
||||||
|
return Object.entries(expected).every(([operator, wanted]) => {
|
||||||
|
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
|
||||||
|
if (operator === "$in") return wanted.some((entry) => String(value) === String(entry));
|
||||||
|
if (operator === "$nin") return !wanted.some((entry) => String(value) === String(entry));
|
||||||
|
if (operator === "$ne") return String(value ?? "") !== String(wanted ?? "");
|
||||||
|
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return String(value ?? "") === String(expected ?? "");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function fakeModel(table, seed = [], campaignId) {
|
||||||
|
const rows = [];
|
||||||
|
let counter = 0;
|
||||||
|
|
||||||
|
function Document(data = {}) {
|
||||||
|
counter += 1;
|
||||||
|
this._id = `${table}-${counter}`;
|
||||||
|
this.isNew = true;
|
||||||
|
this.foundryNames = [];
|
||||||
|
Object.assign(this, data);
|
||||||
|
}
|
||||||
|
Document.prototype.save = async function save() {
|
||||||
|
if (this.isNew) rows.push(this);
|
||||||
|
this.isNew = false;
|
||||||
|
return this;
|
||||||
|
};
|
||||||
|
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||||
|
|
||||||
|
for (const data of seed) {
|
||||||
|
// A seeded row belongs to the campaign the requests are made against unless the
|
||||||
|
// seed says otherwise: the routes scope every lookup by campaign.
|
||||||
|
const row = new Document({ campaign: campaignId, ...data });
|
||||||
|
row.isNew = false;
|
||||||
|
rows.push(row);
|
||||||
|
}
|
||||||
|
|
||||||
|
const model = function Model(data) { return new Document(data); };
|
||||||
|
model.rows = rows;
|
||||||
|
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
|
||||||
|
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
|
||||||
|
model.deleteOne = async (filter) => {
|
||||||
|
const hit = rows.filter((row) => matches(row, filter));
|
||||||
|
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||||
|
return { deletedCount: hit.length };
|
||||||
|
};
|
||||||
|
model.deleteMany = async (filter) => {
|
||||||
|
const hit = rows.filter((row) => matches(row, filter));
|
||||||
|
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||||
|
return { deletedCount: hit.length };
|
||||||
|
};
|
||||||
|
model.updateMany = async (filter, update) => {
|
||||||
|
const hit = rows.filter((row) => matches(row, filter));
|
||||||
|
for (const row of hit) Object.assign(row, update.$set ?? {});
|
||||||
|
return { modifiedCount: hit.length };
|
||||||
|
};
|
||||||
|
return model;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The Foundry sync route with every model it requires stubbed. `seed` pre-fills the
|
||||||
|
// tables with documents the campaign already holds.
|
||||||
|
function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
||||||
|
const routes = new Map();
|
||||||
|
const router = {
|
||||||
|
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||||
|
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||||
|
};
|
||||||
|
const campaign = { _id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId };
|
||||||
|
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||||
|
const models = {
|
||||||
|
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||||
|
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||||
|
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||||
|
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||||
|
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||||
|
};
|
||||||
|
|
||||||
|
const requireStub = (id) => {
|
||||||
|
if (id === "express") return { Router: () => router };
|
||||||
|
if (id.startsWith("node:")) return require(id); // crypto: the sync token is hashed, not stubbed
|
||||||
|
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||||
|
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||||
|
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||||
|
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||||
|
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||||
|
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||||
|
if (models[id]) return models[id];
|
||||||
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
|
};
|
||||||
|
|
||||||
|
const moduleStub = { exports: {} };
|
||||||
|
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
|
||||||
|
requireStub, moduleStub, moduleStub.exports
|
||||||
|
);
|
||||||
|
|
||||||
|
async function call(route, body = {}) {
|
||||||
|
const handlers = routes.get(route);
|
||||||
|
assert.ok(handlers, `${route} is not mounted`);
|
||||||
|
const res = { payload: null, json(payload) { this.payload = payload; }, set: () => {} };
|
||||||
|
const req = { body, get: (name) => (String(name).toLowerCase() === "authorization" ? "Bearer sync-token" : "") };
|
||||||
|
await handlers[handlers.length - 1](req, res);
|
||||||
|
return res.payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { call, models, campaign };
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- The sync route: the notes it answers and the page ids it keeps ---------------
|
||||||
|
|
||||||
|
test("the world reads the campaign's notes with their content and page mapping", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: {
|
||||||
|
notes: [
|
||||||
|
{ _id: "note-1", title: "Session 1", content: "**The start**", foundryPageId: "page-9" },
|
||||||
|
{ _id: "note-2", title: "Tavern Brawl", content: "- rope" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await sync.call("GET /sync/notes");
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.deepEqual(response.notes.map((note) => note.title), ["Session 1", "Tavern Brawl"]);
|
||||||
|
assert.equal(response.notes[0].content, "**The start**", "the markdown source travels: the module renders it");
|
||||||
|
assert.equal(response.notes[0].foundryPageId, "page-9", "and the note says which page it already stands as");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("mapping a note to the page the module made keeps them paired", async () => {
|
||||||
|
const sync = loadSyncRoute({ seed: { notes: [{ _id: "note-1", title: "Session 1", content: "hi" }] } });
|
||||||
|
|
||||||
|
const response = await sync.call("POST /sync/map-note", {
|
||||||
|
worldId: "world-1", noteId: "note-1", foundryPageId: "page-9",
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.equal(sync.models["../models/Note"].rows[0].foundryPageId, "page-9");
|
||||||
|
|
||||||
|
// Mapping the same pair again is the module checking, not a conflict.
|
||||||
|
const again = await sync.call("POST /sync/map-note", {
|
||||||
|
worldId: "world-1", noteId: "note-1", foundryPageId: "page-9",
|
||||||
|
});
|
||||||
|
assert.equal(again.status, "ok");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a page already mapped to another note is refused", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: {
|
||||||
|
notes: [
|
||||||
|
{ _id: "note-1", title: "Session 1", content: "hi", foundryPageId: "page-9" },
|
||||||
|
{ _id: "note-2", title: "Tavern Brawl", content: "ho" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await sync.call("POST /sync/map-note", {
|
||||||
|
worldId: "world-1", noteId: "note-2", foundryPageId: "page-9",
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(response.status, "error");
|
||||||
|
assert.equal(response.msg, "foundry.errors.note-already-synced");
|
||||||
|
assert.equal(sync.models["../models/Note"].rows.find((row) => row._id === "note-2").foundryPageId, undefined,
|
||||||
|
"the first note keeps its page");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("map-note wants this world's note and a page for it", async () => {
|
||||||
|
const sync = loadSyncRoute({ seed: { notes: [{ _id: "note-1", title: "Session 1", content: "hi" }] } });
|
||||||
|
|
||||||
|
assert.equal((await sync.call("POST /sync/map-note", { worldId: "world-1" })).msg, "errors.missing-data");
|
||||||
|
assert.equal((await sync.call("POST /sync/map-note", { noteId: "note-1", foundryPageId: "page-9" })).msg, "errors.missing-data",
|
||||||
|
"another world cannot map this campaign's note");
|
||||||
|
const gone = await sync.call("POST /sync/map-note", {
|
||||||
|
worldId: "world-1", noteId: "note-gone", foundryPageId: "page-9",
|
||||||
|
});
|
||||||
|
assert.equal(gone.msg, "errors.notfound");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The Foundry module writes the journal ---------------------------------------
|
||||||
|
|
||||||
|
// Foundry's `update` takes dotted paths ("flags.dragonroll-foundry.noteId"); an
|
||||||
|
// embedded document's own id is not a path to set.
|
||||||
|
function writeFoundryPaths(target, data) {
|
||||||
|
for (const [key, value] of Object.entries(data)) {
|
||||||
|
if (key === "_id") continue;
|
||||||
|
const parts = key.split(".");
|
||||||
|
const last = parts.pop();
|
||||||
|
let node = target;
|
||||||
|
for (const part of parts) node = node[part] ??= {};
|
||||||
|
node[last] = value;
|
||||||
|
}
|
||||||
|
return target;
|
||||||
|
}
|
||||||
|
|
||||||
|
function makeWorld({ markdown = true, keepCreateFlags = true, failMapNote = false } = {}) {
|
||||||
|
const state = {
|
||||||
|
hooks: new Map(),
|
||||||
|
registered: new Map(),
|
||||||
|
requests: [],
|
||||||
|
timers: new Map(),
|
||||||
|
intervals: new Map(),
|
||||||
|
keepCreateFlags,
|
||||||
|
failMapNote,
|
||||||
|
// What Dragonroll answers the notes reconcile with. Mapping a page answers
|
||||||
|
// like the real backend: the note keeps the page id, so later reads carry it.
|
||||||
|
remoteNotes: [],
|
||||||
|
nextId: 1,
|
||||||
|
};
|
||||||
|
|
||||||
|
const journals = [];
|
||||||
|
|
||||||
|
const makePage = (journal, data = {}) => {
|
||||||
|
const page = {
|
||||||
|
id: `page-${state.nextId++}`,
|
||||||
|
documentName: "JournalEntryPage",
|
||||||
|
name: data.name,
|
||||||
|
text: { content: data.text?.content ?? "" },
|
||||||
|
flags: data.flags ?? {},
|
||||||
|
writes: 0,
|
||||||
|
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||||
|
async update(update) {
|
||||||
|
page.writes += 1;
|
||||||
|
writeFoundryPaths(page, update);
|
||||||
|
return page;
|
||||||
|
},
|
||||||
|
async delete() {
|
||||||
|
const index = journal.pages.contents.indexOf(page);
|
||||||
|
if (index >= 0) journal.pages.contents.splice(index, 1);
|
||||||
|
},
|
||||||
|
};
|
||||||
|
return page;
|
||||||
|
};
|
||||||
|
|
||||||
|
const makeJournal = (data = {}) => {
|
||||||
|
const pages = [];
|
||||||
|
return {
|
||||||
|
id: `journal-${state.nextId++}`,
|
||||||
|
name: data.name,
|
||||||
|
documentName: "JournalEntry",
|
||||||
|
flags: data.flags ?? {},
|
||||||
|
getFlag(module, key) { return this.flags?.[module]?.[key]; },
|
||||||
|
pages: { contents: pages, get: (id) => pages.find((page) => page.id === id) },
|
||||||
|
async update(update) { return writeFoundryPaths(this, update); },
|
||||||
|
async createEmbeddedDocuments(documentName, docs) {
|
||||||
|
assert.equal(documentName, "JournalEntryPage", "the notes' pages are journal pages");
|
||||||
|
// Foundry's own page validation refuses a page without a name.
|
||||||
|
for (const doc of docs) assert.ok(doc.name, "a journal page needs a non-empty name");
|
||||||
|
// A world that does not keep the flags a create was handed: the page
|
||||||
|
// exists but carries no mark, which is what a lost pairing looks like.
|
||||||
|
const created = docs.map((doc) => makePage(this, keepCreateFlags ? doc : { ...doc, flags: {} }));
|
||||||
|
pages.push(...created);
|
||||||
|
return created;
|
||||||
|
},
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
const settingsStore = { autoSync: true, 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() {}, warn() {}, error() {} } },
|
||||||
|
Hooks: {
|
||||||
|
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||||
|
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
|
||||||
|
},
|
||||||
|
setTimeout: (fn, delay = 0) => {
|
||||||
|
const id = state.nextId++;
|
||||||
|
state.timers.set(id, { fn, delay });
|
||||||
|
return id;
|
||||||
|
},
|
||||||
|
clearTimeout: (id) => state.timers.delete(id),
|
||||||
|
setInterval: (fn, delay = 0) => {
|
||||||
|
// Recorded, never run by itself: tests ask for a periodic reconcile with
|
||||||
|
// `runIntervals`, so the ones watching single pushes stay on their own.
|
||||||
|
const id = state.nextId++;
|
||||||
|
state.intervals.set(id, { fn, delay });
|
||||||
|
return id;
|
||||||
|
},
|
||||||
|
clearInterval: (id) => state.intervals.delete(id),
|
||||||
|
fetch: async (url, options = {}) => {
|
||||||
|
const href = String(url);
|
||||||
|
const body = options.body ? JSON.parse(options.body) : null;
|
||||||
|
state.requests.push({ href, method: options.method, body });
|
||||||
|
if (href.includes("foundry/sync/map-note")) {
|
||||||
|
if (state.failMapNote) return { ok: false, status: 500, json: async () => ({ status: "error", msg: "errors.internal" }) };
|
||||||
|
const note = state.remoteNotes.find((entry) => String(entry._id) === String(body.noteId));
|
||||||
|
if (note) note.foundryPageId = body.foundryPageId;
|
||||||
|
return { ok: true, status: 200, json: async () => ({ status: "ok", note }) };
|
||||||
|
}
|
||||||
|
if (href.includes("foundry/sync/notes")) {
|
||||||
|
return { ok: true, status: 200, json: async () => ({ status: "ok", notes: state.remoteNotes }) };
|
||||||
|
}
|
||||||
|
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [] }) };
|
||||||
|
},
|
||||||
|
Actor: { async create() { return null; } },
|
||||||
|
Item: { async create() { return null; } },
|
||||||
|
JournalEntry: {
|
||||||
|
async create(data) {
|
||||||
|
const journal = makeJournal(data);
|
||||||
|
journals.push(journal);
|
||||||
|
return [journal];
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
if (markdown) sandbox.TextEditor = { _getMarkdown: (md) => `<marked>${md}</marked>` };
|
||||||
|
|
||||||
|
sandbox.game = {
|
||||||
|
user: { isGM: true },
|
||||||
|
world: { id: "world-1", title: "Test World" },
|
||||||
|
system: { id: "dnd5e" },
|
||||||
|
modules: { get: () => ({}) },
|
||||||
|
actors: { contents: [], get: () => null },
|
||||||
|
items: { contents: [], get: () => null },
|
||||||
|
folders: { contents: [], get: () => null },
|
||||||
|
journals: { contents: journals, get: (id) => journals.find((journal) => journal.id === id) },
|
||||||
|
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(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||||
|
|
||||||
|
state.game = sandbox.game;
|
||||||
|
state.journals = () => journals;
|
||||||
|
state.addJournal = (name, flags = {}) => {
|
||||||
|
const journal = makeJournal({ name, flags });
|
||||||
|
journals.push(journal);
|
||||||
|
return journal;
|
||||||
|
};
|
||||||
|
state.addPage = (journal, data) => {
|
||||||
|
const page = makePage(journal, data);
|
||||||
|
journal.pages.contents.push(page);
|
||||||
|
return page;
|
||||||
|
};
|
||||||
|
state.mapNoteRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync/map-note"));
|
||||||
|
state.notesReads = () => state.requests.filter((request) => request.href.includes("foundry/sync/notes"));
|
||||||
|
|
||||||
|
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||||
|
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();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
// The reconciles `setInterval` registered: what runs every few seconds on a
|
||||||
|
// linked world, and so what carries each note into its journal page.
|
||||||
|
state.runIntervals = async () => {
|
||||||
|
for (const interval of [...state.intervals.values()]) await interval.fn();
|
||||||
|
await drain();
|
||||||
|
};
|
||||||
|
state.linkedSetup = async () => {
|
||||||
|
await state.fire("init");
|
||||||
|
await state.fire("ready");
|
||||||
|
await state.runTimers();
|
||||||
|
state.requests.length = 0;
|
||||||
|
return state;
|
||||||
|
};
|
||||||
|
|
||||||
|
return state;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The fetch stub updates a note with the page it maps, like the real backend
|
||||||
|
// does, so every test works on notes of its own.
|
||||||
|
const sessionNote = (over = {}) => ({ _id: "note-1", title: "Session 1", content: "**The start**", ...over });
|
||||||
|
const tavernNote = (over = {}) => ({ _id: "note-2", title: "Tavern Brawl", content: "A rope, a chandelier.", ...over });
|
||||||
|
|
||||||
|
test("the campaign's notes become pages of one Dragonroll journal", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
world.remoteNotes = [sessionNote(), tavernNote()];
|
||||||
|
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.equal(world.journals().length, 1, "one journal carries the campaign's notes");
|
||||||
|
const journal = world.journals()[0];
|
||||||
|
assert.equal(journal.name, "Dragonroll");
|
||||||
|
assert.deepEqual(journal.pages.contents.map((page) => [page.name, page.text.content]), [
|
||||||
|
["Session 1", "<marked>**The start**</marked>"],
|
||||||
|
["Tavern Brawl", "<marked>A rope, a chandelier.</marked>"],
|
||||||
|
], "each note is a page, its markdown rendered by Foundry's own renderer");
|
||||||
|
assert.deepEqual(journal.pages.contents.map((page) => page.getFlag(MODULE_ID, "noteId")), ["note-1", "note-2"],
|
||||||
|
"each page keeps the note it stands for");
|
||||||
|
assert.deepEqual(world.mapNoteRequests().map((request) => [request.body.noteId, request.body.foundryPageId]), [
|
||||||
|
["note-1", journal.pages.contents[0].id],
|
||||||
|
["note-2", journal.pages.contents[1].id],
|
||||||
|
], "and the campaign remembers each note's page");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("reconciling again does not double the journal or its pages", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
world.remoteNotes = [sessionNote(), tavernNote()];
|
||||||
|
|
||||||
|
await world.runIntervals();
|
||||||
|
await world.runIntervals();
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.equal(world.journals().length, 1, "the journal is made once, not per reconcile");
|
||||||
|
assert.equal(world.journals()[0].pages.contents.length, 2, "and each note stands as the one page it was given");
|
||||||
|
assert.equal(world.mapNoteRequests().length, 2, "an already-mapped note is not mapped again");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an existing journal named Dragonroll is used, not doubled", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
const gmsOwn = world.addJournal("Dragonroll");
|
||||||
|
|
||||||
|
world.remoteNotes = [sessionNote()];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.equal(world.journals().length, 1, "the journal the world already had is the notes' one");
|
||||||
|
assert.deepEqual(gmsOwn.pages.contents.map((page) => page.name), ["Session 1"]);
|
||||||
|
assert.equal(gmsOwn.getFlag(MODULE_ID, "notesJournal"), true, "and it is marked, so renaming it keeps the notes' home findable");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a note edited in Dragonroll rewrites its page", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
world.remoteNotes = [sessionNote()];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
const first = world.remoteNotes[0];
|
||||||
|
world.remoteNotes = [{ ...first, title: "Session 1 — revisited", content: "**A different start**" }];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
const journal = world.journals()[0];
|
||||||
|
assert.equal(journal.pages.contents.length, 1, "the note still stands as the same single page");
|
||||||
|
assert.deepEqual(journal.pages.contents[0].name, "Session 1 — revisited");
|
||||||
|
assert.equal(journal.pages.contents[0].text.content, "<marked>**A different start**</marked>");
|
||||||
|
assert.equal(world.mapNoteRequests().length, 1, "the pairing the world reads back needs no remapping");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a note deleted in Dragonroll takes its page with it", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
world.remoteNotes = [sessionNote(), tavernNote()];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
const journal = world.journals()[0];
|
||||||
|
const gmsPage = world.addPage(journal, { name: "My own notes", text: { content: "not from Dragonroll" } });
|
||||||
|
world.remoteNotes = world.remoteNotes.filter((note) => note._id !== "note-2");
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.deepEqual(journal.pages.contents.map((page) => page.name), ["Session 1", "My own notes"],
|
||||||
|
"the deleted note's page goes; the GM's own page stays");
|
||||||
|
assert.ok(journal.pages.contents.includes(gmsPage));
|
||||||
|
});
|
||||||
|
|
||||||
|
test("pages already in step with the campaign are not rewritten", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
world.remoteNotes = [sessionNote()];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
const [page] = world.journals()[0].pages.contents;
|
||||||
|
assert.equal(page.writes, 0, "the page was created whole, not patched");
|
||||||
|
await world.runIntervals();
|
||||||
|
assert.equal(page.writes, 0, "a reconcile that changes nothing leaves the page alone");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the campaign's page mapping claims a page whose flag was lost", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
const journal = world.addJournal("Dragonroll");
|
||||||
|
const orphan = world.addPage(journal, { name: "Old name", text: { content: "old" } });
|
||||||
|
|
||||||
|
world.remoteNotes = [{ _id: "note-1", title: "Session 1", content: "**The start**", foundryPageId: orphan.id }];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.equal(journal.pages.contents.length, 1, "no second page under the same title");
|
||||||
|
assert.equal(orphan.name, "Session 1");
|
||||||
|
assert.equal(orphan.getFlag(MODULE_ID, "noteId"), "note-1", "and the page is marked again");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a page under the note's title with no mark is claimed, not doubled", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
const journal = world.addJournal("Dragonroll");
|
||||||
|
const existing = world.addPage(journal, { name: "Session 1", text: { content: "an older copy" } });
|
||||||
|
|
||||||
|
// The campaign has no page id for the note, and the page carries no flag: this
|
||||||
|
// is a page the module made before the pairing was kept, or one whose flag was
|
||||||
|
// lost. It is claimed instead of a second page being made under the same title.
|
||||||
|
world.remoteNotes = [sessionNote()];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.equal(journal.pages.contents.length, 1, "no second page under the note's title");
|
||||||
|
assert.equal(existing.text.content, "<marked>**The start**</marked>", "the note's text lands on the page the world already had");
|
||||||
|
assert.equal(existing.getFlag(MODULE_ID, "noteId"), "note-1", "and the page is marked as the note's");
|
||||||
|
assert.deepEqual(world.mapNoteRequests().map((request) => request.body.foundryPageId), [existing.id],
|
||||||
|
"the campaign is told which page the note now stands as");
|
||||||
|
|
||||||
|
await world.runIntervals();
|
||||||
|
assert.equal(journal.pages.contents.length, 1, "reconciling again does not add another");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("two notes of one title do not share a single page", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
const journal = world.addJournal("Dragonroll");
|
||||||
|
const existing = world.addPage(journal, { name: "Session 1", text: { content: "an older copy" } });
|
||||||
|
|
||||||
|
world.remoteNotes = [sessionNote(), { _id: "note-9", title: "Session 1", content: "second" }];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.equal(journal.pages.contents.length, 2, "the second note gets a page of its own");
|
||||||
|
assert.equal(existing.getFlag(MODULE_ID, "noteId"), "note-1", "the world's page is claimed by the first note");
|
||||||
|
assert.equal(journal.pages.contents[1].getFlag(MODULE_ID, "noteId"), "note-9");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a page whose mark and mapping were both lost is claimed again, not doubled", async () => {
|
||||||
|
// Both ways of recognising the pairing are gone: the create's flag did not stick,
|
||||||
|
// and the campaign never got to keep the page id. Without claiming the page it
|
||||||
|
// already made, every reconcile would write another one.
|
||||||
|
const world = await makeWorld({ keepCreateFlags: false, failMapNote: true }).linkedSetup();
|
||||||
|
world.remoteNotes = [sessionNote()];
|
||||||
|
|
||||||
|
await world.runIntervals();
|
||||||
|
await world.runIntervals();
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
const journal = world.journals()[0];
|
||||||
|
assert.equal(journal.pages.contents.length, 1, "one note stands as the one page it was given");
|
||||||
|
assert.equal(journal.pages.contents[0].getFlag(MODULE_ID, "noteId"), "note-1",
|
||||||
|
"and the page keeps the note it stands for even though the create did not mark it");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("without Foundry's markdown renderer the fallback keeps the text legible", async () => {
|
||||||
|
const world = await makeWorld({ markdown: false }).linkedSetup();
|
||||||
|
world.remoteNotes = [{ _id: "note-1", title: "Session 1", content: "a & b < c\nline two\n\nsecond para" }];
|
||||||
|
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.equal(
|
||||||
|
world.journals()[0].pages.contents[0].text.content,
|
||||||
|
"<p>a & b < c<br />line two</p>\n<p>second para</p>",
|
||||||
|
"escaped paragraphs instead of nothing, until this Foundry offers a renderer",
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("autosync off: the campaign's notes are not written into the world", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
await world.game.settings.set(MODULE_ID, "autoSync", false);
|
||||||
|
|
||||||
|
world.remoteNotes = [sessionNote()];
|
||||||
|
await world.runIntervals();
|
||||||
|
|
||||||
|
assert.deepEqual(world.journals(), [], "no journal is made");
|
||||||
|
assert.deepEqual(world.notesReads(), [], "and the campaign is not even asked");
|
||||||
|
});
|
||||||
@@ -207,6 +207,7 @@ test("autosync on: Foundry CRUD events keep syncing with Dragonroll", async () =
|
|||||||
const pushes = world.syncRequests();
|
const pushes = world.syncRequests();
|
||||||
assert.equal(pushes.length, 1);
|
assert.equal(pushes.length, 1);
|
||||||
assert.equal(pushes[0].body.actors[0]._id, "actor-1");
|
assert.equal(pushes[0].body.actors[0]._id, "actor-1");
|
||||||
|
assert.equal(pushes[0].body.replace, false, "a live actor change never asks Dragonroll to replace the campaign's edits");
|
||||||
});
|
});
|
||||||
|
|
||||||
test("autosync off: CRUD requests stop syncing", async () => {
|
test("autosync off: CRUD requests stop syncing", async () => {
|
||||||
@@ -260,6 +261,7 @@ test("force sync sends selected actors to Dragonroll even with autosync off", as
|
|||||||
const pushes = world.syncRequests();
|
const pushes = world.syncRequests();
|
||||||
assert.equal(pushes.length, 1);
|
assert.equal(pushes.length, 1);
|
||||||
assert.equal(pushes[0].body.fullSync, false, "a forced actor never prunes the campaign");
|
assert.equal(pushes[0].body.fullSync, false, "a forced actor never prunes the campaign");
|
||||||
|
assert.equal(pushes[0].body.replace, true, "a forced sync replaces everything the campaign holds for those actors");
|
||||||
assert.deepEqual(pushes[0].body.actors.map((actor) => actor._id), ["actor-2"]);
|
assert.deepEqual(pushes[0].body.actors.map((actor) => actor._id), ["actor-2"]);
|
||||||
assert.deepEqual(world.notifications.filter(([kind]) => kind !== "info"), []);
|
assert.deepEqual(world.notifications.filter(([kind]) => kind !== "info"), []);
|
||||||
});
|
});
|
||||||
|
|||||||
@@ -57,7 +57,7 @@ function matches(document, filter = {}) {
|
|||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
function fakeModel(table, seed = []) {
|
function fakeModel(table, seed = [], campaignId) {
|
||||||
const rows = [];
|
const rows = [];
|
||||||
let counter = 0;
|
let counter = 0;
|
||||||
|
|
||||||
@@ -76,7 +76,9 @@ function fakeModel(table, seed = []) {
|
|||||||
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||||
|
|
||||||
for (const data of seed) {
|
for (const data of seed) {
|
||||||
const row = new Document({ [table === "folder" ? "target" : "name"]: undefined, ...data });
|
// A seeded row belongs to the campaign the requests are made against unless the
|
||||||
|
// seed says otherwise: the routes scope every lookup by campaign.
|
||||||
|
const row = new Document({ campaign: campaignId, [table === "folder" ? "target" : "name"]: undefined, ...data });
|
||||||
row.isNew = false;
|
row.isNew = false;
|
||||||
rows.push(row);
|
rows.push(row);
|
||||||
}
|
}
|
||||||
@@ -130,6 +132,8 @@ function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
|||||||
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||||
"../models/Item": fakeModel("item", seeded(seed.items)),
|
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||||
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||||
|
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||||
|
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||||
};
|
};
|
||||||
|
|
||||||
const requireStub = (id) => {
|
const requireStub = (id) => {
|
||||||
@@ -139,6 +143,8 @@ function loadSyncRoute({ seed = {}, worldId = "world-1" } = {}) {
|
|||||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||||
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||||
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
if (id === "../services/item-foundry") return repoRequire(path.join("backend", "src", "services", "item-foundry.js"));
|
||||||
|
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||||
|
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||||
if (models[id]) return models[id];
|
if (models[id]) return models[id];
|
||||||
throw new Error(`require("${id}") is not stubbed`);
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
};
|
};
|
||||||
@@ -297,6 +303,76 @@ test("an item the world moved out of a folder follows it to the root", async ()
|
|||||||
assert.equal(sync.models["../models/Item"].rows[0].folder, null);
|
assert.equal(sync.models["../models/Item"].rows[0].folder, null);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// --- Only the world's item directory is listed (Syndria98/dragonroll#67) --------------
|
||||||
|
// The campaign's item list equals the world's items tab: gear that only an actor
|
||||||
|
// carries is its inventory (kept on the actor document), not a Dragonroll item.
|
||||||
|
|
||||||
|
test("an actor's gear is kept off the campaign's item list", async () => {
|
||||||
|
const sync = loadSyncRoute();
|
||||||
|
|
||||||
|
await sync.call("POST /sync/snapshot", {
|
||||||
|
worldId: "world-1",
|
||||||
|
items: [worldItem()],
|
||||||
|
// Thalia carries a potion the world's item directory does not hold.
|
||||||
|
actors: [{
|
||||||
|
_id: "actor-1",
|
||||||
|
name: "Thalia",
|
||||||
|
items: [{ _id: "potion-1", name: "Potion of Healing", type: "consumable", system: { quantity: 2 } }],
|
||||||
|
}],
|
||||||
|
});
|
||||||
|
|
||||||
|
const names = sync.models["../models/Item"].rows.map((row) => row.name);
|
||||||
|
assert.deepEqual(names, ["Longsword"], "only the world's item reaches the list, not the actor's potion");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the campaign's item list is the world's whole item directory", async () => {
|
||||||
|
const sync = loadSyncRoute();
|
||||||
|
|
||||||
|
await sync.call("POST /sync/snapshot", {
|
||||||
|
worldId: "world-1",
|
||||||
|
items: [worldItem(), worldItem({ _id: "item-2", name: "Torch", type: "loot", system: { quantity: 1 } })],
|
||||||
|
actors: [],
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(
|
||||||
|
sync.models["../models/Item"].rows.map((row) => row.name).sort(),
|
||||||
|
["Longsword", "Torch"],
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an item carried by a character is listed once, as its world entry", async () => {
|
||||||
|
const sync = loadSyncRoute();
|
||||||
|
|
||||||
|
await sync.call("POST /sync/snapshot", {
|
||||||
|
worldId: "world-1",
|
||||||
|
items: [worldItem()],
|
||||||
|
// The same sword, a second copy embedded in an actor under another id.
|
||||||
|
actors: [{ _id: "actor-1", name: "Thalia", items: [worldItem({ _id: "sword-copy" })] }],
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(sync.models["../models/Item"].rows.map((row) => row.name), ["Longsword"]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a full snapshot prunes gear that only an actor carried", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: { items: [{ _id: "potion-1", name: "Potion of Healing", foundryItemId: "embedded-1" }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
// The world's item directory is now empty: nothing but a character holds the potion.
|
||||||
|
await sync.call("POST /sync/snapshot", {
|
||||||
|
worldId: "world-1",
|
||||||
|
items: [],
|
||||||
|
actors: [{
|
||||||
|
_id: "actor-1",
|
||||||
|
name: "Thalia",
|
||||||
|
items: [{ _id: "embedded-1", name: "Potion of Healing", type: "consumable", system: { quantity: 2 } }],
|
||||||
|
}],
|
||||||
|
fullSync: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(sync.models["../models/Item"].rows, [], "the actor's own gear no longer stands in the item list");
|
||||||
|
});
|
||||||
|
|
||||||
test("a folder coloured in the world is coloured in the campaign", async () => {
|
test("a folder coloured in the world is coloured in the campaign", async () => {
|
||||||
const sync = loadSyncRoute();
|
const sync = loadSyncRoute();
|
||||||
|
|
||||||
@@ -373,9 +449,12 @@ test("every folder listing says which campaign list it belongs to", () => {
|
|||||||
// field existed carry none at all. tests/entry-folders.test.js runs these routes.
|
// field existed carry none at all. tests/entry-folders.test.js runs these routes.
|
||||||
for (const route of ["note.js", "folder.js"]) {
|
for (const route of ["note.js", "folder.js"]) {
|
||||||
const source = read("backend", "src", "routes", route);
|
const source = read("backend", "src", "routes", route);
|
||||||
const listings = source.match(/Folder\.find\(/g) ?? [];
|
// The listings that gather a campaign's folders are the ones shown as a section's
|
||||||
|
// tree. A walk of one folder's own children (`parentFolder`) is inside a single
|
||||||
|
// list already: folders are only ever nested within their own section.
|
||||||
|
const listings = source.match(/Folder\.find\(\{\s*campaign/g) ?? [];
|
||||||
assert.ok(listings.length, `${route} lists folders`);
|
assert.ok(listings.length, `${route} lists folders`);
|
||||||
const filtered = source.match(/Folder\.find\(\{[^{]*Folder\.filterForTarget\((?:'note'|target)\)/g) ?? [];
|
const filtered = source.match(/Folder\.find\(\{\s*campaign[^{]*Folder\.filterForTarget\((?:'note'|target)\)/g) ?? [];
|
||||||
assert.equal(filtered.length, listings.length, `${route} has a folder listing that names no campaign list`);
|
assert.equal(filtered.length, listings.length, `${route} has a folder listing that names no campaign list`);
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -725,13 +804,15 @@ test("items are grouped under the folder they stand in, nested", () => {
|
|||||||
row.kind, row.kind === "folder" ? row.folder.name : row.item.name, row.depth,
|
row.kind, row.kind === "folder" ? row.folder.name : row.item.name, row.depth,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
// Every folder is followed by what stands in it, one step deeper, and the items that
|
||||||
|
// stand at the root come last (see BuildItemRows).
|
||||||
assert.deepEqual(shape, [
|
assert.deepEqual(shape, [
|
||||||
["folder", "Melee Weapons", 0],
|
["folder", "Melee Weapons", 0],
|
||||||
|
["item", "Longsword", 1],
|
||||||
["folder", "Ranged Weapons", 0],
|
["folder", "Ranged Weapons", 0],
|
||||||
["folder", "Powder Weapons", 1],
|
["folder", "Powder Weapons", 1],
|
||||||
["item", "Pistol", 1],
|
["item", "Pistol", 2],
|
||||||
["item", "Torch", 0],
|
["item", "Torch", 0],
|
||||||
["item", "Longsword", 1],
|
|
||||||
]);
|
]);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -758,9 +839,9 @@ test("an item whose folder is gone, or a folder nested in itself, reads as a roo
|
|||||||
);
|
);
|
||||||
|
|
||||||
const shape = rows.map((row) => [row.kind, row.kind === "folder" ? row.folder.name : row.item.name]);
|
const shape = rows.map((row) => [row.kind, row.kind === "folder" ? row.folder.name : row.item.name]);
|
||||||
assert.ok(shape.includes(["item", "Torch"]), "the item is not lost with the folder that was removed");
|
assert.ok(shape.some(([kind, name]) => kind === "item" && name === "Torch"), "the item is not lost with the folder that was removed");
|
||||||
assert.deepEqual(new Set(shape.filter(([kind]) => kind === "folder").map(([, name]) => name)), new Set(["A", "B"]));
|
assert.deepEqual(new Set(shape.filter(([kind]) => kind === "folder").map(([, name]) => name)), new Set(["A", "B"]));
|
||||||
assert.equal(rows.filter(([kind]) => kind === "folder").length, 2, "a broken tree is walked once, not forever");
|
assert.equal(shape.filter(([kind]) => kind === "folder").length, 2, "a broken tree is walked once, not forever");
|
||||||
});
|
});
|
||||||
|
|
||||||
test("every locale labels the folder row", () => {
|
test("every locale labels the folder row", () => {
|
||||||
|
|||||||
89
tests/item-rarity-entry.test.js
Normal file
89
tests/item-rarity-entry.test.js
Normal file
@@ -0,0 +1,89 @@
|
|||||||
|
// Tests for Syndria98/dragonroll#63: the item rows in the campaign sidebar dropped the text
|
||||||
|
// listing category, rarity and quantity — the rarity colours the text of the entry instead
|
||||||
|
// (common white, uncommon green, rare blue, very rare purple, legendary orange) — and the
|
||||||
|
// quantity left the item surfaces altogether, since it only belongs to an actor's inventory.
|
||||||
|
//
|
||||||
|
// The repository root installs no dependencies, so these read the sources the way
|
||||||
|
// tests/item-entry-display.test.js does — the checks are about the markup and style.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
|
||||||
|
const sidebarSource = read("frontend", "app", "components", "partials", "ContentSidebar.vue");
|
||||||
|
const itemWindowSource = read("frontend", "app", "components", "windows", "ItemSheetWindow.vue");
|
||||||
|
const entryFormSource = read("frontend", "app", "components", "windows", "CreateCampaignEntryWindow.vue");
|
||||||
|
const sheetSource = read("frontend", "app", "components", "windows", "CharacterSheetWindow.vue");
|
||||||
|
const colorsSource = read("frontend", "app", "assets", "css", "colors.scss");
|
||||||
|
|
||||||
|
// The block that renders the item rows, as in tests/item-entry-display.test.js.
|
||||||
|
const itemSection =
|
||||||
|
/<template v-else-if="activeSection === 'items'">([\s\S]*?)<\/template>\s*\n\s*<template v-else>/.exec(sidebarSource)?.[1] ?? "";
|
||||||
|
|
||||||
|
const rarities = ["common", "uncommon", "rare", "very-rare", "legendary"];
|
||||||
|
|
||||||
|
// `selector` is inserted verbatim, so escape the `.` of a class combination. Comments are dropped:
|
||||||
|
// they explain a rule, they are not part of it.
|
||||||
|
function ruleFor(selector) {
|
||||||
|
const rule = new RegExp(`\\.${selector}\\s*\\{([^}]*)\\}`).exec(sidebarSource)?.[0];
|
||||||
|
return rule?.replace(/\/\*[\s\S]*?\*\//g, "");
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the item entry no longer lists the category, rarity and quantity as text", () => {
|
||||||
|
assert.ok(itemSection, "expected to find the items section of the sidebar");
|
||||||
|
assert.doesNotMatch(itemSection, /entity-entry-meta/, "the item row must not render a meta line");
|
||||||
|
assert.doesNotMatch(itemSection, /campaigns\.item\.(categories|rarities|quantity)/, "the item row must not render item meta text");
|
||||||
|
assert.doesNotMatch(sidebarSource, /itemSummary/, "the removed summary helper must not be kept around");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the rarity of an item picks a class for the text of its entry", () => {
|
||||||
|
assert.match(
|
||||||
|
itemSection,
|
||||||
|
/<span class="entity-entry-name" :class="rarityClass\(row\.item\)"/,
|
||||||
|
"the item name must carry the class picked from its rarity"
|
||||||
|
);
|
||||||
|
const helper = /function rarityClass\(item\)\s*\{[\s\S]*?\n\}/.exec(sidebarSource)?.[0] ?? "";
|
||||||
|
assert.ok(helper, "expected a rarityClass helper");
|
||||||
|
for (const rarity of rarities) {
|
||||||
|
assert.ok(helper.includes(`'${rarity}'`), `rarityClass must know about '${rarity}'`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("each rarity colours the entry text with its own theme colour", () => {
|
||||||
|
for (const rarity of rarities) {
|
||||||
|
const rule = ruleFor(`entity-entry-name\\.rarity-${rarity}`);
|
||||||
|
assert.ok(rule, `expected a colour rule for .entity-entry-name.rarity-${rarity}`);
|
||||||
|
assert.match(rule, new RegExp(`color:\\s*var\\(--color-rarity-${rarity}\\)`));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("both theme maps carry the rarity colours", () => {
|
||||||
|
for (const rarity of rarities) {
|
||||||
|
const declarations = colorsSource.match(new RegExp(`rarity-${rarity}:\\s*#[0-9a-fA-F]{6}`, "g")) || [];
|
||||||
|
assert.equal(declarations.length, 2, `expected rarity-${rarity} in both the dark and the light map`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the quantity only shows in an actor's inventory", () => {
|
||||||
|
assert.doesNotMatch(itemWindowSource, /quantity/, "the item window must not list the quantity");
|
||||||
|
assert.doesNotMatch(entryFormSource, /quantity/, "the item create/edit form must not offer the quantity");
|
||||||
|
// the character sheet's inventory table keeps it.
|
||||||
|
assert.match(sheetSource, /campaigns\.character-sheet\.quantity/);
|
||||||
|
assert.match(sheetSource, /\{\{ item\.quantity \}\}/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("no locale keeps the removed item quantity strings", () => {
|
||||||
|
for (const locale of ["en", "es", "ca"]) {
|
||||||
|
const campaigns = JSON.parse(read("frontend", "i18n", "locales", locale, "campaigns.json"));
|
||||||
|
assert.ok(campaigns.item, `${locale} is missing the campaigns.item block`);
|
||||||
|
assert.equal(campaigns.item.quantity, undefined, `${locale} still has campaigns.item.quantity`);
|
||||||
|
assert.equal(campaigns.item["quantity-short"], undefined, `${locale} still has campaigns.item.quantity-short`);
|
||||||
|
// the character sheet's inventory keeps its own quantity column label
|
||||||
|
assert.ok(campaigns["character-sheet"]?.quantity, `${locale} is missing campaigns.character-sheet.quantity`);
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -66,19 +66,22 @@ test("the item routes accept the icon and upload one", () => {
|
|||||||
test("the item info window is registered and opens on a sidebar click", () => {
|
test("the item info window is registered and opens on a sidebar click", () => {
|
||||||
assert.match(windowDefsSource, /item_sheet:\s*{\s*title:[^}]*ItemSheetWindow\.vue/s);
|
assert.match(windowDefsSource, /item_sheet:\s*{\s*title:[^}]*ItemSheetWindow\.vue/s);
|
||||||
// clicking (or Enter/Space on) an item row opens the window instead of expanding inline.
|
// clicking (or Enter/Space on) an item row opens the window instead of expanding inline.
|
||||||
// Since #44 the rows come from the folder tree the world synced, so the row holds the item.
|
// The rows come from the item list's folder tree, so the row holds the item.
|
||||||
assert.match(sidebarSource, /v-for="row in itemRows"[\s\S]*?@click="openItemSheet\(row\.item\)"/);
|
assert.match(sidebarSource, /v-for="row in entryRows\.item\.value"[\s\S]*?@click="openItemSheet\(row\.item\)"/);
|
||||||
assert.match(sidebarSource, /CreateWindow\(['"]item_sheet['"],\s*\{ item \}\)/);
|
assert.match(sidebarSource, /CreateWindow\(['"]item_sheet['"],\s*\{ item \}\)/);
|
||||||
assert.doesNotMatch(sidebarSource, /toggleEntryDetails/);
|
assert.doesNotMatch(sidebarSource, /toggleEntryDetails/);
|
||||||
});
|
});
|
||||||
|
|
||||||
test("the item window shows the info and offers both icon sources", () => {
|
test("the item window shows the info and offers both icon sources", () => {
|
||||||
// info: name, category, rarity, quantity, weight, properties, description
|
// info: name, category, rarity, weight, properties, description — quantity is gone
|
||||||
for (const key of ["form.name", "form.category", "form.rarity", "form.quantity", "form.weight", "form.properties", "form.description"]) {
|
// (#63 keeps it for the actors' inventories).
|
||||||
|
for (const key of ["form.name", "form.category", "form.rarity", "form.weight", "form.properties", "form.description"]) {
|
||||||
assert.ok(itemWindowSource.includes(key), `expected the window to render ${key}`);
|
assert.ok(itemWindowSource.includes(key), `expected the window to render ${key}`);
|
||||||
}
|
}
|
||||||
// own icon: upload through the item route like the character sheet does its photo
|
// own icon: #65 moved picking one into a window of its own, which uploads through
|
||||||
assert.match(itemWindowSource, /\/item\/upload-image\?item=/);
|
// the item route (see tests/foundry-icon-picker.test.js); the sheet opens it and
|
||||||
|
// follows whatever the choice leaves behind.
|
||||||
|
assert.match(itemWindowSource, /CreateChildWindow\(id, ['"]item_icon_source['"]/);
|
||||||
// Foundry icon: switch the item image back to the one the world sent
|
// Foundry icon: switch the item image back to the one the world sent
|
||||||
assert.match(itemWindowSource, /form\.value\.foundryImage/);
|
assert.match(itemWindowSource, /form\.value\.foundryImage/);
|
||||||
assert.match(itemWindowSource, /updateItem\(\{ image: form\.value\.foundryImage \}\)/);
|
assert.match(itemWindowSource, /updateItem\(\{ image: form\.value\.foundryImage \}\)/);
|
||||||
|
|||||||
599
tests/map-foundry-sync.test.js
Normal file
599
tests/map-foundry-sync.test.js
Normal file
@@ -0,0 +1,599 @@
|
|||||||
|
// Tests for the world's scenes arriving as the campaign's maps (Syndria98/dragonroll#99).
|
||||||
|
// Only a scene's background picture and the grid laid over it travel: the campaign keeps its
|
||||||
|
// own scale, its folders, its pinned notes and the tokens standing on the map, and none of it
|
||||||
|
// goes back to the world.
|
||||||
|
//
|
||||||
|
// Same set-up as tests/item-folder-sync.test.js, which the repository root runs without
|
||||||
|
// installing anything: the sync route is loaded into `node:vm` with express, mongoose and its
|
||||||
|
// models stubbed (plain rows and a small filter matcher), so creating, adopting and pruning
|
||||||
|
// maps is observable without a database. The Foundry module is loaded into a `node:vm` context
|
||||||
|
// holding stubbed Foundry globals (`game.scenes` included) with fake timers, like
|
||||||
|
// tests/foundry-sync-toggle.test.js.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
const repoRequire = (relative) => require(path.join(__dirname, "..", relative));
|
||||||
|
|
||||||
|
// --- The sync route against stubbed models -------------------------------------
|
||||||
|
|
||||||
|
// A mongoose query answers whatever `await query` and `query.lean()` answer with, and
|
||||||
|
// lets `select()`, `sort()` and `limit()` sit in between.
|
||||||
|
function mongooseQuery(value) {
|
||||||
|
const result = {
|
||||||
|
select: () => result,
|
||||||
|
sort: () => result,
|
||||||
|
limit: (count) => mongooseQuery(value.slice(0, count)),
|
||||||
|
lean: () => Promise.resolve(value),
|
||||||
|
then: (onFulfilled, onRejected) => Promise.resolve(value).then(onFulfilled, onRejected),
|
||||||
|
};
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Enough of the query language the scene sync uses: equality, $in, $nin, $exists.
|
||||||
|
// Anything else is a filter this test did not expect and says so.
|
||||||
|
function matches(document, filter = {}) {
|
||||||
|
return Object.entries(filter).every(([key, expected]) => {
|
||||||
|
const value = document?.[key];
|
||||||
|
if (expected && typeof expected === "object" && !Array.isArray(expected)) {
|
||||||
|
return Object.entries(expected).every(([operator, wanted]) => {
|
||||||
|
if (operator === "$exists") return (value !== undefined && value !== null) === wanted;
|
||||||
|
if (operator === "$in") return wanted.some((entry) => String(value) === String(entry));
|
||||||
|
if (operator === "$nin") return !wanted.some((entry) => String(value) === String(entry));
|
||||||
|
throw new Error(`filter operator "${key}.${operator}" is not stubbed`);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
return String(value ?? "") === String(expected ?? "");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function fakeModel(table, seed = [], campaignId) {
|
||||||
|
const rows = [];
|
||||||
|
let counter = 0;
|
||||||
|
|
||||||
|
function Document(data = {}) {
|
||||||
|
counter += 1;
|
||||||
|
this._id = `${table}-${counter}`;
|
||||||
|
this.isNew = true;
|
||||||
|
Object.assign(this, data);
|
||||||
|
}
|
||||||
|
Document.prototype.save = async function save() {
|
||||||
|
if (this.isNew) rows.push(this);
|
||||||
|
this.isNew = false;
|
||||||
|
return this;
|
||||||
|
};
|
||||||
|
Object.defineProperty(Document.prototype, "id", { get() { return this._id; } });
|
||||||
|
|
||||||
|
for (const data of seed) {
|
||||||
|
// A seeded row belongs to the campaign the requests are made against unless the seed
|
||||||
|
// says otherwise: the sync scopes every lookup by campaign.
|
||||||
|
const row = new Document({ campaign: campaignId, name: undefined, ...data });
|
||||||
|
row.isNew = false;
|
||||||
|
rows.push(row);
|
||||||
|
}
|
||||||
|
|
||||||
|
const model = function Model(data) { return new Document(data); };
|
||||||
|
model.rows = rows;
|
||||||
|
model.findOne = async (filter) => rows.find((row) => matches(row, filter)) ?? null;
|
||||||
|
model.find = (filter) => mongooseQuery(rows.filter((row) => matches(row, filter)));
|
||||||
|
model.deleteOne = async (filter) => {
|
||||||
|
const hit = rows.filter((row) => matches(row, filter));
|
||||||
|
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||||
|
return { deletedCount: hit.length };
|
||||||
|
};
|
||||||
|
model.deleteMany = async (filter) => {
|
||||||
|
const hit = rows.filter((row) => matches(row, filter));
|
||||||
|
for (const row of hit) rows.splice(rows.indexOf(row), 1);
|
||||||
|
return { deletedCount: hit.length };
|
||||||
|
};
|
||||||
|
return model;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The Foundry sync route with every model it requires stubbed. `seed` pre-fills the tables
|
||||||
|
// with documents the campaign already holds.
|
||||||
|
function loadSyncRoute({ seed = {}, worldId = "world-1", settings } = {}) {
|
||||||
|
const routes = new Map();
|
||||||
|
const router = {
|
||||||
|
get: (route, ...handlers) => routes.set(`GET ${route}`, handlers),
|
||||||
|
post: (route, ...handlers) => routes.set(`POST ${route}`, handlers),
|
||||||
|
};
|
||||||
|
const campaign = {
|
||||||
|
_id: "campaign-1", id: "campaign-1", name: "Test Campaign", foundryWorldId: worldId,
|
||||||
|
...(settings ? { settings } : {}),
|
||||||
|
};
|
||||||
|
const seeded = (rows = []) => rows.map((row) => ({ campaign: campaign._id, ...row }));
|
||||||
|
const models = {
|
||||||
|
"../models/Actor": fakeModel("actor", seeded(seed.actors)),
|
||||||
|
"../models/Item": fakeModel("item", seeded(seed.items)),
|
||||||
|
"../models/Folder": fakeModel("folder", seeded(seed.folders)),
|
||||||
|
"../models/Note": fakeModel("note", seeded(seed.notes)),
|
||||||
|
"../models/Map": fakeModel("map", seeded(seed.maps)),
|
||||||
|
};
|
||||||
|
|
||||||
|
const requireStub = (id) => {
|
||||||
|
if (id === "express") return { Router: () => router };
|
||||||
|
if (id.startsWith("node:")) return require(id); // crypto: the sync token is hashed, not stubbed
|
||||||
|
if (id === "mongoose") return { isValidObjectId: (value) => typeof value === "string" && value.length > 20 };
|
||||||
|
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
||||||
|
if (id === "../services/actor-foundry") return { foundryActorToCharacter: (actor) => ({ name: actor?.name ?? "" }) };
|
||||||
|
if (id === "../services/item-foundry") return { foundryItemToItemData: () => null };
|
||||||
|
if (id === "../services/foundry-icons") return repoRequire(path.join("backend", "src", "services", "foundry-icons.js"));
|
||||||
|
if (id === "../services/map-foundry") return repoRequire(path.join("backend", "src", "services", "map-foundry.js"));
|
||||||
|
if (models[id]) return models[id];
|
||||||
|
throw new Error(`require("${id}") is not stubbed`);
|
||||||
|
};
|
||||||
|
|
||||||
|
const moduleStub = { exports: {} };
|
||||||
|
vm.compileFunction(read("backend", "src", "routes", "foundry-link.js"), ["require", "module", "exports"])(
|
||||||
|
requireStub, moduleStub, moduleStub.exports
|
||||||
|
);
|
||||||
|
|
||||||
|
async function call(route, body = {}) {
|
||||||
|
const handlers = routes.get(route);
|
||||||
|
assert.ok(handlers, `${route} is not mounted`);
|
||||||
|
const res = { payload: null, json(payload) { this.payload = payload; }, set: () => {} };
|
||||||
|
const req = { body, get: (name) => (String(name).toLowerCase() === "authorization" ? "Bearer sync-token" : "") };
|
||||||
|
await handlers[handlers.length - 1](req, res);
|
||||||
|
return res.payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { call, models, campaign };
|
||||||
|
}
|
||||||
|
|
||||||
|
// A scene of the world, as the module sends it: plain document data with its picture read
|
||||||
|
// from the world. This one is 70 px cells and the picture of the ruined keep.
|
||||||
|
function worldScene(over = {}) {
|
||||||
|
return {
|
||||||
|
_id: "scene-1",
|
||||||
|
name: "The Ruined Keep",
|
||||||
|
img: "http://vtt.test/images/keep.webp",
|
||||||
|
grid: 70,
|
||||||
|
flags: {},
|
||||||
|
...over,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const maps = (sync) => sync.models["../models/Map"].rows;
|
||||||
|
|
||||||
|
// --- A scene arrives as a map -------------------------------------------------------
|
||||||
|
|
||||||
|
test("a world scene arrives as a map of the campaign", async () => {
|
||||||
|
const sync = loadSyncRoute();
|
||||||
|
|
||||||
|
const response = await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
const [map] = maps(sync);
|
||||||
|
assert.equal(map.name, "The Ruined Keep");
|
||||||
|
assert.equal(map.image, "http://vtt.test/images/keep.webp", "the scene's background picture is the map's");
|
||||||
|
assert.equal(map.gridSize, 70, "the scene's own cell size is the grid the campaign draws");
|
||||||
|
assert.equal(map.offsetX, 0);
|
||||||
|
assert.equal(map.offsetY, 0, "a scene that shifts nothing has its grid at the corner of the picture");
|
||||||
|
assert.equal(map.foundrySceneId, "scene-1");
|
||||||
|
assert.equal(map.campaign, sync.campaign._id, "the map belongs to the campaign the world is linked to");
|
||||||
|
assert.deepEqual(response.maps, [{ foundrySceneId: "scene-1", mapId: map._id, created: true }]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene keeps the grid its world shifted onto the picture", async () => {
|
||||||
|
const sync = loadSyncRoute();
|
||||||
|
|
||||||
|
await sync.call("POST /sync/scenes", {
|
||||||
|
worldId: "world-1",
|
||||||
|
scenes: [worldScene({ grid: 64, flags: { core: { shiftX: 12, shiftY: -8 } } })],
|
||||||
|
});
|
||||||
|
|
||||||
|
const [map] = maps(sync);
|
||||||
|
assert.equal(map.gridSize, 64);
|
||||||
|
assert.equal(map.offsetX, 12);
|
||||||
|
assert.equal(map.offsetY, -8, "a grid that starts off the corner of the picture arrives where the world puts it");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene of a newer Foundry still arrives", async () => {
|
||||||
|
const sync = loadSyncRoute();
|
||||||
|
|
||||||
|
// Since Foundry V13 the picture sits under `background.src` and the cell size under
|
||||||
|
// `grid.size`.
|
||||||
|
await sync.call("POST /sync/scenes", {
|
||||||
|
worldId: "world-1",
|
||||||
|
scenes: [worldScene({ img: undefined, background: { src: "http://vtt.test/images/keep.webp" }, grid: { size: 128 } })],
|
||||||
|
});
|
||||||
|
|
||||||
|
const [map] = maps(sync);
|
||||||
|
assert.equal(map.image, "http://vtt.test/images/keep.webp");
|
||||||
|
assert.equal(map.gridSize, 128);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene's picture is read against the world the campaign knows", async () => {
|
||||||
|
// An older module sends Foundry's own relative path; it is read against the world's
|
||||||
|
// address, the way an actor's portrait is (Syndria98/dragonroll#89).
|
||||||
|
const sync = loadSyncRoute({ settings: { integrations: { foundryUrl: "http://vtt.test:30000" } } });
|
||||||
|
|
||||||
|
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene({ img: "images/keep.webp" })] });
|
||||||
|
|
||||||
|
assert.equal(maps(sync)[0].image, "http://vtt.test:30000/images/keep.webp");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene with no picture is not a map", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: { maps: [{ _id: "map-1", name: "The Ruined Keep", foundrySceneId: "scene-1", image: "http://vtt.test/images/keep.webp" }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
// The GM took the picture off the scene: its id still travels with the snapshot, so its
|
||||||
|
// map is neither made blank nor dropped, and no new row is made for it either.
|
||||||
|
const response = await sync.call("POST /sync/scenes", {
|
||||||
|
worldId: "world-1",
|
||||||
|
scenes: [worldScene({ img: "" })],
|
||||||
|
fullSync: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(response.maps, []);
|
||||||
|
assert.equal(maps(sync).length, 1);
|
||||||
|
assert.equal(maps(sync)[0].image, "http://vtt.test/images/keep.webp");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("what one of the map's cells stands for stays the campaign's", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: { maps: [{ _id: "map-1", name: "The Ruined Keep", foundrySceneId: "scene-1", gridSize: 50, scale: 1.5 }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene({ gridDistance: 1500, gridUnits: "m" })] });
|
||||||
|
|
||||||
|
assert.equal(maps(sync)[0].gridSize, 70, "the world's cell size arrives");
|
||||||
|
assert.equal(maps(sync)[0].scale, 1.5, "and the distance the campaign says a cell covers is left alone");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- One map per scene ---------------------------------------------------------------
|
||||||
|
|
||||||
|
test("the same scene is never made into two maps", async () => {
|
||||||
|
const sync = loadSyncRoute();
|
||||||
|
|
||||||
|
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||||
|
const response = await sync.call("POST /sync/scenes", {
|
||||||
|
worldId: "world-1",
|
||||||
|
scenes: [worldScene({ name: "The Ruined Keep, II", grid: 80 })],
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(maps(sync).length, 1, "the scene was written over, not doubled");
|
||||||
|
assert.equal(maps(sync)[0].name, "The Ruined Keep, II");
|
||||||
|
assert.equal(maps(sync)[0].gridSize, 80);
|
||||||
|
assert.equal(response.maps[0].created, false, "the push says it wrote a map it already had");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a live scene edit lands on the map, however the campaign had it", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: { maps: [{ _id: "map-1", name: "Old name", foundrySceneId: "scene-1", image: "old.png", gridSize: 40 }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||||
|
|
||||||
|
const [map] = maps(sync);
|
||||||
|
assert.equal(map.image, "http://vtt.test/images/keep.webp");
|
||||||
|
assert.equal(map.gridSize, 70);
|
||||||
|
assert.equal(map.name, "The Ruined Keep");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a full snapshot leaves the picture and grid the campaign lined up alone", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: { maps: [{ _id: "map-1", name: "My keep", foundrySceneId: "scene-1", image: "my-keep.png", gridSize: 40 }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()], fullSync: true });
|
||||||
|
|
||||||
|
const [map] = maps(sync);
|
||||||
|
assert.equal(map.image, "my-keep.png", "a GM reconnecting does not write over a map the campaign already had");
|
||||||
|
assert.equal(map.gridSize, 40);
|
||||||
|
assert.equal(map.name, "My keep");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene takes over the map the campaign drew by hand", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: { maps: [{ _id: "map-1", name: "The Ruined Keep", image: "hand-made.png", gridSize: 50 }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||||
|
|
||||||
|
assert.equal(maps(sync).length, 1, "the room the campaign drew first is not doubled by its scene");
|
||||||
|
assert.equal(maps(sync)[0]._id, "map-1");
|
||||||
|
assert.equal(maps(sync)[0].foundrySceneId, "scene-1", "and it is the scene's map from then on");
|
||||||
|
assert.equal(response.maps[0].mapId, "map-1");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene carrying the campaign's map id adopts that row", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: { maps: [{ _id: "map-0123456789abcdef0123456789", name: "Keep under way", image: "hand-made.png" }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await sync.call("POST /sync/scenes", {
|
||||||
|
worldId: "world-1",
|
||||||
|
scenes: [worldScene({ name: "Somewhere else", flags: { "dragonroll-foundry": { mapId: "map-0123456789abcdef0123456789" } } })],
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(maps(sync).length, 1);
|
||||||
|
assert.equal(response.maps[0].mapId, "map-0123456789abcdef0123456789", "the flag says which map the scene is");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- Pruning --------------------------------------------------------------------------
|
||||||
|
|
||||||
|
test("a full snapshot prunes the maps whose scene this world let go of", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: {
|
||||||
|
maps: [
|
||||||
|
{ _id: "map-1", name: "Cellar", foundrySceneId: "scene-gone" },
|
||||||
|
{ _id: "map-2", name: "Homebrew ford" },
|
||||||
|
{ _id: "map-3", name: "The Ruined Keep", foundrySceneId: "scene-1" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()], fullSync: true });
|
||||||
|
|
||||||
|
assert.deepEqual(maps(sync).map((map) => map._id).sort(), ["map-2", "map-3"],
|
||||||
|
"the scene that is gone takes its map with it, and the campaign's own maps stay");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a live scene push never prunes", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: { maps: [{ _id: "map-1", name: "Cellar", foundrySceneId: "scene-gone" }] },
|
||||||
|
});
|
||||||
|
|
||||||
|
await sync.call("POST /sync/scenes", { worldId: "world-1", scenes: [worldScene()] });
|
||||||
|
|
||||||
|
assert.equal(maps(sync).length, 2, "a push of one scene says nothing about the world's other scenes");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene the world deleted takes its map with it", async () => {
|
||||||
|
const sync = loadSyncRoute({
|
||||||
|
seed: {
|
||||||
|
maps: [
|
||||||
|
{ _id: "map-1", name: "The Ruined Keep", foundrySceneId: "scene-1" },
|
||||||
|
{ _id: "map-2", name: "Homebrew ford" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const response = await sync.call("POST /sync/scene-delete", { worldId: "world-1", foundrySceneId: "scene-1" });
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.deepEqual(maps(sync).map((map) => map._id), ["map-2"], "only the map of that scene goes");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- What the route refuses -----------------------------------------------------------
|
||||||
|
|
||||||
|
test("a push that is not the campaign's world, or names no scenes, is refused", async () => {
|
||||||
|
const sync = loadSyncRoute();
|
||||||
|
|
||||||
|
assert.equal((await sync.call("POST /sync/scenes", { worldId: "another-world", scenes: [worldScene()] })).msg, "errors.missing-data");
|
||||||
|
assert.equal((await sync.call("POST /sync/scenes", { worldId: "world-1" })).msg, "errors.missing-data");
|
||||||
|
assert.deepEqual(maps(sync), [], "nothing was written");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a delete from another world, or naming no scene, is refused", async () => {
|
||||||
|
const sync = loadSyncRoute({ seed: { maps: [{ _id: "map-1", name: "Keep", foundrySceneId: "scene-1" }] } });
|
||||||
|
|
||||||
|
assert.equal((await sync.call("POST /sync/scene-delete", { worldId: "another-world", foundrySceneId: "scene-1" })).msg, "errors.missing-data");
|
||||||
|
assert.equal((await sync.call("POST /sync/scene-delete", { worldId: "world-1" })).msg, "errors.missing-data");
|
||||||
|
assert.equal(maps(sync).length, 1, "and the map is still there");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a map remembers which scene of the world it mirrors", () => {
|
||||||
|
const model = read("backend", "src", "models", "Map.js");
|
||||||
|
assert.match(model, /foundrySceneId:\s*{\s*type:\s*String\s*}/, "the scene a map mirrors is kept on the map");
|
||||||
|
assert.match(model, /\{\s*campaign:\s*1,\s*foundrySceneId:\s*1\s*\}/, "and is unique within the campaign");
|
||||||
|
});
|
||||||
|
|
||||||
|
// --- The Foundry module sends its scenes ---------------------------------------------
|
||||||
|
|
||||||
|
const MODULE_ID = "dragonroll-foundry";
|
||||||
|
|
||||||
|
function makeWorld({ autoSync = true } = {}) {
|
||||||
|
const state = {
|
||||||
|
hooks: new Map(),
|
||||||
|
registered: new Map(),
|
||||||
|
requests: [],
|
||||||
|
timers: new Map(),
|
||||||
|
intervals: new Map(),
|
||||||
|
nextTimerId: 1,
|
||||||
|
};
|
||||||
|
|
||||||
|
// A Scene document: the plain data `toObject()` answers with, which since V13 carries
|
||||||
|
// the picture under `background` rather than `img`.
|
||||||
|
const makeScene = (id, name, over = {}) => ({
|
||||||
|
id, name, documentName: "Scene", img: "", grid: 50, flags: {},
|
||||||
|
toObject() {
|
||||||
|
return {
|
||||||
|
_id: this.id, name: this.name, img: this.img, grid: this.grid, flags: this.flags,
|
||||||
|
...(this.background ? { background: this.background } : {}),
|
||||||
|
};
|
||||||
|
},
|
||||||
|
...over,
|
||||||
|
});
|
||||||
|
const scenes = [
|
||||||
|
makeScene("scene-keep", "The Ruined Keep", { img: "images/keep.webp", grid: 70 }),
|
||||||
|
// A newer Foundry keeps its picture under `background`, and this one is already an
|
||||||
|
// absolute URL, which travels as it is.
|
||||||
|
makeScene("scene-tavern", "Tavern", { img: undefined, background: { src: "http://other.test/tavern.jpg" }, grid: 50 }),
|
||||||
|
];
|
||||||
|
|
||||||
|
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() {}, warn() {}, error() {} } },
|
||||||
|
Hooks: {
|
||||||
|
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||||
|
on(name, fn) { state.hooks.set(name, [...(state.hooks.get(name) || []), fn]); },
|
||||||
|
},
|
||||||
|
setTimeout: (fn, delay = 0) => {
|
||||||
|
const id = state.nextTimerId++;
|
||||||
|
state.timers.set(id, { fn, delay });
|
||||||
|
return id;
|
||||||
|
},
|
||||||
|
clearTimeout: (id) => state.timers.delete(id),
|
||||||
|
setInterval: (fn, delay = 0) => {
|
||||||
|
const id = state.nextTimerId++;
|
||||||
|
state.intervals.set(id, { fn, delay });
|
||||||
|
return id;
|
||||||
|
},
|
||||||
|
clearInterval: (id) => state.intervals.delete(id),
|
||||||
|
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" }) };
|
||||||
|
},
|
||||||
|
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: [], get: () => null },
|
||||||
|
items: { contents: [], get: () => null },
|
||||||
|
scenes: { contents: scenes, get: (id) => scenes.find((scene) => scene.id === id) },
|
||||||
|
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(read("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||||
|
|
||||||
|
state.game = sandbox.game;
|
||||||
|
state.scene = (id) => scenes.find((scene) => scene.id === id);
|
||||||
|
// The two routes the maps travel on: the campaign's reads live under the same prefix and
|
||||||
|
// tell nothing about what the world sent.
|
||||||
|
state.sceneRequests = () => state.requests.filter((request) => request.href.includes("foundry/sync/scenes")
|
||||||
|
|| request.href.includes("foundry/sync/scene-delete"));
|
||||||
|
state.pushes = (route) => state.requests.filter((request) => request.href.includes(route));
|
||||||
|
|
||||||
|
const drain = async () => { await new Promise((resolve) => setImmediate(resolve)); };
|
||||||
|
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();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
// A world that is already linked: init, ready, and the pushes the world makes as it loads.
|
||||||
|
state.setup = async () => {
|
||||||
|
await state.fire("init");
|
||||||
|
await state.fire("ready");
|
||||||
|
await state.runTimers();
|
||||||
|
return state;
|
||||||
|
};
|
||||||
|
// The same, with the world's own pushes out of the way, so a test only sees what it causes.
|
||||||
|
state.linkedSetup = async () => {
|
||||||
|
await state.setup();
|
||||||
|
state.requests.length = 0;
|
||||||
|
return state;
|
||||||
|
};
|
||||||
|
|
||||||
|
return state;
|
||||||
|
}
|
||||||
|
|
||||||
|
test("the world sends its whole scene list as the campaign's maps when it loads", async () => {
|
||||||
|
const world = await makeWorld().setup();
|
||||||
|
|
||||||
|
const [push] = world.pushes("foundry/sync/scenes");
|
||||||
|
assert.ok(push, "a linked world pushes its scenes as it loads");
|
||||||
|
assert.equal(push.body.fullSync, true, "the whole list travels, which is the push that lets the campaign prune");
|
||||||
|
assert.deepEqual(push.body.worldId, "world-1");
|
||||||
|
assert.deepEqual(push.body.scenes.map((scene) => [scene._id, scene.name]), [
|
||||||
|
["scene-keep", "The Ruined Keep"],
|
||||||
|
["scene-tavern", "Tavern"],
|
||||||
|
]);
|
||||||
|
assert.equal(push.body.scenes[0].img, "http://vtt.test/images/keep.webp",
|
||||||
|
"the picture is read from this world, so it travels as an absolute URL");
|
||||||
|
assert.equal(push.body.scenes[0].grid, 70, "the scene's own cell size travels with it");
|
||||||
|
assert.equal(push.body.scenes[1].background.src, "http://other.test/tavern.jpg",
|
||||||
|
"a picture that is already absolute is left as it is");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene the GM changes reaches the campaign as that map", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
|
||||||
|
const keep = world.scene("scene-keep");
|
||||||
|
keep.name = "The Sunken Keep";
|
||||||
|
keep.grid = 100;
|
||||||
|
await world.fire("updateScene", keep);
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
const [push] = world.pushes("foundry/sync/scenes");
|
||||||
|
assert.equal(push.body.fullSync, false, "a live scene edit never prunes the campaign's other maps");
|
||||||
|
assert.deepEqual(push.body.scenes.map((scene) => [scene._id, scene.name, scene.grid]), [
|
||||||
|
["scene-keep", "The Sunken Keep", 100],
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene the GM deletes takes its map off the campaign", async () => {
|
||||||
|
const world = await makeWorld().linkedSetup();
|
||||||
|
|
||||||
|
await world.fire("deleteScene", world.scene("scene-tavern"));
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
const [push] = world.pushes("foundry/sync/scene-delete");
|
||||||
|
assert.equal(push.body.foundrySceneId, "scene-tavern");
|
||||||
|
assert.deepEqual(world.pushes("foundry/sync/scenes"), [], "a deleted scene is not sent as a map to keep");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("autosync off: the world's scenes stop syncing, at world start and afterwards", async () => {
|
||||||
|
const world = makeWorld({ autoSync: false });
|
||||||
|
await world.fire("init");
|
||||||
|
await world.fire("ready");
|
||||||
|
await world.runTimers();
|
||||||
|
assert.deepEqual(world.sceneRequests(), [], "a world with autosync off sends no scene list");
|
||||||
|
|
||||||
|
await world.fire("updateScene", world.scene("scene-keep"));
|
||||||
|
await world.fire("deleteScene", world.scene("scene-tavern"));
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
assert.deepEqual(world.sceneRequests(), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the scene edits queued while autosync was off are sent when it is turned back on", async () => {
|
||||||
|
const world = await makeWorld({ autoSync: false });
|
||||||
|
await world.fire("init");
|
||||||
|
await world.fire("ready");
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
await world.fire("updateScene", world.scene("scene-keep"));
|
||||||
|
await world.runTimers();
|
||||||
|
assert.deepEqual(world.sceneRequests(), []);
|
||||||
|
|
||||||
|
await world.game.settings.set(MODULE_ID, "autoSync", true);
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
assert.ok(world.pushes("foundry/sync/scenes").some((push) => push.body.fullSync === true
|
||||||
|
&& push.body.scenes.length === 2),
|
||||||
|
"turning autosync back on sends this world's whole scene list again");
|
||||||
|
assert.ok(world.pushes("foundry/sync/scenes").some((push) => push.body.fullSync === false
|
||||||
|
&& push.body.scenes.map((scene) => scene._id).includes("scene-keep")),
|
||||||
|
"and the scene edit queued while it was off is sent");
|
||||||
|
});
|
||||||
@@ -85,6 +85,9 @@ function loadMapRoutes({ ownsCampaign = true, maps = [], notes = [] } = {}) {
|
|||||||
},
|
},
|
||||||
// The pins do not ask after actors, only the token routes below do.
|
// The pins do not ask after actors, only the token routes below do.
|
||||||
"../models/Actor": { findOne: () => mongooseQuery(null) },
|
"../models/Actor": { findOne: () => mongooseQuery(null) },
|
||||||
|
// The map list's own folder tree: `/list` reads it and `/update` checks a move
|
||||||
|
// against it, so the pins need the model to answer, never what it answers.
|
||||||
|
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -181,7 +184,12 @@ function loadNoteRoutes({ ownsCampaign = true, notes = [], folders = [], deleted
|
|||||||
findById: (id) => mongooseQuery(notes.find((note) => note._id === id) ?? null),
|
findById: (id) => mongooseQuery(notes.find((note) => note._id === id) ?? null),
|
||||||
deleteOne: () => mongooseQuery({ deletedCount }),
|
deleteOne: () => mongooseQuery({ deletedCount }),
|
||||||
},
|
},
|
||||||
"../models/Folder": { find: () => mongooseQuery(folders) },
|
"../models/Folder": {
|
||||||
|
find: () => mongooseQuery(folders),
|
||||||
|
// models/Folder.js: the note tree is every folder that is not one of the other
|
||||||
|
// campaign lists, whose rows carry no target at all.
|
||||||
|
filterForTarget: (target) => (target === "note" ? { target: { $nin: ["actor", "item", "map"] } } : { target }),
|
||||||
|
},
|
||||||
"../models/Map": {
|
"../models/Map": {
|
||||||
// The driver drops the pins of the note from every map holding one; what is worth
|
// The driver drops the pins of the note from every map holding one; what is worth
|
||||||
// keeping here is the filter it is asked to do that with.
|
// keeping here is the filter it is asked to do that with.
|
||||||
|
|||||||
@@ -82,6 +82,9 @@ function loadMapRoutes({ ownsCampaign = true, maps = [], actors = [] } = {}) {
|
|||||||
: null
|
: null
|
||||||
),
|
),
|
||||||
},
|
},
|
||||||
|
// The map list's own folder tree: `/list` reads it and `/update` checks a move
|
||||||
|
// against it, so the tokens need the model to answer, never what it answers.
|
||||||
|
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -188,6 +191,8 @@ function loadActorRoutes({ ownsCampaign = true, actors = [], deletedCount = 1 }
|
|||||||
return { modifiedCount: 1 };
|
return { modifiedCount: 1 };
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
// The actor list's own folder tree, which the delete does not ask after.
|
||||||
|
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
|
||||||
});
|
});
|
||||||
return { api, tokensPulled };
|
return { api, tokensPulled };
|
||||||
}
|
}
|
||||||
@@ -299,10 +304,14 @@ function mapViewerTokenWiringTests() {
|
|||||||
const sidebar = readRepoFile("frontend", "app", "components", "partials", "ContentSidebar.vue");
|
const sidebar = readRepoFile("frontend", "app", "components", "partials", "ContentSidebar.vue");
|
||||||
|
|
||||||
test("an actor row of the sidebar can be dragged out of it", () => {
|
test("an actor row of the sidebar can be dragged out of it", () => {
|
||||||
const actorRow = /<div v-for="actor in actors"[^>]*>/.exec(sidebar)?.[0];
|
// The actors' block of the sidebar: since the entry lists got their folders the rows
|
||||||
|
// come from that tree, so the actor row holds its actor as `row.item`.
|
||||||
|
const actorSection = /<template v-else-if="activeSection === 'actors'">([\s\S]*?)<\/template>\s*\n\s*<template v-else-if="activeSection === 'items'">/
|
||||||
|
.exec(sidebar)?.[1] ?? "";
|
||||||
|
const actorRow = /<div v-else class="entity-entry"[^>]*>/.exec(actorSection)?.[0];
|
||||||
assert.ok(actorRow, "expected the actor rows of the sidebar");
|
assert.ok(actorRow, "expected the actor rows of the sidebar");
|
||||||
assert.match(actorRow, /draggable="true"/);
|
assert.match(actorRow, /draggable="true"/);
|
||||||
assert.match(actorRow, /@dragstart="startActorDrag\(\$event, actor\)"/);
|
assert.match(actorRow, /@dragstart="startActorDrag\(\$event, row\.item\)"/);
|
||||||
assert.match(sidebar, /setData\(ACTOR_DRAG_TYPE, String\(actor\._id\)\)/);
|
assert.match(sidebar, /setData\(ACTOR_DRAG_TYPE, String\(actor\._id\)\)/);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -332,6 +341,17 @@ function mapViewerTokenWiringTests() {
|
|||||||
assert.match(pane, /@contextmenu\.stop\.prevent="onTokenContextMenu\(token\)"/);
|
assert.match(pane, /@contextmenu\.stop\.prevent="onTokenContextMenu\(token\)"/);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
test("double clicking a token opens its actor's character sheet", () => {
|
||||||
|
assert.match(pane, /@dblclick="openTokenSheet\(token\)"/);
|
||||||
|
// The sheet is opened for the actor behind the token, and only when that actor is known.
|
||||||
|
assert.match(pane, /function openTokenSheet\(token\) \{[^}]*tokenActor\(token\)[^}]*openActorSheet\(/);
|
||||||
|
// A single click is not the trigger: it lands on the token at the end of every drag, so
|
||||||
|
// moving a token would open its sheet every time.
|
||||||
|
assert.doesNotMatch(pane, /@click="openTokenSheet\(/);
|
||||||
|
// The keyboard reaches the same sheet: Enter on a focused token, like its arrow keys.
|
||||||
|
assert.match(pane, /if \(event\.key === 'Enter'\) openTokenSheet\(token\);/);
|
||||||
|
});
|
||||||
|
|
||||||
test("tokens are saved and taken off through the map routes", () => {
|
test("tokens are saved and taken off through the map routes", () => {
|
||||||
assert.match(pane, /['"]\/map\/place-token['"]/);
|
assert.match(pane, /['"]\/map\/place-token['"]/);
|
||||||
assert.match(pane, /['"]\/map\/remove-token['"]/);
|
assert.match(pane, /['"]\/map\/remove-token['"]/);
|
||||||
|
|||||||
72
tests/theme-color-vars.test.js
Normal file
72
tests/theme-color-vars.test.js
Normal file
@@ -0,0 +1,72 @@
|
|||||||
|
// Tests for Syndria98/dragonroll#71: `pnpm dev` warned, on every frontend build,
|
||||||
|
// "You probably don't mean to use the color value red in interpolation here" from `theme-vars()`
|
||||||
|
// in colors.scss. `red`, `green` and `gray` are also Sass colour keywords, so as unquoted map keys
|
||||||
|
// they were parsed as colour *values* and interpolating one into `--color-#{$name}` warned (and can
|
||||||
|
// emit an invalid name). Quoting those keys keeps them strings; the emitted CSS is unchanged, so
|
||||||
|
// `var(--color-red)` and friends still resolve.
|
||||||
|
//
|
||||||
|
// `sass` is not installed for `npm test`, so this reads colors.scss the way the other tests read
|
||||||
|
// sources: the check is that no map key is left bare when it spells a CSS colour keyword.
|
||||||
|
//
|
||||||
|
// 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 read = (...parts) => fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
|
||||||
|
const colorsSource = read("frontend", "app", "assets", "css", "colors.scss");
|
||||||
|
|
||||||
|
// The CSS named colours. Sass parses any of these (in any case) as a colour value, so a theme or
|
||||||
|
// accent map key spelled like one of them has to be quoted to stay a string.
|
||||||
|
const colorKeywords = new Set(
|
||||||
|
[
|
||||||
|
"aliceblue", "antiquewhite", "aqua", "aquamarine", "azure", "beige", "bisque", "black",
|
||||||
|
"blanchedalmond", "blue", "blueviolet", "brown", "burlywood", "cadetblue", "chartreuse",
|
||||||
|
"chocolate", "coral", "cornflowerblue", "cornsilk", "crimson", "cyan", "darkblue", "darkcyan",
|
||||||
|
"darkgoldenrod", "darkgray", "darkgreen", "darkkhaki", "darkmagenta", "darkolivegreen",
|
||||||
|
"darkorange", "darkorchid", "darkred", "darksalmon", "darkseagreen", "darkslateblue",
|
||||||
|
"darkslategray", "darkturquoise", "darkviolet", "deeppink", "deepskyblue", "dimgray",
|
||||||
|
"dodgerblue", "firebrick", "floralwhite", "forestgreen", "fuchsia", "gainsboro", "ghostwhite",
|
||||||
|
"gold", "goldenrod", "gray", "green", "greenyellow", "honeydew", "hotpink", "indianred",
|
||||||
|
"indigo", "ivory", "khaki", "lavender", "lavenderblush", "lawngreen", "lemonchiffon",
|
||||||
|
"lightblue", "lightcoral", "lightcyan", "lightgoldenrodyellow", "lightgray", "lightgreen",
|
||||||
|
"lightpink", "lightsalmon", "lightseagreen", "lightskyblue", "lightslategray",
|
||||||
|
"lightsteelblue", "lightyellow", "lime", "limegreen", "linen", "magenta", "maroon",
|
||||||
|
"mediumaquamarine", "mediumblue", "mediumorchid", "mediumpurple", "mediumseagreen",
|
||||||
|
"mediumslateblue", "mediumspringgreen", "mediumturquoise", "mediumvioletred", "midnightblue",
|
||||||
|
"mintcream", "mistyrose", "moccasin", "navajowhite", "navy", "oldlace", "olive", "olivedrab",
|
||||||
|
"orange", "orangered", "orchid", "palegoldenrod", "palegreen", "paleturquoise",
|
||||||
|
"palevioletred", "papayawhip", "peachpuff", "peru", "pink", "plum", "powderblue", "purple",
|
||||||
|
"rebeccapurple", "red", "rosybrown", "royalblue", "saddlebrown", "salmon", "sandybrown",
|
||||||
|
"seagreen", "seashell", "sienna", "silver", "skyblue", "slateblue", "slategray", "snow",
|
||||||
|
"springgreen", "steelblue", "tan", "teal", "thistle", "tomato", "transparent", "turquoise",
|
||||||
|
"violet", "wheat", "white", "whitesmoke", "yellow", "yellowgreen",
|
||||||
|
]
|
||||||
|
);
|
||||||
|
|
||||||
|
// The keys of the `$themes` and `$accents` maps and of each theme inside them: a line starting with
|
||||||
|
// `key:` or `"key":`. The custom properties of the mixins (`--color-#{$name}: #{$value};`) do not
|
||||||
|
// match, `#` is not part of a key.
|
||||||
|
const mapKeys = [...colorsSource.matchAll(/^\s*("[^"]+"|[A-Za-z][A-Za-z0-9_-]*)\s*:/gm)].map((m) => m[1]);
|
||||||
|
|
||||||
|
test("the theme and accent maps are read as maps of keys", () => {
|
||||||
|
// sanity check on the extraction above before it is trusted to find a bare colour keyword
|
||||||
|
for (const key of ["dark", "light", "katlum", "solus", "silang", "background", "text"]) {
|
||||||
|
assert.ok(mapKeys.includes(key), `expected to find the map key '${key}'`);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
test("no map key is a bare CSS colour keyword", () => {
|
||||||
|
const bare = mapKeys.filter((key) => !key.startsWith('"') && colorKeywords.has(key.toLowerCase()));
|
||||||
|
assert.deepEqual(bare, [], `quote these colors.scss map keys so Sass keeps them strings: ${bare.join(", ")}`);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the colour-named theme keys are quoted in both maps", () => {
|
||||||
|
for (const [key, value] of [["red", "#e06c75"], ["green", "#98c379"], ["gray", "#cccccc"]]) {
|
||||||
|
const declarations = colorsSource.match(new RegExp(`"${key}":\\s*${value}\\b`, "g")) || [];
|
||||||
|
assert.equal(declarations.length, 2, `expected quoted "${key}": ${value} in both the dark and the light map`);
|
||||||
|
}
|
||||||
|
});
|
||||||
Reference in New Issue
Block a user