Frequently Asked Questions

What Stream Deck variants are supported?

All of them, including the mobile version!

What game systems are supported?

Currently the following systems are supported:

Dungeons & Dragons 5e
Dungeons & Dragons 3.5e
Pathfinder 1e
Pathfinder 2e
Shadow of the Demon Lord

My game system is currently not supported, can I still use Material Deck?

Yes, you can!
Most functions are system agnostic, with the exception of some Token Actions and Combat Tracker Actions, where the system is required to display token stats and to set conditions.
If your system isn't supported, it'll assume DnD5e. You can manually set up the stats using the [custom stats] function, and there's a chance that your systems uses the same conditions as DnD5e.

Could you add support for [game system]?

Sure! Please contact me or open an issue.

Could you add support for [module]?

That depends on the module and what you want Material Deck to do. Please contact me or open an issue.

Can players use Material Deck?

Yes they can. They'll need to have a Stream Deck connected to their computer, and have Material Server running on that computer. The GM has a user permission configuration where he/she can determine what players can and cannot do.

Does Material Deck work on Windows/OSX/Linus?

Windows

There are no reported issues with Windows 10

OSX

Some users have reported issues. This might solve your issue, otherwise, please contact me or open an issue.

Linux

Elgato hasn't released an official Stream Deck application for Linux, however there is streamdeck_ui. There is at least one user who has succesfully used that.

Could you add support for StreamPi or Touch Portal?

There are currently no plans for either, but this might change in the future.

Does Material Deck work with hosting services such as the Forge?

Yes it does! Please see below for information on connecting to secured servers.

My server is secure (using SSL), will Material Deck work?

It will work, but there are a few caveats:
-Material Server will need to run on your local machine (so on the computer you're using Foundry on)
-You must set 'Material Server Address' in the module settings to 'localhost:3001'.

A secure version of Material Server is planned.

How do I know if my server is secure?

If you're self-hosting, the Foundry server is not secure by default. If it is hosted remotely it is.
To check:
Access Foundry from a browser. For most (or all) browsers: On the left of the address bar you'll either see a closed lock (server is secure), a lock with a red line through it (server is not secure), or the text 'not secure' (server is not secure).
Alternatively, look at the url (invitation link). If it starts with 'http://' it is not secure, if it starts with 'https://' it is secure.

I've installed the module, server and Stream Deck plugin, why doesn't it do anything?

Is Material Server running?
Is the Stream Deck application running?
Did you either create or install a Stream Deck plugin?
Did you enable the module in 'Manage Modules'?
Did you enable the module in the module settings?

I get the error that Material Deck cannot connect to Material Server

Make sure that you've followed the installation instructions closely, including the last section 'Installing Material Server'.
Make sure Material Server is running, and that you've set up the correct Material Server Address in the module settings. In most cases, the address should be 'localhost:3001', not the address of your Foundry server!
The only situation where it should be changed is if you're running Material Server on a different machine than the one you're accessing Foundry from.

Material Server won't run and/or gives an error

This could be due to various reasons.
Please make sure you've downloaded and installed all the prerequisites
If that didn't solve the issue, you can try running the server from the source.
Please also contact me or open an issue, so I can try to fix the issue in later releases.

Why does the Stream Deck update so slow?

The update speed depends on how powerful your computer is. Both the module and Stream Deck plugin need to do quite a lot of calculations in order to change the icons. Even on a decently powerful computer it can take a second to update all buttons.
You can try increasing the 'Image Buffer Size' in the module settings. This will allow the Stream Deck plugin to store previously sent images. This will prevent your computer from having to scale and convert the same image every time it has to be displayed. I have noticed a performance improvement of about 25%, but this will depend on the speed of your computer.

Is there any way I can support your work?

You could consider becoming a patron on the Material Foundry Patreon page.