Merge branch 'master' into ai/issue-17
This commit is contained in:
30
AGENTS.md
30
AGENTS.md
@@ -28,6 +28,7 @@ CI (`.gitea/workflows/deploy.yml`) builds two Docker images on every push to `ma
|
|||||||
dragonroll/
|
dragonroll/
|
||||||
├── backend/ Express API (CommonJS, entry: src/index.js)
|
├── backend/ Express API (CommonJS, entry: src/index.js)
|
||||||
├── frontend/ Nuxt 4 app (entry: app/app.vue)
|
├── frontend/ Nuxt 4 app (entry: app/app.vue)
|
||||||
|
├── obsidian-plugin/ Plain JavaScript Obsidian plugin for campaign note import/push
|
||||||
├── docker-compose.yml nginx :3000 -> frontend :3000, /api -> backend :5000
|
├── docker-compose.yml nginx :3000 -> frontend :3000, /api -> backend :5000
|
||||||
├── nginx.conf reverse proxy rules for the compose stack
|
├── nginx.conf reverse proxy rules for the compose stack
|
||||||
├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9)
|
├── ecosystem.config.js PM2 config (stale: runs `npm start`, which does not exist — see §9)
|
||||||
@@ -189,7 +190,8 @@ Fetch the file from `/api/public/<filename>`.
|
|||||||
`GET /api/campaign/list` → `{status:'ok',campaigns}`
|
`GET /api/campaign/list` → `{status:'ok',campaigns}`
|
||||||
`GET /api/campaign/retrieve/:id` → `{status:'ok',campaign}` (401 when no `req.user.id`)
|
`GET /api/campaign/retrieve/:id` → `{status:'ok',campaign}` (401 when no `req.user.id`)
|
||||||
|
|
||||||
`GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots)
|
`GET /api/note/list?campaign=` → `{status:'ok', folders, notes}` — notes with `folder: null` (roots);
|
||||||
|
folder entries include `parentFolder` so clients can rebuild nested folder paths
|
||||||
`GET /api/note/subfolder/list?campaign=&folder=` → `{status:'ok', subfolders, notes}`
|
`GET /api/note/subfolder/list?campaign=&folder=` → `{status:'ok', subfolders, notes}`
|
||||||
`POST /api/note/create` — `{title*,content,campaign*,folder?}` (folder validated against campaign)
|
`POST /api/note/create` — `{title*,content,campaign*,folder?}` (folder validated against campaign)
|
||||||
`POST /api/note/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked
|
`POST /api/note/update` — `{id*, title?, content?, folder?, color?}` — partial, ownership checked
|
||||||
@@ -290,7 +292,7 @@ frontend/
|
|||||||
│ │ VersionRender
|
│ │ VersionRender
|
||||||
│ ├── layouts/ IconButton, Dropdown, Tabs, ColorPicker (reusable UI atoms)
|
│ ├── layouts/ IconButton, Dropdown, Tabs, ColorPicker (reusable UI atoms)
|
||||||
│ └── viewer/ TopBar, statusbar/{StatusBar,FetchStatus}, topbar/{TopSearchBar,SearchResult},
|
│ └── viewer/ TopBar, statusbar/{StatusBar,FetchStatus}, topbar/{TopSearchBar,SearchResult},
|
||||||
│ content/{Content,NoteContainer,Note}, widgets/{TableWidget,TestWidget,
|
│ content/{Content,NoteContainer,Note}, map/MapViewerPane, widgets/{TableWidget,TestWidget,
|
||||||
│ inline/RollWidgetInline,display/RollWidgetDisplay}
|
│ inline/RollWidgetInline,display/RollWidgetDisplay}
|
||||||
├── composables/ useTheme.ts (theme+accent singletons, localStorage, data-* attrs),
|
├── composables/ useTheme.ts (theme+accent singletons, localStorage, data-* attrs),
|
||||||
│ useEmitter.ts (BROKEN, see §9)
|
│ useEmitter.ts (BROKEN, see §9)
|
||||||
@@ -304,7 +306,10 @@ There is no `app/pages/`. `app/app.vue` renders a fixed shell of managers. "Scre
|
|||||||
|
|
||||||
- **Windows** — floating, draggable/resizable overlays (login, main menu, settings…), or
|
- **Windows** — floating, draggable/resizable overlays (login, main menu, settings…), or
|
||||||
- **Content** — the campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`),
|
- **Content** — the campaign workspace (`TopBar` + `ContentSidebar` + note column + `StatusBar`),
|
||||||
shown when `Campaign` state is non-null.
|
shown when `Campaign` state is non-null. The note column shows the open notes, or the map anchored
|
||||||
|
on it (`AnchorMap` / `ActivePane` in `services/Content.js`); the sidebar's notes and maps buttons
|
||||||
|
switch between the two while both keep their state, and `viewer/map/MapViewerPane.vue` renders the
|
||||||
|
map there and inside the `map_viewer` window (a detached anchored map).
|
||||||
|
|
||||||
Boot sequence (`app.vue` → `start()`):
|
Boot sequence (`app.vue` → `start()`):
|
||||||
|
|
||||||
@@ -367,7 +372,7 @@ Plain modules with module-scope `ref()`s imported directly. No DI, no Pinia. Sin
|
|||||||
| `Server.js` | axios instance (fallback baseURL `http://localhost:5000/api`), `initApi(baseURL)` called by `plugins/api.ts`, request interceptor adding `Authorization: Bearer <localStorage.token>`, `getBaseUrl()`. Default export is a factory: call `Server()` then `.get/.post`. |
|
| `Server.js` | axios instance (fallback baseURL `http://localhost:5000/api`), `initApi(baseURL)` called by `plugins/api.ts`, request interceptor adding `Authorization: Bearer <localStorage.token>`, `getBaseUrl()`. Default export is a factory: call `Server()` then `.get/.post`. |
|
||||||
| `User.js` | `UserStatus` ref, `GetUser()` (decodes JWT, auto-logout on `exp`), `SetUser(token)`, `LoadUser`, `LogoutUser`, `IsAdmin`, `HasAdmin()`, `GetUserSetting(key)` / `SetUserSetting(key,value)` (server-backed, in `User.settings`) |
|
| `User.js` | `UserStatus` ref, `GetUser()` (decodes JWT, auto-logout on `exp`), `SetUser(token)`, `LoadUser`, `LogoutUser`, `IsAdmin`, `HasAdmin()`, `GetUserSetting(key)` / `SetUserSetting(key,value)` (server-backed, in `User.settings`) |
|
||||||
| `Campaign.js` | `useCampaignService()` → `Campaign` (`useState('campaign')`), `SetCampaign(data)` (also writes `localStorage.selectedCampaignId`), `RestoreCampaign()` |
|
| `Campaign.js` | `useCampaignService()` → `Campaign` (`useState('campaign')`), `SetCampaign(data)` (also writes `localStorage.selectedCampaignId`), `RestoreCampaign()` |
|
||||||
| `Content.js` | `ShowContent` ref (drives the campaign workspace). `SetShowContent` is exported but unused — `ContentManager.vue` sets it from a `watch(Campaign)` and never turns it back off |
|
| `Content.js` | `ShowContent` ref (drives the campaign workspace: `ContentManager.vue` turns it on from a `watch(Campaign)`, `TopBar` off when leaving a campaign) and the anchored map: `ActivePane` (`'notes'`\|`'map'`), `AnchoredMap`, `SetActivePane`, `AnchorMap`, `ClearAnchoredMap` |
|
||||||
| `Emitter.js` | `export const emitter = mitt()` — the app-wide event bus |
|
| `Emitter.js` | `export const emitter = mitt()` — the app-wide event bus |
|
||||||
| `Toaster.js` | `DisplayToast(color, text, duration)` → emits `toast`; `ToastManager.vue` renders it |
|
| `Toaster.js` | `DisplayToast(color, text, duration)` → emits `toast`; `ToastManager.vue` renders it |
|
||||||
| `Tooltip.js` | `SetupTooltip()`, `AddTooltip(el, text, {max_width})` (stores on `el._dr_tooltip`), polled visibility via `elementsFromPoint` |
|
| `Tooltip.js` | `SetupTooltip()`, `AddTooltip(el, text, {max_width})` (stores on `el._dr_tooltip`), polled visibility via `elementsFromPoint` |
|
||||||
@@ -477,6 +482,23 @@ script; `WindowDefinitions` stores raw keys (`title: 'windows.login'`) and `Wind
|
|||||||
configured (`nuxt.config.ts`, `langDir: 'locales/'`, `vueI18n: './i18n.config.ts'`) but its locale files
|
configured (`nuxt.config.ts`, `langDir: 'locales/'`, `vueI18n: './i18n.config.ts'`) but its locale files
|
||||||
(`locales/en.json` etc.) are empty `{}` — the custom plugin is what components actually consume.
|
(`locales/en.json` etc.) are empty `{}` — the custom plugin is what components actually consume.
|
||||||
|
|
||||||
|
### 5.9 Obsidian plugin
|
||||||
|
|
||||||
|
`obsidian-plugin/` is a plain JavaScript community plugin; copy `main.js` and `manifest.json` into
|
||||||
|
`<vault>/.obsidian/plugins/dragonroll-sync/` (details in its README). It signs in through
|
||||||
|
`POST /api/user/login`, saves the 48-hour JWT token in plugin data, and does not save the password.
|
||||||
|
The user selects a campaign from `GET /api/campaign/list`.
|
||||||
|
|
||||||
|
- **Import or refresh campaign notes** reads `/api/note/list` plus `/api/note/subfolder/list` and
|
||||||
|
creates/updates Markdown files under `Dragonroll/<Campaign>/`, preserving Dragonroll's folder tree.
|
||||||
|
- **Push active note to Dragonroll** creates a root campaign note or updates the note linked in its
|
||||||
|
frontmatter.
|
||||||
|
- `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` frontmatter properties link imported
|
||||||
|
notes. They are omitted from content sent to Dragonroll. Per-note signatures detect local edits;
|
||||||
|
imports preserve modified local files, and push is explicit.
|
||||||
|
|
||||||
|
The plugin uses Obsidian's `requestUrl` helper, so the request path does not depend on browser CORS.
|
||||||
|
|
||||||
## 6. Conventions
|
## 6. Conventions
|
||||||
|
|
||||||
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/`
|
- **Backend**: CommonJS `require`/`module.exports`; files in `services/` are shared infra, `routes/`
|
||||||
|
|||||||
@@ -24,6 +24,7 @@ Dragonroll is an open source connector for role-playing games.
|
|||||||
- Play music during physical campaings
|
- Play music during physical campaings
|
||||||
- Plan different encounters
|
- Plan different encounters
|
||||||
- Manage different items and spells
|
- Manage different items and spells
|
||||||
|
- Import and edit campaign notes in Obsidian with the [Dragonroll Sync plugin](obsidian-plugin/README.md)
|
||||||
- And so much more!
|
- And so much more!
|
||||||
|
|
||||||
## Installation 🛠️
|
## Installation 🛠️
|
||||||
@@ -55,7 +56,6 @@ if you want to start the development environments
|
|||||||
|
|
||||||
- Dragonroll <-> Foundry integration
|
- Dragonroll <-> Foundry integration
|
||||||
- Dragonroll <-> Discord Bot integration
|
- Dragonroll <-> Discord Bot integration
|
||||||
- Dragonroll <-> Obsidian integration
|
|
||||||
|
|
||||||
What to sync:
|
What to sync:
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ router.get('/list', async (req, res) => {
|
|||||||
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
if (!hasAccess) return res.json({ status: 'error', msg: 'unauthorized' });
|
||||||
|
|
||||||
const folders = await Folder.find({ campaign })
|
const folders = await Folder.find({ campaign })
|
||||||
.select('_id name date color')
|
.select('_id name parentFolder date color')
|
||||||
.sort({ date: -1 })
|
.sort({ date: -1 })
|
||||||
.lean();
|
.lean();
|
||||||
|
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ import { computed, nextTick, onBeforeUnmount, onMounted, ref, watch } from 'vue'
|
|||||||
import { useI18n } from 'vue-i18n';
|
import { useI18n } from 'vue-i18n';
|
||||||
|
|
||||||
import { useCampaignService } from '~/services/Campaign.js';
|
import { useCampaignService } from '~/services/Campaign.js';
|
||||||
|
import { AnchorMap, AnchoredMap, ClearAnchoredMap, SetActivePane } from '~/services/Content.js';
|
||||||
import { emitter } from '~/services/Emitter';
|
import { emitter } from '~/services/Emitter';
|
||||||
import Server from '~/services/Server';
|
import Server from '~/services/Server';
|
||||||
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
|
import { ClearWindow, CreateWindow, GetFirstWindowId } from '~/services/Windows';
|
||||||
@@ -207,6 +208,9 @@ async function fetchCampaignEntries(entityType = activeSection.value, silent = f
|
|||||||
function selectSection(section) {
|
function selectSection(section) {
|
||||||
activeSection.value = section;
|
activeSection.value = section;
|
||||||
if (isEntrySection(section)) fetchCampaignEntries(section);
|
if (isEntrySection(section)) fetchCampaignEntries(section);
|
||||||
|
// The content area follows the sidebar: maps shows the anchored map, everything else the
|
||||||
|
// notes that are currently open.
|
||||||
|
SetActivePane(section === 'maps' && AnchoredMap.value ? 'map' : 'notes');
|
||||||
}
|
}
|
||||||
|
|
||||||
function createEntry(entityType) {
|
function createEntry(entityType) {
|
||||||
@@ -272,6 +276,7 @@ function showEntryMenu(entry, entityType) {
|
|||||||
const response = await Server().post(`/${entityType}/delete`, { id: entry._id });
|
const response = await Server().post(`/${entityType}/delete`, { id: entry._id });
|
||||||
if (response.data.status === 'ok' && list) {
|
if (response.data.status === 'ok' && list) {
|
||||||
list.value = list.value.filter((current) => current._id !== entry._id);
|
list.value = list.value.filter((current) => current._id !== entry._id);
|
||||||
|
if (entityType === 'map' && isAnchoredMap(entry)) ClearAnchoredMap();
|
||||||
}
|
}
|
||||||
} catch (error) {} finally { HideContextMenu(); }
|
} catch (error) {} finally { HideContextMenu(); }
|
||||||
}
|
}
|
||||||
@@ -294,13 +299,17 @@ async function openCharacterSheet(actor) {
|
|||||||
CreateWindow('character_sheet', { actor });
|
CreateWindow('character_sheet', { actor });
|
||||||
}
|
}
|
||||||
|
|
||||||
async function openMapViewer(map) {
|
// Maps are anchored on the note container instead of opening a window: the notes that were open
|
||||||
const existingWindowId = GetFirstWindowId('map_viewer');
|
// stay open, and the sidebar's notes/maps buttons switch between the two.
|
||||||
if (existingWindowId !== undefined) {
|
function openMapViewer(map) {
|
||||||
ClearWindow({ id: existingWindowId });
|
if (!map) return;
|
||||||
await nextTick();
|
const floatingViewer = GetFirstWindowId('map_viewer');
|
||||||
}
|
if (floatingViewer !== undefined) ClearWindow({ id: floatingViewer });
|
||||||
CreateWindow('map_viewer', { map, campaign: campaignId.value });
|
AnchorMap(map);
|
||||||
|
}
|
||||||
|
|
||||||
|
function isAnchoredMap(map) {
|
||||||
|
return AnchoredMap.value?._id === map._id;
|
||||||
}
|
}
|
||||||
|
|
||||||
function createNote() {
|
function createNote() {
|
||||||
@@ -324,6 +333,7 @@ watch(campaignId, (newVal) => {
|
|||||||
actors.value = [];
|
actors.value = [];
|
||||||
items.value = [];
|
items.value = [];
|
||||||
maps.value = [];
|
maps.value = [];
|
||||||
|
ClearAnchoredMap();
|
||||||
fetchCampaignNotes();
|
fetchCampaignNotes();
|
||||||
if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value);
|
if (isEntrySection(activeSection.value)) fetchCampaignEntries(activeSection.value);
|
||||||
} else {
|
} else {
|
||||||
@@ -334,6 +344,7 @@ watch(campaignId, (newVal) => {
|
|||||||
maps.value = [];
|
maps.value = [];
|
||||||
notesError.value = '';
|
notesError.value = '';
|
||||||
entriesError.value = '';
|
entriesError.value = '';
|
||||||
|
ClearAnchoredMap();
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -502,8 +513,11 @@ onBeforeUnmount(() => {
|
|||||||
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
<div v-if="loadingEntries" class="sidebar-state">{{ t('campaigns.states.loading') }}</div>
|
||||||
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
<div v-else-if="entriesError" class="sidebar-state error">{{ entriesError }}</div>
|
||||||
<div v-else-if="maps.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-maps') }}</div>
|
<div v-else-if="maps.length === 0" class="sidebar-state">{{ t('campaigns.states.empty-maps') }}</div>
|
||||||
<div v-for="map in maps" :key="map._id" class="entity-entry" role="button" tabindex="0" @click="openMapViewer(map)" @keydown.enter="openMapViewer(map)" @keydown.space.prevent="openMapViewer(map)" @contextmenu.prevent="showEntryMenu(map, 'map')">
|
<div v-for="map in maps" :key="map._id" class="entity-entry" :class="{ anchored: isAnchoredMap(map) }" role="button" tabindex="0" @click="openMapViewer(map)" @keydown.enter="openMapViewer(map)" @keydown.space.prevent="openMapViewer(map)" @contextmenu.prevent="showEntryMenu(map, 'map')">
|
||||||
<span class="entity-entry-name">{{ map.name }}</span>
|
<span class="entity-entry-name-row">
|
||||||
|
<span class="entity-entry-name">{{ map.name }}</span>
|
||||||
|
<span v-if="isAnchoredMap(map)" class="entity-entry-sync">{{ t('campaigns.map.anchored') }}</span>
|
||||||
|
</span>
|
||||||
<span class="entity-entry-meta">{{ mapSummary(map) }}</span>
|
<span class="entity-entry-meta">{{ mapSummary(map) }}</span>
|
||||||
<span v-if="!map.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span>
|
<span v-if="!map.image" class="entity-entry-description">{{ t('campaigns.map.no-image') }}</span>
|
||||||
</div>
|
</div>
|
||||||
@@ -654,6 +668,8 @@ onBeforeUnmount(() => {
|
|||||||
}
|
}
|
||||||
.entity-entry:hover { border-color: var(--color-border); background: var(--color-background-soft); }
|
.entity-entry:hover { border-color: var(--color-border); background: var(--color-background-soft); }
|
||||||
.entity-entry:focus-visible { outline: 1px solid var(--color-link); }
|
.entity-entry:focus-visible { outline: 1px solid var(--color-link); }
|
||||||
|
/* The map currently anchored on the note container. */
|
||||||
|
.entity-entry.anchored { border-color: var(--color-link); background: var(--color-background-soft); }
|
||||||
.entity-entry-name-row { display: flex; align-items: baseline; gap: 6px; }
|
.entity-entry-name-row { display: flex; align-items: baseline; gap: 6px; }
|
||||||
.entity-entry-name { font-weight: bold; }
|
.entity-entry-name { font-weight: bold; }
|
||||||
.entity-entry-sync {
|
.entity-entry-sync {
|
||||||
|
|||||||
@@ -1,13 +1,30 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
import NoteContainer from './NoteContainer.vue';
|
import NoteContainer from './NoteContainer.vue';
|
||||||
|
import MapViewerPane from '../map/MapViewerPane.vue';
|
||||||
|
|
||||||
|
import { ActivePane, AnchoredMap, ClearAnchoredMap } from '~/services/Content.js';
|
||||||
|
import { useCampaignService } from '~/services/Campaign.js';
|
||||||
|
import { CreateWindow } from '~/services/Windows';
|
||||||
|
|
||||||
|
const { Campaign } = useCampaignService();
|
||||||
|
|
||||||
|
// Detaching gives the map back a floating window and shows the open notes again.
|
||||||
|
function DetachMap() {
|
||||||
|
const map = AnchoredMap.value;
|
||||||
|
if (!map) return;
|
||||||
|
ClearAnchoredMap();
|
||||||
|
CreateWindow('map_viewer', { map, campaign: Campaign.value?._id ?? null });
|
||||||
|
}
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div class="content">
|
<div class="content">
|
||||||
<NoteContainer>
|
<NoteContainer v-show="ActivePane !== 'map'">
|
||||||
|
|
||||||
</NoteContainer>
|
</NoteContainer>
|
||||||
|
<div v-if="AnchoredMap" v-show="ActivePane === 'map'" class="anchored-map">
|
||||||
|
<MapViewerPane :map="AnchoredMap" anchored @detach="DetachMap"></MapViewerPane>
|
||||||
|
</div>
|
||||||
<!-- PowerMod -->
|
<!-- PowerMod -->
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
@@ -21,4 +38,14 @@ import NoteContainer from './NoteContainer.vue';
|
|||||||
align-items: center;
|
align-items: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/* Hidden with v-show so the open notes stay mounted while the anchored map is displayed. */
|
||||||
|
.anchored-map {
|
||||||
|
width: 100%;
|
||||||
|
height: 100%;
|
||||||
|
min-width: 0;
|
||||||
|
flex-grow: 1;
|
||||||
|
display: flex;
|
||||||
|
flex-direction: column;
|
||||||
|
}
|
||||||
|
|
||||||
</style>
|
</style>
|
||||||
@@ -2,6 +2,7 @@
|
|||||||
import { onMounted, onUnmounted, ref } from 'vue';
|
import { onMounted, onUnmounted, ref } from 'vue';
|
||||||
import Note from './Note.vue';
|
import Note from './Note.vue';
|
||||||
import { emitter } from '~/services/Emitter';
|
import { emitter } from '~/services/Emitter';
|
||||||
|
import { SetActivePane } from '~/services/Content.js';
|
||||||
|
|
||||||
let noteData = ref([]);
|
let noteData = ref([]);
|
||||||
|
|
||||||
@@ -34,6 +35,9 @@ function pushNote(note){
|
|||||||
}
|
}
|
||||||
|
|
||||||
function handlePushNote(note) {
|
function handlePushNote(note) {
|
||||||
|
// A note opened from the sidebar or the search palette always comes to the front, even when
|
||||||
|
// the content area is showing an anchored map.
|
||||||
|
SetActivePane('notes');
|
||||||
pushNote(note);
|
pushNote(note);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
233
frontend/app/components/viewer/map/MapViewerPane.vue
Normal file
233
frontend/app/components/viewer/map/MapViewerPane.vue
Normal file
@@ -0,0 +1,233 @@
|
|||||||
|
<script setup>
|
||||||
|
import { computed, onBeforeUnmount, onMounted, ref, watch } from 'vue';
|
||||||
|
import { CreateWindow } from '@/services/Windows';
|
||||||
|
import { getBaseUrl } from '~/services/Server';
|
||||||
|
import { emitter } from '~/services/Emitter';
|
||||||
|
import { useCampaignService } from '~/services/Campaign.js';
|
||||||
|
|
||||||
|
// The map viewer without window chrome: it fills whatever flex column holds it, so the same
|
||||||
|
// component works inside MapViewerWindow.vue and anchored on the campaign content area.
|
||||||
|
const props = defineProps({
|
||||||
|
map: { type: Object, default: null },
|
||||||
|
// Anchored maps can be detached into a floating window; the window itself does not offer it.
|
||||||
|
anchored: { type: Boolean, default: false }
|
||||||
|
});
|
||||||
|
const emit = defineEmits(['detach']);
|
||||||
|
|
||||||
|
const { Campaign } = useCampaignService();
|
||||||
|
const campaignId = computed(() => Campaign.value?._id ?? Campaign.value?.id ?? null);
|
||||||
|
|
||||||
|
const map = ref(props.map ? { ...props.map } : null);
|
||||||
|
const viewport = ref(null);
|
||||||
|
|
||||||
|
const zoom = ref(1);
|
||||||
|
const pan = ref({ x: 0, y: 0 });
|
||||||
|
const imageSize = ref({ width: 0, height: 0 });
|
||||||
|
const showGrid = ref(true);
|
||||||
|
const dragging = ref(false);
|
||||||
|
|
||||||
|
const minZoom = 0.05;
|
||||||
|
const maxZoom = 8;
|
||||||
|
|
||||||
|
const imageUrl = computed(() => {
|
||||||
|
const image = map.value?.image;
|
||||||
|
if (!image) return '';
|
||||||
|
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
|
||||||
|
});
|
||||||
|
|
||||||
|
const stageStyle = computed(() => ({
|
||||||
|
transform: `translate3d(${pan.value.x}px, ${pan.value.y}px, 0) scale(${zoom.value})`
|
||||||
|
}));
|
||||||
|
|
||||||
|
// The grid is drawn in screen space over the image so its lines stay one pixel wide at any zoom.
|
||||||
|
const gridStyle = computed(() => {
|
||||||
|
if (!showGrid.value || !imageSize.value.width) return { display: 'none' };
|
||||||
|
const cell = `${Math.max(1, Number(map.value?.gridSize) || 50) * zoom.value}px`;
|
||||||
|
return {
|
||||||
|
width: `${imageSize.value.width * zoom.value}px`,
|
||||||
|
height: `${imageSize.value.height * zoom.value}px`,
|
||||||
|
transform: `translate3d(${pan.value.x + (Number(map.value?.offsetX) || 0) * zoom.value}px, ${pan.value.y + (Number(map.value?.offsetY) || 0) * zoom.value}px, 0)`,
|
||||||
|
backgroundImage: `linear-gradient(to right, var(--color-link) 1px, transparent 1px), linear-gradient(to bottom, var(--color-link) 1px, transparent 1px)`,
|
||||||
|
backgroundSize: `${cell} ${cell}`
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
const zoomPercent = computed(() => `${Math.round(zoom.value * 100)}%`);
|
||||||
|
|
||||||
|
function clampZoom(value) {
|
||||||
|
if (!Number.isFinite(value)) return minZoom;
|
||||||
|
return Math.min(maxZoom, Math.max(minZoom, value));
|
||||||
|
}
|
||||||
|
|
||||||
|
function fitToWindow() {
|
||||||
|
const bounds = viewport.value?.getBoundingClientRect();
|
||||||
|
if (!bounds || !imageSize.value.width) return;
|
||||||
|
zoom.value = clampZoom(Math.min(bounds.width / imageSize.value.width, bounds.height / imageSize.value.height));
|
||||||
|
centerOn();
|
||||||
|
}
|
||||||
|
|
||||||
|
function centerOn() {
|
||||||
|
const bounds = viewport.value?.getBoundingClientRect();
|
||||||
|
if (!bounds || !imageSize.value.width) return;
|
||||||
|
pan.value = {
|
||||||
|
x: (bounds.width - imageSize.value.width * zoom.value) / 2,
|
||||||
|
y: (bounds.height - imageSize.value.height * zoom.value) / 2
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function onImageLoaded(event) {
|
||||||
|
imageSize.value = { width: event.target.naturalWidth, height: event.target.naturalHeight };
|
||||||
|
fitToWindow();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Zoom keeping the map point under `point` where it is.
|
||||||
|
function zoomAt(factor, point) {
|
||||||
|
const next = clampZoom(zoom.value * factor);
|
||||||
|
if (next === zoom.value) return;
|
||||||
|
const ratio = next / zoom.value;
|
||||||
|
pan.value = {
|
||||||
|
x: point.x - (point.x - pan.value.x) * ratio,
|
||||||
|
y: point.y - (point.y - pan.value.y) * ratio
|
||||||
|
};
|
||||||
|
zoom.value = next;
|
||||||
|
}
|
||||||
|
|
||||||
|
function onWheel(event) {
|
||||||
|
const bounds = viewport.value?.getBoundingClientRect();
|
||||||
|
if (!bounds) return;
|
||||||
|
zoomAt(event.deltaY < 0 ? 1.15 : 1 / 1.15, { x: event.clientX - bounds.left, y: event.clientY - bounds.top });
|
||||||
|
}
|
||||||
|
|
||||||
|
function zoomFromToolbar(incoming) {
|
||||||
|
const bounds = viewport.value?.getBoundingClientRect();
|
||||||
|
if (!bounds) return;
|
||||||
|
zoomAt(incoming ? 1.25 : 1 / 1.25, { x: bounds.width / 2, y: bounds.height / 2 });
|
||||||
|
}
|
||||||
|
|
||||||
|
let pointerId = null;
|
||||||
|
let lastPointer = { x: 0, y: 0 };
|
||||||
|
|
||||||
|
function onPointerDown(event) {
|
||||||
|
if (event.button !== 0 || !viewport.value) return;
|
||||||
|
dragging.value = true;
|
||||||
|
pointerId = event.pointerId;
|
||||||
|
lastPointer = { x: event.clientX, y: event.clientY };
|
||||||
|
viewport.value.setPointerCapture?.(event.pointerId);
|
||||||
|
}
|
||||||
|
|
||||||
|
function onPointerMove(event) {
|
||||||
|
if (!dragging.value || event.pointerId !== pointerId) return;
|
||||||
|
pan.value = { x: pan.value.x + (event.clientX - lastPointer.x), y: pan.value.y + (event.clientY - lastPointer.y) };
|
||||||
|
lastPointer = { x: event.clientX, y: event.clientY };
|
||||||
|
}
|
||||||
|
|
||||||
|
function onPointerUp(event) {
|
||||||
|
if (event.pointerId !== pointerId) return;
|
||||||
|
dragging.value = false;
|
||||||
|
pointerId = null;
|
||||||
|
viewport.value?.releasePointerCapture?.(event.pointerId);
|
||||||
|
}
|
||||||
|
|
||||||
|
function editMap() {
|
||||||
|
if (!map.value || !campaignId.value) return;
|
||||||
|
CreateWindow('create_map', { campaign: campaignId.value, entry: map.value });
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleMapUpdated({ entityType, entry }) {
|
||||||
|
if (entityType !== 'map' || entry?._id !== map.value?._id) return;
|
||||||
|
const imageChanged = entry.image !== map.value.image;
|
||||||
|
map.value = { ...entry };
|
||||||
|
// A new image is fitted again by onImageLoaded; grid-only changes just move the overlay.
|
||||||
|
if (imageChanged) imageSize.value = { width: 0, height: 0 };
|
||||||
|
}
|
||||||
|
|
||||||
|
// A different map was anchored while this pane was already mounted.
|
||||||
|
watch(() => props.map, (incoming, previous) => {
|
||||||
|
if (incoming === previous) return;
|
||||||
|
map.value = incoming ? { ...incoming } : null;
|
||||||
|
imageSize.value = { width: 0, height: 0 };
|
||||||
|
});
|
||||||
|
|
||||||
|
onMounted(() => {
|
||||||
|
emitter.on('campaign-entry-updated', handleMapUpdated);
|
||||||
|
});
|
||||||
|
|
||||||
|
onBeforeUnmount(() => {
|
||||||
|
emitter.off('campaign-entry-updated', handleMapUpdated);
|
||||||
|
});
|
||||||
|
</script>
|
||||||
|
|
||||||
|
<template>
|
||||||
|
<div class="map-pane">
|
||||||
|
<div class="viewer-bar">
|
||||||
|
<div class="viewer-identity">
|
||||||
|
<strong>{{ map?.name }}</strong>
|
||||||
|
<span class="viewer-meta">{{ $t('campaigns.map.summary', { size: map?.gridSize, scale: map?.scale }) }}</span>
|
||||||
|
</div>
|
||||||
|
<div class="viewer-tools">
|
||||||
|
<button class="viewer-tool" :class="{ selected: showGrid }" type="button" :title="$t('campaigns.map.toggle-grid')"
|
||||||
|
:aria-label="$t('campaigns.map.toggle-grid')" :aria-pressed="showGrid.toString()" @click="showGrid = !showGrid">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/view-grid.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-out')" :aria-label="$t('campaigns.map.zoom-out')" @click="zoomFromToolbar(false)">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/minus.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<span class="zoom-readout">{{ zoomPercent }}</span>
|
||||||
|
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-in')" :aria-label="$t('campaigns.map.zoom-in')" @click="zoomFromToolbar(true)">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<button class="viewer-tool" type="button" :title="$t('campaigns.map.fit')" :aria-label="$t('campaigns.map.fit')" @click="fitToWindow">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/expand.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<button class="viewer-tool" type="button" :title="$t('campaigns.map.edit')" :aria-label="$t('campaigns.map.edit')" @click="editMap">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/edit.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
<button v-if="anchored" class="viewer-tool" type="button" :title="$t('campaigns.map.open-window')" :aria-label="$t('campaigns.map.open-window')"
|
||||||
|
@click="emit('detach')">
|
||||||
|
<img class="tool-icon" src="/icons/iconoir/regular/open-in-window.svg" alt="" aria-hidden="true">
|
||||||
|
</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div
|
||||||
|
ref="viewport"
|
||||||
|
class="map-viewport"
|
||||||
|
:class="{ dragging }"
|
||||||
|
@wheel.prevent="onWheel"
|
||||||
|
@pointerdown="onPointerDown"
|
||||||
|
@pointermove="onPointerMove"
|
||||||
|
@pointerup="onPointerUp"
|
||||||
|
@pointercancel="onPointerUp"
|
||||||
|
>
|
||||||
|
<template v-if="imageUrl">
|
||||||
|
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
|
||||||
|
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
|
||||||
|
</template>
|
||||||
|
<div v-else class="map-empty">
|
||||||
|
{{ $t('campaigns.map.no-image') }}
|
||||||
|
<button class="map-edit" type="button" @click="editMap">{{ $t('campaigns.map.upload-photo') }}</button>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</template>
|
||||||
|
|
||||||
|
<style scoped>
|
||||||
|
.map-pane { width: 100%; flex: 1; min-width: 0; min-height: 0; display: flex; flex-direction: column; overflow: hidden; }
|
||||||
|
.viewer-bar { width: 100%; box-sizing: border-box; display: flex; align-items: center; justify-content: space-between; gap: 10px; padding: 8px 10px; border-bottom: 1px solid var(--color-border); background: var(--color-background-light); }
|
||||||
|
.viewer-identity { min-width: 0; display: flex; flex-direction: column; gap: 2px; }
|
||||||
|
.viewer-identity strong { font-family: MrEavesRemake; overflow-wrap: anywhere; }
|
||||||
|
.viewer-meta { font-size: 11px; opacity: .72; }
|
||||||
|
.viewer-tools { display: flex; align-items: center; gap: 4px; }
|
||||||
|
.viewer-tool { width: 30px; height: 30px; margin: 0; padding: 0; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); display: flex; align-items: center; justify-content: center; cursor: pointer; }
|
||||||
|
.viewer-tool:hover { background: var(--color-button-hover); }
|
||||||
|
.viewer-tool.selected { border-color: var(--color-link); background: var(--color-button-hover); }
|
||||||
|
.tool-icon { width: 16px; height: 16px; filter: invert(var(--color-icon-invert)); }
|
||||||
|
.zoom-readout { min-width: 46px; text-align: center; font-size: 12px; }
|
||||||
|
.map-viewport { position: relative; width: 100%; flex: 1; min-height: 0; overflow: hidden; background-color: var(--color-background); cursor: grab; touch-action: none; }
|
||||||
|
.map-viewport.dragging { cursor: grabbing; }
|
||||||
|
.map-image { position: absolute; top: 0; left: 0; max-width: none; transform-origin: top left; user-select: none; }
|
||||||
|
.map-grid { position: absolute; top: 0; left: 0; opacity: .55; pointer-events: none; }
|
||||||
|
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
|
||||||
|
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
|
||||||
|
.map-edit:hover { background: var(--color-button-hover); }
|
||||||
|
</style>
|
||||||
@@ -129,7 +129,8 @@ async function saveMap() {
|
|||||||
</label>
|
</label>
|
||||||
<label class="form-field">
|
<label class="form-field">
|
||||||
<span>{{ $t('campaigns.map.scale') }}</span>
|
<span>{{ $t('campaigns.map.scale') }}</span>
|
||||||
<input v-model.number="form.scale" type="number" min="0.01" step="0.5">
|
<!-- step="any": any decimal works, the 0.01 minimum alone keeps it positive -->
|
||||||
|
<input v-model.number="form.scale" type="number" min="0.01" step="any" inputmode="decimal">
|
||||||
</label>
|
</label>
|
||||||
<label class="form-field">
|
<label class="form-field">
|
||||||
<span>{{ $t('campaigns.map.offset-x') }}</span>
|
<span>{{ $t('campaigns.map.offset-x') }}</span>
|
||||||
@@ -154,7 +155,16 @@ async function saveMap() {
|
|||||||
|
|
||||||
<style scoped>
|
<style scoped>
|
||||||
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
|
.window-wrapper { display: flex; align-items: center; flex-direction: column; }
|
||||||
.body { width: 100%; padding: 10px 18px 16px; overflow-y: auto; }
|
/* Stretch so the outer margin insets the content instead of overflowing the window. */
|
||||||
|
.body {
|
||||||
|
flex: 1;
|
||||||
|
min-height: 0;
|
||||||
|
align-self: stretch;
|
||||||
|
box-sizing: border-box;
|
||||||
|
margin: 10px;
|
||||||
|
padding: 8px;
|
||||||
|
overflow-y: auto;
|
||||||
|
}
|
||||||
h3 { margin: 0 0 12px; font-family: MrEavesRemake; }
|
h3 { margin: 0 0 12px; font-family: MrEavesRemake; }
|
||||||
form { display: flex; flex-direction: column; gap: 10px; }
|
form { display: flex; flex-direction: column; gap: 10px; }
|
||||||
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }
|
.form-field { min-width: 0; display: flex; flex-direction: column; gap: 4px; font-size: 13px; }
|
||||||
|
|||||||
@@ -1,139 +1,14 @@
|
|||||||
<script setup>
|
<script setup>
|
||||||
import { computed, onBeforeUnmount, onMounted, ref } from 'vue';
|
import { onMounted, ref } from 'vue';
|
||||||
import { SetupHandle, SetSize, ResetPosition, ClearWindow, Top, CreateWindow } from '@/services/Windows';
|
import { SetupHandle, SetSize, ResetPosition, Top } from '@/services/Windows';
|
||||||
import WindowHandle from './partials/WindowHandle.vue';
|
import WindowHandle from './partials/WindowHandle.vue';
|
||||||
import { getBaseUrl } from '~/services/Server';
|
import MapViewerPane from '../viewer/map/MapViewerPane.vue';
|
||||||
import { emitter } from '~/services/Emitter';
|
|
||||||
|
|
||||||
const props = defineProps(['data']);
|
const props = defineProps(['data']);
|
||||||
const id = props.data.id;
|
const id = props.data.id;
|
||||||
const campaignId = props.data.campaign;
|
|
||||||
const handle = ref(null);
|
const handle = ref(null);
|
||||||
const wrapper = ref(null);
|
const wrapper = ref(null);
|
||||||
|
const map = props.data.map ? { ...props.data.map } : null;
|
||||||
const map = ref(props.data.map ? { ...props.data.map } : null);
|
|
||||||
const viewport = ref(null);
|
|
||||||
|
|
||||||
const zoom = ref(1);
|
|
||||||
const pan = ref({ x: 0, y: 0 });
|
|
||||||
const imageSize = ref({ width: 0, height: 0 });
|
|
||||||
const showGrid = ref(true);
|
|
||||||
const dragging = ref(false);
|
|
||||||
|
|
||||||
const minZoom = 0.05;
|
|
||||||
const maxZoom = 8;
|
|
||||||
|
|
||||||
const imageUrl = computed(() => {
|
|
||||||
const image = map.value?.image;
|
|
||||||
if (!image) return '';
|
|
||||||
return /^(https?:|data:|\/\/)/i.test(image) ? image : `${getBaseUrl()}/public/${image}`;
|
|
||||||
});
|
|
||||||
|
|
||||||
const stageStyle = computed(() => ({
|
|
||||||
transform: `translate3d(${pan.value.x}px, ${pan.value.y}px, 0) scale(${zoom.value})`
|
|
||||||
}));
|
|
||||||
|
|
||||||
// The grid is drawn in screen space over the image so its lines stay one pixel wide at any zoom.
|
|
||||||
const gridStyle = computed(() => {
|
|
||||||
if (!showGrid.value || !imageSize.value.width) return { display: 'none' };
|
|
||||||
const cell = `${Math.max(1, Number(map.value?.gridSize) || 50) * zoom.value}px`;
|
|
||||||
return {
|
|
||||||
width: `${imageSize.value.width * zoom.value}px`,
|
|
||||||
height: `${imageSize.value.height * zoom.value}px`,
|
|
||||||
transform: `translate3d(${pan.value.x + (Number(map.value?.offsetX) || 0) * zoom.value}px, ${pan.value.y + (Number(map.value?.offsetY) || 0) * zoom.value}px, 0)`,
|
|
||||||
backgroundImage: `linear-gradient(to right, var(--color-link) 1px, transparent 1px), linear-gradient(to bottom, var(--color-link) 1px, transparent 1px)`,
|
|
||||||
backgroundSize: `${cell} ${cell}`
|
|
||||||
};
|
|
||||||
});
|
|
||||||
|
|
||||||
const zoomPercent = computed(() => `${Math.round(zoom.value * 100)}%`);
|
|
||||||
|
|
||||||
function clampZoom(value) {
|
|
||||||
if (!Number.isFinite(value)) return minZoom;
|
|
||||||
return Math.min(maxZoom, Math.max(minZoom, value));
|
|
||||||
}
|
|
||||||
|
|
||||||
function fitToWindow() {
|
|
||||||
const bounds = viewport.value?.getBoundingClientRect();
|
|
||||||
if (!bounds || !imageSize.value.width) return;
|
|
||||||
zoom.value = clampZoom(Math.min(bounds.width / imageSize.value.width, bounds.height / imageSize.value.height));
|
|
||||||
centerOn();
|
|
||||||
}
|
|
||||||
|
|
||||||
function centerOn() {
|
|
||||||
const bounds = viewport.value?.getBoundingClientRect();
|
|
||||||
if (!bounds || !imageSize.value.width) return;
|
|
||||||
pan.value = {
|
|
||||||
x: (bounds.width - imageSize.value.width * zoom.value) / 2,
|
|
||||||
y: (bounds.height - imageSize.value.height * zoom.value) / 2
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
function onImageLoaded(event) {
|
|
||||||
imageSize.value = { width: event.target.naturalWidth, height: event.target.naturalHeight };
|
|
||||||
fitToWindow();
|
|
||||||
}
|
|
||||||
|
|
||||||
// Zoom keeping the map point under `point` where it is.
|
|
||||||
function zoomAt(factor, point) {
|
|
||||||
const next = clampZoom(zoom.value * factor);
|
|
||||||
if (next === zoom.value) return;
|
|
||||||
const ratio = next / zoom.value;
|
|
||||||
pan.value = {
|
|
||||||
x: point.x - (point.x - pan.value.x) * ratio,
|
|
||||||
y: point.y - (point.y - pan.value.y) * ratio
|
|
||||||
};
|
|
||||||
zoom.value = next;
|
|
||||||
}
|
|
||||||
|
|
||||||
function onWheel(event) {
|
|
||||||
const bounds = viewport.value?.getBoundingClientRect();
|
|
||||||
if (!bounds) return;
|
|
||||||
zoomAt(event.deltaY < 0 ? 1.15 : 1 / 1.15, { x: event.clientX - bounds.left, y: event.clientY - bounds.top });
|
|
||||||
}
|
|
||||||
|
|
||||||
function zoomFromToolbar(incoming) {
|
|
||||||
const bounds = viewport.value?.getBoundingClientRect();
|
|
||||||
if (!bounds) return;
|
|
||||||
zoomAt(incoming ? 1.25 : 1 / 1.25, { x: bounds.width / 2, y: bounds.height / 2 });
|
|
||||||
}
|
|
||||||
|
|
||||||
let pointerId = null;
|
|
||||||
let lastPointer = { x: 0, y: 0 };
|
|
||||||
|
|
||||||
function onPointerDown(event) {
|
|
||||||
if (event.button !== 0 || !viewport.value) return;
|
|
||||||
dragging.value = true;
|
|
||||||
pointerId = event.pointerId;
|
|
||||||
lastPointer = { x: event.clientX, y: event.clientY };
|
|
||||||
viewport.value.setPointerCapture?.(event.pointerId);
|
|
||||||
}
|
|
||||||
|
|
||||||
function onPointerMove(event) {
|
|
||||||
if (!dragging.value || event.pointerId !== pointerId) return;
|
|
||||||
pan.value = { x: pan.value.x + (event.clientX - lastPointer.x), y: pan.value.y + (event.clientY - lastPointer.y) };
|
|
||||||
lastPointer = { x: event.clientX, y: event.clientY };
|
|
||||||
}
|
|
||||||
|
|
||||||
function onPointerUp(event) {
|
|
||||||
if (event.pointerId !== pointerId) return;
|
|
||||||
dragging.value = false;
|
|
||||||
pointerId = null;
|
|
||||||
viewport.value?.releasePointerCapture?.(event.pointerId);
|
|
||||||
}
|
|
||||||
|
|
||||||
function editMap() {
|
|
||||||
if (!map.value) return;
|
|
||||||
CreateWindow('create_map', { campaign: campaignId, entry: map.value });
|
|
||||||
}
|
|
||||||
|
|
||||||
function handleMapUpdated({ entityType, entry }) {
|
|
||||||
if (entityType !== 'map' || entry?._id !== map.value?._id) return;
|
|
||||||
const imageChanged = entry.image !== map.value.image;
|
|
||||||
map.value = { ...entry };
|
|
||||||
// A new image is fitted again by onImageLoaded; grid-only changes just move the overlay.
|
|
||||||
if (imageChanged) imageSize.value = { width: 0, height: 0 };
|
|
||||||
}
|
|
||||||
|
|
||||||
onMounted(() => {
|
onMounted(() => {
|
||||||
Top(wrapper);
|
Top(wrapper);
|
||||||
@@ -143,82 +18,16 @@ onMounted(() => {
|
|||||||
height: Math.max(360, Math.min(760, window.innerHeight - 32))
|
height: Math.max(360, Math.min(760, window.innerHeight - 32))
|
||||||
});
|
});
|
||||||
ResetPosition(id, 'center');
|
ResetPosition(id, 'center');
|
||||||
emitter.on('campaign-entry-updated', handleMapUpdated);
|
|
||||||
});
|
|
||||||
|
|
||||||
onBeforeUnmount(() => {
|
|
||||||
emitter.off('campaign-entry-updated', handleMapUpdated);
|
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<div class="window-wrapper viewer-window" :id="'window-wrapper-' + id" ref="wrapper">
|
<div class="window-wrapper viewer-window" :id="'window-wrapper-' + id" ref="wrapper">
|
||||||
<WindowHandle :window="id" ref="handle" />
|
<WindowHandle :window="id" ref="handle" />
|
||||||
<div class="viewer-bar">
|
<MapViewerPane :map="map" />
|
||||||
<div class="viewer-identity">
|
|
||||||
<strong>{{ map?.name }}</strong>
|
|
||||||
<span class="viewer-meta">{{ $t('campaigns.map.summary', { size: map?.gridSize, scale: map?.scale }) }}</span>
|
|
||||||
</div>
|
|
||||||
<div class="viewer-tools">
|
|
||||||
<button class="viewer-tool" :class="{ selected: showGrid }" type="button" :title="$t('campaigns.map.toggle-grid')"
|
|
||||||
:aria-label="$t('campaigns.map.toggle-grid')" :aria-pressed="showGrid.toString()" @click="showGrid = !showGrid">
|
|
||||||
<img class="tool-icon" src="/icons/iconoir/regular/view-grid.svg" alt="" aria-hidden="true">
|
|
||||||
</button>
|
|
||||||
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-out')" :aria-label="$t('campaigns.map.zoom-out')" @click="zoomFromToolbar(false)">
|
|
||||||
<img class="tool-icon" src="/icons/iconoir/regular/minus.svg" alt="" aria-hidden="true">
|
|
||||||
</button>
|
|
||||||
<span class="zoom-readout">{{ zoomPercent }}</span>
|
|
||||||
<button class="viewer-tool" type="button" :title="$t('campaigns.map.zoom-in')" :aria-label="$t('campaigns.map.zoom-in')" @click="zoomFromToolbar(true)">
|
|
||||||
<img class="tool-icon" src="/icons/iconoir/regular/plus.svg" alt="" aria-hidden="true">
|
|
||||||
</button>
|
|
||||||
<button class="viewer-tool" type="button" :title="$t('campaigns.map.fit')" :aria-label="$t('campaigns.map.fit')" @click="fitToWindow">
|
|
||||||
<img class="tool-icon" src="/icons/iconoir/regular/expand.svg" alt="" aria-hidden="true">
|
|
||||||
</button>
|
|
||||||
<button class="viewer-tool" type="button" :title="$t('campaigns.map.edit')" :aria-label="$t('campaigns.map.edit')" @click="editMap">
|
|
||||||
<img class="tool-icon" src="/icons/iconoir/regular/edit.svg" alt="" aria-hidden="true">
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div
|
|
||||||
ref="viewport"
|
|
||||||
class="map-viewport"
|
|
||||||
:class="{ dragging }"
|
|
||||||
@wheel.prevent="onWheel"
|
|
||||||
@pointerdown="onPointerDown"
|
|
||||||
@pointermove="onPointerMove"
|
|
||||||
@pointerup="onPointerUp"
|
|
||||||
@pointercancel="onPointerUp"
|
|
||||||
>
|
|
||||||
<template v-if="imageUrl">
|
|
||||||
<img class="map-image" :src="imageUrl" :style="stageStyle" :alt="map?.name" draggable="false" @load="onImageLoaded">
|
|
||||||
<div class="map-grid" :style="gridStyle" aria-hidden="true"></div>
|
|
||||||
</template>
|
|
||||||
<div v-else class="map-empty">
|
|
||||||
{{ $t('campaigns.map.no-image') }}
|
|
||||||
<button class="map-edit" type="button" @click="editMap">{{ $t('campaigns.map.upload-photo') }}</button>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</template>
|
</template>
|
||||||
|
|
||||||
<style scoped>
|
<style scoped>
|
||||||
.viewer-window { min-width: 320px; min-height: 0; }
|
.viewer-window { min-width: 320px; min-height: 0; }
|
||||||
.viewer-bar { width: 100%; box-sizing: border-box; display: flex; align-items: center; justify-content: space-between; gap: 10px; padding: 8px 10px; border-bottom: 1px solid var(--color-border); background: var(--color-background-light); }
|
|
||||||
.viewer-identity { min-width: 0; display: flex; flex-direction: column; gap: 2px; }
|
|
||||||
.viewer-identity strong { font-family: MrEavesRemake; overflow-wrap: anywhere; }
|
|
||||||
.viewer-meta { font-size: 11px; opacity: .72; }
|
|
||||||
.viewer-tools { display: flex; align-items: center; gap: 4px; }
|
|
||||||
.viewer-tool { width: 30px; height: 30px; margin: 0; padding: 0; border: 1px solid var(--color-border); border-radius: 7px; background: var(--color-background-soft); display: flex; align-items: center; justify-content: center; cursor: pointer; }
|
|
||||||
.viewer-tool:hover { background: var(--color-button-hover); }
|
|
||||||
.viewer-tool.selected { border-color: var(--color-link); background: var(--color-button-hover); }
|
|
||||||
.tool-icon { width: 16px; height: 16px; filter: invert(var(--color-icon-invert)); }
|
|
||||||
.zoom-readout { min-width: 46px; text-align: center; font-size: 12px; }
|
|
||||||
.map-viewport { position: relative; width: 100%; flex: 1; min-height: 0; overflow: hidden; background-color: var(--color-background); cursor: grab; touch-action: none; }
|
|
||||||
.map-viewport.dragging { cursor: grabbing; }
|
|
||||||
.map-image { position: absolute; top: 0; left: 0; max-width: none; transform-origin: top left; user-select: none; }
|
|
||||||
.map-grid { position: absolute; top: 0; left: 0; opacity: .55; pointer-events: none; }
|
|
||||||
.map-empty { width: 100%; height: 100%; display: flex; flex-direction: column; align-items: center; justify-content: center; gap: 8px; font-size: 13px; opacity: .8; }
|
|
||||||
.map-edit { border: 1px solid var(--color-border); border-radius: 7px; padding: 6px 11px; background: var(--color-background-soft); color: var(--color-text); font-size: 12px; cursor: pointer; }
|
|
||||||
.map-edit:hover { background: var(--color-button-hover); }
|
|
||||||
</style>
|
</style>
|
||||||
|
|||||||
@@ -2,11 +2,38 @@ import { ref } from 'vue';
|
|||||||
|
|
||||||
const ShowContent = ref(false);
|
const ShowContent = ref(false);
|
||||||
|
|
||||||
|
// What the campaign workspace shows where the notes live: the open notes, or the map the
|
||||||
|
// sidebar anchored on the note container. 'notes' | 'map'
|
||||||
|
const ActivePane = ref('notes');
|
||||||
|
|
||||||
|
// The map anchored on the note container (a campaign entry of the sidebar's maps section).
|
||||||
|
const AnchoredMap = ref(null);
|
||||||
|
|
||||||
function SetShowContent(value) {
|
function SetShowContent(value) {
|
||||||
ShowContent.value = value;
|
ShowContent.value = value;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function SetActivePane(value) {
|
||||||
|
ActivePane.value = value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Anchoring shows the map where the open notes are; they stay open and come back on 'notes'.
|
||||||
|
function AnchorMap(map) {
|
||||||
|
AnchoredMap.value = map ?? null;
|
||||||
|
ActivePane.value = AnchoredMap.value ? 'map' : 'notes';
|
||||||
|
}
|
||||||
|
|
||||||
|
function ClearAnchoredMap() {
|
||||||
|
AnchoredMap.value = null;
|
||||||
|
if (ActivePane.value === 'map') ActivePane.value = 'notes';
|
||||||
|
}
|
||||||
|
|
||||||
export {
|
export {
|
||||||
ShowContent,
|
ShowContent,
|
||||||
SetShowContent
|
SetShowContent,
|
||||||
|
ActivePane,
|
||||||
|
AnchoredMap,
|
||||||
|
SetActivePane,
|
||||||
|
AnchorMap,
|
||||||
|
ClearAnchoredMap
|
||||||
}
|
}
|
||||||
@@ -68,7 +68,8 @@
|
|||||||
"summary": "Quadrícula de {size} px · {scale} per cel·la",
|
"summary": "Quadrícula de {size} px · {scale} per cel·la",
|
||||||
"save-error": "No s'ha pogut desar aquest mapa.",
|
"save-error": "No s'ha pogut desar aquest mapa.",
|
||||||
"no-image": "Aquest mapa encara no té imatge.",
|
"no-image": "Aquest mapa encara no té imatge.",
|
||||||
"zoom-in": "Apropar", "zoom-out": "Allunyar", "fit": "Ajustar a la finestra", "toggle-grid": "Mostrar la quadrícula"
|
"zoom-in": "Apropar", "zoom-out": "Allunyar", "fit": "Ajustar a la finestra", "toggle-grid": "Mostrar la quadrícula",
|
||||||
|
"open-window": "Obre en una finestra", "anchored": "Ancorat"
|
||||||
},
|
},
|
||||||
"character-sheet": {
|
"character-sheet": {
|
||||||
"title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir",
|
"title": "Fitxa de personatge", "name": "Nom del personatge", "class": "Classe", "subclass": "Subclasse", "unset-class": "Classe sense definir",
|
||||||
|
|||||||
@@ -72,7 +72,8 @@
|
|||||||
"summary": "{size} px grid · {scale} per cell",
|
"summary": "{size} px grid · {scale} per cell",
|
||||||
"save-error": "Unable to save this map.",
|
"save-error": "Unable to save this map.",
|
||||||
"no-image": "This map has no image yet.",
|
"no-image": "This map has no image yet.",
|
||||||
"zoom-in": "Zoom in", "zoom-out": "Zoom out", "fit": "Fit to window", "toggle-grid": "Show grid"
|
"zoom-in": "Zoom in", "zoom-out": "Zoom out", "fit": "Fit to window", "toggle-grid": "Show grid",
|
||||||
|
"open-window": "Open in window", "anchored": "Anchored"
|
||||||
},
|
},
|
||||||
"character-sheet": {
|
"character-sheet": {
|
||||||
"title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set",
|
"title": "Character Sheet", "name": "Character name", "class": "Class", "subclass": "Subclass", "unset-class": "Class not set",
|
||||||
|
|||||||
@@ -68,7 +68,8 @@
|
|||||||
"summary": "Cuadrícula de {size} px · {scale} por celda",
|
"summary": "Cuadrícula de {size} px · {scale} por celda",
|
||||||
"save-error": "No se pudo guardar este mapa.",
|
"save-error": "No se pudo guardar este mapa.",
|
||||||
"no-image": "Este mapa aún no tiene imagen.",
|
"no-image": "Este mapa aún no tiene imagen.",
|
||||||
"zoom-in": "Acercar", "zoom-out": "Alejar", "fit": "Ajustar a la ventana", "toggle-grid": "Mostrar cuadrícula"
|
"zoom-in": "Acercar", "zoom-out": "Alejar", "fit": "Ajustar a la ventana", "toggle-grid": "Mostrar cuadrícula",
|
||||||
|
"open-window": "Abrir en una ventana", "anchored": "Anclado"
|
||||||
},
|
},
|
||||||
"character-sheet": {
|
"character-sheet": {
|
||||||
"title": "Hoja de personaje", "name": "Nombre del personaje", "class": "Clase", "subclass": "Subclase", "unset-class": "Clase sin definir",
|
"title": "Hoja de personaje", "name": "Nombre del personaje", "class": "Clase", "subclass": "Subclase", "unset-class": "Clase sin definir",
|
||||||
|
|||||||
43
obsidian-plugin/README.md
Normal file
43
obsidian-plugin/README.md
Normal file
@@ -0,0 +1,43 @@
|
|||||||
|
# Dragonroll Sync for Obsidian
|
||||||
|
|
||||||
|
An Obsidian community plugin that imports notes from a Dragonroll campaign and pushes the active
|
||||||
|
Markdown note back to Dragonroll.
|
||||||
|
|
||||||
|
## Install from this repository
|
||||||
|
|
||||||
|
Copy `main.js` and `manifest.json` into:
|
||||||
|
|
||||||
|
```text
|
||||||
|
<vault>/.obsidian/plugins/dragonroll-sync/
|
||||||
|
```
|
||||||
|
|
||||||
|
Then enable **Dragonroll Sync** in Obsidian's Community Plugins settings. The plugin is plain
|
||||||
|
JavaScript and does not need a build step.
|
||||||
|
|
||||||
|
## Connect your account
|
||||||
|
|
||||||
|
Open **Settings → Community plugins → Dragonroll Sync**, enter the Dragonroll API URL and sign in
|
||||||
|
with your Dragonroll username/email and password. The default API URL is
|
||||||
|
`https://dragonroll.aranroig.com/api`; a local server can use `http://localhost:5000/api`.
|
||||||
|
Choose a campaign after signing in. The plugin saves the Dragonroll session token in this vault;
|
||||||
|
Dragonroll sessions expire after 48 hours. The password is not saved.
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
- **Import or refresh campaign notes** fetches all campaign notes, including notes inside nested
|
||||||
|
Dragonroll folders, into `Dragonroll/<Campaign>/`. Imported notes keep their folder hierarchy.
|
||||||
|
- **Push active note to Dragonroll** creates the active Markdown note as a root campaign note, or
|
||||||
|
updates its linked Dragonroll note. A note linked to a different campaign cannot be pushed while
|
||||||
|
another campaign is selected.
|
||||||
|
|
||||||
|
The import command adds `dragonrollId`, `dragonrollCampaign`, and `dragonrollTitle` properties to
|
||||||
|
each imported note's frontmatter. These properties link the local file to its remote record and are
|
||||||
|
omitted from the Markdown content sent back to Dragonroll. Pushing a new local note adds those
|
||||||
|
properties as well.
|
||||||
|
|
||||||
|
Import protects local edits. It updates a linked note only when the local copy still matches the
|
||||||
|
last imported/pushed version. If the local copy changed, or both copies changed since the last sync,
|
||||||
|
the plugin keeps the local file and reports it for review. Push is explicit and updates Dragonroll
|
||||||
|
with the active note's current title and content.
|
||||||
|
|
||||||
|
This is an explicit import/push workflow; it does not sync in the background or delete notes.
|
||||||
497
obsidian-plugin/main.js
Normal file
497
obsidian-plugin/main.js
Normal file
@@ -0,0 +1,497 @@
|
|||||||
|
const {
|
||||||
|
Notice,
|
||||||
|
Plugin,
|
||||||
|
PluginSettingTab,
|
||||||
|
Setting,
|
||||||
|
normalizePath,
|
||||||
|
requestUrl,
|
||||||
|
} = require('obsidian');
|
||||||
|
|
||||||
|
const DEFAULT_SETTINGS = {
|
||||||
|
apiBaseUrl: 'https://dragonroll.aranroig.com/api',
|
||||||
|
token: '',
|
||||||
|
campaignId: '',
|
||||||
|
snapshots: {},
|
||||||
|
};
|
||||||
|
|
||||||
|
const NOTE_ID_PROPERTY = 'dragonrollId';
|
||||||
|
const CAMPAIGN_PROPERTY = 'dragonrollCampaign';
|
||||||
|
const REMOTE_TITLE_PROPERTY = 'dragonrollTitle';
|
||||||
|
|
||||||
|
module.exports = class DragonrollSyncPlugin extends Plugin {
|
||||||
|
async onload() {
|
||||||
|
await this.loadSettings();
|
||||||
|
|
||||||
|
this.status = this.addStatusBarItem();
|
||||||
|
this.updateStatus();
|
||||||
|
this.addRibbonIcon('refresh-cw', 'Import Dragonroll campaign notes', () => this.importCampaignNotes());
|
||||||
|
this.addCommand({
|
||||||
|
id: 'import-campaign-notes',
|
||||||
|
name: 'Import or refresh campaign notes',
|
||||||
|
callback: () => this.importCampaignNotes(),
|
||||||
|
});
|
||||||
|
this.addCommand({
|
||||||
|
id: 'push-active-note',
|
||||||
|
name: 'Push active note to Dragonroll',
|
||||||
|
checkCallback: (checking) => {
|
||||||
|
const file = this.app.workspace.getActiveFile();
|
||||||
|
if (!file || file.extension !== 'md') return false;
|
||||||
|
if (!checking) void this.pushActiveNote();
|
||||||
|
return true;
|
||||||
|
},
|
||||||
|
});
|
||||||
|
this.addSettingTab(new DragonrollSettingTab(this.app, this));
|
||||||
|
|
||||||
|
if (this.settings.token && this.settings.campaignId) {
|
||||||
|
this.status.setText('Dragonroll: ready');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async loadSettings() {
|
||||||
|
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
|
||||||
|
if (!this.settings.snapshots || typeof this.settings.snapshots !== 'object') {
|
||||||
|
this.settings.snapshots = {};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async saveSettings() {
|
||||||
|
await this.saveData(this.settings);
|
||||||
|
this.updateStatus();
|
||||||
|
}
|
||||||
|
|
||||||
|
updateStatus() {
|
||||||
|
if (!this.status) return;
|
||||||
|
if (!this.settings.token) this.status.setText('Dragonroll: signed out');
|
||||||
|
else if (!this.settings.campaignId) this.status.setText('Dragonroll: choose campaign');
|
||||||
|
else this.status.setText('Dragonroll: ready');
|
||||||
|
}
|
||||||
|
|
||||||
|
apiBaseUrl() {
|
||||||
|
let url = String(this.settings.apiBaseUrl || '').trim().replace(/\/+$/, '');
|
||||||
|
if (!url) throw new Error('Enter the Dragonroll API URL in settings.');
|
||||||
|
if (!/\/api$/i.test(url)) url += '/api';
|
||||||
|
return url;
|
||||||
|
}
|
||||||
|
|
||||||
|
async request(path, { method = 'GET', body, authenticated = true } = {}) {
|
||||||
|
const headers = { Accept: 'application/json' };
|
||||||
|
if (authenticated && this.settings.token) {
|
||||||
|
headers.Authorization = `Bearer ${this.settings.token}`;
|
||||||
|
}
|
||||||
|
if (body !== undefined) headers['Content-Type'] = 'application/json';
|
||||||
|
|
||||||
|
let response;
|
||||||
|
try {
|
||||||
|
response = await requestUrl({
|
||||||
|
url: `${this.apiBaseUrl()}${path}`,
|
||||||
|
method,
|
||||||
|
headers,
|
||||||
|
body: body === undefined ? undefined : JSON.stringify(body),
|
||||||
|
throw: false,
|
||||||
|
});
|
||||||
|
} catch (error) {
|
||||||
|
throw new Error(`Could not reach Dragonroll: ${error.message || error}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
let data;
|
||||||
|
try {
|
||||||
|
data = response.json;
|
||||||
|
} catch {
|
||||||
|
throw new Error(`Dragonroll returned an unreadable response (HTTP ${response.status}).`);
|
||||||
|
}
|
||||||
|
if (response.status < 200 || response.status >= 300 || data?.status !== 'ok') {
|
||||||
|
const message = data?.msg || `HTTP ${response.status}`;
|
||||||
|
if (response.status === 401 || message === 'unauthorized') {
|
||||||
|
throw new Error('Dragonroll rejected this session. Sign in again in plugin settings.');
|
||||||
|
}
|
||||||
|
throw new Error(`Dragonroll: ${message}`);
|
||||||
|
}
|
||||||
|
return data;
|
||||||
|
}
|
||||||
|
|
||||||
|
async login(usermail, password) {
|
||||||
|
const data = await this.request('/user/login', {
|
||||||
|
method: 'POST',
|
||||||
|
body: { usermail, password },
|
||||||
|
authenticated: false,
|
||||||
|
});
|
||||||
|
this.settings.token = data.token;
|
||||||
|
this.settings.campaignId = '';
|
||||||
|
await this.saveSettings();
|
||||||
|
return this.getCampaigns();
|
||||||
|
}
|
||||||
|
|
||||||
|
async getCampaigns() {
|
||||||
|
const data = await this.request('/campaign/list');
|
||||||
|
return data.campaigns || [];
|
||||||
|
}
|
||||||
|
|
||||||
|
async selectedCampaign() {
|
||||||
|
if (!this.settings.token) throw new Error('Sign in to Dragonroll in plugin settings first.');
|
||||||
|
if (!this.settings.campaignId) throw new Error('Choose a campaign in plugin settings first.');
|
||||||
|
const campaigns = await this.getCampaigns();
|
||||||
|
const campaign = campaigns.find((item) => String(item._id) === String(this.settings.campaignId));
|
||||||
|
if (!campaign) throw new Error('The selected campaign is unavailable. Choose a campaign in settings.');
|
||||||
|
return campaign;
|
||||||
|
}
|
||||||
|
|
||||||
|
async fetchCampaignNotes(campaignId) {
|
||||||
|
const root = await this.request(`/note/list?campaign=${encodeURIComponent(campaignId)}`);
|
||||||
|
const folders = root.folders || [];
|
||||||
|
const folderById = new Map(folders.map((folder) => [String(folder._id), folder]));
|
||||||
|
const pathCache = new Map();
|
||||||
|
|
||||||
|
const folderPath = (folderId, visiting = new Set()) => {
|
||||||
|
const id = String(folderId || '');
|
||||||
|
if (!id || !folderById.has(id)) return [];
|
||||||
|
if (pathCache.has(id)) return pathCache.get(id);
|
||||||
|
if (visiting.has(id)) return [];
|
||||||
|
const folder = folderById.get(id);
|
||||||
|
const nextVisiting = new Set(visiting);
|
||||||
|
nextVisiting.add(id);
|
||||||
|
const parent = folder.parentFolder ? String(folder.parentFolder) : '';
|
||||||
|
const path = [...folderPath(parent, nextVisiting), safeSegment(folder.name, 'Folder')];
|
||||||
|
pathCache.set(id, path);
|
||||||
|
return path;
|
||||||
|
};
|
||||||
|
|
||||||
|
const nestedResults = await Promise.all(folders.map(async (folder) => {
|
||||||
|
const data = await this.request(
|
||||||
|
`/note/subfolder/list?campaign=${encodeURIComponent(campaignId)}&folder=${encodeURIComponent(folder._id)}`
|
||||||
|
);
|
||||||
|
return (data.notes || []).map((note) => ({ note, folders: folderPath(folder._id) }));
|
||||||
|
}));
|
||||||
|
|
||||||
|
const notes = (root.notes || []).map((note) => ({ note, folders: [] }));
|
||||||
|
for (const result of nestedResults) notes.push(...result);
|
||||||
|
return notes;
|
||||||
|
}
|
||||||
|
|
||||||
|
async importCampaignNotes() {
|
||||||
|
try {
|
||||||
|
const campaign = await this.selectedCampaign();
|
||||||
|
const notes = await this.fetchCampaignNotes(campaign._id);
|
||||||
|
const existingById = await this.findFilesByDragonrollId();
|
||||||
|
const baseFolder = normalizePath(`Dragonroll/${safeSegment(campaign.name, 'Campaign')}`);
|
||||||
|
let created = 0;
|
||||||
|
let updated = 0;
|
||||||
|
let unchanged = 0;
|
||||||
|
let protectedNotes = 0;
|
||||||
|
|
||||||
|
for (const entry of notes) {
|
||||||
|
const remote = entry.note;
|
||||||
|
const id = String(remote._id);
|
||||||
|
const title = String(remote.title || 'Untitled');
|
||||||
|
const content = String(remote.content || '');
|
||||||
|
const remoteSignature = await signature(title, content);
|
||||||
|
const file = existingById.get(id);
|
||||||
|
|
||||||
|
if (!file) {
|
||||||
|
const targetFolder = normalizePath([baseFolder, ...entry.folders].join('/'));
|
||||||
|
await this.ensureFolder(targetFolder);
|
||||||
|
const path = await this.availableMarkdownPath(targetFolder, title, id);
|
||||||
|
const newFile = await this.app.vault.create(path, content);
|
||||||
|
await this.setNoteIdentity(newFile, id, campaign._id, title);
|
||||||
|
this.settings.snapshots[id] = remoteSignature;
|
||||||
|
created += 1;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const localContent = await this.app.vault.read(file);
|
||||||
|
const frontmatter = this.app.metadataCache.getFileCache(file)?.frontmatter || {};
|
||||||
|
const storedTitle = frontmatter[REMOTE_TITLE_PROPERTY];
|
||||||
|
const localTitle = storedTitle && safeSegment(storedTitle, 'Untitled') === file.basename
|
||||||
|
? String(storedTitle)
|
||||||
|
: file.basename;
|
||||||
|
const localSignature = await signature(localTitle, stripPluginMetadata(localContent));
|
||||||
|
const baseline = this.settings.snapshots[id];
|
||||||
|
|
||||||
|
if (!baseline) {
|
||||||
|
if (localSignature === remoteSignature) {
|
||||||
|
this.settings.snapshots[id] = remoteSignature;
|
||||||
|
unchanged += 1;
|
||||||
|
} else {
|
||||||
|
protectedNotes += 1;
|
||||||
|
}
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
const localChanged = localSignature !== baseline;
|
||||||
|
const remoteChanged = remoteSignature !== baseline;
|
||||||
|
if (localChanged && remoteChanged) {
|
||||||
|
protectedNotes += 1;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (localChanged) {
|
||||||
|
protectedNotes += 1;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
if (!remoteChanged) {
|
||||||
|
unchanged += 1;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
await this.app.vault.modify(file, content);
|
||||||
|
await this.setNoteIdentity(file, id, campaign._id, title);
|
||||||
|
const renamed = await this.renameImportedFile(file, title, id);
|
||||||
|
this.settings.snapshots[id] = remoteSignature;
|
||||||
|
updated += 1;
|
||||||
|
if (renamed) existingById.set(id, renamed);
|
||||||
|
}
|
||||||
|
|
||||||
|
await this.saveSettings();
|
||||||
|
const details = protectedNotes ? `; ${protectedNotes} local edit(s) kept for review` : '';
|
||||||
|
new Notice(`Dragonroll import: ${created} added, ${updated} updated, ${unchanged} unchanged${details}.`);
|
||||||
|
} catch (error) {
|
||||||
|
new Notice(error.message || 'Could not import Dragonroll notes.');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async pushActiveNote() {
|
||||||
|
try {
|
||||||
|
const campaign = await this.selectedCampaign();
|
||||||
|
const file = this.app.workspace.getActiveFile();
|
||||||
|
if (!file || file.extension !== 'md') throw new Error('Open a Markdown note to push it.');
|
||||||
|
|
||||||
|
const cache = this.app.metadataCache.getFileCache(file);
|
||||||
|
const frontmatter = cache?.frontmatter || {};
|
||||||
|
const linkedCampaign = frontmatter[CAMPAIGN_PROPERTY];
|
||||||
|
const noteId = frontmatter[NOTE_ID_PROPERTY];
|
||||||
|
if (noteId && String(linkedCampaign || '') !== String(campaign._id)) {
|
||||||
|
throw new Error('This note is linked to another Dragonroll campaign. Select that campaign to push it.');
|
||||||
|
}
|
||||||
|
|
||||||
|
const markdown = stripPluginMetadata(await this.app.vault.read(file));
|
||||||
|
let remote;
|
||||||
|
if (noteId) {
|
||||||
|
const data = await this.request('/note/update', {
|
||||||
|
method: 'POST',
|
||||||
|
body: { id: String(noteId), title: file.basename, content: markdown },
|
||||||
|
});
|
||||||
|
remote = data.note;
|
||||||
|
} else {
|
||||||
|
const data = await this.request('/note/create', {
|
||||||
|
method: 'POST',
|
||||||
|
body: { title: file.basename, content: markdown, campaign: campaign._id },
|
||||||
|
});
|
||||||
|
remote = data.note;
|
||||||
|
}
|
||||||
|
|
||||||
|
const id = String(remote._id || noteId);
|
||||||
|
await this.setNoteIdentity(file, id, campaign._id, file.basename);
|
||||||
|
this.settings.snapshots[id] = await signature(file.basename, markdown);
|
||||||
|
await this.saveSettings();
|
||||||
|
new Notice(`Pushed “${file.basename}” to Dragonroll.`);
|
||||||
|
} catch (error) {
|
||||||
|
new Notice(error.message || 'Could not push this note to Dragonroll.');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async findFilesByDragonrollId() {
|
||||||
|
const result = new Map();
|
||||||
|
for (const file of this.app.vault.getMarkdownFiles()) {
|
||||||
|
const frontmatter = this.app.metadataCache.getFileCache(file)?.frontmatter;
|
||||||
|
const id = frontmatter?.[NOTE_ID_PROPERTY];
|
||||||
|
if (id && !result.has(String(id))) result.set(String(id), file);
|
||||||
|
}
|
||||||
|
return result;
|
||||||
|
}
|
||||||
|
|
||||||
|
async setNoteIdentity(file, noteId, campaignId, title) {
|
||||||
|
await this.app.fileManager.processFrontMatter(file, (frontmatter) => {
|
||||||
|
frontmatter[NOTE_ID_PROPERTY] = String(noteId);
|
||||||
|
frontmatter[CAMPAIGN_PROPERTY] = String(campaignId);
|
||||||
|
frontmatter[REMOTE_TITLE_PROPERTY] = String(title || file.basename);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async ensureFolder(path) {
|
||||||
|
const normalized = normalizePath(path);
|
||||||
|
if (!normalized || normalized === '.') return;
|
||||||
|
const parts = normalized.split('/');
|
||||||
|
let current = '';
|
||||||
|
for (const part of parts) {
|
||||||
|
current = current ? `${current}/${part}` : part;
|
||||||
|
if (!this.app.vault.getAbstractFileByPath(current)) {
|
||||||
|
await this.app.vault.createFolder(current);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async availableMarkdownPath(folder, title, noteId) {
|
||||||
|
const base = safeSegment(title, 'Untitled');
|
||||||
|
let path = normalizePath(`${folder}/${base}.md`);
|
||||||
|
if (!this.app.vault.getAbstractFileByPath(path)) return path;
|
||||||
|
const suffix = String(noteId).slice(-6);
|
||||||
|
path = normalizePath(`${folder}/${base} (${suffix}).md`);
|
||||||
|
let counter = 2;
|
||||||
|
while (this.app.vault.getAbstractFileByPath(path)) {
|
||||||
|
path = normalizePath(`${folder}/${base} (${suffix}-${counter}).md`);
|
||||||
|
counter += 1;
|
||||||
|
}
|
||||||
|
return path;
|
||||||
|
}
|
||||||
|
|
||||||
|
async renameImportedFile(file, title, noteId) {
|
||||||
|
const parent = file.parent?.path || '';
|
||||||
|
const base = safeSegment(title, 'Untitled');
|
||||||
|
let targetPath = normalizePath(parent ? `${parent}/${base}.md` : `${base}.md`);
|
||||||
|
if (targetPath === file.path) return file;
|
||||||
|
if (this.app.vault.getAbstractFileByPath(targetPath)) {
|
||||||
|
targetPath = await this.availableMarkdownPath(parent || '.', title, noteId);
|
||||||
|
}
|
||||||
|
await this.app.fileManager.renameFile(file, targetPath);
|
||||||
|
return this.app.vault.getAbstractFileByPath(targetPath);
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
class DragonrollSettingTab extends PluginSettingTab {
|
||||||
|
constructor(app, plugin) {
|
||||||
|
super(app, plugin);
|
||||||
|
this.plugin = plugin;
|
||||||
|
this.campaigns = [];
|
||||||
|
this.loginName = '';
|
||||||
|
this.password = '';
|
||||||
|
}
|
||||||
|
|
||||||
|
display() {
|
||||||
|
const { containerEl } = this;
|
||||||
|
containerEl.empty();
|
||||||
|
containerEl.createEl('h2', { text: 'Dragonroll Sync' });
|
||||||
|
containerEl.createEl('p', {
|
||||||
|
text: 'Sign in with your Dragonroll account, choose a campaign, then use the import and push commands. Your password is used only to sign in; the 48-hour session token is stored in this vault.',
|
||||||
|
});
|
||||||
|
|
||||||
|
new Setting(containerEl)
|
||||||
|
.setName('Dragonroll API URL')
|
||||||
|
.setDesc('Use the server address, with or without /api.')
|
||||||
|
.addText((text) => text
|
||||||
|
.setPlaceholder('https://dragonroll.aranroig.com/api')
|
||||||
|
.setValue(this.plugin.settings.apiBaseUrl)
|
||||||
|
.onChange(async (value) => {
|
||||||
|
const previous = this.plugin.settings.apiBaseUrl.trim().replace(/\/+$/, '');
|
||||||
|
const next = value.trim().replace(/\/+$/, '');
|
||||||
|
if (previous !== next) {
|
||||||
|
this.plugin.settings.token = '';
|
||||||
|
this.plugin.settings.campaignId = '';
|
||||||
|
this.campaigns = [];
|
||||||
|
}
|
||||||
|
this.plugin.settings.apiBaseUrl = value.trim();
|
||||||
|
await this.plugin.saveSettings();
|
||||||
|
}));
|
||||||
|
|
||||||
|
new Setting(containerEl)
|
||||||
|
.setName('Username or email')
|
||||||
|
.addText((text) => text
|
||||||
|
.setPlaceholder('Dragonroll username or email')
|
||||||
|
.onChange((value) => { this.loginName = value.trim(); }));
|
||||||
|
|
||||||
|
new Setting(containerEl)
|
||||||
|
.setName('Password')
|
||||||
|
.addText((text) => {
|
||||||
|
text.inputEl.type = 'password';
|
||||||
|
text.inputEl.autocomplete = 'off';
|
||||||
|
text.onChange((value) => { this.password = value; });
|
||||||
|
});
|
||||||
|
|
||||||
|
new Setting(containerEl)
|
||||||
|
.setName(this.plugin.settings.token ? 'Session' : 'Sign in')
|
||||||
|
.setDesc(this.plugin.settings.token ? 'The stored session expires after 48 hours.' : 'Password is not saved by this plugin.')
|
||||||
|
.addButton((button) => button
|
||||||
|
.setButtonText('Sign in')
|
||||||
|
.setCta()
|
||||||
|
.onClick(async () => {
|
||||||
|
if (!this.loginName || !this.password) {
|
||||||
|
new Notice('Enter your Dragonroll username/email and password.');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
button.setDisabled(true);
|
||||||
|
try {
|
||||||
|
this.campaigns = await this.plugin.login(this.loginName, this.password);
|
||||||
|
this.password = '';
|
||||||
|
this.display();
|
||||||
|
new Notice(`Signed in. Found ${this.campaigns.length} campaign(s).`);
|
||||||
|
} catch (error) {
|
||||||
|
new Notice(error.message || 'Could not sign in to Dragonroll.');
|
||||||
|
} finally {
|
||||||
|
button.setDisabled(false);
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
|
||||||
|
if (this.plugin.settings.token) {
|
||||||
|
new Setting(containerEl)
|
||||||
|
.setName('Campaign')
|
||||||
|
.setDesc('The campaign used by import and push commands.')
|
||||||
|
.addDropdown((dropdown) => {
|
||||||
|
dropdown.addOption('', 'Choose a campaign');
|
||||||
|
for (const campaign of this.campaigns) {
|
||||||
|
dropdown.addOption(String(campaign._id), campaign.name);
|
||||||
|
}
|
||||||
|
dropdown.setValue(this.plugin.settings.campaignId || '');
|
||||||
|
dropdown.onChange(async (value) => {
|
||||||
|
this.plugin.settings.campaignId = value;
|
||||||
|
await this.plugin.saveSettings();
|
||||||
|
});
|
||||||
|
})
|
||||||
|
.addButton((button) => button
|
||||||
|
.setButtonText('Load campaigns')
|
||||||
|
.onClick(async () => {
|
||||||
|
button.setDisabled(true);
|
||||||
|
try {
|
||||||
|
this.campaigns = await this.plugin.getCampaigns();
|
||||||
|
this.display();
|
||||||
|
new Notice(`Loaded ${this.campaigns.length} campaign(s).`);
|
||||||
|
} catch (error) {
|
||||||
|
new Notice(error.message || 'Could not load campaigns.');
|
||||||
|
} finally {
|
||||||
|
button.setDisabled(false);
|
||||||
|
}
|
||||||
|
}));
|
||||||
|
|
||||||
|
new Setting(containerEl)
|
||||||
|
.setName('Sign out')
|
||||||
|
.setDesc('Remove the saved Dragonroll session from this vault.')
|
||||||
|
.addButton((button) => button
|
||||||
|
.setButtonText('Sign out')
|
||||||
|
.onClick(async () => {
|
||||||
|
this.plugin.settings.token = '';
|
||||||
|
this.plugin.settings.campaignId = '';
|
||||||
|
await this.plugin.saveSettings();
|
||||||
|
this.display();
|
||||||
|
}));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function safeSegment(value, fallback) {
|
||||||
|
const safe = String(value || '')
|
||||||
|
.replace(/[\\\/:*?"<>|#^\[\]]/g, '-')
|
||||||
|
.replace(/[. ]+$/g, '')
|
||||||
|
.trim();
|
||||||
|
return safe || fallback;
|
||||||
|
}
|
||||||
|
|
||||||
|
function stripPluginMetadata(markdown) {
|
||||||
|
const text = String(markdown || '');
|
||||||
|
const match = text.match(/^(---\r?\n)([\s\S]*?)(\r?\n---(?:\r?\n|$))/);
|
||||||
|
if (!match) return text;
|
||||||
|
const keptLines = match[2].split(/\r?\n/).filter((line) =>
|
||||||
|
!/^(dragonrollId|dragonrollCampaign|dragonrollTitle):\s*/.test(line)
|
||||||
|
);
|
||||||
|
const frontmatter = keptLines.join('\n').trim();
|
||||||
|
const body = text.slice(match[0].length);
|
||||||
|
return frontmatter ? `---\n${frontmatter}\n---\n${body}` : body;
|
||||||
|
}
|
||||||
|
|
||||||
|
async function signature(title, content) {
|
||||||
|
const value = `${title}\u0000${String(content).replace(/\r\n/g, '\n')}`;
|
||||||
|
if (globalThis.crypto?.subtle) {
|
||||||
|
const digest = await globalThis.crypto.subtle.digest('SHA-256', new TextEncoder().encode(value));
|
||||||
|
return Array.from(new Uint8Array(digest), (byte) => byte.toString(16).padStart(2, '0')).join('');
|
||||||
|
}
|
||||||
|
let hash = 2166136261;
|
||||||
|
for (let index = 0; index < value.length; index += 1) {
|
||||||
|
hash = Math.imul(hash ^ value.charCodeAt(index), 16777619);
|
||||||
|
}
|
||||||
|
return (hash >>> 0).toString(16);
|
||||||
|
}
|
||||||
9
obsidian-plugin/manifest.json
Normal file
9
obsidian-plugin/manifest.json
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"id": "dragonroll-sync",
|
||||||
|
"name": "Dragonroll Sync",
|
||||||
|
"version": "1.0.0",
|
||||||
|
"minAppVersion": "1.5.0",
|
||||||
|
"description": "Import Dragonroll campaign notes into Obsidian and push edits back.",
|
||||||
|
"author": "Dragonroll",
|
||||||
|
"isDesktopOnly": false
|
||||||
|
}
|
||||||
116
tests/map-viewer.test.js
Normal file
116
tests/map-viewer.test.js
Normal file
@@ -0,0 +1,116 @@
|
|||||||
|
// Tests for the map viewer adjustments of Syndria98/dragonroll#15:
|
||||||
|
// * the campaign workspace can show an anchored map where the open notes are, and the sidebar's
|
||||||
|
// notes/maps buttons switch between the two without losing either,
|
||||||
|
// * the create map window no longer snaps the scale to `min + n * step` values and insets its
|
||||||
|
// content from the window edges.
|
||||||
|
//
|
||||||
|
// `frontend/app/services/Content.js` is a Vue module and the repository root installs no
|
||||||
|
// dependencies, so it is loaded into a `node:vm` context with a minimal `ref` stub: the anchor and
|
||||||
|
// pane rules are plain state transitions and stay fully observable that way. The create map window
|
||||||
|
// checks read its template, because both requirements are about the input element itself.
|
||||||
|
//
|
||||||
|
// Run with `npm test` from the repository root, or `node --test tests/`.
|
||||||
|
|
||||||
|
const { test } = require("node:test");
|
||||||
|
const assert = require("node:assert/strict");
|
||||||
|
const fs = require("node:fs");
|
||||||
|
const path = require("node:path");
|
||||||
|
const vm = require("node:vm");
|
||||||
|
|
||||||
|
function readRepoFile(...parts) {
|
||||||
|
return fs.readFileSync(path.join(__dirname, "..", ...parts), "utf8");
|
||||||
|
}
|
||||||
|
|
||||||
|
function loadContentService() {
|
||||||
|
const source = readRepoFile("frontend", "app", "services", "Content.js");
|
||||||
|
const body = source
|
||||||
|
.replace(/import\s*\{[^}]*\}\s*from\s*['"]vue['"];?/, "")
|
||||||
|
.replace(/export\s*\{/, "return {")
|
||||||
|
.concat("\n;");
|
||||||
|
|
||||||
|
const context = vm.createContext({ ref: (value) => ({ value }) });
|
||||||
|
return vm.compileFunction(body, [], { parsingContext: context })();
|
||||||
|
}
|
||||||
|
|
||||||
|
function anchoredMapTests() {
|
||||||
|
test("the workspace starts on the open notes with no map anchored", () => {
|
||||||
|
const service = loadContentService();
|
||||||
|
assert.equal(service.ActivePane.value, "notes");
|
||||||
|
assert.equal(service.AnchoredMap.value, null);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("anchoring a map shows it instead of the notes", () => {
|
||||||
|
const service = loadContentService();
|
||||||
|
service.AnchorMap({ _id: "map-1", name: "Dungeon" });
|
||||||
|
assert.equal(service.ActivePane.value, "map");
|
||||||
|
assert.equal(service.AnchoredMap.value._id, "map-1");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("switching back to the notes keeps the map anchored", () => {
|
||||||
|
const service = loadContentService();
|
||||||
|
service.AnchorMap({ _id: "map-1" });
|
||||||
|
service.SetActivePane("notes");
|
||||||
|
assert.equal(service.ActivePane.value, "notes");
|
||||||
|
assert.equal(service.AnchoredMap.value._id, "map-1");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("clearing the anchor shows the notes again", () => {
|
||||||
|
const service = loadContentService();
|
||||||
|
service.AnchorMap({ _id: "map-1" });
|
||||||
|
service.ClearAnchoredMap();
|
||||||
|
assert.equal(service.AnchoredMap.value, null);
|
||||||
|
assert.equal(service.ActivePane.value, "notes");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("anchoring nothing falls back to the notes", () => {
|
||||||
|
const service = loadContentService();
|
||||||
|
service.AnchorMap({ _id: "map-1" });
|
||||||
|
service.AnchorMap(null);
|
||||||
|
assert.equal(service.AnchoredMap.value, null);
|
||||||
|
assert.equal(service.ActivePane.value, "notes");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("hiding a pane does not disturb the other one", () => {
|
||||||
|
const service = loadContentService();
|
||||||
|
service.AnchorMap({ _id: "map-1" });
|
||||||
|
service.SetShowContent(false);
|
||||||
|
assert.equal(service.ShowContent.value, false);
|
||||||
|
assert.equal(service.ActivePane.value, "map");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function createMapWindowTests() {
|
||||||
|
const source = readRepoFile("frontend", "app", "components", "windows", "CreateMapWindow.vue");
|
||||||
|
const scaleInput = /<input[^>]*v-model\.number="form\.scale"[^>]*>/.exec(source);
|
||||||
|
|
||||||
|
test("the create map window has a scale input", () => {
|
||||||
|
assert.ok(scaleInput, "expected a v-model.number=\"form.scale\" input");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the scale input accepts any decimal number", () => {
|
||||||
|
const step = /step="([^"]*)"/.exec(scaleInput[0])?.[1];
|
||||||
|
// A number input only accepts `min + n * step`, so a 0.5 step on the 0.01 minimum only
|
||||||
|
// ever offered 5.01, 5.51, 6.01... instead of the number that was typed.
|
||||||
|
assert.ok(
|
||||||
|
step === undefined || step === "any",
|
||||||
|
`the scale input must not snap values, found step="${step}"`
|
||||||
|
);
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the scale input keeps the positive minimum shared with the backend", () => {
|
||||||
|
const min = /min="([^"]*)"/.exec(scaleInput[0])?.[1];
|
||||||
|
assert.equal(min, "0.01");
|
||||||
|
});
|
||||||
|
|
||||||
|
test("the create map window insets its content with an outer margin", () => {
|
||||||
|
const body = /\.body\s*\{[^}]*\}/.exec(source)?.[0];
|
||||||
|
assert.ok(body, "expected a .body style rule");
|
||||||
|
assert.match(body, /margin:\s*[^;]*\d+px/, ".body needs an outer margin");
|
||||||
|
// Without border-box the horizontal margin is added outside the full width and the
|
||||||
|
// content overflows the window instead of being inset by it.
|
||||||
|
assert.match(body, /box-sizing:\s*border-box/, ".body needs box-sizing: border-box");
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
anchoredMapTests();
|
||||||
|
createMapWindowTests();
|
||||||
Reference in New Issue
Block a user