asc/MaterialDeck
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Page: Linux Instructions
Pages
Combat Tracker Action Custom Icons External Modules FAQ Getting Started Home Installation Linux Instructions Macro Action Module Setup Move Action Other Actions Playlist Action Scene Action Soundboard Action Token Action
Clone
7
Linux Instructions
Material Foundry edited this page 2022-08-04 07:42:05 +02:00
Table of Contents

Introduction

Unfortunately, the Stream Deck appication is not available for Linux, which makes it more complex to get Material Deck running on Linux.
While streamdeck_ui exists to connect a Stream Deck to a Linux machine, it unfortunately does not allow the installation of normal Stream Deck plugins (which Material Deck requires). I have tried installing the Windows application on Linux through Wine, but could not get it to work. The only thing I've been able to get to work is to run the Stream Deck application on a Windows 10 virtual machine.

If you happen to find a better way to do this, please let me know.

Important Notes

Having to run a virtual Windows 10 is not exactly resource efficient, so performance might suffer.

Installation

On Linux:

  1. Download and install VirtualBox and its Extension Pack
  2. Download a Windows 10 disk image
  3. Install the Windows 10 virtual machine

Tip 1: You don't have to fill in a product key during installation, you can skip it and do that later.
Tip 2: Annoyingly, Microsoft wants you to log into a Microsoft account during installation, but you can bypass it by temporarily disconnecting from the internet, this will create a local account instead

  1. Go into the virtual machine settings => Network => make sure 'Attached to' is set to 'NAT'
  2. In the same network settings, click 'advanced' and open 'Port Forwarding'
  3. Add a new port forwarding rule, set it to: Protocol = TCP, Host IP = 127.0.0.1, Host Port = 3001, Guest IP = 10.0.2.15, Guest Port = 3001
  4. Start the virtual machine
  5. Connect the Stream Deck to your computer and configure VirtualBox to connect it to Windows: 'Devices' => 'USB' => select the Stream Deck

On the Windows virtual machine:

  1. Download and install the Stream Deck application
  2. When the application opens, if all went well, the Stream Deck should connect to it (it'll display all black keys except for the default 'welcome' action). If that doesn't happen, you might have to configure VirtualBox to use USB2.0 or 3.0 (In the virtual machine settings: 'USB' => select 2.0 or 3.0. You might have to restart the virtual machine)
  3. Download and install the Material Deck plugin (com.cdeenen.materialdeck.streamDeckPlugin). Double clicking should install it
  4. (Optionally, but highly recommended for first-timers) install one of the default profiles (MaterialDeck_xxx.streamDeckProfile). Double clicking should install it
  5. Download the Windows version of Material Server, extract it, and run 'Material Server.exe'.

Back on Linux:

  1. Open Foundry or access it from your browser
  2. Install the Material Plane module and enable it
  3. In the Material Plane module settings tick 'Enable module' and make sure 'Material Server Address' is set to the default (localhost:3001)

Hopefully it now works!

You'll have to start the virtual machine, the Stream Deck app, and Material Server every time you want to use it.