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 FFVIII 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.

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.

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.

Text Box Background Colours

• Left Gradient Colour: Select the colour for the left gradient of the text box background.
• Right Gradient Colour: Select the colour for the right gradient of the text box background.
• Outer Border Colour: Select the colour for the outer border of the text box.
• Inner Border Colour: Select the colour for the inner border of the text box.

Text Colours

• Text Colour: Choose the colour of the main text.
• Text Drop Shadow Colour: Choose the colour for the text drop shadow.

Twitch Event Message Settings

Customise messages for various Twitch events using 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!’

Cheer Settings

Customise the message displayed for cheer events.

• Available Variables:
  • %amount%: Cheer amount.
  • %message%: Cheer message.
  • %user%: Cheerers name.

Follow Settings

Anonymous Follow Mode: When enabled, the follow events will show as anonymous.

Anonymous Followers Name: Name displayed for anonymous follows.

Follow Message: Customise the message displayed for follow events.

• Available Variables:
  • %user%: Followers name.

Raid Settings

Raid Message: Customise the message displayed for raid events.

• Available Variables:
  • %amount%: Viewer amount.
  • %user%: Raiders name.

New Subscriber Settings

New Subscriber Message: Customise the message displayed for new subscriber events.

• Available Variables:
  • %message%: Subscribers message.
  • %tier%: Sub tier.
  • %user%: Subscribers name.

Re-Subscriber Settings

Re-subscriber Message: Customise the message displayed for re-subscriber events.

• Available Variables:
  • %message%: Sub message.
  • %monthsTotal%: Total months subscribed.
  • %monthsStreak%: Current sub streak.
  • %tier%: Sub tier.
  • %user%: Subscribers name.

Gifted Subscription Settings

Gifted Subscription Message: Customise the message displayed for gifted subscription events.

• Available Variables:
  • %monthsTotal%: Total months subbed.
  • %monthsGifted%: Amount of months gifted.
  • %receiver%: Sub receiver.
  • %tier%: Sub tier.
  • %totalAmount%: Total subs gifted.
  • %user%: Gifters name.

Multiple Gifted Subscription Settings

Multiple Gifted Subscriptions Message: Customise the message displayed for multiple gifted subscription events.

• Available Variables:
  • %amount%: Amount of subs gifted.
  • %tier%: Sub tier.
  • %totalAmount%: Total subs gifted.
  • %user%: Gifters name.