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 FFVII 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

Customize the background colours for the text box used in alerts.

Top Left Colour

• Description: Sets the colour for the top left corner of the text box.
• Usage: Click the "Pick a colour" button to select a colour.

Top Right Colour

• Description: Sets the colour for the top right corner of the text box.
• Usage: Click the "Pick a colour" button to select a colour.

Bottom Left Colour

• Description: Sets the colour for the bottom left corner of the text box.
• Usage: Click the "Pick a colour" button to select a colour.

Bottom Right Colour

• Description: Sets the colour for the bottom right corner of the text box.
• Usage: Click the "Pick a colour" button to select a colour.

Text Colours

Text Colour

• Description: Sets the main colour for the alert text.
• Usage: Click the "Pick a colour" button to select a colour.

Amount Text Colour

• Description: Sets the colour for the "how many" text in alerts (e.g., donation amounts, subscriber months).
• Usage: Click the "Pick a colour" button to select a colour.

Drop Shadow Colour

• Description: Sets the colour for the text drop shadow.
• Usage: Click the "Pick a colour" button to select a colour.

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 Message

• Description: Message displayed when a viewer cheers.
• Available Variables:
  • %amount%: Cheer amount
  • %message%: Cheer message
  • %user%: Cheerer's name

Follow Message

• Description: Message displayed when a viewer follows.
• Available Variables:
  • %user%: Follower's name

Raid Message

• Description: Message displayed when a viewer raids the channel.
• Available Variables:
  • %amount%: Viewer amount
  • %user%: Raider's name

New Subscriber Message

• Description: Message displayed when a viewer subscribes.
• Available Variables:
  • %message%: Subscriber message
  • %tier%: Subscription tier
  • %user%: Subscriber's name

Re-subscriber Message

• Description: Message displayed when a viewer resubscribes.
• Available Variables:
  • %message%: Resubscription message
  • %monthsTotal%: Total months subscribed
  • %monthsStreak%: Current subscription streak
  • %tier%: Subscription tier
  • %user%: Subscriber's name

Gifted Subscription Message

• Description: Message displayed when a viewer gifts a subscription.
• Available Variables:

Multiple Gifted Subscriptions Message

• Description: Message displayed when a viewer gifts multiple subscriptions.
• Available Variables: