Quartz integration for TTRPG Tools: Maps Obsidian plugin
  • TypeScript 96.2%
  • SCSS 3.8%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:03:59 +01:00
.changeset chore: version package 2026-11-09 02:20:32 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:27 +01:00
src feat: first pass 2026-04-11 22:17:41 +02:00
test feat: first pass 2026-04-11 22:17:41 +02:00
types Initial commit 2026-04-11 20:43:05 +02:00
.eslintrc.json feat: first pass 2026-04-11 22:17:41 +02:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:25 +02:00
.prettierignore Initial commit 2026-04-11 20:43:05 +02:00
.prettierrc Initial commit 2026-04-11 20:43:05 +02:00
AGENTS.md Initial commit 2026-04-11 20:43:05 +02:00
ARCHITECTURE.md Initial commit 2026-04-11 20:43:05 +02:00
CHANGELOG.md chore: version package 2026-11-09 02:20:32 +00:00
EXAMPLES.md Initial commit 2026-04-11 20:43:05 +02:00
LICENSE feat: first pass 2026-04-11 22:17:41 +02:00
package-lock.json chore: version package 2026-11-09 02:20:32 +00:00
package.json chore: version package 2026-11-09 02:20:32 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:49 +01:00
tsconfig.build.json Initial commit 2026-04-11 20:43:05 +02:00
tsconfig.json Initial commit 2026-04-11 20:43:05 +02:00
tsup.config.ts Initial commit 2026-04-11 20:43:05 +02:00
vitest.config.ts Initial commit 2026-04-11 20:43:05 +02:00

TTRPG Tools: Maps — Quartz v5 Plugin

A Quartz v5 community plugin that renders interactive, read-only TTRPG maps in a generated static site. It consumes the data formats produced by the Obsidian plugin TTRPG Tools: Maps (zoom-map) without requiring any migration — point Quartz at a vault that uses zoommap, and the maps show up on the built site.

Credits

This plugin is a static-site adaptation of TTRPG Tools: Maps (zoom-map) by Jareika, an Obsidian community plugin licensed under MIT. The DOM structure, CSS layout rules, and interactive pan/zoom/pinch math are directly ported from the original at commit da748dbcca9247ef26cf596b9e64b0b552fdb175.

This plugin does not include any editing features; it consumes data produced by the original plugin and renders it as a read-only view in Quartz-generated static sites. For authoring maps, install the original plugin in Obsidian.

Installation

npx quartz plugin add @quartz-community/obsidian-plugin-ttrpg-tools-maps

Then enable it in quartz.config.yaml (one entry registers the transformer, the emitter that copies the map images, and the map component):

plugins:
  - source: "@quartz-community/obsidian-plugin-ttrpg-tools-maps"
    enabled: true
    options:
      blockLanguage: zoommap
      inlineBlockHeaderId: ZOOMMAP-DATA

Configuration

Option Type Default Description
blockLanguage string "zoommap" The code block language that holds a map.
inlineBlockHeaderId string "ZOOMMAP-DATA" The header of inline marker data blocks (storage: note).
defaultIconKey string "pin-red" Accepted, but currently not used: a marker without an icon is always drawn as a red pin.
maxInlineDataBytes number 0 Reserved, currently not used: marker data is always inlined into the page.

Authoring maps

Inside any Markdown note, embed a map with a fenced code block:

```zoommap
imageBases:
  - path: assets/world-map.webp
    name: Forbidden Lands
markers: assets/world-map.webp.markers.json
minZoom: 0.3
maxZoom: 20
height: 480px
width: 100%
```

Or use inline storage (the entire marker dataset lives in the same Markdown note):

```zoommap
image: assets/world-map.webp
storage: note
id: map-1
```

%%
ZOOMMAP-DATA id=map-1
{ "layers": [...], "markers": [...] }
/ZOOMMAP-DATA
%%

Supported features

  • Single and multiple base images with a switcher UI
  • Pan and zoom via mouse wheel, drag, double-click, and pinch
  • Mobile pinch zoom and two-finger pan
  • Pan clamping
  • Markers (pin, sticker, switch variants — rendered statically)
  • Marker tooltips and links
  • Layer visibility toggles
  • Per-marker zoom-range visibility
  • Image overlays
  • Grid overlays (square and hex)
  • Drawings (rectangle, circle, polygon, polyline) with styles
  • Text layers with baselines

Unsupported features (roadmap)

  • Editing of any kind (by design — static site)
  • Ruler / measurement tool
  • Custom units and travel-time calculations
  • Viewport frame overlays
  • Swap pin click-cycling
  • Canvas render mode

Documentation

See the Quartz documentation for more information.

Development

npm install
npm run build
npm test

License

MIT — see LICENSE for the full text, including the upstream copyright notice for the ported source.