Difference between revisions of "FoundryTool Install"

From 5etools Community Wiki
Jump to: navigation, search
m (For Firefox)
m
Line 4: Line 4:
 
There are two separate tools for Foundry;  
 
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)
+
: '''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)
 +
 
 +
:: A slight departure from the rest of the wiki. What follows will be a set of links which when expanded will provide links to common Foundry installation tutorials or Guides and locations for support for such.  Its important to remind you, dear reader, that support for Plutonium is NOT provided by other groups, and its requested that you don't post about it; rather if someone needs support or you wish to share the site/module - please avoid doing so in public forums; Social Media; or your streams. 
 +
 
 +
 
 +
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;>
 +
<div style="font-weight:bold;line-height:1.6;">Installation Guides for Foundry and Supported Environments</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
:: [https://www.youtube.com/watch?v=kEQlhdF1568&list=PLGgCMB0gYnLFWxyrCkUYwHY4vvA_yME7m A Video Overview/Guide]
 +
:: [https://foundryvtt.com/article/installation/ FoundryVTT installation Guide]
 +
:: EXPANDED Installation Guides
 +
::* For Windows
 +
::* For Node.js (Mac)
 +
::* For Unix
 +
::* On AWS (Lightsail)  (Free for one year)
 +
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
 +
 
 +
</div></div>
 +
::* On Forge / FoundryServer - None. This services are preconfigured and do not require you to install them, likewise they're maintained and will be updated as needed.
 +
:::::
 +
::* On
 +
 
 +
 
 +
<br/>
 +
<br/>
 +
Supported Services
 +
 
 +
* [https://aws.amazon.com/?nc2=h_lg '''AWS'''] (FREE -[https://aws.amazon.com/lightsail/pricing/ lightsail] / Paid [https://aws.amazon.com/ec2/pricing/ EC2] )
 +
* [https://cloud.google.com/ '''Google Cloud'''] ( FREE [https://cloud.google.com/free/docs/gcp-free-tier
 +
* Docker
 +
* Upcloud
 +
*
  
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)
 
  
 
<br/>
 
<br/>

Revision as of 04:31, 25 May 2020

framless
v1.22.0

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)
A slight departure from the rest of the wiki. What follows will be a set of links which when expanded will provide links to common Foundry installation tutorials or Guides and locations for support for such. Its important to remind you, dear reader, that support for Plutonium is NOT provided by other groups, and its requested that you don't post about it; rather if someone needs support or you wish to share the site/module - please avoid doing so in public forums; Social Media; or your streams.



Installation Guides for Foundry and Supported Environments
A Video Overview/Guide
FoundryVTT installation Guide
EXPANDED Installation Guides
  • For Windows
  • For Node.js (Mac)
  • For Unix
  • On AWS (Lightsail) (Free for one year)
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 
  • On Forge / FoundryServer - None. This services are preconfigured and do not require you to install them, likewise they're maintained and will be updated as needed.
  • On




Supported Services



Installing Plutonium

Plutonium currently does not support installation via Manifest URL, so the installation will be done manually ( see How to install modules manually on the foundryVTT wiki for more information)

*When the Manifest installation option is available this section will be further developed.*
Copy the Manifest URL provided into the Module Installation field for the
For Plutonium 0.14.1+
For Plutonium 0.14.1 or later, and if you're NOT using Forge. To make full use of the Art Browser you need to do some modification of the server.
  • If it exists; Copy the plutonium-backend.js file from server/ to:
FOR PC ▸
  • 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 different a directory)
/home/$USER/.local/share/FoundryVTT/resources/app
/home/$USER/FoundryVTT/resources/app
/local/FoundryVTT/resources/app
FOR MacOS ▸ ~/Library/Application Support/FoundryVTT
  • Pray that nothing explodes
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.
FOR UNIX ▸ extract files to your $foundryDATAdir/Data/modules/*
FOR MacOS ▸ extract files in ⁨Users ▸ User⁨name ▸ ⁨Library ▸ ⁨Application Support⁩ ▸FoundryVTT⁩ ▸ ⁨Data⁩ ▸ ⁨modules⁩*



    • IF the main.js is not present in your Plutonium unzip...**
You will need to manually apply the modification to the final line of %appdata%/../Local/Programs/FoundryVTT/resources/app/main.js changing from:
require("init")(process.argv, global.paths, initLogging);
to
require("init")(process.argv, global.paths, initLogging)
	.then(() => {
		const {json: jsonBodyParser} = require("express");
		const {Plutonium} = require("plutonium-backend");
		const router = global.express.app._router;
		const ixJsonParser = router.stack.findIndex(it => it.name === "jsonParser");
		// Replace the original JSON body parser with our version
		global.express.app.use(jsonBodyParser({limit: "5mb"}));
		router.stack[ixJsonParser] = router.stack.pop();
		router.post("/api/plutonium", Plutonium.post.bind(Plutonium));
	});

Manual Install of Plutonium

Plutonium currently does not support installation via Manifest URL, so the installation will be done manually ( see How to install modules manually on the foundryVTT wiki for more information)

FoundryManagemodules.png
Download the .zip for the Plutonium module from the link provided to you;
Did you not get that link? Do you want one? Support the Project.
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.
FOR UNIX ▸ extract files to your $foundryDATAdir/Data/modules/*
FOR MacOS ▸ extract files in ⁨Users ▸ User⁨name ▸ ⁨Library ▸ ⁨Application Support⁩ ▸FoundryVTT⁩ ▸ ⁨Data⁩ ▸ ⁨modules⁩*
Restart the FoundryVTT server
Log back into Foundry VTT as the GameMaster
Click the Help button
Click Manage Modules under the game system heading (eg. D&D 5th Edition) See image to the right.
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).

For Plutonium 0.14.1+
For Plutonium 0.14.1 or later, and if you're NOT using Forge. To make full use of the Art Browser you need to do some modification of the server.
  • If it exists; Copy the plutonium-backend.js file from server/ to:
FOR PC ▸
  • 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 different a directory)
/home/$USER/.local/share/FoundryVTT/resources/app
/home/$USER/FoundryVTT/resources/app
/local/FoundryVTT/resources/app
FOR MacOS ▸ ~/Library/Application Support/FoundryVTT
  • Pray that nothing explodes
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.
FOR UNIX ▸ extract files to your $foundryDATAdir/Data/modules/*
FOR MacOS ▸ extract files in ⁨Users ▸ User⁨name ▸ ⁨Library ▸ ⁨Application Support⁩ ▸FoundryVTT⁩ ▸ ⁨Data⁩ ▸ ⁨modules⁩*



    • IF the main.js is not present in your Plutonium unzip...**
You will need to manually apply the modification to the final line of %appdata%/../Local/Programs/FoundryVTT/resources/app/main.js changing from:
require("init")(process.argv, global.paths, initLogging);
to
require("init")(process.argv, global.paths, initLogging)
	.then(() => {
		const {json: jsonBodyParser} = require("express");
		const {Plutonium} = require("plutonium-backend");
		const router = global.express.app._router;
		const ixJsonParser = router.stack.findIndex(it => it.name === "jsonParser");
		// Replace the original JSON body parser with our version
		global.express.app.use(jsonBodyParser({limit: "5mb"}));
		router.stack[ixJsonParser] = router.stack.pop();
		router.post("/api/plutonium", Plutonium.post.bind(Plutonium));
	});

Upgrading Plutonium

If using the Manifest.json you need only update the module like any other, then open the Readme. 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.
Remove the plutonium directory
Install as indicated above.


Installation of Rivet

Uncompress the source file into a directory of your choice and note the location.

For Chrome (like)

  • 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

In Firefox, go to Firefox's store for Rivet


MANUAL INSTALL
  • Enter about:debugging in the URL bar
  • Click This Firefox on the left
  • Click Load Temporary Add-On... and select manifest.json.