v1.4.7

chore: update gm screen api call

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: MaterialFoundry
+open_collective: # Replace with a single Open Collective username
+ko_fi: materialfoundry
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Setup**
+ - OS: [e.g. windows]
+ - Browser: [e.g. chrome, safari, Foundry app]
+ - Module version: [e.g. 1.2.5]
+ - Foundry version: [e.g. 0.8.6]
+ - Gaming system & version: [e.g. dnd5e 1.3.3]
+ - Any other modules enabled: [yes/no]
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Console Log**
+Please check the console (F12) to see if there are any errors and also include them.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE]"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/other-issues.md

@@ -0,0 +1,10 @@
+---
+name: Other issues
+about: For any other issues
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

DEVGUIDE.md

@@ -0,0 +1,40 @@
+
+# Dev Guide
+
+In addition to this repo, you will also need to check out the [MaterialDeck_SD github repo](https://github.com/CDeenen/MaterialDeck_SD).
+
+## Module Development 
+
+### Make a new system.js file
+
+In the [src/systems](src/systems) directory, create a new system file by copying and pasting a similar system to it; for example, `cp demonlord.js wfrp4.js`
+You then need to go through all the functions in there and make sure that the correct data is set.
+
+### Update TokenHelper
+In [src/systems/TokenHelper.js](src/systems/TokenHelper.js), you need to add an `import {}` for your new system.
+
+In the same file, in the setSystem() function, you need to wire in your system to the if/else block.
+
+## Debugging
+
+It's possible to debug on the Stream Deck, so you can do `console.log`. Just follow the instructions [from elgato here](https://developer.elgato.com/documentation/stream-deck/sdk/create-your-own-plugin/).  After editing the code for the plugin, you need to either refresh by refreshing the debug window, or by deselecting the current button, and selecting it again.
+
+When you go to the debugging page, there should be multiple options. With the property inspector open, you should connect to the one with property inspector in its name. If you go to to propertyinspector/js/common.js, near the top there's the debugEn variable. Set it to true, and you should get tons of messages, especially if you change any settings.
+In the module, in MaterialDeck.js, at line 60, there's //console.log("Received",data);. If you uncomment that, it'll log everything that's send from the SD to the module. Might be helpful for debugging.
+
+
+## Streamdeck
+
+To enable logging on the streamdeck, [follow these instructions](https://developer.elgato.com/documentation/stream-deck/sdk/create-your-own-plugin/) from Elgato.
+
+The plugin in Windows is located at (Windows) `AppData/Roaming/Elgato/StreamDeck/Plugins/com.cdeenen.materialdeck.sdPlugin`
+In `propertyinspector/js/common.js::getStats()` there are various functions that are used to get the relevant options to show up in the SD plugin. Each array element has a value and a name, you should keep the value the same, but the name can be whatever you like. I think you'll be able to figure out how to add stuff for wfrp by looking at the others.
+
+
+## Property discovery
+In a Foundry client browser instance, if you go to the dev console, you can browser your tokens via the `canvas.tokens` path, for example `canvas.tokens.children[0].children[0].actor.data`.
+
+## Module Deployment
+If you make changes to files in this project, you'll need to copy the changed files to your Foundry install folder, probably found here: `C:\Users\$USER\AppData\Local\FoundryVTT\Data\modules\MaterialDeck`.
+
+If you change the `MaterialDeck_SD` code (for example, `propertyinspector\js\common.js`), you will need to copy that file to the Elgato streamdeck plugins directory, probably found here: `C:\Users\$USER\AppData\Roaming\Elgato\StreamDeck\Plugins\com.cdeenen.materialdeck.sdPlugin`. 

MaterialDeck.js

@@ -1,26 +1,39 @@
 import {registerSettings} from "./src/settings.js";
 import {StreamDeck} from "./src/streamDeck.js";
 import {TokenControl} from "./src/token.js";
-import {Move} from "./src/move.js";
 import {MacroControl} from "./src/macro.js";
 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";
+import {SceneControl} from "./src/scene.js";
+import {downloadUtility, compatibleCore} from "./src/misc.js";
+import {TokenHelper} from "./src/systems/tokenHelper.js";
 export var streamDeck;
 export var tokenControl;
-var move;
 export var macroControl;
 export var combatTracker;
 export var playlistControl;
 export var soundboard;
 export var otherControls;
+export var externalModules;
+export var sceneControl;
+export var tokenHelper;
 
 export const moduleName = "MaterialDeck";
-export var selectedTokenId;
 
 let ready = false;
-let activeSounds = [];
+
+export let hotbarUses = false;
+export let calculateHotbarUses;
+
+let controlTokenTimer;
+
+export let sdVersion;
+export let msVersion;
+
+let updateDialog;
        
 //CONFIG.debug.hooks = true;
 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -36,6 +49,8 @@ let wsOpen = false;             //Bool for checking if websocket has ever been o
 let wsInterval;                 //Interval timer to detect disconnections
 let WSconnected = false;
 
+//let furnace = game.modules.get("furnace");
+
 /*
  * Analyzes the message received 
  * 
@@ -47,67 +62,127 @@ async function analyzeWSmessage(msg){
     //console.log("Received",data);
 
     if (data.type == "connected" && data.data == "SD"){
+        const msg = {
+            target: "SD",
+            type: "init",
+            system: game.system.id
+        }
+        ws.send(JSON.stringify(msg));
+        
+
         console.log("streamdeck connected to server");
+        streamDeck.resetImageBuffer();
     }
 
+    if (data.type == "version" && data.source == "SD") {
+        let minimumSDversion;
+        let minimumMSversion;
+        if (compatibleCore("0.8.5")) {
+            minimumSDversion = game.modules.get("MaterialDeck").data.flags.minimumSDversion.replace('v','');
+            minimumMSversion = game.modules.get("MaterialDeck").data.flags.minimumMSversion;
+        }
+        else {
+            minimumSDversion = game.modules.get("MaterialDeck").data.minimumSDversion.replace('v','');
+            minimumMSversion = game.modules.get("MaterialDeck").data.minimumMSversion;
+        }
         
+        sdVersion = data.version;
 
+        if (data.version < minimumSDversion && updateDialog == undefined) {
+            updateDialog = new Dialog({
+                title: "Material Deck: Update Needed",
+                content: "<p>The Stream Deck plugin version you're using is v" + data.version + ", which is incompatible with this verion of the module.<br>Update to v" + minimumSDversion + " or newer.</p>",
+                buttons: {
+                 download: {
+                  icon: '<i class="fas fa-download"></i>',
+                  label: "Download Utility",
+                  callback: () => new downloadUtility()
+                 },
+                 ignore: {
+                  icon: '<i class="fas fa-times"></i>',
+                  label: "Ignore"
+                 }
+                },
+                default: "download"
+            });
+            updateDialog.render(true);
+        }
+    }
+
+    if (data.type == 'newDevice') {
+        streamDeck.newDevice(data.iteration,data.device);
+        return;
+    }
 
     if (data == undefined || data.payload == undefined) return;
-      
     const action = data.action;
     const event = data.event;
     const context = data.context;
     const coordinates = data.payload.coordinates;
-    if (coordinates == undefined) coordinates = 0;
     const settings = data.payload.settings;
-
+    const device = data.device;
+    const name = data.deviceName;
+    const type = data.deviceType;
 
     if (data.data == 'init'){
 
     }
     if (event == 'willAppear' || event == 'didReceiveSettings'){
+        if (coordinates == undefined) return;
         streamDeck.setScreen(action);
-        streamDeck.setContext(action,context,coordinates,settings);
+        await streamDeck.setContext(device,data.size,data.deviceIteration,action,context,coordinates,settings,name,type);
+
+        if (game.settings.get(moduleName, 'devices')?.[device]?.enable == false) return;
 
         if (action == 'token'){
             tokenControl.active = true;
-            tokenControl.update(selectedTokenId);
+            tokenControl.pushData(canvas.tokens.controlled[0]?.id,settings,context,device);
         }  
         else if (action == 'macro')
-            macroControl.update(settings,context);
+            macroControl.update(settings,context,device);
         else if (action == 'combattracker')
-            combatTracker.update(settings,context);
+            combatTracker.update(settings,context,device);
         else if (action == 'playlist')
-            playlistControl.update(settings,context);
+            playlistControl.update(settings,context,device);
         else if (action == 'soundboard')
-            soundboard.update(settings,context); 
+            soundboard.update(settings,context,device); 
         else if (action == 'other')
-            otherControls.update(settings,context);
+            otherControls.update(settings,context,device);
+        else if (action == 'external')
+            externalModules.update(settings,context,device);
+        else if (action == 'scene')
+            sceneControl.update(settings,context,device);
     }
     
     else if (event == 'willDisappear'){
-        streamDeck.clearContext(action,coordinates);
+        if (coordinates == undefined) return;
+        streamDeck.clearContext(device,action,coordinates,context);
     }
 
     else if (event == 'keyDown'){
+        if (game.settings.get(moduleName, 'devices')?.[device]?.enable == false) return;
+
         if (action == 'token')
             tokenControl.keyPress(settings);
-        else if (action == 'move')
-            move.keyPress(settings);
         else if (action == 'macro')
             macroControl.keyPress(settings);
         else if (action == 'combattracker')
-            combatTracker.keyPress(settings,context);
+            combatTracker.keyPress(settings,context,device);
         else if (action == 'playlist')
-            playlistControl.keyPress(settings,context);
+            playlistControl.keyPress(settings,context,device);
         else if (action == 'soundboard')
             soundboard.keyPressDown(settings);
         else if (action == 'other')
-            otherControls.keyPress(settings);
+            otherControls.keyPress(settings,context,device);
+        else if (action == 'external')
+            externalModules.keyPress(settings,context,device);
+        else if (action == 'scene')
+            sceneControl.keyPress(settings);
     }
 
     else if (event == 'keyUp'){
+        if (game.settings.get(moduleName, 'devices')?.[device]?.enable == false) return;
+
         if (action == 'soundboard'){
             soundboard.keyPressUp(settings);
         }
@@ -122,7 +197,10 @@ async function analyzeWSmessage(msg){
  */
 function startWebsocket() {
     const address = game.settings.get(moduleName,'address');
-    ws = new WebSocket('ws://'+address+'/');
+    
+    const url = address.startsWith('wss://') ? address : ('ws://'+address+'/');
+
+    ws = new WebSocket(url);
 
     ws.onmessage = function(msg){
         //console.log(msg);
@@ -132,6 +210,7 @@ function startWebsocket() {
     }
 
     ws.onopen = function() {
+        messageCount = 0;
         WSconnected = true;
         ui.notifications.info("Material Deck "+game.i18n.localize("MaterialDeck.Notifications.Connected") +": "+address);
         wsOpen = true;
@@ -142,7 +221,8 @@ function startWebsocket() {
         ws.send(JSON.stringify(msg));
         const msg2 = {
             target: "SD",
-            type: "init"
+            type: "init",
+            system: game.system.id
         }
         ws.send(JSON.stringify(msg2));
         clearInterval(wsInterval);
@@ -152,22 +232,51 @@ function startWebsocket() {
     clearInterval(wsInterval);
     wsInterval = setInterval(resetWS, 10000);
 }
-
+let messageCount = 0;
 /**
  * Try to reset the websocket if a connection is lost
  */
 function resetWS(){
-    if (wsOpen) ui.notifications.warn("Material Deck: "+game.i18n.localize("MaterialDeck.Notifications.Disconnected"));
-    else ui.notifications.warn("Material Deck: "+game.i18n.localize("MaterialDeck.Notifications.ConnectFail"));
+    const maxMessages = game.settings.get(moduleName, 'nrOfConnMessages');
+    if (wsOpen) {
+        ui.notifications.warn("Material Deck: "+game.i18n.localize("MaterialDeck.Notifications.Disconnected"));
+        wsOpen = false;
+        messageCount = 0;
         WSconnected = false;
         startWebsocket();
     }
+    else if (ws.readyState == 3){
+        if (maxMessages == 0 || maxMessages > messageCount) {
+            messageCount++;
+            const countString = maxMessages == 0 ? "" : " (" + messageCount + "/" + maxMessages + ")";
+            ui.notifications.warn("Material Deck: "+game.i18n.localize("MaterialDeck.Notifications.ConnectFail") + countString);
+        }
+        WSconnected = false;
+        startWebsocket();
+    }
+}
 
 export function sendWS(txt){
     if (WSconnected)
         ws.send(txt);
 }
 
+export function isEmpty(obj) {
+    for(var key in obj) {
+        if(obj.hasOwnProperty(key))
+            return false;
+    }
+    return true;
+}
+
+export function getPermission(action,func) {
+    const role = game.user.role-1;
+    const settings = game.settings.get(moduleName,'userPermission');
+    if (action == 'ENABLE') return settings.enable[role];
+    else return settings.permissions?.[action]?.[func]?.[role];
+}
+
+
 //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 //
 // Hooks
@@ -178,36 +287,68 @@ export function sendWS(txt){
  * Ready hook
  * Attempt to open the websocket
  */
-Hooks.once('ready', ()=>{
+Hooks.once('ready', async()=>{
+    registerSettings();
     enableModule = (game.settings.get(moduleName,'Enable')) ? true : false;
 
-    
-    game.socket.on(`module.MaterialDeck`, (payload) =>{
-        //console.log(payload);
-        if (payload.msgType != "playSound") return;
-        playTrack(payload.trackNr,payload.src,payload.play,payload.repeat,payload.volume);  
-    });
-
-    for (let i=0; i<64; i++)
-        activeSounds[i] = false;
-
-    if (enableModule == false) return;
-    if (game.user.isGM == false) {
-        ready = true;
-        return;
-    }
-    
-    startWebsocket();
     soundboard = new SoundboardControl();
     streamDeck = new StreamDeck();
     tokenControl = new TokenControl();
-    move = new Move();
     macroControl = new MacroControl();
     combatTracker = new CombatTracker();
     playlistControl = new PlaylistControl();
     otherControls = new OtherControls();
+    externalModules = new ExternalModules();
+    sceneControl = new SceneControl();
+    tokenHelper = new TokenHelper();
 
+    game.socket.on(`module.MaterialDeck`, async(payload) =>{
+        //console.log(payload);
+        if (payload.msgType == "playSound") soundboard.playSound(payload.trackNr,payload.src,payload.play,payload.repeat,payload.volume);  
+        else if (game.user.isGM && payload.msgType == "playPlaylist") {
+            const playlist = playlistControl.getPlaylist(payload.playlistNr);
+            playlistControl.playPlaylist(playlist,payload.playlistNr);
+        }
+        else if (game.user.isGM && payload.msgType == "playTrack") {
+            const playlist = playlistControl.getPlaylist(payload.playlistNr);
+            const sounds = playlist.data.sounds;
+            for (let track of sounds)
+                if (track._id == payload.trackId)
+                    playlistControl.playTrack(track,playlist,payload.playlistNr)
+        }
+        else if (game.user.isGM && payload.msgType == "stopAllPlaylists")
+            playlistControl.stopAll(payload.force);
+        else if (game.user.isGM && payload.msgType == "soundboardUpdate") {
+            await game.settings.set(moduleName,'soundboardSettings',payload.settings);
+            const payloadNew = {
+                "msgType": "soundboardRefresh"
+            };
+            game.socket.emit(`module.MaterialDeck`, payloadNew);
+        }
+        else if (game.user.isGM == false && payload.msgType == "soundboardRefresh" && enableModule)
+            soundboard.updateAll();
+        else if (game.user.isGM && payload.msgType == "macroboardUpdate") {
+            await game.settings.set(moduleName,'macroSettings',payload.settings);
+            const payloadNew = {
+                "msgType": "macroboardRefresh"
+            };
+            game.socket.emit(`module.MaterialDeck`, payloadNew);
+        }
+        else if (game.user.isGM == false && payload.msgType == "macroboardRefresh" && enableModule)
+            macroControl.updateAll();
+        else if (game.user.isGM && payload.msgType == "playlistUpdate") {
+            await game.settings.set(moduleName,'playlists',payload.settings);
+            const payloadNew = {
+                "msgType": "playlistRefresh"
+            };
+            game.socket.emit(`module.MaterialDeck`, payloadNew);
+        }
+        else if (game.user.isGM == false && payload.msgType == "playlistRefresh" && enableModule)
+            playlistControl.updateAll();
             
+    });
+
+    if (game.user.isGM) {
         let soundBoardSettings = game.settings.get(moduleName,'soundboardSettings');
         let macroSettings = game.settings.get(moduleName, 'macroSettings');
         let array = [];
@@ -223,8 +364,8 @@ Hooks.once('ready', ()=>{
                 color: arrayZero
             });
         }
-    if (soundBoardSettings.colorOff == undefined){
-        game.settings.set(moduleName,'soundboardSettings',{
+    
+        const settings = {
             playlist: "",
             sounds: array,
             colorOn: arrayZero,
@@ -232,64 +373,92 @@ Hooks.once('ready', ()=>{
             mode: arrayZero,
             toggle: arrayZero,
             volume: arrayVolume
+        };
+        if (soundBoardSettings.colorOff == undefined){
+            game.settings.set(moduleName,'soundboardSettings',settings);
+        }
+    }
+
+    if (enableModule == false) return;
+    if (getPermission('ENABLE') == false) {
+        ready = true;
+        return;
+    }
+
+    startWebsocket();
+
+    const hotbarUsesTemp = game.modules.get("illandril-hotbar-uses");
+    if (hotbarUsesTemp != undefined) hotbarUses = true;
 });
-    }
-    
-});
-
-export function playTrack(soundNr,src,play,repeat,volume){
-    if (play){
-        volume *= game.settings.get("core", "globalInterfaceVolume");
-
-        let howl = new Howl({src, volume, loop: repeat, onend: (id)=>{
-            if (repeat == false){
-                activeSounds[soundNr] = false;
-            }
-        },
-        onstop: (id)=>{
-            activeSounds[soundNr] = false;
-        }});
-        howl.play();
-        activeSounds[soundNr] = howl;
-   }
-   else {
-        activeSounds[soundNr].stop();
-        activeSounds[soundNr] = false;
-   }
-}
 
 Hooks.on('updateToken',(scene,token)=>{
     if (enableModule == false || ready == false) return;
     let tokenId = token._id;
-    if (tokenId == selectedTokenId)
-        tokenControl.update(selectedTokenId);
+    if (tokenId == canvas.tokens.controlled[0]?.id) tokenControl.update(canvas.tokens.controlled[0]?.id);
+    if (macroControl != undefined) macroControl.updateAll();
+});
+
+Hooks.on('updateActor',(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 == canvas.tokens.controlled[0]?.id) {
+                tokenControl.update(canvas.tokens.controlled[0]?.id);
+            }
+                
+        }
+    }
+    if (macroControl != undefined) macroControl.updateAll();
 });
 
 Hooks.on('controlToken',(token,controlled)=>{
     if (enableModule == false || ready == false) return;
     if (controlled) {
-        selectedTokenId = token.data._id;
+        tokenControl.update(token.data._id);
+        if (controlTokenTimer != undefined) {
+            clearTimeout(controlTokenTimer);
+            controlTokenTimer = undefined;
+        }
     }
     else {
-        selectedTokenId = undefined;
+        controlTokenTimer = setTimeout(function(){tokenControl.update(canvas.tokens.controlled[0]?.id);},10)
     }
-    tokenControl.update(selectedTokenId);
+    
+    if (macroControl != undefined) macroControl.updateAll();
 });
 
+Hooks.on('updateOwnedItem',()=>{
+    if (macroControl != undefined) macroControl.updateAll();
+})
+
 Hooks.on('renderHotbar', (hotbar)=>{
     if (enableModule == false || ready == false) return;
-    macroControl.hotbar(hotbar.macros);
+    if (macroControl != undefined) macroControl.hotbar(hotbar.macros);
+});
+
+Hooks.on('render', (app)=>{
+    if (enableModule == false || ready == false) return;
+    if (compatibleCore("0.8.1") == false) return;
+    if (app.id == "hotbar" && macroControl != undefined)  macroControl.hotbar(app.macros);
+    
 });
 
 Hooks.on('renderCombatTracker',()=>{
     if (enableModule == false || ready == false) return;
-    combatTracker.updateAll();
-    tokenControl.update(selectedTokenId);
+    if (combatTracker != undefined) combatTracker.updateAll();
+    if (tokenControl != undefined) tokenControl.update(canvas.tokens.controlled[0]?.id);
+});
+
+Hooks.on('renderActorSheet',()=>{
+    if (enableModule == false || ready == false) return;
+    if (tokenControl != undefined) tokenControl.update();
 });
 
 Hooks.on('renderPlaylistDirectory', (playlistDirectory)=>{
     if (enableModule == false || ready == false) return;
-    playlistControl.updateAll();
+    if (playlistControl != undefined) playlistControl.updateAll();
 });
 
 Hooks.on('closeplaylistConfigForm', (form)=>{
@@ -303,24 +472,49 @@ Hooks.on('pauseGame',()=>{
     otherControls.updateAll();
 });
 
-Hooks.on('renderSidebarTab',()=>{
+Hooks.on('renderSidebarTab',(app)=>{
+    const options = {
+        sidebarTab: app.tabName,
+        renderPopout: app.popOut
+    }
     if (enableModule == false || ready == false) return;
-    otherControls.updateAll();
+    if (otherControls != undefined) otherControls.updateAll(options);
+    if (sceneControl != undefined) sceneControl.updateAll();
+    if (document.getElementsByClassName("roll-type-select")[0] != undefined)
+        document.getElementsByClassName("roll-type-select")[0].addEventListener('change',function(){
+            if (otherControls != undefined) otherControls.updateAll(options);
+        })
+});
+
+Hooks.on('closeSidebarTab',(app)=>{
+    const options = {
+        sidebarTab: app.tabName,
+        renderPopout: false
+    }
+    if (otherControls != undefined) otherControls.updateAll(options);
+});
+
+Hooks.on('changeSidebarTab',()=>{
+    if (enableModule == false || ready == false) return;
+    if (otherControls != undefined) otherControls.updateAll();
 });
 
 Hooks.on('updateScene',()=>{
     if (enableModule == false || ready == false) return;
+    sceneControl.updateAll();
+    externalModules.updateAll();
     otherControls.updateAll();
 });
 
 Hooks.on('renderSceneControls',()=>{
-    if (enableModule == false || ready == false) return;
+    if (enableModule == false || ready == false || otherControls == undefined) return;
     otherControls.updateAll();
+    externalModules.updateAll();
 });
 
 Hooks.on('targetToken',(user,token,targeted)=>{
     if (enableModule == false || ready == false) return;
-    if (token.id == selectedTokenId) tokenControl.update(selectedTokenId);
+    if (token.id == canvas.tokens.controlled[0]?.id) tokenControl.update(canvas.tokens.controlled[0]?.id);
 });
 
 Hooks.on('sidebarCollapse',()=>{
@@ -338,79 +532,66 @@ Hooks.on('closeCompendium',()=>{
     otherControls.updateAll();
 });
 
-Hooks.on('renderJournalSheet',()=>{
+Hooks.on('renderCompendiumBrowser',()=>{
     if (enableModule == false || ready == false) return;
-    otherControls.updateAll();
+    otherControls.updateAll({renderCompendiumBrowser:true});
 });
 
-Hooks.on('closeJournalSheet',()=>{
+Hooks.on('closeCompendiumBrowser',()=>{
     if (enableModule == false || ready == false) return;
-    otherControls.updateAll();
+    otherControls.updateAll({renderCompendiumBrowser:false});
 });
 
+Hooks.on('renderJournalSheet',(sheet)=>{
+    if (enableModule == false || ready == false) return;
+    otherControls.updateAll({
+        hook:'renderJournalSheet',
+        sheet:sheet
+    });
+});
+
+Hooks.on('closeJournalSheet',(sheet)=>{
+    if (enableModule == false || ready == false) return;
+    otherControls.updateAll({
+        hook:'closeJournalSheet',
+        sheet:sheet
+    });
+});
+
+Hooks.on('gmScreenOpenClose',(html,isOpen)=>{
+    if (enableModule == false || ready == false) return;
+    externalModules.updateAll({gmScreen:isOpen});
+});
+
+Hooks.on('ShareVision', ()=>{
+    if (enableModule == false || ready == false) return;
+    externalModules.updateAll();
+})
+
+Hooks.on('NotYourTurn', ()=>{
+    if (enableModule == false || ready == false) return;
+    externalModules.updateAll();
+})
+
+Hooks.on('pseudoclockSet', ()=>{
+    if (enableModule == false || ready == false) return;
+    externalModules.updateAll();
+})
+
+Hooks.on('about-time.clockRunningStatus', ()=>{
+    if (enableModule == false || ready == false) return;
+    externalModules.updateAll();
+})
+
 Hooks.once('init', ()=>{
     //CONFIG.debug.hooks = true;
-    registerSettings(); //in ./src/settings.js
+    //registerSettings(); //in ./src/settings.js
 });
 
 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;
-}
+Hooks.on("soundscape", (data) => {
+    externalModules.newSoundscapeData(data);
+});

README.md

@@ -1,8 +1,62 @@
-# 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>
+  <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 +64,34 @@ 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.9 - 0.9<br>
+<b>Module Incompatibilities:</b> None known.<br>
+
+## Developer Guide
+See the [developer guide](./DEVGUIDE.md) for a guide on how to add new systems to `MaterialDeck`.
+
+## 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,428 @@
 # Changelog Material Deck Module
-### v0.8.7 - 19-11-2020
+### v1.4.7 - 20-12-2021
+Fixes:
+<ul>
+<li>External Modules => GM Screen: Changed to new api (thanks to akrigline)</li>
+<li>Fixed an issue where SDs would not iterate properly, causing errors (thanks to InnerGI)</li>
+<li>Fixed support for FXMaster. Requires FXMaster v2.0.0 or later (not officially released yet)</li>
+</ul>
+
+Additions:
+<ul>
+<li>Added compatibility for Foundry V0.9</li>
+<li>Added Forbidden Lands system (thanks to JackDCondon)</li>
+<li>Other Controls => Control Buttons: Added offset for 'Displayed Controls' and 'Displayed Tools'</li>
+<li>Added 'Device Configuration' to the module settings. You can use this to configure specific SD devices to not connect to a client</li>
+<li>Playlist Action => Added option to play next or previous track</li>
+</ul>
+
+### v1.4.6 - 07-09-2021
+Fixes:
+<ul>
+<li>Token Action => Move token: If the user is not the GM, tokens can no longer move if game is paused, and they can no longer move through walls</li>
+<li>Modifications made in the Property Inspector now immediately get saved, instead of when user deselects the setting (changed 'onchange' to 'oninput' event)</li>
+</ul>
+
+Additions:
+<ul>
+<li>Playlist Action: Added a 'Pause All' option</li>
+</ul>
+
+Other:
+<ul>
+<li>PF2E compatibility updated (thanks @kyamsil)</li>
+</ul>
+
+### v1.4.5 - 27-07-2021
+Fixes:
+<ul>
+<li>Combat Tracker Action => Turn Display: If only 'Display Round' was enabled, the vertical alignment would be off. This has been fixed.</li>
+<li>WebSocket client no longer creates duplicate connections</li>
+<li>Token Action => If 'Display Uses/Quantity' is enabled for an item that has no maximum uses/quantity, the uses/quantity border is now consistently black.</li>
+<li>Update dialog that appears if the SD plugin needs to be updated now only appears once</li>
+</ul>
+
+Additions:
+<ul>
+<li>External Modules: Added support for the Soundscape module. Requires Soundscape v1.0.3</li>
+<li>Macro Action => Advanced Macros is now supported for calling macros with arguments</li>
+<li>Combat Tracker Action => Function: Added option to select the combatant after changing the turn</li>
+<li>Other Actions => Added 'Set Roll Mode' which sets the roll mode for all rolls to public, private gm, blind gm or self roll</li>
+<li>Added support for wfrp4e (thanks to sozin#8622 & eccobold#3541)</li>
+<li>Added DEVGUIDE.md to help developers add support for new systems (thanks to sozin#8622 & eccobold#3541)</li>
+</ul>
+
+<br>
+<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.4.5 (<b>must be updated!</b>): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.4.4 - 26-05-2021
+Fixes:
+<ul>
+<li>Some small fixes to make the module compatible with Foundry 0.8.5</li>
+</ul>
+
+Additions:
+<ul>
+<li>Token Action => Added 'Page-Wide Token' option. All buttons on the current page (where the page is the collection of buttons that are shown) that have this enabled will use the same token</li>
+<li>Token Action => On Click: Added 'Set Page-Wide Token' option, so you can configure buttons to set the page-wide token by pressing a button</li>
+<li>Token Action: Added a 'Mode' select box. Setting it to 'Token' is the same as pre v1.4.4. New are the inventory, features and spellbook options that can be used to auto-populate buttons with items, features and spells.</li>
+<li>Added a 'Clear Page' and 'Clear All' button to the soundboard and macroboard configuration</li>
+<li>Added import and export buttons to the soundboard and macroboard configuration (only imports/exports metadata, not the actual audio files or the macros)</li>
+<li>The number of connection error messages you will get is now configurable in the module settings</li>
+<li>Added a download utility to the module settings, so you can easily version-check with the SD plugin and Material Server, download them and download profiles</li>
+<li>Added Japanese localization (thanks BrotherSharper and Asami). All of the new features have not yet been translated</li>
+</ul>
+
+Other:
+<ul>
+<li><b>(Breaking)</b> The Move Action has been removed. Moving tokens is not in the Token Action (it's an on click setting) and moving the canvas is in the Other Actions.</li>
+<li>Major change to the soundboard and macroboard configuration. It is now displayed as pages of 16 sounds or 32 macros each, you can browse through the pages using the arrow keys at the top.</li>
+<li>There is no longer a limit to the amount of sounds/macros you can assign to the soundboard/macroboard, but please note that at some point you might experience performance issues if there's too many sounds/macros.</li>
+<li>Removed the 'Stream Deck Model' module setting, since it's not that useful</li>
+<li>Token Action has been revamped to make it clearer and easier to implement new game systems</li>
+</ul>
+
+<br>
+<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.4.4 (<b>must be updated!</b>): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.4.3 - 05-05-2021
+Fixes:
+<ul>
+<li>Fixed issue where the module would break if multiple Stream Decks were configured in the Stream Deck application, but not all of them had MD actions assigned to them</li>
+<li>In the User Permission Configuration, the Scene Directory hint wasn't displayed properly</li>
+<li>Got rid of warnings that popped up on initialization when using MD as a player</li>
+<li>Fixed issue where the soundboard and macro board could not be configured by players, if it hadn't first been configured by a GM</li>
+</ul>
+
+Other
+<ul>
+<li>Added compatibility for Foundry 0.8.2. Some functions no longer work in 0.8.1 (they still do in 0.7.9)</li>
+</ul>
+
+<br>
+<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.4.2 (unchanged): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.4.2 - 23-04-2021
+Fixes:
+<ul>
+<li>Last update I fixed the combat tracker, but this broke something in the Token Action (if you had a token selected, it would sometimes assumed you didn't have it selected), both should now work</li>
+<li>Token Action: Plugin wouldn't save text boxes (such as 'Prepend Title' or 'Custom') if they were empty</li>
+<li>Token Action: Improved performance, especially when 'Token' is set to 'Selected Token', and you're selecting a new token while you had another token selected<li>
+<li>Token Action => Stats => Skill Modifier: (dnd5e) Would only display the modifier, now it displays the total value (so with proficiency, if applicable)</li>
+<li>Combat Tracker => Mode: Function => Function: Would not always properly load the 'Turn Display' options</li>
+<li>Playlist Action: Background color would not show, and 'Off Color' wouldn't work for 'Offset'</li>
+<li>Macro Action => Macro Board => Offset: Background color would not show</li>
+<li>Scene Action => Offset: Background color would not show</li>
+</ul>
+
+Additions:
+<ul>
+<li>Token Action: Changed the way how you can select what icon will be displayed. Instead of a true/false, there is now a selection box where you can select between 'None', 'Token Icon', 'Actor Icon' and 'Default', where the last one will display the default icon, for example the selected stat to display, the condition, etc</li>
+<li>Token Action => Stats & On Click => Custom: Textbox now automatically resizes to fit the content</li>
+<li>Token Action => On Click => Dice Roll: Added 'Roll Mode' option, where you can set to roll as 'default' (displays dialog), 'normal', 'advantage' or 'disadvantage'. All options, except for 'default', will ignore the previously added 'Token Roll Options' in 'Other Actions'</li>
+</ul>
+
+Other:
+<ul>
+<li>Big code cleanup of the SD plugin</li>
+</ul>
+
+<br>
+<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.4.2 (<b>must be updated!</b>): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.4.1 - 21-04-2021
+Fixes:
+<ul>
+<li>Previous update broke the combat tracker, should now be fixed</li>
+</ul>
+
+### v1.4.0 - 21-04-2021
+Additions:
+<ul>
+<li>Support for connecting multiple Stream Decks at the same time. Please note that performance decreases with each extra Stream Deck</li>
+<li>Other Actions: Added 'Token Roll Options'. This can toggle token rolls between showing a dialog and skipping the dialog and rolling normally or with advantage or disadvantage</li>
+<li>If the SD plugin version you're using is outdated, you now get a pop-up to notify you of this and direct you to the download page</li>
+<li>Added a module setting to set how dark the default white images should be. Can be lowered for improved readability of the text</li>
+<li>Token Action => Stats: Added option to prepend text to the title, so you can set the stat to, for example, strength, and put 'STR: ' in the prepend textbox to display, for example, 'STR: +2'</li>
+</ul>
+
+Fixes:
+<ul>
+<li>Token Action => Skill Roll: Setting wasn't saved in SD app</li>
+<li>Token Action => Roll Ability: Rolling ability checks was broken for some systems</li>
+<li>Token Action => Stats => Display HP: Read overlay indicating HP in the heart icon was also drawn when 'Display Token Icon' was enabled</li>
+<li>Token Action => Stats: Added default images for all dnd5e abilities, saves and skills</li>
+</ul>
+
+<br>
+<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.4.0 (<b>must be updated!</b>): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+
+### v1.3.3 - 12-04-2021
+Additions:
+<ul>
+<li>Other Actions => Open Sidebar Tab: Action now indicates which sidebar tab is open (only works on Foundry 0.8.x)</li>
+<li>Other Actions => Open Sidebar Tab: Added option to create an pop-out (doesn't work for the chat)</li>
+<li>Other Actions: Added option to open the pf2e compendium browser</li>
+<li>Macro Action: Can now call macros by name</li>
+<li>Token Action => On Click: Added option to call a macro. Currently the macro will be applied to the selected token</li>
+<li>Token Action => Display Stats: Added saving throws and skill modifiers for most systems</li>
+<li>Token Action => OnClick: Added 'Dice Roll' option, which allows you to roll ability checks, saving throws and other things (depending on game system)</li>
+<li>Token Action => Stats => Display HP: Made the heart icon dynamic, so the amount that the heart is filled with red depends on the relative amount of hit points of the token. 25% hp means the lower 25% of the heart is red, 50% hp means the lower 50% of the heart is red, etc</li>
+<li>Token Action => Stats => Added a '+' before all modifier stats that are bigger than 0</li>
+<li>Token Action => Custom OnClick: Added support for calling macros. For instructions, please refer to the documentation: https://github.com/CDeenen/MaterialDeck/wiki/Token-Action#custom-on-click-function</li>
+</ul>
+
+Fixes:
+<ul>
+<li>Other Actions => Pause Game: Pause is now transmitted to all connected clients</li>
+<li>Token Action => Display Stats: Fixed movement speed for pf2e</li>
+</ul>
+
+Other:
+<ul>
+<li>Should be compatible with Foundry 0.8.1. Only tested on DnD5e. Please note that any functions that rely on other modules do not work if the other modules are not compatible with 0.8.1</li>
+</ul>
+
+<br>
+<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.3.4 (<b>must be updated!</b>): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.3.2 - 11-03-2021
+Additions:
+<ul>
+<li>Added support for the Multi Action provided by the SD app</li>
+<li>External Modules Action => Added support for About Time</li>
+<li>Token Action => Stats: Added 'Ability Scores', 'Ability Score Modifiers', 'Ability Score Saves' (dnd5e only) and 'Proficiency Bonus'</li>
+<li>Token Action => Stats: Added 'HP (box)' option that displays a box with color that changes depending on the HP</li>
+<li>Move Action: You can now choose what token should be moved, similar to the Token Action</li>
+</ul>
+
+Fixes:
+<ul>
+<li>Playlist Action => Relative Offset: Fixed issue with displaying the target playlist name</li>
+<li>Macro Action: Fixed Hotbar Uses for Shadow of the Demonlord</li>
+</ul>
+
+Other:
+<ul>
+<li>Macro Action: Improved the way Hotbar Uses are displayed, it is now displayed in a box similar to how the module looks in Foundry</li>
+<li>Made the way images are generated more flexible to make future additions easier</li>
+</ul>
+
+<br>
+<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.3.2 (<b>must be updated!</b>): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.3.1 - 27-02-2021
+Additions:
+<ul>
+<li>Token Action: You can now choose what token should be targeted with the action using: 'Selected Token', 'Token Name', 'Actor Name', 'Token Id' or 'Actor Id'. Added relevant user permissions to the permission configuration</li>
+<li>Token Action => On Click: Added options 'Select Token' and 'Center on Token and Select Token'</li>
+<li>Playlist Action: Added relative offset mode, with the option to display the offset target name for playlists</li>
+<li>Playlist Action => Stop All: Added option to display the name of the playlist at the current offset</li>
+</ul>
+
+Fixes:
+<ul>
+<li>Default user permissions would not be loaded if no previously saved permissions were present, resulting in MD assuming nobody has any permissions</li>
+<li>Other Actions => Control Buttons => Lighting Controls: Would create a button for ambient sound instead of lighting</li>
+<li>Token Action => Display Token Icon: It used to show the icon, even if unchecked, if no stat with default icon was selected</li>
+</ul>
+
+<br>
+<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.3.1 (<b>must be updated!</b>): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.3.0 - 25-02-2021
+Additions:
+<ul>
+<li>Material Deck can now be used by players. A 'User Permission Configuration' screen has been added to the module settings where the GM can deside what Material Deck functions are available to users</li>
+<li>Macro Action: Added support for Illandril's Hotbar Uses (only requires the module to be installed, does not have to be active)</li>
+<li>Token Action => OnClick: Added support for CUB conditions</li>
+<li>External Modules => Added support for the 'Trigger Happy' module</li>
+<li>External Modules => Added support for the 'MookAI' module</li>
+<li>External Modules => Added support for the 'Shared Vision' module</li>
+<li>External Modules => Added support for the 'Lock View' module</li>
+<li>External Modules => Added support for the 'Not Your Turn' module</li>
+</ul>
+Fixes:
+<ul>
+<li>Token Action => OnClick: Fixed conditions for pf1e and dnd3.5e</li>
+</ul>
+Other Changes:
+<ul>
+<li>Token and Combat Tracker Actions now autodetect the game system</li>
+<li>Game-system related settings in the SD app unified and improved</li>
+<li>Image Cache setting is no longer considered experimental</li>
+</ul>
+
+<b>Note 1: </b>Because the module can now be used by players, some settings have been moved from 'world' settings to 'client' settings. This means that previous settings have been deleted, and they have to be set up again in the module settings.<br>
+<b>Note 2: </b>You can give users access to the playlists, macro board and soundboard. Currently, everyone has to share the same configuration, so be careful with giving players permission to configure one of them.<br>
+<b>Note 3: </b>Because of the new game system autodetection, some settings for non dnd5e systems might be deleted. You'll have to reconfigure them.<br>
+<br>
+<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.3.0 (<b>must be updated!</b>): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.2.3 - 03-02-2021
+Fixes:
+<ul>
+<li>Fixed some issues for the Shadow of the Demon Lord system</li>
+</ul>
+Other Changes:
+<ul>
+<li>Improved performance of the 'Playlist Configuration', 'Macro Configuration' and 'Soundboard Configuration' screens</li>
+<li>Minor code clean-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.2.2 (unchanged): https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.2.2 - 02-02-2021
+Additions:
+<ul>
+<li>Added a help button in the module configuration</li>
+<li>Token Action: Added support for easy token wildcard image changes</li>
+<li>Token Action: Added a comprehensive custom onClick function that can modify token and actor data, with support for basic mathematical expressions</li>
+</ul>
+Other Changes:
+<ul>
+<li>Improved GM screen 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.2.2: https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### v1.2.1 - 07-01-2021
+<b>Note:</b> Due to a change in how scene control is handled (moved from 'Other Controls' to its own 'Scene Action'), any actions related to scenes no longer work. You will have to set them up again using the new Scene Action.<br>
+<br>
+Additions:
+<ul>
+<li>EXPERIMENTAL: Added an image buffer to prevent resending of images that have already been sent, giving a slight performance boost. Buffer size can be set in the module settings</li>
+<li>Token Action => Display Stats: Added option to select a data path for an attribute</li>
+<li>External Modules => GM Screen: Open and close the GM screen. Link to module: https://foundryvtt.com/packages/gm-screen/</li>
+<li>Other Actions => Roll dice: Roll dice in foundry and select between public roll, private roll, or displaying result on the SD</li>
+<li>Scene Action: Added way to create scene selection screen similar to soundboard/macro board. New functions to do this: 'Scene Directory' and 'Scene Offset'</li>
+<li>Scene Action: Added 'Active Scene' function</li>
+<li>Move Action => Selected Token: Added rotate to and rotate by functions</li>
+<li>Token Action => On Click: Added 'Set Vision' option to set the token's vision and light emission</li>
+<li>Other Actions => Send Chat Message: Send a message to the Foundry chat</li>
+</ul>
+Other Changes:
+<ul>
+<li>Plugin: Scene Action created that replaces Other Actions => Scene Selection</li>
+<li>Plugin: Scene Action: Changed 'Any Scene' to 'Scene by Name'</li>
+<li>Plugin: Actions are now ordered alphabetically</li>
+<li>Plugin: Replaced color strings with color pickers</li>
+<li>Various minor bug fixes</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.2.1: https://github.com/CDeenen/MaterialDeck_SD/releases<br>
+
+### 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,3 @@
+center.png: made by me.
+rotatecw.png & rotateccw.png Edited from https://fontawesome.com/icons/sync-alt?style=solid.
+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,3 @@
+other.png: Made using https://www.elgato.com/en/gaming/keycreator
+cogs.png: Edited from https://fontawesome.com/icons/cogs?style=solid
+d20.png: Edited from https://game-icons.net/1x1/delapouite/dice-twenty-faces-twenty.html

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,3 @@
+play.png: Edited from https://fontawesome.com/icons/play?style=solid
+stop.png: Edited from https://fontawesome.com/icons/stop?style=solid
+pause.png: Edited from https://fontawesome.com/v5.15/icons/pause?style=solid