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>

After Streamer.Bot Installation

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>

User Guide

How to Use

The StreamUP "Discord Going Live" feature allows you to automatically post notifications to your Discord server when you start streaming on Twitch or YouTube. This ensures your community stays updated and can join your live streams promptly.

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

Enter your Discord Webhook URL

• Description: The Webhook URL to which the live stream notifications will be posted.
• Usage: Obtain your Discord Webhook URL from your Discord server settings and paste it here.
• Link: Find out how to get this here

Only post 'public' YouTube Livestreams

• Description: Enable this option to ensure only public live streams are announced on Discord.
• Usage: Check the box to filter out unlisted or private live streams from being posted.

Would you like to ping Everyone?

• Description: Enable this option to ping everyone in the Discord server when you go live.
• Usage: Check the box if you want the notification to mention @everyone.

Please enter the role ID you wish to ping

• Description: The role ID that will be mentioned in the notification instead of @everyone.
• Usage: Enter the specific role ID if you prefer to ping a particular role instead of everyone.
• Note: This option is ignored if the "ping Everyone" option is enabled. You will also need to activate developer mode in order to be able to copy a RoleID.

This is your post message

• Description: The message content that will be posted to Discord.
• Usage: Customize the message to your liking. Use variables like %pingedRole% to dynamically insert the role mention. This will support general discord markdown formatting.

Would you like to create an embedded message?

• Description: Enable this option to send the notification as an embedded message.
• Usage: Check the box to use Discord's embed feature, which supports richer formatting.

This is your embed title

• Description: The title of the embedded message.
• Usage: Enter a title that will appear at the top of the embed, such as "I have just gone live!".

What colour would you like your embed?

• Description: The colour of the embed's border.
• Usage: Click "Pick a colour" to choose a colour that matches your brand or preferences.

What would you like to use as your embed message?

• Description: The main content of the embedded message.
• Usage: Customize the content using variables like %title% to insert dynamic information. This will support general discord markdown formatting.

This is the icon for the embed

• Description: URL to an image that will be displayed as the icon in the embed.
• Usage: Provide a URL to an image that represents your stream or channel.

This is the AvatarURL for the Bot

• Description: URL to an image that will be used as the bot's avatar in the notification.
• Usage: Enter the URL to the image you want the bot to use.

This is the Name of the Bot

• Description: The display name of the bot posting the notification.
• Usage: Enter a custom name for the bot, such as "GoingLiveBot".

Try pull the game from Twitch

• Description: Enable this option to automatically include the game you're playing in the notification.
• Usage: Check the box to pull game information directly from Twitch.

This is the game art you want to show if on YT, if default is not selected

• Description: The fallback game title to show if the game cannot be automatically detected.
• Usage: Enter a default game title, like "Just Chatting", to be used when streaming on YouTube.

This is an example of how it could look, I’ve changed the titles so you know what each one is. Just note that the AvatarURL is the StreamUP Logo, and the Icon is the picture of my face.

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.