External Modules Action
This action allows you to control other modules.
The following modules are supported:
- FXMaster
- Lock View
- Monk's Active Tile Triggers
- Not Your Turn!
- Shared Vision
- Simple Calendar
- Soundscape
External Module Combatibility Issues
The functionality of the 'External Modules' action depends on (the API of) the supported modules.
This means that if one of the modules is updated and changes its API, Material Deck's functionality might break.
This is also the case if Foundry gets a major update, and the supported module has not been updated.
| Option | Description |
|---|---|
| Title | If configured, will set the title/text on the button. This will override any other text that would normally be displayed. |
| Icon Override | Url to a custom icon. If configured, this will override any icon that would normally be displayed. |
| Module | Module to control |
FXMaster
FXMaster can display effects, such as weather effects, filters or special effects.
Using Material Deck you can enable or disable these effects.
| Option | Description |
|---|---|
| Mode | Mode of the button: -Special Effects: Trigger special effects. -Particle Effects: Enable or disable particle effects. -Filter Effects: Enable or disable filter effects. -Clear All: Clear all effects. |
Special Effects
Special effects are effects that are displayed on the canvas, for example explosions or spell effects.
| Option | Description |
|---|---|
| Effect | Effect to trigger |
| Target | Target of the effect: -Cursor: Place effect at the mouser cursor. -Selected Token: Place effect on the selected token. -Targeted Token: Place effect on the targeted token. -From Cursor to Selected Token: Animate effect from the mouse cursor to the selected token. -From Cursor to Targeted Token: Animate effect from the mouse cursor to the targeted token. -From Selected to Targeted Token: Animate effect from the selected to the targeted token. -From Targeted to Selected Token: Animate effect from the targeted to the selected token. |
| Display | -Name: Display the effect's name on the Stream Deck. |
| Colors | -Background: Background color of the button. |
Particle Effects
Particle effects are effects that are displayed across the entire scene, such as weather effects.
| Option | Description |
|---|---|
| Effect | Effect to trigger |
| Effect Options | Effect options will depend on the effect, see here for more info. |
| Display | -Name: Display the effect's name on the Stream Deck. -Icon: Display the effect's icon on the Stream Deck. |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the effect is currently active -Off Color: A border is drawn on the Stream Deck of this color if the effect is currently not active -Background: Background color of the button. |
Filter Effects
Similar to 'Particle Effects', filter effects are displayed across the entire scene but function as a filter.
| Option | Description |
|---|---|
| Effect | Effect to trigger |
| Effect Options | Effect options will depend on the effect, see here for more info. |
| Display | -Name: Display the effect's name on the Stream Deck. -Icon: Display the effect's icon on the Stream Deck. |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the effect is currently active -Off Color: A border is drawn on the Stream Deck of this color if the effect is currently not active -Background: Background color of the button. |
Lock View
Lock View gives the GM control over the zoom and pan capabilities of the player.
Using Material Deck you can enable or disable Pan Lock, Zoom Lock and Bounding Box, and you can set the view of players.
| Option | Description |
|---|---|
| Mode | Mode of the button: -Pan Lock: Enable or disable the 'Pan Lock'. -Zoom Lock: Enable or disable the 'Zoom Lock'. -Bounding Box: Enable or disable the 'Bounding Box'. -Set View: Set the view of players. |
| Toggle Mode | (All but Set View) Sets what to do when pressed:-Toggle: Toggle between on and off. -Enable: Enable. -Disable: Disable. |
| Display | -Name: Display the mode's name on the Stream Deck. -Icon: Display the mode's icon on the Stream Deck. |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the mode is currently active -Off Color: A border is drawn on the Stream Deck of this color if the mode is currently not active -Background: Background color of the button. |
Set View
With the 'Set View' mode you can set the view of players.
| Option | Description |
|---|---|
| Movement | Configures how to move the canvas for the players: -Ignore Movement: Do not move canvas. -Reset to Initial View: Reset canvas to the initial view position. -Clone View: Clone GM's view. -Horizontal Fit: Move canvas to fit it horizontally within the window. -Vertical Fit: Move canvas to fit it vertically within the window. -Automatic Fit (inside): Move canvas so it fits within the window with padding visible on the short side. -Automatic Fit (outside): Move canvas to it fits within the window with no padding visible. -Move Grid Spaces: Move a specified amount of grid spaces. -Move to Coordinates: Move to specified coordinates. -Cursor: Move to cursor position. |
| X | (Move Grid Spaces) Grid spaces to move in x-direction.( Move to Coordinates) X-coordinate to move to. |
| Y | (Move Grid Spaces) Grid spaces to move in y-direction.( Move to Coordinates) Y-coordinate to move to. |
| Scale | Configures how to set the scale for the players: -Ignore Scale: Do not change the scale. -Reset to Initial View: Reset scale to the initial view position. -Clone View: Clone the scale from GM. -Physical Gridsize: Scale to physical gridsize. -Set Scale: Set scale to a specified value. |
| Value | (Set Scale only) Value to set the scale to. |
Monk's Active Tile Triggers
Monk's Active Tile Triggers allows you to configure actions for tiles, such as teleporting tokens or displaying a message when they move onto a tile.
Using Material Deck you can enable or disable triggers.
| Option | Description |
|---|---|
| Tile Name/ID | Name or ID of the tile. |
| Mode | Mode of the button: -Toggle Tile: Enable or disable the tile triggers. -Enable Tile: Enable the tile triggers. -Disable: Enable or disable the tile triggers. |
| Display | -Name: Display the tile's name on the Stream Deck. -Icon: Display the tile's image on the Stream Deck. |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the tile's triggers are currently active -Off Color: A border is drawn on the Stream Deck of this color if the tile's triggers are currently not active -Background: Background color of the button. |
Not Your Turn!
Not Your Turn! allows the GM to block unintended token movement of players.
Using Material Deck you can enable or disable the blocks.
| Option | Description |
|---|---|
| Mode | Mode of the button: -Toggle Combat Movement Block: Enable or disable the 'Combat Movement Block'. -Enable Combat Movement Block: Enable the 'Combat Movement Block'. -Disable Combat Movement Block: Disable the 'Combat Movement Block'. -Toggle Non-Combat Movement Block: Enable or disable the 'Non-Combat Movement Block'. -Enable Non-Combat Movement Block: Enable the 'Non-Combat Movement Block'. -Disable Non-Combat Movement Block: Disable the 'Non-Combat Movement Block'. |
| Display | -Name: Display the mode's name on the Stream Deck. -Icon: Display the mode's icon on the Stream Deck. |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the mode is currently active -Off Color: A border is drawn on the Stream Deck of this color if the mode is currently not active -Background: Background color of the button. |
Shared Vision
Shared Vision allows vision of tokens to be shared with players, even if they have no permission for that token.
Using Material Deck you can enable or disable vision sharing.
| Option | Description |
|---|---|
| Mode | Mode of the button: -Global Vision Sharing: Enable or disable 'Global Vision Sharing'. -All Vision Sharing: Enable or disable the 'All Vision Sharing'. |
| Toggle Mode | Sets what to do when pressed: -Toggle: Toggle between on and off. -Enable: Enable. -Disable: Disable. |
| Display | -Name: Display the mode's name on the Stream Deck. -Icon: Display the mode's icon on the Stream Deck. |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the mode is currently active -Off Color: A border is drawn on the Stream Deck of this color if the mode is currently not active -Background: Background color of the button. |
Simple Calendar
Simple Calendar adds a calendar to Foundry.
Using Material Deck you can display the in-game time and date, start or stop the clock and set the time or date.
| Option | Description |
|---|---|
| Time | Configures the time display. |
| Date | Configures the date display. |
| Date Format | Configures the date format. |
| On Press | Configures what to do when the button is pressed: -Do Nothing: Do nothing. -Start/Stop the Clock: Start or stops the clock. -Set the Time: Sets the time/date. |
| Toggle Mode | (Start/Stop the Clock only) Sets what to do when pressed:-Toggle: Toggle between on and off. -Enable: Enable. -Disable: Disable. |
| Set Time Mode | Sets the mode when the button is pressed: -Next Sunrise: Advance clock to the next sunrise. -Previous Sunrise: Recede clock to the previous sunrise. -Next Midday: Advance clock to the next midday. -Previous Midday: Recede clock to the previous midday. -Next Sunset: Advance clock to the next sunset. -Previous Sunset: Recede clock to the previous sunset. -Next Midnight: Advance clock to the next midnight. -Previous Midnight: Recede clock to the previous midnight. -Set Time to Value: Set the time to a specified value. -Change Time by Value: Change the time by a specified value. |
Time Display
The time display option consists of multiple checkboxes for the 'Digital' and 'Analog' time.
The digital time displays the time as a value, while the analog time displays a clock face.
In both cases you can configure to display the hours, minutes or seconds by checking the respective checkbox. For the digital time you can additionally set it to a 24 hour or 12 hour clock.
Date Display
The date display option consists of multiple checkboxes, these define how the date is displayed.
For example, if only Display is checked for Month, the month's number will be displayed, if Name is also checked, the month's name will be displayed, and lastly, if Abbreviated is also checked, the month's abbreviated name is displayed.
Set Time to Value/ Change Time to Value
The time and date can be changed by setting the values in the Time and Date rows.
Only fields that have a value will be changed, for example, if Mode is set to Change Time by Value and Hours is set to 1, the time will be incremented by 1 hour.
Soundscape
Soundscape adds comprehensive audio mixing capabilities to Foundry.
Using Material Deck you can control Soundscape's mixer and trigger sounds from its soundboard.
| Option | Description |
|---|---|
| Mode | Mode of the button: -Open Soundscape: Opens or closes the Soundscape mixer. -Set Soundscape: Sets the current soundscape. -Mixer: Control Soundscape's mixer. |
| Soundscape Nr | (Set Soundscape only) Sets the current soundscape to this value. |
| Mixer Mode | (Mixer mode only)-Start/Stop All: Start or stops all channels from playing. Start/Stop: Start stop the channel from playing. Toggle Mute: Toggle the channel's mute. -Toggle Solo: Toggle the channel's solo. -Toggle Link: Toggles the channel's link. |
| Channel | (Mixer mode only) Channel to control. |
| Volume Mode | (Mixer mode and Set Volume only) Configures how to control the channel's volume:-Increase/Decrease: Increase or decrease the volume by a specified value. -Set to Value: Set the volume to a specified value. |
| Value | (Mixer mode and Set Volume only) Volume to set. |
| Display | -Channel: Display the channel number on the Stream Deck. -Name: Display the mode's name on the Stream Deck. -Icon: Display the an icon on the Stream Deck. -Volume: ( Mixer mode and Set Volume only) Display the channel's volume on the Stream Deck. |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the mode is currently active -Off Color: A border is drawn on the Stream Deck of this color if the mode is currently not active -Background: Background color of the button. |