FoundryTools: User Guide

From 5etools Community Wiki
Revision as of 02:07, 25 May 2020 by Modnar (talk | contribs) (โ†’โ€ŽShort Introduction)
Jump to: navigation, search


Short Introduction

Foundry has its roots in a project called GM Forge, which was released on Steam to a moderate response. The application however showed the power of a single developer's efforts to build out a better game system for game players to use.

Inspired by that the author of FoundryVTT, Atropos (Andrew Clayton), started his work in August 2018 - pre-Alpha through November 2018 with closed Alpha testing until February of 2019. It was during that time that some of the larger initial community contributors for Roll20 began applying their considerable talents to FoundryVTT. May 22, 2020 the software was released with a large and dedicated community actively working together to get the software documented, polished, and its influx of users up and running.

FoundryVTT allows for direct working within the application. There are currently two tools that work with FoundryVTT;

Plutonium - (a foundry mod/module)
Rivet - (a browser extension)

To learn more about FoundryVTT; you should join their Discord, Visit their Website, and their Wiki.

Where to start...

You're likely here because you've found the site, love it, worked with Roll20, hated/disliked it, and want to do "x" with Roll20 and learned that Foundry can do "x". BUT, are stuck wondering how to bridge the gap between what you want to do, and the time it takes to enter the materials from your personal copies of the 5e books you already own.

So, for that let's directly link to where you likely want to go...

A disclaimer

Foundry is not associated with Norr group or the 5eTools project.


We should address that now.
The tool CAN be used improperly. Content is part of the 5eTools website, and if you don't own a copy of the content - you should avoid use and limit yourself to the content that you own or have legitimate access. A link to where you can obtain legal copies of each resource has been provided so that you can better support both WoTC and the individual content developers.


Whenever Foundry updates next - that doesn't always mean Plutonium will immediately be compatible.
To prevent loss of function that BEFORE YOU UPDATE Foundry, make sure the new features/bug fixes are what you need. That the modules you rely upon currently are compatible and consider the likely loss of function from updating Foundry. You are in a place to control your and your player's experience. It is not Roll20.


Currently, the source code is not public domain, but its release is planned once FoundryVTT is formally released.
It is expected the project will be opensource and released under the MIT license. Which (paraphrased) means you are welcome to use it, modify it, distribute it, and build from it.
It is however requested that if you do develop new versions or features that you fork from the Github and that you modify this page with a link to your own project. That you cannot profit from such modifications.

Foundry Tools


(A FoundryVTT mod) which is in closed beta access. Some additional seats are availible, see Support and the Community Discord for more information


(a browser extension) Rivet is an extension that allows 5etools rolls and (some) data to be sent to Foundry.
Settings for Rivet
Rolls generated on the 5eTools website are automatically sent to Foundry (if you find a roll which isn't, this is a bug; please report it.), but not the results of those rolls. Therefore, the results you see in 5eTools' dice roller will differ from those seen in Foundry. I would recommend using the output from Foundry.
This can be disabled in the extension popup settings.
This can be set to always whisper in the extension popup settings.
A 5etools entity (creature, spell, item, etc.) can be sent to Foundry by clicking the appropriate button next to its name. Note that this will only work with anything Plutonium was already capable of importing.
SHIFT-click the button to import the entity as a "temporary" Foundry Actor/Item/etc., which will be displayed instead of saved to the game. Note that Foundry's handling of these is spotty at best, so your mileage may vary.

If you are a developer, please see this page if you wish to contribute time to a project.

Related Project(s)

KaKaRaTo's Modules that moves your Roll20 Content into Foundry
R20 Exporter