Difference between revisions of "FoundryTools: User Guide"

From 5etools Community Wiki
Jump to: navigation, search
m (Where to start...)
m (How to use it?)
 
(42 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
__INDEX__
 
__INDEX__
 
{{PlutoniumHeader}}
 
{{PlutoniumHeader}}
=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.
+
==Where to start==
 +
::You're likely here because you've found the 5etools site, love it, worked with Roll20, wanted to do "x" with Roll20 and learned that Foundry can do "x", or were looking for a better experience with online gaming and 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 the name '''Plutonium''' from a friend and want some of its [[Feature: FoundryTool|'''QoL features''']].
  
 +
::So, for that let's take you link to where you likely want to go for specifics...
  
<br/>
+
===How to use it?===
: FoundryVTT allows for directly building apps within the platform. 5eTools has currently two tools that work with and within FoundryVTT;
+
::* [[FoundryTool_Install|'''💾Installation Guide''']]  (Get it installed)
: '''Plutonium''' - (a foundry mod/module)
+
::* [[Feature: FoundryTool|'''📋 Features Guide''']] (Get informed on that it does)
: '''Rivet''' - (a browser extension)
+
::* [[Foundry:Guide to Creating a character with Plutonium|'''🏗️How to make a character using Plutonium''']] (Get a practical guide on how to use it)
<br/>
+
::* [[Charactermancer|'''🏗️How to make a character using Plutonium's Charactermancer''']] (Alpha feature)
===Plutonium===
+
<br>
: 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.
+
::* [[Troubleshooting: Plutonium|'''🔧Troubleshooting Guide''']]
<br/>
+
::* [[FoundryTool FAQ|❓ FAQ]]
===Rivet===
+
::* [[Homebrew| '''🍺 Adding Custom Content (Making Homebrew)''']]
: 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.
+
::* [[ChangeLog: Foundry| '''📑 Changelog''']]
 
 
 
<br>
 
<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'''].
+
::* [[Foundry:BestofAddOn_Modules|'''List of Popular Foundry Modules''']] - community curated modules
 
 
==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 [[Feature: FoundryTool|'''QoL features''']].
 
 
 
::So, for that let's take you link to where you likely want to go...
 
:* [[FoundryTool_Install|'''💾Installation Guide''']]
 
:* [[FeaturePlutonium: Importing| '''How to Import content''']]
 
 
<br>
 
<br>
:* [[Troubleshooting: Plutonium|'''🔧Troubleshooting Guide''']]
 
:* [[Feature: FoundryTool|'''📋 Features Guide''']]
 
:* [[FoundryTool FAQ|❓ FAQ]]
 
:* [[Homebrew| '''🍺 Adding Custom Content (Making Homebrew)''']]
 
:* [[ChangeLog: Foundry| '''📑 Changelog''']]
 
  
 +
:: FoundryVTT allows for building apps within the platform through their public and well documented APIs. 5eTools has currently two tools that work with and within FoundryVTT;
  
:* [[FeaturePlutonium: Importing|'''Guide to Importing''']]
+
::<div style="font-size:20px;font-weight: bold;">[[Feature: Plutonium|Plutonium]]</div>
:* [[Foundry:Guide to Creating a character with Plutonium|How to make or level up a character, using 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/>
 
:* How to Migrate from [[Foundry: r20Conversion| Roll20]] or [[[[Foundry: FGConversion|Fantasy Grounds]] to Foundry.
 
  
== A disclaimer ==
+
::<div style="font-size:20px;font-weight: bold;">[[Feature: Rivet|Rivet]]</div>
:: 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 [https://foundryvtt.com/article/license/ '''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.
+
:: 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.
  
==== Content ====
+
::'''<big>Rivet's Usage</big>'''
 
+
[[File:RivetSettings.png|right|noframes|Settings for Rivet]]
::''We should address that now.''
+
::: 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.
::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 [[Page: blacklist|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.
+
:::: This can be set to always whisper in the extension popup settings.
 
+
 
==== Compatibility ====
+
::: 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.
:: Whenever FoundryVTT updates next - that doesn't always mean Plutonium will immediately be compatible.  
+
:::: 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.
 
 
:: 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.
 
  
 
<br/>
 
<br/>
Line 65: Line 46:
  
 
<br/>
 
<br/>
 +
::<div style="font-size:20px;font-weight: bold;">Regarding Content</div>
  
==Foundry Tools==
+
:: The tool ''can'' be used improperly, just like any other tool. Its content comes from the 5eTool's website store of information.  Like with the site 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 [[Page: blacklist|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.
  
===Plutonium===
+
::As a result of misuse by less mature/responsible persons; you will not find support for Plutonium outside of this wiki or the community discord. Some places will be very rude to you about it's mention.
:: (A FoundryVTT mod) which is in closed beta access. Some additional seats are availible, see [[Support the Project| '''Support''']] and the [{{5eTCommunitylink}} '''Community Discord'''] for more information
 
<br/>
 
  
===Rivet===
 
 
:: (a browser extension) Rivet is an extension that allows 5etools rolls and (some) data to be sent to Foundry.
 
 
::'''<big>Usage</big>'''
 
[[File:RivetSettings.png|right|noframes|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.
 
 
<br/>
 
 
If you are a developer, please see [[Support the Project|'''this page''']] if you wish to contribute time to a project.
 
  
 +
::Do yourself a favor, and others - use it responsibly. Don't post in public forums about it without identifying you are using it correctly, or .. better yet. Don't post about it at all on public forums. Don't be "that <guy/gal>". Just enjoy it, and if you're able to... [[Support the Project|Support it]]. If you cannot, the DO NOT make it harder to support it for others.
 
<br>
 
<br>
== 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.
+
{{FoundryConverionProcesslist}}
 +
----
  
====Self/Local host====
+
=About FoundryVTT=
:: You run the service from your home, school or office network on a workstation or device works on (confirmed)
+
: 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.
::* 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 ====
+
: 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.
:: 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)
 
  
 
<br>
 
<br>
:::* [https://cloud.google.com/ '''Google Cloud''']  
+
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'''].
::::: [https://cloud.google.com/free/docs/gcp-free-tier#always-free] (always free)
 
:::* [https://aws.amazon.com/?nc2=h_lg '''AWS''']  
 
::::: [https://aws.amazon.com/lightsail/pricing/ lightsail] 💸 (1 year free)
 
::::: [https://aws.amazon.com/ec2/pricing/ EC2] 💸💸
 
:::* [https://www.hostinger.com/ Hostinger] 💸
 
:::* [https://www.ovhcloud.com/en/vps/ OVH] 💸💸
 
:::* [https://upcloud.com/pricing/ Upcloud] 💸💸
 
:::* [https://www.a2hosting.com/ a2 Hosting] 💸💸
 
:::* [https://www.kamatera.com/express/compute/apps.php?tcampaign=35166_365223&bta=35166&nci=5444#app=node.js kamatera] 💸💸
 
:::* [https://www.digitalocean.com/pricing/ DigitalOcean] 💸💸💸
 
:::* [https://www.namecheap.com/hosting/vps/ Namecheap] 💸💸💸
 
:::* [https://www.webhostface.com/vps-hosting/ Webhostface] 💸💸💸
 
:::* [https://www.nodechef.com/nodejs-hosting nodechef] 💸💸💸💸
 
:::* [https://www.bluehost.com/hosting/vps Bluehost VPS service] 💸💸💸💸💸💸
 
:::* [https://www.liquidweb.com/partner-community/vps/ Liquidweb] 💸💸💸💸💸💸
 
<br>
 
  
== Foundry User Guides ==
+
Foundry has lots of native lexicon keywords; and abilities that its best you get familiarized with before getting into Plutonium. If you've not done that. Specifically if you've not used Foundry WITHOUT any modules, please do so - you're only cheating yourself (and making it harder on everyone else) by not learning the basics and thereafter having to back fill to get that FOUNDATIONAL knowledge of the system.
: [https://www.youtube.com/watch?v=kEQlhdF1568 How to Install Foundry]
 
: [https://www.youtube.com/watch?v=L-XMXlQzKkg&feature=youtu.be How to Create a Character in Foundry]
 
  
 
<br>
 
<br>
== Suggested Add on Modules / Project(s) ==
+
=== Foundry User Guides ===
:: There are a few services that commonly are used for 5e content and playing such, and that the community uses to in addition to, or in replacement of the Plutonium's features.
+
:* How to install Foundry [https://www.youtube.com/watch?v=kEQlhdF1568 VIDEO] [[ Wiki]]
 
+
:* [https://www.youtube.com/watch?v=L-XMXlQzKkg&feature=youtu.be How to Create a Character in Foundry]
{{FoundryModules_Plutonium}}
+
:* [[Foundry:Guide to Creating a character with Plutonium|'''🏗️How to make a character using Plutonium''']]
 
 
=== '''Roll20''' ===
 
::[https://www.patreon.com/kakaroto '''KaKaRaTo's'''] Offfers a suite of tools to nearly seamlessly move your Roll20 Content into Foundry. A truly exceptional effort.
 
::: [https://github.com/kakaroto/R20Exporter R20 Exporter] for [https://chrome.google.com/webstore/detail/r20exporter/apbhfinbjilbkljgcnjjagecnciphnoi/related Chrome]
 
::::: (outdated video '''here''' )
 
::: [https://www.patreon.com/kakaroto/posts?filters%5Btag%5D=R20Converter '''R20Converter''']; which takes those exports and creates a world or compendium file from such
 
<br>
 
:: Help converting R20 macros to Foundry VTT macros.
 
::: https://github.com/ASLopesJR/r20vttable
 
<br>
 
 
 
===Fantasy Grounds===
 
:: [https://www.patreon.com/foundry_grape_juice/posts?filters%5Btag%5D=FG%20Converter | '''Grape Juice's'''] converter for turning 5e and soon Pathfinder2e modules from FG -> FoundryVTT. Aims to be the pathway for FG users to take their Characters and convert them to Foundry compatible sheets;
 
::: With full world/adventures in open beta.  Definitely worth a try
 
 
 
 
<br>
 
<br>
=== DnD Beyond ===
 
:: [https://www.patreon.com/join/vttassets '''VTTassets'''] pulls your monsters/characters/even modules ''AND THEIR MAPS''.  Its stunning work - hefty labor of love. Allowing you to buy digitally on DnD Beyond and have that portable to Foundry as you increase your WoTC digital portfolio.
 
::: [https://www.vttassets.com/assets/vtta-dndbeyond DnDBeyond]
 
  
::[https://www.patreon.com/kakaroto '''KaKaRaTo's'''] moves your DnDBeyond rolls and some content into Foundry
+
----
::: Beyond20 for [https://chrome.google.com/webstore/detail/beyond-20/gnblbpbepfbfmoobegdogkglpbhcjofh Chrome]
+
::<div style="font-size:20px;font-weight: bold;">A disclaimer</div>
:::: 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. Proactive heads up. See the FAQ for more information.''
+
::: 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 [https://foundryvtt.com/article/license/ '''FOUNDRY Virtual Tabletop EULA'''] or Terms of Service with your Virtual hosting service. Plutonium, 5etools, Giddy, and the Norr Group are not affiliated with Foundry Gaming, LLC, and are developed independently from such.

Latest revision as of 10:45, 22 April 2021

framless
v1.29.2

Where to start

You're likely here because you've found the 5etools site, love it, worked with Roll20, wanted to do "x" with Roll20 and learned that Foundry can do "x", or were looking for a better experience with online gaming and 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 the name 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 for specifics...

How to use it?




FoundryVTT allows for building apps within the platform through their public and well documented APIs. 5eTools has currently two tools that work with and within FoundryVTT;
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 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.
Rivet's 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.


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.


Regarding Content
The tool can be used improperly, just like any other tool. Its content comes from the 5eTool's website store of information. Like with the site 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.
As a result of misuse by less mature/responsible persons; you will not find support for Plutonium outside of this wiki or the community discord. Some places will be very rude to you about it's mention.


Do yourself a favor, and others - use it responsibly. Don't post in public forums about it without identifying you are using it correctly, or .. better yet. Don't post about it at all on public forums. Don't be "that <guy/gal>". Just enjoy it, and if you're able to... Support it. If you cannot, the DO NOT make it harder to support it for others.



Where are you bringing content from?

or

About 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.


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

Foundry has lots of native lexicon keywords; and abilities that its best you get familiarized with before getting into Plutonium. If you've not done that. Specifically if you've not used Foundry WITHOUT any modules, please do so - you're only cheating yourself (and making it harder on everyone else) by not learning the basics and thereafter having to back fill to get that FOUNDATIONAL knowledge of the system.


Foundry User Guides



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, Giddy, and the Norr Group are not affiliated with Foundry Gaming, LLC, and are developed independently from such.