Updated Soundboard Actions (markdown)

Soundboard-Actions.md

@@ -1 +1,90 @@
-To be written
+With the Soundboard action you can trigger specific sounds to be played, which is great for sound effects, such as explosions, clashing swords, or for creating sonic ambiences. 
+
+# Module Configuration
+You need to set up the soundboard in Foundry. This is done in the Foundry [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup). At the top you will find the 'Soundboard Configuration' button. Clicking it opens the configuration screen, as shown below.
+
+At the top right you have to select the playlist from which you want to play the sounds. In the image below you can see that I have a dedicated 'Soundboard' playlist. You can add sounds to that playlist using the normal methods provided by Foundry.
+
+The screen is divided into a number of boxes, each labeled 'Sound #', where each represents a single sound and its settings. The number of sounds you can see depends on what Stream Deck model you've set up in the module configuration.
+
+For each sound there are 7 options:
+
+### Name
+The name of the sound, this is the name that will be displayed on the SD button if 'Display Name' is selected in the property inspector. This name doesn't have to correspond with the file name of the sound, or the name that can be seen in the Foundry playlist.
+
+### Sound Selection
+This is a drop-down menu, where you can select a sound from the selected playlist.
+
+### Icon
+Here you can select an icon that will be displayed on the SD button if 'Display Icon' is selected in the property inspector.<br>
+Please read [these](https://github.com/CDeenen/MaterialDeck/wiki/Getting-Started#important-notes-on-foundry-assigned-text-and-icons) notes on rules regarding icon selection.
+
+### On Color
+Clicking the colored box you'll be presented with a color picker. This sets the color of the ring that's shown on the button when the sound is playing.
+
+### Off Color
+Clicking the colored box you'll be presented with a color picker. This sets the color of the ring that's shown on the button when the sound is not playing.
+
+### Playback
+This sets the playback mode, you can select from:
+* Once - Play the sound once
+* Repeat - Play the sound on repeat
+* Hold - Play the sound as long as the button is held down
+
+### Volume
+The playback volume
+
+![](https://github.com/CDeenen/MaterialDeck/blob/Master/wiki/img/SoundboardConfig.png)
+
+# Stream Deck Configuration
+## Mode
+Select the mode of the button
+* Play Sound - Play (or stop) the selected sound
+* Offset - Pressing this button offsets the sound number for easy switching between visible sounds
+* Stop All Sounds - Stops all currently playing sounds
+
+## Mode: Play Sound
+Play or stop the selected sound
+
+#### Display Name
+Toggles whether or not the button should display the sound's name, as set in the 'Soundboard Configuration'.
+
+#### Display Icon
+Toggles whether or not the button should display the sound's icon, as set in the 'Soundboard Configuration'.
+
+#### Sound Number
+The sound to play. The number corresponds with the number in the 'Soundboard Configuration'
+
+#### Background
+Sets the background color of the button. The icon needs to have transparent parts (so no jpeg).<br>
+You set the color using hexadecimal values, and it must start with '#'.<br>
+You could use a [color picker](https://htmlcolorcodes.com/color-picker/) to find the right hex value.
+
+## Mode: Offset
+With offset you can give the sound number an offset allowing easy switching between displaying different sounds. 
+
+#### Offset
+Sets the amount the sound number needs to be offset when the button is pressed
+
+#### On Color
+Sets the color of the ring that's shown on the button when the offset is set to the value set in the offset box.<br>
+You set the color using hexadecimal values, and it must start with '#'.<br>
+You could use a [color picker](https://htmlcolorcodes.com/color-picker/) to find the right hex value.
+
+#### Off Color
+Sets the color of the ring that's shown on the button when the offset is set to the value set in the offset box.<br>
+You set the color using hexadecimal values, and it must start with '#'.<br>
+You could use a [color picker](https://htmlcolorcodes.com/color-picker/) to find the right hex value.
+
+#### Background
+Sets the background color of the button. The icon needs to have transparent parts (so no jpeg).<br>
+You set the color using hexadecimal values, and it must start with '#'.<br>
+You could use a [color picker](https://htmlcolorcodes.com/color-picker/) to find the right hex value.
+
+## Mode: Stop All Sounds
+Pressing this will stop all currently playing sounds
+
+#### Background
+Sets the background color of the button. The icon needs to have transparent parts (so no jpeg).<br>
+You set the color using hexadecimal values, and it must start with '#'.<br>
+You could use a [color picker](https://htmlcolorcodes.com/color-picker/) to find the right hex value.