ChCh
/
CloudBot
Archived
10
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
This repository has been archived on 2023-04-13. You can view files and clone it, but cannot push or open issues or pull requests.
1,046 Commits 7 Branches 6 Tags 24 MiB
Python 99.7%
Shell 0.3%
Go to file
Steven Smith 7963e05e93 Create .editorconfig 2013-07-31 22:10:21 +08:00
core Update config.py 2013-07-19 17:22:06 +08:00
disabled_stuff Uploaded the old launcher to the disabled_stuff folder, because some people still want it 2013-07-02 03:52:11 +12:00
lib Added Tweepy contributor and license information 2013-07-15 23:15:23 +12:00
plugins Why the shit is that still there. It does nothing at all 2013-08-01 01:48:50 +12:00
.editorconfig Create .editorconfig 2013-07-31 22:10:21 +08:00
.gitignore Adjusted .gitignore for my new text editor :3 2012-08-10 14:04:25 +12:00
CONTRIBUTING.md Create CONTRIBUTING.md 2013-07-31 22:07:24 +08:00
CONTRIBUTORS :D 2013-07-27 17:56:14 +12:00
LICENSE permission changes 2012-02-27 22:46:47 -08:00
README.md noodle 2013-07-28 23:02:19 +12:00
bot.py Various tweaks 2012-09-05 21:35:44 +12:00
requirements.txt Update requirements.txt 2013-07-20 14:23:49 +08: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

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

Once you have installed the required dependencies, you can run the bot! Make sure you are in the correct folder and run the following command:

python bot.py

The first time you run the bot it will generate the config file. The next time you run it, it will start normally.

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