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

You will need to be a Twitch Affiliate to make this prediction system work. It will automatically animate when a prediction is happening on Twitch.

Show and Hide

You can show and hide the prediction at any point by adding a trigger to the ‘Minim Prediction • Show/Hide Widget’ action. When the prediction is completed, if the widget is not visible, it will automatically unhide it.

Settings

This is an overview of what all the settings do. You can access this menu by going to the Minim Poll • 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.
• Usage: Select the appropriate OBS connection number to link Minim Poll with your OBS setup.

General Settings

Add Transparency

• Description: Makes the background of the prediction widget transparent.
• Usage: Check this option to add transparency to the prediction widget's background, allowing your stream content to be visible behind it.

Add Rounded Corners

• Description: Adds rounded corners to the prediction widget.
• Usage: Check this option to apply rounded corners to the prediction widget for a smoother appearance.

How long the prediction stays on screen when completed

• Description: Duration (in milliseconds) that the completed prediction message remains on screen.
• Usage: Enter the desired duration in the input field.

Set all text to uppercase

• Description: Converts all displayed text to uppercase.
• Usage: Check this option if you want all text in the prediction widget to be displayed in uppercase.

Text displayed when a prediction is cancelled

• Description: Customizable message shown when a prediction is cancelled.
• Usage: Enter the message you want to display when a prediction is cancelled in the input field.

Text displayed when a prediction is completed

• Description: Customizable message shown when a prediction is completed.
• Usage: Enter the message you want to display when a prediction is completed in the input field.

Colour Settings

Customize the appearance of the poll widget by selecting colours for various elements.

Title Settings

Text colour

• Description: Sets the colour of the prediction title text.
• Usage: Click the "Pick a colour" button to select a colour.

Countdown bar colour

• Description: Sets the colour of the countdown bar showing the remaining time for the prediction.
• Usage: Click the "Pick a colour" button to select a colour.

Answer Settings

For each answer option, you can customize the text colour and the voting bar and win colour.

Answer 1 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.

Answer 2 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.

Answer 3 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.

Answer 4 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.

Answer 5 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.

Answer 6 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.

Answer 7 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.

Answer 8 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.

Answer 9 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.

Answer 10 Settings

• Text colour: Sets the colour of the answer text. Click the "Pick a colour" button to select a colour.
• Voting bar and win colour: Sets the colour of the voting bar and the win indicator. Click the "Pick a colour" button to select a colour.