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

This product will just automatically trigger when you receive a hype train.

Settings

This is an overview of what all the settings do. You can access this menu by going to the Codec Moments • Settings action then right clicking the Test trigger, then press Test Trigger.

General Settings

OBS Connection Number

• Description: The number assigned to your OBS connection in Streamer.Bot. This can be found on the left of your OBS connection in the 'Stream Apps -> OBS' tab.
• Options:
  • 0: Default OBS connection number.
  • Additional numbers correspond to other OBS connections you may have set up.

Random Codec Frequency Number

• Description: Toggle this option to randomize the codec frequency number during streaming or recording.
• Options:
  • On: Enables randomization of codec frequency.
  • Off: Disables randomization.

OBS Settings

Rounded Corners

• Description: Toggle the rounded corners effect for elements displayed during the stream.
• Options:
  • Yes: Rounded corners are enabled.
  • No: Rounded corners are disabled.

Transparent Background

• Description: Toggle to enable or disable a transparent background for the display elements.
• Options:
  • Yes: Background transparency is enabled.
  • No: Background transparency is disabled.

Foreground Colour

• Description: Select the foreground colour for elements displayed on screen.
• Options:
  • Hex Value: Choose a colour by its hex value (e.g., #00FFFF).

Background Colour

• Description: Select the background colour for elements displayed on screen.
• Options:
  • Hex Value: Choose a colour by its hex value (e.g., #0080FF).

Main Text Colour

• Description: Set the colour for the main text displayed during the stream.
• Options:
  • Hex Value: Choose a colour by its hex value (e.g., #FFFFFF).

Secondary Text Colour

• Description: Set the colour for the secondary text displayed during the stream.
• Options:
  • Hex Value: Choose a colour by its hex value (e.g., #000000).

OBS Text Settings

• Title Text: Set the title text for the hype train notification (e.g., "Hype Train").
• Main Text: Set the main description text (e.g., "Sub, gift, or use Bits to get to the next level").
• Starting Text: Customize the text displayed when the hype train begins (e.g., "You'll have a limited time to earn exclusive emotes").
• Scrolling Heading Text on Hype Train Start: Set the heading text that scrolls when the hype train starts (e.g., "HYPE TRAIN INCOMING!").
• Scrolling Heading Text on Hype Train End: Set the heading text that scrolls when the hype train ends (e.g., "HYPE TRAIN COMPLETED!").

Chat Message Settings

Send Messages to Chat

• Description: Toggle to enable or disable automatic chat messages for the hype train.
• Options:
  • Yes: Messages are sent to the chat.
  • No: Messages are not sent to the chat.

Send Message as Bot Account

• Description: Toggle to send hype train messages as a bot account.
• Options:
  • Yes: Messages are sent from a bot account.
  • No: Messages are sent from the main account.

Hype Train Started Message

• Description: Customize the message that appears in chat when the hype train starts.
• Default Message: "A Hype Train has started! All aboard!"

Hype Train Level Up Message

• Description: Customize the message that appears in chat when the hype train levels up. Variables include:
  • %contributors%: Number of contributors.
  • %level%: Hype train level.
  • %top.bits.user%: Username of the top bits cheerer.
  • %top.bits.total%: Total bits cheered by the top cheerer.
  • %top.subscription.user%: Username of the highest sub gifter.
  • %top.subscription.total%: Number of gifted subs from the top gifter.

Hype Train Ended Message

• Description: Customize the message that appears in chat when the hype train ends. Variables include:
  • %contributors%: Number of contributors.
  • %level%: Hype train level.
  • %percent%: Percentage progress towards the next level.
  • %top.bits.user%: Username of the top bits cheerer.
  • %top.bits.total%: Total bits cheered by the top cheerer.
  • %top.subscription.user%: Username of the highest sub gifter.
  • %top.subscription.total%: Number of gifted subs from the top gifter.