FoundryTool Install

From 5etools Community Wiki
Revision as of 03:58, 25 March 2021 by Modnar (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

framless
v1.24.1

There are two separate tools for Foundry;

Plutonium - which is a native module for FoundryVTT that operates within foundry to enable its features. (for more information see Plutonium Features) and
Rivet, which is a browser extension that connects the browser with the 5eTools website to pass through certain actions and requests allow you to integrated 5eTools site functionality into your Plutonium session. (for more information see Rivet Features)


Its important to remind you, dear reader, that support for Plutonium is NOT provided by other groups, and you'll likely get reprimanded for asking for such. Likewise, its requested that you don't post about it publicly or on other locations; it is a public tool, but its hard enough to support those that are picking it... so please if you want the project to grow and continue as a publicly available tool - don't make supporting it burdensome, use it correctly, and only tell those you believe are capable of reading directions and following them.
TL;DR - Fight Club rules (and don't share with people YOU wouldn't want to personally answer their questions.)


You have Foundry, and now need to to either host it yourself, or on a virtual hosting service.
You may wish to have it on a hosting service if you want to provide constant access to the server, you travel, your own computer/ISP is slow, or because it would often ensure a higher quality of service (and let you use that domainname you've always wanted) (search for Dynamic DNS (DDNS) for free/Vanity Domains you use use for self hosting)
FOUNDRY Installation Guides (for Foundry and Supported Environments)

Installing Foundry

Installing a PRIOR version of Foundry

You can obtain previous versions of Foundry by using the following URL;
https://foundryvtt.com/releases/download?version=version&platform=platform.

if you wanted a windows version for 0.6.6 

https://foundryvtt.com/releases/download?version=0.6.6&platform=windows.


Hosting Foundy

An excellent article exists on this topic here


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 💸💸



A Video Overview/Guide
FoundryVTT's installation Guide
ADDITIONAL ADVICE:
If working from windows, you'll want to get properties for the short cut, go to the compatibility tab and mark Foundry as "Run as Administrator"
Run as Administrator.png
EXPANDED Installation Guides

Supported Services 

Create an AWS Account   
go to amazon lightsail
Create an instance
Choose the node.js instance
click create instance
let it finish initializing
may require a refresh
click on the new instance
go to networking 
add rule
under port or range type 30000
installing foundry
download and install FileZilla
download the foundry .zip for node.js
go to your account page on Lightsail
download your ssh key (a .pem file)

open FileZilla
file > site manager
new site
change protocol to SFTP
in the host field copy and paste your Lightsail Public IP
change login type to key file
put in your username (likely, bitnami)
browse for the .pem file (note that in file browser it will likely default to PPK, change this to PEM or the file won't show up)
click connect
you should see the file directory for your server in the right window of Filezilla
on your personal computer, unzip the Foundry zip that you downloaded from your account page
drag and drop the now unzipped Foundry folder into the bitnami (or whatever your username is) folder in FileZilla
create a new folder in the bitnami folder called foundrydata
go back to Amazon Lightsail
sudo npm install pm2 -g
node ~/foundry/resources/app/main.js --dataPath=/home/bitnami/foundrydata
pm2 start ~/foundry/resources/app/main.js --name "foundry"

http://255.255.255.255:30000
replace the 255.255.255.255 with your Public IP from the AWS Lightsail page
  • For Windows
  • For Node.js (Mac)
  • For Unix
  • Upcloud


  • On Forge / FoundryServer - None. These services are pre-configured and do not require you to install them, likewise, they're maintained and will be updated as needed.
  • On DreamHost

=== On a Mobile device

Mobile Install



Installation Guides for Foundry Tools

Installing Plutonium

There are THREE main steps in a traditional installation:
  • Manifest URL (in which you provide Foundry the Manifest URL and it in turn download and places the files in the directory already configured)
  • Modifying Core (in which you add a new library and register it in the main.js) (for Art & Media Repo & World/Package installs (in core 0.8.x))
  • Confirm installation by Activating the module within each world you wish to use it within.
Please note: Plutonium is only to be used with a STABLE Foundry VTT release candidate. Not with Alpha or Beta releases.



Alternatively, (at the bottom of the page)
  • Docker
  • TheForge


Manifest URL

Click to View Video Walkthrough
Go to Get.5e.Tools,
Choose the FoundryVTT
Click to Copy the Manifest URL provided
 https://get.5e.tools/plutonium/module.json
Go to the FoundryVTT app, to the Add-on Modules section.
Choose the Install Module and paste https://get.5e.tools/plutonium/module.json into the Manifest URL: field.
PlutoniumManifestURL.png
Click Install.
Modify the Server backend.
Click here to find out how; or click expand below to remain on this page.



How to Modify the Backend

If you are NOT using Forge, or FoundryServer for your hosting platform, this unlocks additional feature(s).
If you are on theForge or FoundryServer this will not currently work for you, and you will likely want to disable backend detection

please note there is a script listed at the end of this portion which can do all this for you

Add Backend library;
Copy the plutonium-backend.js file from FoundryVTT\Data\modules\plutonium\server directory of your installed Plutonium Module to:
FOR Windows ▸
  • If you installed "for current user only" on Windows: %appdata%\..\Local\Programs\FoundryVTT\resources\app
  • If you installed "for all users" on Windows: Program Files\FoundryVTT\resources\app
FOR UNIX ▸
  • Look for one of the following directories (different flavors and systems may install to a different)
/home/$USER/.local/share/FoundryVTT/resources/app
/home/$USER/FoundryVTT/resources/app
/local/FoundryVTT/resources/app
MacOS.png
FOR MacOS ▸
\Applications ▸ click Show Package Contents > Resources > app > main.js
or you can open a terminal and do a
find / -name main.js


In Windows:Right Mouse Click on App
Modify FoundryVTT's main.js
Locate the main.js file in your installation
IN Windows ▸
Right Mouse click on the App in the taskbar and choose Browse Application Data and navigate to
%appdata%/../Local/Programs/FoundryVTT/resources/app/main.js
IN UNIX ▸
IN MacOS/OSX ▸
Go to the following directory
\Applications ▸ click Show Package Contents > Resources > app > main.js


Open the main.js as an adminstrator and locate the following line


for FoundryVTT core 0.7.3 or greater
require("init")(process.argv, global.paths, startupMessages);
changing it to...
require("init")(process.argv, global.paths, startupMessages)
	.then(() => {
		require("plutonium-backend.js").init();
	});
for FoundryVTT core 0.6.6 or less
require("init")(process.argv, global.paths, initLogging);
changing it to...
require("init")(process.argv, global.paths, initLogging)
	.then(() => {
		require("plutonium-backend.js").init();
	});


RESTART FOUNDRY SERVER
- The server MUST restart to load in the new library for the new backend.


⚠️ (These are Community Created) ⚠️

User Instructions for the script

SCRIPT
OR, if you are self hosting you may use the batch/bash script (again, run in adminstrative mode/sudo) found here
  • IN Windows ▸ you would use updateMain.bat
  • IN Unix/MacOS ▸ you would use updateMain.bash
(Several Hosted Environments CANNOT make use of this script)


ScienceIcon.png


Manual Install of Plutonium

For and overview of the process see How to install modules manually on the foundryVTT wiki for more information)

Windows:Right Mouse Click on App
Download the .zip for the Plutonium module; (located here)
FOR PC ▸ extract files to your C:\Users\<You>\Appdata\Local\FoundryVTT\Data\modules\plutonium directory.*
Paste this into the Explorer address bar %localappdata%/FoundryVTT to open into the directory quickly.
Or right mouse click on the Foundry App's icon on the taskbar and choose Browse User Data and extract there
FOR UNIX ▸ extract files to your $foundryDATAdir/Data/modules/*
FOR MacOS ▸ extract files in ⁨ Users ▸ User⁨name ▸ ⁨Library ▸ ⁨Application Support⁩ ▸FoundryVTT⁩ ▸ ⁨Data⁩ ▸ ⁨modules⁩*
Confirm that the directory is named ...Data\modules\plutonium⁩ and not ...Data\modules\Plutonium⁩ (it is case sensitive) and isn't nested under a subdirectory.
Restart the FoundryVTT server
Log back into Foundry VTT as the GameMaster
Click the Configuration/Settings button
Click Manage Modules under the game system heading (eg. D&D 5th Edition).
Find the newly installed module and place a checkmark next to 5eTools module Plutonium, then click Update Modules at the bottom of the list to activate it.

* Please make sure when extracting that the code resides in C:\Users\<You>\Appdata\Local\FoundryVTT\Data\modules\plutonium directory - and not C:\Users\<You>\Appdata\Local\FoundryVTT\Data\modules\Plutonium\plutonium directory. (ie extract the zip's contents into the C:\Users\<You>\Appdata\Local\FoundryVTT\Data\modules directory).

Modify the Server backend. Click here to find out how; or see above to remain on this page.


Upgrading Plutonium

If using the manifest URL you need only update the module like any other, then open the Readme.MD and confirm there isn't a change in the backend components or modification needed for the main.js script.


Manual Updating

Navigate to the directory for the module (see above)
Delete the plutonium directory
Install Plutonium as indicated above.



DOCKER INSTALL

If you are familiar with and using Docker - here is the community member's Plutonium build
https://github.com/Cottonbug/foundryvtt-docker/tree/plutonium_support


Most popular Docker images do NOT not have the backend modified as part of the image.
However a clever member built this to make one of the most popular docker images functional with Plutonium's features.

TheForge / FoundryServer / Molten

Manifest URL installation may not work.
Cannot Install.png
This was addressed in part in the User Guide - but, to briefly restate. If you are using Plutonium, you need to verify that you're using it correctly and legally for your local laws. Regretfully; several users did not, and that in turn blacklisted the app. You can still manually install it, but it will no longer be able to update through the normal methodology. You'll have to reinstall manually with each update.


See, this tutorial/video on How to install on The Forge manually through their interface.
Then proceed with Manual installation. You will not be able to modify the backend; you will not have World/Module/Package importing options and Art Browser will not work for you.


For how to put your files onto hosted services Watch this video, while it is geared to FoundryServer the process is similar for most other hosting companies.



noframe

How to Install Rivet

Follow the links below depending upon the browser



If that does not work, you may wish to do a manual installation.


Manual Installation

Go to get.5e.tools and grab the zip file for for Rivet.
For Chrome
  • Open the Extension Management page by navigating to chrome://extensions.
The Extension Management page can also be opened by clicking on the Chrome menu, hovering over More Tools then selecting Extensions.
  • Enable Developer Mode by clicking the toggle switch next to Developer mode.
  • Click the LOAD UNPACKED button and select the extension directory.


For Firefox
  • Enter about:debugging in the URL bar
  • Click This Firefox on the left
  • Click Load Temporary Add-On... and select manifest.json.
Retrieved from "https://wiki.5e.tools/index.php?title=FoundryTool_Install&oldid=8673"