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.

Achievement Title

• Description: Sets the default title for regular achievement alerts.

Sound Effect Volume

• Description: Adjusts the volume of the alert sound effects.
• Usage: Adjust the slider or input a number to set the desired volume level.

Toggle Rare Achievements

• Description: Enables or disables rare achievement alerts.

Rare Achievement Title

• Description: Sets the title for rare achievement alerts.

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.

Donation Settings

Background Colour

• Description: Sets the background colour of the donation alert.
• Usage: Click the "Pick a colour" button to select a colour.

Gamerscore Amount

• Description: Multiplies the donation amount by this number to calculate the gamerscore.

Gamerscore Amount to Trigger Rare Achievement

• Description: Sets the threshold for triggering a rare achievement alert based on the gamerscore amount.

Achievement Name

• Description: Sets the name of the achievement for donation alerts.

Achievement Message

• Description: Sets the message displayed for donation alerts.
• Available Variables:
  • %amountCurrency%: Donation amount

Twitch Settings

Cheer Settings

Background Colour

• Description: Sets the background colour of the cheer alert.
• Usage: Click the "Pick a colour" button to select a colour.

Gamerscore Amount

• Description: Multiplies the amount of bits received by this number to calculate the gamerscore.

Gamerscore Amount to Trigger Rare Achievement

• Description: Sets the threshold for triggering a rare achievement alert based on the cheer amount.

Achievement Name

• Description: Sets the name of the achievement for cheer alerts.

Achievement Message

• Description: Sets the message displayed for cheer alerts.
• Available Variables:
  • %amount%: Cheer amount

Follow Settings

Background Colour

• Description: Sets the background colour of the follow alert.
• Usage: Click the "Pick a colour" button to select a colour.

Gamerscore Amount

• Description: Sets the gamerscore amount for each new follow.

Achievement Name

• Description: Sets the name of the achievement for follow alerts.

Achievement Message

• Description: Sets the message displayed for follow alerts.

Anonymous Follow Mode

• Description: Enables anonymous follow mode.

Anonymous Follower Name

Raid Settings

Background Colour

Gamerscore Amount

Gamerscore Amount to Trigger Rare Achievement

Achievement Name

Achievement Message

Subscriber Settings

Background Colour

Gamerscore Amount

Gamerscore Amount to Trigger Rare Achievement

Achievement Name

Achievement Message

YouTube Settings

Gamerscore Tracker Guide

This widget will track all of the achievements Gamerscores and keep a total for your stream. You can use the following chat commands to control them.

| --- | --- |