This repository has been archived on 2023-04-13. You can view files and clone it, but cannot push or open issues/pull-requests.
 
 
Go to file
ChChBot admin 358b415566 added corridor light 2017-11-30 22:24:15 +01:00
core some changes... 2015-02-18 22:55:28 +01:00
disabled_stuff Revert "disable chch_worker" 2015-02-20 13:13:45 +01:00
lib Added Tweepy contributor and license information 2013-07-15 23:15:23 +12:00
plugins added corridor light 2017-11-30 22:24:15 +01:00
util Improved http module, improved mcuser 2014-02-28 16:56:32 +13:00
.editorconfig Create .editorconfig 2013-07-31 22:10:21 +08:00
.gitignore ignore config.ssl 2016-11-17 21:24:07 +01:00
CONTRIBUTING.md Adjust terms, change references to 'master' to 'develop', fix links 2013-08-01 21:03:24 +08:00
CONTRIBUTORS Added RAINBOWS 2013-10-01 10:03:46 +13:00
LICENSE Remove executable permissions 2013-11-29 19:47:40 -08:00
README.md test 2014-02-25 18:50:03 +13:00
cloudbot.py I am not a smart person sometimes 2014-03-01 18:40:36 +13:00
config.default update default config 2015-02-19 17:22:27 +01:00
requirements.txt Added really shoddy, probably broken git plugin 2014-02-25 19:30:55 +13:00
restartcloudbot.sh removed buggy part for killing old processes 2017-02-24 17:08:01 +01:00

README.md

CloudBot

About

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

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. LXML is required while Enchant and PyDNS are needed for several plugins.

These can be installed with pip (The Python package manager):

[sudo] pip install -r requirements.txt

If you use pip, you will also need the following packages on linux or pip will fail to install the requirements. python, python-dev, libenchant-dev, libenchant1c2a, libxslt-dev, libxml2-dev.

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

If you are unable to use pip, there are Windows installers for LXML available for 64 bit and 32 bit versions of Python.

Run

Before you run the bot, rename config.default to config and edit it with your preferred settings.

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:

python bot.py

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

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.

(some of the information on the wiki is outdated and needs to be rewritten)

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 currently developed on Windows 8 with Python 2.7.5.

It requires the Python module lXML. The module Enchant is needed for the spellcheck plugin. The module PyDNS is needed for SRV record lookup in the mcping plugin.

Windows users: Windows compatibility some plugins is broken (such as ping), but we do intend to add it. Eventually.

Example CloudBots

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

License

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

CloudBot

Copyright © 2011-2013 Luke Rogers

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