MaterialFoundry / MaterialDeck

41 stars 20 forks source link

Note: At the moment Windows and OSX support has been confirmed. 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!

Please read the documentation carefully, especially if you want to modify the default profile!

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.

Youtube Video

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.

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

Instructions and More Info

Instructions and more info can be found in the wiki.

Latest releases

Module
Stream Deck
Material Companion

Module manifest: https://github.com/MaterialFoundry/MaterialDeck/releases/latest/download/module.json

Software Versions & Module Incompatibilities

Foundry VTT: v10 - v11
Module Incompatibilities: None known.

Feedback

If you have any suggestions or bugs to report, feel free to create an issue, contact me on Discord (Cris#6864), or send me an email: info@materialfoundry.nl.

Credits

Author: Cristian Deenen (Cris#6864 on Discord)

Special thanks to Asmodeus#7588 who made this module possible by generously donating a Stream Deck XL
Please consider supporting me on Patreon, and feel free to join the Material Foundry Discord server.

Abandonment

Abandoned modules are a (potential) problem for Foundry, because users and/or other modules might rely on abandoned modules, which might break in future Foundry updates.
I consider this module abandoned if all of the below cases apply:

If the above cases apply (as judged by the "League of Extraordinary Foundry VTT Developers" admins), I give permission to the "League of Extraordinary Foundry VTT Developers" admins to assign one or more developers to take over this module, including requesting the Foundry team to reassign the module to the new developer(s).
I require the "League of Extraordinary Foundry VTT Developers" admins to send me an email 2 weeks before the reassignment takes place, to give me one last chance to prevent the reassignment.
I require to be credited for my work in all future releases.