Script Documentation
BlasBot.mrc
Required script for most of the other scripts to work. You will have to input some info upon loading the script. If you change any of this info or enter it incorrectly, please read the info in the script on how to reset it. Other required scripts can be found in the README.md instructions. This script also contains the "!games on" and "!games off" commands to enable and disable any of the other games scripts on this GitHub that you have loaded in mIRC.
jackpot.v2.mrc
Do not use in conjunction with Jackpot Classic.
IMPORTANT: Version 2.1 requires the updated BlasBot.mrc file. So please update your BlasBot.mrc before installing the new version of Jackpot!
This is a new and much improved version of Jackpot Classic. You will be asked to enter all needed information in input boxes when you first load the script. You may use as many emotes as you want (at least two, obviously) for the reels. You may set the odds of winning the jackpot to any percentage that you want, regardless of the number of emotes used. You can now right click your status or channel window in mIRC and select the "!JackPot" context menu that appears and easily view and set the following: enable/disable !jackpot, emotes used, cost to play, user cooldown, new pot amount, odds of winning, current pot, all reels speeds, WHISPER mode, lever pull message, and jackpot lose message.
What's added/different in Version 2.1 from Version 2.0:
Queue System: The !jackpot is now QUEUED when multiple users try to activate it at the same time. No more waiting for the last person to finish before you are able to type !jackpot to play.
Whisper Mode: Mods can enable "whisper mode" on and off. When it is enabled and users type !jackpot in the chat, your bot will whisper them the game instead of outputting to the main channel. If a user WINS the !jackpot, your bot will still display the winning hype message in the main channel. The queue system also works when this mode is enabled.
More Customization: Added even more options to the context menu that allow you to easily customize the speeds for each reel, as well as the messages that the bot uses for the "pull message" and when a user loses the !jackpot.
Stats Tracking: The !jackpot now keeps track of all users number of games played, how much channel currency they have spent, and their total winnings. The command is !myjackpot and may be disabled in the context menu if desired.
Command List:
!jackpot ::: plays the game.
!jackpot stats ::: this will tell you some basic stats of the jackpot... the current jackpot, the last winner, how much the last winner won, the total number of winners, and the total payouts.
!jackpot record ::: this will tell you who won the largest !jackpot ever and how much it was for.
!jackpot on ::: Mod Only. Turn the game on.
!jackpot off ::: Mod Only. Turn the game off.
!jackpot set # ::: Mod Only. Manually set the current jackpot to #.
!jackpot odds # ::: Mod Only. Change the odds of winning the !jackpot.
!jackpot whispers on ::: Mod Only. Turn on WHISPER mode.
!jackpot whispers off ::: Mod Only. Turn off WHISPER mode.
!jackpot bet # ::: Mod Only. Change the amount of channel currency that is spent on each play of !jackpot.
!jackpot cd # ::: Mod Only. Change the cooldown time for !jackpot.
!jackpot newpot # ::: Mod Only. Change the amount of channel currency that new !jackpot's will be set to after someone wins.
!jackpot emotes emote1 emote2 ::: Mod Only. Set the emotes that !jackpot uses by adding them to this command. (at least two required)
!myjackpot ::: Check your own individual !jackpot statistics. Mods may also use "!myjackpot username" to check another user. This command can be disabled in the context menu.
slots.50x.v2.mrc 50x Version
slots.10x.v2.mrc 10x Version
Do not use in conjunction with Slot Machine Classic.
IMPORTANT: Please be sure that you are using the LATEST BlasBot.mrc file from this GitHub, otherwise this game may not work.
This is a new and much improved version of Slot Machine Classic, although the reels and payouts are much different. You will be asked to enter most information in input boxes when you first load the script. You can right click your status or channel window in mIRC and select the "!Slot" context menu that appears and easily view and set the following: enable/disable !slot, emotes used, cost to play, user cooldown, house edge/odds of winning, all reels speeds, WHISPER mode, lever pull message, and slot lose message.
Game Details (for 50x Version):
The game requires you to specify seven emotes to be used. The user needs to match three emotes to win. The seven emotes are worth 1x, 2x, 3x, 5x, 10x, 25x, and 50x the users bet. The lower the payout multiplier, the higher the odds of receiving that multiplier during any given winning game.
The "houseedge" option needs some explanation as it can be confusing. The default value is "0" which means that the user will break even in the long term. At this value, the odds of getting a winning spin on the !slot is 31.33%. If set to "100" then the user will ALWAYS lose. If it is set to "-100" then the user will ALWAYS win.
Some other examples:
If the value is set to "-45.624" then the user will win TWICE as much in the long term. For every 1 point wagered, they will win 2 points back. This is because they will be getting a winning spin twice as often, 62.66% of the time instead of 31.33% of the time.
If the value is set to "-4.5624" then the user will win 10% more in the long term. For every 10 points wagered, they will win 11 points back. This is because they will be getting a winning spin 10% more often, 34.46% of the time instead of 31.33% of the time.
If the value is set to "50" then the user will DOUBLE their losses. They will win 1 point for every 2 points wagered. This is because they will be getting a winning spin half as often, 15.67% of the time instead of 31.33% of the time.
Game Details (for 10x Version):
Similar to the 50x version, except that there are no 50x and 25x payout options. Therefor, the odds of a winning outcome in general are increased.
More technical details:
50x Version: With a "houseedge" of 0, the following are the odds of the outcome on any given slot game:
lose = 68.67%
1x = 14.286%
2x = 7.143%
3x = 4.762%
5x = 2.857%
10x = 1.429%
25x = 0.571%
50x = 0.286%
10x Version: With a "houseedge" of 0, the following are the odds of the outcome on any given slot game:
lose = 57.333%
1x = 20%
2x = 10%
3x = 6.667%
5x = 4%
10x = 2%
I also have some basic FFZ emotes that may be used for the Slot Machine at http://www.frankerfacez.com/emoticons/user/blasman13 if desired. Note that these will not display correctly if using the WHISPER mode.
Command List:
You may also type !slots instead of !slot, as they will both do the same.
!slot # ::: plays the game and bets # amount of points on the slot machine. (example: !slot 100)
!slot ::: typed by itself will give info on how to play the game.
!slot on ::: Mod Only. Turn the game on.
!slot off ::: Mod Only. Turn the game off.
!slot houseedge # ::: Mod Only. Change the houseedge of the !slot.
!slot whispers on ::: Mod Only. Turn on WHISPER mode.
!slot whispers off ::: Mod Only. Turn off WHISPER mode.
!slot minbet # ::: Mod Only. Change the minimum amount of channel currency that is required to be wagered for a game of !slot.
!slot maxbet # ::: Mod Only. Change the maximum amount of channel currency that is required to be wagered for a game of !slot.
!slot cd # ::: Mod Only. Change the cooldown time for !slot.
!slot emotes emote1 emote2 ::: Mod Only. Set the emotes that !slot uses by adding them to this command.
!myslot ::: Check your own individual !slot statistics. Mods may also use "!myslot username" to check another user. This command can be disabled in the context menu.
This script contains the !payactive command that is similar to AnkhBot's "!points add +viewers #" command, except that it will only give points to the users who have been ACTIVE in the last X seconds (see below) and are still in your channel's viewerlist. Just like with AnkhBot's "!points" command, users need to be an Editor in AnkhBot in order to be able to use this command.
Basic Usage:
!payactive # # ::: Initiates a payactive. The first # is the amount of channel currency. The second # is OPTIONAL and will be a timer that lets users know that they have # seconds to speak up in chat before the payactive will happen. Example: "!payactive 100" will instantly payout 100 points to all active users. Whereas "!payactive 100 60" will display a message saying that in one minute (60 seconds) everyone who has been chatting in the last X minutes (what you set the payactive time to) will receive 100 points.
!payactivex # # ::: Similar to !payactive, except that users will need to speak within the X amount of seconds specified as the second number. Therefore, both numbers are required.
Example: “!payactivex 100 120” will pay out 100 points to all users who have been active within the 120 seconds after the command is activated.
!payauto # # # # ::: This will set up AUTOMATIC !payactive’s. You may also use “!payautox” to have automatic !payactivex’s instead of !payactive’s.
!payauto [AMOUNT of currency] [TIMER OF !payactive] [HOW OFTEN the !payactive] [OPTIONAL: HOW MANY TIMES to keep repeating the !payactive]
Example: "!payauto 100 60 300" will perform an automatic "!payactive 100 60" every 300 seconds until manually stopped. Whereas "!payauto 100 60 300 5" will also perform a "!payactive 100 60" every 300 seconds, but will stop after 5 times.
You may type !payauto by itself. If a !payauto is active, it will display information on the current !payauto. If no !payauto is active, it will display information on how to properly use the !payauto command.
!payauto off ::: Disable an active !payauto or !payautox.
!paylimit # ::: Sets the MAX LIMIT for the !payactive amount of currency. This is useful for mods that may accidentally forget to add a space between the amount of currency and the timer. Example: Accidentally typing "!payactive 100600" instead of "!payactive 100 600" The default is set to 1000000. Type !paylimit without a number to check the current limit.
!set activetime # ::: Change the amount of time (in seconds) for a user to be considered ACTIVE in chat. The default is set to 900 seconds (15 minutes). If a user has said anything in chat in the last # seconds when the payactive happens, they will receive the channel currency.
Advanced Usage:
You may use time units for easier usage of !payactive/!payactivex’s and !payauto/!payautox’s.
Example: “!payactive 100 5m” is the same as !payactive 100 300
You may set “ranges” for any of the numbers in the payactive and payauto commands.
Example: “!payactive 100-200 5m-10m” will perform a !payactive that is a random number between 100-200 and a random time between 300 and 600 seconds.
Example: “!payauto 100 5m 1h-1.5h” will perform an automatic “!payactive 100 5m” every 60 to 90 minutes (a random time between 3600 and 5400 seconds).
Notes:
Only one type of !payauto can be activated at a time. Activating a !payauto or !payautox while one is active will overwrite the previous one. !payauto and !payautox share this rule together (only one can be active at a time).
Only one !payactive can be activated at a time. If a !payactive is activated while one is waiting for the timer to finish, the previous !payactive will be overwritten. !payactivex shares this same rule independently of !payactive. Therefore, you can have a !payactive and !payactivex active at the same time.
You may still perform !payactive/!payactivex commands while a !payauto or !payautox is active. They will not overwrite each other.
This script is designed to help with Raiding other channels. After typing "!raid username" the script will post a link to the raid target as well as the message to copy and paste. Twenty seconds after typing "!raid username," your bot will automatically join the channel to raid (your bot never leaves your own channel though). Once YOU type the raid message into the channel that you are raiding (using your main Twitch account, not your bots, obviously), your bot will silently begin listening in on the channel that you are raiding. For the next 90 seconds, whoever types your raid message into that chat (or whatever text you specify to match), will be added to the "raider list." After the 90 seconds are over, your bot will automatically part the channel that you are raiding and begin paying everyone who raided with you a specified amount of channel currency. Raiders will only receive the payout ONCE, regardless of how many times they paste the raid message. A text file called "raid_history.txt" will be kept in your mIRC folder, it will keep a list of when you raided a channel, and who raided with you as well. There are many other commands, for a complete list type !raidhelp.
scramble.mrc
ScrambleWords.txt
Edit the variables and read the info at the beginning of the script before you load the script. Otherwise, you will have to un-load and re-load the script for the changes to take effect. Put the ScrambleWords.txt file into your mIRC root directory as well.
The game is a TWO player word guessing game, where the bot will rearrange the letters of a five-letter word and whisper the scrambled word to the two players that have agreed to play against each other. The first player to successfully whisper the correct unscrambled word back to the bot will win the game as well as the amount of points that were agreed upon from the other player.
Command List:
!scram on ::: Mod Only. This command will enable the game in your channel.
!scram off ::: Mod Only. This command will disable the game in your channel.
!scram ::: This command will give an info message about how to play the game as well as additional commands.
!scram # ::: Example: !scram 100. This is for a user to start the game as player 1 with X amount of their points on the line. The bot will start a 90 second timer to wait for a second player to join.
!scram # username ::: Example: !scram 100 blasman. This command is for a user to start the game as player 1, but only the username at the end of the command will be able to join the game as player 2.
!scram accept ::: When there is a player 1 waiting for a player 2, this command will join the game as player 2.
!scramstats ::: This command will tell a user their overall win/loss record for the game, as well as their fastest time to win the game.
!scramstats username ::: This command will tell a user their win/loss record against the username in the command.
!scramtop ::: This command will list the top 5 players with the most wins, as well as the 5 fastest times to win the game.
rps.mrc
Edit the variables and read the info at the beginning of the script before you load the script. Otherwise, you will have to un-load and re-load the script for the changes to take effect.
This is a simple "Rock, Paper, Scissors" game for two players. Once two players agree to play the game against each other, they will both be whispered by the bot to enter their choice. The results will be displayed in the main channel. The winner will receive X points from the other player.
Command List:
!rps on ::: Mod Only. This command will enable the game in your channel.
!rps off ::: Mod Only. This command will disable the game in your channel.
!rps ::: This command will give an info message about how to play the game as well as additional commands.
!rps # ::: Example: !rps 100. This is for a user to start the game as player 1 with X amount of their points on the line. The bot will start a 90 second timer to wait for a second player to join.
!rps # username ::: Example: !rps 100 blasman. This command is for a user to start the game as player 1, but only the username at the end of the command will be able to join the game as player 2.
!rps accept ::: When there is a player 1 waiting for a player 2, this command will join the game as player 2.
roulette.mrc
Edit the variables and read the info at the beginning of the script before you load the script. Otherwise, you will have to un-load and re-load the script for the changes to take effect.
This is a classic single-zero Casino Roulette table. It is similar to channel "heists" in the sense that everyone in the channel can bet on the same table at the same time. You can set a maximum amount of channel currency that a user can bet for the entire table, as well as a minimum bet for any option on the table. Therefor, a user can make multiple bets at the table on different options, just like at a real Casino. See http://i.imgur.com/j7Fwytt.jpg for all betting options.
Command List:
!rbet on ::: Mod Only. This command will enable the game in your channel.
!rbet off ::: Mod Only. This command will disable the game in your channel.
!rbet ::: This command will give an info message about how to play the game as well as additional commands.
!rbet [option] [amount] ::: Example: !rbet red 100. This is to make a wager at the table. The example simply means that you bet 100 channel currency on "red."
blackjack.mrc
Edit the variables and read the info at the beginning of the script before you load the script. Otherwise, you will have to un-load and re-load the script for the changes to take effect.
This is a one player BlackJack game. It is an infinite decks game. The bot will always stand on 17 or higher.
!blackjack on ::: Mod Only. This command will enable the game in your channel.
!blackjack off ::: Mod Only. This command will disable the game in your channel.
!blackjack ::: This command will give an info message about how to play the game.
!blackjack # ::: Example: !blackjack 100. This will begin the game with X amount of points as your wager.
rr.mrc
Edit the variables and read the info at the beginning of the script before you load the script. Otherwise, you will have to un-load and re-load the script for the changes to take effect.
This is a two player Russian Roulette game. Two players pass a gun with six chambers in the cylinder to each other and take turns at taking a shot at themselves. The player that gets shot loses X amount of channel currency to the other player. Before the game begins, everyone else in the channel will have 90 seconds to place bets on who will be the survivor.
!rr on ::: Mod Only. This command will enable the game in your channel.
!rr off ::: Mod Only. This command will disable the game in your channel.
!rr ::: This command will give an info message about how to play the game as well as additional commands.
!rr # ::: Example: !rr 100. This is for a user to start the game as player 1 with X amount of their points on the line. The bot will start a 90 second timer to wait for a second player to join.
!rr # username ::: Example: !rr 100 blasman. This command is for a user to start the game as player 1, but only the username at the end of the command will be able to join the game as player 2.
!rr accept ::: When there is a player 1 waiting for a player 2, this command will join the game as player 2.
!rrbet user # ::: When betting is open, use this command to bet that either player will be the winner.
followdate.mrc
Also required: DateXpander.mrc
This is a !date command that will return how long and when a user first followed your Twitch channel.
- Mods may use !date by itself to get their own follow date, or they may use it with a users name after the !date command to get info of when another user followed the channel.
- Non-Mods may only use !date by itself to get their own follow date, and there is a one minute cooldown on the command.
- The command automatically removes any @ characters from the target's name.
The following are some example replies from the bot.
If the user has been following for LESS THAN ONE HOUR it will display MINUTES and SECONDS only:
User has been following this channel for 47 minutes, and 34 seconds since Jan 14 2016.
If the user has been following for BETWEEN ONE HOUR and ONE DAY it will display HOURS and MINUTES only:
User has been following this channel for 13 hours, and 21 minutes since Jan 13 2016.
If the user has been following for BETWEEN ONE DAY and ONE WEEK it will display DAYS and HOURS only:
User has been following this channel for 4 days, and 13 hours since Jan 10 2016.
If the user has been following for OVER A WEEK if will display YEARS, MONTHS, WEEKS, and DAYS only:
User has been following this channel for 1 year, 3 months, 1 week, and 4 days since Oct 3 2015.
hosts.mrc
Read the info in the script! This is a simple !hosts command that will list everyone who is currently hosting your channel, in alphabetical order.
autohost.mrc
Edit the variables and read the info at the beginning of the script before you load the script, and read the info in the script! Read the commented sections in the script for info on available commands.
give.mrc
This is a simple !give command to give points to another user. The built in give command in AnkhBot has various issues such as the ability to easily give points to users that don't exist. This command addresses that issue as well as prevents the user from giving points to the streamer, the bot, or themselves. If will only give points to a user who is currently ACTIVE and in the channel, therefor it requires the randuser.mrc script as well.
shoutout.mrc
This is a basic "caster command" used when promoting other streamers in your channel. It is different than AnkhBot's and most other bots shout out commands in the following ways:
- You can use any of the following commands for shout outs (easy to figure out how to edit in the script as well): !caster !so !shoutout !follow !streamer !ally
- You may shout out multiple users using the command by adding the list of users after the command, separated by spaces (eg. !caster user1 user2 user3)
- The command checks the Twitch API to ensure that the name is a valid Twitch user, and retrieves the proper Twitch display name as well. If the user does not exist on Twitch, then either an error message will be displayed, or the name will be omitted from the list of users if shouting out multiple users.
- The command automatically removes any @ characters from the target's name.
mario.maker.mrc
This is a Mario Maker Level ID submission script. Users may submit Level ID's into a queue to be played by the streamer.
!mm [on/off] ::: Mod Only. Set the script as active and inactive.
!mm cost # ::: Mod Only. Set an optional currency cost for users to submit Level ID's. Default is 0.
!mm max # ::: Mod Only. Set the maximum amount of Level ID's allowed to be queued per user. Default is 1.
!mm queue # ::: Mod Only. Set the maximum amount of Level ID's allowed in the queue. Default is 0 (no limit).
!mm history # ::: Mod Only. Set the number of Level ID's to be kept in history. This is to prevent Level ID's from being resubmitted after already being played and removed from the current queue. Default is 0.
!mm ban [level id] ::: Mod Only. Add a Level ID to the blacklist so that it cannot be submitted to the queue.
!mm followcheck [on/off] ::: Mod Only. Set the script to only allow followers of the channel to submit Level ID's. Default is off.
!nextid ::: Mod Only. Display and advance to the next Level ID in the queue.
!submit [level id] ::: Submit a Level ID to the queue. This command may also be whispered.
!currentid ::: Display the current Level ID as well as the queue size.
Once the first Level ID is activated using !nextid, a text file named mm_current.txt will also be created in your mIRC directory that displays the current Level ID being played. You may use this text file with your broadcasting software to display the current Level ID on the stream.
Other scripts on this GitHub are:
dice.mrc - a !dice game, somewhat similar to Casino Roulette.
katana.mrc - a game created for twitch.tv/A_Colder_Vision
predict.mrc - a script that I use for prediction games in my channel.
queenulhu.duel.mrc - a game created for twitch.tv/queenulhu
syphon.mrc - a points raffle where everyone puts points into a pot, and the winner gets all the points entered.
nowhosting.mrc - displays a message in chat when you host another channel.
highlight.mrc - use "!highlight message" to make notes of what/when to highlight something that happened during the stream. Saves to a file called "highlights.txt" in your mIRC folder.
thaithyme.istream.mrc - A simple script created for the amazing twitch.tv/thaithyme . Everyone who is a streamer in a channel can let each other know and follow each other.
jackpot.classic.mrc
It is highly recommended that you install Jackpot Version 2 instead of Classic Jackpot Machine, as Jackpot Version 2 is a much newer and superior version of the game. Do not use Classic Jackpot Machine in conjunction with Jackpot Version 2.
Edit the variables and read the info at the beginning of the script before you load the script. Otherwise, you will have to un-load and re-load the script for the changes to take effect.
This is a classic jackpot slot machine. There are nine emotes, and if you get any three in a row, you win the jackpot. The jackpot amount keeps going up with each attempt at winning the jackpot. The odds of winning are 1 in 81.
Command List:
!jackpot ::: plays the game.
!jackpot stats ::: this will tell you some basic stats of the jackpot... the current jackpot, the last winner, how much the last winner won, the total number of winners, and the total payouts.
!jackpot on ::: Mod Only. Turn the game on.
!jackpot off ::: Mod Only. Turn the game off.
!jackpot set # ::: Mod Only. Manually set the current jackpot to #.
!jackpot reset ::: Mod Only. DELETE all jackpot statistics.
!jackpot bet # ::: Mod Only. Change the amount of channel currency that is spent on each play of !jackpot.
!jackpot cd # ::: Mod Only. Change the cooldown time for !jackpot.
!jackpot newpot # ::: Mod Only. Change the amount of channel currency that new !jackpot's will be set to after someone wins.
!jackpot emotes emote1 emote2 emote3 emote4 emote5 emote6 emote7 emote8 emote9 ::: Mod Only. Set the nine emotes that !jackpot uses by adding them to this command.
slots.classic.mrc
It is highly recommended that you install Slots Version 2 instead of Classic Slot Machine, as Slots Version 2 is a much newer and superior version of the game. Do not use Classic Slot Machine in conjunction with Slots Version 2.
Edit the variables and read the info at the beginning of the script before you load the script. Otherwise, you will have to un-load and re-load the script for the changes to take effect.
This is a classic slot machine game for your channel.
Command List:
You may also type !slots instead of !slot, as they will both do the same.
!slot # ::: plays the game and bets # amount of points on the slot machine. (example: !slot 100)
!slot ::: typed by itself will give info on how to play the game as well as the link for the payout info. http://i.imgur.com/ch5vQZ2.png
!slot on ::: Mod Only. Turn the game on.
!slot off ::: Mod Only. Turn the game off.
It's also worth noting that I ran the script through a 1,000,000 times loop to get an idea of the overall odds of winning and losing. The variance was less than 0.1% in favor of the user. It only seems like the users win a lot simply because it's very easy to win 1x, 2x, and even 5x. However, it is very rare to get any of the other combinations of symbols.