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 Enabling Chat Commands 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

How to Use

1. There are a few different ways to open the UI to create a Poll:

   1. Type !poll in Twitch or YouTube chat.
   2. Under the Poll System • Main Action action you can right click the top trigger and press Test Trigger.

2. This will then open the Create Poll UI.

Creating a New Poll

Follow the steps below to set up a new poll.

Poll Question

• Description: The question you want to ask your viewers.
• Example: "What game should I play next?"

Poll Time (seconds)

• Description: The duration for which the poll will remain open.
• Default Value: 30 seconds
• Usage: Type in the desired poll duration.

Choices

• Description: The options available for viewers to choose from in the poll. You must provide between 2 and 5 choices.
• Usage: Enter each choice in the provided text boxes.
  • Choice 1: The first option.
  • Choice 2: The second option.
  • Choice 3: (Optional) The third option.
  • Choice 4: (Optional) The fourth option.
  • Choice 5: (Optional) The fifth option.

Send Poll to Twitch

• Description: Option to send the poll to your Twitch stream.
• Input Field: Checkbox
• Usage: If checked, the poll will be sent to your Twitch chat.

Send Poll to YouTube

• Description: Option to send the poll to your YouTube stream.
• Input Field: Checkbox
• Usage: If checked, the poll will be sent to your YouTube chat.

Buttons

1. Start Button
   • Function: Begins the poll with the specified settings.
   • Location: Bottom-centre of the UI.
   • Action: Click to start the poll after configuring the question, duration, and choices.
2. Cancel Button
   • Function: Cancels the poll setup and closes the poll creation window.
   • Location: Bottom-right corner of the UI.
   • Action: Click to discard the poll setup and exit.

Poll Results Overview

The Poll Results window displays the outcome of a poll conducted during your stream if you have it selected in the Poll settings. It shows detailed results for each choice, including votes from Twitch and YouTube.

Poll Question

• Description: Displays the question that was asked in the poll.
• Example: "What game should I play next?"

Choice Results

Each choice is listed with the following details:

• Choice Number and Title: The number and title of the poll option.
  • Example: 1: GTA: SA
• Total Votes: The number of votes this choice received, along with the percentage of total votes.
  • Example: 0 votes (0%)
• Twitch Votes: The number of votes this choice received from Twitch viewers.
  • Example: Twitch Votes: 0
• YouTube Votes: The number of votes this choice received from YouTube viewers.
  • Example: YouTube Votes: 0

Total Votes

This section summarizes the total votes from each platform:

• Twitch Total Votes: The cumulative votes from all choices on Twitch.
  • Example: Twitch Total Votes: 0
• YouTube Total Votes: The cumulative votes from all choices on YouTube.
  • Example: YouTube Total Votes: 0

Final Total Votes

• Description: Displays the combined total votes from all platforms and choices.
  • Example: Final Total Votes: 0

Buttons

1. Close Button
   • Function: Closes the Poll Results window.
   • Location: Bottom-right corner of the UI.
   • Action: Click to close the results window.

Chat Commands

Here is a list of all the chat commands and how they work:

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.