Userguide

Contents
Quickly jump to areas of the userguide.
Beam Authentication
Twitch Authentication
Chat Relay
Permissions
Variables
Points
Command System
Counters
Quotes System
Giveaways
Song Requests
Misc Commands
Examples
Tips
Beam Authentication
Follow these steps to properly authenicate and log into Beam
  1. To connect to Beam you will need to create a secondary Beam account for the bot.
  2. In the Bot Name you want to write the name of your secondary account.
  3. Important: If you already had a primary and secondary Beam account created, make sure you are not logged in as your primary account already on your default browser! If so log out before proceeding.
  4. Now you can click the Generate OAuth-Token. ScorpChat will then ask for your approval to connect to your Secondary channel. Simply click the APPROVE button and it will take you to the next page which will show you the Oauth Token. Copy paste the token into the Oauth-Token field in ScorpChat.

  5. In the Channel field you type your primary username (not bot!).
  6. It should look somewhat similar to this.

  7. Now you can click the Connect button.
Twitch Authentication
Follow these steps to properly authenicate and log into Twitch
  1. To connect to Twitch you will need to create a secondary Twitch account for the bot.
  2. Once the Twitch user is created, you can type the name of the secondary channel in the Bot Name field.
  3. Important: If you already had a primary and secondary Twitch account created, make sure you are not logged in as your primary account already on your default browser! If so log out before proceeding.
  4. Now comes the Oauth-Token. Make sure you are logged into your secondary Twitch account before clicking the Generate Oauth-Token button at the bottom of the Twitch log in. This will take you to a page which will ask for approval, click Authorize then it will give you the Oauth-token. Simply copy this over to the Oauth-Token field.

  5. In the Channel you type your username with a "hashtag" in front of it.
    Here's an example: #username
    This will be your main channel and it can be all lower case.
  6. For the Port and Server you can leave those two alone as the default information should work fine.
  7. It should look somewhat similar to this.

  8. Now you can click the Connect button.
Chat Relay
Relaying chat messages between Twitch and Beam
Once both Twitch and Beam have been successfully authenticated and connected you can relay chat messages between the two simply by enabling the feature from the "Relay" tab within the bot.
If you intend to relay chat from Beam to Twitch please make sure your bot account is modded on Twitch to prevent it from being auto-silenced for spam.
Permissions
Used when setting command permission.
+aAnyone
+rRegulars
+sSubscribers
+mModerators
+eEditors
+cCaster
+u(name)Specific viewer only.
+min_points(#)Must have at least # points.
Variables
These may be used in output text for dynamic content.
$userDisplays the user of the command.
$targetDisplays the targetted viewer name.
$target1-9Allows multiple targets in a single command (seperate with spaces when using command). Example: !cmd viewer1 viewer2 viewer3
$msgDisplays the text after the command.
$timeDisplays the streamers current time.
$dateDisplays the streamers current date.
$datetimeDisplays the streamers current date and time.
$randnum(min,max)Displays a random number in a specified range.
$randvalueDisplays the selected number chosen by $randnum in the same command output. In a case where multiple $randnum exist you can use $randvalue(0-9)
$math{1+1}Performs mathmatical calculation and outputs the result.
$currencynameDisplays the custom name of your currency.
$countDisplays the number of times a command has been used.
$toppoints(num)Displays top X amount of users based on points.
$tophours(num)Displays top X amount of users based on hours.
$pointsDisplays the number of points of the user.
$rankDisplays the users current rank.
$nxtrankreqDisplays the remaining points for viewer to reach the next rank.
$hoursDisplays the users total hours.
$gameIf text contains $target this will show their last played game, otherwise it will display the game currently being played by the streamer.
$mygameDisplays the game currently being played by the streamer.
$titleDisplays the channel title.
$statusDisplays the channel title.
$urlDisplays the url of the target. (beam or twitch depending on which chat the command is used)
$randuserDisplays a random active user.
$randomuservalueDisplays the selected name chosen by $randuser in the same command output. In a case where multiple $randuser exist you can use $randomuservalue(0-9)
$readapi(URL)Displays the text on the URL’s page. Max 255 characters
$sfx(filename)If sound effects are enabled filename will play when the command is used if it matches one on the list.
$logfile(filename,text)Appends text to filename.txt in the CustomFiles bot subfolder.
$reqpoints(#)Adds a # point cost to use a command. Add it to the outgoing message of a command.
$uptimeDisplays how long the stream has been live.
$addpoints(name,#)Gives # points to name (must be a current viewer in channel). Variable is removed from output text.
$addpointsall(#)Gives # points to all viewers currently in channel. Variable is removed from output text.
$randomlist(filename)Retrieves a random line from filename within the randomlist folder in the ScorpBot directory. Easily access the folder with a button on the bot gui dashboard. Note: Will not accept a full path (ex: C:/path/file.txt)
$readfile(C:/path/file.txt, last)Retrieves text from a file. If no 2nd variable is entered it will simply display the first text from the file up to max 360 characters including multiple lines. Optional 2nd variable can be: first/last/random/#. (# = a specific line number)
$writefile(C:/path/file.txt, text, false, last)Writes text to a file. 3rd variable is optional and can be true or false to determine if it will overwrite the file or not. If set to false, 4th variable can be either first or last to write to the beginning or end of the file.
$raidsDisplays current number of raids for $user.
$targetraidsDisplays current number of raids for $target.
$raiderAdds 1 to raid count for $target. Will only work per $target every 6 hours to prevent accidental repeats and, if used, it will block $addpoints if within the 6 hour restriction.
$if{check|true text|false text}Creates a situation with conditional output. check may use =,>,<,!=,<>,>=,<=. Examples:
$if{$user=Scorpio|You are Scorpio|You are not Scorpio}
$if{$points>=1000|You have enough $currencyname!|You don't have enough $currencyname!}
$command(command string, delay)Allows calling a command from within a command. Can optionally set a delay in seconds before it is called.
Example: $command(!so Scorpio, 5)
Points
This information will help with adding, removing, and giving points to/from viewers. Note: !points should be replaced with your own points command if it has been customized in your bot.
!points addUsed for mods+ to create new points for viewer(s). Permission for this option can be changed in the bot.
For a single viewer: !points add username # (# = number of points)
For all viewers: !points add +viewers(#) (# = number of points)
!points removeUsed for mods+ to remove points from a viewer. Permission for this option can be changed in the bot.
Usage: !points remove username # (# = number of points)
!points giveAllows giving your own points to another viewer. Anyone can use this command.
Usage: !points give username # (# = number of points)
Command System
Create/edit/use custom commands with optional permissions.
Usage: !command action command_name permission output
!command addAdd a new command.
!command editEdit an existing command.
!command removeRemove an existing command. Also accepts delete.
!command show !cmdWhispers the details about the specified command (!cmd).
!command cd # !cmdSets the global cooldown (in minutes) to # for the specified command (!cmd).
!command ucd # !cmdSets the user-specific cooldown (in minutes) to # for the specified command (!cmd).
!command resetcount !cmdResets the command $count for the specified command (!cmd).
!command type public/whisper/both !cmdSets the type to either public, whisper, or both for the specified command (!cmd).
!command alltext !cmdToggles whether the command can be found anywhere in the text.
C/DCommand specific cooldown in minutes which affects all users.
User C/DUser cooldown in minutes which affects only the specific user of the command.
!commandsDisplays all commands usable at your permission level.
Counters
Custom counter option for in chat and on-stream display.
With the counter system you can create a custom command which when used will increase that commands numerical value, saved in a text file.
These are the fields which make up a counters. Command is not only the command used in chat but the name of the text file as well. Text represents how it should be saved in the text file and displayed on stream or in chat. Using the Copy Path to Clipboard button below you can quickly capture the full path either for linking to on-stream text or using the $readfile() variable for a chat command.
While the final buttons perform standard functions to increase/decrease and reset the counter, any mod or higher can also perform these functions from chat with the following commands.
(replace !counter with your custom counter command)
!counterIncreases counter by 1.
!counter -Decreases counter by 1.
!counter resetResets counter to 0.
!counter #Sets counter to specified number #.
Quotes System
Save and retrieve quotes.
!quoteDisplay a random quote.
!quote #Display a specific quote number (#)
!quote add textSave a new quote (text).
!quote delete #Remove a specific quote (#).
Giveaways
For prize giveaways in your channel.
!giveawayQuickly starts a 5 second timer to give a prize to a random viewer. Prize is listed as TBA and it selects from all viewers online.
!giveaway startBegins a custom giveaway.
Usage: !giveaway start prize|time|command|cost|maxentries
(Note: command|cost|maxentries are optional)
Song Requests
Viewer song request system.
!songrequest urlUsed to request a song. url can be either a fully qualified YouTube url or just the video ID.
!songDisplays the current playing song title.
!nextsongDiplays the title of the next song.
!skip or !vetoStops the currently playing song and moves on to the next one.
Misc Commands
Some other useful commands built into the bot.
!streaminfoGives you general info about ScorpBot in the current stream, such as which currencies and minigames are enabled and teh commands to use them.
!steam textSearches steam library for text giving the first result with price in local currency.
!setregular usernameAdds username to regular list.
!addregular usernameAdds username to regular list.
!setraids username #Sets raid count to # for username.
Examples
Type the following into chat to create some useful commands.
!command add !caster +m Go follow $target at $url, they were last playing $game!
Usage:!caster Scorpio
Output:Go follow Scorpio at beam.pro/Scorpio, they were last playing Rocket League!
Tips
Some general tips based on issues encountered by some Streamers while configuring and using ScorpBot
Twitch Game/Title:You will receive a forbidden error while attempting to update Twitch game name and title unless you add your bot account as an editor in the Twitch channel control panel through the Twitch website.