Code Docs

StreamUP Product Documentation

General Notices

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> Please make sure you have followed the standard product installation steps for StreamUP products.

Install the product into OBS. Getting Started

Install the product into Streamer.Bot and use our DLL so make sure you follow the instructions below! Installing Products into 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>

User Guide

Alright, now that you have installed everything that is required into Streamer.Bot it is time to start using the product. 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>

How to Use

This product is designed to work straight out of the box. It integrates with Twitch’s ad system so it automatically does the actions in Streamer.Bot.

Settings Menu

Buttons

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

General Settings

OBS Connection Number

• Description: Specifies the OBS connection number. This number can be found on the left of your OBS connection in the 'Stream Apps -> OBS' tab.
• Usage: Select the appropriate OBS connection number to link the ad tracker with your OBS setup.

Widget Background Colour

• Description: Sets the background colour of the ad tracker widget.
• Usage: Click the "Pick a colour" button to select a colour that matches your stream's theme.

Widget Text Colour

• Description: Sets the colour of the text displayed in the widget.
• Usage: Click the "Pick a colour" button to select a colour that ensures readability against the background.

Widget Timer Bar Colour

• Description: Sets the colour of the timer bar that indicates the ad duration.
• Usage: Click the "Pick a colour" button to select a colour that stands out for easy tracking.

First pre-roll ad length (secs)

• Description: Sets the length of the first pre-roll ad in seconds, which can be found in your Twitch Dashboard.
• Default Value: 180

Ads Countdown Message

• Description: Message displayed when counting down to the start of ads.
• Variables:
  • %minutes%: Minutes until ads run
  • %adLength%: How long ads will last

Ads Starting Message

• Description: Message displayed when ads are starting.

Ads Currently Running Message

• Description: Message displayed while ads are running.
• Variables:
  • %adLength%: How long is left of ads

Ads Finished Message

• Description: Message displayed when ads have finished.

Twitch Chat Message Settings

Customise the messages posted to Twitch chat during different ad states.

Send messages from bot account

• Description: Enables or disables sending messages from the bot account.

Ads Countdown Message

• Description: Message posted to chat when counting down to the start of ads.
• Variables:
  • %minutes%: Minutes until ads run
  • %adLength%: How long ads will last

Ads Starting Message

• Description: Message posted to chat when ads are starting.
• Variables:
  • %adLength%: How long ads will last

Ads Currently Running Message

• Description: Message posted to chat while ads are running.
• Variables:
  • %adLength%: How long is left of ads

Ads Finished Message

• Description: Message posted to chat when ads have finished.