Currency Core (2).png

General Notices

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

</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 both Twitch and YouTube, will allow players to bet between 100 and 5000 with a default bet of 1000. Players also have a 50/50 chance to win.

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

Reset Button
- Function: Resets all settings to their default values.
- Action: Click to reset all settings to default.
Save Button
- Function: Saves the current settings.
- Action: Click to save your changes.

General Settings

These few settings control how the game behaves and

How much should be staked when no value is given?
- Sets the default amount of points to bet if the user does not specify an amount or enters an invalid amount.
Minimum bet amount
- Establishes the minimum amount of points a user can bet in the gamble game.
Maximum bet amount
- Establishes the maximum amount of points a user can bet in the gamble game.
What % chance do you want to give the users?
- Determines how likely a user win is to happen. The higher the number the more likely.
Would you like to enable push?
- Determines if push is enabled, if push is enable then if logic roll are equal the result will be a draw and the bet will be returned, otherwise a match will be settled as a loss.
Would you like to fail if bet is outside the range?
- Determines if the action should fail if the bet is out side the range, if fail is not enabled it will try to push to the min or max value.

Commands

This extension only comes with one command.

Command	Purpose
!gamble
This is how the user will have a gamble, with the command `!gamble <amount>`

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

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

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

Trigger	Description
Gamble All In Loss	Triggers when a player loses all their remaining balance in one gambling round.
Gamble All In Win	Triggers when a player wins after betting all their remaining balance in one gambling round.
Gamble All In Push	Triggers when a player neither wins nor loses, but ends up with the same balance after betting all their remaining balance in one gambling round.
Gamble Any Loss	Triggers whenever a player experiences any loss in a gambling round.
Gamble Any Win	Triggers whenever a player experiences any win in a gambling round.
Gamble Any Push	Triggers whenever a player's balance remains the same after a gambling round (no net win or loss).
Gamble Loss	Triggers when a player loses in a gambling round. That isn’t an All In Bet.
Gamble Win	Triggers when a player wins in a gambling round. That isn’t an All In Bet.
Gamble Push	Triggers when a player's balance remains the same after a gambling round (no net win or loss). That isn’t an All In Bet.

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

Argument Name	Example	Description
`gameName`	Gamble	This is the name of the game.
`points`	99284	This is the amount of points you have at the start.
`pointsName`	Points	This is the name you’ve given to your points.
`betSize`	3000	This is the amount that ended up been bet.
`gambleResult`	64	This is the random number that is span in order to determine a winner.
`allIn`	False	This bool is if the bet is an All In bet or not.
`result`	Loss	This is a bool showing if the bet is a winner or not.
`oldPoints`	99284	This is the points before the bet.
`newPoints`	96284	This is the points after the bet.

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.

`%failCode%`	`%failReason%`
4501	User can not afford to do this
4502	User’s request is over the limit
4503	User’s request is under the limit