Releases: Obsidian-TTRPG-Community/ttrpg-convert-cli-ui
TTRPG Convert CLI UI v2.4.0
v2.4.0 — Starter pack: Basic Test Config + property templates
- A new Starter pack item on the Setup tab installs bundled assets into your
CLI home with one click: a ready-to-run Basic Test Config
(basic-test-config.json— Lost Mine of Phandelver plus the 2024 core books,
Fantasy Statblocks on) and three custom "properties" templates for
monsters, spells, and items. They're shipped inside the app (Tauri
bundle.resources) and copied in by the Rustinstall_bundled_assetscommand,
so no download is needed. The Setup row shows ✓ once they're present. - The custom templates put every key stat into the note's frontmatter
properties (visible in Obsidian's Properties view and queryable by Dataview)
and add aCLI-Imageproperty pointing at the note's primary image — the
token for monsters (falling back to the first portrait/fluff image), and the
first fluff image for spells and items. - The monster template (
monster2md-properties-statblock.txt) places the
Fantasy Statblocks block above the body content, since the statblock is the
most important part of a creature note. Its name includesstatblock, so it
appears in the Configure tab's monster dropdown when Fantasy Statblocks is on.
Full Changelog: v2.3.0...v2.4.0
Install
- Windows —
.msior.exe. Unsigned, so SmartScreen shows "Windows protected your PC" on first run — click More info → Run anyway. - macOS —
.dmg(Apple Silicon and Intel builds provided). If macOS says the app is "damaged" or from an unidentified developer, it's just Gatekeeper quarantining an unsigned download — clear it with:xattr -cr "/Applications/TTRPG Convert CLI UI.app"then open normally. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.
TTRPG Convert CLI UI v2.3.0
v2.3.0 — Thank the developer
- A new ♥ button in the top bar opens a Thank the developer dialog. The
CLI converter this app drives is built and maintained by ebullient — the
dialog credits her work and gathers the ways she's set up to receive thanks:
Buy Me a Coffee, GitHub Sponsors, Open Collective, and a link to
star the converter repo. It shows her cartoon avatar (loaded from GitHub, with
a graceful fallback when offline). Links open in your browser via the existing
external-link handling.
Full Changelog: v2.2.0...v2.3.0
Install
- Windows —
.msior.exe. Unsigned, so SmartScreen shows "Windows protected your PC" on first run — click More info → Run anyway. - macOS —
.dmg(Apple Silicon and Intel builds provided). If macOS says the app is "damaged" or from an unidentified developer, it's just Gatekeeper quarantining an unsigned download — clear it with:xattr -cr "/Applications/TTRPG Convert CLI UI.app"then open normally. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.
TTRPG Convert CLI UI v2.2.0
v2.2.0 — Homebrew source browser
- The one-file-at-a-time homebrew picker is replaced by a categorised browser
that works like the official source picker. It scans your homebrew folder and
groups everything by type — Book, Adventure, Collection, Creature, Spell, … —
taken from the subfolders, with each entry labelled by title and author from
the filename. You can search by title, author, or category and multi-select
with checkboxes; selected items float to the top, unticking removes them, and
your picks are written as file paths (newline-delimited, so comma-containing
titles stay intact). No file contents are read, so it stays fast even with a
large homebrew library.
Full Changelog: v2.1.0...v2.2.0
Install
- Windows —
.msior.exe. Unsigned, so SmartScreen shows "Windows protected your PC" on first run — click More info → Run anyway. - macOS —
.dmg(Apple Silicon and Intel builds provided). If macOS says the app is "damaged" or from an unidentified developer, it's just Gatekeeper quarantining an unsigned download — clear it with:xattr -cr "/Applications/TTRPG Convert CLI UI.app"then open normally. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.
TTRPG Convert CLI UI v2.1.0
v2.1.0 — Template Creator, guided setup & Apple Silicon fix
Everything since 2.0.1. Headline additions are the Template Creator and a
guided post-conversion checklist, plus an important Apple Silicon fix.
Templates
- Template Creator (new) — a builder for authoring Qute templates without
writing the syntax by hand, opened from the Templates section. A searchable
side-panel lists the variables your installed templates actually expose, so
they're always valid: objects expand (e.g.scores→dex,dexMod), arrays
expand to their item fields (e.g.action→name,desc) with a one-click
loop scaffold, and there's an image-block insert. Snippet buttons for
frontmatter /{#if}/{#for}/{#each}, a "Start from" picker to base a
new template on an existing one, a live (approximate, clearly-labelled)
preview, and Save straight into your templates folder. - Template guide (new) — an in-app reference for the template language:
the keys, file-naming, a Qute syntax cheatsheet, and links to the official and
community docs. - Recommended button — fills every template type with a sensible default
from your installed templates in one click.
Run — guided next steps
- New "After it finishes" panel that adapts to your config: copy-into-vault
steps; the plugins to install (linked to community.obsidian.md) with
required / recommended / optional badges; the Fantasy Statblocks
folder-parsing setup; and exactly which files from the downloaded examples
folder (CSS snippets, admonition definitions) to copy and where. Ends by
prompting an Obsidian restart. - A clear warning — on both Configure and Run — when the chosen monster template
will produce plain Markdown instead of Fantasy Statblocks, with how to switch.
Updates
- The app now checks for new releases on launch and shows a dismissible
banner ("Update available — vX.Y.Z") with a Download button to the releases
page when a newer stable version is published. The check is silent on failure
and never blocks startup; prereleases don't trigger it.
Fixes
- Homebrew filenames containing commas no longer break conversion. The
homebrew list was comma-delimited internally, so a filename with a comma in it
(common for third-party titles, e.g. "Flee, Mortals!.json") was split into a
broken path the converter couldn't open — it failed with a NullPointerException
before writing any output. Homebrew is now newline-delimited (one path per
line), and existing configs broken by the old behaviour are repaired
automatically when loaded in Configure. - Apple Silicon Macs now download the correct converter. The arm64 build is
published asosx-aarch_64(underscore), which the asset matcher didn't
recognise — so Apple Silicon machines were getting the Intel binary and
failing with "Bad CPU type in executable". Added the classifier, plus
runtime (Rosetta-aware) architecture detection, and an actionable log message
if a mismatched binary is ever run. - Open output folder now works reliably — it no longer routes through a
URL-only handler that rejected local file paths. - Source pickers: unticking a source now removes it, and already-picked
sources sort to the top when you reopen the picker.
Configure
defaultSourceoverrides moved into the Advanced section alongside the source
index and content filters, with a note on the 2024-only use case.
Full Changelog: v2.0.1...v2.1.0
Install
- Windows —
.msior.exe. Unsigned, so SmartScreen shows "Windows protected your PC" on first run — click More info → Run anyway. - macOS —
.dmg(Apple Silicon and Intel builds provided). If macOS says the app is "damaged" or from an unidentified developer, it's just Gatekeeper quarantining an unsigned download — clear it with:xattr -cr "/Applications/TTRPG Convert CLI UI.app"then open normally. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.
TTRPG Convert CLI UI v2.1.0-rc3
Full Changelog: v2.1.0-rc2...v2.1.0-rc3
Install
- Windows —
.msior.exe. Unsigned, so SmartScreen shows "Windows protected your PC" on first run — click More info → Run anyway. - macOS —
.dmg(Apple Silicon and Intel builds provided). If macOS says the app is "damaged" or from an unidentified developer, it's just Gatekeeper quarantining an unsigned download — clear it with:xattr -cr "/Applications/TTRPG Convert CLI UI.app"then open normally. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.
TTRPG Convert CLI UI v2.1.0-rc2
Full Changelog: v2.1.0...v2.1.0-rc2
Install
- Windows —
.msior.exe. Unsigned, so SmartScreen shows "Windows protected your PC" on first run — click More info → Run anyway. - macOS —
.dmg(Apple Silicon and Intel builds provided). If macOS says the app is "damaged" or from an unidentified developer, it's just Gatekeeper quarantining an unsigned download — clear it with:xattr -cr "/Applications/TTRPG Convert CLI UI.app"then open normally. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.
TTRPG Convert CLI UI v2.1.0-rc1
Full Changelog: v2.0.1...v2.1.0-rc1
Install
- Windows —
.msior.exe. Unsigned, so SmartScreen shows "Windows protected your PC" on first run — click More info → Run anyway. - macOS —
.dmg(Apple Silicon and Intel builds provided). If macOS says the app is "damaged" or from an unidentified developer, it's just Gatekeeper quarantining an unsigned download — clear it with:xattr -cr "/Applications/TTRPG Convert CLI UI.app"then open normally. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.
TTRPG Convert CLI UI v2.0.1
Full Changelog: v2.0.0...v2.0.1
Install
- Windows —
.msior.exe - macOS —
.dmg(Apple Silicon and Intel builds provided). If macOS says the app is "damaged" or from an unidentified developer, it's just Gatekeeper quarantining an unsigned download — clear it with:xattr -cr "/Applications/TTRPG Convert CLI UI.app"then open normally. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.
TTRPG Convert CLI UI v2.0.0-rc2
Full Changelog: https://github.com/Obsidian-TTRPG-Community/ttrpg-convert-cli-ui/commits/v2.0.0-rc2
Install
- Windows —
.msior.exe - macOS —
.dmg(unsigned: right-click -> Open the first time). Apple Silicon and Intel builds are provided separately. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.
TTRPG Convert CLI UI v2.0.0
v2.0.0 — Cross-platform rewrite
A ground-up, cross-platform rebuild of the Windows-only TTRPG_CLI_UI as a
Tauri 2 desktop app (Windows, macOS, Linux) that wraps
ttrpg-convert-cli. No Java
required — the converter binary is fetched for your OS on first run.
Setup
- One "CLI home" folder holds everything (converter, data, templates, images,
homebrew, configs, output). - Library panel installs/updates each piece, detecting what's already on disk
and switching Install -> Update accordingly (gitpullfor cloned repos,
re-download for the converter and templates).
Configure
- Full config-key coverage: sources, Obsidian output paths, images, reprint
behaviour, tag prefix, dice roller, Fantasy Statblocks, races-as-species,
only-referenced-tables, anddefaultSourceoverrides. - Source pickers read the cloned data's
books.json/adventures.jsonso you
choose sources by name instead of typing codes. - Homebrew file picker rooted at the homebrew folder.
- Advanced (collapsible) content filters: include / exclude / excludePattern,
with an index-driven key picker (Generate index -> click keys into the lists). - All 16 template keys, each defaulting to a sensible template
(monster2md-yamlStatblock-body.txtwhen Fantasy Statblocks is on). - Master selector to load any saved config back into the form for reuse, and a
liveconfig.jsonpreview.
Run
- Config dropdown, output/data folders, and
--index/--log/--debug/
-vflags with a live command preview. The Run tab unlocks once a config
exists.
Misc
- Theme support: System / Light / Dark / Obsidian, remembered between sessions.
- Resizable output log.
- Tested core (config builder, reverse parser, platform/asset matching, index
and source parsing).
Full Changelog: v2.0.0-rc2...v2.0.0
Install
- Windows —
.msior.exe - macOS —
.dmg(unsigned: right-click -> Open the first time). Apple Silicon and Intel builds are provided separately. - Linux —
.AppImageor.deb
On first launch the app downloads the ttrpg-convert-cli binary for your OS and you point it at your 5etools data — no Java required.