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>
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
By default this product is setup to work with Twitch and YouTube. It will allow users to earn points an average rate of 3,500 Points Per Hour on the basis that they are there for the full hour and constantly chatting. There are various triggers already setup. You can disable ones you don’t want to use by following the instructions on this page:
Settings
This overview explains the function of each setting. By adjusting these settings, you can control the rate at which users earn points. You can access this menu by going to the Currency Core • Settings action then right clicking the Test trigger, then press Test Trigger.
Buttons
- 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.
- Save Button
- Function: Saves the current settings.
- Location: Bottom-centre of the UI.
- Action: Click to save your changes.
- 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
The general settings allow you to customize how users earn points during your stream. Adjust these settings to control the rate at which points are awarded based on different activities.
What would you like to call your points
- Description: This setting allows you to name your currency. The name you choose will be displayed wherever points are referenced.
- Usage: Enter the desired name for your points. For example, you can call them "Coins", "Stars", or "Tokens".
Chat Messages give random amount of points
This section controls the points distribution for chat messages. Users can earn points randomly within the specified range.
- Min Points Per Chat
- Description: Sets the minimum number of points a user can earn per chat message.
- Usage: Enter a number to specify the minimum points. For example, if set to 10, users will earn at least 10 points per message.
- Max Points Per Chat
- Description: Sets the maximum number of points a user can earn per chat message.
- Usage: Enter a number to specify the maximum points. For example, if set to 15, users can earn up to 15 points per message.
Chat Message Cooldown
- Description: Sets the cooldown period in seconds between messages for earning points. This prevents spamming.
- Usage: Enter the number of seconds to set the cooldown. For example, if set to 15, users can earn points from chat messages every 15 seconds.
Points For First Words
- Description: Sets the number of points awarded for a user's first message in the chat.
- Usage: Enter the number of points to award. For example, if set to 50, users will earn 50 points for their first message.
Points Per Present Viewers Tick
- Description: Sets the number of points awarded per tick (a unit of time) based on the number of active viewers.
- Usage: Enter the number of points to award per tick. For example, if set to 50, users will earn 50 points for each tick they are present.
Points Per Dollar Tipped
- Description: Sets the number of points awarded for every dollar tipped.
- Usage: Enter the number of points to award per dollar. For example, if set to 200, users will earn 200 points for every dollar tipped.
By adjusting these settings, you can tailor the points system to fit your streaming community's needs and ensure a balanced and engaging experience.
Twitch Settings
The Twitch settings allow you to customize how users earn points based on their interactions on your Twitch channel. Adjust these settings to control the points awarded for various Twitch-specific activities.
Points Per Bit
- Description: Sets the number of points awarded for each bit cheered by a user.
- Usage: Enter the number of points to award per bit. For example, if set to 1, users will earn 1 point for each bit cheered.
Points Per T1
- Description: Sets the number of points awarded for a Tier 1 subscription.
- Usage: Enter the number of points to award for a Tier 1 subscription. For example, if set to 300, users will earn 300 points for subscribing at Tier 1.
Points Per T2
- Description: Sets the number of points awarded for a Tier 2 subscription.
- Usage: Enter the number of points to award for a Tier 2 subscription. For example, if set to 700, users will earn 700 points for subscribing at Tier 2.
Points Per T3
- Description: Sets the number of points awarded for a Tier 3 subscription.
- Usage: Enter the number of points to award for a Tier 3 subscription. For example, if set to 1900, users will earn 1900 points for subscribing at Tier 3.
Points Per Month Subbed
- Description: Sets the number of points awarded for each month a user is subscribed.
- Usage: Enter the number of points to award per month of subscription. For example, if set to 10, users will earn 10 points for each month they maintain their subscription.
Points Per Raid
- Description: Sets the number of points awarded for each raid initiated by the user.
- Usage: Enter the number of points to award per raid. For example, if set to 250, users will earn 250 points for each raid they initiate.
Points Per Raid Viewer
- Description: Sets the number of points awarded for each viewer participating in a raid.
- Usage: Enter the number of points to award per raid viewer. For example, if set to 5, users will earn 5 points for each viewer they bring in a raid.
Points Per Follow
- Description: Sets the number of points awarded for each new follower.
- Usage: Enter the number of points to award per follow. For example, if set to 100, users will earn 100 points for each new follower.
Points Per Gift Sub
- Description: Sets the number of points awarded for each gifted subscription.
- Usage: Enter the number of points to award per gifted sub. For example, if set to 200, users will earn 200 points for each gifted subscription.
By adjusting these settings, you can incentivize and reward various activities on your Twitch channel, enhancing engagement and encouraging participation.
Twitch Settings
The Twitch settings allow you to customize how users earn points based on their interactions on your Twitch channel. Adjust these settings to control the points awarded for various Twitch-specific activities.
Points Per Bit
- Description: Sets the number of points awarded for each bit cheered by a user.
- Usage: Enter the number of points to award per bit. For example, if set to 1, users will earn 1 point for each bit cheered.
Points Per T1
- Description: Sets the number of points awarded for a Tier 1 subscription.
- Usage: Enter the number of points to award for a Tier 1 subscription. For example, if set to 300, users will earn 300 points for subscribing at Tier 1.
Points Per T2
- Description: Sets the number of points awarded for a Tier 2 subscription.
- Usage: Enter the number of points to award for a Tier 2 subscription. For example, if set to 700, users will earn 700 points for subscribing at Tier 2.
Points Per T3
- Description: Sets the number of points awarded for a Tier 3 subscription.
- Usage: Enter the number of points to award for a Tier 3 subscription. For example, if set to 1900, users will earn 1900 points for subscribing at Tier 3.
Points Per Month Subbed
- Description: Sets the number of points awarded for each month a user is subscribed.
- Usage: Enter the number of points to award per month of subscription. For example, if set to 10, users will earn 10 points for each month they maintain their subscription.
Points Per Raid
- Description: Sets the number of points awarded for each raid initiated by the user.
- Usage: Enter the number of points to award per raid. For example, if set to 250, users will earn 250 points for each raid they initiate.
Points Per Raid Viewer
- Description: Sets the number of points awarded for each viewer participating in a raid.
- Usage: Enter the number of points to award per raid viewer. For example, if set to 5, users will earn 5 points for each viewer they bring in a raid.
Points Per Follow
- Description: Sets the number of points awarded for each new follower.
Supported Triggers
These are the current triggers set for Twitch and YouTube events. Each trigger is defined by its source (either Twitch or YouTube) and the type of event that activates it.
If you do not want any of these triggers to be active, you can simply turn them off. This can typically be done in the context menu of the trigger.
| --- | --- |
Commands
This extension comes with several commands for you and your chat to use, they are listed below.
| --- | --- |
<aside>
<img src="/icons/info-alternate_blue.svg" alt="/icons/info-alternate_blue.svg" width="40px" /> Just note that when using the set and add to all commands it will only change the users that already have some points, so take care when using these.
</aside>