Skip to content

Building and Importing

Brioche Masquée edited this page Aug 4, 2026 · 1 revision

Building and Importing

Live preview

Open a page and click Open Preview (top right of the editor) to see it rendered with your project's actual theme — close to what EncounterPlus will actually show.

A couple of things render only at preview time, not in the final build: front matter is hidden, and image paths get adjusted for the preview's own folder depth. Everything else — blockquote variants, tables, inline Compendium blocks — matches the real build.

If you switch your project's theme, close and reopen the preview — VSCode has no way to force an already-open preview to reload.

Building

Run MPX: Build Module, or the build button in the Project section of the panel. Any unsaved files are saved automatically first.

MPX validates everything before building anything — broken slugs, missing parents, invalid field values. Every problem is collected and reported at once, in the "MPX" output channel, rather than stopping at the first one — so one pass tells you everything that needs fixing.

On success, a .module file appears at your project's root, named after the project folder.

Version auto-increment

By default (mpx.autoIncrementVersion in project settings), module.json's patch version bumps after a successful build (1.0.01.0.1) — so the next build starts from a new version. The .module file you just built keeps the version it was built with; only the project's own module.json changes, to prepare for next time.

Broken link warnings

After a successful build, if any page links don't resolve to a real page, group, map, or encounter, you'll get a notification with a Show Broken Links action — listing them in the same "MPX" output channel. This never blocks the build; it's a heads-up, not an error.

Importing into EncounterPlus

Get the .module file onto the device running EncounterPlus (AirDrop, a cloud drive, etc.), then use the app's Import Content feature and pick it as a local file.

Next step

Advanced settings — the finer per-card display toggles and build options most projects won't need to touch.

Clone this wiki locally