From 4276e0cf18f183c76b41879242f1290c4a159a9b Mon Sep 17 00:00:00 2001 From: CDeenen <68693756+CDeenen@users.noreply.github.com> Date: Sun, 11 Apr 2021 22:14:55 +0200 Subject: [PATCH] Updated Getting Started (markdown) --- Getting-Started.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Getting-Started.md b/Getting-Started.md index 0ad3bd6..627af71 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -4,10 +4,10 @@ Communication between Foundry and the SD goes through websockets. Websocket is a
In the SD software, you are able to assign actions to the SD buttons. The actions for MD are provided by the plugin, which, when installed, show up on the right side, under the Material Deck category. You can drag one of these actions to a specific SD button. Selecting the button in the software opens the property inspector (PI) in the lower left part of the SD software, which will load the configuration for the selected action (loading the configuration can take some time, so please be patient). Using this configuration you can configure the button to do what you want. Details on how to configure the various MD actions can be found [here](https://github.com/CDeenen/MaterialDeck/wiki#instructions).

-Once everything is installed, and the server is running, the communication goes as follows: --If, in the SD software, a new action is assigned, an action is removed, an action is moved to a different key, or a configuration is changed, the SD sends a message to Foundry. Foundry has a buffer that stores the data for each button that has been assigned in the SD software. This buffer is updated with the new information. Foundry also checks if data needs to be send back to the SD, for example images, text, or background colors. If so, it will send this data, and the SD updates the button. --If a SD button is pressed, the SD sends a message to Foundry, specifying a keyUp or keyDown event, and the selected action. Foundry then performs the required action. --If things change in Foundry (such as the initative order, a token's icon or name, etc), Foundry checks the buffer if there is a relevant action assigned to a SD button. If so, it will send the newly updated data to the SD, which then updates the button. +Once everything is installed, and the server is running, the communication goes as follows:
+-If, in the SD software, a new action is assigned, an action is removed, an action is moved to a different key, or a configuration is changed, the SD sends a message to Foundry. Foundry has a buffer that stores the data for each button that has been assigned in the SD software. This buffer is updated with the new information. Foundry also checks if data needs to be send back to the SD, for example images, text, or background colors. If so, it will send this data, and the SD updates the button.
+-If a SD button is pressed, the SD sends a message to Foundry, specifying a keyUp or keyDown event, and the selected action. Foundry then performs the required action.
+-If things change in Foundry (such as the initative order, a token's icon or name, etc), Foundry checks the buffer if there is a relevant action assigned to a SD button. If so, it will send the newly updated data to the SD, which then updates the button.
# Basic Stream Deck Setup Instructions With everything [installed](https://github.com/CDeenen/MaterialDeck/wiki/Installation), you can start assigning actions to SD buttons. The actions for MD are provided by the plugin, which, when installed, show up on the right side of the SD software, under the Material Deck category. You can drag one of these actions to a specific SD button. Selecting the button in the software opens the property inspector (PI) in the lower left part of the SD software, which will load the configuration for the selected action (loading the configuration can take some time, so please be patient). Using this configuration you can configure the button to do what you want. Details on how to configure the various MD actions can be found [here](https://github.com/CDeenen/MaterialDeck/wiki#instructions).