v1.2.0

MaterialDeck.js

@@ -7,6 +7,7 @@ import {CombatTracker} from "./src/combattracker.js";
 import {PlaylistControl} from "./src/playlist.js";
 import {SoundboardControl} from "./src/soundboard.js";
 import {OtherControls} from "./src/othercontrols.js";
+import {ExternalModules} from "./src/external.js";
 export var streamDeck;
 export var tokenControl;
 var move;
@@ -15,6 +16,7 @@ export var combatTracker;
 export var playlistControl;
 export var soundboard;
 export var otherControls;
+export var externalModules;
 
 export const moduleName = "MaterialDeck";
 export var selectedTokenId;
@@ -50,11 +52,8 @@ async function analyzeWSmessage(msg){
         console.log("streamdeck connected to server");
     }
 
-
-
-
     if (data == undefined || data.payload == undefined) return;
-      
+    //console.log("Received",data);
     const action = data.action;
     const event = data.event;
     const context = data.context;
@@ -62,7 +61,6 @@ async function analyzeWSmessage(msg){
     if (coordinates == undefined) coordinates = 0;
     const settings = data.payload.settings;
 
-    
     if (data.data == 'init'){
 
     }
@@ -74,6 +72,8 @@ async function analyzeWSmessage(msg){
             tokenControl.active = true;
             tokenControl.update(selectedTokenId);
         }  
+        else if (action == 'move')
+            move.update(settings,context);
         else if (action == 'macro')
             macroControl.update(settings,context);
         else if (action == 'combattracker')
@@ -84,6 +84,8 @@ async function analyzeWSmessage(msg){
             soundboard.update(settings,context); 
         else if (action == 'other')
             otherControls.update(settings,context);
+        else if (action == 'external')
+            externalModules.update(settings,context);
     }
     
     else if (event == 'willDisappear'){
@@ -105,6 +107,8 @@ async function analyzeWSmessage(msg){
             soundboard.keyPressDown(settings);
         else if (action == 'other')
             otherControls.keyPress(settings);
+        else if (action == 'external')
+            externalModules.keyPress(settings,context);
     }
 
     else if (event == 'keyUp'){
@@ -181,7 +185,6 @@ export function sendWS(txt){
 Hooks.once('ready', ()=>{
     enableModule = (game.settings.get(moduleName,'Enable')) ? true : false;
     
-    
     game.socket.on(`module.MaterialDeck`, (payload) =>{
         //console.log(payload);
         if (payload.msgType != "playSound") return;
@@ -206,6 +209,7 @@ Hooks.once('ready', ()=>{
     combatTracker = new CombatTracker();
     playlistControl = new PlaylistControl();
     otherControls = new OtherControls();
+    externalModules = new ExternalModules();
 
 
     let soundBoardSettings = game.settings.get(moduleName,'soundboardSettings');
@@ -265,6 +269,18 @@ Hooks.on('updateToken',(scene,token)=>{
         tokenControl.update(selectedTokenId);
 });
 
+Hooks.on('updateActor',(scene,actor)=>{
+    if (enableModule == false || ready == false) return;
+    let children = canvas.tokens.children[0].children;
+    for (let i=0; i<children.length; i++){
+        if (children[i].actor.id == actor._id){
+            let tokenId = children[i].id;
+            if (tokenId == selectedTokenId)
+                tokenControl.update(selectedTokenId);
+        }
+    }
+});
+
 Hooks.on('controlToken',(token,controlled)=>{
     if (enableModule == false || ready == false) return;
     if (controlled) {
@@ -311,6 +327,7 @@ Hooks.on('renderSidebarTab',()=>{
 Hooks.on('updateScene',()=>{
     if (enableModule == false || ready == false) return;
     otherControls.updateAll();
+    externalModules.updateAll();
 });
 
 Hooks.on('renderSceneControls',()=>{
@@ -355,62 +372,4 @@ Hooks.once('init', ()=>{
 
 Hooks.once('canvasReady',()=>{
     ready = true;
-});
-
-export function getFromJSONArray(data,i){
-    if (i>9) return 'nul';
-    let val;
-    if (i == 0) val = data.a;
-    else if (i == 1) val = data.a;
-    else if (i == 2) val = data.c;
-    else if (i == 3) val = data.d;
-    else if (i == 4) val = data.e;
-    else if (i == 5) val = data.f;
-    else if (i == 6) val = data.g;
-    else if (i == 7) val = data.h;
-    else if (i == 8) val = data.i;
-    else if (i == 9) val = data.j;
-    else if (i == 10) val = data.k;
-    else if (i == 11) val = data.l;
-    else if (i == 12) val = data.m;
-    else if (i == 13) val = data.n;
-    else if (i == 14) val = data.o;
-    else if (i == 15) val = data.p;
-    else if (i == 16) val = data.q;
-    else if (i == 17) val = data.r;
-    else if (i == 18) val = data.s;
-    else if (i == 19) val = data.t;
-    else if (i == 20) val = data.u;
-    else if (i == 21) val = data.v;
-    else if (i == 22) val = data.w;
-    else if (i == 23) val = data.x;
-    return val;
-}
-
-export function setToJSONArray(data,i,val){
-    if (i>9) return 'nul';
-    if (i == 0) data.a = val;
-    else if (i == 1) data.b = val;
-    else if (i == 2) data.c = val;
-    else if (i == 3) data.d = val;
-    else if (i == 4) data.e = val;
-    else if (i == 5) data.f = val;
-    else if (i == 6) data.g = val;
-    else if (i == 7) data.h = val;
-    else if (i == 8) data.i = val;
-    else if (i == 9) data.j = val;
-    else if (i == 10) data.k = val;
-    else if (i == 11) data.l = val;
-    else if (i == 12) data.m = val;
-    else if (i == 13) data.n = val;
-    else if (i == 14) data.o = val;
-    else if (i == 15) data.p = val;
-    else if (i == 16) data.q = val;
-    else if (i == 17) data.r = val;
-    else if (i == 18) data.s = val;
-    else if (i == 19) data.t = val;
-    else if (i == 20) data.u = val;
-    else if (i == 21) data.v = val;
-    else if (i == 22) data.w = val;
-    else if (i == 23) data.x = val;
-}
+});

README.md

@@ -1,8 +1,67 @@
-# Stream Deck
-Material Deck is a Foundry VTT module that allows you to control certain Foundry functions using an Elgato Stream Deck.
+<b>Note:</b> 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 <a href="https://timothycrosley.com/project-7-streamdeck_ui">Stream Deck UI</a> that might be compatible.<br>
+<b>In any case: Proceed at your own risk, I will not take any responsibility if you spent money and the module doesn't work!</b>
 
-## Instructions
-Instructions are on the <a href="https://github.com/CDeenen/MaterialDeck/wiki">wiki</a>.
+<b>Please read the documentation carefully, especially if you want to modify the default profile!</b>
+
+I created a <a href="https://discord.gg/3hd4G6TkmA">Discord server</a> 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](https://github.com/CDeenen/MaterialDeck/blob/Master/wiki/img/Youtube.png)](https://youtu.be/7h5Ew8cJYxg "FoundryVTT Material Deck Demonstration")
+
+# 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.<br><br>
+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.<br><br>
+The functions are categorized into actions. Here is a list of the available actions and their most important functions:
+<ul>
+  <li>Playlist Action: Control Foundry's playlists</li>
+  <ul>
+    <li>Play/Stop playlists</li>
+    <li>Play/Stop tracks</li>
+    <li>Stop all tracks & playlists</li>
+  </ul>
+  <li>Soundboard Action: Play sounds</li>
+  <ul>
+    <li>Play/Stop sound</li>
+    <li>Stop all sounds</li>
+  </ul>
+  <li>Token Action: Display token info</li>
+  <ul>
+    <li>Display selected token's name, icon or stats (HP/AC/Movement/etc)</li>
+    <li>Open selected token's character sheet or token config</li>
+    <li>Target token</li>
+    <li>Toggle token visibility, combat state, conditions</li>
+  </ul>
+  <li>Move Action: Move selected token or the canvas</li>
+  <ul>
+    <li>Move token (in a specified direction)</li>
+    <li>Move canvas (in a specified direction)</li>
+    <li>Zoom canvas in/out</li>
+  </ul>
+  <li>Macro Actions: Execute macros</li>
+  <ul>
+    <li>Execute macro from hotbar</li>
+    <li>Execute macro from macro board</li>
+  </ul>
+  <li>Combat Tracker Actions: Control and display the combat tracker</li>
+  <ul>
+    <li>Display combatants</li>
+    <li>Start/Stop combat</li>
+    <li>Next/Previous turn/round</li>
+  </ul>
+  <li>Other Actions: Misc other actions</li>
+  <ul>
+    <li>Pause/Resume game</li>
+    <li>Scene selection/activation</li>
+    <li>Toggle control buttons</li>
+    <li>Control darkness level</li>
+    <li>Open/Roll from a roll table</li>
+    <li>Open sidebar tab</li>
+    <li>Open compendium pack</li>
+    <li>Open journal entry</li>
+  </ul>
+</ul>
+  
+## Instructions and More Info
+Instructions and more info can be found in the <a href="https://github.com/CDeenen/MaterialDeck/wiki">wiki</a>.
 
 ## Latest releases
 <a href="https://github.com/CDeenen/MaterialDeck/releases">Module</a><br>
@@ -10,3 +69,30 @@ Instructions are on the <a href="https://github.com/CDeenen/MaterialDeck/wiki">w
 <a href="https://github.com/CDeenen/MaterialServer/releases">Server</a><br>
 <br>
 Module manifest: https://raw.githubusercontent.com/CDeenen/MaterialDeck/Master/module.json
+
+## Software Versions & Module Incompatibilities
+<b>Foundry VTT:</b> Tested on 0.7.5-0.7.9<br>
+<b>Module Incompatibilities:</b> None known.<br>
+
+## 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: cdeenen@outlook.com.
+
+## Credits
+<b>Author:</b> Cristian Deenen (Cris#6864 on Discord)<br>
+<br>
+Special thanks to Asmodeus#7588 who made this module possible by generously donating a Stream Deck XL
+<br>
+Please consider supporting me on <a href="https://www.patreon.com/materialfoundry">Patreon</a>, and feel free to join the Material Foundry <a href="https://discord.gg/3hd4G6TkmA">Discord</a> 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.<br>
+I consider this module abandoned if all of the below cases apply:
+<ul>
+  <li>This module/github page has not received any updates in at least 3 months</li>
+  <li>I have not posted anything on "the Foundry", "the League of Extraordinary Foundry VTT Developers" or the "Material Foundry" Discord servers in at least 3 months</li>
+  <li>I have not responded to emails or PMs on Discord in at least 1 month</li>
+  <li>I have not announced a temporary break from development, unless the announced end date of this break has been passed by at least 3 months</li>
+</ul>
+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).<br>
+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.<br>
+I require to be credited for my work in all future releases.

changelog.md

@@ -1,5 +1,93 @@
 # Changelog Material Deck Module
-### v0.8.7 - 19-11-2020
+### v1.2.0 - 28-12-2020
+Fixes
+<ul>
+<li>Incorrect link to some black backgrounds fixed</li>
+<li>Token Action: Movement speed wouldn't be displayed for DnD5e 1.2.0</li>
+<li>Macro Action => Hotbar: 10th macro would not trigger and display correctly</li>
+<li>Combat Tracker Action => Function: Default value would not properly initialize</li>
+<li>Other Actions => Darkness Control => Display would not function correctly</li>
+<li>Fixed some issues in the SD plugin where correct settings would not be displayed</li>
+</ul>
+Additions:
+<ul>
+<li>Added new 'External Modules Action', which will contain all module integrations that don't fit anywhere else</li>
+<li>Added support for the Custom Hotbar module in 'Macro Action' => Mode: 'Custom Hotbar'. Link to module: https://foundryvtt.com/packages/custom-hotbar/</li>
+<li>Added support for the FxMaster module in 'External Modules Action' => Mode: 'Fx Master'. Link to module: https://foundryvtt.com/packages/fxmaster/</li>
+</ul>
+
+### v1.1.1 - 12-12-2020
+Fixes
+<ul>
+<li>Fixed issue where deleting a playlist would cause an error preventing the Soundboard Configuration to show up</li>
+</ul>
+
+<b>Compatible server app and SD plugin:</b><br>
+Material Server v1.0.2 (unchanged): https://github.com/CDeenen/MaterialServer/releases <br>
+SD plugin v1.1.0 (unchanged): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.1.0 - 09-12-2020
+Fixes
+<ul>
+<li>Settings would not show for Combat Tracker action</li>
+<li>Macro Action => Macro Board default settings fixed</li>
+<li>API has been improved, making integration with other hardware/software easier, and making future changes/additions easier</li>
+</ul>
+Additions:
+<ul>
+<li>Added support for Pathfinder 1e and Shadow of the Demon Lord</li>
+<li>All dialogs that are openable using the SD can now be closed by pressing the button while the dialog is open</li>
+<li>Playlist Action & Soundboard Action => Stop All now indicates if there are tracks/playlists/sounds playing</li>
+<li>Confirmed Foundry 0.7.8 compatibility</li>
+</ul>
+
+<b>Compatible server app and SD plugin:</b><br>
+Material Server v1.0.2 (unchanged): https://github.com/CDeenen/MaterialServer/releases <br>
+SD plugin v1.1.0: https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### V1.0.1 - 26-11-2020
+<ul>
+<li>Fixed issue where macro from macroboard wouldn't execute if furnace arguments were not defined</li>
+<li>Fixed issue where soundboard wouldn't save if no previous data existed for that sound</li>
+</ul>
+
+<b>Compatible server app and SD plugin:</b><br>
+Material Server v1.0.2 (unchanged): https://github.com/CDeenen/MaterialServer/releases <br>
+SD plugin v1.0.0 (unchanged): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.0.0 - 24-11-2020
+Release
+<ul>
+<li>Fixed issue where the last column in 'Soundboard Configuration' would not work properly</li>
+</ul>
+
+<b>Compatible server app and SD plugin:</b><br>
+Material Server v1.0.2: https://github.com/CDeenen/MaterialServer/releases <br>
+SD plugin v1.0.0: https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v0.9.2 - 24-11-2020
+<ul>
+<li>Removed unnecessary errors when module is not fully configured</li>
+<li>Solved issue that soundboard config couldn't be saved on a world that hadn't run Material Deck previously</li>
+</ul>
+
+### v0.9.1 - 23-11-2020
+<ul>
+<li>Fixed 'Playlist' action issue where 'TrackNr' wouldn't show</li>
+<li>Fixed 'Soundboard Configuration' issue where changing the playlist would reset everything you've changed since last save</li>
+<li>'Soundboard Configuration', 'Macro Configuration' and 'Playlist Configuration' now save after each change, and update the SD instantly</li>
+<li>Save button has been removed from configuration screens, since it is now redundant</li>
+<li>Added support for DnD3.5e and Pathfinder 2e</li>
+</ul>
+
+<b>Note1:</b> In 'Macro Configuration', previously saved Furnace arguments have to be filled in again.<br>
+<b>Note2:</b> Any settings set in 'Playlist Configuration' have to be set again<br>
+<br>
+<b>Compatible server app and SD plugin:</b><br>
+Material Server v1.0.1 (unchanged): https://github.com/CDeenen/MaterialServer/releases <br>
+SD plugin v0.9.1: https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v0.9.0 - 19-11-2020
 <ul>
 <li>Added support for more playlists</li>
 <li>Added playmode setting for each playlist, which overrides the default playmode</li>

img/combattracker/SOURCES.txt

@@ -0,0 +1,5 @@
+combattracker.png: Edited from https://fontawesome.com/icons/fist-raised?style=solid
+nextturn.png, previousturn.png: Edited from https://fontawesome.com/icons/arrow-right?style=solid
+nextround.png, previousround.png: Edited from https://fontawesome.com/icons/step-forward?style=solid
+startcombat.png: Edited from https://fontawesome.com/icons/play?style=solid
+stopcombat.png: Edited from https://fontawesome.com/icons/stop?style=solid

img/external/SOURCES.txt

@@ -0,0 +1,2 @@
+external.png: Edited from https://fontawesome.com/icons/external-link-alt?style=solid
+fxmaster.png: Edited from https://fontawesome.com/icons/magic?style=solid

img/macro/SOURCES.txt

@@ -0,0 +1 @@
+macro.png: Foundry's icon folder, converted from .svg, original name: dice-target.svg

img/move/SOURCES.txt

@@ -0,0 +1,2 @@
+center.png: made by me
+All other images taken from freepngimg.com, iverted color and rotated. Source: https://freepngimg.com/png/24691-right-arrow-hd

img/other/SOURCES.txt

@@ -0,0 +1,2 @@
+other.png: Made using https://www.elgato.com/en/gaming/keycreator
+cogs.png: Edited from https://fontawesome.com/icons/cogs?style=solid

img/other/darkness/SOURCES.txt

@@ -0,0 +1,2 @@
+decreasedarkness.png: Made using https://www.elgato.com/en/gaming/keycreator
+increasedarkness.png: Made using https://www.elgato.com/en/gaming/keycreator

img/other/pause/SOURCES.txt

@@ -0,0 +1,3 @@
+resume.png: Edited from https://fontawesome.com/icons/play?style=solid
+pause.png: Edited from https://fontawesome.com/icons/pause?style=solid
+playpause.png: Combined resume.png and pause.png

img/playlist/SOURCES.txt

@@ -0,0 +1,2 @@
+play.png: Edited from https://fontawesome.com/icons/play?style=solid
+stop.png: Edited from https://fontawesome.com/icons/stop?style=solid

img/soundboard/SOURCES.txt

@@ -0,0 +1,2 @@
+soundboard.png: Edited from https://fontawesome.com/icons/music?style=solid
+play.png: Edited from https://fontawesome.com/icons/play?style=solid

img/token/SOURCES.txt

@@ -0,0 +1,5 @@
+ac.webp: Foundry's icon folder, original name: heater-steel-worn.webp
+hp.png: made using Elgato's key creator: https://www.elgato.com/en/gaming/keycreator
+init.png: freepngimg.com, color inverted, from: https://freepngimg.com/png/81025-art-dice-dungeons-system-dragons-d20-triangle/icon
+speed.webp: Foundry's icon folder, original name: shoes-collared-leather-blue.webp
+mystery-man.png: Foundry's icon folder, converted from .svg