MD to Journal

Bring your detailed notes from Obsidian or another Markdown editor directly into Foundry VTT! MD to Journal allows you to synchronize an entire local folder of .md files, transforming them into a structured and fully linked collection of Foundry Journals.

This module was built with Obsidian.md users in mind but works perfectly with any folder of Markdown files. It's perfect for managing extensive campaign notes, world-building wikis, or adventure modules in your favorite external editor and seamlessly bringing them into your game.

Features

• Preserves Folder Structure: Your nested folders are converted into a matching folder structure within the Foundry Journals tab.

• Seamless Foundry Link Integration: Drag links from any Foundry entity (like an Actor, Item, Scene, or Journal) directly into your notes. They are automatically converted back into clickable @UUID links upon import, enabling a true round-trip workflow.

• Automatic Link Conversion: Automatically converts [[wikilinks]] and standard Markdown links between your notes into the proper Foundry VTT @UUID links, keeping your wiki connected.
• Asset Handling: Finds and uploads local images and other attachments referenced in your notes to a designated assets folder in Foundry.
• Obsidian Compatibility: Strips YAML frontmatter from your notes to keep the final journal pages clean and focused on the content.

• Extensible via Add-ons: The module is designed to be system-agnostic but can be enhanced for specific game systems through separate add-on modules. Developers can use a built-in hook to add their own text conversions (e.g., for PF2E action icons). Learn how to create an add-on here.

How to Use

1. Click the "Sync Folder" button at the top of the Journal Directory sidebar.
2. In the dialog, choose a destination folder within Foundry (or leave it as the top level).
3. Click the "Select Folder" button and choose the local folder on your computer that you want to upload.
4. Click "Sync to Journals" and let the module build your library.

Please note: Synchronization is not automatic. You must repeat this process any time you want to update your journals with the latest changes from your local folder.

Configuration Options

The module includes a few settings to customize your workflow:

• Custom Assets Path (Optional): You can select a specific folder for all uploaded images and attachments.
• Minimum Role to Use: Restrict the sync functionality to either Game Masters or Assistant GMs.
• Hide Sync Button: For a cleaner interface, you can choose to hide the sync button.

System-Specific Add-ons

The community has created add-ons that provide extra features for specific game systems. Install them just like any other module to enhance your import process.

• MD to Journal - PF2E Addon

*If you create an add-on for another system, please let me know, and I will be happy to list it here!*

⚠️ Important Disclaimer ⚠️

This module is in an early stage of development. The synchronization process works by deleting all previously synced content that it manages within the target folder before importing the new version. It is designed to protect journals you create manually within those folders, but backups are always recommended.

Please use at your own risk.

Credits and Acknowledgements

This module relies on the excellent marked.js library for fast and reliable Markdown-to-HTML conversion. A big thank you to its creators and maintainers