API tools faq
paste
Advertisement
Guest User

ModBot v1.7 commands

a guest
Nov 26th, 2014
985
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 12.77 KB | None | 0 0
raw download clone embed print report
  1. ModBot is designed to be a user-friendly bot for Twitch.TV, based heavily on LoyaltyBot.
  2.  
  3. This modification of ModBot directly uses the base code of the original ModBot available at http://twitchmodbot.sourceforge.net.
  4. Even though most of the original code has been modified, this project would probably have never been started without it.
  5.  
  6. Any questions/comments/suggestions can be emailed to me @ CoMaNdO.ModBot@gmail.com
  7.  
  8. Requires .NET Framework 4. Most Windows users should have it already, but if not: http://www.microsoft.com/en-us/download/details.aspx?id=17718
  9.  
  10.  
  11.  
  12. ************************INSTALLATION************************
  13.  
  14. Head to http://ModBot.wordpress.com/installation
  15.  
  16.  
  17.  
  18. ************************SUBSCRIBERS (Regulars)**************
  19.  
  20. ModBot features 2 ways to handle subscribers: a google docs spreadsheet, or adding someone as a sub via the database. They do not conflict with each other, so if you happen to have someones name in both they will not have the subscriber effect twice or more. Just pick whichever one is more convenient for you to use, or a combination. Really doesn't matter, although it is recommended to use the database method.
  21.  
  22. Google Docs (Support not provided, if you encounter any issues you're on your own, use the database method instead):
  23. If you already use LoyaltyBot, you can use the exact same subscribers link.
  24. If you don't use LoyaltyBot and want to make a google docs spreadsheet to more easily manage your subscribers list:
  25. 1) Create a new spreadsheet at http://docs.google.com/
  26. 2) Set cell A1 as the header "Username"
  27. 3) Subscriber Names will then be placed in Column A cells, starting with A2. (Fig. 1)
  28. 4) Set the Subscriber list to Public, and change the type to json. (Fig. 2)
  29. *Note: Even if you don't have a Sub button, you can still add people to your sub list so that they receive double currency income.
  30. Figure 1: [Column Setup] - http://i.imgur.com/eyQOwGz.jpg
  31. Figure 2: [Changing Doc Settings] - http://i.imgur.com/jDU9xOR.jpg
  32.  
  33.  
  34. Database:
  35. Use the following command to add a subscriber:
  36. !modbot addsub <username>
  37.  
  38. Use the following command to remove a subscriber:
  39. !modbot removesub <username>
  40.  
  41.  
  42.  
  43. ************************USER ACCESS LEVELS******************
  44.  
  45. Something that you need to understand for this bot are the user levels.
  46. You, the broadcaster, are always Level 5. You have access to every command.
  47. Normal users in the channel are level 0. They have access to all commands that are set to level 0.
  48. Level 1 users are Helpers. They have basic access.
  49. Level 2 users are Moderators. They have more advanced access.
  50. Level 3 users are Super mods. They have access to all commands except the ones that affect all users or the channel.
  51. Level 4 users are Trusted mods. They have access that is equal to the streamer, add only people you trust to this level.
  52.  
  53. Access of each level is described below.
  54.  
  55.  
  56.  
  57. ************************COMMANDS****************************
  58.  
  59. Currency:
  60. !currency/!<currency> - (Anyone or Access Level 1 if the command is disabled) Checks your current amount of currency on the channel.
  61. !currency/!<currency> top5 - (Anyone) Provides a list of the 5 users with the most currency (5 minutes cooldown).
  62. !currency/!<currency> <username> - (Access Level 1) Manually check the currency of a specific person.
  63. !currency/!<currency> enable/disable - (Access Level 3) Enable or disable the currency command.
  64. !currency/!<currency> add <username/online/all> <amount> - (Access Level 3) Adds the specified amount of currency to the username. Using "online" as the username will give the specified of currency to all online users in the channel. Using "all" (Access Level 4) as the username will give the specified of currency to all users that have ever visited the channel.
  65. !currency/!<currency> set <username/online/all> <amount> - (Access Level 3) Sets the specified amount of currency to the username. Using "online" as the username will set the specified of currency to all online users in the channel. Using "all" (Access Level 4) as the username will set the specified of currency to all users that have ever visited the channel.
  66. !currency/!<currency> remove <username/online/all> <amount> - (Access Level 3) Removes the specified amount of currency from the username. Using "online" as the username will remove the specified of currency from all online users in the channel. Using "all" (Access Level 4) as the username will remove the specified of currency from all users that have ever visited the channel.
  67. !currency/!<currency> clear - (Access Level 3) Removes the currency from all the users who have ever visited the channel.
  68.  
  69.  
  70. Custom commands:
  71. !modbot addcmd <AccessLevelRequired> <command> <output> - (Access Level 2) Access level must be between 0 and 4. Command and output can be any text. Quick example: "!mod addcom 0 !ts Come hang out with on on teamspeak" would add a !ts command that anyone in the channel could use. If the first character of the <output> is a /, it will be stripped.
  72. !modbot delcmd <command> - (Access Level 2) Deletes the command. Currently if you want to edit a command, you must delete it and re-add it.
  73. !modbot cmdlist - (Access Level 1) Lists all of the custom commands currently available to the channel.
  74.  
  75. * Note: The commands will always trigger if they're the first word in the sentence, so you might want to have a "command identifier" such as ! to prevent "accidental triggers" from occuring.
  76.  
  77.  
  78. User management:
  79. !modbot addhelper <username> - (Access Level 3) Changes the person to a Helper (Access Level 1).
  80. !modbot addmod <username> - (Access Level 3) Changes the person to a Moderator (Access Level 2).
  81. !modbot addsuper <username> - (Access Level 4) Changes the person to a Super mod (Access Level 3).
  82. !modbot demote <username> - (Access Level 3) Moves the person down 1 Access Level. Only works if the person's access level is above 0.
  83. !modbot setlevel <username> <number> - (Access Level 3) Sets the person to the specified Access Level. Can be used instead of addhelper, addmod, addsuper, or demote. Cannot change someones access level to yours or above or below 0.
  84. !modbot addsub <username> - (Access Level 3) Add someone to the internal Sub List. Doesn't cause conflicts with a spreadsheet Sub List.
  85. !modbot removesub <username> - (Access Level 3) Remove someone from the internal Sub List.
  86.  
  87. Channel metadata:
  88. !modbot title <title> - (Access Level 4) Changes the channel's title.
  89. !modbot game <game> - (Access Level 4) Changes the channel's game.
  90.  
  91.  
  92. Battletag:
  93. !btag/!battletag <YourBtag> - (Anyone) Sets your battletag in the database. If you win an auction or raffle, your battletag is shown in the winner output.
  94.  
  95.  
  96. Bot:
  97. !modbot/!bot/!botinfo - (Anyone) Provides brief information about the bot, the current version and the blog's link (5 minutes cooldown). Please use it to support me.
  98.  
  99.  
  100.  
  101. ************************EXTENSIONS**************************
  102.  
  103. * Extensions can be downloaded and updated through the updater, automated updates capability is also built in the bot,
  104. but advised to disable when running over 10 extensions (as it may affect the starting times of the bot).
  105.  
  106.  
  107. Giveaway:
  108. Run giveaways in your channel, the UI provides many options to configure such as if the winner must be a follower and/or a subscriber and more.
  109.  
  110. UI:
  111. [EXPLAIN]
  112.  
  113. Commands:
  114. !giveaway/!raffle start <Type> [Price] [MaxTickets] - (Access Level 2) Starts a new giveaway.
  115. Type - The giveaway type, these are the possible options:
  116. 1 = Active users.
  117. 2 = Keyword.
  118. 3 = Ticket.
  119. If Ticket giveaway is selected, a price and max tickets can be provided too, default price is 5 and max tickets 1.
  120. Price - The price for a single ticket.
  121. MaxTickets - The max amount of tickets for a single user to buy.
  122. !giveaway/!raffle close/lock - (Access Level 2) Declines new entries.
  123. !giveaway/!raffle open/unlock - (Access Level 2) Accepts new entries.
  124. !giveaway/!raffle stop - (Access Level 2) Ends the giveaway.
  125. !giveaway/!raffle roll [optional <Amount>] - (Access Level 2) Rolls for a winner, in ticket/keyword giveaway the giveaway must be closed first.
  126. !giveaway/!raffle cancel - (Access Level 2) Cancels the current giveaway (and refunds everyone's entries).
  127.  
  128. !ticket <amount> - (Anyone) In a ticket giveaway, purchases the specified number of tickets. The amount of tickets must be equal or greater than 0. If you buy tickets and wish to get out of the raffle, use "!ticket 0" to have your coins refunded.
  129.  
  130.  
  131. Auction:
  132. Lets users bid currency over something provided by (probably) the streamer.
  133.  
  134. UI:
  135. Planned.
  136.  
  137. Commands:
  138. !auction open - (Access Level 2) Opens a new auction. Users can bid freely until you close the auction. Current winner is shown in the channel each time there's a new High Bid, and every 30 seconds afterwards.
  139. !auction close - (Access Level 2) Closes the auction and announces the final winner.
  140. !auction cancel - (Access Level 2) Cancels the auction and refunds the highest bid.
  141. !bid <Amount> - (Anyone) Bid <Amount>.
  142.  
  143.  
  144. Gambling:
  145. Lets users gamble currency points over different options, that's another way to earn currency.
  146. This is commonly used for win/lose over games/matches in the stream.
  147.  
  148. UI:
  149. Planned.
  150.  
  151. Commands:
  152. !gamble open <MinBet> <MaxBet> <WinReward> <option1> <option2> <option3> ... <optionN> - (Access Level 2) Opens a new betting pool.
  153. MinBet - Specifies the minimum amount of currency required to make a bet.
  154. MaxBet - Specifies the maximum amount of currency that a user can bet.
  155. WinReward - Additional currency reward to give to each winner.
  156. Options - Space separated, use quotation marks to add an option with spaces.
  157. !gamble close - (Access Level 2) Locks the bets so that no more bets can be made.
  158. !gamble winner <Option> - (Access Level 2) Closes the bet pool, and pays out people who bet on the correct option.
  159. Option - The winning option, provide the name or the option id with a hashtag first (ex: #1).
  160. !gamble cancel - (Access Level 2) Cancels the bet pool, and refunds all bets.
  161. !bet help - (Anyone) Provides information about the availble betting options and how to bet.
  162. !bet <Amount> <Option> - (Anyone) Bet <amount> on <option>
  163. Amount - The amount of currency to bet.
  164. Option - The option to bet on, can be the full option name or the id with a hashtag first (ex: #1).
  165.  
  166.  
  167. Greetings:
  168. Greets new users joining the channel.
  169. This is really not recommended for use, many people find greeting bots offensive.
  170.  
  171. Commands:
  172. !modbot greeting set <Greeting Text> - (Access Level 3) Sets your greeting message that will be sent everytime someone joins your channel. Using '@user' in your greeting will put the person who joined's username in the greeting.
  173. !modbot greeting on - (Access Level 3) Turns on your greeting messages.
  174. !modbot greeting off - (Access Level 3) Turns off your greeting messages.
  175.  
  176.  
  177. Polls:
  178. Start polls that cost currency.
  179. Contains optional automated goals to end the poll.
  180.  
  181. UI:
  182. Planned.
  183.  
  184. Commands:
  185. !poll create/start <VoteCost> <VotesGoal> <TotalVotesGoal> <Title> <Option1> <Option2> ... <OptionN> - (Access Level 2) Start a poll.
  186. VoteCost - The cost to vote.
  187. VotesGoal - The goal that a single option must reach to automatically end the poll and declare that option as the winner, 0 to disable.
  188. TotalVotesGoal - The goal that all options together must reach (ex: if set to 8, 3 from option 1, 5 from option 2) to automatically end the poll and declare the leading option as the winner, 0 to disable.
  189. Title - The title of the poll.
  190. Options - Space separated options, use quotation marks to add options with spaces (ex: "Option 1").
  191. !poll close - (Access Level 2) Decline new votes.
  192. !poll open - (Access Level 2) Accept new votes.
  193. !poll stop/end - (Access Level 2) Ends the poll, declaring the leading option as the winner.
  194. !poll cancel - (Access Level 2) Cancels the poll, refunds all the votes.
  195. !poll votes - (Access Level 1) Shows the current state of the votes.
  196. !poll votes top <number> - (Access Level 1) Shows the current state of the top <number> votes.
  197. !vote <Option> - (Anyone) Vote on <option>.
  198. Option - The option, must be the full name or the id with a hashtag first (ex: #1).
  199.  
  200.  
  201. User Ranks (Work in progress):
  202. Provides ranks to your users. Fully configurable.
  203.  
  204. UI:
  205. Planned.
  206.  
  207. Commands:
  208. !ranks add <Rank> - (Access Level 3) Add a rank.
  209. !ranks remove <Rank> - (Access Level 3) Remove a rank.
  210. !ranks list - (Access Level 3) List all ranks.
  211.  
  212.  
  213. Multiple Command Outputs:
  214. Adds the option to add custom commands with multiple outputs.
  215. An optional option is data storage, once the command is used and a certain output has been granted to a user, it'll be saved an whenever the user will use the command again, he'll get the same output every time.
  216.  
  217. UI:
  218. [EXPLAIN]
  219.  
  220. Commands:
  221. None.
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!