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 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 Enabling Chat Commands 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>

User Guide

This guide assumes that you are connected to Twitch and/or YouTube correctly, the StreamUP DLL is in the dll folder and it is up-to-date and you are running the latest version of Streamer.bot. These can all be checked or done with the links above.

How to Set Up

So once imported into Streamer.bot we can start modifying this to your needs.

• You can load up the Settings and Adjust them to your needs.

This product will work with both Twitch and YouTube.

Settings

This is where you can adjust the settings of the discord post. This will help you control how it looks or what it says, you can access this by going into the Discord Going Live • Settings Action and right clicking on the Test trigger and then pressing Test Trigger from the context menu.

Buttons

1. 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.
2. Save Button
   • Function: Saves the current settings.
   • Location: Bottom-centre of the UI.
   • Action: Click to save your changes.

Settings

General

General Settings allow you to set up the basic settings these will be needed regardless of the platform you are using.

• Please Enter Your Webhook.
  • This is a URL that tell us where to post, there is a link below in the setting to tell you more about this.
• This is the AvatarURL for the Bot
  • This is what the image of the user posting will be, by default it is the StreamUP Logo
• This is the name of the bot posting.
  • This is the name of the bot that is posting, This is by default Going Live Bot but you can change this to suit your brand.

Twitch

These settings are controls what the post will look like when you go live on Twitch, if you don’t stream on Twitch these setting are skippable. Howe

• Would you like to ping Everyone.
  • Just a simple yes or no if you want to ping everyone.
• Role Id of the role you want to ping.
  • If you are pinging everyone this doesn’t matter, also you need to have dev mode on to get role ID, link below in settings for that.
• What would you like you message to say?
  • This is what the post will say, it will not be on the embed. This will accept Arguments.
• Would you like to create an embed.
  • If this is set to yes, everything following can be ignored and the post will be more simplistic
• What would you like to Title your Embed.
  • This usually seen as the white heading, it will accept some discord formatting.
• What colour would you like your Twitch Embed
  • This is seen as a little line down the side.
• What would you like to use as your embed message.
  • This is the main body of the embed, it will accept some discord formatting.
• This is the Icon for the embed
  • This will show as a little icon in the top left, if none is given it just won’t show

YouTube

These settings are controls what the post will look like when you go live on Twitch, if you don’t stream on Twitch these setting are skippable.

• Pull Game Category from Twitch
  • If set to Yes, the game category will automatically be pulled from Twitch based on your live stream. If set to No, the default game selected below will be used.
• Default Game
  • Choose a default game category (e.g., "Just Chatting") to use when "Pull Game Category from Twitch" is set to No.
• Live Stream Post Type
  • Select which live streams to post.
  • Example: "Public Only" means only public streams will be shared.
• Copy Settings from Twitch
  • Any settings that are checked will copy the same setting from the Twitch Tab, and therefor can be ignored, if unchecked you will need to set them.
• Would you like to ping Everyone.
  • Just a simple yes or no if you want to ping everyone.
• Role Id of the role you want to ping.
  • If you are pinging everyone this doesn’t matter, also you need to have dev mode on to get role ID, link below in settings for that.
• What would you like you message to say?
  • This is what the post will say, it will not be on the embed. This will accept Arguments.
• Would you like to create an embed.
  • If this is set to yes, everything following can be ignored and the post will be more simplistic
• What would you like to Title your Embed.
  • This usually seen as the white heading, it will accept some discord formatting.
• What colour would you like your Twitch Embed
  • This is seen as a little line down the side.
• What would you like to use as your embed message.
  • This is the main body of the embed, it will accept some discord formatting.
• This is the Icon for the embed
  • This will show as a little icon in the top left, if none is given it just won’t show

Arguments and Triggers

This has only 2 triggers, those are the going live for the platforms Twitch and YouTube.

In your messages you also have a few arguments you can use in your post.