Feature: Module Importer/Exporter

From 5etools Community Wiki
Jump to: navigation, search

framless
v1.18.4

Module Importer Exporter.gif

Module Importer/Exporter

Dm.png
Found in the Open Tools list.
A game backup and recovery system.
This saves the maps, tables, Decks, & character to a file saved locally so that you don't lose it, and so that you can share your work with other DMs.


Feature's Elements 

Portions of this feature are configurable through the Configuration Editor's Import Tab.


Module exporter importer.png

1. Exporter

Export Game to File
Converts all of the Maps, Journal Entries (Handouts & Character Sheets), Token Actions, Decks, and Rollable tables into a JSON file stored locally.

2. Importer

Load from 5eTools
Clicking this pulls the 5eTools repository for Modules. From that list, one Module can be picked
Upload File
Clicking this attempts to pull the file from a specific (often local) location.

3. Import Category

  • Character - (this covers all PCs, NPCs, and Monsters)
  • Jukebox Tracks -
  • Maps


NOTE:  The script-wide configurable "rest time" options (found in the Config Editor ) affect how quickly each category of entries is imported (tables and decks use the "Handout" rest time value)

Walkthrough (How to use it)

Importer

  • Choose either Load from 5eTools, or Upload file
  • Navigate to the module/file you wish to use
  • Choose the Import Category you wish to import from the drop-down list.
  • Choose the item(s) from the list you wish to import, or choose all
  • Click Import.

Exporter 

  • Click Export Game to File   (the exporter exports the game you are currently in)
  • Choose which category(ies) you wish to export.
  • Save file
     
The file will include all categories in one file. Which it should prompt you with where to save it locally. Navigating to the location with your file manager to confirm its existence, or if its not there, check to confirm you've followed the directions by trying it again.



Feature Support


Known Issues/Limitations

Why Don't my imported Monsters have Macros?

Well for Module Importer/Exporter the modules are exact copies of the Roll20/WoTC module. So this is as is expected and intended.

Why Don't the module's spells/items/etc bind with drag n' drop?

Well for Module Importer/Exporter the modules are exact copies of the Roll20 adventure, if that adventure didn't have that feature when it was exported... it doesn't now - and most publishers don't use Giddy's format for such.

Karkolohk map is broken in Rime of the frostmaiden

Yup, you'll have to find a replacement map.


FAQ

What modules can I import

The Following Modules are availible for Import
REMINDER: If you do not own the module IRL you may be violating your country's laws by importing such


Why Don't my imported Monsters have Macros / my Import settings*?

Well for Module Importer/Exporter the modules are exact copies of the Roll20/WoTC module. So this is as is expected and intended - modules have verbatim as Roll20/WoTC intended. The module importer bypasses the importing config editor settings.

Modules you can import

Best Practices

While you can import the categories in any order.

If you are importing maps, and wish to use them "as is" (with the encounters/monsters that are there), we recommend importing characters also, until their associated character sheets are imported, they do NOT have a reference for their bars (HP / AC etc). Attempting to modify them before the character sheets are loaded may break that link, even if their charcter sheet is later loaded, and you would then have to manually go and reassign the tokens that have been modified.

NOTE:  The script-wide configurable "rest time" options (found in the Config Editor ) affect how quickly each category of entries is imported (tables and decks use the "Handout" rest time value).


NOTE:   Configuration options (aside from "rest time" as detailed above) do not affect the module importer. It effectively "clones" the content as-exported from the original module, including any whisper/advantage/token actions/ etc sort of settings.




Related Features



Did that answer your question(s)?

If not please check the under Support; Troubleshooting or the Known Issues page for further guidance, or go to the Discord community and leave a comment in the issues channel.

If you enjoy the project, please follow this link to see how you can contribute and help make it even better.