Code Docs

StreamUP Product Documentation

General Notices

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

Currency Core

</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>

<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 will work on Twitch and YouTube and has 6 Emotes ranging from a x8 payout all the way to the x128 payout.

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.
   • Action: Click to reset all settings to default.
2. Save Button
   • Function: Saves the current settings.
   • Action: Click to save your changes.

General Settings

The General Settings will allow you to control how your slot machine behaves.

• How much should be staked when no value is given or something is invalid?
  • Sets the default amount of points to bet if the user does not specify an amount or enters something invalid.
• Minimum bet amount
  • Establishes the minimum amount of points a user can bet in the slots game.
• Maximum bet amount
  • Establishes the maximum amount of points a user can bet in the slots game.
• Payout when 2 Emotes Match
  • Determines if users will receive a payout when two emotes match.
• How much payout do you want to give for a Match Two?
  • Specifies the multiplier for the payout when there is a match of two emotes.
• Would you like to fail if bet is out of range?
  • Determines if the action should fail if the bet is outside the range, if not enabled it will try bet the minimum or 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 as many emotes as you wish and are each entered into the table. The table has 3 columns, Emote Name, Payout and Percentage.

Please take care when entering these,

• Emote Name: This is the emote you want to be part of the slots by default these are hearts but you can use emotes you have access to such as Kappa or andiliFudge
• Payout: This is how much x a user will get when winning, meaning if payout is 8 and they win they will get x8 so for a bet of 1000, payout would be 8000.
• Percentage: This is how likely an emote is to appear however these aren’t worked out as a percentage per se, sure if they all add up to 100 they will act that way but they do correlate with the other emotes. Best way to think of it is if I have Emote 1 = 40, Emote 2 = 37 and Emote 3 = 11, if each emote had that amount of tickets in a raffle and I had to pick one out that’s the likely hood of each emote getting picked. So Emote 1 is 40/88, Emote 2 is 37/88 and Emote 3 is 11/88

If it can not find the Percentage or Payout value you can set some defaults, however these should not be needed if you fill in the table correctly

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.

| --- | --- |