Updated Macro Actions (markdown)
@@ -1 +1,71 @@
|
|||||||
To be written
|
The Macro action allows you to trigger macros. <br>
|
||||||
|
See the image below for an example on how to set up a hotkey macros in a token control screen. It has been taken from the provided example XL profile.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Only the lower left section of the screen is set using the Macro action, the others are set with the Token and Move actions.
|
||||||
|
|
||||||
|
# Module Configuration
|
||||||
|
When using the 'Macro Board' mode, you need to set up the macro board 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 'Macro Configuration' button. Clicking it opens the configuration screen, as shown below.
|
||||||
|
|
||||||
|
The screen is divided into a number of boxes, each labeled 'Macro #', where each represents a single macro and its settings. The number of macros you can see depends on what Stream Deck model you've set up in the module configuration.
|
||||||
|
|
||||||
|
For each macro there are 3 options: Macro selection, furnace arguments (only if 'the Furnace' is installed) and background.
|
||||||
|
|
||||||
|
### Macro Selection
|
||||||
|
This is a drop-down menu, where you can select a macro from your macro directory (which you can find by pressing the 'file' icon to the left of your macro hotbar).
|
||||||
|
|
||||||
|
### Furnace Arguments
|
||||||
|
This function is only available if you have [the Furnace](https://foundryvtt.com/packages/furnace/) installed.<br>
|
||||||
|
Here you can fill in any arguments that you could use with 'the Furnace' Please read the documentation regarding [advanced macros](https://github.com/kakaroto/fvtt-module-furnace#advanced-macros).<br>
|
||||||
|
If, for example, you wanted to execute a macro named 'My Macro' with the arguments 'argument1 argument2 argument3', you would use for example `/"My Macro" 100 50 "test"` in the chat. In the macro configuration screen you would only fill in the arguments, so: `100 50 "test"`.
|
||||||
|
|
||||||
|
### Background Color
|
||||||
|
Clicking the colored box you'll be presented with a color picker. Selecting a color will set that color as the background color for the button.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
# Stream Deck Configuration
|
||||||
|
## Mode
|
||||||
|
Select the mode of the button
|
||||||
|
* Hotbar - Execute macros from the hotbar
|
||||||
|
* Visible Hotbar - Execute macros from the macros that are currently visible in the hotbar
|
||||||
|
* Macro Board - Execute a macro as set in the 'Macro Configuration' in the module settings
|
||||||
|
|
||||||
|
## Mode: Hotbar/Visible Hotbar
|
||||||
|
At the bottom of the Foundry screen there is a hotbar, where you can place macros. Using the 'hotbar' or 'visible hotbar' mode you can execute one of these macros. The difference between these modes is that when you select the macro by number, in the 'hotbar' mode, the button will execute the macro at that number regardless of which macros are currently shown on screen. So the macro you execute doesn't change when you scroll through the different hotbar pages. In the 'visible hotbar' mode, the macro you execute is the one that is currently visible, so it does change when you scroll through the hotbar pages.
|
||||||
|
|
||||||
|
#### Display Name
|
||||||
|
Toggles whether or not the button should display the token's name
|
||||||
|
|
||||||
|
#### Macro Number
|
||||||
|
The macro to execute. In 'hotbar' mode, this is a value between 1 and 50. In 'visible hotbar' this is a value between 1 and 10. 10 corresponds with the macro at location 0 in the Foundry hotbar.
|
||||||
|
|
||||||
|
#### Background
|
||||||
|
Sets the background color of the button
|
||||||
|
|
||||||
|
## Mode: Macro Board
|
||||||
|
|
||||||
|
### Type: Trigger Macro
|
||||||
|
Trigger a macro from the macro board, as set in the Macro Configuration screen (see above).
|
||||||
|
|
||||||
|
#### Display Name
|
||||||
|
Toggles whether or not the button should display the token's name
|
||||||
|
|
||||||
|
#### Macro Number
|
||||||
|
The macro to execute. The number corresponds with the macro number in the Macro Configuration
|
||||||
|
|
||||||
|
### Type: Offset
|
||||||
|
With offset you can give the macro number an offset allowing easy switching between displaying different macros.
|
||||||
|
|
||||||
|
#### Offset
|
||||||
|
Sets the amount the macro 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
|
||||||
|
|
||||||
|
#### 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
|
||||||
|
|||||||
Reference in New Issue
Block a user