Mimir - D&D Campaign Assistant

“Remember, I know everything that can be known in the multiverse.” - Mimir, Planescape

Welcome to Mimir, your local-first D&D 5e campaign management tool. Named after the wise floating skull of Planescape lore, Mimir helps Dungeon Masters organize campaigns, run sessions, and keep everything at their fingertips.

Quick Start

New to Mimir? Start with our tutorials:

1. Your First Campaign — Create a campaign and explore the dashboard
2. Your First Module — Build an adventure with maps and monsters
3. Running Your First Session — Use Play Mode to run an encounter
4. Player Display Setup — Set up a second screen for players
5. Creating Homebrew Content — Make custom items, monsters, and spells

Features

Campaign Management

Create and organize campaigns with a structured workflow. Track documents, NPCs, and plot threads across multiple adventure modules.

Interactive Maps

Upload maps (UVTT or images), configure grids, and place tokens. Manage fog of war with line-of-sight calculations and light sources.

Play Mode

Run sessions with a dedicated play interface. Control what players see on a second display while you manage encounters behind the scenes.

D&D 5e Reference

Search monsters, spells, items, and more from your D&D sourcebooks. Quick access to rules when you need them.

PDF Export

Print character sheets, spell cards, and maps with token cutouts for physical play.

Documentation

This documentation is organized using the Diataxis framework:

Installation

macOS / Linux — one-line install:

curl -sSL https://raw.githubusercontent.com/mimir-dm/mimir/main/scripts/install.sh | sh

This installs the Mimir app (to ~/Applications on macOS, ~/.local/bin on Linux). On macOS it also installs the mimir-mcp CLI to ~/.local/bin; on Linux the script installs the app only — download mimir-mcp-<target-triple> from GitHub Releases or build it with cargo build --release -p mimir-mcp.

To pin a specific version:

curl -sSL https://raw.githubusercontent.com/mimir-dm/mimir/main/scripts/install.sh | sh -s -- --version X.Y.Z

Windows — download and run the .msi installer from GitHub Releases.

Supported Platforms: macOS, Windows, Linux

Getting Help

• Issues: Report bugs on GitHub Issues
• Discussions: Ask questions on GitHub Discussions

Mimir is open source software. See the Developer Documentation if you’d like to contribute.

Tutorials

Welcome to the Mimir tutorials! These step-by-step guides will walk you through the core features of Mimir, from creating your first campaign to running your first game session.

What You’ll Learn

Each tutorial builds on the previous one, taking you from a complete beginner to a confident Dungeon Master using Mimir:

1. Your First Campaign - Create a campaign and explore the dashboard
2. Your First Module - Build an adventure module with maps and monsters
3. Running Your First Session - Use Play Mode to run an encounter
4. Player Display Setup - Set up a second screen for your players
5. Creating Homebrew Content - Create custom items, monsters, and spells

Prerequisites

• Mimir installed on your computer
• Basic familiarity with D&D 5th Edition (helpful but not required)

Time Commitment

Each tutorial takes approximately 15-30 minutes to complete. You can complete them all in one sitting or spread them out over multiple sessions.

Ready to begin? Start with Your First Campaign.

Your First Campaign

This tutorial walks you through creating your first campaign in Mimir. By the end, you’ll have a fully configured campaign ready for adventure modules and session play.

Time to complete: 5-10 minutes

What you’ll learn:

• Navigate the Mimir interface
• Create a new campaign
• Explore the Campaign Dashboard
• Import catalog data for the next tutorials

Prerequisites

• Mimir installed and running
• No additional setup required

Step 1: Launch Mimir

When you launch Mimir, you’ll see the home screen with the floating Mimir skull and the tagline “Your arcane companion for D&D 5e campaign management.”

The header bar contains:

• Mimir logo (skull icon) - Click to return home
• Campaign selector - Switch between campaigns
• Characters - Create and manage PCs and NPCs
• Reference - Open the D&D 5e reference library
• Settings (gear icon) - Configure application preferences

Step 2: Create a New Campaign

1. Click the Campaign Selector dropdown in the header
2. Click Create New Campaign

The Create New Campaign form opens.

Step 3: Fill in Campaign Details

The campaign creation form has two fields:

Campaign Name (Required)

Enter a descriptive name for your campaign. This appears throughout Mimir and in exported materials.

Example: “Curse of Strahd”, “Homebrew - The Shattered Realms”, “One-Shot: Goblin Heist”

Description (Optional)

Add notes about your campaign concept, themes, or setting. This is for your reference only.

Example: “Gothic horror campaign set in the domain of Barovia. Players are trapped and must defeat the vampire Strahd von Zarovich.”

Step 4: Create the Campaign

Click Create Campaign. Mimir will:

1. Create the campaign in the database
2. Redirect you to the Campaign Dashboard

Step 5: Explore the Campaign Dashboard

The Campaign Dashboard is your command center for the entire campaign. It has a header showing your campaign name and tabs for the different aspects of your game — Campaign, Modules, NPCs, PCs, and Homebrew. See the Campaign Dashboard reference for what each tab contains; you’ll work in the Modules tab in the next tutorial.

Step 6: Campaign Actions

The dashboard header includes three buttons: Sources, PDF, and Export Archive.

Sources opens the Campaign Sources modal where you select which D&D source books are available for this campaign. This controls which monsters, items, and spells appear in catalog searches.

PDF exports campaign documents as a PDF file.

Export Archive creates a backup of your entire campaign including:

• All documents and notes
• Module data
• Maps and tokens
• Character assignments

Use this regularly for backups or when moving campaigns between computers.

Step 7: Import Catalog Data

Before the next tutorial you’ll need catalog data imported — Tutorial 2 searches the catalog for monsters, and Mimir ships with none. Follow Manage Campaign Sources to download a source archive and import it, then come back here.

What’s Next?

Your campaign is ready! Here are your next steps:

1. Create your first module - Build an adventure with maps and encounters
2. Add characters - Create PCs for your players
3. Explore the Reference - Browse monsters, spells, and items for inspiration

For details on anything you saw in this tutorial, see the Campaign Dashboard reference and Create a Campaign.

Next tutorial: Your First Module

Your First Module

This tutorial walks you through creating an adventure module in Mimir. By the end, you’ll have a module with maps, monsters, and tokens ready for play.

Time to complete: 15-20 minutes

What you’ll learn:

• Create a module within your campaign
• Upload and configure maps
• Add monsters from the D&D 5e catalog
• Place tokens on maps with the Token Setup tool
• Add light sources for dynamic lighting

Prerequisites

• A campaign created and catalog data imported (Tutorial 1)
• A map file: a PNG/JPG image or a UVTT file — a universal VTT export format that embeds grid, wall, and lighting data (see Map Formats). You can export UVTT from Dungeondraft, download maps from free map sites, or build one with Mimir’s map generator. Use a UVTT map if you can — to follow Tutorial 3’s fog-of-war steps you’ll need one (fog depends on UVTT wall data); a plain image works for everything else.

What is a Module?

In Mimir, a module is a self-contained adventure within your campaign. Think of it as a chapter or episode - “The Goblin Hideout”, “Dragon’s Lair”, or “The Haunted Manor”. Each module has its own:

• Maps and encounters
• Monsters and traps
• NPCs
• Session notes and documents

This separation lets you prepare adventures independently and reuse them across campaigns.

Step 1: Navigate to the Modules Tab

1. Open your campaign from the Campaign Selector
2. Click the Modules tab in the dashboard

You’ll see the module sidebar (left) and the main panel (right).

Step 2: Create a Module

1. Click the + button in the Modules section
2. In the Create Module dialog:
   • Module Name - Enter a descriptive name (e.g., “The Lost Mine - Cragmaw Hideout”)
   • Module Type - Select the type (Standard Adventure, Mystery, Dungeon Crawl, Heist, Horror, Political Intrigue)
   • Description (optional) - Add notes about the module
3. Click Create

Your new module appears in the modules list.

Step 3: Open the Module Dashboard

Click your new module in the modules list. The module dashboard opens in the main panel, with Play, PDF, and Delete buttons in its header and sections for documents, NPCs, maps, and dangers below.

Step 4: Upload a Map

1. In the Maps section, click the + button

2. Choose your map file:

   • Image files (PNG, JPG, WebP) - Standard map images
   • UVTT files - Universal VTT format with embedded grid data

3. Enter a Map Name for the map

4. Click Upload

The map appears as a card in the Maps section, showing its name and pixel dimensions.

Tip: UVTT files from tools like Dungeondraft include grid configuration automatically. For image files, you can configure the grid in Token Setup.

Step 5: Open Token Setup

The Token Setup modal is where you add monsters, place tokens, and configure your map.

1. Click your map’s card in the Maps section
2. The Token Setup modal opens showing:
   • Token Palette (left) - Token types and monster search
   • Map Canvas (center) - The map with grid overlay
   • Token Inventory (right) - Placed tokens and light sources

The palette has more token types than we’ll use here — see the Token Setup Modal reference for all of them.

Step 6: Add a Monster

This step searches the catalog, so it requires the source data you imported in Tutorial 1 (Manage Campaign Sources).

1. In the Token Palette, click Monster
2. Search for “Goblin”
3. Select Goblin from the search results
4. Click on the map to place the monster token

The goblin appears on the map and in the Token Inventory on the right. Repeat to place a second goblin if you like — drag tokens to reposition them, or click the × in the inventory to delete one.

Step 7: Add a Light Source

A light source feeds Mimir’s dynamic lighting — the engine that computes illuminated areas from lights and walls — and fog of war, which hides unexplored or unseen areas from players (see the glossary).

1. In the Token Palette, find the Light Sources section
2. Click Torch
3. Click on the map to place the torch

The torch appears in the Token Inventory under “Light Sources” with a Lit/Unlit toggle. It will illuminate the area around it in the DM Map window during play.

Step 8: Save and Close

Token placements save automatically. Click × or press Escape to close the Token Setup modal.

Your module is now ready for play!

What’s Next?

Your module is prepared with maps, monsters, and tokens. Continue to:

1. Run your first session - Use Play Mode to run an encounter
2. Add more content - Upload additional maps, add NPCs, create documents
3. Prepare multiple modules - Create the next chapter of your adventure

For full details on token placement, see Place Tokens on a Map and the Token Setup Modal reference.

Next tutorial: Running Your First Session

Running Your First Session

This tutorial walks you through running a game session with the DM Map window. You’ll learn how to open the battle map, place your party, control fog of war, show the map to players, and keep session notes.

Time to complete: 10-15 minutes

What you’ll learn:

• Open the DM Map window for a module
• Select the active map and place PC tokens
• Control fog of war
• Open the Player Display and move tokens during play
• Keep session notes
• End the session

Prerequisites

• A module with at least one map and some tokens (Tutorial 2)
• At least one PC created and assigned to the campaign — fog of war reveals around PC tokens, so you need a PC to see anything
• For the fog-of-war step, your map must be a UVTT file (it carries the wall data fog needs)

Step 1: Open the DM Map Window

1. Open your campaign and go to the Modules tab
2. Select your module from the sidebar
3. Click the Play button in the module header

A separate DM Map window opens showing your module’s battle map. Your main window stays on the campaign dashboard — keep it nearby, you’ll use it for monster stats and notes during play.

Step 2: Select Your Map

At the top left of the DM Map window is a Map dropdown.

1. Open the dropdown — it lists your module’s maps plus any campaign-level maps (suffixed “(Campaign)”)
2. Select the map you prepared in Tutorial 2 (the first module map is usually selected automatically)

The map loads in the window with its grid and the monster tokens and light sources you placed in Tutorial 2.

Step 3: Place Your PCs

PC tokens aren’t placed during prep — you add them at the table.

1. Click Add PCs in the map toolbar

A token appears for each PC assigned to the campaign, placed in a small formation in the top-left corner of the map. Drag each PC token to where the party enters the map.

To move any token: click and hold, drag, release. Tokens snap to grid squares.

Step 4: Turn On Fog of War

Fog starts off. To hide everything the party can’t see:

1. Click Fog in the map toolbar

On your view, areas outside the party’s vision turn semi-transparent gray; players see nothing there at all. While Fog is on, LOS (token line of sight) is forced on too, so enemies outside the party’s sight stay hidden automatically.

Note: The Fog and LOS buttons only appear for UVTT maps — fog needs the wall data UVTT files carry. On a plain image map, work with Reveal Map and per-token visibility instead (right-click a token → Hide from Players).

Try the ambient light dropdown too: set it to Dark and watch the visible area shrink to your placed torch and the PCs’ darkvision. See Control Fog of War for the full set of controls.

Step 5: Open the Player Display

The Player Display is a second window for your players (a TV, projector, or shared screen).

1. Click Display in the DM Map window’s top toolbar
2. A new window opens, and the button changes to Display On
3. Drag the new window to your player-facing screen

Players see the current map with fog applied, visible tokens only, and no names, stats, or controls. While the display is open, a Blackout button appears next to Display On — click it to black out the player screen while you reposition tokens or set up a reveal.

Step 6: Play

Now run the encounter:

• Move tokens by dragging them. The Player Display updates immediately, and fog recalculates as PC tokens move — drag a PC down a corridor and watch the visible area follow.
• Reveal hidden enemies by right-clicking a token and choosing Show to Players (or select it and press H).
• Look up monster stats in your main window: the module dashboard’s monster list opens a stat block panel when you click a monster. Double-clicking a monster token in the DM Map window selects that monster in the dashboard for you.

Step 7: Keep Session Notes

Every module comes with a Play Notes document. In your main window:

1. On the module dashboard, find Play Notes in the Documents panel
2. Click it to open the editor

Type initiative order, HP, rulings, and player decisions as you go — the editor auto-saves (“Saving…” then “Saved”). Notes persist between sessions and are included when you export the campaign.

Step 8: End the Session

When you’re done:

1. Click Display On to close the Player Display
2. Close the DM Map window

Token positions are saved automatically, so the next time you click Play, the map is exactly where you left it.

Next tutorial: Player Display Setup

Player Display Setup

This tutorial walks you through setting up and using the Player Display - a second window that shows your players what their characters can see while you maintain full DM control.

Time to complete: 5 minutes

What you’ll learn:

• Set up a second screen for players
• Open and control the Player Display
• Understand what players see vs. what you see
• Use Blackout mode for dramatic reveals

Prerequisites

• Completed Tutorial 3 (DM Map window basics)
• Ideally: a second monitor, TV, or projector for players

The Two-Screen Setup

The Player Display creates a two-screen experience:

This lets you manage everything behind the scenes while players see only what their characters would see.

Step 1: Connect Your Second Screen

Before opening the Player Display, connect your second screen:

• TV or Monitor - HDMI/DisplayPort connection
• Projector - For tabletop projection
• Extended Display - Not mirrored (each screen shows different content)

Display Arrangement

On your computer:

1. Open display settings
2. Set to “Extend” (not “Mirror”)
3. Arrange screens to match physical layout
4. Note which screen is secondary

Step 2: Open the DM Map Window

1. Open your campaign
2. Go to the Modules tab
3. Select a module and click Play — the DM Map window opens
4. Make sure a map is selected in the Map dropdown at the top left of the window

Step 3: Open the Player Display

In the DM Map window’s toolbar:

1. Click the Display button
2. A new window opens
3. The button changes to show Display On

Position the Window

Drag the Player Display window to your secondary screen:

1. Click and hold the window title bar
2. Drag to the player-facing screen
3. Maximize the window (or press F11 for fullscreen)

Tip: On macOS, you can use Mission Control to move windows between spaces. On Windows, use Win+Shift+Arrow keys.

Step 4: Understanding the Views

What You See (DM View)

Your view shows everything:

• All tokens (visible and hidden)
• Token names and labels
• Full toolbar and controls
• Line of sight visualization (debug overlays)

What Players See

The player display shows:

• The map image
• Fog of war based on PC positions
• Visible tokens only (no hidden enemies)
• Token images without names
• No controls or UI elements

Step 5: Controlling What Players See

Fog of War

With Fog enabled in the map toolbar (UVTT maps only — fog needs wall data), fog of war updates automatically based on:

• Where PC tokens are positioned
• Their vision radius (including darkvision)
• Active light sources
• Walls and obstacles

Move a PC token and watch the fog update in real-time on both screens.

Reveal Map Toggle

For situations where you want to show the whole map:

1. Find the Reveal Map toggle in the toolbar
2. Enable it to bypass fog of war
3. Disable it to restore fog of war

Use this for:

• Area maps without exploration
• Post-combat wrap-up
• Location reveals

Ambient Lighting

The ambient light level affects visibility:

Change this to match the in-game environment (dungeon, night, etc.).

Step 6: Using Blackout Mode

The Blackout button (a crossed-out-eye icon with the tooltip “Toggle Blackout”) appears next to Display On in the DM Map window toolbar while the display is open:

1. Click Blackout to hide everything from players
2. The player screen blacks out and shows “Display Paused”
3. Click again to restore the view

Blackout is handy whenever you want to change something without the players watching — setup, map transitions, or a dramatic reveal.

Step 7: Closing the Display

When your session ends:

1. Click the Display On button again, or
2. Close the player display window directly
3. The button returns to Display

The DM Map window stays open - you can reopen the display anytime.

Setup Tips

For in-person play, position the TV, monitor, or projector so all players can see it, and adjust brightness for the room. For remote play, screen-share the Player Display window through your video call app.

If something isn’t working, see Troubleshooting.

Next Steps

You can now create campaigns, build modules with maps and encounters, run sessions with fog of war, and use a second screen for players. One tutorial remains: creating your own homebrew content.

Next tutorial: Creating Homebrew Content

Creating Homebrew Content

This tutorial walks you through creating custom items, monsters, and spells for your campaign. By the end, you’ll have homebrew content integrated into your modules and character sheets.

Time to complete: 10-15 minutes

What you’ll learn:

• Create a custom magic item from scratch
• Clone a catalog monster and modify it
• Clone a catalog spell and customize it
• Use homebrew content in modules and on characters

Prerequisites

• A campaign created (Tutorial 1)
• Catalog data imported (Manage Campaign Sources) — monsters, items, and spells should appear in Reference searches
• A module with a map (Tutorial 2) — Step 5 places the homebrew monster via Token Setup
• A PC created and assigned to the campaign — Step 5 adds the item and spell to a character sheet; the spell step needs a spellcaster

What is Homebrew?

In D&D, “homebrew” means custom content created by the DM. Mimir’s homebrew system lets you create items, monsters, and spells that live alongside the official catalog data. Homebrew content is scoped to a campaign — your custom sword in one campaign doesn’t appear in another.

Step 1: Open the Homebrew Tab

1. Open your campaign from the Campaign Selector
2. Click the Homebrew tab in the dashboard

You’ll see three sub-tabs: Items, Monsters, and Spells.

Step 2: Create a Custom Magic Item

Let’s create a unique magic sword for your campaign.

1. Click the Items sub-tab

2. Fill in the item form on the right panel:

   • Name: “Frostbrand Falchion”
   • Item Type: weapon
   • Rarity: rare
   • Requires Attunement: checked

3. The form expands to show weapon-specific fields:

   • Category: Martial
   • Bonus: +1
   • Damage: 2d4
   • Damage Type: Slashing
   • Properties: Select “Finesse” and “Light”

4. In the Description field, write:

   This curved blade is forged from ice-steel mined in the Frostfell. On a hit, the target takes an additional 1d6 cold damage. While attuned, you have resistance to fire damage.

5. Click Create Item

Your item appears in the homebrew items list with an HB badge.

Step 3: Create a Custom Monster

Monster stat blocks are complex, so Mimir uses a clone-only approach: you start from a catalog monster and modify it.

1. Click the Monsters sub-tab
2. Click Clone from Catalog
3. Search for “Goblin” — we’ll create a goblin variant
4. Click “Goblin” in the results

The cloned monster appears in your list immediately. The detail view shows “Based on Goblin.”

5. Select the new monster and click Edit

6. Change the Name to “Goblin Firestarter”

7. In the JSON data, you can modify:

   • Hit points
   • Armor class
   • Actions and abilities
   • Challenge rating

8. Save your changes

Tip: The stat block is edited as JSON in the 5etools data format, but you don’t need to understand the full structure to make simple changes — find the field you want (like "hp" or "ac") and update its value. See Create a Homebrew Monster and The Homebrew System for how this data is structured and stored.

Step 4: Create a Custom Spell

Like monsters, spells are cloned from the catalog.

1. Click the Spells sub-tab
2. Click Clone from Catalog
3. Search for “Burning Hands”
4. Click it to create a homebrew copy
5. Select the new spell and click Edit
6. Change the Name to “Freezing Hands”
7. In the JSON data, change:
   • The damage type from fire to cold
   • Update the description text accordingly
8. Save your changes

Spell data uses the same JSON editing approach as monsters — see Create a Homebrew Spell for the details.

Step 5: Use Homebrew in Your Module

Now let’s use the homebrew content you’ve created.

Add the Monster to a Module

1. Go to the Modules tab and open a module
2. Click a map to open Token Setup
3. In the Monster palette, search for “Goblin Firestarter”
4. Your homebrew monster appears in the results with an HB badge
5. Click it and place the token on the map

Add the Item to a Character

1. Go to the PCs tab and open a character sheet
2. Navigate to the Equipment tab
3. Click Add Item
4. Search for “Frostbrand Falchion”
5. Your homebrew item appears with an HB badge
6. Add it to the character’s inventory

Add the Spell to a Character

1. On a spellcasting character’s sheet, go to the Spells tab
2. Click Add Spell
3. Search for “Freezing Hands”
4. Your homebrew spell appears alongside catalog spells
5. Add it to the character’s known spells

How It All Fits Together

Campaign: "The Frozen North"
├── Homebrew Items: Frostbrand Falchion
├── Homebrew Monsters: Goblin Firestarter
├── Homebrew Spells: Freezing Hands
├── Module: "The Ice Caves"
│   └── Tokens: Goblin Firestarter × 3
└── Characters
    └── "Kira the Ranger"
        ├── Inventory: Frostbrand Falchion (equipped, attuned)
        └── Spells: Freezing Hands (prepared)

Homebrew content is campaign-scoped, so it travels with your campaign when you export it as an archive.

What’s Next?

You’ve learned the three homebrew workflows. Continue exploring:

1. Create more items — Full item field reference including armor types
2. Browse the catalog — Search Reference for inspiration on what to clone
3. Experiment — Clone a high-CR monster, reduce its stats, and create a weakened variant for lower-level play

Previous tutorial: Player Display Setup

How-To Guides

These practical guides help you accomplish specific tasks in Mimir. Unlike tutorials, how-to guides assume you already know the basics and need quick, focused instructions for a particular goal.

By Topic

Campaigns

• Create a Campaign
• Manage Documents
• Manage Sources
• Archive & Restore
• Export Campaign

Maps

• Upload a Map
• Configure Grid
• Place Tokens
• Manage Light Sources
• Print Maps
• Generate Maps
• Mapgen Standalone Tool

Characters

• Create a Player Character
• Create an NPC
• Assign to Campaign
• Manage Inventory
• Manage Spells
• Level Up
• Print Character Sheet

Modules

• Create a Module
• Add Monsters
• Module Documents

Play Mode

• Start a Session
• Manage Encounters
• Fog of War
• Manage Traps & POIs
• Use Player Display

Homebrew

• Create Items
• Create Monsters
• Create Spells

AI Assistant

• AI Assistant

Can’t find what you’re looking for? Check the Reference section for detailed documentation of all features.

Campaigns

How-to guides for creating and managing campaigns.

• Create a Campaign - Start a new campaign
• Manage Documents - Organize campaign documents
• Export Campaign - Backup and transfer campaigns

Create a Campaign

This guide shows you how to create a new campaign in Mimir and configure it for your game.

Steps

1. Open the Campaign Selector in the header bar
2. Click + New Campaign
3. Fill in the campaign details:
   • Campaign Name (required) — A descriptive name for your campaign
   • Description (optional) — Notes about your campaign concept, themes, or setting
4. Click Create Campaign

You’ll be redirected to your new campaign’s dashboard.

What Gets Created

When you create a campaign, Mimir automatically generates 11 template documents to give you a starting structure: Campaign Pitch, Starting Scenario, World Primer, Character Guidelines, Table Expectations, Character Integration, Campaign Bible, Safety Tools, House Rules, Player Secrets, and Faction Overview. These appear in the Campaign tab of your dashboard. Edit or delete them as needed — they’re a starting point, not a requirement.

Configure Campaign Sources

After creating your campaign, you’ll likely want to configure which D&D source books are available:

1. Click the Sources button in the dashboard header
2. Enable the books your group owns or you want to use
3. Close the modal

Source filtering affects all catalog searches within this campaign — monster searches, spell lists in character creation, item lookups, and more. A “PHB only” campaign won’t show Xanathar’s Guide content.

Tips

• Use descriptive names that help you identify campaigns later (e.g., “Curse of Strahd - Tuesday Group” rather than just “Campaign 1”)
• The description is only visible to you — use it for notes about themes, players, or campaign status
• Configure sources early — it controls what content appears throughout the campaign
• You can archive campaigns you’re no longer running to keep your list clean

See Also

• Tutorial: Your First Campaign
• Manage Documents
• Export Campaign
• Campaigns vs Modules — Understanding the hierarchy

Manage Documents

Mimir uses documents to organize campaign and module content — session notes, location descriptions, lore, encounter plans, and anything else you need for your game.

Document Scope

Documents belong to either a campaign or a module:

• Campaign documents — World-building, lore, factions, and setting notes. Created from the Campaign tab on the dashboard.
• Module documents — Session prep, encounter notes, and location descriptions. Created within a specific module’s prep view.

Creating a Document

1. Navigate to where you want the document:
   • Campaign tab for campaign-level documents
   • Module prep view for module documents
2. Click the + button in the document sidebar
3. Choose between two modes:
   • New Document — Enter a title and create a blank markdown document
   • Upload File — Drag and drop (or browse for) a markdown file or image. Supported formats: .md, .png, .jpg, .jpeg, .webp, .gif, .svg
4. Click Create

Editing Documents

Click a document in the sidebar to open it in the rich text editor.

The editor supports:

• Headings — H1, H2, H3
• Formatting — Bold, italic, strikethrough
• Lists — Bullet and numbered lists
• Blocks — Blockquotes, horizontal rules
• Tables — Insert and manage tables with rows and columns
• Undo/Redo — Full history support

Documents are written in Markdown under the hood. The editor renders markdown visually while preserving the underlying format.

Auto-Save

Changes save automatically as you type (after a brief pause). A status indicator shows:

• Saving… — Changes being written
• Saved — All changes persisted

There is no manual save button — your work is always preserved.

PDF Export

Click the Export PDF button in the editor header to export the current document as a PDF.

Reordering Documents

Documents can be reordered using the up/down arrow buttons that appear when you hover over a document in the sidebar. This controls the display order within that document’s scope (campaign or module).

Deleting Documents

Hover over a document in the sidebar to reveal a delete button (trash icon). Click it and confirm to remove the document. This is permanent.

Session Notes

Every module gets an auto-created Play Notes document for in-session tracking (HP, initiative, events). Open it from the module’s Documents panel during play — it auto-saves like any other document.

See Also

• Create a Campaign
• Module Documents
• Start a Session

Manage Campaign Sources

Configure which D&D source books are available in your campaign.

Import Source Data

Before you can use catalog content (monsters, spells, items), source data must be imported into Mimir.

Mimir imports .tar.gz archives of JSON data in the format established by the 5etools community project. Pre-packaged archives are available from the Mimir Resources releases page; download both the data archive and the matching image archive.

1. Click the Settings gear icon in the header bar
2. Under Admin Tools, click Import Books
3. In the Manage Catalog Sources modal, click Import 5etools Data
4. Select the data archive (.tar.gz)
5. Wait for the import to complete — this may take a few minutes for large archives
6. (Optional) Click Import Images and select the image archive to add token art and book illustrations

After import, the source books appear in the Manage Catalog Sources list.

Configure Sources for a Campaign

Each campaign can restrict which source books are available, letting you run a “PHB only” game or include supplements selectively.

1. Open your campaign dashboard
2. Click the Sources button in the header
3. Toggle source books on or off
4. Close the modal

Changes take effect immediately — catalog searches within this campaign now filter by the enabled sources.

Disable or Remove a Source

To disable a source book for a specific campaign:

1. Open Campaign Sources (dashboard → Sources button)
2. Toggle the book off

To remove a source book entirely from Mimir:

1. Click the Settings gear icon, then click Import Books under Admin Tools
2. Check the box next to each source book you want to remove
3. Click Delete Selected, then confirm

Removing a source deletes all catalog entries from that book. Campaign data (characters, homebrew, documents) is not affected.

Tips

• Configure sources early when creating a campaign — it controls what appears in all catalog searches
• Characters can optionally have their own source restrictions, independent of the campaign (useful when players own different books)
• Imported data is stored locally in your SQLite database — no internet connection is needed after import

See Also

• Create a Campaign — Initial campaign setup
• The Catalog System — How source data works
• Troubleshooting: Missing catalog data

Archive and Restore Campaigns

Hide completed or inactive campaigns without deleting them.

Archive a Campaign

1. Open the campaign you want to archive
2. In the campaign dashboard header, click the Archive action
3. Confirm the archive

The campaign disappears from the default campaign list but all data is preserved.

View Archived Campaigns

1. Open the Campaign Selector dropdown in the header
2. Toggle the Show Archived option
3. Archived campaigns appear in the list, marked as archived

Restore an Archived Campaign

1. View archived campaigns (see above)
2. Select the archived campaign
3. Click Unarchive in the dashboard header
4. The campaign returns to the active campaign list

Archive vs Delete

Archive first, delete only when you’re certain you no longer need the campaign.

See Also

• Export Campaign — Create a portable backup before archiving
• Create a Campaign

Export Campaign

Export your campaign as a portable archive for backup or transfer.

Steps

1. Open your campaign dashboard
2. Click Export Archive in the campaign header
3. Choose a save location
4. The campaign exports as a .mimir-campaign.tar.gz archive

What’s Included

The archive contains:

• Campaign metadata and settings
• All module data
• Maps and token positions
• Documents and session notes
• Character assignments

Use Cases

• Backup - Regular exports protect against data loss
• Transfer - Move campaigns to another computer
• Sharing - Send a campaign to another DM

Importing

To import an exported campaign:

1. Open the Campaign Selector dropdown in the header
2. Click Import Campaign
3. Select the .mimir-campaign.tar.gz file
4. The campaign appears in your campaign list

See Also

• Create a Campaign
• Print Maps - For PDF output

Maps

How-to guides for working with battle maps.

• Upload a Map - Add map images and UVTT files
• Configure Grid - Align the grid overlay
• Place Tokens - Add tokens to your map
• Manage Light Sources - Set up dynamic lighting
• Print Maps - Export maps for printing

Upload a Map

Add battle maps and area maps to your campaign modules.

Supported Formats

Steps

1. Open a module from the Modules tab
2. Find the Maps section in the module dashboard
3. Click the + button
4. Choose your map file
5. Enter a Name for the map
6. Click Upload

The map appears as a card in the Maps section. Click it to open Token Setup.

UVTT Files (Recommended)

UVTT files from tools like Dungeondraft include grid, wall, door, and lighting data that Mimir imports automatically. This gives you line-of-sight fog of war, accurate token snapping, and dynamic lighting out of the box.

See Map Formats for details on what UVTT files contain and why they’re preferred.

Image Files

Standard image files work for basic token placement but lack wall data, so fog of war is not available — the Fog and LOS controls only appear for UVTT maps. On image maps, use the Reveal Map toggle and per-token Hide from Players instead. Mimir defaults to 70 pixels per grid square. See Configure Grid for details.

Generated Maps

Maps produced by mimir-mapgen are .dungeondraft_map files. Mimir cannot open .dungeondraft_map files directly — map uploads accept only UVTT (.dd2vtt, .uvtt) and image files. To use a generated map in Mimir, open it in Dungeondraft (a paid tool) and export it as Universal VTT.

Tips

• Always prefer UVTT when available — fog of war and dynamic lighting only work on UVTT maps
• Maps can belong to a specific module or to the campaign at large
• You can upload multiple maps per module (one per room/area is common for dungeon crawls)

See Also

• Configure Grid — Grid alignment details
• Place Tokens — Adding monsters and NPCs to maps
• Map Formats — Understanding UVTT and alternatives
• Generate Maps — Create maps procedurally

Verify Grid Alignment

How to check that your map’s grid matches Mimir’s grid overlay, and what to do if it doesn’t.

Goal

Ensure that tokens snap to the correct grid squares on your map.

Steps

For UVTT Files

1. Upload your UVTT file (see Upload a Map)
2. Open Token Setup by clicking the map card
3. Verify: The grid overlay should align with the map’s drawn grid lines
4. Place a test token — it should snap to the center of a grid square

UVTT files embed grid data (cell size, offset, dimensions), so alignment is automatic. If the grid looks correct, you’re done.

For Image Files

1. Upload your image file
2. Open Token Setup by clicking the map card
3. Check alignment: Mimir defaults to 70 pixels per grid square, starting from the top-left corner
4. If the overlay grid lines align with the map’s drawn grid, you’re ready to place tokens

If the Grid Doesn’t Align (Image Files)

If your image uses a non-standard grid size (e.g., 100px squares), the overlay won’t match the map artwork. Options:

1. Obtain the UVTT version of the map if available — this is the best fix
2. Use the map as a visual backdrop and position tokens by eye rather than relying on snap-to-grid

How Token Snapping Works

• Tokens snap to grid centers when placed
• Token size respects the grid — a Large creature occupies a 2×2 area, Huge occupies 3×3
• The grid overlay in Token Setup shows exactly where tokens will land

See Also

• Upload a Map — Supported formats and upload steps
• Place Tokens — Adding tokens to the grid
• Fog of War — How fog interacts with grid and walls
• Map Formats — Understanding UVTT and image formats

Place Tokens

Place monsters, NPCs, traps, markers, and light sources on your maps.

Open Token Setup

1. Navigate to a module (Modules tab → select module)
2. Find your map in the Maps section
3. Click the Place Tokens button on the map card to open Token Setup

Token Palette

The left panel shows available tokens:

• Monsters - Creatures added to this module
• NPCs - Non-player characters assigned to the module
• Traps - Hazards and traps
• Markers - Points of interest
• Light Sources - Torches, lanterns, candles

Placing a Token

1. Click a token in the palette
2. Configure options (size, color, visibility)
3. Click on the map where you want to place it
4. The token appears at that location

Token Options

Before placing, you can set:

• Size - Tiny, Small, Medium, Large, Huge, Gargantuan
• Color - Border color for identification
• Visible to Players - Whether players can see this token

Managing Placed Tokens

Tokens appear in the Placed Tokens panel (right side):

• Click to select on the map
• Drag to reposition
• Click × to delete
• Right-click for options

Moving Tokens

1. Click and drag a token
2. Move to the new position
3. Release to place

Tokens snap to grid squares by default.

Tips

• Place monsters before the session starts
• Use different colors to distinguish groups
• Hide tokens for surprise encounters

See Also

• Manage Light Sources
• Configure Grid

Manage Light Sources

Light sources affect visibility in fog of war. This guide covers placing and controlling lights.

Light Source Types

Placing Light Sources

1. Open Token Setup (click the Place Tokens button on a map card)
2. Find Light Sources in the Token Palette
3. Click a light type (Torch, Lantern, or Candle)
4. Click on the map to place

Light Source Inventory

Placed light sources appear in the right panel under “Light Sources”:

• Each light shows its type
• Lit/Unlit button toggles the light
• × button deletes the light

Toggling Lights

In Token Setup

Click the Lit/Unlit button next to any light source in the inventory.

In Play Mode

Right-click a light source on the map to toggle it.

How Lights Affect Visibility

• Lit - Expands visible area for all tokens
• Unlit - No effect on visibility
• Lights work with PC darkvision to determine what players see

Use Cases

• Torches on walls - Simulate dungeon lighting
• Lanterns with party - Light source that moves with PCs
• Candles on tables - Ambient lighting for atmosphere

Tips

• Place lights at choke points for dramatic reveals
• Toggle lights during play for effect (torch goes out!)
• Combine with ambient light settings for atmosphere

See Also

• Place Tokens
• Fog of War
• Vision & Lighting Reference

Print Maps

Export maps to PDF for physical play or reference.

Steps

1. Open Play Mode for your module
2. Select the map you want to print
3. Click the Print button in the map toolbar
4. Configure print sections (see below)
5. Click Generate PDF
6. Preview the PDF, then save to your chosen location

Print Sections

The print dialog has two independent sections that can be enabled together or separately.

Preview

Fits the entire map on a single page — useful for DM reference or handouts.

Options:

• Grid — Overlay the grid on the map
• LOS Walls — Show line-of-sight wall positions
• Starting Positions — Show where tokens are placed

Play

Prints at 1 inch = 5 feet scale, tiled across multiple pages for physical tabletop play. The dialog shows an estimated page count when tiling is needed.

Options:

• Grid — Overlay the grid on the map
• LOS Walls — Show line-of-sight wall positions
• Token Cutouts — Generate printable circular token images

Token Cutouts

When enabled in the Play section, the PDF includes a sheet of circular token images that can be cut out for use as physical tokens on the printed map.

Tips

• Use the Preview section for quick DM reference sheets
• Use the Play section with token cutouts for a complete physical play kit
• Enable both sections to get everything in one PDF

See Also

• Upload a Map
• Export Campaign

Generate a Map

Use Mimir’s mapgen tool to procedurally generate Dungeondraft-format maps from biome presets or custom YAML configurations.

What Mapgen Creates

Mapgen generates .dungeondraft_map files containing:

• Noise-based terrain with blended textures
• Trees, grass, and other vegetation
• Roads and rivers that follow the terrain
• Rooms with walls, doors, and windows
• Water bodies, elevation contours, and lighting
• Polygon-based layouts for irregular room shapes

Output files open directly in Dungeondraft for further editing or UVTT export. Mimir cannot open .dungeondraft_map files directly — to use a generated map in Mimir, open it in Dungeondraft (a paid tool) and export it as Universal VTT.

Quick Start: Using a Preset

Prerequisite: the mimir-mapgen binary is not bundled with the Mimir app. Either download a pre-built binary from GitHub Releases (attached to each release for every platform) or build it from source with cargo build -p mimir-mapgen --release. See Install and Use Mapgen as a Standalone Tool for details.

Generate a map from one of 12 built-in biome presets:

mimir-mapgen generate --preset forest --output my-forest.dungeondraft_map

Use a specific seed for reproducible results:

mimir-mapgen generate --preset forest --seed 42 --output my-forest.dungeondraft_map

List Available Presets

mimir-mapgen list-presets

Example presets:

See the Mapgen Reference for the full table of all 12 presets and their aliases.

Custom YAML Configs

For full control, write a YAML configuration file:

name: "Forest Clearing"
width: 32
height: 32
seed: 42

terrain:
  slots:
    - texture: "res://textures/terrain/terrain_grass.png"
      lower: 0.0
      upper: 0.5
    - texture: "res://textures/terrain/terrain_dirt.png"
      lower: 0.4
      upper: 0.7
    - texture: "res://textures/terrain/terrain_stone.png"
      lower: 0.6
      upper: 0.9
    - texture: "res://textures/terrain/terrain_gravel.png"
      lower: 0.8
      upper: 1.0
  blend_width: 0.05
  smooth_blending: true

trees:
  - tree:
      textures:
        - "res://textures/objects/more_trees/oak_01.png"
        - "res://textures/objects/more_trees/oak_02.png"
      min_distance: 500.0
      noise_lower: 0.4
      noise_upper: 0.75
      probability: 0.5
      scale_min: 0.8
      scale_max: 1.2
      layer: 300
      random_rotation: true
      random_mirror: true

roads:
  - {}

Generate from the config:

mimir-mapgen generate config.yaml --output clearing.dungeondraft_map

Validate a Config

Check a config for errors without generating:

mimir-mapgen validate config.yaml

Iterating on Maps

Maps are deterministic — the same seed and config produce the same map. To iterate:

1. Generate with a specific seed
2. Open in Dungeondraft and review
3. Adjust config parameters
4. Regenerate with the same seed to compare changes
5. Try different seeds for different terrain layouts

Using via AI Assistant

Mapgen is also available as an MCP tool (generate_map) through Mimir’s AI assistant integration. Describe the scene you want — “a misty forest clearing with a road” — and the assistant will build the YAML config and generate the map for you.

See Also

• Install and Use Mapgen as a Standalone Tool — Installation and a full worked example
• Upload a Map — Import maps into Mimir modules (UVTT or image files)
• Mapgen Reference — Full YAML schema and configuration details

Install and Use Mapgen as a Standalone Tool

mimir-mapgen is a self-contained procedural map generator that creates Dungeondraft-compatible .dungeondraft_map files. It has no dependency on Mimir’s database, UI, or MCP server — you can build it independently and use it as a command-line tool anywhere.

Note that Mimir itself cannot open .dungeondraft_map files directly — Mimir’s map upload accepts only UVTT (.dd2vtt, .uvtt) and image files. To use a generated map in Mimir, open it in Dungeondraft (a paid tool) and export it as Universal VTT.

Prerequisites

• Rust toolchain (1.75+) — install via rustup (only needed when building from source)
• Dungeondraft — to open and edit generated maps (or export to UVTT for Mimir, Foundry VTT, or Roll20)

Installation

From GitHub Releases

Pre-built mimir-mapgen binaries for each platform are attached to Mimir’s GitHub releases. Download the binary for your platform and put it on your $PATH.

From Source

Clone the repository and build just the mapgen crate:

git clone https://github.com/mimir-dm/mimir.git
cd mimir
cargo build -p mimir-mapgen --release

The binary is at target/release/mimir-mapgen. Copy it somewhere on your $PATH:

cp target/release/mimir-mapgen /usr/local/bin/

Verify Installation

mimir-mapgen --help

Quick Start

Generate a map from a built-in preset:

mimir-mapgen generate --preset forest -o forest.dungeondraft_map

Open forest.dungeondraft_map in Dungeondraft. Done.

Other useful commands:

mimir-mapgen list-presets             # show all 12 biome presets
mimir-mapgen validate config.yaml     # check a YAML config without generating
mimir-mapgen generate --preset forest --seed 42 -o forest.dungeondraft_map   # reproducible output

See the Mapgen Reference for the full CLI flags, the complete preset table, and every YAML schema field.

Worked Example: Island Fort

A custom YAML config combining island mode, a walled room, water, and trees:

name: "Island Fort"
width: 32
height: 32
seed: 42

noise:
  octaves: 5
  persistence: 0.5
  lacunarity: 2.0
  scale: 0.035

island_mode: 1.0

terrain:
  slots:
    - texture: "res://textures/terrain/terrain_grass.png"
      lower: 0.0
      upper: 0.35
    - texture: "res://textures/terrain/terrain_moss.png"
      lower: 0.3
      upper: 0.55
    - texture: "res://textures/terrain/terrain_dry_grass.png"
      lower: 0.5
      upper: 0.75
    - texture: "res://textures/terrain/terrain_sand.png"
      lower: 0.7
      upper: 1.0
  blend_width: 0.06
  smooth_blending: true

rooms:
  - id: "fort"
    x: 12
    y: 12
    width: 8
    height: 8
    terrain_slot: 0
    portals:
      - wall: south
        position: 3
        type: door

trees:
  - tree:
      textures:
        - "res://textures/objects/more_trees/oak_01.png"
        - "res://textures/objects/more_trees/oak_02.png"
      min_distance: 350.0
      noise_lower: 0.0
      noise_upper: 0.5
      probability: 0.6
      scale_min: 0.8
      scale_max: 1.2
      layer: 300
      random_rotation: true
      random_mirror: true

water:
  threshold: 0.85
  deep_color: "ff1a6b5a"
  shallow_color: "ff30b89a"
  blend_distance: 60.0
  min_contour_points: 6
  smooth_iterations: 5
  pixels_per_cell: 64.0

Generate it:

mimir-mapgen generate island_fort.yaml -o island_fort.dungeondraft_map

How it works:

• island_mode applies a radial falloff so the center stays low (land) and edges rise — combined with water.threshold: 0.85, the high-noise edges become ocean.
• The four terrain.slots blend grass through sand as noise increases, so beaches appear near the water.
• The fort room is placed in grid squares; trees and other outdoor features automatically route around it.
• The trees entry is a full object config — all placement fields (min_distance through random_mirror) are required.

For the many other sections you can add (roads, rivers, lakes, lights, polygons, pattern fills, materials, and more), see the Mapgen Reference.

Iterative Workflow

Maps are deterministic — the same seed + config always produces the same result. Use this for rapid iteration:

1. Generate with a fixed seed
2. Open in Dungeondraft and review
3. Tweak config parameters (tree density, road width, room positions)
4. Regenerate with the same seed to see only your changes
5. Try different seeds to explore different terrain layouts

Run mimir-mapgen validate config.yaml after each edit to catch schema and layout errors before generating.

Example Configs

The crates/mimir-mapgen/examples/ directory contains YAML configs and pre-generated maps for every biome preset plus multi-feature configs like tavern_river.yaml and island_fort.yaml.

See Also

• Mapgen Reference — Full CLI, preset table, and YAML schema with all fields documented
• Dungeondraft Texture Catalog — Available res:// texture paths
• Generate Maps (Mimir Integration) — Using mapgen through Mimir’s UI and MCP tools

Characters

How-to guides for creating and managing characters.

• Create a Player Character - Build a PC
• Create an NPC - Add non-player characters
• Assign to Campaign - Link characters to campaigns
• Manage Inventory - Add items, equip gear, track currency
• Manage Spells - View and manage character spells
• Level Up - Advance a character to the next level
• Print Character Sheet - Export character sheets

Create a Player Character

Create player characters using the character creation wizard.

Access the Character Creator

1. Click Characters in the header
2. Click Create Character

Character Creation Wizard

The wizard guides you through seven steps:

Step 1: Basics

• Character name
• Player name (who plays this character)

Step 2: Race

• Select race from the campaign’s enabled sources
• Race determines racial traits and ability score options

Step 3: Class

• Select class (Fighter, Wizard, Rogue, etc.)
• Set starting level
• Choose subclass if applicable

Step 4: Background

• Select a background (Acolyte, Criminal, Noble, etc.)
• Background grants proficiencies, languages, and starting equipment

Step 5: Abilities

• Set ability scores
• See computed modifiers

Step 6: Skills

• Choose skill proficiencies based on class and background options
• See computed skill bonuses

Step 7: Review

• Review all selections
• Make final adjustments
• Click Create Character

After Creation

Your character appears in the Characters list and is available for campaign assignment. The character sheet has four tabs:

• Character — Stats, combat info, ability scores, saving throws
• Equipment — Inventory and item management
• Spells — Complete class spell reference for caster classes (spell details, spell slots)
• Details — Background, personality traits, ideals, bonds, flaws

Editing Characters

1. Click a character in the list
2. Open the character sheet
3. Edit sections directly
4. Changes auto-save

Tips

• Get character info from players before creating
• Use the wizard for complete characters
• Quick-create for NPCs doesn’t need all steps
• Level up uses a separate dialog

See Also

• Assign to Campaign
• Print Character Sheet

Create an NPC

Create non-player characters for your campaigns and modules.

Steps

NPCs are created from the campaign dashboard:

1. Open your campaign dashboard
2. Go to the NPCs tab
3. Click Create NPC

NPC Creation

NPC creation is simplified — only a name is required. Optional fields can be filled in during creation or edited later:

1. Enter the NPC Name (required)
2. Optionally fill in:
   • Race — The NPC’s race
   • Role — Their function in the story (e.g., shopkeeper, quest giver, villain)
   • Location — Where the party finds them
   • Faction — Organization or group affiliation
3. Click Create

Assigning NPCs

NPCs can be assigned to:

• Campaign - Recurring characters across modules
• Module - Location-specific NPCs

NPC vs Monster

Use NPCs for important characters the party interacts with socially.

Tips

• Create NPCs during prep, not at the table
• Keep descriptions brief but memorable
• Include one distinctive trait or quirk
• Link to relevant plot threads in notes

See Also

• Create a Player Character
• Assign to Campaign

Assign to Campaign

Add characters to a campaign so they appear in Play Mode.

Assigning Player Characters

From the Campaign Dashboard

1. Open your campaign
2. Go to the PCs tab
3. Click Add Existing to assign an existing character, or Create PC to make a new one
4. Select a character and click Add to Campaign

From the Character List

1. Click Characters in the header
2. Find an unassigned character
3. Select a campaign from the dropdown — the character is assigned immediately

Assigning NPCs

Campaign-Level NPCs

1. Open your campaign dashboard
2. Go to the NPCs tab
3. Click Create NPC to add a new NPC

Module-Level NPCs

1. Open a module
2. Find the NPCs section
3. Click + to add an NPC
4. Select from campaign NPCs or create new

What Assignment Does

Assigned PCs appear in:

• Campaign PCs tab
• Play Mode sidebar
• “Add PCs” button functionality

Assigned NPCs appear in:

• Campaign or module NPC lists
• Token placement palette

Removing Characters

1. Find the character in the campaign tab
2. Click the remove button
3. Character returns to unassigned

The character isn’t deleted - just removed from the campaign.

Tips

• Assign all PCs before the first session
• NPCs can belong to multiple modules
• Characters can be in multiple campaigns

See Also

• Create a Player Character
• Create an NPC

Manage Character Inventory

Add items, equip gear, attune magic items, and track currency on the Equipment tab.

Accessing the Equipment Tab

1. Click Characters in the header
2. Select a character
3. Click the Equipment tab in the character sheet

Clicking opens the Inventory & Equipment dialog, which has three tabs: Inventory, Equipment, and Currency.

Inventory Tab

Adding Items

1. Click + Add Item
2. Use the search box to find items (minimum 2 characters)
3. Select an item from the dropdown results — both catalog and homebrew items appear
4. Set the Quantity and optional Notes
5. Click Add to Inventory

Homebrew items are marked with an HB badge.

Viewing and Removing Items

Your inventory lists all items with:

• Item name and source badge
• Quantity (shown as x2, x3, etc.)
• Equipped status
• Notes (if any)

Click the − button to remove an item.

Equipment Tab

Toggle items as equipped or unequipped using checkboxes. All inventory items appear in this list — check the box next to an item to mark it as equipped.

Attunement

Below the equipped items list, the Attuned Items section shows magic items eligible for attunement with a counter (e.g., “Attuned Items 2/3”). Check the box to attune an item. The D&D 5e limit of 3 attuned items is enforced.

Currency Tab

Track character wealth with four fields:

• Platinum (pp)
• Gold (gp)
• Silver (sp)
• Copper (cp)

A total gold value is calculated and displayed below.

See Also

• Create a Player Character
• Print Character Sheet — Equipment Cards print option

Manage Character Spells

View and manage spells for spellcasting characters.

Accessing the Spells Tab

1. Click Characters in the header
2. Select a spellcasting character
3. Click the Spells tab in the character sheet

Note: The Spells tab only appears for characters with a spellcasting class (Wizard, Cleric, Bard, etc.). Non-casters won’t see this tab.

Spells Tab Overview

The Spells tab displays three sections:

Spellcasting Stats

Shows your spellcasting fundamentals:

• Spell Save DC — Difficulty class for saving throws against your spells
• Spell Attack — Your modifier for spell attack rolls
• Spellcasting Ability — Which ability score powers your spells

For multiclass characters, stats are shown for each spellcasting class separately.

Spell Slots

Displays available spell slots by level (1st through 9th). Cantrips are marked as unlimited.

Available Spells

Your class spells grouped by level (Cantrips through 9th level). Each level header shows the spell count and can be expanded or collapsed.

Each spell card shows:

• Spell name and school of magic
• Tags: HB (homebrew), R (ritual), C (concentration)
• Expand a spell to see full details: casting time, range, components, duration, and description

How Spell Management Works

Mimir displays all possible spells for your class — spell preparation and selection is a table activity managed by the player during the game. The Spells tab serves as a complete reference so players can browse their full spell list and look up details on the fly.

Homebrew Spells

Homebrew spells created in the campaign’s Homebrew tab automatically appear alongside catalog spells in the character’s spell list, tagged with HB.

See Also

• Create a Player Character
• Print Character Sheet — Spell Cards print option

Level Up a Character

Advance a character to the next level using the level-up dialog.

Steps

1. Click Characters in the header
2. Find your character in the list
3. Click the Level Up button on the character card
4. Work through the dialog steps
5. Click Confirm Level Up on the final step

Level-Up Dialog

The dialog guides you through the relevant steps for your class and level. Steps that don’t apply are skipped automatically.

Step 1: Select Class

Choose which class to level up. For multiclass characters, you can select an existing class or add a new one.

Step 2: Choose Subclass

Only appears at subclass selection levels (e.g., level 3 for most classes).

Pick a subclass for the chosen class.

Step 3: Hit Points

Choose how to gain HP for the new level:

• Average — Take the class’s fixed average
• Roll — Roll the hit die
• Manual — Enter a specific value

Step 4: Ability Score

Only appears at ASI levels (typically 4, 8, 12, 16, 19).

Increase ability scores or choose a feat.

Step 5: Spells

Only appears for spellcasting classes.

Learn new cantrips or spells available at your new level. Search and select from your class’s spell list.

Step 6: Features

Only appears when the new level grants feature choices.

Select from available class features such as Fighting Style, Metamagic options, Battle Master Maneuvers, Warlock Invocations, or Expertise.

Step 7: Summary

Review all features gained at this level.

Step 8: Review

Final review of all changes before confirming. Click Confirm Level Up to apply.

Navigation

• Completed steps show a checkmark and can be clicked to revisit
• Use Back and Next to move between steps
• Next is disabled until the current step is complete

See Also

• Create a Player Character
• Manage Character Spells

Print Character Sheet

Export character sheets to PDF for printing.

Steps

1. Click Characters in the header
2. Find and click the character
3. Click Print PDF on the character sheet
4. Configure print options
5. Save the PDF

Print Options

The export dialog lets you select which sections to include:

Character Sheets:

• Compact Sheet (2-page) — Stats, combat, skills, equipment summary
• Battle Card — Half-page combat reference (AC, HP, attacks, saves)

Cards:

• Spell Cards — Printable cards for all spells (if the character is a caster)
• Equipment Cards — Cards for weapons, magic items, and special ammunition

Compact Sheet and Spell Cards are enabled by default. At least one option must be selected to export.

Compact Sheet

The 2-page character sheet includes:

• Character name, race, class, and level
• Ability scores and modifiers
• Combat stats (AC, HP, speed, initiative)
• All 18 skills with computed bonuses
• Saving throws
• Attacks and equipment
• Proficiencies
• Personality traits, ideals, bonds, flaws
• Spellcasting info and spell slots (if applicable)
• Full inventory
• Currency

Battle Card

A half-page combat quick reference — ideal for keeping at the table during encounters. Includes AC, HP, attack bonuses, and saving throw modifiers at a glance.

Spell Cards

For spellcasters, spell cards are printed in a 3x3 grid:

• Each spell gets a card with name, level, school, casting time, range, components, and description
• Cut and use as physical references during play

Equipment Cards

Cards for notable equipment — weapons, magic items, and special ammunition. Print and cut for physical item tracking at the table.

Tips

• Print before session for quick reference
• Use card stock for durability
• Update and reprint after level ups
• Keep a backup PDF

See Also

• Create a Player Character
• Export Campaign

Modules

How-to guides for creating adventure modules.

• Create a Module - Start a new adventure module
• Add Monsters - Add monsters from the catalog
• Module Documents - Organize module content

Create a Module

Add adventure modules to your campaign.

What is a Module?

A module is a self-contained adventure:

• “The Goblin Hideout”
• “Dragon’s Lair”
• “The Haunted Manor”

Each module has its own maps, monsters, NPCs, and documents.

Steps

1. Open your campaign dashboard
2. Go to the Modules tab
3. Click the + button
4. Fill in the module details:
   • Module Name - Descriptive title for the adventure
   • Module Type - Select type (Standard Adventure, Mystery, Dungeon Crawl, Heist, Horror, Political Intrigue)
   • Description (optional) - Notes about the module
5. Click Create Module

After Creation

Your new module appears in the module list. Select it to see its dashboard with Play, PDF, and Delete buttons.

Organizing Modules

Modules are numbered in creation order:

• Module 1: “Cragmaw Hideout”
• Module 2: “Cragmaw Castle”
• Module 3: “Wave Echo Cave”

Use descriptive names to identify content.

Tips

• Create one module per dungeon or major location
• Break large adventures into multiple modules
• Start with your first session’s content
• Add more modules as players progress

See Also

• Add Monsters
• Module Documents
• Upload a Map

Add Monsters

Add monsters from the D&D 5e catalog or your homebrew collection to your maps via Token Setup.

Steps

1. Open a module from the Modules tab
2. Click the Place Tokens button on a map card to open Token Setup
3. In the Token Palette, click Monster
4. Search by name (e.g., “Goblin”, “Dragon”, “Zombie”)
5. Select a monster from the results
6. Configure token options (size, color, visibility)
7. Click on the map to place the monster token

Monster Search

Type a monster name in the search field to filter results. Results show CR and source for quick reference. Homebrew monsters you’ve created in the campaign’s Homebrew tab also appear in search results alongside catalog entries.

Token Options

Before placing, configure:

• Size - Tiny, Small, Medium, Large, Huge, Gargantuan
• Color - Border color to distinguish groups
• Visible to Players - Hide for surprise encounters

Placing Multiple Monsters

To add multiple of the same monster:

1. Search and select the monster
2. Click on the map to place each one
3. Each placement creates a new token

Each click on the map places an individual token.

Managing Monster Tokens

Placed monsters appear in the Placed Tokens panel (right side):

• Click to select on map
• Drag to reposition
• Click × to delete
• Right-click for more options

Viewing Monster Stats

In Play Mode, click any monster in the sidebar to see:

• Full stat block
• Ability scores and modifiers
• Actions and special abilities
• Legendary actions (if applicable)

Module Monsters Quick Select

Once you’ve added monsters to a map, the Token Palette shows a Module Monsters section at the top with quick-select buttons for monsters already in the module. This saves time when placing the same monster on multiple maps.

Tips

• Add monsters during prep, not at the table
• Use different colors to distinguish enemy groups
• Hide tokens for surprise encounters
• Search by CR to find level-appropriate challenges
• Create homebrew monsters in the Homebrew tab if you need custom creatures

See Also

• Create a Module
• Place Tokens
• Manage Encounters

Module Documents

Create and manage documents within your adventure modules for session prep, location descriptions, encounter plans, and more.

Creating Documents

1. Open a module from the Modules tab
2. Find the Documents section in the module prep view
3. Click the + button to create a new document
4. Choose between:
   • New Document — Enter a title to create a blank markdown document
   • Upload File — Upload a markdown file or image (.md, .png, .jpg, .jpeg, .webp, .gif, .svg)
5. Click Create

Editing Documents

1. Click a document in the sidebar to open the editor
2. Use the rich text toolbar for formatting:
   • Headings (H1, H2, H3)
   • Bold, italic, strikethrough
   • Bullet and numbered lists
   • Blockquotes and horizontal rules
   • Tables
3. Changes auto-save as you type — watch for the “Saved” indicator
4. Click ← Back to return to the module overview

Reordering Documents

Hover over a document in the sidebar to reveal up/down arrow buttons. Click to change the display order.

Tips

• Create documents during prep, not at the table
• Use read-aloud text for atmospheric descriptions
• Keep encounter plans brief and scannable
• Session notes can be edited during play
• Export individual documents to PDF using the Export PDF button in the editor header

See Also

• Create a Module
• Manage Documents

Play Mode

How-to guides for running game sessions.

• Start a Session - Enter Play Mode
• Manage Encounters - Run combat encounters
• Fog of War - Control visibility
• Manage Traps & POIs - Place, reveal, and trigger map markers
• Use Player Display - Set up a second screen

Start a Session

Open the DM Map window to run your game session.

Prerequisites

• A module with at least one map
• Tokens placed on the map (optional but recommended)
• PCs assigned to the campaign (needed for fog of war and the Add PCs button)

Steps

1. Open your campaign
2. Go to the Modules tab
3. Select a module
4. Click the Play button in the module header

The DM Map window opens in a separate window. Your main window stays on the campaign dashboard — keep it open for monster stat lookups and notes during play. (You can also click Play in the modules table on the campaign landing page.)

The DM Map Window

The window contains:

• Map selector (top left) - Dropdown of the module’s maps plus campaign-level maps (suffixed “(Campaign)”)
• Display / Blackout / Fullscreen (top right) - Display and Blackout control the Player Display; Fullscreen applies to the DM Map window itself (the Player Display has its own F11 fullscreen)
• Map toolbar - Zoom, Add PCs, Reveal Map, and (on UVTT maps) Fog, LOS, and ambient light
• Map canvas - The tactical view with all tokens

See DM Map Window for the full reference.

Initial Setup

1. Select the starting map from the Map dropdown
2. Click Add PCs in the map toolbar to place all campaign PCs, then drag them to the party’s starting position
3. On UVTT maps, click Fog in the map toolbar if you want fog of war (it starts off)
4. Click Display to open the Player Display (if using a second screen)
5. You’re ready to play

Tip: Open the display and click Blackout while you position tokens, then turn Blackout off to reveal the scene.

Session Notes

Use the module’s Play Notes document: in the main window, open the module dashboard and click Play Notes in the Documents panel. It auto-saves as you type.

Ending the Session

There is no explicit end-session action:

1. Click Display On to close the Player Display
2. Close the DM Map window

Token positions are saved automatically and restored the next time you click Play.

See Also

• Manage Encounters
• Fog of War
• Use Player Display
• DM Map Window Reference

Manage Encounters

Run combat encounters effectively during your session.

Viewing Monster Stats

Monster stats live in the main window, which stays on the campaign dashboard while the DM Map window is open. On the module dashboard, click any monster in the Dangers panel to open the Monster Stats Panel:

• Full stat block
• Ability scores and saves
• Actions and attacks
• Special abilities

The panel opens alongside the dashboard, so your main screen becomes the reference screen while the map runs in its own window.

Tip: Double-click a monster token in the DM Map window to select that monster in the dashboard automatically.

Monster Quick List

The Dangers panel lists all monsters in the module:

• Quantity - Number of each monster (e.g., “3×”)
• Name - Monster name (custom display name if one is set)

Click to select and view stats.

Adding PCs to the Map

Click the Add PCs button in the DM Map window’s map toolbar to place all campaign player characters on the current map.

Note: Monster tokens are placed in Token Setup — click the map’s card in the module dashboard’s Maps section. The dashboard stays available in the main window during a session, so you can place additional monsters there mid-session.

Moving Tokens in Combat

1. Drag tokens to new positions
2. Tokens snap to the grid
3. Movement is visible on the player display (if open)

Token Visibility

Toggle token visibility to:

• Hide enemies before combat starts
• Reveal monsters during surprise rounds
• Show reinforcements arriving

Right-click a token and select Hide from Players / Show to Players (or select the token and press H).

Tips

• Open monster stats before combat starts
• Track HP in the module’s Play Notes document (Documents panel on the module dashboard)
• Use display names and notes to distinguish monsters by room/area
• Position hidden tokens before players enter areas

See Also

• Fog of War
• Start a Session
• Add Monsters

Fog of War

Recipes for controlling what players see on the battle map. All controls live in the map toolbar of the DM Map window, and changes take effect on the Player Display immediately.

• Control-by-control reference: Play Mode
• Rules and numbers (vision ranges, light radii): Vision & Lighting
• How and why the system works: Vision System

Note: The vision controls (Fog, LOS, ambient light, debug overlays) only appear for maps with UVTT wall data. On plain image maps, work with Reveal Map and per-token visibility instead.

Hide the map during exploration

Use this when the party enters an unexplored area and should only see what their characters can see.

1. Open the Player Display.
2. In the map toolbar, click Fog.
3. Check the DM view: areas players cannot see are shaded semi-transparently for you and hidden entirely from players.

While Fog is on, LOS is forced on as well — tokens outside the party’s line of sight are hidden automatically. You cannot turn LOS off without first turning Fog off.

Reveal areas as the party explores

There is no manual reveal brush — the revealed area is computed live from PC token vision. To reveal more of the map:

1. Drag PC tokens forward. Vision follows each token.
2. Click a door on the map to open it. Open doors let vision pass; closed doors block it.
3. Add or activate light sources where ambient light is dim or dark — see Manage Light Sources.
4. If a whole area should become visible, raise the ambient light level to Bright.

Moving a token back also retracts its vision: fog is recalculated from current token positions, not accumulated.

Hide enemies but show terrain

Use this for encounters where players know the layout but should not see unseen threats.

1. Make sure Fog is off.
2. Click LOS in the map toolbar.

The map stays fully visible; tokens outside the party’s line of sight are hidden until a PC can see them.

Reveal the whole map temporarily

Use this for town maps, overviews, or any scene where fog doesn’t fit the fiction.

1. Click the Reveal Map (eye) button in the toolbar.
2. When you want fog back, click it again — the tooltip changes to “Hide map (restore fog)”.

Reveal Map overrides Fog and LOS (both buttons are disabled while it is active) but does not change their settings, so switching it off restores exactly the state you had before. Tokens you have individually hidden stay hidden.

Hide a lurking enemy regardless of vision

1. Right-click the token and choose Hide from Players (or select the token and press H).
2. The token is hidden from the Player Display even where players have vision, and even while Reveal Map is active.

Set the mood with ambient light

1. Pick Bright, Dim, or Dark from the ambient light dropdown.
2. In Dark, only darkvision and light sources grant vision — combine with sparse, placed torches for room-by-room tension.

The dropdown starts at the map’s UVTT ambient light value (if any); your selection overrides it for the session.

Stage a dramatic reveal

1. Click Blackout in the header (available while the Player Display is open) so players see nothing.
2. Position tokens, toggle lights, and set the ambient light.
3. Turn Blackout off to present the finished scene.

Check what players can actually see

1. Toggle the debug overlays button in the toolbar to draw vision ranges and walls on the DM view.
2. For ground truth, glance at the Player Display window itself.

See Also

• Use Player Display
• Manage Light Sources
• Vision & Lighting Reference
• Vision System

Manage Traps and POIs

Place trap markers and points of interest (POIs) on a map, control what players see, and trigger traps during play.

Traps and POIs are placed in the Token Setup modal and managed during play from the DM Map window’s map viewer. Some operations are only available in Token Setup — each section below says where it works.

Place a Trap

1. Open Token Setup: click the map card (or its Place Tokens button) in the Module Prep View or the dashboard Modules tab.
2. In the token palette, select Trap (⚠️).
3. Optionally use Link Trap to search the catalog and link a published trap — the marker takes the trap’s name, and its full description can be pulled up in the trap details panel during play.
4. Set the name (if not linked) and choose whether the marker starts Visible to players (off by default — traps usually start hidden).
5. Click a grid square on the map to place the marker.

Drag the marker to reposition it (Token Setup only).

Note: A trap record also stores a detection DC and trigger/effect text. The current UI does not provide a form for editing these fields directly; link a catalog trap to give the marker a name that resolves to full trap mechanics in the play-mode trap details panel.

Hide or Reveal a Trap

Hidden traps appear gray and are never sent to the Player Display. Visible traps show a dashed green ring and appear on the Player Display.

• Token Setup: right-click the marker and choose Show to Players / Hide from Players, or use the Vis/Hid button next to the trap in the placed-content list.
• Play Mode / DM Map window: right-click the trap marker to toggle its visibility directly.

Reveal a trap when the party detects it; keep it hidden until then.

Trigger and Reset a Trap

Available in Token Setup only: right-click the trap marker and choose Trigger Trap. The marker is shown in its triggered state and the placed-content list shows “(Triggered)”. To re-arm it, right-click again and choose the reset option.

Place a POI

1. Open Token Setup for the map.
2. In the token palette, select Marker (📍).
3. Set a name and color, and choose initial player visibility.
4. Click a grid square to place it.

New POIs use the pin icon. To change the icon or add a description, edit the POI (next section).

Edit a POI (Icon, Color, Description)

Open the POI edit form from either view:

• Token Setup: click the Edit button next to the POI in the placed-content list, or right-click the marker and choose Edit…
• Play Mode / DM Map window: right-click the POI marker and choose Edit…

The form lets you set the name, a DM-notes description, one of eight icons (pin, star, skull, chest, door, secret, question, exclamation), and a color.

Hide or Reveal a POI

• Token Setup: use the Vis/Hid button in the placed-content list, or right-click the marker.
• Play Mode / DM Map window: right-click the POI marker and choose Show to Players / Hide from Players.

Visible POIs are sent to the Player Display with their icon and color.

Delete a Trap or POI

Right-click the marker and choose Delete (POI deletion is available in both views; trap deletion in Token Setup), or use the × button in the Token Setup placed-content list. Deletion asks for confirmation and is permanent.

During Play

• Double-clicking a trap or POI in the DM Map window focuses its details in the campaign dashboard — for catalog-linked traps this shows the full trap mechanics.
• Marker visibility changes propagate to the Player Display immediately while it is open.

See Also

• Fog of War — Controlling map visibility around your markers
• Token Setup Modal — Full reference for the placement UI
• Play Mode — Session interface reference

Use Player Display

Show players a fog-of-war view on a second screen.

Opening the Display

1. Click Play on a module to open the DM Map window
2. Click Display in the window’s top toolbar (it changes to Display On)
3. A new window opens
4. Drag the window to your player-facing screen

What Players See

The player display shows:

• Current map with fog of war
• Visible tokens only
• No monster names or stats
• Clean interface without controls

Blackout Mode

Hide everything from players:

1. Click the Blackout button (crossed-out-eye icon, tooltip “Toggle Blackout”) next to Display On — it appears while the display is open
2. Player screen blacks out and shows “Display Paused”
3. Click again to restore

Use for:

• Setup before session
• Dramatic reveals
• Map transitions
• Bathroom breaks

Switching Maps

1. Pick a different map from the Map dropdown at the top left of the DM Map window
2. Player display updates automatically
3. Use Blackout during transitions for drama

Closing the Display

• Click the Display On button again, or
• Close the window directly

Tips

• Use fullscreen (F11) on the player screen
• Keep notes on your screen, map on theirs
• Use Blackout liberally for reveals

See Also

• Fog of War
• Tutorial: Player Display Setup

Homebrew Content

Create custom items, monsters, and spells for your campaigns.

What is Homebrew?

Homebrew content is custom D&D material you create for your campaign. When the official catalog doesn’t have what you need — a custom magic sword, a unique creature, or a modified spell — you create it as homebrew.

Where to Find It

Homebrew is managed from the Homebrew tab on the Campaign Dashboard (the 5th tab). Each campaign has its own homebrew content.

The Three Types

Clone from Catalog

For monsters and spells, the primary workflow is cloning: search the D&D 5e catalog, select an entry, and Mimir creates a homebrew copy you can modify. Items can also be cloned or created from scratch.

Cloned entries display “Based on [original name]” so you can track the source.

How Homebrew Integrates

• Homebrew items appear in inventory search results when adding items to characters
• Homebrew monsters appear in monster search when placing tokens in Token Setup
• Homebrew spells appear in character spell lists alongside catalog spells

All homebrew content is tagged with an HB badge throughout the UI.

Guides

• Create a Homebrew Item
• Create a Homebrew Monster
• Create a Homebrew Spell

Create a Homebrew Item

Create custom items for your campaign — weapons, armor, potions, magic items, and more.

Navigate to Homebrew Items

1. Open your campaign dashboard
2. Click the Homebrew tab
3. Select the Items sub-tab

Create from Scratch

1. Fill in the item form on the right panel
2. Set the required and optional fields (see below)
3. Click Create Item

Clone from Catalog

1. Click Clone from Catalog
2. Search for an existing item (minimum 2 characters)
3. Results show name, type, rarity, and source
4. Click an item to pre-fill the form with its data
5. Modify fields as needed
6. Click Create Item

If the name conflicts with an existing homebrew item, “ (Custom)“ is appended.

Item Fields

Common Fields (All Items)

• Name (required) — Item name
• Item Type — weapon, armor, potion, ring, rod, scroll, staff, wand, wondrous item, adventuring gear
• Rarity — common, uncommon, rare, very rare, legendary, artifact
• Weight — Weight in pounds
• Value — Value in gold pieces
• Requires Attunement — Checkbox; optionally specify attunement requirements (e.g., “by a spellcaster”)
• Description — Item description and properties

Weapon Fields

Shown when item type is weapon:

• Category — Simple or martial
• Bonus — +1, +2, or +3
• Damage — Damage dice (e.g., 1d8)
• Damage Type — Slashing, piercing, bludgeoning, fire, cold, etc.
• Versatile Damage — Alternate damage when wielded two-handed
• Range — Range in feet
• Properties — Finesse, Heavy, Light, Reach, Thrown, Two-Handed, Versatile, Ammunition, Loading, Special

Armor Fields

Shown when item type is armor:

• AC — Base armor class
• Bonus — +1, +2, or +3
• Strength Required — Minimum strength score
• Stealth Disadvantage — Whether the armor imposes disadvantage on Stealth checks

Editing Items

Click an item in the list, then click Edit to modify its fields.

Deleting Items

Click Delete on a selected item. If any characters have the item in their inventory, a warning shows which characters are affected.

See Also

• Manage Character Inventory
• Homebrew Overview

Create a Homebrew Monster

Create custom monsters by cloning and modifying entries from the D&D 5e catalog.

Navigate to Homebrew Monsters

1. Open your campaign dashboard
2. Click the Homebrew tab
3. Select the Monsters sub-tab

Clone from Catalog

Homebrew monsters are created by cloning existing catalog entries:

1. Click Clone from Catalog
2. Search for a monster (minimum 2 characters)
3. Results show name, CR, size, type, and source
4. Click a monster to create a homebrew copy immediately

The new monster appears in your homebrew list with “Based on [original name]” shown in the detail view.

Editing Monsters

1. Select a monster from the list
2. Click Edit
3. Modify the Name and/or the JSON data containing the full stat block
4. Save your changes

The stat block data is stored as JSON. The detail pane shows extracted metadata: CR, size, and creature type.

Using Homebrew Monsters

Homebrew monsters appear in monster search results alongside catalog entries when:

• Placing tokens in Token Setup
• Browsing monsters in module prep

They are tagged with an HB badge for identification.

Deleting Monsters

Click Delete on a selected monster. If any modules reference the monster, a warning shows which modules are affected.

See Also

• Add Monsters to Module
• Homebrew Overview

Create a Homebrew Spell

Create custom spells by cloning and modifying entries from the D&D 5e catalog.

Navigate to Homebrew Spells

1. Open your campaign dashboard
2. Click the Homebrew tab
3. Select the Spells sub-tab

Clone from Catalog

Homebrew spells are created by cloning existing catalog entries:

1. Click Clone from Catalog
2. Search for a spell (minimum 2 characters)
3. Results show name, level, school, and source
4. Click a spell to create a homebrew copy immediately

The new spell appears in your homebrew list with “Based on [original name]” shown in the detail view.

Editing Spells

1. Select a spell from the list
2. Click Edit
3. Modify the Name and/or the JSON data containing the spell details
4. Save your changes

The detail pane shows extracted metadata: spell level and school of magic.

Using Homebrew Spells

Homebrew spells appear automatically in character spell lists alongside catalog spells for spellcasting characters. They are tagged with an HB badge.

Deleting Spells

Click Delete on a selected spell. A confirmation prompt appears before deletion.

See Also

• Manage Character Spells
• Homebrew Overview

AI Assistant Integration

Use Mimir with Claude Code for AI-assisted campaign management via natural language.

What It Does

Mimir includes an MCP (Model Context Protocol) server that exposes 54 tools to Claude Code, enabling you to manage campaigns, search catalogs, generate maps, and prep sessions through conversation. Ask “create a forest map” or “find CR 5 undead monsters” and the assistant handles it.

Prerequisites

• Mimir desktop app installed
• Claude Code installed
• The mimir-mcp binary (installed alongside the app, or built from source)

Setup

For App Users

Inside the desktop app, the MCP server runs as a sidecar — a companion process bundled with the app that launches automatically. For Claude Code, you use the standalone mimir-mcp binary instead. On macOS, the install script places it at ~/.local/bin/mimir-mcp, so it’s already on your PATH (if not, add ~/.local/bin to your PATH). On Linux and Windows, download the binary for your platform from GitHub Releases (e.g. mimir-mcp-x86_64-unknown-linux-gnu or mimir-mcp-x86_64-pc-windows-msvc.exe), or build it from source as described below.

1. Register the server with Claude Code:

   claude mcp add mimir -- mimir-mcp
   

2. Install the Claude Code plugin. Inside a Claude Code session, add the Mimir marketplace, then install the plugin:

   /plugin marketplace add mimir-dm/mimir
   /plugin install mimir-dm@mimir
   

From Source

If you’re working from the Mimir repository, build the binary yourself:

cargo build --release -p mimir-mcp

Then register the built binary (target/release/mimir-mcp) with claude mcp add as above.

Database Path

The server auto-detects the Mimir database on macOS (~/Library/Application Support/com.mimir.app/data/mimir.db) and Linux ($XDG_DATA_HOME/com.mimir.app/data/mimir.db, falling back to ~/.local/share/...). On Windows there is no default — you must set the environment variable:

# macOS / Linux
export MIMIR_DATABASE_PATH=/path/to/mimir.db

# Windows (PowerShell)
$env:MIMIR_DATABASE_PATH = "C:\Users\you\AppData\Roaming\com.mimir.app\data\mimir.db"

You can find your database path in the app under Settings > Integrations, which displays it with a copy button.

See Environment Variables for details.

Available Tools, Commands, and Skills

The full listing of MCP tools, plugin slash commands, and skills lives in the MCP Server Reference. In brief, tools cover campaign, module, document, character, and map management, map generation, homebrew content, and catalog search.

Example Workflows

Campaign setup:

“Create a new campaign called ‘Curse of Strahd’ and add a module for Death House”

Monster search:

“Find all CR 3-5 undead monsters from the Monster Manual”

Map generation:

“Generate a dark swamp map with standing water and dim lighting”

Session prep:

“Run a session prep check on the Goblin Hideout module”

Character management:

“Add a +1 longsword to Aldric’s inventory”

Important Notes

• MCP tools modify the database directly — there is no undo
• Export your campaign regularly as a backup
• The assistant is the DM’s tool — it prompts for choices rather than making creative decisions autonomously
• Set the active campaign with set_active_campaign before using campaign-specific tools

Reference

This section contains detailed reference documentation for all of Mimir’s features and interfaces.

UI Reference

Detailed documentation for each screen and interface:

• Home Screen
• Campaign Dashboard
• Module Prep View
• Play Mode
• DM Map Window
• Token Setup Modal
• Player Display
• Sources Window
• Settings

Data & Formats

• Data Model - Entities and how they relate
• Characters - Character data reference
• Sources & Catalog - Source books and catalog content
• File Formats - Supported map and export formats
• Campaign Archive Format - Export/import archive structure
• PDF Export - Character sheets, cards, and map printing

Systems & Tools

• Vision & Lighting - D&D 5e vision rules in Mimir
• MCP Server - AI assistant integration reference
• Mapgen - Procedural map generation
• Dungeondraft Texture Catalog - Textures available to mapgen

Quick References

• Keyboard Shortcuts - All hotkeys and shortcuts
• Environment Variables - Configuration options
• Troubleshooting - Symptoms, causes, and fixes
• Glossary - Definitions of Mimir terminology

Looking for step-by-step instructions? Check out the How-To Guides.

UI Reference

Detailed documentation for each screen and interface in Mimir.

Screens

• Home Screen - The main landing page
• Campaign Dashboard - The central hub for campaign management
• Module Prep View - Preparing adventure modules
• Play Mode - Running game sessions
• Token Setup Modal - Placing and configuring tokens on maps
• Player Display - The player-facing display window

Home Screen

The Home Screen is your starting point in Mimir. From here you can access campaigns, characters, reference materials, and application settings.

Layout

Header Bar

The header bar is consistent across the entire application — it appears on every screen:

Campaign Selector

The campaign selector dropdown shows:

• All active (non-archived) campaigns
• + New Campaign button at the bottom
• Import Campaign option for loading archives

Selecting a campaign navigates to its Campaign Dashboard.

Main Content

The home screen displays the Mimir landing with the floating skull and tagline. The skull artwork adapts to the active theme (light, dark, or hyper).

Actions

Settings Screen

Accessible via the gear icon. The Settings screen provides:

• Catalog Management — Import source data archives, enable/disable source books
• Theme Selection — Light, Dark, or Hyper theme
• Application Info — Version number, data paths, dev mode status

See Also

• Create a Campaign
• Campaign Dashboard
• Keyboard Shortcuts

Campaign Dashboard

The Campaign Dashboard is your central hub for managing a campaign. It uses a tabbed interface to organize different aspects of your campaign.

Header

• Campaign Name — Displayed prominently at the top
• Sources — Configure which D&D source books are enabled for this campaign
• PDF — Export campaign documents as PDF
• Export Archive — Export campaign as .mimir-campaign.tar.gz archive

Tabs

Campaign Tab

The world-building hub with a two-panel layout:

Sidebar (Left):

• Documents — Campaign-level documents for lore, setting notes, factions, and world-building. Create new documents with the + button. Reorder with up/down arrows.
• Maps — Campaign-level maps (not tied to a specific module). Upload with the + button.

Main Panel (Right):

• Opens the document editor when a document is selected
• Shows a map preview when a map is selected
• Maps can be exported to PDF or deleted from the preview

Modules Tab

Adventure modules within this campaign:

• Module List — Table showing all modules with action buttons
• Play — Enter Play Mode for a module
• Open — Open the module prep view
• PDF — Export module materials
• Create Module — Add new adventure modules with the + button

NPCs Tab

Non-player characters for this campaign:

• NPC List — All NPCs across modules
• NPC Details — Stats, notes, role, location, faction
• Create NPC — Add new NPCs

PCs Tab

Player characters assigned to this campaign:

• PC List — Characters in this campaign
• Add Existing — Assign existing characters to the campaign
• PC Details — Full character sheets with tabs for stats, equipment, spells, and details

Homebrew Tab

Custom content for this campaign:

• Items — Create or clone items from the catalog
• Monsters — Clone and modify monsters from the catalog
• Spells — Clone and modify spells from the catalog

See Homebrew Content for detailed guides.

See Also

• Module Prep View
• Manage Documents

Module Prep View

The Module Prep View is where you prepare adventure content before running it in Play Mode.

Layout

Sidebar (Left)

The module list showing all modules in the campaign:

• Module Cards - Name and number
• Create Module - Add new module (+)
• Active Indicator - Shows which module is selected

Main Panel (Right)

The selected module’s dashboard with sections:

Module Header

• Module Name - Title of the adventure
• Play - Enter Play Mode for this module
• PDF - Export module materials as PDF

Content Sections

Documents

Session prep documents and notes:

• Organized by type (encounter notes, descriptions, etc.)
• Create new documents with the + button
• Click to edit

NPCs

Non-player characters specific to this module:

• Quick reference for module NPCs
• Link to full NPC details
• Add NPCs with the + button

Maps

Battle maps and area maps:

• Map cards with thumbnails
• Click the Place Tokens button to open Token Setup
• Upload new maps with the + button

Monsters

Quick view of monsters in this module (populated from Token Setup). Includes both catalog and homebrew monsters.

Actions

See Also

• Token Setup Modal
• Play Mode
• Create a Module

Play Mode

Play Mode is how you run a game session in Mimir. Clicking the Play button on a module (campaign dashboard Modules tab, or the modules table on the campaign landing page) opens the DM Map window — a separate window with the tactical battle map — while the main window stays on the campaign dashboard for monster stats, documents, and notes.

Session Surfaces

Double-clicking a token, trap, or POI in the DM Map window focuses the corresponding entry in the campaign dashboard.

The sections below document the map viewer — the canvas and toolbar embedded in the DM Map window.

Map Canvas

The tactical display:

• Current map with grid
• All tokens (visible and hidden)
• Fog of war visualization (semi-transparent on the DM view)
• Light source effects

Map Toolbar

Above the map canvas:

Visibility Controls

Fog and LOS are two separate toggle buttons, but they are not fully independent: enabling Fog forces LOS on and locks the LOS button until Fog is turned off. LOS can be enabled on its own. Reveal Map overrides both while active without changing their settings. Both toggles start off when the window opens.

Individually hidden tokens are never shown to players, in any state.

Vision ranges and lighting values are listed in Vision & Lighting; common workflows are in Fog of War; the rationale is in Vision System.

Working with Tokens

• Move - Click and drag
• Select - Click token
• Toggle visibility - Right-click → Hide from Players / Show to Players (or select and press H)
• Mark dead - Right-click → Mark Dead (or select and press D)
• View stats - Double-click a monster token to focus it in the campaign dashboard’s monster panel

Player Display Controls

In the DM Map window’s top toolbar:

• Display - Open/close the Player Display window (shows Display On while open)
• Blackout - Hide everything from players (shown only while the display is open)

Session Notes

There is no notes panel in the DM Map window. Each module has an auto-created Play Notes document — open it from the Documents panel on the module dashboard in the main window. It auto-saves as you type.

See Also

• DM Map Window
• Player Display
• Start a Session
• Fog of War
• Vision & Lighting

DM Map Window

The DM Map window is a separate window showing the battle map while the main window stays on the campaign dashboard for reference. Clicking Play on a module (campaign dashboard Modules tab, or the modules table on the campaign landing page) opens it.

Window Properties

Layout

Toolbar

Map Viewer

The map area embeds the DM map viewer (documented in Play Mode), with these controls:

• Zoom, reset view, Add PCs, Reveal Map, Print
• Fog, LOS, ambient light, and debug overlay toggles (UVTT maps)
• Token drag, selection, context menu, vision settings
• Trap and POI markers with visibility toggles

See Play Mode for the full toolbar and token control reference.

Status Bar

Shows map name, pixel dimensions, current pan offset, and Player Display connection state.

Dashboard Link

Double-clicking a token, trap, or POI in the DM Map window emits a focus event to the main window, which selects the corresponding monster, NPC, PC, trap, or POI in the campaign dashboard.

Keyboard Shortcuts

Shortcuts are ignored while typing in text inputs.

See Also

• Play Mode — Session-running overview and full map viewer reference
• Player Display — The player-facing window
• Keyboard Shortcuts — Full shortcut reference

Token Setup Modal

The Token Setup Modal is where you configure maps, place tokens, and prepare encounters.

Opening Token Setup

Click the Place Tokens button on a map card in the Module Prep View to open Token Setup.

Layout

Token Palette (Left)

Tools for adding content to the map:

Module Monsters (appears when monsters have been added)

• Quick-select buttons for monsters already in the module
• Shows name, encounter tag, and quantity

Monster

• Search D&D 5e monsters by name
• Shows CR and source book
• Click to select, then click map to place

NPC

• Add NPC tokens
• Select from module NPCs

Trap

• Place trap markers at grid positions
• Optionally link a catalog trap (search by name) — the marker takes the trap’s name
• Trap records store name, description, trigger/effect descriptions, detection DC, triggered state, and player visibility

Marker

• Place point-of-interest (POI) markers at grid positions
• POI records store name, description, icon, color, and player visibility

Light Sources

• Torch (20 ft bright / 40 ft dim)
• Lantern (30 ft bright / 60 ft dim)
• Candle (5 ft bright / 10 ft dim)

Map Canvas (Center)

The main map display:

• Grid Overlay - Aligned to map squares
• Placed Tokens - All tokens on this map
• Trap/POI Markers - Drag to move; right-click for actions (visibility, trigger/reset for traps, edit for POIs, delete)
• Zoom Controls - Adjust view
• Pan - Click and drag to move

Placed Content (Right)

All placed content:

Tokens

• List of all placed tokens
• Click to select on map
• Delete with × button

Light Sources

• All placed lights
• Lit/Unlit toggle
• Delete with × button

Traps

• Shows name, DC (if set), and triggered state
• Vis/Hid toggle for player visibility
• Delete with × button

Points of Interest

• Shows name and icon type
• Edit, Vis/Hid toggle, and delete buttons

Canvas Controls

Located above the map:

• Zoom - +/- buttons and percentage
• Reset - Fit map to view

Token Options

When placing tokens:

See Also

• Place Tokens — Step-by-step placement workflow
• Manage Traps and POIs — Placing and running trap/POI markers
• Add Monsters
• Manage Light Sources
• Play Mode — Where placed content is used in session

Player Display

The Player Display is a separate window showing what players can see, designed for a second screen, TV, or projector.

Opening the Display

In Play Mode, click the Player Display button in the header. A new window opens that you can drag to your player-facing screen.

What Players See

The player display shows:

• Map - Current active map
• Fog of War - Based on PC positions and vision
• Visible Tokens - Only tokens marked as visible
• Light Effects - From active light sources

What’s Hidden

Players do NOT see:

• Hidden tokens
• Monster names or stats
• DM controls or UI
• Session notes
• Debug visualizations

Fog of War Controls

Two independent toggles control what players see:

Fog

• Unrevealed areas are black
• Reveals based on PC vision
• Best for exploration

LOS

• Map remains fully visible
• Enemy tokens hidden outside PC vision
• Best for tactical combat

DM Controls

When the Player Display is open, additional controls appear:

Blackout Mode

Click the eye icon (Blackout) to:

• Hide everything from players
• Show a completely black screen
• Set up encounters secretly
• Create dramatic reveals

Click again to restore the view.

Physical Setup

TV/Monitor

• Connect via HDMI/DisplayPort
• Set display to “Extend” (not mirror)
• Drag Player Display window to second screen
• Maximize or fullscreen (F11)

Projector

• Project onto table or wall
• Useful for tabletop projection mapping

Virtual/Remote

• Share the Player Display window via screen share
• Works with Discord, Zoom, etc.

Troubleshooting

See Also

• Play Mode
• Use Player Display
• Fog of War

Sources Window

The Sources window is a standalone D&D 5e reference browser that opens as a separate application window.

Opening the Sources Window

Click Reference in the header bar. The Sources window opens independently from the main application, so you can keep it visible alongside the campaign dashboard or play mode.

Layout

Book Library

The library view lists all imported source books with cover images. Click a book to open it.

Book Reader

The reader displays book content organized by chapters and sections:

• Navigation sidebar — Table of contents with chapter/section headings
• Content area — Rendered book content with stat blocks, tables, and formatted text
• Search — Full-text search across the current book

Catalog Browser

Search and browse specific entity types:

Each category supports search and filtering by source book.

Cross-References

Content in the Sources window is cross-linked. Monster stat blocks link to referenced spells, item descriptions link to conditions, and class features link to related rules. Click a reference to navigate to it.

Theme

The Sources window respects the application theme (light, dark, hyper) and synchronizes theme changes with the main window.

See Also

• Manage Campaign Sources — Import and configure source books
• The Catalog System — How source data works

Settings

The Settings screen provides application-wide configuration. Access it via the gear icon in the header bar.

The sidebar is divided into three groups: Admin Tools, Application, and (in development builds only) Developer.

Admin Tools

Manage Campaigns

Opens the Campaign Management modal for archiving, restoring, and deleting campaigns.

Import Books

Opens the Manage Catalog Sources modal for the D&D 5e source data that powers catalog searches:

See Manage Campaign Sources for the import workflow.

Application

Theme

Choose between three visual themes:

Theme changes apply to all open windows (main, DM map, player display, sources).

Integrations

Configuration for connecting Claude Code or Claude Desktop to Mimir via the MCP server. Displays:

Claude starts the MCP server automatically; no manual server management is required.

About

Developer

Only visible in development builds.

Dev Tools

All dev commands are rejected by the backend outside debug builds.

See Also

• Home Screen — Navigation overview
• MCP Server — The integration the Integrations section configures
• Environment Variables — Advanced configuration

Data Model

The hierarchy of entities in Mimir and how they relate to each other.

Entity Hierarchy

Campaign
├── Documents (campaign-level)
├── Maps (campaign-level)
├── Characters (PCs and NPCs)
│   ├── Classes (multiclass support)
│   ├── Inventory
│   ├── Spells
│   ├── Proficiencies
│   ├── Feats
│   └── Features
├── Modules
│   ├── Documents (module-level)
│   ├── Maps (module-level)
│   ├── Module Monsters (catalog references)
│   ├── Module NPCs
│   └── Token Placements
├── Homebrew Items
├── Homebrew Monsters
├── Homebrew Spells
└── Campaign Sources (enabled books)

Campaigns

The top-level container. A campaign represents a complete D&D game — the world, the story, the characters.

Archiving a campaign hides it from the default list but preserves all data. Deleting a campaign is permanent and cascades to all children.

When you create a campaign, Mimir automatically generates 11 template documents (Campaign Pitch, Starting Scenario, World Primer, Character Guidelines, Table Expectations, Character Integration, Campaign Bible, Safety Tools, House Rules, Player Secrets, Faction Overview).

Characters

Both player characters (PCs) and non-player characters (NPCs) use the same data model. The is_npc flag distinguishes them.

Character Classes

Characters support multiclassing. Each class entry tracks:

A level 5 Fighter / level 3 Wizard has two entries.

Character Inventory

Character Spells

Character Proficiencies

Character Feats

Character Features

Character Sources

Optional per-character source filtering, separate from campaign sources.

Modules

Modules are adventure containers within a campaign — a dungeon, a town, a story arc.

Module Monsters

References to catalog monsters (or homebrew monsters) used in this module’s encounters.

Module NPCs

NPCs created specifically for this module (distinct from campaign-level characters).

Documents

Flexible text content at either the campaign or module level.

A document belongs to a campaign, and optionally to a specific module within that campaign.

Maps

Battle maps with optional grid, wall, and lighting data.

Map Overlays

Maps support several overlay types:

Light Sources (light_sources table) — Dynamic lights with grid position, bright/dim radius, color, and active state.

Fog Revealed Areas (fog_revealed_areas table) — Rectangles tracking which map areas have been revealed to players (x, y, width, height). Written by the fog reveal commands (reveal_rect, reveal_circle, reveal_all); these are currently not surfaced in the UI — live fog rendering is computed from PC token vision instead (see Vision System).

Points of Interest (map_pois table) — Named markers with descriptions, icons, colors, and visibility at specific grid positions.

Traps (map_traps table) — Trap markers with name, description, trigger/effect descriptions, detection DC, triggered state, and visibility.

Token Placements (token_placements table) — Monster and NPC positions on the map.

Homebrew Content

Custom content scoped to a campaign. Three types:

Homebrew Items

Homebrew Monsters

Homebrew Spells

Campaign Sources

Controls which D&D source books are active for a campaign.

Catalog searches filter results by the campaign’s enabled sources.

Campaign Assets

Uploaded files (map images, token art) stored as binary blobs.

Assets are stored in the assets/ directory within the application data folder.

Catalog Data

Read-only D&D 5e reference data imported from external sources. Key tables:

A full-text search index (catalog_fts, an FTS5 virtual table) provides fast search across all catalog entity types.

See The Catalog System for how this data is used.

See Also

• Campaigns vs Modules — Why the hierarchy exists
• The Homebrew System — Creating custom content
• Architecture Overview — How data flows through the system

Characters

Reference for what Mimir tracks on player characters and NPCs. For full table schemas, see the Data Model.

PCs and NPCs

PCs and NPCs share one data model. The is_npc flag distinguishes them and controls which fields are relevant:

Both kinds support the full set of related records below (classes, inventory, spells, and so on).

Core Fields

Classes and Multiclassing

Characters can have any number of class entries, one per class:

Inventory

Spells

Proficiencies

Features

Selectable class features chosen during level-up:

Each feature records its source class.

Feats

Per-Character Sources

Characters can carry their own enabled-source list, separate from the campaign’s source filter.

Level-Up Choices

A level-up request specifies:

See Also

• Data Model — Full character table schemas
• Character How-To Guides — Creating, leveling, and managing characters

Books and Sources

Mimir supports importing D&D 5e source books for reference and catalog population. The source system allows you to browse book content, search the extracted catalog data, and navigate cross-references between game elements.

Mimir ships with no game content — not even the System Reference Document (SRD). All catalog data comes from archives you import. See The Catalog System for why, and Manage Campaign Sources for the import procedure.

Archive Format

Source data is imported from gzip-compressed tar archives (.tar.gz) containing JSON data in the format established by the 5etools community project. The archive must include a books.json file describing the available sources; the importer streams the archive directly without extracting it to disk.

Pre-packaged archives are available from the Mimir Resources releases page. Two archive types are published:

The importer only processes source books whose group is core (PHB, DMG, MM) or supplement (XGE, TCE, etc.). Books in other groups — setting books (Eberron, Ravnica, Theros), adventures, DM screens, homebrew — are skipped.

Catalog Population

When you import a data archive, Mimir extracts game content into catalog tables in the local SQLite database. Spells go into the spells table, monsters into monsters, items into items, and so on for classes, races, feats, backgrounds, conditions, actions, and other entity types. Magic item variants are expanded during import (a +1/+2/+3 weapon template generates an entry per base item).

The catalog tables store both summary information for search results and complete details for individual entries, allowing fast searching across thousands of entries while still providing full stat blocks and descriptions for a specific entry.

Cross-Reference System

Book content contains tagged references using the {@type name|source} syntax. A reference like {@spell fireball|PHB} identifies a spell named “fireball” from the Player’s Handbook. The content renderer converts these tags into clickable links that display tooltips on hover and full details on click.

The cross-reference system supports spells, creatures, items, conditions, actions, classes, races, feats, and backgrounds. References to content from sources you haven’t imported appear as plain text rather than links.

Storage Location

Catalog data lives in the SQLite database in the application data directory. On macOS this is ~/Library/Application Support/com.mimir.app/, with equivalent locations on Windows and Linux. Imported images are stored under assets/catalog/ in the same directory and are served on demand.

Tauri Commands

The source system exposes the following commands through Tauri IPC.

Keyboard Shortcuts

Quick reference for keyboard shortcuts in Mimir.

Global Shortcuts

Map Navigation

Token Manipulation (Play Mode)

Player Display Window

Document Editor

Notes

• Cmd is used on macOS, Ctrl on Windows/Linux
• Shortcuts are ignored when typing in text inputs or textareas
• Token manipulation shortcuts require a token to be selected

File Formats

Supported file formats in Mimir.

Map Formats

Image Files

Standard image formats for battle maps:

UVTT Format

Universal Virtual Tabletop format:

UVTT files include:

• Embedded map image
• Grid size and offset
• Wall and door positions
• Light source data (some tools)

Dungeondraft Map

Generated by Mimir’s mapgen system:

Can be opened directly in Dungeondraft for editing or UVTT export.

Export Formats

PDF Export

Available for:

• Campaign and module documents
• Character sheets and battle cards
• Monster, spell, equipment, and trap cards
• Maps (preview and true-scale tiled pages)
• Token cutout sheets

See PDF Export for details.

Archive Export

Campaign archive format:

• .mimir-campaign.tar.gz archive containing all campaign data
• Maps, documents, characters, homebrew content
• Portable between installations; see Export Campaign

Character Data

Characters are stored in the Mimir database:

• Not exported as separate files
• Included in campaign archives (see Export Campaign)
• PDF export produces printable sheets

Import Sources

D&D Content

Mimir can import from:

• 5e.tools JSON format
• Official SRD content

Content is stored in the catalog database.

See Also

• Upload a Map
• Export Campaign

Vision & Lighting

Reference values and rules used by Mimir’s fog of war calculation.

For the toolbar controls, see Play Mode. For step-by-step usage, see Fog of War. For the design rationale, see Vision System.

Scale

One grid square equals 5 feet. All ranges below are in feet and converted to map pixels using the map’s grid size.

Token Vision Values

Each token carries four vision-related values:

Ambient Light Levels

The ambient level initializes from the map’s UVTT data when present and can be overridden per session from the map toolbar.

Light Source Presets

Token-carried light uses the token’s light radius value as the dim radius, with the bright radius at half that distance.

Light Level at a Point

The effective light level at a point is the best of:

• Bright, if the point is within any active source’s bright radius
• Dim, if the point is within any active source’s dim radius (when ambient is darkness)
• The ambient level otherwise

A token must be inside a light’s radius to benefit from it: the light level at the token’s own position determines which vision range applies.

What Reveals Fog

Visibility States

The Fog and LOS toggles are separate buttons but not fully independent: enabling Fog forces LOS on, and the LOS button is locked until Fog is turned off. Reveal Map overrides both. The resulting states:

Individually hidden tokens are never shown to players, in any state. See Play Mode for the controls themselves.

Wall Occlusion

UVTT maps include wall and portal (door) data:

• Vision is computed as a visibility polygon by raycasting against walls
• Closed doors block vision; open doors do not
• The Fog and LOS toggles are only available on maps with UVTT data

Maps without wall data use circular (radius-only) vision with no obstructions.

See Also

• Fog of War — task recipes
• Vision System — how the D&D 5e rules map to the implementation
• Play Mode — toolbar controls

Environment Variables

All environment variables recognized by Mimir and its components.

Application

MIMIR_DEV

Forces development mode regardless of build type. When set (any value), Mimir uses the dev database directory instead of production.

export MIMIR_DEV=1

Effect: Database and assets are read from {app_dir}/dev/data/ instead of {app_dir}/data/. This prevents development from modifying production campaign data.

Default: Not set. Dev mode is normally detected automatically via Rust’s cfg!(debug_assertions) — debug builds use dev paths, release builds use production paths.

RUST_LOG

Controls log verbosity using the tracing filter syntax.

# Show debug logs for all Mimir crates
export RUST_LOG=mimir=debug,mimir_core=debug

# Trace-level for the core crate only
export RUST_LOG=mimir_core=trace

# Quiet mode — errors only
export RUST_LOG=mimir=error

Default: mimir=info,mimir_core=info (all builds)

Log output: Written to files in the logs directory:

• macOS: ~/Library/Application Support/com.mimir.app/logs/
• Linux: ~/.local/share/com.mimir.app/logs/
• Windows: %APPDATA%/com.mimir.app/logs/

MCP Server

MIMIR_DATABASE_PATH

Overrides the database path for the MCP sidecar server. Useful when running the MCP server outside of Tauri (e.g., as a standalone process for Claude Code).

export MIMIR_DATABASE_PATH=~/Library/Application\ Support/com.mimir.app/data/mimir.db

Default: Platform-specific:

The path supports ~ and $HOME expansion.

Note on Linux: The MCP server respects the XDG_DATA_HOME environment variable. If unset, it falls back to ~/.local/share/.

MIMIR_SEED_ASSETS

Development only. Path to the seed-asset directory (sample UVTT maps, token images) used when seeding the dev database from the in-app Dev Tools.

export MIMIR_SEED_ASSETS=/path/to/mimir/crates/mimir-core/src/seed/assets

Default: Not set. The seeder walks parent directories looking for crates/mimir-core/src/seed/assets; the variable is only needed when running from a location where that walk fails.

Build System

TAURI_ENV_TARGET_TRIPLE

Set by Tauri during builds. Used by the sidecar build scripts to determine the target architecture.

# Set automatically by Tauri, but can be overridden for cross-compilation
export TAURI_ENV_TARGET_TRIPLE=aarch64-apple-darwin

Supported values:

• aarch64-apple-darwin (macOS ARM64)
• x86_64-apple-darwin (macOS Intel)
• x86_64-unknown-linux-gnu (Linux x86_64)
• aarch64-unknown-linux-gnu (Linux ARM64)
• x86_64-pc-windows-msvc (Windows x86_64)
• aarch64-pc-windows-msvc (Windows ARM64)

Default: Auto-detected from the current platform when not set.

CARGO_TERM_COLOR

Standard Cargo variable for controlling colored output. Set to always in CI workflows.

export CARGO_TERM_COLOR=always

Platform Directories

Mimir uses platform-appropriate directories following OS conventions. These aren’t environment variables, but they’re the default paths that environment variables override:

macOS

Linux

Windows

See Also

• Troubleshooting — Common issues related to paths and configuration
• Development Setup — Setting up a development environment
• MCP Server Reference — MCP server configuration

Campaign Archive Format

Technical reference for Mimir’s campaign export/import archive format.

Overview

Campaign archives are gzip-compressed tar files with the extension .mimir-campaign.tar.gz. An archive contains a complete snapshot of one campaign — metadata, modules, documents, characters, maps, tokens, homebrew content, and binary assets. Archives are self-contained and portable between machines and Mimir installations.

Archive Structure

<slug>.mimir-campaign.tar.gz
├── manifest.json                    # Archive metadata
├── data.json                        # All campaign data
└── assets/
    └── {asset-id}/{filename}        # One file per campaign asset

The archive contains exactly two JSON files plus one entry per asset. Asset files are stored under their original asset ID and filename; binary content is not hashed or deduplicated.

Manifest

manifest.json contains archive metadata:

Counts

Catalog References

Each entry identifies a catalog item that campaign documents reference but the archive does not contain:

References are extracted at export time by scanning document content for {@type name|source} tags.

Campaign Data

data.json contains all campaign entities in a single JSON object:

Character Entries

Each character entry contains the base character fields (flattened) plus:

Map Entries

Each map entry contains the base map fields (flattened) plus:

Asset Files

Binary files (map images, token art) are stored in the archive at assets/{asset-id}/{filename}, where {asset-id} is the asset’s UUID at export time and {filename} is its original filename.

Import Behavior

When an archive is imported:

1. The archive is extracted and data.json is parsed; import fails if data.json is missing or unparseable. The manifest’s format field is not checked during import — that validation happens only in archive preview (see Preview)
2. New UUIDs are generated for all entities, so imports never conflict with existing data
3. Internal references (module, document, character, map, asset, and monster/NPC IDs) are remapped to the new UUIDs
4. Asset files are copied into the importing installation’s assets directory under campaigns/{new-campaign-id}/{filename}
5. Campaign sources are restored; they take effect only if the corresponding catalog data exists in the importing installation
6. If the campaign name already exists, a numeric suffix is appended (e.g., Name (2)), unless a name override is supplied

Importing the same archive twice creates two independent copies of the campaign.

Preview

An archive preview reads manifest.json without extracting or importing the rest of the archive. Preview is where the manifest’s format field is validated: archives whose format is not "mimir-campaign" are rejected. The preview contains:

See Also

• Export Campaign — How to create archives
• Data Model — Entity relationships

PDF Export

Mimir generates PDFs from campaign data using Typst, a modern typesetting system compiled in-process by the mimir-print crate. Every export returns the finished PDF to the frontend as base64 data, where it can be previewed and saved to disk.

Export Types

Tauri Commands

The application registers twelve print commands (crates/mimir/src/main.rs), implemented in crates/mimir/src/commands/print/.

Card commands accept a show_cut_lines option. Map and module options include grid overlay, line-of-sight walls, starting positions, and token cutout toggles.

All rendering commands return ApiResponse<PrintResult>, where PrintResult contains pdf_base64 (the PDF as base64) and size_bytes (the decoded size). save_pdf returns ApiResponse<()> and list_print_templates returns a list of { id, name, category } entries.

Section Types

PDFs are assembled from typed sections (crates/mimir-print/src/sections/), each of which produces Typst markup:

Rendering Pipeline

Each command gathers data from the database, builds the relevant sections, and assembles them with a DocumentBuilder. The combined Typst source is compiled in-memory by the Typst compiler library inside a custom MimirTypstWorld — no external Typst CLI and no temporary data files are involved. Images (maps, tokens) are passed to the compiler as in-memory virtual files.

Shared Typst components are embedded in the application binary (crates/mimir-print/src/embedded_templates.rs): _shared/styles.typ, _shared/components.typ, and _shared/icons.typ. Imports of these paths are resolved from the embedded copies before any disk lookup. The embedded styles define grayscale, print-friendly colors and the font stacks Inter / Helvetica / Arial (headings and body) and JetBrains Mono / Consolas (monospace).

Fonts are not bundled: the compiler uses system fonts, discovered once per process via fontdb (crates/mimir-print/src/world.rs). If the first font in a stack is not installed, Typst falls back through the stack.

Template Directory

list_print_templates scans the templates/ directory inside the application data directory, recursively collecting .typ files (anything under a _shared/ directory is skipped). Each entry’s id is its relative path without the extension, its category is the first directory component, and its name is the title-cased file name. If the directory does not exist, the command returns an empty list.

This listing is informational only: the export commands above generate their Typst source from the embedded section types and embedded shared components, and do not render user-supplied .typ files.

MCP Server Reference

Technical reference for Mimir’s Model Context Protocol (MCP) server — the sidecar that enables AI assistant integration.

Architecture

The MCP server (mimir-mcp) runs as a Tauri sidecar process. It connects to the same SQLite database as the main app and exposes 54 tools across 8 categories.

Components

• Binary: mimir-mcp (built to crates/mimir/binaries/mimir-mcp-{target-triple})
• Protocol: MCP over stdio
• Database: Shared SQLite database (same file the desktop app uses; default location varies by platform — see below)
• Plugin: Claude Code plugin at crates/mimir-mcp/plugin/

Configuration

The database path is resolved from the MIMIR_DATABASE_PATH environment variable, falling back to a platform default:

See Environment Variables for details.

Errors

Most tools operate on an active campaign. Until a campaign is selected with set_active_campaign, campaign-scoped tools return a NoActiveCampaign error (No active campaign. Use set_active_campaign first.). The active campaign is held in memory per server process — it is not persisted, so each new server process starts with no campaign selected.

Tool Reference

Campaign Management (10 tools)

Module Management (8 tools)

Document Management (6 tools)

Character Management (13 tools)

Map Management (8 tools)

Map Generation (3 tools)

Catalog Search (1 tool)

A single search_catalog tool searches all catalog categories.

Parameters:

Results are filtered to the active campaign’s enabled sources when a campaign is set.

Homebrew Content (5 tools)

Homebrew items, monsters, and spells share a unified tool set. Every call takes a content_type parameter: item, monster, or spell.

create_homebrew parameters:

Claude Code Plugin

For installation and setup, see the AI Assistant How-To.

Slash Commands

Skills

See Also

• AI Assistant How-To
• Mapgen Reference

Mapgen Reference

Technical reference for mimir-mapgen — Mimir’s procedural map generator that outputs Dungeondraft-compatible .dungeondraft_map files.

CLI Usage

mimir-mapgen <command>

Commands

Generate

# From a YAML config file
mimir-mapgen generate config.yaml -o output.dungeondraft_map

# From a biome preset
mimir-mapgen generate --preset forest -o output.dungeondraft_map

# With a random seed override
mimir-mapgen generate config.yaml --seed 42 -o output.dungeondraft_map

You must provide either a config file path or --preset, but not both.

Validate

mimir-mapgen validate config.yaml

Reports validation errors without generating a map. Useful for checking configs before generation.

List Presets

mimir-mapgen list-presets

Biome Presets

12 built-in presets with sensible defaults for terrain, objects, and noise parameters.

Some presets accept alternate names: lake/pond, swamp/marsh/bog, island_tropical/tropical_island (hyphens also accepted).

YAML Configuration Schema

Top-Level Fields

name: "My Forest Map"          # string, required — map display name
width: 32                       # u32, required — width in grid squares
height: 32                      # u32, required — height in grid squares
seed: 42                        # u64, optional — random seed

Noise

Controls Perlin noise that drives terrain blending, object placement, and feature generation.

noise:
  seed: 0              # u32 — noise seed (separate from map seed), default 0
  octaves: 6           # usize — noise layers (more = more detail), default 6
  persistence: 0.5     # f64 — amplitude decay per octave (0–1), default 0.5
  lacunarity: 2.0      # f64 — frequency multiplier per octave, default 2.0
  scale: 0.01          # f64 — base frequency (lower = larger features), default 0.01

Island Mode

Optional radial falloff creating island/clearing shapes where the center is low and edges are high.

island_mode: 1.5       # f64, optional — falloff strength (higher = steeper)

Terrain

Defines 4 terrain texture slots and their noise-based blending.

terrain:
  slots:                        # exactly 4 slots required
    - texture: "res://textures/terrain/terrain_dirt.png"
      lower: 0.0                # f64 — noise range lower bound
      upper: 0.3                # f64 — noise range upper bound
    - texture: "res://textures/terrain/terrain_grass.png"
      lower: 0.25
      upper: 0.55
    - texture: "res://textures/terrain/terrain_moss.png"
      lower: 0.5
      upper: 0.8
    - texture: "res://textures/terrain/terrain_gravel.png"
      lower: 0.75
      upper: 1.0
  blend_width: 0.05            # f64 — overlap width for blending
  smooth_blending: false        # bool — smooth interpolation vs hard boundaries

Slots should have overlapping lower/upper ranges for natural blending. Each slot’s weight is determined by how well the noise value falls within its range.

Trees

Array of tree configurations with optional shadow and canopy layers.

trees:
  - id: "oaks"                           # string, optional — name for cross-referencing (e.g., from lights)
    tree:
      textures:                          # list of textures (randomly selected)
        - "res://textures/objects/trees/tree_01.png"
        - "res://textures/objects/trees/tree_02.png"
      min_distance: 180.0                # f64 — minimum spacing (pixels)
      noise_lower: 0.3                   # f64 — place only where noise > this
      noise_upper: 0.8                   # f64 — place only where noise < this
      probability: 0.8                   # f64 — placement chance (0–1)
      scale_min: 0.8                     # f64 — minimum random scale
      scale_max: 1.4                     # f64 — maximum random scale
      layer: 300                         # i32 — Dungeondraft render layer
      random_rotation: true              # bool — randomize rotation
      random_mirror: true                # bool — randomly flip horizontally
      custom_color: null                 # string, optional — ARGB hex override
    shadow:                              # optional shadow beneath tree
      texture: "res://textures/objects/trees/tree_shadow.png"
      offset: "Vector2( 10, 15 )"        # Vector2 — offset from tree position in pixels (Godot string form)
      scale_factor: 1.2                  # f64 — scale relative to tree
      layer: 50                          # i32 — render layer (below tree)
    canopy:                              # optional canopy placed on level 1 (overhead foliage)
      texture: "res://textures/objects/trees/tree_canopy.png"
      scale_factor: 1.5                  # f64 — scale relative to tree
      layer: 500                         # i32 — render layer (above tree)

All fields of the inner tree object block are required except id and custom_color. The shadow offset is a Vector2, written in Godot’s string form: "Vector2( x, y )".

Clutter

Small decorative objects scattered across the map.

clutter:
  - id: "grass"                          # string, optional — name for cross-referencing
    textures:
      - "res://textures/objects/grass/grass_01.png"
    min_distance: 80.0
    noise_lower: 0.2
    noise_upper: 0.7
    probability: 0.6
    scale_min: 0.5
    scale_max: 1.0
    layer: 100
    random_rotation: true
    random_mirror: false
    custom_color: null

Each clutter entry is an object config with the same fields as the tree block above; all fields are required except id and custom_color.

Clumps

Clustered object groups (rock formations, flower patches).

clumps:
  - id: "rock_piles"                     # string, optional — name for cross-referencing
    primary:                             # main object (placed via Poisson Disc)
      textures:
        - "res://textures/objects/rocks/rock_01.png"
      min_distance: 200.0
      noise_lower: 0.4
      noise_upper: 0.9
      probability: 0.5
      scale_min: 0.8
      scale_max: 1.2
      layer: 150
      random_rotation: true
      random_mirror: false
    secondary:                           # scattered around each primary
      textures:
        - "res://textures/objects/rocks/pebble_01.png"
      min_distance: 30.0
      noise_lower: 0.0
      noise_upper: 1.0
      probability: 1.0
      scale_min: 0.3
      scale_max: 0.6
      layer: 100
      random_rotation: true
      random_mirror: false
    secondary_count: [3, 6]              # [u32, u32] — min/max secondaries per primary
    secondary_radius: 100.0              # f64 — max distance of secondaries from primary (pixels)

primary and secondary are both full object configs (same fields and requirements as the tree block above).

Roads

Road paths using noise-following walk (straight) or sinusoidal meander (meandering).

roads:
  - id: "main_road"                      # string, optional — name for cross-referencing (lights, custom paths)
    from: Left                           # Edge — start: Left, Right, Top, Bottom (default Left)
    to: Right                            # Edge — end side (default Right)
    texture: "res://textures/paths/path_dirt.png"   # default "res://textures/paths/path_dirt.png"
    width: 512.0                         # f64 — road width in pixels (512 = 2 grid squares), default 512.0
    layer: 100                           # i32 — render layer, default 100
    style: straight                      # PathStyle — "straight" or "meandering", default straight
    step_distance: 64.0                  # f64 — walk step size (pixels), default 64.0
    fov: 1.047                           # f64 — field of view angle (radians), default π/3
    noise_weight: 0.5                    # f64 — 0=all progress, 1=all noise, default 0.5
    margin: 128.0                        # f64 — margin from map edge (pixels), default 128.0
    smooth_density: 8                    # usize — Bezier smoothing density, default 8
    effort: 0.5                          # f64 — contour crossing: 0.0 avoids contours, 1.0 ignores them, default 0.5
    edge_paths:                          # optional — border textures along road sides
      texture: "res://textures/paths/path_edge.png"
      offset: 20.0                       # f64 — perpendicular offset from center
      width: 8.0                         # f64 — edge path width
      layer: 190                         # i32 — render layer

All road fields have defaults, so roads: [{}] produces a valid default road.

Path styles:

• straight — greedy walk following noise ridges/valleys. Roughly straight with gentle bends.
• meandering — sinusoidal S-curves. More natural for rivers and winding roads.

Roads automatically route around rooms and corridors.

Rivers

River paths with water polygon and bank paths. Default style is meandering.

rivers:
  - id: "east_river"                     # string, optional — name for cross-referencing
    from: Top                            # Edge — start side (default Top)
    to: Bottom                           # Edge — end side (default Bottom)
    width: 768.0                         # f64 — water width (pixels), default 768.0
    style: meandering                    # PathStyle — "straight" or "meandering", default meandering
    step_distance: 64.0                  # f64 — walk step size, default 64.0
    fov: 1.047                           # f64 — FOV for straight style, default π/3
    noise_weight: 0.5                    # f64 — noise following weight, default 0.5
    margin: 128.0                        # f64 — margin from map edge, default 128.0
    smooth_density: 8                    # usize — Bezier smoothing, default 8
    deep_color: "ff3aa19a"               # string — ARGB hex for deep water, default "ff3aa19a"
    shallow_color: "ff3ac3b2"            # string — ARGB hex for shallow water, default "ff3ac3b2"
    bank_texture: "res://textures/paths/path_rocks.png"  # default "res://textures/paths/path_rocks.png"
    bank_width: 256.0                    # f64 — bank path width, default 256.0
    bank_layer: 100                      # i32 — bank render layer, default 100
    effort: 0.5                          # f64 — contour crossing: 0.0 follows valleys, 1.0 ignores contours, default 0.5
    source: null                         # string, optional — lake id where the river starts (overrides `from`)
    drain: null                          # string, optional — lake id where the river ends (overrides `to`)

Rivers generate a water polygon between two banks plus bank paths on each side. Very wide rivers (1000+) can simulate coastlines. Rivers automatically route around rooms and corridors.

source and drain connect a river to declarative lakes (see Lakes) by their id. When set, the river starts/ends at the lake shoreline instead of a map edge.

Water Bodies

Noise-threshold water generation for lakes and ponds.

water:
  threshold: 0.75                        # f64 — noise values above this become water
  deep_color: "ff3aa19a"                 # string — ARGB hex
  shallow_color: "ff3ac3b2"              # string — ARGB hex
  blend_distance: 40.0                   # f64 — edge blend distance
  min_contour_points: 6                  # usize — minimum polygon size
  smooth_iterations: 2                   # usize — edge smoothing passes
  pixels_per_cell: 64.0                  # f64 — coordinate scaling
  disable_border: false                  # bool — disable water border effect

Lakes

Declarative lakes placed by center and radius, with a noise-perturbed organic shoreline. The noise map is depressed inside the lake to form a basin.

lakes:
  - id: "north_lake"                     # string, required — unique id (referenced by river source/drain)
    center: [16, 10]                     # [f64, f64], required — center in grid squares
    radius: 5.0                          # f64, required — approximate radius in grid squares
    roughness: 0.4                       # f64 — shoreline jaggedness 0.0–1.0, default 0.4
    deep_color: "ff2a7f6f"               # string — ARGB hex, default "ff2a7f6f"
    shallow_color: "ff3ac3b2"            # string — ARGB hex, default "ff3ac3b2"
    blend_distance: 3.0                  # f64 — water edge blend distance, default 3.0

Elevation Contours

Cliff and hill contour lines at noise thresholds.

elevation:
  levels:
    - threshold: 0.65                    # f64 — noise threshold for this contour
      texture: "res://textures/paths/path_rocks.png"
      width: 12.0                        # f64 — contour line width
      layer: 100                         # i32 — render layer
      min_points: 8                      # usize — minimum contour length
      smooth_iterations: 2              # usize — smoothing passes
      shadow:                            # optional shadow below contour
        texture: "res://textures/paths/path_rocks.png"
        offset: 8.0                      # f64 — perpendicular offset
        width: 16.0                      # f64 — shadow width
        layer: 50                        # i32 — shadow layer
  pixels_per_cell: 64.0                  # f64 — coordinate scaling

Rooms

Rectangular rooms with walls, doors, and terrain overrides. Outdoor features (trees, clutter, roads) automatically route around rooms.

rooms:
  - id: "guard_room"              # string, required — unique identifier
    x: 4                          # u32 — grid X position (left edge)
    y: 6                          # u32 — grid Y position (top edge)
    width: 5                      # u32 — width in grid squares
    height: 4                     # u32 — height in grid squares
    terrain_slot: 3               # usize, optional — terrain texture slot (0–3)
    walls:                        # optional — per-wall toggles (default: all true)
      north: true
      south: true
      east: true
      west: false                 # open side
    portals:                      # optional — doors/windows on walls
      - wall: "north"            # WallSide — north, south, east, west
        position: 2              # u32 — grid offset along wall from start
        type: "door"             # PortalType — door, window, archway, secret_door
        width: 1                 # u32 — portal width in grid squares

All coordinates are in grid squares (256 pixels per grid square internally). Rooms must not overlap or extend beyond map boundaries.

Corridors

Connections between rooms with parallel wall segments.

corridors:
  - from: "guard_room"           # string — source room ID
    from_wall: "east"            # WallSide — exit wall of source
    to: "throne_room"            # string — destination room ID
    to_wall: "west"              # WallSide — entry wall of destination
    width: 2                     # u32 — width in grid squares
    terrain_slot: 3              # usize, optional — floor terrain slot
    portals:                     # optional — doors at corridor ends
      - end: "from"             # CorridorEnd — "from" or "to"
        type: "door"            # PortalType
        width: 1                # u32 — portal width

Corridors are straight when rooms are aligned on the connecting axis; L-shaped otherwise.

Polygons

Arbitrary closed shapes defined by vertices in grid coordinates. Use for irregular rooms, oval chambers, or L-shaped areas.

polygons:
  - id: "room_a"                   # string, required — unique identifier
    points:                        # list of [x, y] vertices tracing the perimeter in order
      - [3, 6]
      - [9, 6]
      - [9, 14]
      - [3, 14]
    terrain_slot: 3                # usize, optional — terrain texture slot (0–3)
    wall_texture: "res://textures/walls/battlements.png"  # optional
    portals:
      - edge: 0                   # usize — 0-indexed segment (edge 0 = points[0]→points[1])
        position: 0.5             # f64 — fractional position along edge (0.0–1.0)
        type: door                # PortalType — door, window, archway, secret_door

Vertices may be listed clockwise or counter-clockwise; validation only rejects self-intersecting outlines and degenerate (zero-length) edges, plus polygons with fewer than 3 vertices.

Adjacency: When two polygons share an edge, the shared wall is automatically removed, creating an open connection. Overlapping polygons are merged into a single outer wall. Edge indexing: edge 0 = points[0] → points[1], the last edge wraps to points[0].