From fb26eacc8d717df1d88ae92d9763c53778e8e285 Mon Sep 17 00:00:00 2001 From: CDeenen <68693756+CDeenen@users.noreply.github.com> Date: Thu, 19 Nov 2020 13:39:28 +0100 Subject: [PATCH] Update README.md --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad2805f..1066bff 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -I created a Discord server to discuss this and other hardware-based Foundry modules. Feel free to join if you'd like to be updated on this module. +Note: At the moment only Windows support has been confirmed. Right now it doesn't appear to work on MacOS. Linux support is unknown, there is no official Linux support for the Stream Deck, but there exist a 3rd party Stream Deck UI that might be compatible.
+In any case: Proceed at your own risk, I will not take any responsibility if you spent money and the module doesn't work! + +I created a Discord server to discuss this and other hardware-based Foundry modules. Feel free to join if you'd like to join the discussion and be updated on this module. # Material Deck -Material Deck is a Foundry VTT module that allows you to control certain Foundry functions using an Elgato Stream Deck. A Stream Deck is a device that has physical buttons with displays behind them. Material Deck uses this to, for example, control playlists, execute macros, display and control the combat tracker.
-The module allows a high degree of customization, where each button on the Stream Deck can be assigned any desired function. Furthermore, it supports folder structures, allowing easy switching between various button configurations so you can easily switch between the combat tracker, soundboard, or any other (custom) configuration.
+Material Deck is a Foundry VTT module that allows you to control certain Foundry functions using an Elgato Stream Deck. A Stream Deck is a device that has physical buttons with displays behind them. Material Deck uses this to, for example, control playlists, execute macros, display and control the combat tracker.

+The module allows a high degree of customization, where each button on the Stream Deck can be assigned any desired function. Furthermore, it supports folder structures, allowing easy switching between various button configurations so you can easily switch between the combat tracker, soundboard, or any other (custom) configuration.

The functions are categorized into actions. Here is a list of the available actions and their most important functions: