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 first words. This means this product will automatically trigger the first time any user chats each stream. This is automatically handled by Streamer.Bot and is reset every 12 hours by default.

You can use this product with many different triggers. They just need to be triggers that utilise some kind of message. This can be a cheer, super chat, donation, pretty much anything! If the trigger method you want doesn’t work, feel free to feed it back to StreamUP and we can try and add it in a future update.

Follow this guide if you need to know how triggers work: 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 Highlight Message • Settings action then right clicking the Test trigger, then press Test Trigger.

Buttons

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.

Save Button

• Function: Saves the current settings.
• Location: Bottom-centre of the UI.
• Action: Click to save your changes.

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.

Text Box Background Colours

• Top Left Colour: Sets the colour for the top left corner of the text box background.
• Top Right Colour: Sets the colour for the top right corner of the text box background.
• Bottom Left Colour: Sets the colour for the bottom left corner of the text box background.
• Bottom Right Colour: Sets the colour for the bottom right corner of the text box background.

Text Colours

• Text Colour: Sets the colour of the text displayed in the highlight message.
• Text Drop Shadow Colour: Sets the colour of the drop shadow for the text, enhancing its visibility.

Misc. Settings

• How long each character takes to type (in ms): Sets the typing animation speed for the characters in the message. Measured in milliseconds.
• How long the animation stays on screen: Determines the duration the message animation remains visible on the screen. Measured in milliseconds.