Documentation

The plugin should automatically connect to OBS and Twitch once things are setup properly

OBS

Websockets needs to be on for communication between this plugin and OBS.

1. Go to Tools->Websocket Server Settings.
2. In Plugin Settings turn on Enable WebSocket server.
3. Within Server Settings, make sure Enable Authentication is enabled.
4. Click Apply or Ok on the OBS window.
5. Port is normally 4455
6. IP Address is normally 127.0.0.1 (if you are on the same computer)
7. Click on Show Connect Info to copy the password
8. On the webpage, click on the OBS Connect button. If is ok, it should indicate "On" and the button should now say "Disconnect".

Twitch

Access to the Twitch chat bot needs authentication. Assume your channel is named twitch_streamer and you would like the bot to be under a different account, bot_account. You would need to login to the bot's twitch account and access this page. You can use your main account for the bot; if you do "bot" messages will show from twitch_streamer. If you login from the bot_account "bot" messages will be from bot_account

1. For the account you would like to use as the bot, login to twitch as that account.
2. Come back to this page
3. Put the channel name in Channelwhich the bot will connect
4. Click Authorize to start the Authentication process
5. You should be asked for permission for some activites; Approve this
6. You will be redirected back to the Plugin page and the bot should authorize.
7. The bot should have connected

Commands

• Available commands are play, show, send If you would like something else, please let me know
• Commands that start with '!' have to be at the start of a message. Those without can match anywhere in the message, at the beginning, end or surrounded by space, and are matched in a case insensitive way, gl is the same as GL.
• play local_file_name
  • local_file_name has to be the full path to the audio file you would like to play
  • If you have spaces in the path, you can surround the path in "quotes"
  • An input is automatically created, played and removed
• show scene_item_name [duration]
  • scene_item_name needs to exist on the Sources list. This can be useful for playing animations
  • duration Optional, default of 5 seconds, after it is hidden
  • the item should be "hidden" with the eyeball crossed out. The first time you run the command it may not work if the value is not hidden.
  • If you would like the animation to loop, make sure the loop is checked in Properties
  • Make sure the Restart playback when source becomes active to start the file when it becomes visible.
• url url-to-open
  • utl-to-open Open this url in an obs browser source
  • url Command Parameters
  • x X position to place the brower, see anchor
  • y Y position to place the brower, see anchor
  • width Input width in pixels. This does not control the output size. A default screen is likely to be 1920 pixels wide. Scaling of the output has not been added yet.
  • height Input height in pixels. A default screen is likely to be 1080 pixels high.
  • anchor can be upper-left, upper-center, upper-right, center-left, center-center, center-right, lower-left, lower-center, or lower-right
• send message to send
  • messages to send are sent to the chat.
• Special variables
  • $commands - All command names
  • $sounds - All sound commands, starting with play
  • $1 - First word after command
  • $2 - Second word after command
  • $n - nth word after command
  • $* - All words after command seperated by spaces
  • Spaces separate words, unless "quoted"

Events

• follow - Actions to do on a user follow
  • $user - Name of the user who followed
• raid - Actions to do on a user follow
  • $user - Name of the user who raided
  • $viewers - Number of viewers in the raid
• subscribe - Actions to do on a user subscription message
  • $user - Name of the user who subscribed
  • $months - Total number of months subscribed
  • $duration - Duration of the current subscription
  • $tier - Tier of the subscription
  • $text - Raw text of the message used
• bits num_bits - Actions to do on bits being used
  • $user - Name of the user who used bits
  • $bits - Number of bits used
  • $text - Raw text of the message used
  • num_bits
    • n - Single amount of bits
    • min-max - Range between min and max bits [min,max]
    • min- - Range between min and unlimited bits [min, inf]
    • -max - Range between 0 and max bits [0, max]
    • Examples:
    • bits 100 on 100 bits
    • bits 5 10 15 20 on 5, 10, 15, or 20 bits
    • bits 10-50 on bits between 10 and 50, inclusive
    • bits -10 on bits from 0 to 10, inclusive
    • bits 100- on bits from 100 to inf, inclusive