About This File
THIS PROJECT HAS MOVED TO TotallyNotRobots/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 #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!
Changelog
See CHANGELOG.md
