KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

lava-flow

★ 96 Open GitHub ↗

A Foundry VTT module that allows you to import your notes from Obsidian MD into Foundry journal entries.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Lava Flow

This module allows you to import your notes from Obsidian MD into Foundry journal entries.

## Features

- Select your whole vault or even just one folder within it. Or even just any folder with .md files.
- Replaces Obsidian links with journal entry links in Foundry.
- Overwrite or ignore existing journal entries.
- Give your players permission to observe all notes or not during import.
- Optional index Journal entry which lists all your notes under their top-level folder.
- Optional "Reference" section which adds backlinks to each journal entry, similar to Obsidian MD's backlinks.
- Optionally import your images and have them embedded in your journal entries.
- All created folders have the flag "lavaFlowFolder" and likewise journal entries will have the flag "lavaFlowJournalEntry".

## Compatibility Matrix

I highly recommend using the latest version of Foundry supported by the module, as the latest version of this module will have the best functionality and latest bug fixes.
| Lava Flow Version | Foundry Version |
| -- | -- |
| v1.\* | v9 |
| v2.\* | v10 |
| v3.\* | v11 |
| v4.\* | v12 |
| [TODO: workaround for now](https://github.com/Praxxian/lava-flow/issues/74) | v13 |

## How to Use

1. Under the Journal tab, there is an "Import Obsidian Vault" button.\
   ![image](https://user-images.githubusercontent.com/54974037/146979663-d754caeb-df13-454c-8b2a-00ecce5ff8a4.png)
1. Click this to open the import menu.\
   ![image](https://github.com/Praxxian/lava-flow/assets/54974037/806dded3-8239-4743-a47d-1f7590a2bc5a)
1. Name the top journal folder you wish to place your notes in. If this folder does not already exist, it will be created. Leaving this blank will place your notes directly into your journal entries.
1. Select the folder you wish to import. This can be any folder within your vault, including the root, or any folder with markdown files.
1. Select if you wish to overwrite journal entries that already exist with the same name in the same folder.
   - (Optional) If you do not wish to overwrite existing journal entries, you can choose to skip duplicates.
1. Select if all players should have the [Observer](https://foundryvtt.com/article/users/) permission on the notes that get imported.
1. Select if you wish to create an Index journal entry. This lists links to every imported entry, organized by their top-level folder.\
   ![image](https://user-images.githubusercontent.com/54974037/146980929-400ce499-c352-47a1-890a-5f3ae574b8d3.png)
1. Select if you wish to create backlinks in each imported journal entry. This creates a "Reference" section to the end of each journal entry, linking to all the journal entries that reference it.\
   ![image](https://user-images.githubusercontent.com/54974037/146981259-6755cb58-a4d6-4df6-9473-8ad8c5914182.png)
1. Select if you would like to combine individual files into a single journal entry with multiple pages for each folder. Using this, the Journal Entry will have the folder name, and the pages will be named after the files.
   - You can choose to do this _only_ when no subfolders are present. This is the default and recommended setting. Allowing this for all folders creates some unintuitive results like having a Journal Entry and folder named the same thing.
1. If you want to import images, select "Import non-markdown files". By default, this uses local storage, you can also select S3 storage.

## Known Issues

- **Foundry Version 13:** Compatability is in progress, but in the meantime there is a [workaround](https://github.com/Praxxian/lava-flow/issues/74).
- Folder depth is limited to Foundry's folder depth limit.
- Obsidian Canvas files are not supported. These will be ignored.
- Issues with selecting a folder and having no files import. This is usually an issue with webkitdirectory. Workaround/solution is typically to use a different browser (e.g. Firefox, Chrome, Edge).
  - Caused by some browsers (e.g. OperaGX)
  - Foundry App
    - Caused by older versions of Electron, which the Foundry app uses.
    - This impacts all v9 installs.
    - This _can_ impact v10 and newer if you previously had a v9 install and upgraded Foundry via the app instead of through a v10 installer.
    - If you experience this in v10+, try installing using a new installer. Please take all appropriate caution, such as backing up your user data, as you would with any upgrade.
- Not all Obsidian markdown is supported in Foundry.
  - Callouts are formatted as block quotes.
  - Code blocks work, but do not have syntax highlighting.
  - Comments
  - Diagrams
  - Embeds: These are still linked, but the text is not populated within the page's content.
  - Footnotes
  - Highlighting
  - Obsidian URI links: you should not need these anyway since you would not want to link from the Foundry server's file system. Use normal `[[Links]]`.
  - Math using Mathjax.
  - Tasks are formatted as lists with `[x]` instead of checkboxes. Still readable, but not as clean.

## License

Lava Flow is released under the MIT License.

## Contact

The best place to track bugs is to create a [new issue](https://github.com/Praxxian/lava-flow/issues/new).

For other questions, I am on both the Obsidian and FoundryVTT Discord as @praxis#2944.

lava-flow

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README