Updated Playlist Actions (markdown)

Playlist-Actions.md

@@ -1 +1,84 @@
-To be written
+With the Playlist action you can control the built-in Foundry playlist function. It allows you to play or stop playlists or tracks, and shows which playlists or tracks are currently playing (from a set of playlists you've selected).<br>
+See the image below for an example on how to set up a playlist control screen. It has been taken from the provided example XL profile.
+
+![](https://github.com/CDeenen/MaterialDeck/blob/Master/wiki/img/PlaylistControl.png)
+
+Button functions in the image: Top row, from left to right:
+* 1 Back - Exits this folder to go back to the home page of the profile
+* 2 Mode: Stop All - Stops all tracks and playlists
+* 3-5 Mode: Playlist, Type: Offset - Offsets the playlist number, allowing easy switching between different playlists
+* 6-8 Mode: Track, Type: Offset - Offsets the track number, allowing easy switching between different tracks
+
+Other rows show 3 different playlists (1 per row):
+* 1 Mode: Playlist, Type: Play/Stop - Play or stop the selected playlist
+* 2-8 Mode: Track, Type: Play/Stop - Play or stop the selected track
+
+# Module Configuration
+You need to configure the playlist control in the Foundry [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup). At the top you will find the 'Playlist Configuration' button. Clicking it opens the configuration screen, as shown below.
+
+There are 2 sections: 'Play Method', and 'Playlists'.
+
+### Play Method
+The play method determines what to do when a track is playing, while another track is requested. By setting it to 'Unrestricted', you can play as many tracks at the same time as you want. Setting it to 'One track per playlist' will automatically stop all playing tracks in the playlist, ensuring that only one track is playing at a time. Setting 'Play Method' to 'One track in total' will limit playback to only one track in total.<br>
+<br>
+Options:
+* Unrestricted - Play as many tracks at the same time as you want
+* One track per playlist - Play only one track per playlist. Trying to start a second track will stop the other tracks in the playlist
+* One track in total - Play only one track in total. Trying to start a second track will stop all other tracks that are playing
+
+**Note:** This play method only applies if tracks are started using the Stream Deck, you can still play more tracks using Foundry's internal audio player.
+
+### Playlists
+Here you can select which playlists can be controlled with the module. You can select up to 9 playlists, where the playlist number corresponds with the number you have to fill in in the property inspector.
+
+![](https://github.com/CDeenen/MaterialDeck/blob/Master/wiki/img/PlaylistConfig.png)
+
+
+# Stream Deck Configuration
+## Mode
+Select the mode of the button
+* Playlist - Control playlists
+* Track - Control tracks
+* Stop All - Stop all playlists and tracks
+
+## Mode: Playlist/Track
+The playlist and track mode are very similar, the only difference is that one controls playlists, while the other controls tracks. Setup is the same for both.
+
+### Type: Play/Stop
+Play or stop a playlist/track.
+
+#### Display Name
+Toggles whether or not the button should display the token's name
+
+#### Playlist/Track Nr
+Sets the playlist or track number to control with this button. The playlist number corresponds with the number in the 'Playlist Configuration' in the module settings, the track number corresponds with the order of the track in the playlist (as seen in Foundry's playlist).
+
+#### On Color
+Sets the color of the ring that's shown on the button when the playlist/track is playing
+
+#### Off Color
+Sets the color of the ring that's shown on the button when the playlist/track is not playing
+
+#### Background
+Sets the background color of the button
+
+### Type: Offset
+With offset you can give the playlist or track number an offset allowing easy switching between displaying different playlists/tracks. For example, in the (topmost) image above, the playlist offset is set to 0, 3, and 6 for the 3 offset buttons respectively (left to right).
+
+#### Offset
+Sets the amount the playlist/track 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
+
+#### 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
+
+#### Background
+Sets the background color of the button
+
+## Mode: Stop All
+Stops all tracks and playlists
+
+#### Background
+Sets the background color of the button