CloudBotRefresh is the newest generation of CloudBot, the python IRC bot originally based on Skybot.
To install CloudBotRefresh on *Unix, see docs/installing-unix.md
To install CloudBotRefresh on Windows, see docs/installing-windows.md
If you're going to be actively developing on CloudBotRefresh, and submitting PRs back, we recommend running CloudBotRefresh inside Vagrant. This allows everyone to have an identical development environment.
To install CloudBotRefresh in Vagrant (both *Unix and Windows), see docs/installing-vagrant.md
Before you run the bot, rename config.default 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 CloudBotRefresh/cloudbot/__main__.py
Specify the path as /path/to/repository/cloudbot/main.py, where cloudbot is inside the repository directory.
To configure your CloudBot, visit the Config Wiki Page.
To write your own modules, visit the Module Wiki Page.
More at the Wiki Main Page.
Note that the configuration page, and the main wiki page, are still for CloudBot Develop. The Module Wiki Page has been rewritten for refresh, but the other pages are outdated.
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-2014 Luke Rogers and CloudBot Contributors
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/>.