Updated Combat Tracker Actions (markdown)

Combat-Tracker-Actions.md

@@ -1 +1,64 @@
-To be written
+The Combat Tracker action has function to control the combat, and display Foundry's combat tracker
+
+## Mode
+Select the mode of the action:
+* Combatants - Display information of combatants in the combat tracker
+* Current Turn's Combatant - Display information on the combatant whose turn it is right now
+* Function - Control the combat turns and rounds
+
+## Mode: Combatants & Current Turn's Combatant
+Display information of combatants in the combat tracker. When the mode is set to 'Combatants', a yellow ring will be displayed around the token whose turn it is.
+
+### Display Name
+Toggles whether or not the button should display the token's name
+
+### Display Icon
+Toggles whether or not the button should display the token's icon
+
+### Stats
+You can select a stat to be displayed on the button (under the name, if 'Display Name' is selected).<br>
+You can choose between the following stats (currently only dnd5e is supported):
+* Hit points
+* Armor class
+* Movement speed
+* Initiative
+
+Each of these have their own default icon (heart for HP, shield for AC, etc) that will be displayed if 'Display Icon' is deselected.
+
+### On Click
+Determines what Foundry should do when you press the button:
+* Do Nothing - Does nothing
+* Center on Token - Centers the view on the selected token
+* Open Character Sheet - Opens the token's character sheet
+* Open Token Config - Opens the token's configuration screen
+
+### Combatant Nr - Combatants Mode Only
+Set the number in the combat tracker of the token you want to display. So the first token in the combat tracker would be nr 1, the second nr 2, etc
+
+### Background
+Sets the background color. 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: Function
+Gives the button a function to control the combat tracker
+
+### Function: Start/Stop Combat
+Pressing the button will start or stop the combat, depending on the current state of the combat. The icon and background will change to indicate the state:
+* No combat & no combatants: 'Play' icon, black background. Pressing button does nothing
+* No combat & combatants in tracker: 'Play' icon, green background. Pressing button starts the combat
+* Combat: 'Stop' icon, red background. Pressing button stops the combat
+
+### Function: Turn Display
+Displays the current combat round and turn
+
+### Other functions
+* Next Turn - Press to go to the next turn
+* Previous Turn - Press to go to the previous turn
+* Next Round - Press to go to the next round
+* Previous Round - Press to go to the previous round
+
+### Background
+Sets the background color. 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.