From 32e9fbec59561f4b239857725937b4ad4fcf14e8 Mon Sep 17 00:00:00 2001
From: Material Foundry <68693756+CDeenen@users.noreply.github.com>
Date: Sat, 7 May 2022 01:06:14 +0200
Subject: [PATCH] Created Linux Instructions (markdown)

---
 Linux-Instructions.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 Linux-Instructions.md

diff --git a/Linux-Instructions.md b/Linux-Instructions.md
new file mode 100644
index 0000000..fe221cc
--- /dev/null
+++ b/Linux-Instructions.md
@@ -0,0 +1,35 @@
+## Introduction
+Unfortunately, the Stream Deck appication is not available for Linux, which makes it more complex to get Material Deck running on Linux.<br>
+While [streamdeck_ui](https://timothycrosley.github.io/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.<br>
+<br>
+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.<br>
+Currently this only works for unsecured Foundry servers, this is a limitation that I could make a workaround for, if there's interest in it.
+
+## Installation
+On Linux:
+1. Download and install [VirtualBox and its Extension Pack](https://www.virtualbox.org/wiki/Downloads)
+2. Download a [Windows 10 disk image](https://www.microsoft.com/software-download/windows10)
+3. [Install the Windows 10 virtual machine](https://www.extremetech.com/computing/198427-how-to-install-windows-10-in-a-virtual-machine)
+> Tip 1: You don't have to fill in a product key during installation, you can skip it and do that later.<br>
+> 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
+4. When installed, 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](https://www.elgato.com/en/downloads)
+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](https://github.com/CDeenen/MaterialDeck_SD/releases) (com.cdeenen.materialdeck.streamDeckPlugin). Double clicking should install it
+4. (Optionally, but highly recommended for first-timers) install one of the [default profiles](https://github.com/CDeenen/MaterialDeck_SD/releases) (MaterialDeck_xxx.streamDeckProfile). Double clicking should install it
+5. Download [MaterialServer-win.zip](https://github.com/CDeenen/MaterialServer/releases/tag/v1.0.2), extract it, and run 'Material Server.exe'. A terminal window should now open, it'll print some lines. Take note of the line 'Websocket on: xxx.xxx.xxx.xxx:3001'
+
+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 at 'Material Server Address' fill in the ip address you found in the Material Server window
+
+Hopefully it now works!<br>
+<br>
+You'll have to start the virtual machine, the Stream Deck app, and Material Server every time you want to use it.
\ No newline at end of file