Doopian

Guitar Hero Song Request Bot Instructions and Setup

Jan 26th, 2016
571
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 9.02 KB | None | 0 0
  1. Thanks for checking out the song request bot I made! Read this file very carefully because it has all the information
  2. you'll need to use the request bot. If you have any issues with it or requests for new features, feel free to message
  3. me on twitch or twitter! Also, I will be editting this pastebin and the others as I release newer versions.
  4.  
  5. SETUP:
  6.  
  7. 1. SETTING UP THE BOT WITH MIRC
  8. Here is a video on how to download and set up mirc with twitch your bot:
  9. -----> https://www.youtube.com/watch?v=8f1hum8i2uw <-----
  10.  
  11. Keep in mind, you do need to have a license to use mIRC. Its a one time payment of $20 on their site, but you can use
  12. a 30 day free trial to see if using mIRC is something you would like. Also, you can check out that video series if you
  13. feel motivated to code your own features on top of the song request code I've provided.
  14. NOTE: You do run the risk of messing up the bot if you start developing your own code.
  15.  
  16.  
  17. 2. FINDING THE SCRIPTS EDITOR
  18. After you have successfully created a new twitch account for your bot and connected it to your channel via mIRC, we
  19. can add the code. First, you need to locate the "Scripts Editor" button on mIRC. It is located in the top tool bar
  20. 5th from the left and looks like this:
  21. -----> http://thebadgersett.us/images/guide/mirc19.png <-----
  22.  
  23. Once you've located the Scripts Editor, click it. Another screen will pop up with 5 tabs "Aliases, Popups, Remote,
  24. Users, and Variables" We will only need to worry edit 3 of the tabs Remote, Users, and Variables.
  25.  
  26.  
  27. 3. THE REMOTE TAB
  28. First, we will edit the remote tab. This is where the majority of the code will go when programming in mIRC. The other
  29. tabs are there to make things easier for coding in remote. I have uploaded all of the "remote" code to a pastebin file
  30. here:
  31. -----> http://pastebin.com/sAzR74h2 <-----
  32.  
  33. Copy and paste that entire file to the remote tab.
  34.  
  35.  
  36. 4. THE USERS TAB
  37. The Users tab is very simple all you need to add here is:
  38. -----> 3:[your twitch name] <-----
  39.  
  40. EXAMPLE: In my code I have:
  41. 3:doopian
  42.  
  43.  
  44. 5. THE VARIABLES TAB
  45. The Variables tab will be used to customize your bot. For example, if you want viewers to only be able to
  46. request 1 song, or if you change your mind and want to allow 2 requests per user, you can change the values of the
  47. variables here. The variables tab is in a pastebin file found here:
  48. -----> http://pastebin.com/J301HXYh <-----
  49.  
  50. Copy and paste that entire file to the variables tab.
  51.  
  52.  
  53.  
  54. INSTRUCTIONS:
  55.  
  56. 1. LEARNING THE VARIABLES
  57. After you have copy and pasted the variables tab you will see 5 variables on the top "%SongLengthLimit, %TotalSongLimit,
  58. %SongRequestLimit, %UserRequestLimit, and %SongsLink" .. You can edit the values of these however you like, but
  59. first let me explain what each does:
  60.  
  61. %SongLengthLimit: This variable is the limit to how long a song title can be to be requested. This prevents spam
  62. basically. So any song someone requests has to be less than 55 characters by default. You can
  63. edit that value if you want shorter or longer song titles allowed in your list. I have this value
  64. set to 55 because that is a little over the length of "It must really suck to be Four Years Strong
  65. Right now" in GH:Live.
  66.  
  67. %TotalSongLimit: This variable is used to set a maximum size of your list. By default it is set to 10 songs before
  68. the list is full and viewers need to wait until a song is removed to request another.
  69.  
  70. %SongRequestLimit: This variable is how many duplicate requests you want to allow in your request list. This prevents
  71. your song list from being mostly one song. For example, if you want to allow the same song on your
  72. list 2 times, but not 3 set the value to 2. By default, it is set to 1 so there are no duplicate songs
  73. allowed. NOTE: Any misspellings or a change of spacing will add duplicates to the list over your limit.
  74. I will cover how to fix this later in the file.
  75.  
  76. %UserRequestLimit: This variable is how many songs each user can request. By default I have it set to 1 so each user can
  77. request no more than 1 song until their song has been played or removed from the list. Smaller channels
  78. may want to change this to a higher number.
  79.  
  80. %SongsLink: This variable will link to a page where users can view the songs you have. By default there is no value. You don't
  81. need to have a link there for the bot to work. If you do decide to add a link to your requests just add a space
  82. and then copy and paste the link to a pastebin or something. For example my %SongsLink is set up like this:
  83. %SongsLink http://pastebin.com/SHzEzip2
  84.  
  85. NOTE: If you plan to strictly request ghtv on stream, toymachinesh has a site that he keeps updated with all
  86. of the ghtv songs available here:
  87. -----> http://theherofeed.com/guitar-hero-tv-song-list/ <-----
  88.  
  89. NOTE: DO NOT edit the 5 other variables "%listtimer, %currenttimer, %nexttimer, %songstimer, and %totalsongs"
  90.  
  91.  
  92. 2. LEARNING THE COMMANDS
  93. Now that you've set and undertand your variables, we can start learning and using the commands! There are 9 commands in
  94. total. 2 of those commands only you can use, 2 only moderators and you can use, and the rest anyone can use.
  95.  
  96. YOUR COMMANDS:
  97. !resetsongs: When you want to begin taking song requests, use this command to clear the entire request list.
  98.  
  99. !pop: This will remove the first song on the list and then output the next song to be played. If there are no songs
  100. left to be played, the bot will let you know.
  101.  
  102.  
  103. YOU/MOD COMMANDS:
  104. !remove: There will be songs or phrases requested that you don't want on your list. This command lets you and your mods
  105. remove a song. In order to use the command correctly you need to add either a number or a song title to the
  106. command in order for the bot to know which song you want to remove.
  107.  
  108. EXAMPLE: If the list is ttfaf, slow ride, mauvis garcon, and my curse. We can remove slow ride by typing:
  109. !remove slow ride OR !remove 2
  110.  
  111. NOTE: Since slow ride is the 2nd song on the list "!remove 2" will delete it. Also, if you type out the
  112. song title to remove the song, you will need to spell it correctly with proper spacing.
  113.  
  114. !change: If a viewer accidentally requests a song you don't have or wants to change requests for whatever reason,
  115. this command will do the trick. In order to properly format the command you need to add a number AND THEN
  116. a song title. The number is the song you want to change on the list and the song title is the NEW song title.
  117.  
  118. EXAMPLE: If the list is ttfaf, slow ride, mauvis garcon, and my curse. We can change slow ride to cliffs of
  119. dover by typing:
  120. !change 2 cliffs of dover
  121.  
  122. NOTE: This is the only way to change a song. You have to format the command in this order NUMBER FIRST then
  123. the new song title.
  124.  
  125.  
  126. PLEB COMMANDS:
  127. !request: This is how anyone can request a song for you to play on your channel. In order to request a song you just
  128. need to add a song title after the command.
  129.  
  130. EXAMPLE: If I want to request slow ride I would type:
  131. !request slow ride
  132.  
  133. NOTE: Every song request gets added to the end of the list, so you will be playing songs in the order they
  134. are requested in. AKA First In First Out.
  135.  
  136. !songs: This will display the link to your song requests if you have a link. If not, the bot will say you don't have a
  137. link to your songs.
  138.  
  139. !currentsong: Displays the current song being played if there is one. AKA the first song on the list.
  140.  
  141. !nextsong: Displays the next song being played if there is one. AKA the second song on the list.
  142.  
  143. !list: Displays the entire request list if there are songs to display.
  144.  
  145. NOTE: You may want to make a panel on your twitch page for these commands so users have a place to see how to use your
  146. bot. This will help you not get spammed with questions on how to use the bot.
  147.  
  148.  
  149.  
  150. POSSIBLE UPDATES:
  151. At this point your bot is set up and you understand everything there is to know about it (I hope). I will be updating
  152. the bot when I can. I will also add some new commands, debug any issues, and maybe scrap some ideas. Currently what I
  153. want to add are:
  154.  
  155. 1) A ban command for song requests: To remove a user that ALWAYS requests something you need to remove.
  156. 2) A random song picker: To pick songs randomly from your request list rather than First In First Out.
  157.  
  158. Again, if you have any ideas/questions regarding the bot just message me on twitter or twitch. Thanks again for checking
  159. this out and hopefully it works out well for your channel!
Advertisement
Add Comment
Please, Sign In to add comment