obsidian-plugin/nossimonov_obsidian-chartdown
1
0
Fork 0
mirror of https://github.com/nossimonov/obsidian-chartdown.git synced 2026-07-22 08:38:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
15 commits 1 branch 8 tags 53 KiB
TypeScript 96.3%
CSS 3.7%
Find a file
github-actions[bot] 9ee669291d Release 0.1.7
2026-07-22 03:02:52 +00:00
.github/workflows BOM-tolerant manifest parse in the release workflow 2026-07-21 17:47:10 -07:00
src Release 0.1.4 2026-07-22 00:05:04 +00:00
.gitignore Lockfile + standalone build: reproducible from the published packages 2026-07-21 17:40:53 -07:00
LICENSE Store review round: plain MIT, source synced per release, asset attestations 2026-07-21 16:23:30 -07:00
manifest.json Release 0.1.7 2026-07-22 03:02:52 +00:00
package-lock.json Lockfile + standalone build: reproducible from the published packages 2026-07-21 17:40:53 -07:00
package.json Lockfile + standalone build: reproducible from the published packages 2026-07-21 17:40:53 -07:00
README.md Store review round: plain MIT, source synced per release, asset attestations 2026-07-21 16:23:30 -07:00
styles.css Release 0.1.1 2026-07-21 23:23:51 +00:00
tsconfig.json Self-contained type environment for store review 2026-07-21 16:57:04 -07:00
versions.json Release 0.1.7 2026-07-22 03:02:52 +00:00

README.md

Chartdown for Obsidian

Write TTRPG maps as plain text in your notes; see them as maps. Chartdown is a Markdown-inspired language for battlemaps, hex charts, and region maps — this plugin renders every ```chartdown fence in place, entirely on your machine.

```chartdown
# Ambush at Redford Crossing
map: battlemap
grid: square 20x15
scale: 5ft
[terrain]
river redford "The Redford" : path A9 F9 K9 P10 T10 width=2
road tollroad "Old Toll Road" : path K1 K15
ford : on redford on tollroad difficult
[tokens]
goblins g1 g2 : C12 E13
ogre "Gruk" : G9 size=2 hidden
party start : J14..L15
```

What you get

  • Maps in your prep notes — versionable, diffable, no graphical editor. Edit the fence, reopen the note, the map follows.
  • GM/player split, fail-closed — hidden tokens, [gm] notes, and triggers render only in GM view. Each map has a toolbar toggle; the settings tab sets the default.
  • Export SVG — one click writes the map (in the current view) next to the note and reveals it in your system file explorer.
  • Export UVTT — one .dd2vtt per map level, with walls, doors, windows, and lights mapped for VTT import (Foundry, Roll20 via importers, Arkenforge, …) and the map image rasterized in-app. Note: .dd2vtt files are hidden in Obsidian's own file explorer (unknown extension) — they're real files in your vault folder, and the export reveals them.
  • Multi-level battlemaps, themes, light and sight — the full Chartdown v0.1 language.

Try the language first in the playground — no install, runs in your browser.

Manual installation

Until the plugin is in the community store: download main.js, manifest.json, and styles.css from the latest release, place them in <your vault>/.obsidian/plugins/chartdown/, then enable Chartdown under Settings → Community plugins. (Or point BRAT at Nossimonov/obsidian-chartdown.)

Development

Development happens in the Chartdown monorepo (packages/obsidian), which is where the tests and issue tracker live — please file issues and PRs there. This repository carries the store-facing artifact: src/ and styles.css are synced verbatim from the monorepo by the release workflow (every release commit pins the exact source it was built from), and release assets carry build-provenance attestations. The plugin imports @chartdown/core and @chartdown/render-svg, published from the same monorepo.

License

MIT. The Chartdown language specification is CC-BY-4.0.