Module Setup - MaterialFoundry/MaterialDeck GitHub Wiki

This documentation is for the old, deprecated Material Deck v1. The new documentation for v2+ can be found here.

You can enter the module setup in Foundry by pressing 'Game Settings' (cogs icon) in the sidebar on the right, and then pressing 'Configure Settings'. This will open the 'Configure Game Settings' screen, where you have to press the 'Module Settings' at the top. Then go to the Material Deck section. At the top you will find 6 buttons:

The 'Help' button opens a window with basic instructions. 'Playlist Configuration', Macro Configuration and 'Soundboard Configuration' are discussed on the pages for the relevant actions, click the links above to access those pages. Using the 'User Permission Configuration', the GM can configure what Material Deck functions users have access to. Each action has various settings, and these settings can be set for each user role. Below that, you will find the following settings:

  • Enable Module for this Client: Ticking this box enabled the module for the client
  • System Override: Overrides the automatic game system detection. Unsupported systems default to dnd5e, but a different system can be selected in case it is more similar to your gaming system
  • Material Companion Address: Fill in the address of Material Companion (usually if you run it on the same computer as you're using for Foundry, this can be localhost:3001). This is not necessarily the IP address of Foundry! It is the IP address of the computer that's running Material Companion. The default value will work for 99% of people, only change it if you know what you're doing. More info on Material Companion can be found here
  • Image Cache Size: Sets the amount of images to store in the image cache. The image cache will locally store all images sent to the Stream Deck. This improves the update speed, but increases memory usage.
  • Image Brightness: Sets the brightness of the default white images for better readibility of the text. If Image Cache Size is large, it'll take a while for the new brightness setting to be applied. A refresh will give instantaneous results.
  • Number of Connection Attempts: Sets the number of times Material Deck will attempt to connect to Material Companion. Will be unlimited if set to 0.

Material Companion Address

Finding the correct Material Companion address can be a bit confusing. The important thing is that you distinguish between the Foundry server and your Foundry client. When you use Foundry, there is a single server, and multiple clients (one for each player). The client is usually a web browser, but this can also be the Foundry app if you use that to access the game. For setting the address, the location of the Foundry server does not matter. It can be on your pc, on the Forge, or anywhere you want.Material Deck and Companion only care about the client. For most people, the Foundry client (either a browser or the Foundry application), the Stream Deck and Material Companion are on the same computer. In this case, you can (usually) set the address to 'localhost:3001'. Only if you have the Stream Deck and Material Companion on a different computer, do you need to change the address to something else. In this case you can refer to the 'Alternative Material Companion Address' in the 'Overview' tab in Material Companion and fill in that address as the Material Companion Address. While this setup is not recommended, it can work if you really want it. Even if you think you need to set the address to anything different than 'localhost:3001', I suggest you first give 'localhost:3001' a try. If the address is 'localhost:3001', the Foundry server can be either secure or insecure. If the address is different (because Material Companion and the Stream Deck are on a different computer), you will have issues if the Foundry server is secure. If, for some reason, you still have issues with a secured Foundry server, you could try the following (you will need to have Material Companion and the Stream Deck on the same computer as your Foundry client): *Chrome: Navigate to chrome://flags/#allow-insecure-localhost, and enable it *Firefox: Navitage to about:config, search for network.websocket.allowInsecureFromHTTPS and set it to true More info on Material Companion can be found here