Code Docs

StreamUP Product Documentation

General Notices

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> This product comes without a .StreamUP file because it is just controlled inside of Streamer.Bot. You can however get other Poll overlays to put in OBS that will work with this system from the StreamUP website. Remember you can get access to everything by supporting us monthly!

You still need to install the product into Streamer.Bot and use our DLL so make sure you follow the instructions below! Installing Products into Streamer.Bot Adding a Product into Streamer.Bot Setting Up a Product in Streamer.Bot

All these links go to the same page but for easy of access I included them all so that you can clearly see what is required to do before continuing!

</aside>

After Streamer.Bot Installation

Alright, now that you have installed everything that is required into Streamer.Bot it is time to start using the Poll System. If you are unsure what some of the settings were and what they did you can see explanations at the bottom of this guide.

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> If there is an tiny image, you can click on the image to see a enhanced version of it.

</aside>

User Guide

By default this product is setup to work with Twitch and YouTube. There are various triggers already setup. You can disable ones you don’t want to use by following the instructions on this page: How to Edit Triggers in Streamer.Bot

Settings

This is an overview of what all the settings do. You can access this menu by going to the Poll System • Settings action then right clicking the Test trigger, then press Test Trigger.

Buttons

1. Reset Button:
   • Function: Resets all settings to their default values.
   • Location: Bottom-left corner of the UI.
2. Save Button:
   • Function: Saves the current settings.
   • Location: Bottom-centre of the UI.
3. Cancel Button:
   • Function: Discards any changes and closes the settings window.
   • Location: Bottom-right corner of the UI.

General Settings

Send Messages to Twitch Chat

• Description: Enable or disable sending messages to Twitch chat when an event occurs.

Send Twitch Messages from Bot Account

• Description: Specify whether messages to Twitch chat should be sent from a bot account.

Send Messages to YouTube Chat

• Description: Enable or disable sending messages to YouTube chat when an event occurs.

Send YouTube Messages from Bot Account

• Description: Specify whether messages to YouTube chat should be sent from a bot account.

Your local 3 character currency code

• Description: Set your local currency code. This will convert any donations etc., to your currency, including YouTube Supers.

Twitch Settings

Cheer Settings

• Message: Custom message template for cheer events.
• Available Variables:
  • %amount%: Cheer Amount
  • %message%: Cheer Message
  • %user%: Cheerers Name

Follow Settings

• Message: Custom message template for follow events.
• Anonymous Follow Mode: Toggle to enable or disable anonymous follow mode.
• Anonymous Follower Name: Set a name for anonymous followers.
• Available Variables:
  • %user%: Followers Name

Raid Settings

• Message: Custom message template for raid events.
• Available Variables:
  • %amount%: Viewer Amount
  • %user%: Raiders Name

Subscriber Settings

• Message: Custom message template for new subscriber events.
• Available Variables:
  • %message%: Subscribers Message
  • %tier%: Sub Tier
  • %user%: Subscribers Name

Re-Subscriber Settings

• Message: Custom message template for re-subscriber events.
• Available Variables:
  • %message%: Sub Message
  • %monthsTotal%: Total Months Subscribed
  • %monthsStreak%: Current Sub Streak
  • %tier%: Sub Tier
  • %user%: Subscribers Name

Gifted Sub Settings

• Message: Custom message template for gifted sub events.
• Available Variables:
  • %monthsTotal%: Total Months Subbed
  • %monthsGifted%: Amount Of Months Gifted
  • %receiver%: Sub Receiver
  • %tier%: Sub Tier
  • %user%: Gifters Name

Gifted Sub Bomb Settings

• Message: Custom message template for sub bomb events.
• Available Variables:
  • %amount%: Amount Of Subs Gifted
  • %tier%: Sub Tier
  • %totalAmount%: Total Subs Gifted
  • %user%: Gifters Name

First Words Settings

• Message: Custom message template for first chat messages.
• Available Variables:
  • %message%: Chat Message
  • %user%: Chatters Name

Reward Redemption Settings

• Message: Custom message template for reward redemption events.
• Available Variables:
  • %message%: Chat Message
  • %user%: Chatters Name

Shoutout Settings

• Message: Custom message template for shoutout events.
• Available Variables:
  • %receiver%: User Being Shoutout
  • %user%: User Executing Shoutout

User Banned Settings

• Message: Custom message template for user ban events.
• Available Variables:

User Timed Out Settings

• Message: Custom message template for user timeout events.
• Available Variables:

YouTube Event Message Settings