Compare commits
15 Commits
2cce19e032
...
ai/issue-1
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3c3df58d8d | ||
| c9ee16f2f2 | |||
|
|
abcec4d2ff | ||
| dcc6d7a14b | |||
| 227fff1351 | |||
| a64fe499e9 | |||
| b75ee05276 | |||
| bc7231a1da | |||
| 252ae2d6b2 | |||
|
|
30e23b643c | ||
|
|
8376acfc6b | ||
|
|
f8dae95563 | ||
| 98aa3be078 | |||
| 80c6b1b62f | |||
|
|
9aad484fe9 |
@@ -142,7 +142,10 @@ name is the slug, and the first heading is the title. `services/Docs.js` reads t
|
|||||||
(`import.meta.glob(..., {query:'?raw'})`), builds the sidebar and renders a page with marked;
|
(`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
|
`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
|
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.
|
`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
|
||||||
|
|||||||
@@ -27,6 +27,19 @@ const MapSchema = new Schema({
|
|||||||
x: { type: Number, default: 0 },
|
x: { type: Number, default: 0 },
|
||||||
y: { type: Number, default: 0 }
|
y: { type: Number, default: 0 }
|
||||||
}],
|
}],
|
||||||
|
// Segments that block the map like walls. The endpoints are image pixels from the top left corner
|
||||||
|
// of the image, like a pin — and the very space Foundry draws a scene's walls in, so a paired
|
||||||
|
// scene and map trade them as they stand. `move`/`sight` say what passes through the segment, and
|
||||||
|
// `door` is 0 (not a door), 1 (open) or 2 (closed), following Foundry's own wall values.
|
||||||
|
walls: [{
|
||||||
|
x1: { type: Number, default: 0 },
|
||||||
|
y1: { type: Number, default: 0 },
|
||||||
|
x2: { type: Number, default: 0 },
|
||||||
|
y2: { type: Number, default: 0 },
|
||||||
|
move: { type: Boolean, default: true },
|
||||||
|
sight: { type: Boolean, default: true },
|
||||||
|
door: { type: Number, min: 0, max: 2, default: 0 }
|
||||||
|
}],
|
||||||
campaign: {
|
campaign: {
|
||||||
type: Schema.Types.ObjectId,
|
type: Schema.Types.ObjectId,
|
||||||
ref: 'Campaign',
|
ref: 'Campaign',
|
||||||
@@ -39,7 +52,16 @@ const MapSchema = new Schema({
|
|||||||
ref: 'Folder',
|
ref: 'Folder',
|
||||||
default: null
|
default: null
|
||||||
},
|
},
|
||||||
|
// The Foundry scene whose walls this map mirrors once the linked world has paired them (see
|
||||||
|
// routes/foundry-link.js): the whole wall set of one is the whole wall set of the other.
|
||||||
|
foundrySceneId: { type: String },
|
||||||
date: { type: Date, default: Date.now }
|
date: { type: Date, default: Date.now }
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// A scene walls one map of a campaign at most, like a Foundry actor one actor row.
|
||||||
|
MapSchema.index(
|
||||||
|
{ campaign: 1, foundrySceneId: 1 },
|
||||||
|
{ unique: true, partialFilterExpression: { foundrySceneId: { $type: 'string' } } }
|
||||||
|
);
|
||||||
|
|
||||||
module.exports = mongoose.model('Map', MapSchema);
|
module.exports = mongoose.model('Map', MapSchema);
|
||||||
|
|||||||
@@ -7,8 +7,11 @@ 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');
|
||||||
const Folder = require('../models/Folder');
|
const Folder = require('../models/Folder');
|
||||||
|
// `MapModel`, not `Map`: this file uses the built-in `Map` for the item folder maps.
|
||||||
|
const MapModel = require('../models/Map');
|
||||||
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 { 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 +44,33 @@ function requestMatchesWorld(campaign, worldId) {
|
|||||||
return typeof worldId === 'string' && worldId === campaign.foundryWorldId;
|
return typeof worldId === 'string' && worldId === campaign.foundryWorldId;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// 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) {
|
async function saveFoundryActor(campaign, source, fullSync = 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 || {});
|
||||||
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;
|
||||||
@@ -85,6 +111,7 @@ async function saveFoundryItem(campaign, source, fullSync = false, folders = nul
|
|||||||
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;
|
||||||
@@ -452,6 +479,103 @@ router.post('/sync/map-item', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// --- Scene walls -----------------------------------------------------------
|
||||||
|
// A campaign map can mirror the walls of a Foundry scene: the whole set travels whoever edits
|
||||||
|
// it, so the map's editor and the scene's wall tool see the same segments. A map is paired with
|
||||||
|
// a scene by name while the module reconciles its campaign — the way an unmapped item maps to
|
||||||
|
// the world document it shares its name with — and `POST /sync/map-scene` records that pairing.
|
||||||
|
// The endpoints are image pixels of the scene's background there too, so a segment crosses
|
||||||
|
// unchanged; `door` follows Foundry's own wall values (1 open, 2 closed), and locked doors
|
||||||
|
// arrive closed.
|
||||||
|
|
||||||
|
// Same shape the campaign's own `/map/walls` saves by: finite endpoints or nothing, whole pixels
|
||||||
|
// that never go off the top left corner, no segment without length.
|
||||||
|
function toSyncedWall(source) {
|
||||||
|
const corners = [source?.x1, source?.y1, source?.x2, source?.y2];
|
||||||
|
if (!corners.every((value) => Number.isFinite(Number(value)))) return null;
|
||||||
|
|
||||||
|
const toPixel = (value) => Math.max(0, Math.round(Number(value)));
|
||||||
|
const wall = {
|
||||||
|
x1: toPixel(source.x1),
|
||||||
|
y1: toPixel(source.y1),
|
||||||
|
x2: toPixel(source.x2),
|
||||||
|
y2: toPixel(source.y2),
|
||||||
|
move: source.move !== false,
|
||||||
|
sight: source.sight !== false,
|
||||||
|
door: [1, 2].includes(Math.round(Number(source.door))) ? Math.round(Number(source.door)) : 0
|
||||||
|
};
|
||||||
|
return wall.x1 === wall.x2 && wall.y1 === wall.y2 ? null : wall;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The maps the module pairs scenes with and reconciles walls against: what a wall set needs to
|
||||||
|
// land on a scene, and nothing the module has no use for.
|
||||||
|
router.get('/sync/maps', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
|
||||||
|
const maps = await MapModel.find({ campaign: campaign._id })
|
||||||
|
.select('_id name image foundrySceneId walls')
|
||||||
|
.sort({ name: 1 })
|
||||||
|
.lean();
|
||||||
|
res.json({ status: 'ok', maps });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
router.post('/sync/map-scene', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const { mapId, foundrySceneId, worldId } = req.body;
|
||||||
|
if (!requestMatchesWorld(campaign, worldId) || !mapId || !foundrySceneId) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const map = await MapModel.findOne({ _id: mapId, campaign: campaign._id });
|
||||||
|
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
const existing = await MapModel.findOne({
|
||||||
|
campaign: campaign._id,
|
||||||
|
foundrySceneId: String(foundrySceneId).trim(),
|
||||||
|
_id: { $ne: map._id }
|
||||||
|
});
|
||||||
|
if (existing) return res.json({ status: 'error', msg: 'foundry.errors.scene-already-synced' });
|
||||||
|
|
||||||
|
map.foundrySceneId = String(foundrySceneId).trim().slice(0, 120);
|
||||||
|
await map.save();
|
||||||
|
res.json({ status: 'ok', map });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// A scene's whole wall set, as the module draws it: the paired map takes it over, like the
|
||||||
|
// world's item folders take over the campaign's tree. A scene the campaign has no map paired
|
||||||
|
// with answers `notfound` — most scenes are none of the campaign's business.
|
||||||
|
router.post('/sync/map-walls', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const campaign = await syncCampaign(req, res);
|
||||||
|
if (!campaign) return;
|
||||||
|
const { foundrySceneId, walls, worldId } = req.body;
|
||||||
|
if (!requestMatchesWorld(campaign, worldId) || !foundrySceneId || !Array.isArray(walls)) {
|
||||||
|
return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
}
|
||||||
|
|
||||||
|
const map = await MapModel.findOne({ campaign: campaign._id, foundrySceneId: String(foundrySceneId).trim() });
|
||||||
|
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
|
||||||
|
map.walls = walls.map(toSyncedWall).filter(Boolean);
|
||||||
|
await map.save();
|
||||||
|
res.json({ status: 'ok', map: { _id: map.id } });
|
||||||
|
} 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
|
// 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
|
// force import a campaign asks for from its sidebar (routes/foundry.js). One set of
|
||||||
|
|||||||
@@ -238,4 +238,50 @@ router.post('/remove-token', async (req, res) => {
|
|||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// A wall is a segment of the map that blocks it like one does. The editor saves the whole set at
|
||||||
|
// once — drawing, moving, re-typing and taking off segments are all the same request — and a paired
|
||||||
|
// Foundry scene takes that set whole too, so the set is the contract on both sides. Endpoints are
|
||||||
|
// image pixels like a pin's, and a wall keeps the `_id` it is sent with when one of the current
|
||||||
|
// walls has it, so the markers on screen do not jump through a save. A segment with no length is
|
||||||
|
// dropped: it is a click that was not meant to draw anything.
|
||||||
|
function toStoredWall(source, currentWalls) {
|
||||||
|
const corners = [source?.x1, source?.y1, source?.x2, source?.y2];
|
||||||
|
if (!corners.every((value) => Number.isFinite(Number(value)))) return null;
|
||||||
|
|
||||||
|
const wall = {
|
||||||
|
x1: toCoordinate(source.x1),
|
||||||
|
y1: toCoordinate(source.y1),
|
||||||
|
x2: toCoordinate(source.x2),
|
||||||
|
y2: toCoordinate(source.y2),
|
||||||
|
// What the editor draws is a wall, not an opening: both stay out unless it says otherwise.
|
||||||
|
move: source.move !== false,
|
||||||
|
sight: source.sight !== false,
|
||||||
|
door: [1, 2].includes(Math.round(Number(source.door))) ? Math.round(Number(source.door)) : 0
|
||||||
|
};
|
||||||
|
if (wall.x1 === wall.x2 && wall.y1 === wall.y2) return null;
|
||||||
|
|
||||||
|
const id = String(source?._id ?? '').trim();
|
||||||
|
if (id && currentWalls.some((current) => String(current?._id) === id)) wall._id = id;
|
||||||
|
return wall;
|
||||||
|
}
|
||||||
|
|
||||||
|
router.post('/walls', async (req, res) => {
|
||||||
|
try {
|
||||||
|
const { id, walls } = req.body;
|
||||||
|
if (!id || !Array.isArray(walls)) return res.json({ status: 'error', msg: 'errors.missing-data' });
|
||||||
|
|
||||||
|
const map = await Map.findById(id);
|
||||||
|
if (!map) return res.json({ status: 'error', msg: 'errors.notfound' });
|
||||||
|
if (!(await userOwnsCampaign(map.campaign, req.user.id))) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
|
const currentWalls = Array.from(map.walls ?? []);
|
||||||
|
map.walls = walls.map((source) => toStoredWall(source, currentWalls)).filter(Boolean);
|
||||||
|
await map.save();
|
||||||
|
res.json({ status: 'ok', map });
|
||||||
|
} catch (err) {
|
||||||
|
console.error(err);
|
||||||
|
res.json({ status: 'error', msg: 'errors.internal' });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
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
|
||||||
@@ -169,8 +170,11 @@ function foundryActorToCharacter(foundryActor) {
|
|||||||
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),
|
proficiencies: foundryProficiencies || 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),
|
||||||
|
|||||||
@@ -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 };
|
||||||
|
|||||||
@@ -36,6 +36,11 @@ let folderSyncRunning = 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();
|
||||||
|
let wallSyncTimeout;
|
||||||
|
let mapSyncRunning = false;
|
||||||
|
let mapSyncErrorLogged = false;
|
||||||
|
const queuedWallSceneIds = new Set();
|
||||||
|
const applyingWallsSceneIds = new Set();
|
||||||
|
|
||||||
function getCollectionContents(collection, collectionName) {
|
function getCollectionContents(collection, collectionName) {
|
||||||
if (!collection) {
|
if (!collection) {
|
||||||
@@ -300,6 +305,7 @@ async function applyDragonrollLink(result) {
|
|||||||
scheduleSnapshotSync(0);
|
scheduleSnapshotSync(0);
|
||||||
setTimeout(initializeCharacterSync, 0);
|
setTimeout(initializeCharacterSync, 0);
|
||||||
setTimeout(reconcileDragonrollItems, 2000);
|
setTimeout(reconcileDragonrollItems, 2000);
|
||||||
|
setTimeout(reconcileDragonrollMaps, 2500);
|
||||||
} 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";
|
||||||
@@ -441,6 +447,7 @@ function handleAutoSyncChange(value) {
|
|||||||
clearTimeout(actorSyncTimeout);
|
clearTimeout(actorSyncTimeout);
|
||||||
clearTimeout(itemSyncTimeout);
|
clearTimeout(itemSyncTimeout);
|
||||||
clearTimeout(folderSyncTimeout);
|
clearTimeout(folderSyncTimeout);
|
||||||
|
clearTimeout(wallSyncTimeout);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
if (!game.user?.isGM || !getSyncToken()) return;
|
if (!game.user?.isGM || !getSyncToken()) return;
|
||||||
@@ -450,6 +457,7 @@ function handleAutoSyncChange(value) {
|
|||||||
initializeCharacterSync();
|
initializeCharacterSync();
|
||||||
reconcileDragonrollItems();
|
reconcileDragonrollItems();
|
||||||
queueFoundryItemFolders(400);
|
queueFoundryItemFolders(400);
|
||||||
|
reconcileDragonrollMaps();
|
||||||
if (queuedActorChanges.size) {
|
if (queuedActorChanges.size) {
|
||||||
clearTimeout(actorSyncTimeout);
|
clearTimeout(actorSyncTimeout);
|
||||||
actorSyncTimeout = setTimeout(flushActorChanges, 400);
|
actorSyncTimeout = setTimeout(flushActorChanges, 400);
|
||||||
@@ -458,6 +466,10 @@ function handleAutoSyncChange(value) {
|
|||||||
clearTimeout(itemSyncTimeout);
|
clearTimeout(itemSyncTimeout);
|
||||||
itemSyncTimeout = setTimeout(flushItemChanges, 400);
|
itemSyncTimeout = setTimeout(flushItemChanges, 400);
|
||||||
}
|
}
|
||||||
|
if (queuedWallSceneIds.size) {
|
||||||
|
clearTimeout(wallSyncTimeout);
|
||||||
|
wallSyncTimeout = setTimeout(flushFoundrySceneWalls, 400);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function dragonrollActorId(actor) {
|
function dragonrollActorId(actor) {
|
||||||
@@ -523,9 +535,16 @@ function isSupportedCharacterActor(actor) {
|
|||||||
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,
|
||||||
@@ -911,6 +930,239 @@ async function flushItemChanges() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Scene walls -----------------------------------------------------------
|
||||||
|
// A campaign map can mirror the walls of a Foundry scene: the whole set travels to whoever did
|
||||||
|
// not edit it, so the map's wall editor and the scene's wall tool see the same segments. The
|
||||||
|
// endpoints are image pixels of the scene's background there too, so a segment crosses unchanged.
|
||||||
|
// Walls need no D&D 5e — they are plain scene geometry — and unlike actors and items, a scene is
|
||||||
|
// never made or deleted here: only its walls are read and written.
|
||||||
|
|
||||||
|
// Wall endpoints are whole image pixels on either side, rounded the same way before a set is
|
||||||
|
// compared, written or sent, so a set that only differs in Foundry's float precision is still
|
||||||
|
// recognised as unchanged and no write is made for it.
|
||||||
|
function toWallPixel(value) {
|
||||||
|
return Math.max(0, Math.round(Number(value) || 0));
|
||||||
|
}
|
||||||
|
|
||||||
|
function toWallDoor(value) {
|
||||||
|
const door = Number(value) || 0;
|
||||||
|
return door === 1 || door === 2 ? door : 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
// A Foundry wall in the campaign's shape: `sense` blocks sight, `move` passage, and a door is
|
||||||
|
// open or closed by its state (`ds`) — Foundry's locked doors read as closed.
|
||||||
|
function campaignWallFromFoundry(wall) {
|
||||||
|
const c = Array.from(wall?.c ?? []);
|
||||||
|
return {
|
||||||
|
x1: toWallPixel(c[0]),
|
||||||
|
y1: toWallPixel(c[1]),
|
||||||
|
x2: toWallPixel(c[2]),
|
||||||
|
y2: toWallPixel(c[3]),
|
||||||
|
move: (Number(wall?.move) || 0) !== 0,
|
||||||
|
sight: (Number(wall?.sense) || 0) !== 0,
|
||||||
|
door: Number(wall?.door) > 0 ? (Number(wall?.ds) === 1 ? 1 : 2) : 0,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function campaignWallFromSync(wall) {
|
||||||
|
return {
|
||||||
|
x1: toWallPixel(wall?.x1),
|
||||||
|
y1: toWallPixel(wall?.y1),
|
||||||
|
x2: toWallPixel(wall?.x2),
|
||||||
|
y2: toWallPixel(wall?.y2),
|
||||||
|
move: wall?.move !== false,
|
||||||
|
sight: wall?.sight !== false,
|
||||||
|
door: toWallDoor(wall?.door),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// A campaign wall in Foundry's own shape: blocking sight is its opaque wall (light and sense
|
||||||
|
// alike, the way the wall tool sets them), blocking movement its impassable one, and a door
|
||||||
|
// carries the open/closed state it has.
|
||||||
|
function foundryWallData(wall) {
|
||||||
|
const sight = wall?.sight !== false;
|
||||||
|
const door = toWallDoor(wall?.door);
|
||||||
|
return {
|
||||||
|
c: [
|
||||||
|
toWallPixel(wall?.x1),
|
||||||
|
toWallPixel(wall?.y1),
|
||||||
|
toWallPixel(wall?.x2),
|
||||||
|
toWallPixel(wall?.y2),
|
||||||
|
],
|
||||||
|
light: sight ? 2 : 0,
|
||||||
|
sense: sight ? 2 : 0,
|
||||||
|
move: wall?.move === false ? 0 : 1,
|
||||||
|
door,
|
||||||
|
ds: door === 1 ? 1 : 0,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Whether the scene already stands with the campaign's set, both read in the campaign's shape.
|
||||||
|
function wallsMatch(localWalls, remoteWalls) {
|
||||||
|
if (localWalls.length !== remoteWalls.length) return false;
|
||||||
|
return remoteWalls.every((entry, index) => {
|
||||||
|
const wanted = campaignWallFromSync(entry);
|
||||||
|
const local = localWalls[index];
|
||||||
|
return ["x1", "y1", "x2", "y2", "move", "sight", "door"].every((key) => local?.[key] === wanted[key]);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function wallDocumentsOf(scene) {
|
||||||
|
return (scene?.wallDocuments?.contents || scene?.walls?.contents || []).slice();
|
||||||
|
}
|
||||||
|
|
||||||
|
function sceneWallSnapshots(scene) {
|
||||||
|
return wallDocumentsOf(scene).map(campaignWallFromFoundry);
|
||||||
|
}
|
||||||
|
|
||||||
|
function reportMapSyncError(error) {
|
||||||
|
if (mapSyncErrorLogged) return;
|
||||||
|
mapSyncErrorLogged = true;
|
||||||
|
console.warn(`${MODULE_ID} | Map sync failed and will retry.`, error);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The scene a wall hook is about: Foundry v11 hands the Wall document and older versions the
|
||||||
|
// Scene, and both are taken for one.
|
||||||
|
function wallSceneFromHook(...hookArgs) {
|
||||||
|
for (const argument of hookArgs) {
|
||||||
|
if (argument?.documentName === "Scene") return argument;
|
||||||
|
if (argument?.documentName === "Wall") return argument.parent ?? null;
|
||||||
|
}
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
function queueFoundrySceneWalls(...hookArgs) {
|
||||||
|
const scene = wallSceneFromHook(...hookArgs);
|
||||||
|
if (!scene || !game.user?.isGM || !game.world || !getSyncToken()) return;
|
||||||
|
// Walls Dragonroll itself just wrote into the scene are not the GM editing them.
|
||||||
|
if (applyingWallsSceneIds.has(scene.id)) return;
|
||||||
|
|
||||||
|
queuedWallSceneIds.add(scene.id);
|
||||||
|
clearTimeout(wallSyncTimeout);
|
||||||
|
wallSyncTimeout = setTimeout(flushFoundrySceneWalls, 400);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function flushFoundrySceneWalls() {
|
||||||
|
// Autosync off: the queued wall sets wait, like the item edits do.
|
||||||
|
if (!isAutoSyncEnabled()) return;
|
||||||
|
const sceneIds = [...queuedWallSceneIds];
|
||||||
|
queuedWallSceneIds.clear();
|
||||||
|
|
||||||
|
for (const sceneId of sceneIds) {
|
||||||
|
const scene = game.scenes?.get(sceneId);
|
||||||
|
if (!scene) continue;
|
||||||
|
try {
|
||||||
|
await pushFoundrySceneWalls(scene);
|
||||||
|
mapSyncErrorLogged = false;
|
||||||
|
} catch (error) {
|
||||||
|
// A scene no campaign map mirrors is the normal case — most of a world's scenes are
|
||||||
|
// none of the campaign's business — so it is not a failure worth retrying.
|
||||||
|
if (error.message === "errors.notfound") continue;
|
||||||
|
reportMapSyncError(error);
|
||||||
|
queuedWallSceneIds.add(sceneId);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (queuedWallSceneIds.size) {
|
||||||
|
clearTimeout(wallSyncTimeout);
|
||||||
|
wallSyncTimeout = setTimeout(flushFoundrySceneWalls, 5000);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function pushFoundrySceneWalls(scene) {
|
||||||
|
const token = getSyncToken();
|
||||||
|
if (!token || !game.user?.isGM || !game.world || !scene) return;
|
||||||
|
await postDragonroll("foundry/sync/map-walls", {
|
||||||
|
worldId: game.world.id,
|
||||||
|
foundrySceneId: scene.id,
|
||||||
|
walls: sceneWallSnapshots(scene),
|
||||||
|
}, token);
|
||||||
|
}
|
||||||
|
|
||||||
|
// The campaign's walls reconciled onto its maps: paired with a scene by name where they are not
|
||||||
|
// paired yet, and every paired scene brought to the campaign's set. Live wall edits in the scene
|
||||||
|
// run the other way — they push the scene's set to the campaign as they happen.
|
||||||
|
async function reconcileDragonrollMaps() {
|
||||||
|
const token = getSyncToken();
|
||||||
|
if (!token || !game.user?.isGM || !game.world || mapSyncRunning || !isAutoSyncEnabled()) return;
|
||||||
|
mapSyncRunning = true;
|
||||||
|
try {
|
||||||
|
const result = await getDragonroll("foundry/sync/maps", token);
|
||||||
|
const remoteMaps = result.maps || [];
|
||||||
|
const pairedSceneIds = new Set(remoteMaps.map((entry) => entry.foundrySceneId).filter(Boolean));
|
||||||
|
|
||||||
|
for (const entry of remoteMaps) {
|
||||||
|
let scene = entry.foundrySceneId ? game.scenes?.get(entry.foundrySceneId) : null;
|
||||||
|
if (!scene) {
|
||||||
|
// Pair by name, the way an unmapped item maps to the world document that shares its
|
||||||
|
// name — but only when map and scene are each other's only one with it: writing the
|
||||||
|
// walls into the wrong scene is not a mistake to make on an ambiguous name. A map
|
||||||
|
// whose paired scene is gone (deleted, or a copied world) is paired anew the same way.
|
||||||
|
const namesakes = (game.scenes?.contents || [])
|
||||||
|
.filter((candidate) => !pairedSceneIds.has(candidate.id)
|
||||||
|
&& candidate.name === String(entry.name).trim());
|
||||||
|
scene = namesakes.length === 1 ? namesakes[0] : null;
|
||||||
|
if (scene) {
|
||||||
|
pairedSceneIds.add(scene.id);
|
||||||
|
await postDragonroll("foundry/sync/map-scene", {
|
||||||
|
worldId: game.world.id,
|
||||||
|
mapId: String(entry._id),
|
||||||
|
foundrySceneId: scene.id,
|
||||||
|
}, token);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (!scene) continue;
|
||||||
|
|
||||||
|
const localWalls = sceneWallSnapshots(scene);
|
||||||
|
const campaignWalls = Array.isArray(entry.walls) ? entry.walls : [];
|
||||||
|
// A map with no walls of its own adopts the walls the scene already has: they are the
|
||||||
|
// GM's work, and writing an empty set over them would undo it before the campaign's
|
||||||
|
// editor ever opened. Once both sides hold walls, the campaign's set rules the scene.
|
||||||
|
if (!campaignWalls.length && localWalls.length) {
|
||||||
|
await pushFoundrySceneWalls(scene);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
await applyDragonrollWalls(scene, campaignWalls, localWalls);
|
||||||
|
}
|
||||||
|
mapSyncErrorLogged = false;
|
||||||
|
} catch (error) {
|
||||||
|
reportMapSyncError(error);
|
||||||
|
} finally {
|
||||||
|
mapSyncRunning = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The campaign's whole set lands on the scene: segments are updated in place while a wall
|
||||||
|
// document exists for them, ones beyond the documents are made, and ones the campaign let go of
|
||||||
|
// are deleted. Marked as Dragonroll's own write while it runs, so the scene's wall hooks do not
|
||||||
|
// push the set straight back to the campaign.
|
||||||
|
async function applyDragonrollWalls(scene, walls, current = sceneWallSnapshots(scene)) {
|
||||||
|
if (wallsMatch(current, walls)) return;
|
||||||
|
|
||||||
|
const documents = wallDocumentsOf(scene);
|
||||||
|
const updates = [];
|
||||||
|
const creates = [];
|
||||||
|
for (const [index, wall] of walls.entries()) {
|
||||||
|
// A document that already stands where the campaign wants it is left alone; one index
|
||||||
|
// over the documents is made, and the ones the campaign let go of are deleted.
|
||||||
|
if (documents[index]) {
|
||||||
|
if (wallsMatch([campaignWallFromFoundry(documents[index])], [wall])) continue;
|
||||||
|
updates.push({ _id: documents[index].id, ...foundryWallData(wall) });
|
||||||
|
} else {
|
||||||
|
creates.push(foundryWallData(wall));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const deleteIds = documents.slice(walls.length).map((document) => document.id);
|
||||||
|
|
||||||
|
applyingWallsSceneIds.add(scene.id);
|
||||||
|
try {
|
||||||
|
if (updates.length) await scene.updateEmbeddedDocuments("Wall", updates);
|
||||||
|
if (creates.length) await scene.createEmbeddedDocuments("Wall", creates);
|
||||||
|
if (deleteIds.length) await scene.deleteEmbeddedDocuments("Wall", deleteIds);
|
||||||
|
} finally {
|
||||||
|
applyingWallsSceneIds.delete(scene.id);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const CATEGORY_TO_FOUNDRY_ITEM_TYPE = {
|
const CATEGORY_TO_FOUNDRY_ITEM_TYPE = {
|
||||||
weapon: "weapon",
|
weapon: "weapon",
|
||||||
armor: "equipment",
|
armor: "equipment",
|
||||||
@@ -1194,7 +1446,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 };
|
||||||
@@ -1220,7 +1484,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);
|
||||||
}
|
}
|
||||||
@@ -1428,6 +1693,8 @@ 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);
|
||||||
|
setTimeout(reconcileDragonrollMaps, 2500);
|
||||||
|
setInterval(reconcileDragonrollMaps, 5000);
|
||||||
|
|
||||||
for (const event of [
|
for (const event of [
|
||||||
"createActor", "updateActor", "deleteActor",
|
"createActor", "updateActor", "deleteActor",
|
||||||
@@ -1461,6 +1728,13 @@ Hooks.once("ready", () => {
|
|||||||
queueFoundryItemChange(isDelete ? "delete" : "upsert", document);
|
queueFoundryItemChange(isDelete ? "delete" : "upsert", document);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A GM's wall edit sends the scene's whole set to the campaign map mirroring it,
|
||||||
|
// debounced like the item changes: dragging a wall fires an update per move.
|
||||||
|
// Scenes no campaign map mirrors answer `notfound`, and the queue lets those go.
|
||||||
|
for (const event of ["createWall", "updateWall", "deleteWall"]) {
|
||||||
|
Hooks.on(event, (...args) => queueFoundrySceneWalls(...args));
|
||||||
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
// 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
|
||||||
|
|||||||
@@ -418,3 +418,88 @@ 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);
|
||||||
|
}
|
||||||
@@ -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>
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ import { ClearWindow, CreateWindow, GetFirstWindowId } from '@/services/Windows'
|
|||||||
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
|
import { HideContextMenu, ShowContextMenu } from '~/services/ContextMenu';
|
||||||
import { BuildNoteOptions, OptionLabel, ToImagePoint, ToScreenPoint } from '~/services/MapPins';
|
import { BuildNoteOptions, OptionLabel, ToImagePoint, ToScreenPoint } from '~/services/MapPins';
|
||||||
import { ActorDragId, CellCentre, IsActorDrag, MoveByCells, TokenSize } from '~/services/MapTokens';
|
import { ActorDragId, CellCentre, IsActorDrag, MoveByCells, TokenSize } from '~/services/MapTokens';
|
||||||
|
import { IsWall, MoveWall, SnapToGrid, ToDrawPoint, ToScreenWall } from '~/services/MapWalls';
|
||||||
import { DisplayToast } from '~/services/Toaster';
|
import { DisplayToast } from '~/services/Toaster';
|
||||||
import Server, { getBaseUrl } from '~/services/Server';
|
import Server, { getBaseUrl } from '~/services/Server';
|
||||||
import { emitter } from '~/services/Emitter';
|
import { emitter } from '~/services/Emitter';
|
||||||
@@ -114,6 +115,18 @@ let lastPointer = { x: 0, y: 0 };
|
|||||||
|
|
||||||
function onPointerDown(event) {
|
function onPointerDown(event) {
|
||||||
if (event.button !== 0 || !viewport.value) return;
|
if (event.button !== 0 || !viewport.value) return;
|
||||||
|
if (editingWalls.value && imageUrl.value) {
|
||||||
|
// While the wall editor is open the left pointer draws instead of panning: the wheel and
|
||||||
|
// the zoom buttons still move the view about.
|
||||||
|
const spot = wallSpot(event);
|
||||||
|
const first = spot && SnapToGrid(spot, grid.value);
|
||||||
|
if (!first) return;
|
||||||
|
pointerId = event.pointerId;
|
||||||
|
viewport.value.setPointerCapture?.(event.pointerId);
|
||||||
|
drawingWall.value = { x1: first.x, y1: first.y, x2: first.x, y2: first.y };
|
||||||
|
selectedWall.value = null;
|
||||||
|
return;
|
||||||
|
}
|
||||||
dragging.value = true;
|
dragging.value = true;
|
||||||
pointerId = event.pointerId;
|
pointerId = event.pointerId;
|
||||||
lastPointer = { x: event.clientX, y: event.clientY };
|
lastPointer = { x: event.clientX, y: event.clientY };
|
||||||
@@ -121,13 +134,28 @@ function onPointerDown(event) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
function onPointerMove(event) {
|
function onPointerMove(event) {
|
||||||
|
if (drawingWall.value && event.pointerId === pointerId) {
|
||||||
|
const spot = wallSpot(event);
|
||||||
|
const snapped = spot && SnapToGrid(spot, grid.value);
|
||||||
|
if (snapped) drawingWall.value = { ...drawingWall.value, x2: snapped.x, y2: snapped.y };
|
||||||
|
return;
|
||||||
|
}
|
||||||
if (!dragging.value || event.pointerId !== pointerId) return;
|
if (!dragging.value || event.pointerId !== pointerId) return;
|
||||||
pan.value = { x: pan.value.x + (event.clientX - lastPointer.x), y: pan.value.y + (event.clientY - lastPointer.y) };
|
pan.value = { x: pan.value.x + (event.clientX - lastPointer.x), y: pan.value.y + (event.clientY - lastPointer.y) };
|
||||||
lastPointer = { x: event.clientX, y: event.clientY };
|
lastPointer = { x: event.clientX, y: event.clientY };
|
||||||
}
|
}
|
||||||
|
|
||||||
function onPointerUp(event) {
|
async function onPointerUp(event) {
|
||||||
if (event.pointerId !== pointerId) return;
|
if (event.pointerId !== pointerId) return;
|
||||||
|
if (drawingWall.value) {
|
||||||
|
const segment = drawingWall.value;
|
||||||
|
pointerId = null;
|
||||||
|
drawingWall.value = null;
|
||||||
|
viewport.value?.releasePointerCapture?.(event.pointerId);
|
||||||
|
// A drag that ended where it started drew no wall; anything with length becomes one.
|
||||||
|
if (IsWall(segment)) await saveWalls([...walls.value, segment]);
|
||||||
|
return;
|
||||||
|
}
|
||||||
dragging.value = false;
|
dragging.value = false;
|
||||||
pointerId = null;
|
pointerId = null;
|
||||||
viewport.value?.releasePointerCapture?.(event.pointerId);
|
viewport.value?.releasePointerCapture?.(event.pointerId);
|
||||||
@@ -503,6 +531,215 @@ function handleActorEntry({ entityType, entry }) {
|
|||||||
actors.value = [entry, ...actors.value.filter((current) => String(current._id) !== String(entry._id))];
|
actors.value = [entry, ...actors.value.filter((current) => String(current._id) !== String(entry._id))];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// --- Walls blocking the map ---
|
||||||
|
// The wall editor: with walls on, dragging over the map draws a segment from one grid intersection
|
||||||
|
// to the next, dragging an endpoint retypes it, dragging the segment itself moves it, and right
|
||||||
|
// clicking one (or Delete on a focused one) opens its controls and takes it off. Walls are stored
|
||||||
|
// in image pixels like the pins, and every edit saves the whole set — the same set a paired
|
||||||
|
// Foundry scene takes over, so the two see the same walls.
|
||||||
|
|
||||||
|
const walls = computed(() => map.value?.walls ?? []);
|
||||||
|
const editingWalls = ref(false);
|
||||||
|
// The wall a pointer is holding: a new segment being dragged, the whole segment being slid, or one
|
||||||
|
// endpoint being retyped. Like a token's move, the change stays local until the pointer lets go,
|
||||||
|
// so a drag across the map is one save and not one per mouse move.
|
||||||
|
const drawingWall = ref(null);
|
||||||
|
const draggingWall = ref(null);
|
||||||
|
const draggingEnd = ref(null);
|
||||||
|
// The wall whose controls are asked for: selected before its menu opens, kept while it is dragged.
|
||||||
|
const selectedWall = ref(null);
|
||||||
|
|
||||||
|
const END_KEYS = [['x1', 'y1'], ['x2', 'y2']];
|
||||||
|
let wallDragPointerId = null;
|
||||||
|
let lastWallDrag = { x: 0, y: 0 };
|
||||||
|
|
||||||
|
function toggleWallEditing() {
|
||||||
|
editingWalls.value = !editingWalls.value;
|
||||||
|
if (!editingWalls.value) {
|
||||||
|
drawingWall.value = null;
|
||||||
|
draggingWall.value = null;
|
||||||
|
draggingEnd.value = null;
|
||||||
|
selectedWall.value = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// The spot of the viewport in image pixels, clamped to the image: while a wall is being held the
|
||||||
|
// pointer may cross an edge, and the wall should stay on the map rather than vanish.
|
||||||
|
function wallSpot(event) {
|
||||||
|
const bounds = viewport.value?.getBoundingClientRect();
|
||||||
|
if (!bounds) return null;
|
||||||
|
return ToDrawPoint({ x: event.clientX - bounds.left, y: event.clientY - bounds.top }, viewState());
|
||||||
|
}
|
||||||
|
|
||||||
|
// The wall as it should be drawn right now: with the drag's preview on top of what is stored.
|
||||||
|
function wallGeometry(wall) {
|
||||||
|
if (draggingWall.value && String(draggingWall.value.wall?._id) === String(wall?._id)) {
|
||||||
|
const moved = MoveWall(wall, draggingWall.value.dx, draggingWall.value.dy);
|
||||||
|
if (moved) return { ...wall, ...moved };
|
||||||
|
}
|
||||||
|
if (draggingEnd.value && String(draggingEnd.value.wall?._id) === String(wall?._id) && draggingEnd.value.point) {
|
||||||
|
const [keyX, keyY] = END_KEYS[draggingEnd.value.end];
|
||||||
|
return { ...wall, [keyX]: draggingEnd.value.point.x, [keyY]: draggingEnd.value.point.y };
|
||||||
|
}
|
||||||
|
return wall;
|
||||||
|
}
|
||||||
|
|
||||||
|
function wallScreen(wall) {
|
||||||
|
return ToScreenWall(wallGeometry(wall), viewState());
|
||||||
|
}
|
||||||
|
|
||||||
|
function wallClasses(wall) {
|
||||||
|
return {
|
||||||
|
'wall-door': Number(wall?.door) > 0,
|
||||||
|
'wall-move-only': !wall?.sight && Number(wall?.door) === 0,
|
||||||
|
selected: Boolean(selectedWall.value) && String(selectedWall.value) === String(wall?._id)
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// The wire shape of a wall: what the server keeps, with the `_id` of the ones it already has so a
|
||||||
|
// save neither doubles them nor re-ids them under the viewer's feet.
|
||||||
|
function plainWall(wall) {
|
||||||
|
const stored = {
|
||||||
|
x1: Number(wall.x1), y1: Number(wall.y1), x2: Number(wall.x2), y2: Number(wall.y2),
|
||||||
|
move: wall.move !== false, sight: wall.sight !== false, door: Number(wall.door) || 0
|
||||||
|
};
|
||||||
|
return wall._id ? { _id: String(wall._id), ...stored } : stored;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function saveWalls(next) {
|
||||||
|
return updateMap('/map/walls', { id: map.value?._id, walls: next.map(plainWall) }, t('campaigns.map.walls.error'));
|
||||||
|
}
|
||||||
|
|
||||||
|
async function replaceWall(wall, patch) {
|
||||||
|
const next = walls.value.map((current) => (
|
||||||
|
String(current?._id) === String(wall?._id) ? { ...current, ...patch } : current
|
||||||
|
));
|
||||||
|
await saveWalls(next);
|
||||||
|
}
|
||||||
|
|
||||||
|
async function removeWall(wall) {
|
||||||
|
if (String(selectedWall.value) === String(wall?._id)) selectedWall.value = null;
|
||||||
|
await saveWalls(walls.value.filter((current) => String(current?._id) !== String(wall?._id)));
|
||||||
|
}
|
||||||
|
|
||||||
|
function onWallPointerDown(event, wall) {
|
||||||
|
// The segment is what is being held here: the map must not start panning under the pointer.
|
||||||
|
event.stopPropagation();
|
||||||
|
if (event.button !== 0) return;
|
||||||
|
|
||||||
|
wallDragPointerId = event.pointerId;
|
||||||
|
event.currentTarget.setPointerCapture?.(event.pointerId);
|
||||||
|
lastWallDrag = { x: event.clientX, y: event.clientY };
|
||||||
|
selectedWall.value = String(wall?._id ?? '');
|
||||||
|
draggingWall.value = { wall, dx: 0, dy: 0 };
|
||||||
|
}
|
||||||
|
|
||||||
|
function onWallPointerMove(event) {
|
||||||
|
if (!draggingWall.value || event.pointerId !== wallDragPointerId) return;
|
||||||
|
const zoomScale = zoom.value || 1;
|
||||||
|
draggingWall.value = {
|
||||||
|
...draggingWall.value,
|
||||||
|
// The drag is measured in screen pixels and applied in image ones, and the whole segment
|
||||||
|
// goes by the same delta: a moved wall keeps its shape and the grid it was drawn on.
|
||||||
|
dx: draggingWall.value.dx + (event.clientX - lastWallDrag.x) / zoomScale,
|
||||||
|
dy: draggingWall.value.dy + (event.clientY - lastWallDrag.y) / zoomScale
|
||||||
|
};
|
||||||
|
lastWallDrag = { x: event.clientX, y: event.clientY };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function onWallPointerUp(event) {
|
||||||
|
if (!draggingWall.value || event.pointerId !== wallDragPointerId) return;
|
||||||
|
|
||||||
|
const { wall, dx, dy } = draggingWall.value;
|
||||||
|
wallDragPointerId = null;
|
||||||
|
draggingWall.value = null;
|
||||||
|
event.currentTarget?.releasePointerCapture?.(event.pointerId);
|
||||||
|
|
||||||
|
const moved = MoveWall(wall, dx, dy);
|
||||||
|
if (!moved || (moved.x1 === Number(wall.x1) && moved.y1 === Number(wall.y1)
|
||||||
|
&& moved.x2 === Number(wall.x2) && moved.y2 === Number(wall.y2))) return;
|
||||||
|
await replaceWall(wall, moved);
|
||||||
|
}
|
||||||
|
|
||||||
|
function onWallEndPointerDown(event, wall, end) {
|
||||||
|
event.stopPropagation();
|
||||||
|
if (event.button !== 0) return;
|
||||||
|
|
||||||
|
wallDragPointerId = event.pointerId;
|
||||||
|
event.currentTarget.setPointerCapture?.(event.pointerId);
|
||||||
|
selectedWall.value = String(wall?._id ?? '');
|
||||||
|
draggingEnd.value = { wall, end, point: { x: Number(wall[END_KEYS[end][0]]), y: Number(wall[END_KEYS[end][1]]) } };
|
||||||
|
}
|
||||||
|
|
||||||
|
function onWallEndPointerMove(event) {
|
||||||
|
if (!draggingEnd.value || event.pointerId !== wallDragPointerId) return;
|
||||||
|
const spot = wallSpot(event);
|
||||||
|
const snapped = spot && SnapToGrid(spot, grid.value);
|
||||||
|
if (!snapped) return;
|
||||||
|
draggingEnd.value = { ...draggingEnd.value, point: snapped };
|
||||||
|
}
|
||||||
|
|
||||||
|
async function onWallEndPointerUp(event) {
|
||||||
|
if (!draggingEnd.value || event.pointerId !== wallDragPointerId) return;
|
||||||
|
|
||||||
|
const { wall, end, point } = draggingEnd.value;
|
||||||
|
wallDragPointerId = null;
|
||||||
|
draggingEnd.value = null;
|
||||||
|
event.currentTarget?.releasePointerCapture?.(event.pointerId);
|
||||||
|
|
||||||
|
const [keyX, keyY] = END_KEYS[end];
|
||||||
|
if (point.x === Number(wall[keyX]) && point.y === Number(wall[keyY])) return;
|
||||||
|
const retyped = { ...wall, [keyX]: point.x, [keyY]: point.y };
|
||||||
|
// Retyped into its own end, the segment has no length left: the wall is gone.
|
||||||
|
if (!IsWall(retyped)) await removeWall(wall);
|
||||||
|
else await replaceWall(wall, { [keyX]: point.x, [keyY]: point.y });
|
||||||
|
}
|
||||||
|
|
||||||
|
function onWallContextMenu(wall) {
|
||||||
|
selectedWall.value = String(wall?._id ?? '');
|
||||||
|
ShowContextMenu([
|
||||||
|
{
|
||||||
|
name: t(wall.sight ? 'campaigns.map.walls.sight-open' : 'campaigns.map.walls.sight-block'),
|
||||||
|
icon: '/icons/iconoir/regular/eye.svg',
|
||||||
|
action: () => { HideContextMenu(); replaceWall(wall, { sight: !wall.sight }); }
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: t(wall.move ? 'campaigns.map.walls.move-open' : 'campaigns.map.walls.move-block'),
|
||||||
|
icon: '/icons/iconoir/regular/lock.svg',
|
||||||
|
action: () => { HideContextMenu(); replaceWall(wall, { move: !wall.move }); }
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: t('campaigns.map.walls.door'),
|
||||||
|
icon: '/icons/iconoir/regular/home-simple-door.svg',
|
||||||
|
context: [
|
||||||
|
{ name: t('campaigns.map.walls.door-none'), action: () => { HideContextMenu(); replaceWall(wall, { door: 0 }); } },
|
||||||
|
{ name: t('campaigns.map.walls.door-closed'), action: () => { HideContextMenu(); replaceWall(wall, { door: 2 }); } },
|
||||||
|
{ name: t('campaigns.map.walls.door-open'), action: () => { HideContextMenu(); replaceWall(wall, { door: 1 }); } }
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{ divider: true },
|
||||||
|
{
|
||||||
|
name: t('campaigns.map.walls.remove'),
|
||||||
|
icon: '/icons/iconoir/regular/xmark-circle.svg',
|
||||||
|
action: () => { HideContextMenu(); removeWall(wall); }
|
||||||
|
}
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
|
||||||
|
// A focused wall answers Delete too, the way a focused token does.
|
||||||
|
async function onWallKeydown(event, wall) {
|
||||||
|
if (event.key !== 'Delete' && event.key !== 'Backspace') return;
|
||||||
|
event.preventDefault();
|
||||||
|
await removeWall(wall);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Escape lets go of whatever the editor is holding: an unfinished segment first, the selection next.
|
||||||
|
function onWindowKeydown(event) {
|
||||||
|
if (event.key !== 'Escape') return;
|
||||||
|
if (drawingWall.value) drawingWall.value = null;
|
||||||
|
else if (selectedWall.value) selectedWall.value = null;
|
||||||
|
}
|
||||||
|
|
||||||
// A different map was anchored while this pane was already mounted.
|
// A different map was anchored while this pane was already mounted.
|
||||||
watch(() => props.map, (incoming, previous) => {
|
watch(() => props.map, (incoming, previous) => {
|
||||||
if (incoming === previous) return;
|
if (incoming === previous) return;
|
||||||
@@ -510,6 +747,10 @@ watch(() => props.map, (incoming, previous) => {
|
|||||||
imageSize.value = { width: 0, height: 0 };
|
imageSize.value = { width: 0, height: 0 };
|
||||||
movingToken.value = null;
|
movingToken.value = null;
|
||||||
draggingActor.value = false;
|
draggingActor.value = false;
|
||||||
|
drawingWall.value = null;
|
||||||
|
draggingWall.value = null;
|
||||||
|
draggingEnd.value = null;
|
||||||
|
selectedWall.value = null;
|
||||||
});
|
});
|
||||||
|
|
||||||
watch(campaignId, () => {
|
watch(campaignId, () => {
|
||||||
@@ -525,6 +766,7 @@ onMounted(() => {
|
|||||||
emitter.on('campaign-entry-updated', handleActorEntry);
|
emitter.on('campaign-entry-updated', handleActorEntry);
|
||||||
emitter.on('delete-note', handlePinnedNoteDeleted);
|
emitter.on('delete-note', handlePinnedNoteDeleted);
|
||||||
emitter.on('title-updated', handlePinnedNoteRenamed);
|
emitter.on('title-updated', handlePinnedNoteRenamed);
|
||||||
|
window.addEventListener('keydown', onWindowKeydown);
|
||||||
fetchPinnableNotes();
|
fetchPinnableNotes();
|
||||||
fetchTokenActors();
|
fetchTokenActors();
|
||||||
});
|
});
|
||||||
@@ -535,6 +777,7 @@ onBeforeUnmount(() => {
|
|||||||
emitter.off('campaign-entry-updated', handleActorEntry);
|
emitter.off('campaign-entry-updated', handleActorEntry);
|
||||||
emitter.off('delete-note', handlePinnedNoteDeleted);
|
emitter.off('delete-note', handlePinnedNoteDeleted);
|
||||||
emitter.off('title-updated', handlePinnedNoteRenamed);
|
emitter.off('title-updated', handlePinnedNoteRenamed);
|
||||||
|
window.removeEventListener('keydown', onWindowKeydown);
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
@@ -550,6 +793,10 @@ onBeforeUnmount(() => {
|
|||||||
:aria-label="$t('campaigns.map.toggle-grid')" :aria-pressed="showGrid.toString()" @click="showGrid = !showGrid">
|
:aria-label="$t('campaigns.map.toggle-grid')" :aria-pressed="showGrid.toString()" @click="showGrid = !showGrid">
|
||||||
<img class="tool-icon" src="/icons/iconoir/regular/view-grid.svg" alt="" aria-hidden="true">
|
<img class="tool-icon" src="/icons/iconoir/regular/view-grid.svg" alt="" aria-hidden="true">
|
||||||
</button>
|
</button>
|
||||||
|
<button class="viewer-tool" :class="{ selected: editingWalls }" type="button" :title="$t('campaigns.map.walls.edit')"
|
||||||
|
:aria-label="$t('campaigns.map.walls.edit')" :aria-pressed="editingWalls.toString()" @click="toggleWallEditing">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/border-out.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-out')" :aria-label="$t('campaigns.map.zoom-out')" @click="zoomFromToolbar(false)">
|
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-out')" :aria-label="$t('campaigns.map.zoom-out')" @click="zoomFromToolbar(false)">
|
||||||
<img class="tool-icon" src="/icons/iconoir/regular/minus.svg" alt="" aria-hidden="true">
|
<img class="tool-icon" src="/icons/iconoir/regular/minus.svg" alt="" aria-hidden="true">
|
||||||
</button>
|
</button>
|
||||||
@@ -587,6 +834,42 @@ onBeforeUnmount(() => {
|
|||||||
<template v-if="imageUrl">
|
<template v-if="imageUrl">
|
||||||
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
|
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
|
||||||
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
|
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
|
||||||
|
<!-- Walls are drawn in screen space like the pins, so their lines stay thin at any
|
||||||
|
zoom. They only catch the mouse while the editor is open, and never when there
|
||||||
|
is no image to hold them. -->
|
||||||
|
<svg v-if="imageUrl && (walls.length || drawingWall || editingWalls)" class="map-walls" :class="{ editing: editingWalls }">
|
||||||
|
<g v-for="wall in walls" :key="wall._id">
|
||||||
|
<line class="wall-line" :class="wallClasses(wall)" v-bind="wallScreen(wall)"></line>
|
||||||
|
<template v-if="editingWalls">
|
||||||
|
<line
|
||||||
|
class="wall-hit"
|
||||||
|
role="button"
|
||||||
|
tabindex="0"
|
||||||
|
:aria-label="$t('campaigns.map.walls.wall')"
|
||||||
|
v-bind="wallScreen(wall)"
|
||||||
|
@pointerdown="onWallPointerDown($event, wall)"
|
||||||
|
@pointermove="onWallPointerMove"
|
||||||
|
@pointerup="onWallPointerUp"
|
||||||
|
@pointercancel="onWallPointerUp"
|
||||||
|
@contextmenu.stop.prevent="onWallContextMenu(wall)"
|
||||||
|
@keydown="onWallKeydown($event, wall)"
|
||||||
|
></line>
|
||||||
|
<circle
|
||||||
|
v-for="end in [0, 1]"
|
||||||
|
:key="end"
|
||||||
|
class="wall-end"
|
||||||
|
:cx="end === 0 ? wallScreen(wall).x1 : wallScreen(wall).x2"
|
||||||
|
:cy="end === 0 ? wallScreen(wall).y1 : wallScreen(wall).y2"
|
||||||
|
r="5"
|
||||||
|
@pointerdown="onWallEndPointerDown($event, wall, end)"
|
||||||
|
@pointermove="onWallEndPointerMove"
|
||||||
|
@pointerup="onWallEndPointerUp"
|
||||||
|
@pointercancel="onWallEndPointerUp"
|
||||||
|
></circle>
|
||||||
|
</template>
|
||||||
|
</g>
|
||||||
|
<line v-if="drawingWall" class="wall-draft" v-bind="ToScreenWall(drawingWall, viewState())"></line>
|
||||||
|
</svg>
|
||||||
<div class="map-pins">
|
<div class="map-pins">
|
||||||
<button
|
<button
|
||||||
v-for="pin in pins"
|
v-for="pin in pins"
|
||||||
@@ -629,6 +912,7 @@ onBeforeUnmount(() => {
|
|||||||
</button>
|
</button>
|
||||||
</div>
|
</div>
|
||||||
<div v-if="draggingActor" class="map-drop-hint">{{ $t('campaigns.map.tokens.drop-hint') }}</div>
|
<div v-if="draggingActor" class="map-drop-hint">{{ $t('campaigns.map.tokens.drop-hint') }}</div>
|
||||||
|
<div v-if="editingWalls" class="map-walls-hint">{{ $t('campaigns.map.walls.hint') }}</div>
|
||||||
</template>
|
</template>
|
||||||
<div v-else class="map-empty">
|
<div v-else class="map-empty">
|
||||||
{{ $t('campaigns.map.no-image') }}
|
{{ $t('campaigns.map.no-image') }}
|
||||||
@@ -699,6 +983,27 @@ onBeforeUnmount(() => {
|
|||||||
background: var(--color-background-soft); color: var(--color-text); font-size: 12px;
|
background: var(--color-background-soft); color: var(--color-text); font-size: 12px;
|
||||||
pointer-events: none; box-shadow: 0px 0px 6px -1px rgba(0,0,0,0.55);
|
pointer-events: none; box-shadow: 0px 0px 6px -1px rgba(0,0,0,0.55);
|
||||||
}
|
}
|
||||||
|
/* Walls are drawn in screen space like the pins, so their lines stay thin at any zoom. A sight
|
||||||
|
wall is red, a wall that only stops movement grey, a door green — close to how Foundry paints
|
||||||
|
them on its own scenes. Only the editor's hit lines and handles catch the mouse. */
|
||||||
|
.map-walls { position: absolute; inset: 0; width: 100%; height: 100%; pointer-events: none; overflow: visible; }
|
||||||
|
.wall-line { stroke: var(--color-red); stroke-width: 2; opacity: .85; pointer-events: none; }
|
||||||
|
.wall-line.wall-move-only { stroke: var(--color-gray); }
|
||||||
|
.wall-line.wall-door { stroke: var(--color-green); stroke-width: 3; }
|
||||||
|
.wall-line.selected { stroke: var(--color-link); opacity: 1; }
|
||||||
|
/* The grabbable line and the endpoint handles: each wall gives its own hit area, wide enough that
|
||||||
|
the pointer finds it at any zoom. */
|
||||||
|
.wall-hit { stroke: transparent; stroke-width: 16; stroke-linecap: round; pointer-events: stroke; cursor: move; }
|
||||||
|
.wall-hit:focus-visible { stroke: var(--color-link); stroke-opacity: .35; outline: none; }
|
||||||
|
.wall-end { fill: var(--color-background-soft); stroke: var(--color-link); stroke-width: 1.5; pointer-events: auto; cursor: crosshair; }
|
||||||
|
.wall-draft { stroke: var(--color-link); stroke-width: 2; stroke-dasharray: 6 4; pointer-events: none; }
|
||||||
|
/* Shown while the wall editor is open, so the gestures it answers to are at hand. */
|
||||||
|
.map-walls-hint {
|
||||||
|
position: absolute; bottom: 10px; left: 50%; transform: translateX(-50%);
|
||||||
|
padding: 5px 10px; border: 1px dashed var(--color-link); border-radius: 7px;
|
||||||
|
background: var(--color-background-soft); color: var(--color-text); font-size: 12px;
|
||||||
|
pointer-events: none; box-shadow: 0px 0px 6px -1px rgba(0,0,0,0.55);
|
||||||
|
}
|
||||||
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
|
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
|
||||||
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
|
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
|
||||||
.map-edit:hover { background: var(--color-button-hover); }
|
.map-edit:hover { background: var(--color-button-hover); }
|
||||||
|
|||||||
@@ -108,11 +108,13 @@ useHead({
|
|||||||
color: var(--color-text);
|
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-sidebar,
|
||||||
.docs-sections {
|
.docs-sections {
|
||||||
position: sticky;
|
position: sticky;
|
||||||
top: 0;
|
top: 0;
|
||||||
max-height: 100vh;
|
height: 100vh;
|
||||||
overflow-y: auto;
|
overflow-y: auto;
|
||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
padding: 18px 14px;
|
padding: 18px 14px;
|
||||||
@@ -122,7 +124,6 @@ useHead({
|
|||||||
flex: 0 0 268px;
|
flex: 0 0 268px;
|
||||||
width: 268px;
|
width: 268px;
|
||||||
border-right: 1px solid var(--color-border);
|
border-right: 1px solid var(--color-border);
|
||||||
background-color: var(--color-background-light);
|
|
||||||
display: flex;
|
display: flex;
|
||||||
flex-direction: column;
|
flex-direction: column;
|
||||||
gap: 14px;
|
gap: 14px;
|
||||||
@@ -208,8 +209,13 @@ useHead({
|
|||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
}
|
}
|
||||||
|
|
||||||
.docs-article {
|
/* 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;
|
max-width: 760px;
|
||||||
|
margin-inline: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
.docs-kicker {
|
.docs-kicker {
|
||||||
@@ -221,7 +227,6 @@ useHead({
|
|||||||
}
|
}
|
||||||
|
|
||||||
.docs-pager {
|
.docs-pager {
|
||||||
max-width: 760px;
|
|
||||||
margin-top: 34px;
|
margin-top: 34px;
|
||||||
padding-top: 18px;
|
padding-top: 18px;
|
||||||
border-top: 1px solid var(--color-border);
|
border-top: 1px solid var(--color-border);
|
||||||
@@ -256,8 +261,10 @@ useHead({
|
|||||||
}
|
}
|
||||||
|
|
||||||
.docs-sections {
|
.docs-sections {
|
||||||
flex: 0 0 220px;
|
flex: 0 0 240px;
|
||||||
width: 220px;
|
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);
|
border-left: 1px solid var(--color-border);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -294,87 +301,19 @@ useHead({
|
|||||||
color: var(--color-link);
|
color: var(--color-link);
|
||||||
}
|
}
|
||||||
|
|
||||||
/* El markdown renderitzat: tot dins de .docs-markdown, perquè ve de v-html. */
|
/* El markdown renderitzat ve estilat a assets/css/main.scss, sota .docs-markdown, perquè la
|
||||||
.docs-markdown :deep(h1) {
|
finestra de documentació (windows/DocumentationWindow.vue) se'l serveix igualment. */
|
||||||
margin: 0 0 14px 0;
|
|
||||||
font-family: 'MrEavesRemake', serif;
|
/* Finestra molt ampla: tot el conjunt va al mig, així els apartats queden a prop del
|
||||||
font-size: 2rem;
|
text en lloc d'estirats cap al cantó dret de la pantalla. */
|
||||||
font-weight: normal;
|
@media (min-width: 1440px) {
|
||||||
line-height: 1.2;
|
.docs {
|
||||||
|
justify-content: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.docs-markdown :deep(h2) {
|
.docs-main {
|
||||||
margin: 30px 0 10px 0;
|
flex: 0 1 860px;
|
||||||
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 :deep(h3) {
|
|
||||||
margin: 22px 0 8px 0;
|
|
||||||
font-family: 'MrEavesRemake', serif;
|
|
||||||
font-size: 1.1rem;
|
|
||||||
font-weight: normal;
|
|
||||||
scroll-margin-top: 20px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.docs-markdown :deep(p),
|
|
||||||
.docs-markdown :deep(li) {
|
|
||||||
line-height: 1.65;
|
|
||||||
}
|
|
||||||
|
|
||||||
.docs-markdown :deep(ul),
|
|
||||||
.docs-markdown :deep(ol) {
|
|
||||||
margin: 10px 0;
|
|
||||||
padding-left: 1.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.docs-markdown :deep(a) {
|
|
||||||
color: var(--color-link);
|
|
||||||
}
|
|
||||||
|
|
||||||
.docs-markdown :deep(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 :deep(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 :deep(pre code) {
|
|
||||||
padding: 0;
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
.docs-markdown :deep(table) {
|
|
||||||
margin: 14px 0;
|
|
||||||
border-collapse: collapse;
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.docs-markdown :deep(th),
|
|
||||||
.docs-markdown :deep(td) {
|
|
||||||
padding: 7px 10px;
|
|
||||||
border: 1px solid var(--color-border);
|
|
||||||
text-align: left;
|
|
||||||
vertical-align: top;
|
|
||||||
line-height: 1.5;
|
|
||||||
}
|
|
||||||
|
|
||||||
.docs-markdown :deep(th) {
|
|
||||||
background-color: var(--color-background-light);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@media (max-width: 1200px) {
|
@media (max-width: 1200px) {
|
||||||
@@ -391,7 +330,7 @@ useHead({
|
|||||||
.docs-sidebar,
|
.docs-sidebar,
|
||||||
.docs-sections {
|
.docs-sections {
|
||||||
position: static;
|
position: static;
|
||||||
max-height: none;
|
height: auto;
|
||||||
width: 100%;
|
width: 100%;
|
||||||
border-left: none;
|
border-left: none;
|
||||||
border-right: none;
|
border-right: none;
|
||||||
|
|||||||
@@ -319,7 +319,10 @@ async function saveSheet() {
|
|||||||
|
|
||||||
<div v-if="error" class="sheet-error">{{ error }}</div>
|
<div v-if="error" class="sheet-error">{{ error }}</div>
|
||||||
|
|
||||||
<main v-show="activeTab === 'abilities'" class="sheet-grid">
|
<!-- 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="character-column">
|
<div class="character-column">
|
||||||
<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')">
|
||||||
@@ -387,6 +390,7 @@ async function saveSheet() {
|
|||||||
</section>
|
</section>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<main v-show="activeTab === 'abilities'" class="sheet-tab-body">
|
||||||
<section class="sheet-panel abilities-panel">
|
<section class="sheet-panel abilities-panel">
|
||||||
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
|
<h2>{{ $t('campaigns.character-sheet.ability-scores') }}</h2>
|
||||||
<div class="ability-grid">
|
<div class="ability-grid">
|
||||||
@@ -529,6 +533,7 @@ async function saveSheet() {
|
|||||||
</main>
|
</main>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<style scoped>
|
<style scoped>
|
||||||
@@ -550,8 +555,10 @@ 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 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-tab-body { display: block; }
|
de la pestanya oberta. */
|
||||||
|
.sheet-layout { display: grid; grid-template-columns: minmax(200px, 34%) minmax(0, 1fr); gap: 11px; align-items: start; }
|
||||||
|
.sheet-tab-body { grid-column: 2; grid-row: 1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
||||||
/* Pestilletes del marc: arrencen del cantó dret de la finestra, per fora del cos, i queden
|
/* 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). */
|
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-tabs { position: absolute; left: 100%; top: 34px; display: flex; flex-direction: column; align-items: flex-start; gap: 5px; padding-top: 6px; }
|
||||||
@@ -585,11 +592,9 @@ async function saveSheet() {
|
|||||||
.portrait-controls button:disabled { opacity: .55; cursor: wait; }
|
.portrait-controls button:disabled { opacity: .55; cursor: wait; }
|
||||||
.photo-input { display: none; }
|
.photo-input { display: none; }
|
||||||
/* La columna de la fitxa: la imatge dalt i, just a sota, el que es consulta d'anada i
|
/* La columna de la fitxa: la imatge dalt i, just a sota, el que es consulta d'anada i
|
||||||
tornada — classe d'armadura, velocitat, bonificadors i les barres de cops. */
|
tornada — classe d'armadura, velocitat, bonificadors i les barres de cops. No penja de
|
||||||
.character-column { grid-column: 1; grid-row: 1 / -1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
cap pestanya: es queda al seu lloc mentre se'n canvia. */
|
||||||
.abilities-panel { grid-column: 2 / -1; grid-row: 1; }
|
.character-column { grid-column: 1; grid-row: 1; display: flex; flex-direction: column; gap: 11px; min-width: 0; }
|
||||||
.skills-panel { grid-column: 2 / -1; grid-row: 2; }
|
|
||||||
.proficiencies-panel { grid-column: 2 / -1; grid-row: 3; }
|
|
||||||
.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; }
|
||||||
@@ -663,8 +668,8 @@ textarea { resize: vertical; width: 100%; min-height: 88px; 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; }
|
.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; }
|
||||||
.character-column, .abilities-panel, .skills-panel, .proficiencies-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
|
/* 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. */
|
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-tabs { position: static; align-self: stretch; flex-direction: row; flex-wrap: wrap; gap: 4px; padding: 6px 8px 0; }
|
||||||
|
|||||||
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>
|
||||||
87
frontend/app/services/MapWalls.js
Normal file
87
frontend/app/services/MapWalls.js
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
// The rules behind the wall segments of a map (the wall editor: drag to draw a segment from grid
|
||||||
|
// intersection to grid intersection, drag an endpoint to retype it, drag the segment itself to move
|
||||||
|
// it). Like pins and tokens, walls are stored in image pixels — the very space Foundry draws a
|
||||||
|
// scene's walls in — so these helpers only translate and snap: they hold no state and talk to no
|
||||||
|
// API, and the editor saves the whole set the way the viewer ends up with it.
|
||||||
|
|
||||||
|
// Screen pixels (relative to the top left corner of the map viewport) → image pixels, clamped to
|
||||||
|
// the image but never refused: while a wall is being drawn the pointer does leave the image, and
|
||||||
|
// the endpoint then sticks to its edge instead of vanishing.
|
||||||
|
function ToDrawPoint(point, view) {
|
||||||
|
const zoom = Number(view?.zoom);
|
||||||
|
if (!Number.isFinite(zoom) || zoom <= 0) return null;
|
||||||
|
|
||||||
|
const x = (Number(point?.x) - Number(view?.pan?.x ?? 0)) / zoom;
|
||||||
|
const y = (Number(point?.y) - Number(view?.pan?.y ?? 0)) / zoom;
|
||||||
|
if (!Number.isFinite(x) || !Number.isFinite(y)) return null;
|
||||||
|
return { x: Math.max(0, x), y: Math.max(0, y) };
|
||||||
|
}
|
||||||
|
|
||||||
|
// The nearest intersection of the grid, in image pixels: a drawn wall's endpoints snap to these,
|
||||||
|
// so walls line up with the cells whatever offset the map has — the way Foundry snaps its walls
|
||||||
|
// to the grid too.
|
||||||
|
function SnapToGrid(point, grid) {
|
||||||
|
const size = Math.max(1, Number(grid?.gridSize) || 50);
|
||||||
|
const offsetX = Number(grid?.offsetX) || 0;
|
||||||
|
const offsetY = Number(grid?.offsetY) || 0;
|
||||||
|
|
||||||
|
const x = Number(point?.x);
|
||||||
|
const y = Number(point?.y);
|
||||||
|
if (!Number.isFinite(x) || !Number.isFinite(y)) return null;
|
||||||
|
|
||||||
|
return {
|
||||||
|
x: Math.max(0, Math.round(offsetX + Math.round((x - offsetX) / size) * size)),
|
||||||
|
y: Math.max(0, Math.round(offsetY + Math.round((y - offsetY) / size) * size))
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// A wall (image pixels) → screen pixels of the map viewport. Walls are drawn in screen space like
|
||||||
|
// the pins, so their lines stay one pixel wide whatever the zoom is.
|
||||||
|
function ToScreenPoint(x, y, view) {
|
||||||
|
const zoom = Number(view?.zoom) || 0;
|
||||||
|
return {
|
||||||
|
x: Number(view?.pan?.x ?? 0) + Number(x ?? 0) * zoom,
|
||||||
|
y: Number(view?.pan?.y ?? 0) + Number(y ?? 0) * zoom
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function ToScreenWall(wall, view) {
|
||||||
|
const from = ToScreenPoint(wall?.x1, wall?.y1, view);
|
||||||
|
const to = ToScreenPoint(wall?.x2, wall?.y2, view);
|
||||||
|
return { x1: from.x, y1: from.y, x2: to.x, y2: to.y };
|
||||||
|
}
|
||||||
|
|
||||||
|
// A whole wall slid over the map: both endpoints by the same delta, so a moved wall keeps its
|
||||||
|
// shape and its alignment to the grid it was drawn on. Never off the top left corner.
|
||||||
|
function MoveWall(wall, dx, dy) {
|
||||||
|
const x1 = Number(wall?.x1);
|
||||||
|
const y1 = Number(wall?.y1);
|
||||||
|
const x2 = Number(wall?.x2);
|
||||||
|
const y2 = Number(wall?.y2);
|
||||||
|
const stepX = Number(dx);
|
||||||
|
const stepY = Number(dy);
|
||||||
|
if (![x1, y1, x2, y2, stepX, stepY].every(Number.isFinite)) return null;
|
||||||
|
|
||||||
|
return {
|
||||||
|
x1: Math.max(0, Math.round(x1 + stepX)),
|
||||||
|
y1: Math.max(0, Math.round(y1 + stepY)),
|
||||||
|
x2: Math.max(0, Math.round(x2 + stepX)),
|
||||||
|
y2: Math.max(0, Math.round(y2 + stepY))
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Two endpoints of a segment, snapped or not, long enough to be a wall: a drag that ends where it
|
||||||
|
// started drew nothing.
|
||||||
|
function IsWall(wall) {
|
||||||
|
return Boolean(wall) && Number.isFinite(wall.x1) && Number.isFinite(wall.y1)
|
||||||
|
&& Number.isFinite(wall.x2) && Number.isFinite(wall.y2)
|
||||||
|
&& !(wall.x1 === wall.x2 && wall.y1 === wall.y2);
|
||||||
|
}
|
||||||
|
|
||||||
|
export {
|
||||||
|
IsWall,
|
||||||
|
MoveWall,
|
||||||
|
SnapToGrid,
|
||||||
|
ToDrawPoint,
|
||||||
|
ToScreenWall
|
||||||
|
};
|
||||||
@@ -120,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
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -111,6 +111,16 @@
|
|||||||
"drop-hint": "Deixa anar per posar l'actor en aquest mapa",
|
"drop-hint": "Deixa anar per posar l'actor en aquest mapa",
|
||||||
"open": "Obre la fitxa de personatge", "remove": "Treu la fitxa",
|
"open": "Obre la fitxa de personatge", "remove": "Treu la fitxa",
|
||||||
"error": "No s'han pogut canviar les fitxes d'aquest mapa."
|
"error": "No s'han pogut canviar les fitxes d'aquest mapa."
|
||||||
|
},
|
||||||
|
"walls": {
|
||||||
|
"edit": "Edita murs",
|
||||||
|
"hint": "Arrossega sobre el mapa per dibuixar un mur · arrossega'n els extrems per canviar-lo, el cos per moure'l",
|
||||||
|
"wall": "Mur",
|
||||||
|
"sight-block": "Bloqueja la vista", "sight-open": "Permet la vista",
|
||||||
|
"move-block": "Bloqueja el moviment", "move-open": "Permet el moviment",
|
||||||
|
"door": "Porta", "door-none": "No és porta", "door-closed": "Porta tancada", "door-open": "Porta oberta",
|
||||||
|
"remove": "Treu el mur",
|
||||||
|
"error": "No s'han pogut guardar els murs d'aquest mapa."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"character-sheet": {
|
"character-sheet": {
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
"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.",
|
||||||
|
"scene-already-synced": "Un altre mapa d'aquesta campanya ja està sincronitzat amb aquella escena 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-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.",
|
"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-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.",
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
"create-map": "Crear mapa",
|
"create-map": "Crear mapa",
|
||||||
"map-viewer": "Mapa",
|
"map-viewer": "Mapa",
|
||||||
"pinned-note": "Nota fixada",
|
"pinned-note": "Nota fixada",
|
||||||
|
"documentation": "Documentació",
|
||||||
"item-sheet": "Objecte",
|
"item-sheet": "Objecte",
|
||||||
"icon-source": "Tria una icona",
|
"icon-source": "Tria una icona",
|
||||||
"foundry-icons": "Icones del Foundry"
|
"foundry-icons": "Icones del Foundry"
|
||||||
|
|||||||
@@ -115,6 +115,16 @@
|
|||||||
"drop-hint": "Drop to place the actor on this map",
|
"drop-hint": "Drop to place the actor on this map",
|
||||||
"open": "Open character sheet", "remove": "Remove token",
|
"open": "Open character sheet", "remove": "Remove token",
|
||||||
"error": "Unable to change the tokens of this map."
|
"error": "Unable to change the tokens of this map."
|
||||||
|
},
|
||||||
|
"walls": {
|
||||||
|
"edit": "Edit walls",
|
||||||
|
"hint": "Drag on the map to draw a wall · drag its ends to retype it, its body to move it",
|
||||||
|
"wall": "Wall",
|
||||||
|
"sight-block": "Block sight", "sight-open": "Let sight through",
|
||||||
|
"move-block": "Block movement", "move-open": "Let movement through",
|
||||||
|
"door": "Door", "door-none": "Not a door", "door-closed": "Closed door", "door-open": "Open door",
|
||||||
|
"remove": "Remove wall",
|
||||||
|
"error": "Unable to save the walls of this map."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"character-sheet": {
|
"character-sheet": {
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
"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.",
|
||||||
|
"scene-already-synced": "Another map in this campaign is already synced with that Foundry scene.",
|
||||||
"icons-unavailable": "Foundry's icons are not available: its bridge is not set up, or it cannot be reached right now.",
|
"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.",
|
"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-not-linked": "This campaign has no Foundry world linked to it. Connect one under campaign settings, in the Integrations tab.",
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
"create-map": "Create Map",
|
"create-map": "Create Map",
|
||||||
"map-viewer": "Map",
|
"map-viewer": "Map",
|
||||||
"pinned-note": "Pinned note",
|
"pinned-note": "Pinned note",
|
||||||
|
"documentation": "Documentation",
|
||||||
"item-sheet": "Item",
|
"item-sheet": "Item",
|
||||||
"icon-source": "Choose an icon",
|
"icon-source": "Choose an icon",
|
||||||
"foundry-icons": "Foundry icons"
|
"foundry-icons": "Foundry icons"
|
||||||
|
|||||||
@@ -111,6 +111,16 @@
|
|||||||
"drop-hint": "Suelta para colocar al actor en este mapa",
|
"drop-hint": "Suelta para colocar al actor en este mapa",
|
||||||
"open": "Abrir hoja de personaje", "remove": "Quitar la ficha",
|
"open": "Abrir hoja de personaje", "remove": "Quitar la ficha",
|
||||||
"error": "No se pudieron cambiar las fichas de este mapa."
|
"error": "No se pudieron cambiar las fichas de este mapa."
|
||||||
|
},
|
||||||
|
"walls": {
|
||||||
|
"edit": "Editar muros",
|
||||||
|
"hint": "Arrastra sobre el mapa para dibujar un muro · arrastra sus extremos para cambiarlo, su cuerpo para moverlo",
|
||||||
|
"wall": "Muro",
|
||||||
|
"sight-block": "Bloquear la visión", "sight-open": "Permitir la visión",
|
||||||
|
"move-block": "Bloquear el movimiento", "move-open": "Permitir el movimiento",
|
||||||
|
"door": "Puerta", "door-none": "No es puerta", "door-closed": "Puerta cerrada", "door-open": "Puerta abierta",
|
||||||
|
"remove": "Quitar muro",
|
||||||
|
"error": "No se pudieron guardar los muros de este mapa."
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"character-sheet": {
|
"character-sheet": {
|
||||||
|
|||||||
@@ -4,6 +4,7 @@
|
|||||||
"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.",
|
||||||
|
"scene-already-synced": "Otro mapa de esta campaña ya está sincronizado con esa escena de Foundry.",
|
||||||
"icons-unavailable": "Los iconos de Foundry no están disponibles: su bridge no está configurado o no es accesible ahora.",
|
"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.",
|
"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-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.",
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
"create-map": "Crear mapa",
|
"create-map": "Crear mapa",
|
||||||
"map-viewer": "Mapa",
|
"map-viewer": "Mapa",
|
||||||
"pinned-note": "Nota fijada",
|
"pinned-note": "Nota fijada",
|
||||||
|
"documentation": "Documentación",
|
||||||
"item-sheet": "Objeto",
|
"item-sheet": "Objeto",
|
||||||
"icon-source": "Elegir icono",
|
"icon-source": "Elegir icono",
|
||||||
"foundry-icons": "Iconos de Foundry"
|
"foundry-icons": "Iconos de Foundry"
|
||||||
|
|||||||
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`);
|
||||||
|
}
|
||||||
|
});
|
||||||
@@ -43,7 +43,7 @@ const normalizeActor = fromSource(script, /function normalizeActor\(actor\) \{[\
|
|||||||
const barPercent = fromSource(script, /function barPercent\(current, max\) \{[\s\S]*?\n\}/);
|
const barPercent = fromSource(script, /function barPercent\(current, max\) \{[\s\S]*?\n\}/);
|
||||||
const barPool = fromSource(actorRouteSource, /function barPool\(existing, value\) \{[\s\S]*?\n\}/);
|
const barPool = fromSource(actorRouteSource, /function barPool\(existing, value\) \{[\s\S]*?\n\}/);
|
||||||
|
|
||||||
// The column that opens the abilities tab: the portrait with everything under it.
|
// The column that stands beside every tab: the portrait with everything under it.
|
||||||
function portraitColumn() {
|
function portraitColumn() {
|
||||||
const start = template.indexOf('<div class="character-column">');
|
const start = template.indexOf('<div class="character-column">');
|
||||||
const end = template.indexOf('<section class="sheet-panel abilities-panel">');
|
const end = template.indexOf('<section class="sheet-panel abilities-panel">');
|
||||||
|
|||||||
@@ -53,7 +53,6 @@ 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 proficiencies-panel"/, "the proficiencies ride 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"]) {
|
||||||
@@ -63,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
|
||||||
|
|||||||
522
tests/character-sheet-traits-items.test.js
Normal file
522
tests/character-sheet-traits-items.test.js
Normal file
@@ -0,0 +1,522 @@
|
|||||||
|
// 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)),
|
||||||
|
};
|
||||||
|
|
||||||
|
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 (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");
|
||||||
|
});
|
||||||
@@ -3,8 +3,10 @@
|
|||||||
// numbered group, translations for the group's label, and no link pointing at a page that does not
|
// 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
|
// 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
|
// checked against the sources that define it: the slash commands of discord-bot/src/commands.js and
|
||||||
// the commands the Obsidian plugin registers, and (3) the routes: /docs and /docs/<slug> render the
|
// 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.
|
// 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
|
// `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
|
// is loaded straight from source, the way the other tests load the frontend services; it imports
|
||||||
@@ -326,3 +328,237 @@ test("the main menu points at the documentation", () => {
|
|||||||
assert.ok(strings.documentation, `${locale} has no label for the documentation link`);
|
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");
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|||||||
@@ -280,6 +280,7 @@ function loadFoundryWriters({ seed = {} } = {}) {
|
|||||||
if (id === "../models/Campaign") return { findOne: async () => campaign };
|
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/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/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 (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`);
|
||||||
};
|
};
|
||||||
|
|||||||
@@ -141,6 +141,7 @@ 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 (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`);
|
||||||
};
|
};
|
||||||
|
|||||||
699
tests/map-walls.test.js
Normal file
699
tests/map-walls.test.js
Normal file
@@ -0,0 +1,699 @@
|
|||||||
|
// Tests for the walls of maps (Syndria98/dragonroll#100): a wall editor on the map viewer, the
|
||||||
|
// walls kept on the map document, and the sync that lets a paired Foundry scene and a campaign
|
||||||
|
// map trade the same segments.
|
||||||
|
//
|
||||||
|
// Like map-pins.test.js, the express routers run against a stubbed `require` inside `node:vm`,
|
||||||
|
// the `MapWalls.js` service is loaded the way the map tests load the other services, and the
|
||||||
|
// Foundry module is loaded into a stubbed Foundry world whose embedded-document writes are
|
||||||
|
// observable. The last checks read the template of the map viewer, because there the wiring
|
||||||
|
// itself 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");
|
||||||
|
|
||||||
|
const MODULE_ID = "dragonroll-foundry";
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Loads an express router file with every module it requires stubbed out: `stubs` maps a require
|
||||||
|
// path to the module the route should see.
|
||||||
|
function loadRouter(relativeParts, stubs) {
|
||||||
|
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 in stubs)) throw new Error(`require("${id}") is not stubbed`);
|
||||||
|
return stubs[id];
|
||||||
|
};
|
||||||
|
|
||||||
|
const moduleStub = { exports: {} };
|
||||||
|
vm.compileFunction(readRepoFile(...relativeParts), ["require", "module", "exports"])(
|
||||||
|
requireStub, moduleStub, moduleStub.exports
|
||||||
|
);
|
||||||
|
|
||||||
|
async function call(route, { body = {}, query = {}, params = {}, user = { id: "user-1" }, get = () => "" } = {}) {
|
||||||
|
const handlers = routes.get(route);
|
||||||
|
assert.ok(handlers, `${route} is not mounted`);
|
||||||
|
const res = { payload: null, json(payload) { this.payload = payload; } };
|
||||||
|
await handlers[handlers.length - 1]({ body, query, params, user, get }, res);
|
||||||
|
return res.payload;
|
||||||
|
}
|
||||||
|
|
||||||
|
return { routes, call };
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- POST /map/walls: the wall editor's save ------------------------------------------------
|
||||||
|
|
||||||
|
function makeMapDoc(walls = []) {
|
||||||
|
return { _id: "map-1", campaign: "campaign-1", walls, save: async () => {} };
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadMapRoutes({ ownsCampaign = true, maps = [] } = {}) {
|
||||||
|
return loadRouter(["backend", "src", "routes", "map.js"], {
|
||||||
|
"../models/Campaign": { findOne: () => mongooseQuery(ownsCampaign ? { _id: "campaign-1" } : null) },
|
||||||
|
"../models/Map": { findById: (id) => mongooseQuery(maps.find((map) => map._id === id) ?? null) },
|
||||||
|
"../models/Note": { findOne: () => mongooseQuery(null) },
|
||||||
|
"../models/Actor": { findOne: () => mongooseQuery(null) },
|
||||||
|
"../models/Folder": { find: () => mongooseQuery([]), belongsToSection: async () => true },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function wallSaveRouteTests() {
|
||||||
|
test("the wall editor saves the whole set, sanitised to whole image pixels", async () => {
|
||||||
|
const map = makeMapDoc();
|
||||||
|
const api = loadMapRoutes({ maps: [map] });
|
||||||
|
|
||||||
|
const response = await api.call("POST /walls", {
|
||||||
|
body: {
|
||||||
|
id: "map-1",
|
||||||
|
walls: [
|
||||||
|
// Coordinates arrive as strings from a form-ish body and can leave the image.
|
||||||
|
{ x1: "10.4", y1: -8, x2: 50, y2: 50.5, move: false },
|
||||||
|
{ _id: "wall-2", x1: 100, y1: 0, x2: 100, y2: 75, door: 2 },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.deepEqual(map.walls, [
|
||||||
|
{ x1: 10, y1: 0, x2: 50, y2: 51, move: false, sight: true, door: 0 },
|
||||||
|
{ _id: "wall-2", x1: 100, y1: 0, x2: 100, y2: 75, move: true, sight: true, door: 2 },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a save replaces the set: walls the editor dropped are gone", async () => {
|
||||||
|
const map = makeMapDoc([
|
||||||
|
{ _id: "wall-1", x1: 0, y1: 0, x2: 50, y2: 0 },
|
||||||
|
{ _id: "wall-2", x1: 0, y1: 0, x2: 0, y2: 50 },
|
||||||
|
]);
|
||||||
|
const api = loadMapRoutes({ maps: [map] });
|
||||||
|
|
||||||
|
await api.call("POST /walls", { body: { id: "map-1", walls: [{ _id: "wall-2", x1: 5, y1: 5, x2: 0, y2: 60 }] } });
|
||||||
|
|
||||||
|
assert.deepEqual(map.walls.map((wall) => String(wall._id)), ["wall-2"]);
|
||||||
|
assert.equal(map.walls[0].y1, 5);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("segments without length or with unreadable endpoints are dropped", async () => {
|
||||||
|
const map = makeMapDoc();
|
||||||
|
const api = loadMapRoutes({ maps: [map] });
|
||||||
|
|
||||||
|
await api.call("POST /walls", {
|
||||||
|
body: {
|
||||||
|
id: "map-1",
|
||||||
|
walls: [
|
||||||
|
{ x1: 40, y1: 40, x2: 40, y2: 40 },
|
||||||
|
{ x1: "wide", y1: 0, x2: 50, y2: 50 },
|
||||||
|
{ x1: 0, y1: 0, x2: 50, y2: 50 },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(map.walls.length, 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an unknown _id does not smuggle an id into the set, and a door outside 1 and 2 is no door", async () => {
|
||||||
|
const map = makeMapDoc([{ _id: "wall-1", x1: 0, y1: 0, x2: 50, y2: 0 }]);
|
||||||
|
const api = loadMapRoutes({ maps: [map] });
|
||||||
|
|
||||||
|
await api.call("POST /walls", {
|
||||||
|
body: {
|
||||||
|
id: "map-1",
|
||||||
|
walls: [
|
||||||
|
{ _id: "wall-9", x1: 0, y1: 0, x2: 50, y2: 0, door: 5 },
|
||||||
|
{ _id: "wall-1", x1: 60, y1: 0, x2: 60, y2: 50, door: "1" },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.deepEqual(map.walls, [
|
||||||
|
{ x1: 0, y1: 0, x2: 50, y2: 0, move: true, sight: true, door: 0 },
|
||||||
|
{ _id: "wall-1", x1: 60, y1: 0, x2: 60, y2: 50, move: true, sight: true, door: 1 },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("saving walls needs the map and an array, and only of one's own campaign", async () => {
|
||||||
|
const map = makeMapDoc();
|
||||||
|
const api = loadMapRoutes({ maps: [map] });
|
||||||
|
const foreign = loadMapRoutes({ ownsCampaign: false, maps: [makeMapDoc()] });
|
||||||
|
|
||||||
|
assert.equal((await api.call("POST /walls", { body: { walls: [] } })).msg, "errors.missing-data");
|
||||||
|
assert.equal((await api.call("POST /walls", { body: { id: "map-1" } })).msg, "errors.missing-data");
|
||||||
|
assert.equal((await api.call("POST /walls", { body: { id: "map-1", walls: "nope" } })).msg, "errors.missing-data");
|
||||||
|
assert.equal((await api.call("POST /walls", { body: { id: "map-404", walls: [] } })).msg, "errors.notfound");
|
||||||
|
assert.equal((await foreign.call("POST /walls", { body: { id: "map-1", walls: [] } })).msg, "unauthorized");
|
||||||
|
assert.deepEqual(map.walls, []);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- The module's sync routes: pairing a scene and trading wall sets -------------------------
|
||||||
|
|
||||||
|
function loadSyncRoutes({ campaign = { _id: "campaign-1", foundryWorldId: "world-1", settings: {} }, maps = [] } = {}) {
|
||||||
|
const matches = (map, filter) => {
|
||||||
|
if (filter._id !== undefined) {
|
||||||
|
if (typeof filter._id === "object" && filter._id.$ne !== undefined) {
|
||||||
|
if (String(map._id) === String(filter._id.$ne)) return false;
|
||||||
|
} else if (String(map._id) !== String(filter._id)) return false;
|
||||||
|
}
|
||||||
|
if (filter.campaign !== undefined && String(map.campaign) !== String(filter.campaign)) return false;
|
||||||
|
if (filter.foundrySceneId !== undefined
|
||||||
|
&& String(map.foundrySceneId ?? "") !== String(filter.foundrySceneId)) return false;
|
||||||
|
return true;
|
||||||
|
};
|
||||||
|
|
||||||
|
return loadRouter(["backend", "src", "routes", "foundry-link.js"], {
|
||||||
|
"node:crypto": require("node:crypto"),
|
||||||
|
mongoose: { isValidObjectId: () => false },
|
||||||
|
"../models/Campaign": { findOne: () => mongooseQuery(campaign) },
|
||||||
|
"../models/Actor": { find: () => mongooseQuery([]), findOne: () => mongooseQuery(null) },
|
||||||
|
"../models/Item": { find: () => mongooseQuery([]), findOne: () => mongooseQuery(null) },
|
||||||
|
"../models/Folder": { find: () => mongooseQuery([]) },
|
||||||
|
"../models/Map": {
|
||||||
|
find: (filter) => mongooseQuery(maps.filter((map) => matches(map, filter))),
|
||||||
|
findOne: (filter) => mongooseQuery(maps.find((map) => matches(map, filter)) ?? null),
|
||||||
|
},
|
||||||
|
"../services/actor-foundry": { foundryActorToCharacter: () => ({}) },
|
||||||
|
"../services/item-foundry": { foundryItemToItemData: () => null },
|
||||||
|
"../services/foundry-icons": { joinFoundryAssetUrl: () => "" },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// The sync routes authenticate with the token, not a JWT.
|
||||||
|
function asModule(request) {
|
||||||
|
return { ...request, get: (name) => (String(name).toLowerCase() === "authorization" ? "Bearer sync-token-1" : "") };
|
||||||
|
}
|
||||||
|
|
||||||
|
function syncRoutesTests() {
|
||||||
|
test("the module reads the campaign's maps with their walls and pairings", async () => {
|
||||||
|
const maps = [
|
||||||
|
{ _id: "map-1", campaign: "campaign-1", name: "Dungeon", image: "d.png", foundrySceneId: "scene-1", walls: [{ x1: 0, y1: 0, x2: 50, y2: 0 }] },
|
||||||
|
{ _id: "map-2", campaign: "campaign-1", name: "Town", image: "", foundrySceneId: null, walls: [] },
|
||||||
|
];
|
||||||
|
const api = loadSyncRoutes({ maps });
|
||||||
|
|
||||||
|
const response = await api.call("GET /sync/maps", asModule({}));
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.deepEqual(response.maps.map((map) => map.name), ["Dungeon", "Town"]);
|
||||||
|
assert.deepEqual(response.maps[0].walls, [{ x1: 0, y1: 0, x2: 50, y2: 0 }]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a paired scene's whole wall set replaces the map's, sanitised", async () => {
|
||||||
|
const map = { _id: "map-1", campaign: "campaign-1", name: "Dungeon", foundrySceneId: "scene-1", walls: [{ x1: 9, y1: 9, x2: 9, y2: 60 }], save: async () => {} };
|
||||||
|
const api = loadSyncRoutes({ maps: [map] });
|
||||||
|
|
||||||
|
const response = await api.call("POST /sync/map-walls", asModule({
|
||||||
|
body: {
|
||||||
|
worldId: "world-1",
|
||||||
|
foundrySceneId: "scene-1",
|
||||||
|
walls: [
|
||||||
|
{ x1: 10.4, y1: -3, x2: 60, y2: 50.5, move: true, sight: false, door: 0 },
|
||||||
|
{ x1: 0, y1: 0, x2: 0, y2: 0, door: 2 },
|
||||||
|
{ x1: 0, y1: 0, x2: 50, y2: 0, door: 1 },
|
||||||
|
],
|
||||||
|
},
|
||||||
|
}));
|
||||||
|
|
||||||
|
assert.equal(response.status, "ok");
|
||||||
|
assert.deepEqual(map.walls, [
|
||||||
|
{ x1: 10, y1: 0, x2: 60, y2: 51, move: true, sight: false, door: 0 },
|
||||||
|
{ x1: 0, y1: 0, x2: 50, y2: 0, move: true, sight: true, door: 1 },
|
||||||
|
]);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene with no paired map answers notfound and changes no map", async () => {
|
||||||
|
const map = { _id: "map-1", campaign: "campaign-1", name: "Dungeon", foundrySceneId: "scene-1", walls: [{ x1: 0, y1: 0, x2: 50, y2: 50 }], save: async () => {} };
|
||||||
|
const api = loadSyncRoutes({ maps: [map] });
|
||||||
|
|
||||||
|
const response = await api.call("POST /sync/map-walls", asModule({
|
||||||
|
body: { worldId: "world-1", foundrySceneId: "scene-2", walls: [] },
|
||||||
|
}));
|
||||||
|
|
||||||
|
assert.equal(response.msg, "errors.notfound");
|
||||||
|
assert.equal(map.walls.length, 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the wall push needs the paired world, the scene and an array", async () => {
|
||||||
|
const map = { _id: "map-1", campaign: "campaign-1", name: "Dungeon", foundrySceneId: "scene-1", walls: [{ x1: 0, y1: 0, x2: 50, y2: 50 }], save: async () => {} };
|
||||||
|
const api = loadSyncRoutes({ maps: [map] });
|
||||||
|
|
||||||
|
const wrongWorld = await api.call("POST /sync/map-walls", asModule({ body: { worldId: "world-2", foundrySceneId: "scene-1", walls: [] } }));
|
||||||
|
const noScene = await api.call("POST /sync/map-walls", asModule({ body: { worldId: "world-1", walls: [] } }));
|
||||||
|
const noWalls = await api.call("POST /sync/map-walls", asModule({ body: { worldId: "world-1", foundrySceneId: "scene-1" } }));
|
||||||
|
|
||||||
|
assert.deepEqual([wrongWorld.msg, noScene.msg, noWalls.msg], ["errors.missing-data", "errors.missing-data", "errors.missing-data"]);
|
||||||
|
assert.equal(map.walls.length, 1);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("an unauthenticated module hears nothing but unauthorized", async () => {
|
||||||
|
const api = loadSyncRoutes({ maps: [] });
|
||||||
|
const response = await api.call("GET /sync/maps", { get: () => "" });
|
||||||
|
assert.equal(response.msg, "unauthorized");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("pairing a map with a scene records it, and one scene walls one map at most", async () => {
|
||||||
|
const maps = [
|
||||||
|
{ _id: "map-1", campaign: "campaign-1", name: "Dungeon", foundrySceneId: null, walls: [], save: async () => {} },
|
||||||
|
{ _id: "map-2", campaign: "campaign-1", name: "Crypt", foundrySceneId: "scene-1", walls: [], save: async () => {} },
|
||||||
|
];
|
||||||
|
const api = loadSyncRoutes({ maps });
|
||||||
|
|
||||||
|
const taken = await api.call("POST /sync/map-scene", asModule({ body: { worldId: "world-1", mapId: "map-1", foundrySceneId: "scene-1" } }));
|
||||||
|
assert.equal(taken.msg, "foundry.errors.scene-already-synced");
|
||||||
|
assert.equal(maps[0].foundrySceneId, null);
|
||||||
|
|
||||||
|
const paired = await api.call("POST /sync/map-scene", asModule({ body: { worldId: "world-1", mapId: "map-1", foundrySceneId: "scene-7" } }));
|
||||||
|
assert.equal(paired.status, "ok");
|
||||||
|
assert.equal(maps[0].foundrySceneId, "scene-7");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- The MapWalls service: snapping and drawing ---------------------------------------------
|
||||||
|
|
||||||
|
function loadMapWallsService() {
|
||||||
|
const source = readRepoFile("frontend", "app", "services", "MapWalls.js");
|
||||||
|
const body = source.replace(/export\s*\{/, "return {").concat("\n;");
|
||||||
|
return vm.compileFunction(body, [])();
|
||||||
|
}
|
||||||
|
|
||||||
|
function mapWallsServiceTests() {
|
||||||
|
const service = loadMapWallsService();
|
||||||
|
// 800x600 image, shown at 200% and panned so its top left corner sits at (20, 10) of the viewport.
|
||||||
|
const view = { zoom: 2, pan: { x: 20, y: 10 }, width: 800, height: 600 };
|
||||||
|
const grid = { gridSize: 50, offsetX: 10, offsetY: 0 };
|
||||||
|
|
||||||
|
test("a spot of the viewport becomes the image pixel it stands for, clamped but never refused", () => {
|
||||||
|
assert.deepEqual(service.ToDrawPoint({ x: 100, y: 50 }, view), { x: 40, y: 20 });
|
||||||
|
// A drag over the edge keeps drawing at the edge instead of dropping the wall.
|
||||||
|
assert.deepEqual(service.ToDrawPoint({ x: 0, y: 50 }, view), { x: 0, y: 20 });
|
||||||
|
assert.equal(service.ToDrawPoint({ x: 100, y: 50 }, { zoom: 0, pan: { x: 0, y: 0 } }), null);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("endpoints snap to the nearest grid intersection, offset included", () => {
|
||||||
|
assert.deepEqual(service.SnapToGrid({ x: 112, y: 24 }, grid), { x: 110, y: 0 });
|
||||||
|
assert.deepEqual(service.SnapToGrid({ x: 112, y: 26 }, grid), { x: 110, y: 50 });
|
||||||
|
assert.deepEqual(service.SnapToGrid({ x: -8, y: -8 }, grid), { x: 0, y: 0 });
|
||||||
|
assert.equal(service.SnapToGrid(null, grid), null);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a wall becomes the screen line that draws it", () => {
|
||||||
|
assert.deepEqual(service.ToScreenWall({ x1: 40, y1: 20, x2: 90, y2: 70 }, view), { x1: 100, y1: 50, x2: 200, y2: 150 });
|
||||||
|
assert.deepEqual(service.ToScreenWall({}, view), { x1: 20, y1: 10, x2: 20, y2: 10 });
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a slid wall keeps its shape and goes nowhere off the image", () => {
|
||||||
|
assert.deepEqual(service.MoveWall({ x1: 10, y1: 10, x2: 60, y2: 10 }, 13.4, -5.6), { x1: 23, y1: 4, x2: 73, y2: 4 });
|
||||||
|
assert.deepEqual(service.MoveWall({ x1: 5, y1: 5, x2: 5, y2: 55 }, -10, 0), { x1: 0, y1: 0, x2: 0, y2: 50 });
|
||||||
|
assert.equal(service.MoveWall({ x1: 0, y1: 0, x2: 5, y2: 5 }, "x", 0), null);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a segment with no length is no wall", () => {
|
||||||
|
assert.equal(service.IsWall({ x1: 40, y1: 40, x2: 41, y2: 40 }), true);
|
||||||
|
assert.equal(service.IsWall({ x1: 40, y1: 40, x2: 40, y2: 40 }), false);
|
||||||
|
assert.equal(service.IsWall(null), false);
|
||||||
|
assert.equal(service.IsWall({ x1: 0, y1: 0, x2: 0 }), false);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- The Foundry module: pairing scenes, trading wall sets -----------------------------------
|
||||||
|
|
||||||
|
function makeWallWorld({ autoSync = true, maps = [], scenes = [], pairedSceneIds = null } = {}) {
|
||||||
|
const state = {
|
||||||
|
hooks: new Map(),
|
||||||
|
registered: new Map(),
|
||||||
|
requests: [],
|
||||||
|
notifications: [],
|
||||||
|
timers: new Map(),
|
||||||
|
nextTimerId: 1,
|
||||||
|
maps,
|
||||||
|
embeddedWrites: [],
|
||||||
|
pairedSceneIds,
|
||||||
|
};
|
||||||
|
|
||||||
|
const settingsStore = {
|
||||||
|
autoSync,
|
||||||
|
syncToken: "sync-token-1",
|
||||||
|
dragonrollApiUrl: "http://backend.test:5000",
|
||||||
|
};
|
||||||
|
|
||||||
|
const sandbox = {
|
||||||
|
console: { log() {}, info() {}, warn() {}, error() {} },
|
||||||
|
URL,
|
||||||
|
CONFIG: {},
|
||||||
|
window: { location: { origin: "http://vtt.test" } },
|
||||||
|
ui: {
|
||||||
|
notifications: {
|
||||||
|
info: (text) => state.notifications.push(["info", text]),
|
||||||
|
warn: (text) => state.notifications.push(["warn", text]),
|
||||||
|
error: (text) => state.notifications.push(["error", text]),
|
||||||
|
},
|
||||||
|
},
|
||||||
|
Hooks: {
|
||||||
|
once(name, fn) { state.hooks.set(name, [fn]); },
|
||||||
|
on(name, fn) {
|
||||||
|
const handlers = state.hooks.get(name) || [];
|
||||||
|
handlers.push(fn);
|
||||||
|
state.hooks.set(name, handlers);
|
||||||
|
},
|
||||||
|
},
|
||||||
|
setTimeout: (fn, delay = 0) => {
|
||||||
|
const id = state.nextTimerId++;
|
||||||
|
state.timers.set(id, { fn, delay });
|
||||||
|
return id;
|
||||||
|
},
|
||||||
|
clearTimeout: (id) => state.timers.delete(id),
|
||||||
|
setInterval: () => 0,
|
||||||
|
clearInterval: () => {},
|
||||||
|
fetch: async (url, options = {}) => {
|
||||||
|
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/maps")) {
|
||||||
|
return { ok: true, status: 200, json: async () => ({ status: "ok", maps: state.maps }) };
|
||||||
|
}
|
||||||
|
if (href.includes("foundry/sync/map-walls") && state.pairedSceneIds
|
||||||
|
&& !state.pairedSceneIds.includes(body?.foundrySceneId)) {
|
||||||
|
return { ok: true, status: 200, json: async () => ({ status: "error", msg: "errors.notfound" }) };
|
||||||
|
}
|
||||||
|
return { ok: true, status: 200, json: async () => ({ status: "ok", actors: [], items: [], folders: [] }) };
|
||||||
|
},
|
||||||
|
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 },
|
||||||
|
folders: { contents: [] },
|
||||||
|
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(readRepoFile("dragonroll-foundry", "scripts", "api.js"), sandbox);
|
||||||
|
|
||||||
|
state.game = sandbox.game;
|
||||||
|
|
||||||
|
// A scene holding Foundry-shape wall documents. Its embedded writes are recorded, and —
|
||||||
|
// like the real client — each one fires the scene's wall hooks while the write is under way.
|
||||||
|
state.makeScene = (id, name, walls = []) => {
|
||||||
|
const scene = {
|
||||||
|
id, name, documentName: "Scene",
|
||||||
|
wallDocuments: { contents: walls },
|
||||||
|
async updateEmbeddedDocuments(kind, updates) {
|
||||||
|
state.embeddedWrites.push([kind, "update", updates]);
|
||||||
|
for (const update of updates) {
|
||||||
|
const wall = walls.find((current) => current.id === update._id);
|
||||||
|
const { _id, ...rest } = update;
|
||||||
|
Object.assign(wall, rest);
|
||||||
|
}
|
||||||
|
await state.fireSync("updateWall", walls.map((wall) => ({ documentName: "Wall", id: wall.id, parent: scene })));
|
||||||
|
},
|
||||||
|
async createEmbeddedDocuments(kind, creates) {
|
||||||
|
state.embeddedWrites.push([kind, "create", creates]);
|
||||||
|
const created = creates.map((data, index) => ({ id: `${id}-wall-${index}`, ...data }));
|
||||||
|
walls.push(...created);
|
||||||
|
await state.fireSync("createWall", created.map((wall) => ({ documentName: "Wall", id: wall.id, parent: scene })));
|
||||||
|
},
|
||||||
|
async deleteEmbeddedDocuments(kind, ids) {
|
||||||
|
state.embeddedWrites.push([kind, "delete", ids]);
|
||||||
|
for (const documentId of ids) {
|
||||||
|
const index = walls.findIndex((wall) => wall.id === documentId);
|
||||||
|
if (index >= 0) walls.splice(index, 1);
|
||||||
|
}
|
||||||
|
await state.fireSync("deleteWall", ids.map((documentId) => ({ documentName: "Wall", id: documentId, parent: scene })));
|
||||||
|
},
|
||||||
|
};
|
||||||
|
return scene;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Fire a wall hook through the sandboxed Hooks registry without awaiting each handler: the
|
||||||
|
// real client fires wall hooks synchronously while a write runs.
|
||||||
|
state.fireSync = (name, documents) => {
|
||||||
|
for (const handler of state.hooks.get(name) || []) {
|
||||||
|
for (const document of documents) handler(document);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
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 < 8; round += 1) {
|
||||||
|
if (!state.timers.size && round > 2) break;
|
||||||
|
const due = [...state.timers.values()];
|
||||||
|
state.timers.clear();
|
||||||
|
for (const timer of due) await timer.fn();
|
||||||
|
await drain();
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
async function drain() {
|
||||||
|
await new Promise((resolve) => setImmediate(resolve));
|
||||||
|
}
|
||||||
|
|
||||||
|
state.linkedSetup = async () => {
|
||||||
|
await state.fire("init");
|
||||||
|
await state.fire("ready");
|
||||||
|
await state.runTimers();
|
||||||
|
state.requests.length = 0;
|
||||||
|
state.embeddedWrites.length = 0;
|
||||||
|
return state;
|
||||||
|
};
|
||||||
|
|
||||||
|
state.wallPushes = () => state.requests.filter((request) => request.href.includes("foundry/sync/map-walls"));
|
||||||
|
state.scenePairings = () => state.requests.filter((request) => request.href.includes("foundry/sync/map-scene"));
|
||||||
|
|
||||||
|
return state;
|
||||||
|
}
|
||||||
|
|
||||||
|
function foundryModuleWallTests() {
|
||||||
|
test("a GM's wall edit pushes the scene's whole set, in the campaign's shape", async () => {
|
||||||
|
const scene = makeWallWorld().makeScene("scene-1", "Dungeon", [
|
||||||
|
{ id: "wall-1", c: [10.4, -3, 60, 50.5], light: 2, sense: 2, move: 1, door: 0, ds: 0 },
|
||||||
|
{ id: "wall-2", c: [0, 0, 50, 0], light: 0, sense: 0, move: 0, door: 2, ds: 1 },
|
||||||
|
]);
|
||||||
|
const world = await scene.linkedSetup();
|
||||||
|
|
||||||
|
await world.fire("updateWall", { documentName: "Wall", id: "wall-2", parent: scene });
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
const pushes = world.wallPushes();
|
||||||
|
assert.equal(pushes.length, 1);
|
||||||
|
assert.equal(pushes[0].body.foundrySceneId, "scene-1");
|
||||||
|
assert.deepEqual(pushes[0].body.walls, [
|
||||||
|
{ x1: 10, y1: 0, x2: 60, y2: 51, move: true, sight: true, door: 0 },
|
||||||
|
{ x1: 0, y1: 0, x2: 50, y2: 0, move: false, sight: false, door: 1 },
|
||||||
|
]);
|
||||||
|
assert.deepEqual(world.embeddedWrites, []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the campaign's set lands on its paired scene: changed walls written, extra ones deleted", async () => {
|
||||||
|
const world = makeWallWorld({
|
||||||
|
maps: [{
|
||||||
|
_id: "map-1", name: "Dungeon", foundrySceneId: "scene-1",
|
||||||
|
walls: [
|
||||||
|
{ x1: 0, y1: 0, x2: 50, y2: 0, move: true, sight: true, door: 0 },
|
||||||
|
{ x1: 50, y1: 0, x2: 50, y2: 100, move: false, sight: true, door: 2 },
|
||||||
|
],
|
||||||
|
}],
|
||||||
|
scenes: [],
|
||||||
|
});
|
||||||
|
const scene = world.makeScene("scene-1", "Dungeon", [
|
||||||
|
{ id: "wall-1", c: [0, 0, 50, 0], light: 2, sense: 2, move: 1, door: 0, ds: 0 },
|
||||||
|
{ id: "wall-2", c: [0, 0, 0, 80], light: 2, sense: 2, move: 1, door: 0, ds: 0 },
|
||||||
|
{ id: "wall-3", c: [90, 90, 120, 90], light: 2, sense: 2, move: 1, door: 0, ds: 0 },
|
||||||
|
]);
|
||||||
|
world.game.scenes.contents.push(scene);
|
||||||
|
|
||||||
|
await world.fire("init");
|
||||||
|
await world.fire("ready");
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
// wall-1 already stands where the campaign wants it and is left alone; wall-2 is
|
||||||
|
// retyped into the campaign's second segment; wall-3 is beyond the set and goes.
|
||||||
|
const updates = world.embeddedWrites.find(([, kind, payload]) => kind === "update" && payload.length)?.[2];
|
||||||
|
assert.deepEqual(updates, [{
|
||||||
|
_id: "wall-2", c: [50, 0, 50, 100], light: 2, sense: 2, move: 0, door: 2, ds: 0,
|
||||||
|
}]);
|
||||||
|
const deletes = world.embeddedWrites.find(([, kind, payload]) => kind === "delete")?.[2];
|
||||||
|
assert.deepEqual(deletes, ["wall-3"]);
|
||||||
|
// The set landed on the scene is exactly the campaign's: it reads back unchanged, so the
|
||||||
|
// writes are not echoed to the campaign.
|
||||||
|
assert.deepEqual(world.wallPushes(), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a map with no walls adopts the walls the scene already has", async () => {
|
||||||
|
const world = makeWallWorld({
|
||||||
|
maps: [{ _id: "map-1", name: "Crypt", foundrySceneId: "scene-1", walls: [] }],
|
||||||
|
scenes: [],
|
||||||
|
});
|
||||||
|
const scene = world.makeScene("scene-1", "Crypt", [
|
||||||
|
{ id: "wall-1", c: [0, 0, 100, 0], light: 2, sense: 2, move: 1, door: 0, ds: 0 },
|
||||||
|
]);
|
||||||
|
world.game.scenes.contents.push(scene);
|
||||||
|
|
||||||
|
await world.fire("init");
|
||||||
|
await world.fire("ready");
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
const pushes = world.wallPushes();
|
||||||
|
assert.equal(pushes.length, 1);
|
||||||
|
assert.deepEqual(pushes[0].body.walls, [
|
||||||
|
{ x1: 0, y1: 0, x2: 100, y2: 0, move: true, sight: true, door: 0 },
|
||||||
|
]);
|
||||||
|
assert.deepEqual(world.embeddedWrites, []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a campaign map pairs with the scene of its name, and only when it is the only one", async () => {
|
||||||
|
const paired = makeWallWorld({
|
||||||
|
maps: [{ _id: "map-1", name: "Dungeon", foundrySceneId: null, walls: [{ x1: 10, y1: 10, x2: 60, y2: 60 }] }],
|
||||||
|
scenes: [],
|
||||||
|
});
|
||||||
|
const scene = paired.makeScene("scene-1", "Dungeon", []);
|
||||||
|
paired.game.scenes.contents.push(scene);
|
||||||
|
await paired.fire("init");
|
||||||
|
await paired.fire("ready");
|
||||||
|
await paired.runTimers();
|
||||||
|
|
||||||
|
const pairings = paired.scenePairings();
|
||||||
|
assert.equal(pairings.length, 1);
|
||||||
|
assert.deepEqual(pairings[0].body, { worldId: "world-1", mapId: "map-1", foundrySceneId: "scene-1" });
|
||||||
|
// Paired, the campaign's wall lands as a new wall document on the scene.
|
||||||
|
const creates = paired.embeddedWrites.find(([, kind, payload]) => kind === "create")?.[2];
|
||||||
|
assert.deepEqual(creates, [{ c: [10, 10, 60, 60], light: 2, sense: 2, move: 1, door: 0, ds: 0 }]);
|
||||||
|
|
||||||
|
// Two scenes share the name: the map is nobody's by name alone, and nothing is paired or written.
|
||||||
|
const twin = makeWallWorld({
|
||||||
|
maps: [{ _id: "map-1", name: "Dungeon", foundrySceneId: null, walls: [{ x1: 10, y1: 10, x2: 60, y2: 60 }] }],
|
||||||
|
scenes: [],
|
||||||
|
});
|
||||||
|
twin.game.scenes.contents.push(twin.makeScene("scene-1", "Dungeon", []), twin.makeScene("scene-2", "Dungeon", []));
|
||||||
|
await twin.fire("init");
|
||||||
|
await twin.fire("ready");
|
||||||
|
await twin.runTimers();
|
||||||
|
|
||||||
|
assert.deepEqual(twin.scenePairings(), []);
|
||||||
|
assert.deepEqual(twin.embeddedWrites, []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a scene no campaign map mirrors is let go of, not retried", async () => {
|
||||||
|
const world = makeWallWorld({ pairedSceneIds: [] });
|
||||||
|
const scene = world.makeScene("scene-9", "Not a map", [
|
||||||
|
{ id: "wall-1", c: [0, 0, 50, 50], light: 2, sense: 2, move: 1, door: 0, ds: 0 },
|
||||||
|
]);
|
||||||
|
await world.linkedSetup();
|
||||||
|
world.game.scenes.contents.push(scene);
|
||||||
|
|
||||||
|
await world.fire("createWall", { documentName: "Wall", id: "wall-1", parent: scene });
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
// The push was made once and, hearing the campaign keeps no map for this scene, the
|
||||||
|
// module stops asking about it again.
|
||||||
|
assert.equal(world.wallPushes().length, 1);
|
||||||
|
assert.deepEqual(world.notifications.filter(([kind]) => kind === "error"), []);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("autosync off keeps walls at home, and on again reconciles them", async () => {
|
||||||
|
const world = makeWallWorld({ autoSync: false, scenes: [] });
|
||||||
|
const scene = world.makeScene("scene-1", "Dungeon", [
|
||||||
|
{ id: "wall-1", c: [0, 0, 50, 50], light: 2, sense: 2, move: 1, door: 0, ds: 0 },
|
||||||
|
]);
|
||||||
|
world.game.scenes.contents.push(scene);
|
||||||
|
await world.fire("init");
|
||||||
|
await world.fire("ready");
|
||||||
|
await world.runTimers();
|
||||||
|
|
||||||
|
await world.fire("updateWall", { documentName: "Wall", id: "wall-1", parent: scene });
|
||||||
|
await world.runTimers();
|
||||||
|
assert.deepEqual(world.wallPushes(), []);
|
||||||
|
assert.ok(!world.requests.some((request) => request.href.includes("foundry/sync/maps")));
|
||||||
|
|
||||||
|
await world.game.settings.set(MODULE_ID, "autoSync", true);
|
||||||
|
await world.runTimers();
|
||||||
|
assert.ok(world.requests.some((request) => request.href.includes("foundry/sync/maps")),
|
||||||
|
"the campaign's maps are asked for again");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// --- The map viewer: the editor's wiring -------------------------------------------------------
|
||||||
|
|
||||||
|
function mapViewerWiringTests() {
|
||||||
|
const pane = readRepoFile("frontend", "app", "components", "viewer", "map", "MapViewerPane.vue");
|
||||||
|
|
||||||
|
test("the viewer bar opens the wall editor", () => {
|
||||||
|
assert.match(pane, /:aria-pressed="editingWalls\.toString\(\)" @click="toggleWallEditing"/);
|
||||||
|
assert.match(pane, /\$t\('campaigns\.map\.walls\.edit'\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("walls are drawn in screen space and only the editor's hit areas catch the mouse", () => {
|
||||||
|
assert.match(pane, /class="wall-line"[^>]*:class="wallClasses\(wall\)"[^>]*v-bind="wallScreen\(wall\)"/);
|
||||||
|
assert.match(pane, /\.map-walls\s*\{[^}]*pointer-events:\s*none/);
|
||||||
|
assert.match(pane, /\.wall-hit\s*\{[^}]*pointer-events:\s*stroke/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("every wall edit saves the whole set through /map/walls", () => {
|
||||||
|
assert.match(pane, /updateMap\('\/map\/walls'/);
|
||||||
|
// A held drag stays local until the pointer lets go, and a wall keeps its _id through saves.
|
||||||
|
assert.match(pane, /_id: String\(wall\._id\)/);
|
||||||
|
assert.match(pane, /if \(IsWall\(segment\)\) await saveWalls\(\[\.\.\.walls\.value, segment\]\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("drawn endpoints snap to the grid, like Foundry's wall tool", () => {
|
||||||
|
assert.match(pane, /import \{ IsWall, MoveWall, SnapToGrid, ToDrawPoint, ToScreenWall \} from '~\/services\/MapWalls'/);
|
||||||
|
assert.match(pane, /SnapToGrid\(spot, grid\.value\)/);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("a wall answers the mouse and the keyboard", () => {
|
||||||
|
assert.match(pane, /@contextmenu\.stop\.prevent="onWallContextMenu\(wall\)"/);
|
||||||
|
assert.match(pane, /@keydown="onWallKeydown\(\$event, wall\)"/);
|
||||||
|
assert.match(pane, /Delete.*removeWall|removeWall/);
|
||||||
|
assert.match(pane, /event\.key !== 'Escape'[\s\S]*drawingWall\.value = null/);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
wallSaveRouteTests();
|
||||||
|
syncRoutesTests();
|
||||||
|
mapWallsServiceTests();
|
||||||
|
foundryModuleWallTests();
|
||||||
|
mapViewerWiringTests();
|
||||||
Reference in New Issue
Block a user