Difference between revisions of "FoundryTool Install"

From 5etools Community Wiki
Jump to: navigation, search
m
(5 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
<br/>
 
<br/>
  
==Manual Install of Plutonium==
+
==Installing Plutonium==
 +
Plutonium currently does not support installation via Manifest URL, so the installation will be done manually ( see [https://foundry-vtt-community.github.io/wiki/Modules/#installing-modules| 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
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;>
 +
<div style="font-weight:bold;line-height:1.6;">For Plutonium 0.14.1+</div>
 +
<div class="mw-collapsible-content">
 +
 
 +
: For Plutonium 0.14.1 or later, and if you're NOT using Forge. To make full use of the [[Plutonium: Art Browser|Art Browser]] you need to do some modification of the server.
 +
 
 +
:* If it exists; Copy the <code>plutonium-backend.js</code> file from <code>server/</code> to:
 +
:: FOR PC ▸
 +
:::*  If you installed "for current user only" on Windows: <code>%appdata%/../Local/Programs/FoundryVTT/resources/app</code>
 +
:::*  If you installed "for all users" on Windows: <code>Program Files/FoundryVTT/resources/app</code>
 +
:: 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 ▸ <code>~/Library/Application Support/FoundryVTT</code>
 +
:* Pray that nothing explodes
 +
 
 +
extract files to your <code>C:\Users\<You>\Appdata\Local\FoundryVTT\Data\modules\plutonium</code> directory.*
 +
::: Paste this into the Explorer address bar  <code>%localappdata%/FoundryVTT</code> to open into the directory quickly.
 +
: FOR UNIX ▸ extract files to your  <code>$foundryDATAdir/Data/modules/</code>*
 +
: FOR MacOS ▸ extract files in <code>⁨Users ▸ User⁨name ▸ ⁨Library ▸ ⁨Application Support⁩ ▸FoundryVTT⁩ ▸ ⁨Data⁩ ▸ ⁨modules⁩</code>*
 +
 
 +
 
 +
<br/>
 +
 
 +
**IF the main.js is not present in your Plutonium unzip...**
 +
 
 +
: You will need to manually apply the modification to the final line of <code>%appdata%/../Local/Programs/FoundryVTT/resources/app/main.js</code> 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));
 +
});
 +
 
 +
</div></div>
 +
 
 +
===Manual Install of Plutonium===
 
Plutonium currently does not support installation via Manifest URL, so the installation will be done manually ( see [https://foundry-vtt-community.github.io/wiki/Modules/#installing-modules| How to install modules manually] on the foundryVTT wiki for more information)
 
Plutonium currently does not support installation via Manifest URL, so the installation will be done manually ( see [https://foundry-vtt-community.github.io/wiki/Modules/#installing-modules| How to install modules manually] on the foundryVTT wiki for more information)
  
Line 36: Line 91:
 
: For Plutonium 0.14.1 or later, and if you're NOT using Forge. To make full use of the [[Plutonium: Art Browser|Art Browser]] you need to do some modification of the server.
 
: For Plutonium 0.14.1 or later, and if you're NOT using Forge. To make full use of the [[Plutonium: Art Browser|Art Browser]] you need to do some modification of the server.
  
:* Copy the <code>plutonium-backend.js</code> file from <code>server/</code> to:
+
:* If it exists; Copy the <code>plutonium-backend.js</code> file from <code>server/</code> to:
 
:: FOR PC ▸
 
:: FOR PC ▸
 
:::*  If you installed "for current user only" on Windows: <code>%appdata%/../Local/Programs/FoundryVTT/resources/app</code>
 
:::*  If you installed "for current user only" on Windows: <code>%appdata%/../Local/Programs/FoundryVTT/resources/app</code>
 
:::*  If you installed "for all users" on Windows: <code>Program Files/FoundryVTT/resources/app</code>
 
:::*  If you installed "for all users" on Windows: <code>Program Files/FoundryVTT/resources/app</code>
 
:: FOR UNIX ▸  
 
:: FOR UNIX ▸  
  /home/$USER/.local/share/FoundryVTT
+
:::* Look for one of the following directories (different flavors and systems may install to different a directory)
  /home/$USER/FoundryVTT
+
  /home/$USER/.local/share/FoundryVTT/resources/app
  /local/FoundryVTT
+
  /home/$USER/FoundryVTT/resources/app
 +
  /local/FoundryVTT/resources/app
 
::  
 
::  
 
:: FOR MacOS ▸ <code>~/Library/Application Support/FoundryVTT</code>
 
:: FOR MacOS ▸ <code>~/Library/Application Support/FoundryVTT</code>
Line 56: Line 112:
 
<br/>
 
<br/>
  
:Finally, modify the final line of <code>%appdata%/../Local/Programs/FoundryVTT/resources/app/main.js</code> from:
+
**IF the main.js is not present in your Plutonium unzip...**
 +
 
 +
: You will need to manually apply the modification to the final line of <code>%appdata%/../Local/Programs/FoundryVTT/resources/app/main.js</code> changing from:
  
 
  require("init")(process.argv, global.paths, initLogging);
 
  require("init")(process.argv, global.paths, initLogging);
Line 75: Line 133:
  
 
</div></div>
 
</div></div>
 +
 +
===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 ==
 
== Installation of Rivet ==

Revision as of 03:33, 23 May 2020

framless
v1.3.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)


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

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