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

1. Once you have run the settings in the previous steps and close the window, you will be prompted with a window that will ask you to log into Twitch. You should only need to do this the first time using this product.

2. Upon pressing OK, another window will pop up letting you know a browser source interaction window has opened in OBS. Log into Twitch there and then close the window and press OK.

3. Now when you start to raid a channel everything should be working correctly. If you are prompted to Approve the stream due to it requiring a mature audience. You can run the ‘Minim Raid Out • Approve Mature Stream’ action. This will open another browser interact window in OBS that you can quickly press the ‘Approve Stream’ button. Then you can close. Since you logged in with Twitch, you shouldn’t be asked to approve again.

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

• Description: This is the number assigned to your OBS connection in Streamer.Bot. You can find it in the ‘Stream Apps -> OBS’ tab.
• Options:
  • OBS Connection Number:
    • Default: 0
    • Additional OBS connections can be selected by choosing other numbers.

Would you like OBS to automatically stop your stream 5 seconds after the raid completes?

• Description: Toggle to enable or disable automatic stopping of the stream a few seconds after the raid finishes.
• Options:
  • Yes: Stream stops automatically 5 seconds after the raid.
  • No: Stream will not stop automatically.

Would you like the stream preview to go full screen before the raid completes?

• Description: Toggle to enable or disable the stream preview switching to full screen before the raid completes.
• Options:
  • Yes: The stream preview will go full screen before the raid completes.
  • No: The stream preview remains in its original size.

How much time before the raid sends does the stream preview switch to full screen?

• Description: Set the amount of time (in milliseconds) before the raid sends when the stream preview switches to full screen.
• Options:
  • Default Value: 10000 (10 seconds).

Design Settings

Rounded Corners

• Description: Toggle to enable or disable rounded corners for display elements during the raid.
• Options:

Text Settings

• Raid Started Message:
• Raid Cancelled Message:
• Raid Sub-heading Message:

Colour Settings

• Countdown Bar Colour:
• Raid Message Text Colour:
• Raid Sub-heading Text Colour:
• Raid Username Text Colour:

Would you like to have the text outlined?

• Description: Toggle to enable or disable outlines for the raid text.
• Options:
• Raid Message Text Outline Colour:
• Raid Sub-heading Text Outline Colour:
• Raid Username Text Outline Colour: