Difference between revisions of "FoundryTools: User Guide"

From 5etools Community Wiki
Jump to: navigation, search
m (Where to start...)
m (A disclaimer)
Line 33: Line 33:
  
 
::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.
 
::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.
 +
 +
==== Compatibility ====
 +
:: 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.
  
 
<br/>
 
<br/>

Revision as of 13:44, 23 May 2020

framless
v1.3.1

Short Introduction

Welcome to the movement!


FoundryTools is a bit different; in that FoundryVTT allows for direct working within the application. There are currently two tools that work with FoundryVTT;

Plutonium - (a foundry mod)
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.

Content

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.

Compatibility

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.


Code

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

Plutonium

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


Rivet

(a browser extension) Rivet is an extension that allows 5etools rolls and (some) data to be sent to Foundry.
Usage
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
Beyond20