Skip to content
Rodrigo Takehara edited this page Feb 21, 2022 · 37 revisions

How do I install 5e-Framework?

You don't install it. A framework is just a campaign file for MapTool (with lots of code that makes interfacing between an RPG and MapTool easier - like character sheets and dice rolls.) You just open it and add on to it.

To use it, you just need MapTool installed and open the Framework with it. If you already have content, you can drag and drop images for maps and handouts, and copy and paste text and edit it.

How do I update the Framework?

See Updating

Where can I get more Monsters, Spells and Character Options?

For legal reasons, only SRD content is available in the 5e-Framework. You can create your own and share among friends or import from D&D Beyond (or another resource you own.) 5e-Framework version 2.5.3 includes the ddb importer, allowing you to easily import monsters and spells from D&D Beyond.

To import new content that you got somehow, open the JSON file and copy it's content, then in the framework, open the DM Menu (F12) and go to the Settings, click Import Compendium and paste that content there. It will merge the current content with the new one, if it find duplicates, the new ones will override the old ones.

I am getting a "Error executing "switchToken": the token name or id "" is unknown. message.

That's not a question. To use your character sheet, you must be in the same map as it's token, if you opened the character sheet then moved to another map, the sheet will not find the token and will give you this error. You can either move your token with you or go back to the map you was before.

If your character is on the current map and you still experience this problem, be sure the character token's name only contains letters and numbers, and refresh the character sheet and weapons.

On versions 1.5 and newer, player tokens are referenced on a Library token, so this error should not appear on these versions.

I making changes on my Character Sheet and sometimes rolls back to an older state.

Not a question, if the changes don't take place immediately and you get an error message, be sure your token is present on the current map. Similarly, if the changes happened on another map, it's because the updated token is on that map, and the character sheet takes data from the current map.

On versions 1.5 and newer, player tokens are referenced on a Library token, so this error should not appear on these versions.

How can I Contribute?

Check the Contributing. Thanks for the interest, by the way!

Is it available in insert language here?

If it's not English, then no.

Can I help translating it to insert language here?

Not yet, you could translate on your own, but updating would be a pain so I do not recommend it, I need to figure out how to centralize all text used in the framework so language would be mostly unaffected by version.

I know it's not the same thing, but you can translate the Monsters, Features and Additional Features, spells and items may break so some testing is required.

Does it work on Mobile?

No.

Does it Support Fog of War/Dynamic Lighting?

Yes.

What are the advantages over Roll20?

MapTool is free, open source and extremely flexible. It's not browser-based so you have to download and install it, but because of that, it doesn't depend on a remote server. That means you're not dependent on Roll20 servers, you can use high resolution images and you're not restricted in storage size. MapTool supports advanced features like Dynamic Lighting, Vision, Fog of War and much more. MapTool also features its own scripting language - allowing you to code and share your own creations.

MapTool already has a large library of ready-to-use "drop-in" resources to enhance your game! Some of these resources include animated doors, localized audio, teleport pads, random treasure generators and weather effects. Features like these require a subscription from the other guys! If you don't find a framework for your RPG of choice, you can make your own and share with others!

The 5e-Framework is a self-contained solution to playing D&D 5th edition with MapTool. The framework is fully-featured with a compendium and can automate most gameplay mechanics. It can assist with game rules, character creation, attack and damage rolls, applying conditions, spell casting, resource management and more - all without needing to leave MapTool. The expansive compendium includes all SRD content and functions similar to the Roll20 compendium. It's easy to edit and easy to expand - allowing for the quick import of monsters and spells from D&D Beyond. The framework also includes a language system, increasing the level of immersion.

Some of these advantages are subjective to your expectations, use the tool best suited for you.

Does it have D&D Beyond integration?

It has partial intergration. Currently, you can import Monsters and Spells individually from D&D Beyond.

You can also import public characters but this feature may not work 100% of the time

Does it support Pathfinder 2?

There are Pathfinder 2 frameworks made by others. 5e-Framework doesn't support Pathfinder 2 - it's a D&D framework.