CloudBot - The simple, fast, expandable, open-source Python IRC Bot!
Clone or download
#292 Compare This branch is 94 commits ahead of edwardslabs:gonzobot.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cloudbot
data
docs
plugins
tests
travis
.editorconfig
.gitattributes
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
Vagrantfile
config.default.json
format_json.py
requirements.txt
vagrant-bootstrap.sh

README.md

CloudBot

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

Getting CloudBot

There are currently four different branches of this repository, each with a different level of stability:

  • gonzobot (stable): This branch contains everything in the master branch plus additional plugins added for Snoonet IRC. This branch is the currently maintained branch which will also contain many fixes for various bugs from the master branch.
  • gonzobot-dev (unstable): This branch is based off of the gonzobot branch and includes new plugins that are not fully tested.
  • master (stable (old)): This branch contains stable, tested code. This branch is based directly on the upstream master branch and is not currently maintained.
  • python3.4 (unstable (old)): This is the outdated testing branch from the upstream repo.

New releases will be pushed from python3.4 to master whenever we have a stable version to release. These changes will be merged into gonzobot then deployed. This should happen on a fairly regular basis, so you'll never be too far behind the latest improvements.

Installing CloudBot

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

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.4 -m cloudbot

Note that you can also run the cloudbot/__main__.py file directly, which will work from any directory.

python3.4 CloudBot/cloudbot/__main__.py

Specify the path as /path/to/repository/cloudbot/main.py, where cloudbot is inside the repository directory.

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.

To write your own plugins, visit the Plugins Wiki Page.

More at the Wiki Main Page.

Support

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!

Example CloudBots

You can find a number of example bots in #CloudBot.

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/>.

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

Powered by wordnik

Translations are Powered by Yandex.Translate

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