Streamer.bot
Run your Streamer.bot actions from any Vfinity event or Quick Deck pad
Connect Vfinity to Streamer.bot on your computer, and any event or Quick Deck pad can run one of your Streamer.bot actions, with the viewer's name, the gift or the chat message passed along.
Vfinity connects to Streamer.bot's WebSocket server as a client. Streamer.bot has to be open, with its WebSocket server started, before Vfinity can reach it.
Connect Streamer.bot
Start Streamer.bot's WebSocket server
In Streamer.bot, start its WebSocket server and note the address, port and password it uses.
Open the Streamer.bot card
In Vfinity, go to SettingsConnections. Under Apps, open the Streamer.bot card and turn on Connect to Streamer.bot.
Enter where it is
Fill in IP Address and Port to match Streamer.bot. If its server asks for a password, type it in Server password.
Connect
Click Connect Streamer.bot. The card's status turns to Connected, and Vfinity reads your list of Streamer.bot actions.
If Vfinity cannot connect, the card shows Problem: followed by what went wrong. When a connection drops, Vfinity tries again on its own, waiting a little longer between each try. With Connect on launch on, it also connects when Vfinity starts.
Turning off Connect to Streamer.bot closes the connection, and Vfinity leaves Streamer.bot alone until you turn it back on.
Run an action from an event
Add the step
Open an event on the Events tab, click Add a step and choose Streamer.bot action.
Pick the action
Click URL / action ID and choose an action from the list, which shows your Streamer.bot actions by name. Vfinity saves the action's ID. You can also paste an ID straight into the field.
Refresh the list if needed
The list fills in while Streamer.bot is connected. Made a new action since you connected? Click Refresh action list to see it. If the list cannot be read, the step shows Integration request failed.
Save and test
Save the event, then right-click it and choose Test it now to run it without waiting for a viewer.
The step works the same way in a Quick Deck pad, so a pad can press a Streamer.bot action by hand. In a Blueprint event, an Action node runs it.
Pass details to the action
JSON body / arguments takes a JSON object. Vfinity sends it to Streamer.bot as the action's arguments, after filling in any placeholders in its text values.
{
"user": "{name}",
"gift": "{gift}",
"amount": "{count}",
"message": "{comment}",
"loud": true
}Placeholders work in text values, including {name}, {gift}, {count},
{diamonds}, {comment} and {arg1} to {arg9} for chat commands. Numbers
and true or false values go through as they are. Each filled-in value has line
breaks turned into spaces and stops at 500 characters, so a long chat message
cannot flood your action.
Leave it as {} to send no arguments. The event will not save while the
action ID is empty or the arguments are not a JSON object.
See every placeholder in Template variables.
When the action does not run
The step fails with Integration is disconnected when Streamer.bot is not connected, and it also fails when Streamer.bot turns the request down. Either way, the other steps in the same event still run.
Check that Streamer.bot is open, its WebSocket server is running, and the action still exists. Right-click the event and choose Test it now to try again.
Keep the password safe
The Server password is kept on this PC only, apart from your settings. A backup carries it only when you tick Include passwords and tokens, and it is blanked out of an exported support log.
The other direction
To have a script or another app run Vfinity commands and events, use the Local API.