CloudBot is a simple, fast, expandable open-source Python IRC Bot!
There are currently two different branches of this repository, each with a different level of stability:
- master (stable): This branch contains stable, tested code. This is the branch you should be using if you just want to run your own CloudBot!
- python3.4 (unstable): This branch is where where test and develop new features. If you would like to help develop CloudBot, you can use this branch.
New releases will be pushed from python3.4 to master whenever we have a stable version to release. This should happen on a fairly regular basis, so you'll never be too far behind the latest improvements.
Firstly, CloudBot will only run on Python 3.4 or higher. Because we use the asyncio module, you will not be able to use any other versions of Python.
To install CloudBot on *nix (linux, etc), see here
To install CloudBot on Windows, see here
Before you run the bot, rename
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.4 -m cloudbot
Note that you can also run the
cloudbot/__main__.py file directly, which will work from any directory.
Specify the path as /path/to/repository/cloudbot/main.py, where
cloudbot is inside the repository directory.
Getting help with CloudBot
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.
To write your own plugins, visit the Plugins Wiki Page.
More at the Wiki Main Page.
The developers reside in #CloudBot on EsperNet 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!
You can find a number of example bots in #CloudBot.
CloudBot is licensed under the GPL v3 license. The terms are as follows.
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/>.
This product includes GeoLite2 data created by MaxMind, available from http://www.maxmind.com. GeoLite2 databases are distributed under the Creative Commons Attribution-ShareAlike 3.0 Unported License