DungeonFog to FG Module Generator

Fantasy Grounds

Hello! Welcome to the Fantasy Grounds module generator for DungeonFog

This page and the generator itself were coded in their entirety by Forecaster, for the benefit of the venn diagram overlap between DungeonFog users and Fantasy Grounds users (such as myself).

You can get started right away by using the form below, or read on for more information!

If, after reading the sections below, you need additional help, or want to report an issue, you can find Forecaster on the DungeonFog discord. You can also report issues and submit feature requests on this projects GitHub repository (requires a GitHub account).

On the GitHub page you can also find all the code associated with this project, which includes the parser and this page.

Features:

Import of map image
Wall definitions for Line of Sight
Doors, windows, toggleable walls, & illusory walls
Lighting

Video overview/tutorial

Chapters:
00:00:00 - Chapter 0 - Introduction
00:05:27 - Chapter 1.1 - Executable & GUI
00:26:32 - Chapter 1.2 - Command line
00:49:01 - Chapter 2 - Web generator
00:52:16 - Chapter 3 - Python scripts

Watch on YouTube

Download Application

Go here to download the application version of this tool!

Generate Module

For the application version of the module generator see the sections below the form. Get more options and features by downloading the application.

The module name and list of files are passed to the script as normal. The module author field is passed to the script using the -a parameter.

.section_title:hover { text-decoration: none; } .section_title { margin-top: 20px; margin-bottom: 10px; display: inline-block } .section_title.hidden { display: none } #section_content_6622a8f8e97f8 { margin-left: 35px; margin-top: 10px; margin-bottom: 20px; display: none } #show_section_6622a8f8e97f8:target ~ div.collapsible-section a[href='#show_section_6622a8f8e97f8'] { display: none; } #show_section_6622a8f8e97f8:target ~ div.collapsible-section a[href='#hide_section_6622a8f8e97f8'] { display: inline-block; } #show_section_6622a8f8e97f8:target ~ div #section_content_6622a8f8e97f8 { display: block }

What does this do?

This generator takes one or more .df2vtt files exported from DungeonFog and turns them into a module file for Fantasy Grounds. (One module can contain multiple maps)

This module can then be added to the Modules directory in Fantasy Grounds and loaded within a campaign to access its contents.

.section_title:hover { text-decoration: none; } .section_title { margin-top: 20px; margin-bottom: 10px; display: inline-block } .section_title.hidden { display: none } #section_content_6622a8f8e9851 { margin-left: 35px; margin-top: 10px; margin-bottom: 20px; display: none } #show_section_6622a8f8e9851:target ~ div.collapsible-section a[href='#show_section_6622a8f8e9851'] { display: none; } #show_section_6622a8f8e9851:target ~ div.collapsible-section a[href='#hide_section_6622a8f8e9851'] { display: inline-block; } #show_section_6622a8f8e9851:target ~ div #section_content_6622a8f8e9851 { display: block }

How do I use the generator?

You have three choices for using the generator, and they are as follows:

Use the limited online generator on this page. Easy.
Download the executable and run the generator locally. Intermediate.
Download the Python scripts and run the generator via the commandline. Expert.

Each of these have their own advantages and drawbacks. See the following sections for more information about each.

.section_title:hover { text-decoration: none; } .section_title { margin-top: 20px; margin-bottom: 10px; display: inline-block } .section_title.hidden { display: none } #section_content_6622a8f8e9861 { margin-left: 35px; margin-top: 10px; margin-bottom: 20px; display: none } #show_section_6622a8f8e9861:target ~ div.collapsible-section a[href='#show_section_6622a8f8e9861'] { display: none; } #show_section_6622a8f8e9861:target ~ div.collapsible-section a[href='#hide_section_6622a8f8e9861'] { display: inline-block; } #show_section_6622a8f8e9861:target ~ div #section_content_6622a8f8e9861 { display: block }

Online Generator

The web generator is easy and quick to use, and requires no setup, but it does require uploading the .df2vtt files and then downloading the resulting module. This of course requires an internet connection.

There are also some restrictions on file sizes:

A maximum of 20 files can be uploaded to create a single module.
Each file can be a maximum of 20 MB.
The maximum total size of all the files combined is 50 MB.

There are also no settings available for the online generator at the moment.

.section_title:hover { text-decoration: none; } .section_title { margin-top: 20px; margin-bottom: 10px; display: inline-block } .section_title.hidden { display: none } #section_content_6622a8f8e986d { margin-left: 35px; margin-top: 10px; margin-bottom: 20px; display: none } #show_section_6622a8f8e986d:target ~ div.collapsible-section a[href='#show_section_6622a8f8e986d'] { display: none; } #show_section_6622a8f8e986d:target ~ div.collapsible-section a[href='#hide_section_6622a8f8e986d'] { display: inline-block; } #show_section_6622a8f8e986d:target ~ div #section_content_6622a8f8e986d { display: block }

Executable

You can download the generator as an executable which includes everything required to run it.

With this you can generate modules locally on your system without an internet connection or having to send the map files anywhere. You also get access to more options, such as the portal refinement system, and more.

The executable can also be run from the commandline without the GUI if required.

.section_title:hover { text-decoration: none; } .section_title { margin-top: 20px; margin-bottom: 10px; display: inline-block } .section_title.hidden { display: none } #section_content_6622a8f8e9948 { margin-left: 35px; margin-top: 10px; margin-bottom: 20px; display: none } #show_section_6622a8f8e9948:target ~ div.collapsible-section a[href='#show_section_6622a8f8e9948'] { display: none; } #show_section_6622a8f8e9948:target ~ div.collapsible-section a[href='#hide_section_6622a8f8e9948'] { display: inline-block; } #show_section_6622a8f8e9948:target ~ div #section_content_6622a8f8e9948 { display: block }

Python Scripts

Advanced users may wish to download the raw Python scripts which can be through the Python interpreter.

This requires the correct libraries to be installed in the Python environment.

I'm not going to provide instructions on how to do this. The generator will complain if you try to use a feature without the required libraries installed.

.section_title:hover { text-decoration: none; } .section_title { margin-top: 20px; margin-bottom: 10px; display: inline-block } .section_title.hidden { display: none } #section_content_6622a8f8e9953 { margin-left: 35px; margin-top: 10px; margin-bottom: 20px; display: none } #show_section_6622a8f8e9953:target ~ div.collapsible-section a[href='#show_section_6622a8f8e9953'] { display: none; } #show_section_6622a8f8e9953:target ~ div.collapsible-section a[href='#hide_section_6622a8f8e9953'] { display: inline-block; } #show_section_6622a8f8e9953:target ~ div #section_content_6622a8f8e9953 { display: block }

Notes & Known issues

Notes:

Using the web-based parser requires uploading the map files to Forecasters server and downloading the resulting files from it. While these files are not publicly accessible in any way, no guarantees are made regarding their security. If you wish for guaranteed security you must run the generator locally. See the other sections for instructions on how to do this.
If you are generating an updated version of a module you have loaded into Fantasy Grounds previously, make sure you use the same name for the module and any maps within, or any changes or current token positions within a campaign will be lost.

Known issues:

Due to limited data within the df2vtt format all windows are treated as doors by default. To specify which portals are windows, toggleable walls, etc, use the portal refinement mode. Once portals are tagged in the export these will be used to define defaults (though these will not cover all types available in Fantasy Grounds).

.section_title:hover { text-decoration: none; } .section_title { margin-top: 20px; margin-bottom: 10px; display: inline-block } .section_title.hidden { display: none } #section_content_6622a8f8e9960 { margin-left: 35px; margin-top: 10px; margin-bottom: 20px; display: none } #show_section_6622a8f8e9960:target ~ div.collapsible-section a[href='#show_section_6622a8f8e9960'] { display: none; } #show_section_6622a8f8e9960:target ~ div.collapsible-section a[href='#hide_section_6622a8f8e9960'] { display: inline-block; } #show_section_6622a8f8e9960:target ~ div #section_content_6622a8f8e9960 { display: block }

Feedback

I stated this above, but I'm summarizing it just in case someone misses it (with a nice clear title too):

Any bug report, feature request, or other feedback can be delivered in the following ways:

The following changelog is for the module generator in general, including this web page, the application and the Python scripts. Changes, features, or fixes unless specified may apply to all of these.

2021-08-19 v1.2.3 Change from setting ruleset to 53 to setting it to Any (Should make the module available in most CoreRPG-based rulesets 2021-07-28 v1.2.2 Executable doesn't work in command line mode Some typos 2021-07-27 v1.2.1 Portal number disappearing in portal refinement window when reaching double digits Portal refinement breaking when trying to parse more than one map Implemented proper logging system with levels Improved error handling for input files Block clicking Generate button in GUI with no files selected 2021-07-26 Ignore lights and ignore walls & doors is always on in online generator Example command output based on form fields 2021-07-20 Improved layout of web page Improved feedback from script when using form Update generator form to work with updated scripts 2021-07-18 v1.2 GUI & Executable Portal refinement mode Lighting support 2021-05-08 v1.1 All doors are walls bug Missing line in doors -p (portal refine) mode to script (not available in web version) 2021-04-26 v1.0 Initial release

Web Analytics