Skip to content

Installing the Module

Installing the Module

To use Material Plane, you must install the module. There are several ways to do this:

Built-In Module Browser
The easiest way to install modules is using the built-in module browser.

  1. Start Foundry VTT and make sure you're in the 'Setup' screen
  2. Navigate to the 'Add-on Modules' tab

  3. Press the 'Install Module' button

    Screenshot

  4. Search for 'Material Plane' in the search bar at the top

  5. Press the 'Install' button

    Screenshot

Manifest URL
You can use the module's manifest URL to install the module. The main reason for this is to install a specific version of the module.

You can find the manifest URL for all available versions here.
Choose the version you want, and right-click 'Manifest URL' to copy the URL.

Alternatively, you could use this manifest URL which always points to the latest release:
https://github.com/MaterialFoundry/MaterialPlane_Foundry/releases/latest/download/module.json

  1. Start Foundry VTT and make sure you're in the 'Setup' screen
  2. Navigate to the 'Add-on Modules' tab

  3. Press the 'Install Module' button

    Screenshot

  4. At the bottom you can find the 'Manifest URL' field, copy the manifest URL into this field and press 'Install'

    Screenshot

Manual
The last option is a manual installation

  1. Download the 'module.zip' file from GitHub
  2. Extract this file into the 'User Data Path' of your Foundry installation
  3. (Re)start Foundry VTT

Enabling the Module

After installing the module, it must be enabled for each world in which you want to use the module:

  1. Start Foundry VTT and the world you want to use it in
  2. Open the 'Game Settings' sidebar tab (on the right of the screen, cogs icon)

  3. Select 'Manage Modules'

    Screenshot

  4. Search for 'Material Plane' and tick the box to the left of it

    Screenshot

  5. Press 'Save Module Settings'

Updating the Module

Modules in Foundry do not automatically update. You will have to check regularly if an update is available.
Within Foundry you can either update all modules, or a single module:

  1. Start Foundry VTT and make sure you're in the 'Setup' screen
  2. Navigate to the 'Add-on Modules' tab

  3. Either:

    • Click 'Update All' to update all modules

    Screenshot

    • Click the update button for the module you want to update

    Screenshot

Uninstalling the Module

To uninstall the module:

  1. Start Foundry VTT and make sure you're in the 'Setup' screen
  2. Navigate to the 'Add-on Modules' tab

  3. Right-click the 'Material Plane' icon and click 'Uninstall'

    Screenshot