Code Docs

StreamUP Product Documentation

General Notices

<aside> <img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> This product comes without a .StreamUP file because it is just controlled inside of Streamer.Bot. You can however get other Poll overlays to put in OBS that will work with this system from the StreamUP website. Remember you can get access to everything by supporting us monthly!

You still need to install the product into Streamer.Bot and use our DLL so make sure you follow the instructions below! Installing Products into Streamer.Bot Adding a Product into Streamer.Bot Setting Up a Product in 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>

After Streamer.Bot Installation

Alright, now that you have installed everything that is required into Streamer.Bot it is time to start using the Poll System. 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>

Getting A Brickset API Key

For this product to work you will need to get an API key from the Brickset website. This is free and easy to get.

1. Create a Brickset account here: https://brickset.com/signup
2. Head to https://brickset.com/tools/webservices/requestkey
3. Fill out the form with your name and what you will be using the API key for:

1. Check your emails, you will have an API key from Brickset. Make sure to check your junk as well!
2. Make a note of your API key for the steps below!

User Guide

<aside> <img src="/icons/new-alert_gray.svg" alt="/icons/new-alert_gray.svg" width="40px" /> Please note. You will need the following OBS plugin for this to work:

OBS Ghostscript https://obsproject.com/forum/resources/obs-ghostscript.556/

</aside>

1. To load up the instruction manual in the ‘Actions’ tab, select the ‘LEGO Instruction Manual • Load Manual’ Action. Right click the ‘Test’ trigger in the top right corner and select ‘Test Trigger’.

2. A new window will open. Please enter your LEGO set number. (This is printed on the front of the box) and also your API key you got earlier from the Brickset website. If you missed that step you can press the link ‘Click here to get your API key’.

If there is an issue with the LEGO set number or API key, you will be prompted when you press ‘Submit’.

1. You will receive different manuals for the LEGO set provided. These will be in different languages etc. You can select the one you want and press ‘Preview’ to make sure that is the one you want. Once happy press ‘Select’.

It will begin to download locally, this will be shown with a progress bar. This file will be saved in your Streamer.Bot directory then in ‘/StreamUP/LEGO’.

1. When the download is finished you will be prompted if you would like the instruction manual to be opened in a separate window so you can look at it for yourself.

2. The instruction manual will then be sent into OBS. You can add this to other scenes, resize etc.

3. To change what page you are on in the instruction manual there are 2 Actions in Streamer.Bot you can use.

   1. LEGO Instruction Manual • Next Page
   2. LEGO Instruction Manual • Previous Paged

You can set these up for any trigger you like such as a hotkey or even use Streamdeck etc. Just add a new trigger in the top right of each action.