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>

<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

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.
• Enable any commands and ensure permission on starting them is correct.
• You can load up the Settings and Adjust them to your needs.

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, and by following the instructions on this page you can customise it to how you would like it to work:

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

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.

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.

General Settings covers the administration settings and multi-platform settings.

• What would you like to call your points?

  • This is how it would be displayed in chat.

• What variable would you like Streamer.bot to use?

  • This is how Streamer.bot saves the variable, it’s recommended to keep this as points, but you can switch it if you choose to.

• What would you like to be the default point amount?

  • This is the default amount a user will be rounded up to if they drop below this amount, if you don’t want this to happen you can set this to 0.

• Minimum Points Per Chat

  • This is a minimum amount a user will get for chatting.

• Maximum Points Per Chat

  • This is the maximum amount a user will get for chatting, you can have this the same as the minimum to have it act as a set amount.

• Cooldown Per Chat

  • This is the cooldown applied to each chat message to prevent spamming for points, if you don’t want users to earn points for chatting you can just disable the trigger.

• How many Points for first words

  • This is the amount of points a user will earn when they chat for the first time.

• How many points per Present Viewers Tick

  • This is the amount of points a user will earn per present viewer tick, this works across both platforms so if multi-streaming try ensure the timing matches.

  <aside> 🚨

  Please Note this will run regardless if you are live or not, there is no checking on this, if you want to only run it while live the solution is to Enable and Disable the triggers when you go live. If you would like help in doing this reach out in the discord.

  </aside>

• How many points per Dollar Tipped

  • This works out centrally into dollars, and will out how many points is required, for YouTube this will auto add points, but for other platforms it can not do this so will post a message saying how many points are owed.(Unless you change the default behaviour, in the Tipping Action)

• Do you want certain users to gain a boost when earning points.

  • This is a yes or no, if you want some users to earn more points, boosts only effect the earning of points and not gambling. If you say no here, the next two settings do not matter.

• Group for users who gain a boost

  • This is the group for the users who will gain the boost, a default group will be created but you can use your own if you have one.

• How much of a boost will the users get

  • This is the multiplier the user will receive.

By adjusting these settings, you can tailor the points system to fit your streaming community's needs and ensure a balanced and engaging experience.

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>