StreamUP Docs

Appearance

Configuring StreamUP Points Core System ​

by CodeWithTD ​
Version: 3.0.0Page Incomplete
DLLStreamerbot Import

💡General Notice

This guide assumes you have the latest StreamUP DLL installed. All required plugins, including the StreamUP plugin, and Streamer.Bot should be up to date. It also assumes you have already imported any fonts, OBS scenes, and Streamer.Bot import files.

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

If you haven't and where appropriate please follow these specifically:

Some steps are accompanied by images, you can click on these images to make them bigger. Where appropriate they have been tagged with Numbers, you can find the corresponding number in brackets (X)

By default this product is setup to work with Twitch, YouTube and Now KICK!. 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 customize it to how you would like it to work:

The Settings ​

Running Currency System • Settings will open the settings window, in here you can adjust settings and how you want your Points System to run from changing what you call your points and how they save all the way how much a user will get for following.

System Settings ​

These settings control the core behavior of your points system, such as what you call your points, the variable name used in Streamer.bot, the default point amount, and whether certain users receive a boost when earning points. You can also set the group for boosted users and the boost multiplier.

  • What would you like to call your points?: Sets the display name for your points (e.g., Typos, Crumbs, Coins).
  • What variable name would you like Streamer.bot to use?: The internal variable name used for storing points. Recommended to keep as 'points' unless you have a conflicting system.
  • Default point amount: Minimum number of points a user will have. If their balance falls below this, it will be rounded up to this value (set to 0 to disable).
  • Do you want certain users to gain a boost when earning points?: Enables/disables a boost group for users who should earn more points.
  • Group for users who gain a boost: Selects the group whose members will receive boosted points.
  • How much of a boost should the users get?: Sets the multiplier for boosted users (e.g., 1.5x points).

General Settings ​

General settings let you configure how points are awarded for chat activity, including minimum and maximum points per chat message, cooldowns, points for first words, present viewers, and tips. These settings help you fine-tune how users earn points through regular engagement and tipping.

  • Minimum Points Per Chat Message: The lowest number of points a user can earn per chat message.
  • Maximum Points Per Chat Message: The highest number of points a user can earn per chat message.
  • Cooldown Per Chat Message: The time (in seconds) before a user can earn points for another chat message.
  • How many points would you like for first words?: Points awarded for a user's first message in chat.
  • How many points would you like per Present Viewer Tick?: Points given for each present viewer tick (periodic check).
  • How many points would you like per Dollar Tipped?: Points awarded per USD tipped (used for tip integrations).

Twitch Settings ​

Twitch-specific settings allow you to set how many points are given for Twitch events like bits, subscriptions (Tier 1, 2, 3), months subbed, raids, viewers, follows, and gift subs. You can also choose to boost gift subs with the tier value, making Twitch rewards customizable for your community.

  • How Many Points Per Bit: Points given for each Twitch bit cheered.
  • How Many Points Per Tier 1/2/3: Points awarded for each subscription tier (Tier 1, 2, or 3).
  • How Many Points Per Month Subbed: Points given for each month a user is subscribed (added to tier value).
  • How Many Points Per Raid: Points awarded for each raid event.
  • How Many Points Per Viewer: Points given for each viewer in a raid (collective bonus).
  • How Many Points Per Follow: Points awarded for each new Twitch follow.
  • How Many Points Per Gift Sub: Points given for each gifted subscription.
  • Boost each gift sub with the Tier Value?: If enabled, gift subs are boosted by the tier value (e.g., 5 Tier 1 subs = 1000 + 1500 points).

YouTube Settings ​

YouTube settings let you configure points for YouTube subs, memberships, membership levels, gifted memberships, and membership months. You can specify points for each membership type, set a default for not found memberships, and choose to boost gifted memberships with the level value.

  • How Many Points Per Sub: Points awarded for each new YouTube subscriber.
  • How many points for each membership: Points given for each membership type (e.g., Core Supporter, Prime Supporter, Ultimate Supporter, with different levels).
  • How Many Points Per Membership (Not Found): Default points if the membership type is not found in the table.
  • How Many Points Per Membership Months: Points given for each month a user is a member (added to membership value).
  • How Many Points Per Gifted Member: Points awarded for each gifted membership.
  • Boost each gift sub with the Level Value?: If enabled, gifted memberships are boosted by the level value (e.g., 5 basic memberships = 2500 + 2500 points).

Kick Settings ​

Kick settings allow you to set points for Kick follows, subs, sub months, and gifts. These options help you reward users for engagement on the Kick platform, similar to Twitch and YouTube settings.

  • Points for a Kick Follow: Points awarded for each new Kick follow.
  • Points for a Kick Sub: Points given for each Kick subscription.
  • Points for a Kick Sub Month: Points awarded for each month a user is subscribed on Kick.
  • Points for a Per Kick Gift: Points given for each gifted Kick subscription.

Triggers ​

Each trigger is an action that can be performed on user points:

  • Add Points: Adds a specified amount of points to a user.
  • Set Points: Sets a user's points to a specific value.
  • Reset Points: Resets a user's points to the default or zero.
  • Add To All: Adds points to all users in the system.
  • Set To All: Sets all users' points to a specific value.
  • Get Points: Retrieves and displays a user's current points.
  • Generic Fail: Used when a points action fails (e.g., not enough points, invalid user).

Variables Available ​

This section provides a list of available variables that can be used in the output messages.

  • %user%: The user who used the command.
  • %points%: The number of points a person has.
  • %pointsName%: The name of the points.
  • %target%: The user whose points are being adjusted.
  • %addAmount%: The amount being added.
  • %setAmount%: The amount the points are being set to.
  • %count%: The number of users being adjusted.

Use these variables to customize the output messages as needed.

Commands ​

As previously mentioned commands when imported are disabled by default, and so these will need enabling if you haven't already done that, you can find how to do that in the Installing SB File in Streamer.Bot that is linked above.

These commands can change to whatever you require them to be, however do not create new commands as these work on the command ID so new commands will not work, if you accidentally delete a command you will need to reimport it, however changing !getPoints to !getCrumbs is perfectly acceptable.

These are the commands you can expect to find in this product. Due to YouTubes naming scheme and the fact you can have duplicate names and spaces, any targeted commands like Adding and Setting you will need to put the Value first for example !addPoints 5000 Andilippi or !setPoints 1000 Terrier Darts, also note if you do the command on Twitch it will only target Twitch Viewers, if you do it on YouTube it will only target YouTube. The same with Kick.

  • !addToAll
  • !addPoints
  • !points
  • !resetAllPoints
  • !setPoints
  • !setToAll

Events Supported ​

Many Events are supported in this Product, below you can see a list of them and a link to the official Streamer.bot Documentation on it.

Twitch ​

YouTube ​

Kick ​

Tipping Support ​

Tips are supported in this system however they are not automatically given to the viewer this is because it is not always clear who gave the tip and what platform they are from. There fore when a tip is recieved you will see a message in chat saying %donator% tipped %userGave% this works out as $%amountInUSD% and they will require %pointsNeeded% %pointsName%. Then it will be on you to assign the points correctly. All of the current methods that tipping can be done in Streamer.bot is supported. You can find links on the supported