Other Actions
Other Actions is used for miscellaneous actions.
| 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 |
| Function | Sets the function of the button: -Pause: Pause or unpause the game -Control Buttons: Open or enable the control buttons -Open Sidebar Tab: Open or close sidebar tabs -Roll Dice: Roll dice using a formula -Dice Pool: Create a dice pool and roll it -Roll Tables: Open or close roll tables and roll from them -Open Compendium Pack: Open or close compendium packs -Open Journal: Open or close journal entries -Send Chat Message: Send a chat message -Set Roll Sharing Mode: Set the roll sharing mode -Cycle Through Tokens: Cycle through tokens on the canvas |
Pause
This function allows you to pause or unpause the game.
| Option | Description |
|---|---|
| Mode | Sets what to do on a button press: -Pause Game: Pause the game -Resume: Resumes/unpauses the game -Toggle Pause: Will pause the game if unpaused, or will unpause the game if paused |
| Display | -Icon: Display an icon on the Stream Deck |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the game is paused -Off Color: A border is drawn on the Stream Deck of this color if the game is not paused -Background: Background color of the button |
Control Buttons
This function allows you to open control buttons or select/activate tools (the buttons on the left of the Foundry window).
Controls are the 'categories' on the left. Each category can contain one or more tools and are shown to the right of the controls.
| Option | Description |
|---|---|
| Control | The control/tool to open or the control that contains the tool that you want to open or activate: -Displayed Controls: Select from one of the controls that are currently displayed in Foundry using Nr-Displayed Tools: Select from one of the tools that are currently displayed in Foundry using Nr-Controls/Tools Offset: Configure offsets for Displayed Controls and Displayed Tools. See here for more info-Rest: All other options are a list of controls in Foundry that can be selected |
| Number | (Only for Displayed Controls/Tools) The control or tool number that you want to select. 1 is the topmost tool/control. |
| Mode | (Not for Displayed Controls/Tools or Controls/Tools Offset) Select what you want to do when the button is pressed:-Open Control: Open the control -Rest: All other options are the tools for the selected control. Will select or activate the tool |
| Display | -Icon: Display an icon on the Stream Deck |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the control or tool is selected -Active Color: A border is drawn on the Stream Deck of this color if the tool is activated -Off Color: A border is drawn on the Stream Deck of this color if the control or tool is not selected -Background: Background color of the button |
Controls/Tools Offset
Control and tool offsets can be used in combination with Nr to give an offset to the selected control or tool.
For example, if the controls offset is set to 3, a button with Control set to Displayed Controls and Nr set to 1 will now select control 4,
and a button with Nr set to 3 will not select control 6.
This can be used to browse through the controls or tools.
For example, say you have 5 Displayed Controls buttons with Nr set from 1 to 5, and a button with Offset Mode Increase/Decrease and Offset of 1.
If you then press the offset button, the offset will increase to 1, so now controls 2 through 6 ar selected.
| Option | Description |
|---|---|
| Offset Mode | Sets how to set the offset: -Set to Value: Sets the offset to the value set in Offset-Increase/Decrease: Increases the offset by the value set in Offset |
| Offset | The value to set the offset to (in case of Set to Value), or the value to increment the offset with (in case of Increase/Decrease).The offset can be any value, positive or negative. |
| Display | -Offset: Display the current offset on the Stream Deck -Icon: Display an icon on the Stream Deck |
| Colors | -On Color: (Set to Value only) A border is drawn on the Stream Deck of this color if the current offset is equal to the offset configured in Offset-Off Color: ( Set to Value only) A border is drawn on the Stream Deck of this color if the current offset is not equal to the offset configured in Offset-Background: Background color of the button |
Open Sidebar Tab
This function allows you to open or close sidebar tabs.
| Option | Description |
|---|---|
| Tab | The sidebar tab to open or close |
| Pop Out | If selected, will pop out the sidebar tab in a separate window |
| Display | -Name: Display the name of the sidebar tab on the Stream Deck -Icon: Display the icon of the sidebar tab on the Stream Deck |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the sidebar tab is open -Off Color: A border is drawn on the Stream Deck of this color if the sidebar is not open -Background: Background color of the button |
Roll Dice
This function allows you to roll dice from a formula
| Option | Description |
|---|---|
| Mode | The roll mode: -Default: Result is shown as set in Foundry -Public Roll: Result is shown in chat to everyone -GM Roll: Result is shown in chat to the player that rolled and the GM -Blind Roll: Result is shown in chat to the GM only -Self Roll: Result is shown in chat to the user who rolled -Display on Stream Deck: Result is displayed on the Stream Deck |
| Formula | The roll formula. Follows the same format as standard Foundry roll commands, but omit /r or /roll.For example: 1d20 + 7 or 1d4 / 2 + 2d8 |
| Display | -Formula: Display the formula on the Stream Deck -Icon: Display an icon on the Stream Deck |
| Colors | -Background: Background color of the button |
Dice Pool
This function allows you to create a dice pool and roll it.
You can add or remove dice using the Add Dice and Remove Dice modes and roll using the Roll Dice Pool mode.
| Option | Description |
|---|---|
| Mode | -Roll Dice Pool: Rolls the dice pool -Clear Dice Pool: Clear the dice pool -Add Dice: Add a die to the dice pool -Remove Dice: Remove a die from the dice pool |
| Roll Mode | (Only on Roll Dice Pool) The roll mode:-Public Roll: Result is shown in chat to everyone -GM Roll: Result is shown in chat to the player that rolled and the GM -Blind Roll: Result is shown in chat to the GM only -Self Roll: Result is shown in chat to the user who rolled -Display on Stream Deck: Result is displayed on the Stream Deck |
| Clear After Roll | (Only on Roll Dice Pool) Clears the dice pool after it has been rolled |
| Dice | (Only on Add/Remove Dice) The dice type to add or remove |
| Display | -Formula: (Only on Roll Dice Pool) Display the formula of the dice pool on the Stream Deck-Value: (Only on Add/Remove Dice) The amount of dice of this dice type in the dice pool-Icon: Display an icon on the Stream Deck |
| Colors | -Background: Background color of the button |
Roll Tables
This function allows you to open and close roll tables, and roll from them.
| Option | Description |
|---|---|
| Table | Table to select: -Select by Number: Select a table by its number -Select by Name/Id: Select a table by its name or id -Rest: List of all roll tables |
| Number | (Only on Select by Number) The number of the table to select |
| Name/Id | (Only on Select by Name/Id) The name or id of the table to select |
| Mode | Selects what to do on a button press: -Open Table: Opens or closes the table -Public Roll: Roll from the table, the result is shown in chat to everyone -GM Roll: Roll from the table, the result is shown in chat to the player that rolled and the GM -Blind Roll: Roll from the table, the result is shown in chat to the GM only -Self Roll: Roll from the table, the result is shown in chat to the user who rolled |
| Display | -Name: Display the name of the roll table on the Stream Deck -Icon: Display the icon of the roll table on the Stream Deck |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the roll table is open -Off Color: A border is drawn on the Stream Deck of this color if the roll table is not open -Background: Background color of the button |
Open Compendium Pack
This function allows you to open and close compendium packs.
| Option | Description |
|---|---|
| Compendium | Compendium pack to select: -Select by Number: Select a compendium pack by its number -Select by Name: Select a compendium pack by its name -Rest: List of all compendium packs |
| Number | (Only on Select by Number) The number of the compendium pack to select |
| Name | (Only on Select by Name) The name of the compendium pack to select |
| Display | -Name: Display the name of the compendium pack on the Stream Deck -Icon: Display the icon of the compendium pack on the Stream Deck |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the compendium pack is open -Off Color: A border is drawn on the Stream Deck of this color if the compendium pack not open -Background: Background color of the button |
Open Journal
This function allows you to open and close journal entries or specific pages of journal entries.
| Option | Description |
|---|---|
| Journal | Journal to select: -Select by Number: Select a journal by its number -Select by Name: Select a journal by its name -Rest: List of all journals |
| Number | (Only on Select by Number) The number of the journal to select |
| Name/Id | (Only on Select by Name/Id) The name or id of the journal to select |
| Mode | Selects what to do on a button press: -Open Journal: Opens or closes the journal -Open Page by Number: Open a specific page of the journal by its page number -Open Page by Name: Open a specific page of the journal by its name |
| Page Number | (Only on Open Page by Number) The number of the journal's page to open |
| Page Name | (Only on Open Page by Name) The name of the journal's page to open |
| Display | -Name: Display the name of the journal on the Stream Deck -Icon: Display an icon on the Stream Deck |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the journal is open. If Open Page by Number/Name is selected, only half of a border will be of this color if the journal is open but not on the right page-Off Color: A border is drawn on the Stream Deck of this color if the journal is not open -Background: Background color of the button |
Send Chat Message
This function allows you to send a chat message.
| Option | Description |
|---|---|
| Speaker | -User: Chat message will be spoken by the user -Token: Chat message will be spoken by the selected token or the player token |
| Message | The message to send to chat |
| Display | -Message: Display the chat message on the Stream Deck -Icon: Display an icon on the Stream Deck |
| Colors | -Background: Background color of the button |
Set Roll Sharing Mode
This function allows you to set the roll mode in Foundry for generic rolls.
| Option | Description |
|---|---|
| Mode | -Public Roll: Results are shown in chat to everyone -GM Roll: Results are shown in chat to the player that rolled and the GM -Blind Roll: Results are shown in chat to the GM only -Self Roll: Results are shown in chat to the user who rolled |
| Display | -Mode: Display the selected mode on the Stream Deck -Icon: Display an icon on the Stream Deck |
| Colors | -On Color: A border is drawn on the Stream Deck of this color if the current roll mode is Mode-Off Color: A border is drawn on the Stream Deck of this color if the current roll mode is not Mode-Background: Background color of the button |
Cycle Through Tokens
This function allows you to cycle through tokens to select them.
| Option | Description |
|---|---|
| Mode | -All Tokens: Cycle through all tokens -Owned Tokens: Cycle through owned tokens -Friendly Tokens: Cycle through friendly tokens |
| Display | -Icon: Display an icon on the Stream Deck |
| Colors | -Background: Background color of the button |