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. When you run the settings action and then press save. You will be prompted to finish the setup in OBS with the following message:

   

   1. In OBS there will be a properties window open. Select the Clone dropdown and select the source you wish to take photos of. Then press OK

      

   2. Resize and Crop the Polaroid Picture • Source source in OBS so it aligns inside of the Polaroid Picture

      

   3. In the Source list, drag the Polaroid Picture • Source source into the Polaroid Picture • Group group, then press OK in Streamer.Bot

      

2. You need to set how you want this effect to trigger by selecting the Actions tab. Under the Actions window on the left select Polaroid Picture • Main Action. Under the Triggers window on the right, right click the Reward Redemption trigger. Either create a new reward or add it to one that already exists (make sure it has User Input Required enabled) then press OK.

   

Changing and Editing a Camera

1. Select the Polaroid Picture • Edit Camera action and right click the Test trigger and press Test Trigger.

   

2. You will then be greeted with the same setup process as the initial setup here: When you run the settings action and then press save. You will be prompted to finish the setup in OBS with the following message:

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: 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.

Toggle countdown on/off

• Description: Toggle to enable or disable the countdown before the polaroid picture effect.
• Options:
  • Checked: Countdown is enabled.
  • Unchecked: Countdown is disabled, and the freeze frame will happen instantly.

Select where you want to polaroid picture to land on screen

• Description: Choose the position on the screen where the polaroid picture will appear.
• Options:
  • Random: The picture will land at a random position.
  • Additional predefined positions may be available.

Toggle polaroid shadow on/off

• Description: Toggle to enable or disable the shadow effect on the polaroid picture.
• Options:
  • Checked: Shadow is enabled.
  • Unchecked: Shadow is disabled.

Select polaroid frame colour

• Description: Choose the colour of the polaroid frame.
• Options:
  • Pick a colour: Opens a colour picker to select the frame colour.

Select text colour

• Description: Choose the colour of the text on the polaroid picture.
• Options:
  • Pick a colour: Opens a colour picker to select the text colour.

Discord Settings

Toggle send to Discord on/off

• Description: Toggle to enable or disable sending notifications to Discord.
• Options:
  • Checked: Enable sending notifications to Discord.
  • Unchecked: Disable sending notifications to Discord.

Enter your Discord Webhook URL

• Description: The URL used to send notifications to a specific Discord channel.
• Instructions:
  • Paste your Discord Webhook URL into the text field.
  • For instructions on how to get your Webhook URL, click the link.

Use Rich Text for the Discord post

• Description: Toggle to enable or disable the use of rich text formatting in the Discord post.
• Options:
  • Checked: Enable rich text formatting, making the Discord post visually appealing.
  • Unchecked: Disable rich text formatting.

Save Locally