Code Docs

StreamUP Product Documentation

This documentation is now old. Please update to the newest version.

General Notices

<aside> 💡 This product will work without the core system, but it is highly recommended for you to install that too.

Currency Core V1

</aside>

<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

By default this product is setup to work with Twitch and YouTube. It allows users to gamble their points for a chance to win big on the slot machines. This slot machine is full customisable allowing you to change the odds an emote may show up, which emotes it uses and how much it pays out along with some other settings.

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 Slots • 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.
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

What would you like to call your points

• Description: Specifies the name that will be used to refer to the user's points in the slots game.
• Usage: Enter a custom name for your points, such as "Coins" or "Tokens".

Bet Amount when none is given

• Description: Sets the default amount of points to bet if the user does not specify an amount.
• Usage: Enter a number (e.g., 1000) that will be used as the default bet amount.

Points a user will have if they don't have enough to bet

• Description: Defines the amount of points given to users who attempt to bet without having enough points. For example if they only have 150 then when they try to bet they will be rounded back up to 200. If you don't want this setting on you can set it to 0
• Usage: Enter a number (e.g., 200) to ensure users can participate even if they run out of points.

Minimum bet amount

• Description: Establishes the minimum amount of points a user can bet in the slots game.
• Usage: Enter the smallest bet amount (e.g., 100) allowed in the game.

Maximum bet amount

• Description: Establishes the maximum amount of points a user can bet in the slots game.
• Usage: Enter the largest bet amount (e.g., 5000) allowed in the game.

Payout when 1st and 2nd Emote Match

• Description: Determines if users will receive a payout when the first and second emotes match.
• Usage: Check or uncheck the box to enable or disable payouts for matching the first two emotes.

How much payout do you want to give for a match Two?

• Description: Specifies the multiplier for the payout when there is a match of two emotes.
• Usage: Enter a multiplier value (e.g., 3) to set the payout for two matching emotes.

Would you like to fail if bet is under minimum?

• Description: Determines if the action should fail if the bet is under the minimum or if it should try bet the minimum.
• Usage: Check or Uncheck if you want it to fail when someone bets under the minimum.

Would you like to fail if bet is under maximum?

• Description: Determines if the action should fail if the bet is under the maximum or if it should try bet the maximum.
• Usage: Check or Uncheck if you want it to fail when someone bets under the maximum.

Emote Settings

Emote Settings control which emotes are part of the slots and what effect they have on the game in terms of payout and percentage.

You can have up to 10 emotes and each emote has the following settings:

Enable this emote

• Description: Determines if this emote is enabled or not.
• Usage: Check or uncheck the box to enable the emote.

How much X should a match 3 Payout?

• Description: Specifies the multiplier for the payout when a user gets three of this emote in a row.
• Usage: Enter a number representing the payout multiplier for a match of three emotes.

What % chance do you want to put on this emote showing?

• Description: Defines the likelihood of this emote appearing in the slots game. The percentages are relative to each other.
• Usage: Enter a percentage value (e.g., 20%) to set the probability of this emote appearing. For example, if Emote 1 is set to 50, Emote 2 is set to 50, and Emote 3 is set to 100, the actual chances would be calculated as 25%, 25%, and 50% respectively.

These settings allow you to customize which emotes are used in the slots game, how much they pay out, and how frequently they appear, ensuring a tailored and balanced game experience.

Commands

This extension only comes with one command.

<aside> 💡 Note that amount can be one of the following.

A Number : !slot 5000 A Percentage : !slot 20% It can use K and M as short for Thousands and Millions : !slot 50k !slot 5m You can use All to call for an all in: !slot all or you can leave it blank to bet the default amount: !slot

</aside>

<aside> ⛔ If you try bet a negative number that will be converted into a positive number.

</aside>

Arguments and Triggers

This game comes with several Custom Triggers so you have full control over what happen with the different out comes, below is a list of the triggers and when they would trigger. Each Trigger is found in the Custom >> Currency trigger context menu.

These actions will also return several arguments these can be used in your actions.

| --- | --- | --- |

Errors

If something goes wrong slots has some error codes built in these can be used with Generic Fail Trigger. When this happens you can use either %failCode% or %failReason% to differentiate between the errors.

This table shows the error code and the reason that is associated with that error.

| --- | --- |