Introduction
This page contains installation instructions for Windows and OSX.
Because the Stream Deck application is not available for Linux, you'll have to run a virtual machine to get it to work. There's separate instructions for Linux users here.
Installing the module
- In the configuration and setup screen, go to 'Add-on Modules'
- Click 'Install Module' at the bottom
- Either search for the module and install like any other module, or in the bottom, there's a textbox labeled 'Manifest URL', copy the following link into that:
https://raw.githubusercontent.com/CDeenen/MaterialDeck/Master/module.json - Click the 'Install' button
Installing the Stream Deck plugin
You first have to download and install the Stream Deck software, you can then install the plugin:
- Download the latest plugin file (com.cdeenen.materialdeck.streamDeckPlugin) from here or get it from the Download Utility in the Foundry module (in the module settings)
- Double-click the file, this should open the Stream Deck software if it's not open yet
- Press 'Install' in the pop-up
If that doesn't work, you can try the following:
- Download the source code from here
- Copy the 'com.cdeenen.materialdeck.sdPlugin' folder (in the Plugin folder) to
%appdata%\Elgato\StreamDeck\Plugins\(Windows) or~/Library/Application Support/com.elgato.StreamDeck/Plugins/(OSX) - Restart the Stream Deck application.
Installing a Stream Deck profile (optional)
Currently, there are profiles for the normal and XL Stream Deck variants, for both players (with '_player' in the file name) and DMs. Additionally theres the 'MaterialDeck-Kruvek' profile for the normal Stream Deck that was made by a user and might be worth giving a try.
You don't have to use these profiles, but they can serve as an example.
- Download the latest profile (ending with .streamDeckProfile) from here
- Double-click the file, this should load the profile into the Stream Deck software
- Alternatively, if that doesn't work, you can press the down arrow next to the current profile name, click 'Edit Profiles', click the down arrow at the bottom and select 'Import' and then navigate to the profile
Installing Material Server
Material Server should be installed on the same computer that you have the Stream Deck connected to.
- Download the latest version for your operating system here or get it from the Download Utility in the Foundry module (in the module settings)
- Extract the archive
- Double-click the MaterialServer file to start the server (needs to be done every time you want to use the module)
This generally works for Windows, but you might run into issues with MacOS or Linux. Please look here for more information
Some browsers, such as Brave, have a built-in adblocker that may prevent Foundry from connecting to Material Server. If you run into connection issues, try disabling the adblocker (in brave: press the lion icon, and set the shields to 'down'), or use another browser like Chrome or Firefox.