The easy to use and full featured Irc Bot everyone is talking about!
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

readme.md 2.6KB

4 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. # About Combot
  2. Created by: Chris Woodward
  3. Combot is designed to provide an all-in-one solution for those who wish to run an IRC bot easily. It includes many useful features as well as fun games. It can even be used as your personal client!
  4. ## Feature Set
  5. * Auto-Reconnect Available
  6. * Server Specific Configurations
  7. * Nickname and Channel Blacklists
  8. * Simple Yet Powerful Command Structure
  9. * Hot loaded Modules
  10. * Bot Configuration Access
  11. * Automatic Invite Accepts
  12. * Channel Moderation Control
  13. * Message and Highlight Spam Control
  14. * Messaging System
  15. * Weather Information
  16. * Google and Youtube search
  17. * URL Information Display
  18. * Channel Introductions
  19. * Wolfram Alpha
  20. * Nick Quotes
  21. * Decision Maker
  22. * Channel Rules
  23. * Nick Last Seen
  24. * SED
  25. * Custom Command Repsponses
  26. * Channel and Nick Relaying
  27. ## Requirements
  28. * MySQL v5.5 or greater
  29. * .NET Framework v4.5.1 or Mono Runtime >3.2.8
  30. * Git (If using the GitVersionTask Nuget Package)
  31. ## Installation - Windows
  32. 1) Download the Release zip file from the latest release in https://git.teknik.io/Uncled1023/Combot/releases and extract the files to a directory of your choice.<br>
  33. 2) Copy Combot.Servers.Default.json to Combot.Servers.json and configure the bot for the correct servers, channels, owner information, and MySQL database.<br>
  34. 3) Run Combot-Interface.exe or Combot-CLI.exe
  35. ## Installation - Linux (Ubuntu)
  36. 1) Download the Release zip file from the latest release in https://git.teknik.io/Uncled1023/Combot/releases and extract the files to a directory of your choice.<br>
  37. 2) Copy Combot.Servers.Default.json to Combot.Servers.json and configure the bot for the correct servers, channels, owner information, and MySQL database.<br>
  38. 3) Install Mono-Complete: `sudo apt-get mono-complete`<br>
  39. 4) Run Combot-CLI.exe: `mono Combot-CLI.exe`
  40. ## Building
  41. To fully maximise the potential of Combot's ease of development, Visual Studios 13 should be installed. If you have Visual Studios installed, you can add **Module Template.zip** to your project templates to easily create new modules. If you do not want to use a template, you can copy an existing module and work from there.
  42. If you do not have git installed on your machine, or do not want to add the git versioning, then go to the Nuget Package Manager within Visual Studios and Uninstall the **GitVersionTask** package.
  43. ## Bugs/Feature Requests
  44. Please report all bugs you find to me so I can fix them as soon as possible. Also if you have any feature requests, feel free to send them to me as well.
  45. ## Contact Info
  46. Email: admin@teknik.io<br>
  47. IRC: (irc.teknik.io)#Combot<br>
  48. IRC: (irc.rizon.net)#Combot<br>
  49. Nick: Uncled1023