InstructBot Logo InstructBot
Login
Getting Started
Third Party Integrations
Overview StreamElements StreamLabs TipeeeStream Twitch
Applications
Commands
Overview
Command Types Creating Commands Downloading Commands Active Command Set Cooldowns Queues
Disable Profile Command Enable Profile Command External Command Help Command Input Command Mute Sound Command Parallel Command Play Sound Command Random Command Sequential Command Swap Left and Right Mouse Button Command Text Command Timeout Command Toggle Profile Command
Execute Command Nothing Command Use Command
Options
Environment
General Backup and Restore Console Key Bindings Sound Warnings
Notifications
Overview Connection
Commands
General Random Timeout Use
StreamElements StreamLabs TipeeeStream Twitch Users
Profiles
Rewards
Overview
Accumulator Discounts Follower Gifted Subscription Subscription
Editing Rewards Types of Rewards
Users Variables YouTube

Accumulator

  1. Support
  2. Rewards
  3. Accumulator

See: Enabled, General ( Payout At, Increment For Non-Triggering Amount Only, Only Active Commands, Only Active Viewers, Amount Per Bit, Amount Per Donation, Amount Per Subscription, Amount Per Gifted Subscription or Rewards ) or Notifications ( Total Reached or Increment Reached )

The accumulator screen is used to reward users for cheers and / or donations. When enabled each time a user cheers or donations an amount, that value is added to the current amount. When the current amount reaches the payout at amount the specified rewards are given to you users.

Note: The current amount is persisted between streams and so it will increment until the payout at amount is reached as long as the accumulator remain enabled.

Enabled

To enable the accumulator you must toggle it on.

InstructBot rewards screen showing how to enable the accumulator.

You can see if the accumulator is currently enabled by the overlay icons in the navigation menu and window title bar. When enabled the Overlay icon showing that the accumulator is currently enabled in InstructBot. overlay icon is shown, e.g.

Show an example of the enabled indicator for the accumulator in InstructBot.

When disabled, the Overlay icon showing that the accumulator is currently disabled in InstructBot. icon will be used instead.

General

See: Payout At, Increment For Non-Triggering Amount Only, Only Active Commands, Only Active Viewers, Amount Per Bit, Amount Per Donation, Amount Per Subscription, Amount Per Gifted Subscription or Rewards

The general tab of the accumulator screen controls how the accumulator is incremented and what if anything is rewarded when the payout amount is reached.

Payout At

The "Payout At" amount controls when the accumulator is triggered to reward your users.

Example showing the payout at amount of the accumulator in InstructBot.

You can see the current amount the accumulator has reached next to the payout at amount (currently 0). When this amount exceeds the payout at amount, the accumulator will be triggered and the rewards distributed. You can modify this as required.

Example showing the current amount of the accumulator in InstructBot.

Increment For Non-Triggering Amount Only

When toggled on, only non-triggering amounts will increment the payout at amount. When toggled off, triggering and non-triggering amounts will increment the payout at amount.

Example showing the non-triggering amounts only setting for the accumulator in InstructBot.

Only Active Commands

When toggled on, only commands which are enabled of those that are configured will be rewarded.

Example showing the only active commands setting for the accumulator in InstructBot.

Only Active Viewers

When toggled on, only viewers which are active will be rewarded.

Example showing the only active viewers setting for the accumulator in InstructBot.

Amount Per Bit

The number the current amount is incremented for each bit received.

Example showing the amount per bit setting of the accumulator in InstructBot.

Amount Per Donation

The number the current amount is incremented for each donation received.

Example showing the amount per donation setting of the accumulator in InstructBot.

Amount Per Subscription

The number the current amount is incremented for each tier of subscription received.

Example showing the amount per tier of subscription setting of the accumulator in InstructBot.

Amount Per Gifted Subscription

The number the current amount is incremented for each tier of gifted subscription received.

Example showing the amount per tier of gifted subscription setting of the accumulator in InstructBot.

Rewards

The rewards to be distributed when the current amount reaches the payout at amount.

Example showing the configured rewards for the accumulator in InstructBot.

In the example above, 20 uses of a configure random command, 20 uses of the shoot command, 10 uses of the Mag Dump command, 1 use of the Alt F4 command and 5 uses of the grenade command would be split randomly between the eligible users when the current amount reaches the payout at amount, e.g. 10000.

For a more detailed explanation of how to add, remove and edit rewards see Editing Rewards. For an explanation of each reward type please see Types of Rewards.

Notifications

See: Total Reached ( Enabled, Introduction, User Template, User Separator, Command Template or Command Separator ) or Increment Reached ( Enabled, Message or Increment Amount )

The notifications tab of the accumulator screen controls if progress messages for the accumulator are sent to chat.

Total Reached

See: Enabled, Introduction, User Template, User Separator, Command Template or Command Separator

The total reached notification is sent to chat when the current amount reaches the payout at amount.

Enabled

When toggled on the total reached notification will be output into chat.

Example showing the accumulator total reached notification enable toggle button.

Note: If toggle off, no notification will sent when the current amount reaches the payout at amount and users will not be notified of any uses they have been rewarded.

Introduction

The text used at the beginning of the message sent.

Example showing the total reached notification introduction text for the accumulator in InstructBot.

Variables

AccountName: The name of the account logged into InstructBot.

ApplicationName: InstructBot's name.

CurrentValue: The current value of the accumulator.

PayoutAt: The payout at value of the accumulator.

Percentage: The percentage of the accumulator.

User Template

The template used to generate a piece of text per user.

Example showing the total reached notification user template for the accumulator in InstructBot.

Variables

AccountName: The name of the account logged into InstructBot.

ApplicationName: InstructBot's name.

Command: The list of commands the user is being rewarded.

RewardedUser: The user which is being rewarded with one or more commands, see here for a full list of variables.

User Separator

The text to place between each piece of text generated from the user template.

Example showing the total reached notification user separator for the accumulator in InstructBot.

Command Template

The template used to generate a piece of text per command.

Example showing the total reached notification command template for the accumulator in InstructBot.

Variables

Count: The number of uses rewarded.

RewardedCommand: The command being rewarded, see here for a full list of variables.

Command Separator

The text to place between each piece of text generated from the command template.

Example showing the total reached notification command separator for the accumulator in InstructBot.

Increment Reached

See: Enabled, Message or Increment Amount

The increment reached notification is sent to chat when the current amount reaches the specified percentage of the payout at amount.

Enabled

When toggled on the increment reached notification will be sent to chat.

Example showing the increment reached notification toggle button for the accumulator in InstructBot.

Message

The text to send to chat when the specified increment has been reached.

Example showing the text input of the increment reached message for the accumulator in InstructBot.

Variables

AccountName: The name of the account logged into InstructBot.

ApplicationName: InstructBot's name.

CurrentValue: The current value of the accumulator.

PayoutAt: The payout at value of the accumulator.

Percentage: The percentage of the accumulator.

Increment Amount

The percentage increment at which a message will be sent to chat.

Example showing the increment amount of the accumulator in InstructBot.

For example in the above a message with be sent at 10%, 20%, 30% etc...

This website uses cookies to improve your experience. We'll assume you're ok with this, but you can opt-out if you wish.AcceptReject