Module Settings

The module settings can be accessed in Foundry by pressing the 'Game Settings' (cogs icon) in the sidebar on the right, and then pressing 'Configure Settings'. This will open the 'Configure Game Settings' menu, where you have to select 'Material Deck' in the left column.
At the top you will find 5 buttons:
- Documentation: Pressing this button will lead you to this documentation.
- Download Utility: Opens the Download Utility.
- Device Manager: Opens the Device Manager.
- Permission Config: Opens the Permission Config.
- Soundboard: Opens the Soundboard.
- Custom Action Config: Opens the Custom Action Config.
Below that, you will find the following settings:
- Enable Module for this Client
- Hold Time
- Stream Deck Port
- Maximum Connection Attempts
- Image Cache Size
Enable Module for this Client
Each user can decide for themselves if they want to enable Material Deck (assuming the GM has allowed this in the Permission Config).
Unticking this setting will prevent the module from trying to connect to a Stream Deck.
Any sounds played through the Audio Action will still be played for users that have this setting disabled.
Hold Time
Some actions will provide 'hold' functionality. This setting sets the default hold time (the time in milleseconds that you have to hold a button for it to register as a 'hold').
Please note that system modules and Custom Actions can define their own hold time.
Stream Deck Port
Material Deck needs to know on what port to connect to the Stream Deck. By default this is set to 3005
, but this can be changed if desired (for example, if another application uses that port). Most people will not need to change this.
If you change the port here, you will also need to change the port in the Stream Deck application.
This can be done by selecting any Material Deck action, pressing the 'Global Plugin Settings' at the bottom, and changing the port there to the same value.
Maximum Connection Attempts
Material Deck will attempt to connect to the Stream Deck whenever Foundry is refreshed or the connection to the Stream Deck is lost.
It will attempt to create a connection as many times as configured here. So if set to 5, Material Deck will attempt to connect 5 times, after which it stops. You will then have to refresh Foundry to retry the connection.
Setting this to 0 will cause Material Deck to keep trying to connect indefinitely.
Image Cache Size
Material Deck often has to generate and send a lot of images to the Stream Deck, which can be time consuming. To improve performance, an image cache is implemented which stores images in the Stream Deck app. This means that if an image has to be sent that has already been sent previously (maybe because you switched between two folders), Material Deck no longer has to generate and then send that image, instead it tells the Stream Deck app to display an image from the cache.
The image cache size is the amount of images to store. A higher value will improve performance (for a longer time), but it increases memory (RAM) usage.