Code Docs

StreamUP Product Documentation

Getting Started

1. Open the 1 - DOWNLOAD AND INSTALL THESE FIRST and make sure to download and install all of the items. You can skip any that you already have installed previously.

   These are usually things like the StreamUP OBS Plugin and different fonts that cannot be distributed with the product.

   

Installing StreamUP Products into OBS Studio

Setup OBS Studio

This section is to make sure you have OBS Studio setup correctly. We will check if you have all the required plugins installed and if not show how to install them.

<aside> <img src="/icons/exclamation-mark-double_red.svg" alt="/icons/exclamation-mark-double_red.svg" width="40px" /> Please make sure OBS Studio is up to date. The minimum OBS Studio version required is v28. However products are only tested on the latest builds of OBS Studio

</aside>

1. Download & install the StreamUP OBS Plugin.

   1. Extract the downloaded .zip file.
   2. Copy the contents of the Windows folder into your obs-studio folder. The file path is usually:

   <aside> <img src="/icons/folder_gray.svg" alt="/icons/folder_gray.svg" width="40px" /> C:\Program Files\obs-studio

   </aside>

2. Open OBS then on the top menu bar, select Tools -> StreamUP -> Check Product Requirements.

   

   1. If you have any OBS plugins that need installing or updating they will be displayed here. You can then do one of the following:

      

      1. Download the StreamUP Pluginstaller and follow the YouTube tutorial.
      2. Click on the Download link on each plugin. It will automatically use your web browser to download the selected plugin.

   2. Install all the plugins you downloaded into OBS by copying the files into the obs-studio folder just like you did for the StreamUP OBS plugin.

Adding a Product into OBS Studio

This section is to show you how to install a StreamUP product into OBS Studio using the provided .StreamUP files.

<aside> <img src="/icons/exclamation-mark-double_red.svg" alt="/icons/exclamation-mark-double_red.svg" width="40px" /> Please note: Make sure you place the products folder somewhere safe on your PC. Moving it after install will break the product as OBS will lose track of the reference files.

</aside>

1. In OBS, on the top menu bar, select Tools -> StreamUP -> Install a Product

   

2. Navigate to the products folder you wish to install. Open the 2 - OBS INSTALL folder and open the .StreamUP file. This will create a new scene/s in OBS.

   

Installing Products into Streamer.Bot

<aside> <img src="/icons/exclamation-mark-double_red.svg" alt="/icons/exclamation-mark-double_red.svg" width="40px" /> Please make sure Streamer.Bot is up to date. All products are tested on the latest versions of Streamer.Bot.

</aside>

StreamUP Library Setup

This section is to install the StreamUP library file for Streamer.Bot. This file is required for the products to function so it is imperative you follow these instructions carefully.

<aside> <img src="/icons/exclamation-mark-double_red.svg" alt="/icons/exclamation-mark-double_red.svg" width="40px" /> Please Note: If the following file doesn't exist in the download, don't worry! It just means that it is not currently required for that particular product.

However you can download it from here

StreamUP_Library_Updater.zip

</aside>

1. Navigate to the 3 - STREAMER.BOT INSTALL folder and copy/cut the StreamUP_Library_Updater.exe file.

   

2. Navigate to your Streamer.Bot folder and paste the file into the root of it.

   

3. Double click the StreamUP_Library_Updater.exe to open it up.

   

4. Hit the Download or Update button. When you are all up to date, you can close this window.

   

Adding a Product into Streamer.Bot

This section is to show you how to install a StreamUP product into Streamer.Bot using the provided .sb files.

1. In Streamer.Bot, navigate to the tab Servers/Clients → WebSocket Server and enable Auto Start.

   Configure the following settings then press Start Server.

   <aside> <img src="/icons/gear_gray.svg" alt="/icons/gear_gray.svg" width="40px" /> Address - 127.0.0.1 Port - 8080 Endpoint - /

   </aside>

   

2. Navigate to the tab Stream Apps → OBS and make sure your OBS is connected via WebSocket 5.x. Make a note of the connection number (by default this is 0).

   

   The default settings should be fine.

   

3. Press Import in the top left.

   

4. Navigate to the 3 - BOT INSTALL\STREAMER.BOT folder.

   

   Drag & drop the .sb into the Import String field. Press Import

   

   <aside> <img src="/icons/exclamation-mark-double_red.svg" alt="/icons/exclamation-mark-double_red.svg" width="40px" /> Important Note:

   If you cannot drag and drop the file you can open it using Notepad. Select all of the text (CTRL + A) and copy it (CTRL + C). Paste the copied text into the Import String box inside of Streamer.Bot.

   </aside>

Setting Up a Product in Streamer.Bot

This section will show you how to setup a StreamUP product and customise its settings in Streamer.Bot.

1. Select the Actions tab. Under the Actions window on the left select [*ProductName] *• Settings. Under the Triggers window on the right, right click the top trigger and press Test Trigger

2. Configure the products settings and follow any prompts on screen. Make sure the OBS Connection Number is set. By default this is 0. You can double check yours by going to the Stream Apps tab in Streamer.Bot

3. To test everything is working okay, head to the Actions tab on the left and select [ProductName] • Main Action. In the Triggers window on the right side, right click a trigger and press Test, check OBS to see the alerts in action.

Enabling Chat Commands In Streamer.Bot

This section will show you how to enable chat commands for a StreamUP product in Streamer.Bot.