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

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 Minim Alerts • 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.
   • 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 alerts with your OBS setup.

Sound Effect Volume

• Description: Sets the volume level for alert sound effects.
• Usage: Adjust the slider or input a number to set the desired volume level. The number must be between 0 and 100.

Transparent Background

• Description: Sets banner background transparency mode.
• Usage: Toggle to enable or disable the transparency of the alert background.

Local Currency Code

• Description: Enter your local 3-character currency code. This setting converts any donations to your specified currency, including YouTube Super Chats.
• Example: GBP for British Pound, USD for US Dollar.

Twitch Settings

Customise various Twitch events here. On the messages section you can use dynamic variables. Below you will see each type of event and what variables are available for them. When using a variable, make sure you wrap it in ‘%%’. e.g. ‘Thank you for following %user%, welcome in!’

Follow Settings

• Available Variables:
  • %user%: Follower's Name
• Anonymous Follow Mode: Toggle to enable anonymous follows.
• Anonymous Follower Name: Set the name to display for anonymous follows.
• Text Displayed On Top Line: Enter the text to display on the top line using the variable %user%.
• Text Displayed On Bottom Line: Enter the text to display on the bottom line.
• Banner Colour: Select the banner colour for the follow alert.
• Text Colour: Select the text colour for the follow alert.

Cheer Settings

• Available Variables:
  • %amount%: Cheer Amount
  • %message%: Cheer Message
  • %user%: Cheerer Name
• Text Displayed On Top Line: Enter the text to display on the top line using the variable %user%.
• Text Displayed On Bottom Line: Enter the text to display on the bottom line using the variables %amount% and %message%.
• Banner Colour: Select the banner colour for the cheer alert.
• Text Colour: Select the text colour for the cheer alert.

Subscriber Settings

• Available Variables:
  • %message%: Subscriber Message
  • %tier%: Subscription Tier
  • %user%: Subscriber Name
• Text Displayed On Top Line: Enter the text to display on the top line using the variable %user%.
• Text Displayed On Bottom Line: Enter the text to display on the bottom line using the variable %tier%.
• Banner Colour: Select the banner colour for the subscriber alert.
• Text Colour: Select the text colour for the subscriber alert.

Re-Subscriber Settings

• Available Variables:
  • %message%: Re-Subscriber Message
  • %monthsTotal%: Total Months Subscribed
  • %monthsStreak%: Current Sub Streak
  • %tier%: Subscription Tier
  • %user%: Re-Subscriber Name
• Text Displayed On Top Line: Enter the text to display on the top line using the variable %user%.
• Text Displayed On Bottom Line: Enter the text to display on the bottom line using the variables %tier% and %monthsTotal%.
• Banner Colour: Select the banner colour for the re-subscriber alert.
• Text Colour: Select the text colour for the re-subscriber alert.

Subscriber Tier Colour Settings

• Prime Banner Colour: Select the banner colour for Prime subscribers.
• Prime Text Colour: Select the text colour for Prime subscribers.
• Tier 1 Banner Colour: Select the banner colour for Tier 1 subscribers.
• Tier 1 Text Colour: Select the text colour for Tier 1 subscribers.
• Tier 2 Banner Colour: Select the banner colour for Tier 2 subscribers.
• Tier 2 Text Colour: Select the text colour for Tier 2 subscribers.
• Tier 3 Banner Colour: Select the banner colour for Tier 3 subscribers.
• Tier 3 Text Colour: Select the text colour for Tier 3 subscribers.

Gift Sub Settings

• Available Variables:
• Text Displayed On Top Line: Enter the text to display on the top line using the variable %user%.
• Text Displayed On Bottom Line: Enter the text to display on the bottom line using the variables %tier%, %receiver%, and %totalAmount%.
• Banner Colour: Select the banner colour for the gift sub alert.
• Text Colour: Select the text colour for the gift sub alert.

Gift Bomb Settings

• Available Variables:
• Text Displayed On Top Line: Enter the text to display on the top line using the variable %user%.
• Text Displayed On Bottom Line: Enter the text to display on the bottom line using the variables %amount%, %tier%, and %totalAmount%.
• Banner Colour: Select the banner colour for the gift bomb alert.
• Text Colour: Select the text colour for the gift bomb alert.

Raid Settings

• Available Variables:
• Text Displayed On Top Line: Enter the text to display on the top line using the variable %user%.

YouTube Event Message Settings

Customise various YouTube events here. On the messages section you can use dynamic variables. Below you will see each type of event and what variables are available for them. When using a variable, make sure you wrap it in ‘%%’. e.g. ‘Thank you for joining channel memberships %user%, welcome in!’

Donation Event Message Settings

Customize messages for donation events. Below you will see each type of event and what variables are available for them. When using a variable, make sure you wrap it in ‘%%’. e.g. ‘Thank you for the %amountCurrency% donation %user%!’