CloudBot/DEV

About

CloudBot is a Python IRC bot very heavily based on Skybot by rmmh.

Goals

• Easy to use wrapper
• Intuitive configuration
• Fully controlled from IRC
• Fully compatable with existing skybot plugins
• Easily extendable
  • Thorough documentation
  • Cross-platform
• Muti-threaded, efficient
  • Automatic reloading
  • Little boilerplate

Getting and using CloudBot

Download

Get CloudBot at https://github.com/ClouDev/CloudBot/zipball/develop.

Unzip the resulting file, and continue to read this document.

Install

Before you can run the bot, you need to install a few Python dependencies. These can be installed with pip (The Python package manager):

[sudo] pip install -r requirements.txt

How to install pip

curl -O http://python-distribute.org/distribute_setup.py # or download with your browser on windows
python distribute_setup.py
easy_install pip

Run

Once you have installed the required dependencies, there are two ways you can run the bot:

Launcher

Note: Due to some issues with the launcher we recommend you run the bot manually as detailed below.

The launcher will start the bot as a background process, and allow the bot to close and restart itself. This is only supported on unix-like machines (not Windows).

For the launcher to work properly, install screen, or daemon (daemon is recommended):

apt-get install screen

apt-get install daemon

Once you have installed either screen or daemon, run the start command:

./cloudbot start

It will generate a default config for you. Once you have edited the config, run it again with the same command:

./cloudbot start

This will start up your bot as a background process. To stop it, use ./cloudbot stop. (Config docs at the wiki)

Manually

To manually run the bot and get console output, run it with:

python bot.py

On Windows you can usually just double-click the bot.py file to start the bot, as long as you have Python installed correctly.

(note: running the bot without the launcher breaks the start and restart commands)

Getting help with CloudBot

Documentation

To configure your CloudBot, visit the Config Wiki Page.

To write your own plugins, visit the Plugin 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.

Requirements

CloudBot runs on Python 2.7.x. It is developed on Ubuntu 12.04 with Python 2.7.3.

It requires the Python module lXML, and Enchant is needed for the spellcheck plugin.

The programs daemon or screen are recomended for the launcher to run optimaly.

Windows users: Windows compatibility with the launcher and some plugins is broken (such as ping), but we do intend to add it.³

Example CloudBots

The developers of CloudBot run two CloudBots on Espernet.

They can both be found in #CloudBot.

mau5bot is the semi-stable bot, and runs on the latest stable development version of CloudBot. (mau5bot is running on Ubuntu Server 12.04 with Python 2.7.3)

neerbot is unstable bot, and runs on the HEAD of the develop branch. (neerbot is running on Debian Wheezy/Testing with Python 2.7.2)

License

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

CloudBot/DEV

Copyright © 2011-2012 Luke Rogers / ClouDev - <[cloudev.github.com](http://cloudev.github.com)>

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

Notes

³ eventually