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.

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

Heist Settings

Settings control how the game will operate. You will need to read these instructions carefully to understand the mechanics of each setting.

General Settings

• This is the the length in seconds users will have to join the heist.
  • This is just the time the users will have to join, the heist will auto end and resolve when this time is up.
• This is how users will join the heist.
  • This is the trigger users will use to start the heist, this can be used in the heistTrigger argument,
• This is how much it will cost to join.
  • This is how many points it will cost to join.
• Do you want people to be allowed to enter if they don’t have enough?
  • If you set this to no, users will not be able to join, if its set to yes they will join with whatever points they have.

Heist Settings

• Would you like to use randoms or indexing?
  • This controls how things are selected, indexing means it will try get the same value on the of each box, for example it will get Line1 from each box, if the line doesnt exist it will be random. Random is what it is, this means it will take a random value of each box, making the possibilities endless.
• These are the heist names.
  • These are just heist names, they play no part in logic.
• These are the amounts you can win.
  • These are the prize pots, these are split amongst the people who win.
• These are the max entries.
  • These are max entries, the more people who join the better your chances of winning are
• These are the buffers.
  • Buffer is a value that is multiplied by the number of people who joined, B * E = X the higher X is the better your chances are.
• These are the survivals.
  • Survivals are a chance, the higher the better you have of winning. In order to win this number need to be higher than the random number of 100 - X (X been the number from above)

User Settings

• Enable boosting for the group.
  • This turns on if you want boosting, boosted users will gain both values.
• Select group to be boosted.
  • This is the group that will be boosted, a default Heist Boosted Group will be created, but you can select your own group.
• This is the base survival rate.
  • This is the survival rate the higher the more chance, recommend it to be between 15 and 35
• This is the boosted survival rate.
  • This is the boosted, same as above, users will get both values and again I would recommend 15 to 35
• This is the base shares.
  • Shares are the split a user will get if they win. I this should be lower than 5, if boosting is off it wont really matter because everyone will get the same.
• This is the boosted shares.
  • These are added shares boosted users will get if are part of the group, again keep it lower than 5.

Commands

This extension only comes with one command.

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 >> Heists trigger context menu.

<aside> 💡

</aside>

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.

| --- | --- |