FoundryTool Install
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)
Contents
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)
- 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.
- Paste this into the Explorer address bar
- FOR UNIX ▸ extract files to your
$foundryDATAdir/Data/modules/
* - FOR MacOS ▸ extract files in
Users ▸ Username ▸ 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 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.
- Copy the
plutonium-backend.js
file fromserver/
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
- If you installed "for current user only" on Windows:
- FOR UNIX ▸
- Copy the
/home/$USER/.local/share/FoundryVTT /home/$USER/FoundryVTT /local/FoundryVTT
- FOR MacOS ▸
~/Library/Application Support/FoundryVTT
- Pray that nothing explodes
- FOR MacOS ▸
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.
- Paste this into the Explorer address bar
- FOR UNIX ▸ extract files to your
$foundryDATAdir/Data/modules/
* - FOR MacOS ▸ extract files in
Users ▸ Username ▸ Library ▸ Application Support ▸FoundryVTT ▸ Data ▸ modules
*
- Finally, modify the final line of
%appdata%/../Local/Programs/FoundryVTT/resources/app/main.js
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)); });
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.
- Open the Extension Management page by navigating to
For Firefox
- Enter
about:debugging
in the URL bar - Click This Firefox on the left
- Click Load Temporary Add-On... and select
manifest.json
.
- Enter