├── LICENSE ├── Pinger.cs ├── Program.cs ├── README.md └── TwitchChatBot.cs /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Pinger.cs: -------------------------------------------------------------------------------- 1 | using System.Net.Sockets; 2 | using System.Threading; 3 | 4 | namespace ChatBot_Demo 5 | { 6 | //Handles sending PING to Twitch server every five minutes to keep the connection alive 7 | public class Pinger 8 | { 9 | //vars 10 | public TwitchChatBot myClient; 11 | public Thread pingSender; 12 | 13 | //constructor 14 | public Pinger(TwitchChatBot myClient) 15 | { 16 | this.myClient = myClient; 17 | pingSender = new Thread(new ThreadStart(this.Run)); 18 | } 19 | 20 | // Starts the thread 21 | public void Start() 22 | { 23 | pingSender.IsBackground = true; 24 | pingSender.Start(); 25 | } 26 | 27 | // Send PING to irc server every 5 minutes 28 | public void Run() 29 | { 30 | while (true) 31 | { 32 | myClient.SendPing(); 33 | Thread.Sleep(300000); // 5 minutes 34 | } 35 | } 36 | } 37 | } -------------------------------------------------------------------------------- /Program.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Net.Sockets; 3 | using System.IO; 4 | using System.Collections.Generic; 5 | 6 | namespace ChatBot_Demo 7 | { 8 | class Program 9 | { 10 | //credentials (suppressed for privacy) 11 | private static string login_name = ""; 12 | private static string token = Environment.GetEnvironmentVariable("Token"); //Token should be stored in a safe place 13 | private static List channels_to_join = new List(new string[] { "", "" }); 14 | 15 | //main function 16 | static void Main(string[] args) 17 | { 18 | //Testing writing to line 19 | Console.WriteLine("Hello World!"); 20 | 21 | //New up a List of TwitchChatBot objects 22 | List chatBots = new List(); 23 | 24 | //add each channel to the list 25 | for (int i = 0; i < channels_to_join.Count; i++) 26 | { 27 | chatBots.Add(new TwitchChatBot(login_name, token, channels_to_join[i])); 28 | } 29 | 30 | //for each chatBot... 31 | for (int i = 0; i < chatBots.Count; i++) 32 | { 33 | //this chatBot 34 | TwitchChatBot chatBot = chatBots[i]; 35 | 36 | //Connect to Twitch IRC 37 | chatBot.Connect(); 38 | 39 | //Start Pinger 40 | Pinger pinger = new Pinger(chatBot); 41 | pinger.Start(); 42 | } 43 | 44 | //Read message until we quit 45 | while (true) 46 | { 47 | //for each chatBot... 48 | for (int i = 0; i < chatBots.Count; i++) 49 | { 50 | //this chatbot 51 | TwitchChatBot chatBot = chatBots[i]; 52 | 53 | //if we get disconnected, reconnect 54 | if (!chatBot.Client.Connected) 55 | { 56 | chatBot.Connect(); 57 | } 58 | //else we're connected 59 | else 60 | { 61 | //get the message that just came through 62 | string msg = chatBot.ReadMessage(); 63 | 64 | //did we receive a message? 65 | if (msg != "" && msg != null) 66 | { 67 | //write the raw message to the console 68 | Console.WriteLine(msg); 69 | 70 | //response string 71 | string toRespond = ""; 72 | 73 | //If PING respond with PONG 74 | if (msg.Length >= 4 && msg.Substring(0, 4) == "PING") 75 | chatBot.SendPong(); 76 | 77 | //Trim the message to just the chat message piece 78 | string msgTrimmed = trimMessage(msg); 79 | 80 | //Handling commands 81 | if (msgTrimmed.Length >= 6 && msgTrimmed.Substring(0, 6) == "!8ball") 82 | toRespond = chatBot.Command_MagicEightBall(); 83 | else if (msgTrimmed == "!age") 84 | toRespond = chatBot.Command_Age(); 85 | else if (msgTrimmed == "!discord") 86 | toRespond = chatBot.Command_Discord(); 87 | 88 | //Write response to console and send message to chat 89 | Console.WriteLine(toRespond); 90 | 91 | //Send the message to chat 92 | chatBot.SendMessage(toRespond); 93 | } 94 | 95 | } 96 | } 97 | 98 | } 99 | 100 | } 101 | 102 | #region Helper methods 103 | /// 104 | /// Trims an IRC message from chat to just the message that was sent in the chat 105 | /// 106 | /// 107 | /// string 108 | public static string trimMessage(string message) 109 | { 110 | int indexOfSecondColon = getNthIndex(message, ':', 2); 111 | var result = message.Substring(indexOfSecondColon + 1); 112 | return result; 113 | } 114 | 115 | /// 116 | /// Gets the second colon, which is the seperator before the chat message 117 | /// 118 | /// 119 | /// 120 | /// 121 | /// string 122 | public static int getNthIndex(string s, char t, int n) 123 | { 124 | int count = 0; 125 | for (int i = 0; i < s.Length; i++) 126 | { 127 | if (s[i] == t) 128 | { 129 | count++; 130 | if (count == n) 131 | { 132 | return i; 133 | } 134 | } 135 | } 136 | return -1; 137 | } 138 | #endregion 139 | 140 | 141 | } 142 | } 143 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CSharp-Chatbot-Sample 2 | A sample IRC Twitch chatbot using written in C#. 3 | 4 | ## What's in this sample 5 | This sample demonstrates how to write a simple Twitch chatbot through IRC. The chatbot connects to a Twitch channel's chat via IRC, reads messages from chat, responds to a few simple commands, and maintains the connection by PINGing and PONGing as needed. 6 | 7 | ## How to edit this Bot and use it yourself 8 | - Generate an OAuth Token per the instructions from the [Twitch IRC documentation](https://dev.twitch.tv/docs/irc/#building-the-bot) 9 | - Create a new C# Console Application 10 | - Download the TwitchChatBot.cs file 11 | - Add the TwitchChatBot.cs file into your project 12 | - Download the Pinger.cs file 13 | - Add the Pinger.cs file into your project 14 | - Download the Program.cs file 15 | - Overwrite the existing Program.cs file in your project with the contents from this Program.cs file. 16 | - Update the namespace in your files as they need to match the name of your project rather than "Chatbot_Demo" 17 | - Update the three variables in the Program.cs file with the credentials specific to you ("login_name" is the Twitch username of your bot, "token" is the token generated from step 1, and "channels_to_join" is the Twitch channel(s) chat you want your bot to join) 18 | - Run the project. Open the channel you're testing chat with and talk to your bot 19 | -------------------------------------------------------------------------------- /TwitchChatBot.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Text; 4 | using System.Net.Sockets; 5 | using System.IO; 6 | 7 | namespace ChatBot_Demo 8 | { 9 | public class TwitchChatBot 10 | { 11 | //Props 12 | public TcpClient Client; 13 | public StreamReader Reader; 14 | public StreamWriter Writer; 15 | private string Login_Name { get; set; } 16 | private string Token { get; set; } 17 | private string Channel_To_Join { get; set; } 18 | 19 | //constructor 20 | public TwitchChatBot(string l, string t, string c) 21 | { 22 | this.Login_Name = l; 23 | this.Token = t; 24 | this.Channel_To_Join = c; 25 | } 26 | 27 | #region IRC 28 | /// 29 | /// Makes an IRC connection to Twitch 30 | /// 31 | /// void 32 | public void Connect() 33 | { 34 | Client = new TcpClient("irc.twitch.tv", 6667); 35 | Reader = new StreamReader(Client.GetStream()); 36 | Writer = new StreamWriter(Client.GetStream()); 37 | 38 | Writer.WriteLine("PASS " + Token); 39 | Writer.WriteLine("NICK " + Login_Name); 40 | Writer.WriteLine("USER " + Login_Name + " 8 * :" + Login_Name); 41 | Writer.WriteLine("JOIN #" + Channel_To_Join); 42 | Writer.Flush(); 43 | } 44 | 45 | /// 46 | /// Reads a message from the chat of the channel you're joined to 47 | /// 48 | /// string 49 | public string ReadMessage() 50 | { 51 | string chat_message = Reader.ReadLine(); 52 | return chat_message; 53 | } 54 | 55 | /// 56 | /// Sends a message in the chat of the channel you're joined to 57 | /// 58 | /// 59 | /// void 60 | public void SendMessage(string message) 61 | { 62 | string toSend = (":" + Login_Name + "!" + Login_Name + "@" + Login_Name + 63 | ".tmi.twitch.tv PRIVMSG #" + Channel_To_Join + " :" + message); 64 | Writer.WriteLine(toSend); 65 | Writer.Flush(); 66 | } 67 | 68 | /// 69 | /// Sends a ping periodically to keep the connection alive 70 | /// 71 | /// void 72 | public void SendPing() 73 | { 74 | Console.WriteLine("Sending PING...."); 75 | Writer.WriteLine("PING :irc.twitch.tv"); 76 | Writer.Flush(); 77 | } 78 | 79 | /// 80 | /// Sends a pong in response to a PING to keep the connection alive 81 | /// 82 | /// void 83 | public void SendPong() 84 | { 85 | Console.WriteLine("Sending PONG...."); 86 | Writer.WriteLine("PONG :irc.twitch.tv"); 87 | Writer.Flush(); 88 | } 89 | 90 | #endregion 91 | 92 | #region Command Handlers 93 | /// 94 | /// Handles the !age command. Returns info on the streamer's age. 95 | /// 96 | /// string 97 | public string Command_Age() 98 | { 99 | string s = "Streamer is X years old"; 100 | return s; 101 | } 102 | 103 | /// 104 | /// Handles the !8ball command. Returns a Magic Eight Ball phrase 105 | /// 106 | /// string 107 | public string Command_MagicEightBall() 108 | { 109 | string s; 110 | Random random = new Random(); 111 | int randomNumber = random.Next(0, 8); 112 | switch (randomNumber) 113 | { 114 | case 0: 115 | s = "Signs point to yes"; 116 | break; 117 | case 1: 118 | s = "My intuition says no"; 119 | break; 120 | case 2: 121 | s = "Definitely, probably"; 122 | break; 123 | case 3: 124 | s = "Doubtful, but hold out hope"; 125 | break; 126 | case 4: 127 | s = "Absolutely not"; 128 | break; 129 | case 5: 130 | s = "It's unclear right now. Ask again later."; 131 | break; 132 | case 6: 133 | s = "Chances are good"; 134 | break; 135 | default: 136 | s = "That's a silly question. Ask something else"; 137 | break; 138 | } 139 | 140 | return s; 141 | } 142 | 143 | /// 144 | /// Handles the !discord command. Responds with a link to the streamer's discord. 145 | /// 146 | /// string 147 | public string Command_Discord() 148 | { 149 | string s = "Come join the Discord! "; 150 | 151 | return s; 152 | } 153 | #endregion 154 | } 155 | } 156 | --------------------------------------------------------------------------------