Skip to content

Yet another Streamer.bot plugin for Macro Deck

License

Notifications You must be signed in to change notification settings

dichternebel/macrodeck-yasb-plugin

Repository files navigation

Macro Deck YaSb Plugin

Streamer.bot logo Yet another Streamer.bot plugin for Macro Deck.

Manual Installation

Go to the releases and download the latest version.
Open Macro Deck, go to the Plugins tab and click on the Install from file button.

By default the plugin listens to General.Custom and Misc.GlobalVariableUpdated events. Configure the plugin to match your Streamer.bot websocket server settings and you're good to go!

Usage

The plugin will automatically connect to the Streamer.bot websocket server and listen for events configured in the plugin settings. It will get all available actions that may be triggered on application start or when the websocket connection is established.

Configuration in Streamer.bot

The Streamer.bot websocket server has to run. When you use authentication in Streamer.bot make sure to use the same password in the settings. Click on the eye symbol to be sure!

Events

You can configure the plugin to listen to all available events in Streamer.bot. Events that are not selected in the plugin Events setting will be ignored. If you are not intrested in using events you can completely uncheck all events.

Variables

Every Streamer.bot event you have subscribed to will result in a variable being created in Macro Deck as soon as a message is received by the plugin.

The plugin will not transform any event messages by default, instead it will create variable values in raw JSON format.
If you want to transform the raw values you can use the plugin configuration called f(x) to store the variable value by a given key of your choice.

Variable names are stored in the format actionName_variableName in lower case:

Variables Screenshot

Actions

The plugin comes with a Macro Deck action called DoAction that can be used to execute any existing action in Streamer.bot:

DoAction Screenshot

To configure the Macro Deck action, you need to enter the Action ID and the Action Name of the Streamer.bot Action you want to trigger or you can select the group of the action in the first combobox and then select the action in the second combobox and click on Use.

The Argument field is optional and can be used to pass an argument to the action. It has to be in valid JSON format like { "value": 42 } or like seen in the screenshot above.

Requirements

  • Streamer.bot 0.2.5 or higher
  • Macro Deck 2.14.1 or higher