Difference between revisions of "FoundryTools: User Guide"

From 5etools Community Wiki
Jump to: navigation, search
m (Where to start...)
m (Short Introduction)
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
{{PlutoniumHeader}}
 
{{PlutoniumHeader}}
 
=Short Introduction=
 
=Short Introduction=
 +
===FoundryVTT===
 
: 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.   
 
: 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.
+
: 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.
  
  
 
<br/>
 
<br/>
FoundryVTT allows for direct working within the application. There are currently [[FoundryTools:_User_Guide#Foundry_Tools|two tools]] that work with FoundryVTT;  
+
: FoundryVTT allows for directly building apps within the platform. 5eTools has currently two tools that work with and within FoundryVTT;  
: Plutonium - (a foundry mod/module)
+
: '''Plutonium''' - (a foundry mod/module)
: Rivet - (a browser extension)
+
: '''Rivet''' - (a browser extension)
 
<br/>
 
<br/>
 +
===Plutonium===
 +
: Is an add-on module for FoundryVTT, which is available for free to the public. You can pick it up from [https://get.5e.tools/ '''here''']. Plutonium adds various Quality of Life (QoL) features, as well as specific features for 5e gaming. Including a character building tool, community created content and a simplified means to bring content you legally own - into Foundry via a few clicks of the button.
 +
<br/>
 +
===Rivet===
 +
: Rivet is a browser extension that brings content from 5eTools website in a targeted manner into Foundry from interacting on the website. Its a bridge, using the ease of the website's UI as you become more accustomed to Foundry's interface.
  
 +
<br>
 
To learn more about FoundryVTT; you should join their [{{Template:FoundryCommunitylink}} '''Discord'''], Visit their [https://foundryvtt.com '''Website'''], and their [https://foundry-vtt-community.github.io/wiki/ '''Wiki'''].
 
To learn more about FoundryVTT; you should join their [{{Template:FoundryCommunitylink}} '''Discord'''], Visit their [https://foundryvtt.com '''Website'''], and their [https://foundry-vtt-community.github.io/wiki/ '''Wiki'''].
  

Revision as of 22:15, 29 July 2020

framless
v1.5.0

Short Introduction

FoundryVTT

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 directly building apps within the platform. 5eTools has currently two tools that work with and within FoundryVTT;
Plutonium - (a foundry mod/module)
Rivet - (a browser extension)


Plutonium

Is an add-on module for FoundryVTT, which is available for free to the public. You can pick it up from here. Plutonium adds various Quality of Life (QoL) features, as well as specific features for 5e gaming. Including a character building tool, community created content and a simplified means to bring content you legally own - into Foundry via a few clicks of the button.


Rivet

Rivet is a browser extension that brings content from 5eTools website in a targeted manner into Foundry from interacting on the website. Its a bridge, using the ease of the website's UI as you become more accustomed to Foundry's interface.


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 5etools 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; or you already use Foundry and heard of Plutonium from a friend and want some of its QoL features.
So, for that let's take you link to where you likely want to go...




A disclaimer

The use of this tool is meant for use for your own campaigns. It is only meant and should only be used on campaigns with content that you legally possess. The use of this tool may be against the FOUNDRY Virtual Tabletop EULA or Terms of Service with your Virtual hosting service. Plutonium, 5etools, and the Norr Group are not affiliated with Foundry Gaming, LLC, and are developed independently from such.

Content

We should address that now.
The tool can be used improperly. Some of its content comes from the 5eTools website, and if you don't own a copy of the content - you should ABSOLUTELY avoid use and limit yourself to the content that you own or have legitimate access (see Blacklisting for how). 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 FoundryVTT updates next - that doesn't always mean Plutonium will immediately be compatible.
To prevent loss of function BEFORE YOU UPDATE Foundry make sure the new features/bug fixes in the newest FoundryVTT are what you need.
Its not uncommon that updates can create compatibility "gaps" with custom modules. If a module you rely upon currently is not compatible, consider the likely loss of that function from updating Foundry.
You are in a place to control your and your player's experience. It is not Roll20. This is the power of self hosting.


Open Source Code

Currently, the source code repo is not public domain, but its release is planned.
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 eventual Github and that you modify this page with a link to your own project, and that license does not permit you to resells or profit from the source or your modification from such.


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.


Hosting Services

For Foundry to be useful, both you and your players will need to access the site the software generates. This is called hosting, and you can do it locally (from your workstation/home/business) or through a provider - website/application/VPS. There are a staggering number of options for this; but to help you out the installation guide will go into some specifics; but in general - if you're looking for a solution; here are the services we've been made aware that work with Foundry.

Self/Local host

You run the service from your home, school or office network on a workstation or device works on (confirmed)
  • MacOs
  • *nix (ie various versions of Unix/Linux)
  • Windows 10
Devices
  • SBC (single board computers) - such a RaspberryPIs (2 or better); Asus Tinker; LattePanda Alpha; (minimum requirements for FoundryVTT apply- if you're running more modules, more memory/speed/storage is always going to be a good investment)
  • GoogleChrome books (?!?) I know - but.. yes, its possible.

Cloud/VPS Hosting

Please note, MANY hosting companies CAN host Foundry as it is Node.js, however MANY will absolutely request you not have a constant running service. So, while you can get it running, that doesnt' mean your hosting provider will be happy when they're visiting the logs and see your account eating up capacity while idle.
The following is a small cross-segment of hosting platforms and relative costs (if any cost exists)


[1] (always free)
lightsail 💸 (1 year free)
EC2 💸💸


Foundry User Guides

How to Install Foundry
How to Create a Character in Foundry


Related Project(s)

There are a few services that commonly are used for 5e content and playing such.
Adventures - Adventure Import/Export ; DnD Beyond Importer (A great system for those who use DnD Beyond for their digital properties - Bonus; its a very well done design)
Items/Monster/Feats; etc importer - DnD Beyond Importer ; [2] ; Community Tables; Beyond20 (Another DnD Beyond importer); [ https://gitlab.com/fohswe/smip-compendium] ;

Roll20

KaKaRaTo's Modules that moves your Roll20 Content into Foundry, exceptional effort.
R20 Exporter for Chrome
(outdated video here )
R20Converter; which takes those exports and creates a world or compendium file from such


R20 macros to Foundry VTT macros.
https://github.com/ASLopesJR/r20vttable


DnD Beyond

VTTassets pulls monsters/characters/even modules AND THEIR MAPS, stunning work - hefty labor of love.
DnDBeyond
KaKaRaTo's moves your DnDBeyond rolls/Content into Foundry
Beyond20 for Chrome
NOTIFICATION: Beyond20 requires a static Foundry Tab name to key off of, if you use Plutonium's Feature for tab renaming - it will break Beyond20's functionality. But if don't want to use that Plutonium feature... Beyond20's limitation/implementation will not. Just a heads up.