Code Docs

StreamUP Product Documentation

General Notices

<aside> 💡

Please make sure you have followed the standard product installation steps for StreamUP products.

Install the product into OBS. Getting Started

This product doesn’t use the StreamUP DLL (yet), so that step is for now, not required!

Like the rest of our products, we also assume you have a basic knowledge of Streamer.bot

</aside>

Getting your StreamUP API Key

1. Go to https://api.streamup.tips/twitch
   1. Read the very important notice on the website
2. Click on the button “LOGIN WITH TWITCH”
3. On the next page Twitch gives you a summary what we need / require and on that page you click Authorize
4. After it’s done you should get a message with “Hi, YourUserName” that means that everything went successfully!
5. Click on text “Click here to reveal your key.”
   1. Make sure you don’t show this to anyone!
6. Copy that code into your clipboard it will be used later!

Configuring Pokémon and Friends

Creating and Assigning a Channel Reward Redemption.

1. Go to the “Actions” tab

2. Click on “StreamUP - Pokémon and Friends - Perform Catch”

3. Right click on white space in the triggers field

4. Go to “Twitch”

5. Go to “Channel Reward”

6. Select “Reward Redemption”

   

7. On the new window click on Create Reward

   

8. Give your Reward a Title. This really doesn’t matter as the bot automatically changes it to “Catch the ‘Pokemon Name’”

9. Give it a cost, whatever feels right in your community

10. Give it a description so people know what this reward is

11. Click Ok

    

    <aside> 💡

    Note that you can customize the rest as well, but we are going over the bare minimum 😉

    </aside>

12. The reward you’ve just created should be automatically selected and press Ok

    

Opening and configuring PaF settings

1. Click on the “StreamUP - Pokémon and Friends - Settings” Action

2. Right Click on “Core - Test” Trigger

3. Press “Test Trigger”

   

4. There should popup a new window and you can Paste the StreamUP API Key into the first available field

5. Select the Channel Point Reward you created earlier

   

6. The rest of the settings you can adjust to your liking, please read what each setting is does and can do, after you are done press “Save” at the bottom.

<aside> 📢

The last 5 settings on the bottom (not shown on the provided screenshot) are for your own custom actions to be run it can be something like sound effects or anything else like that, do NOT assign the original actions to these fields! Other wise you will create an infinite loop!

</aside>

Enabling the Twitch Commands

1. Go to Commands

2. Find the “StreamUP - Pokémon and Friends” Category

3. Right click on the selected action

4. Click on “Enabled”

5. Repeat process for all Commands

   

   We have set that !poke-reset, !poke-end and !poke-spawn are only available for mods and higher

Customizing Spawn and Flee timers

By default we have set that Pokémon spawn between 5 and 15 minutes and flee in 10 minutes after a spawn. But if you don’t like these values you can change them within Streamer.bot.

1. Go to the “Settings” tab within Streamer.bot

2. Go to the “Timed Actions” tab within Settings

   

   <aside> 💡

   If you’re fine with these values you just ONLY need to enable “StreamUP - Pokémon and Friends - Spawn Pokémon Timer”

   </aside>

Changing and Enabling “StreamUP - Pokémon and Friends - Spawn Pokémon Timer”

1. Double click on “StreamUP - Pokémon and Friends - Spawn Pokémon Timer”

2. Tick the box “Enabled”

3. Change the values in the first and second box to a different value (in seconds) to make them spawn more or less frequent.

4. Press “Ok” when you’re done!

   

   <aside> 💡

   From the moment you clicked “Ok” Pokémon will now spawn from that timer.

   </aside>

Changing the “StreamUP - Pokémon and Friends - Automatic Flee Timer”

1. Double click on “StreamUP - Pokémon and Friends - Automatic Flee Timer”
2. Change the value in the box to a different value (in seconds) to make them flee quicker or slower.
   1. Note you can also enable “Random” so that the Pokémon runs away randomly 😉
3. Press “Ok” when you’re done!

And that should be it! StreamUP - Pokemon and Friends - Cloud Edition should now be up and running! If you have any questions or need support feel free to ask us in the discord!