TotallyNotRobots / CloudBot

CloudBot - The simple, fast, expandable, open-source Python IRC Bot!
GNU General Public License v3.0
72 stars 40 forks source link
bot framework irc irc-bot python

CloudBot

Python application CodeFactor codebeat badge codecov

CloudBot is a simple, fast, expandable open-source Python IRC Bot!

Getting CloudBot

You have a few options for getting the bot, you can:

Installing CloudBot

Firstly, CloudBot will only run on Python 3.6 or higher

To install CloudBot on *nix (linux, etc), see here

To install CloudBot on Windows, see here

Running CloudBot

Before you run the bot, rename config.default.json to config.json and edit it with your preferred settings. You can check if your JSON is valid using jsonlint.com!

Once you have installed the required dependencies and renamed the config file, you can run the bot! Make sure you are in the correct folder and run the following command:

python3 -m cloudbot

Getting help with CloudBot

Documentation

The CloudBot documentation is currently somewhat outdated and may not be correct. If you need any help, please visit our IRC channel and we will be happy to assist you.

Support

The developers reside in #gonzobot-dev on Snoonet and would be glad to help you.

If you think you have found a bug/have a idea/suggestion, please open a issue here on Github and contact us on IRC!

Contributing

See CONTRIBUTING.md

Changelog

See CHANGELOG.md

License

CloudBot is licensed under the GPL v3 license. The terms are as follows.

GPL V3

CloudBot

Copyright © 2011-2015 Luke Rogers / CloudBot Project

CloudBot is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

CloudBot is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with CloudBot.  If not, see <http://www.gnu.org/licenses/>.

Powered by wordnik

TV information is provided by TheTVDB.com, but we are not endorsed or certified by TheTVDB.com or its affiliates.

This product uses data from http://wordnik.com in accordance with the wordnik.com API terms of service.