Register

Markdown Importer

An Add-on Module for Foundry Virtual Tabletop

Author: Reetro Project: Source Foundry Versions 12 to 14 (Verified 14) Last Updated 9 hours, 35 minutes ago

Markdown Importer

A Foundry VTT module for D&D 5e that imports markdown files as NPC actors, player characters, journal entries, and merchant shops. Drag and drop .md files onto the canvas or use the built-in editor to write and import directly.

HOW TO USE

Drag and Drop

Drag any .md file onto the Foundry canvas. A dialog will appear asking what to create — NPC Actor, Player Character, Journal Entry, or Merchant Shop (if the Merchant Sheet module is installed).

Markdown Editor

Click the Tiles group in the scene controls toolbar on the left side of the screen. The Markdown Editor button opens a built-in editor where you can write or paste markdown and import it directly without touching a file.

The editor has three or four save buttons at the bottom depending on which modules are installed. Save as NPC creates an NPC actor. Save as Player creates a player character actor. Save as Journal creates a journal entry. Save as Shop creates a merchant shop and is only visible if Merchant Sheet is installed.

MARKDOWN SYNTAX

Basic Structure

Every file starts with a hash for the name and italics for the size, race, and alignment.

 
# Goblin Scout
*Small Humanoid, Neutral Evil*

NPC Stat Block

List armor class, hit points, and speed as bold pairs. Add the ability score table, then bold lines for skills, senses, languages, and challenge rating. Use double hash headings for Features, Actions, Reactions, and Bonus Actions.

 
**Armor Class** 13
**Hit Points** 10 (3d6)
**Speed** 30 ft.

## Actions

**Scimitar.** *Melee Weapon Attack:* +4 to hit, reach 5 ft.
*Hit:* 5 (1d6 + 2) slashing damage.

Player Character

Add a bold Class line near the top and double hash sections for Ideals, Bonds, and Flaws.

 
**Class** Rogue

## Ideals
Freedom is the only thing worth fighting for.

## Bonds
I owe a debt to the thieves guild.

Spells

Each spell goes on one line with name, level, school, and all properties followed by the description.

 
## Spells

**Fireball.** 3rd-level evocation. Casting Time: 1 action. Range: 150 ft. Components: V, S, M. Duration: Instantaneous. Each creature in a 20-foot radius makes a DC 14 Dexterity saving throw, taking 8d6 fire damage on a failure.

Supported levels are Cantrip, 1st-level, 2nd-level, 3rd-level and so on. Supported schools are abjuration, conjuration, divination, enchantment, evocation, illusion, necromancy, and transmutation.

Custom Items

Each item starts with a dash and a name, with sub-properties indented below.

 
## Custom Items

- Serpent Fang Dagger
  - type: weapon
  - rarity: rare
  - damage: 1d4
  - damage type: piercing
  - description: A curved dagger carved from a serpent fang.
  - icon: icons/weapons/daggers/dagger-curved-black.webp

Supported types are weapon, armor, armour, equipment, consumable, potion, tool, loot, treasure, feature, feat, and spell. Supported rarities are common, uncommon, rare, very rare, legendary, and artifact. Supported sub-properties are type, rarity, weight, description, icon, damage, damage type, range, and ac.

Merchant Shop

Each item is a dash, the name, a pipe, the price and currency, and optionally a pipe followed by qty and a number.

 
## Shop

- Longsword | 15 gp
- Health Potion | 50 gp | qty: 3
- Torch | 1 cp | qty: unlimited

Add a pipe and the word custom to create a custom shop item with sub-properties.

 
- Rare Blade | 200 gp | qty: 1 | custom
  - type: weapon
  - rarity: rare
  - description: A finely crafted blade of unknown origin.

Currency options are cp, sp, ep, gp, and pp. Omit the quantity portion entirely for unlimited stock.

SETTINGS

Open via Settings, then Module Settings, then Markdown Importer, then Configure.

Section Keywords

These settings control which markdown headings the parser looks for. Each is a comma-separated list of heading names. Matching is case insensitive.

Lore / Biography defaults to Lore, Who He Is, Who She Is, Who They Are, Biography, Details, Public. Populates the actor's biography field. Traits defaults to Racial Traits, Traits. Creates passive feat items. Class Features defaults to Class Features, Features. Creates class feature items. Actions defaults to Actions. Creates weapon and active ability items. Reactions defaults to Reactions. Creates reaction items. Bonus Actions defaults to Bonus Actions. Creates bonus action items. Spells defaults to Spells, Spell List. Creates spell items. Equipment defaults to Equipment. Creates equipment items for PC actors. Ideals defaults to Ideals. Populates the PC ideals field. Bonds defaults to Bonds. Populates the PC bonds field. Flaws defaults to Flaws. Populates the PC flaws field.

Parsing Behaviour

Class name search depth defaults to 10. This controls how many lines from the top of the file the parser searches for a class name when importing a PC. Normalise skill and damage names defaults to off. When on it formats skill and damage type names to match Foundry's internal naming conventions, useful if items are not appearing in the correct tabs. Look up icons from compendium defaults to on. Searches compendium packs to find matching icons for imported items by name. Disable if imports are slow due to large compendium collections.

COMPATIBILITY

Foundry VTT v12 to v14. D&D 5e system v3.0 or later. The Merchant Sheet module is optional and enables the Merchant Shop import option when installed.

 

Please report any bugs or issues here - https://github.com/Reetro/Markdown-Importer/issues

Supported Game Systems

  1. Dungeons & Dragons Fifth Edition

    Latest Version: Version 5.3.3 Last Updated 3 months ago

Categories

Available Versions

  1. Version 1

    9 hours, 35 minutes ago
    Foundry Version 12 - 14 (Verified 14) Manifest URL Read Notes