2012-02-28 08:38:58 +01:00
##CloudBot/DEV
2011-11-21 00:24:54 +01:00
2011-11-21 00:32:16 +01:00
### About
2012-02-28 10:03:52 +01:00
CloudBot is very heavily based on [Skybot ](https://github.com/rmmh/skybot ) by rmmh.
CloudBot is meant to be a simple, extendable python IRC bot, with minimal magic. To write your own plugins, vist the [Plugin Wiki Page ](http://git.io/cloudbotplugins ).
More at the [wiki ](http://git.io/cloudbotwiki ).
2011-11-21 00:24:54 +01:00
2012-02-28 09:48:46 +01:00
### Download
Get Cloudbot at [git.io/getcloudbot ](http://git.io/getcloudbot "CloudBot" ).
Unzip, and follow the install directions.
2011-11-21 00:32:16 +01:00
### Install
2012-02-28 09:48:46 +01:00
Before you can run the bot, you need to install a few Python modules. These are `lXML` , `BeautifulSoup` , and `Enchant` . On Debian based systems, these can be installed using the following commands:
`sudo apt-get install python-lxml`
`sudo apt-get install python-beautifulsoup`
`sudo apt-get install python-enchant`
2011-11-21 00:24:54 +01:00
2012-02-28 09:51:13 +01:00
In addition, for .whois to work optimally, you must have `whois` installed. Again, on Debian based systems, install it with
2012-02-28 09:48:46 +01:00
`sudo apt-get install whois`
2011-11-21 00:32:16 +01:00
2012-02-28 09:48:46 +01:00
If you are a user of another Linux disto, use your package manager to install the modules, or use Google to locate source packages you can install.
Once you have installed the required dependencies, run the bot with
2011-11-21 00:24:54 +01:00
2012-02-28 09:48:46 +01:00
`python bot.py`
2012-02-02 17:49:12 +01:00
2012-02-28 09:48:46 +01:00
It will generate a default config for you. Once you have editied the config, run it again with
2012-02-23 03:35:40 +01:00
2012-02-28 09:48:46 +01:00
`python bot.py`
2011-11-21 00:24:54 +01:00
2012-02-28 10:03:52 +01:00
and it will connect to any server(s) you have added to the config. (Config docs at the [wiki ](http://git.io/cloudbotconfig ))
2011-11-21 00:24:54 +01:00
2011-11-21 00:32:16 +01:00
### Requirements
2012-02-28 09:56:16 +01:00
CloudBot runs on Python 2.7.x. It is developed on Debian Wheezy/Testing with Python 2.7.2.
### Example CloudBots
2012-02-28 10:03:52 +01:00
The developers of CloudBot run two Cloudbots on [Espernet ](http://esper.net ).
They can both be found in [#CloudBot ](irc://irc.esper.net/cloudbot "Connect via IRC to #CloudBot on irc.esper.net ).
2012-02-28 09:56:16 +01:00
2012-02-28 09:57:35 +01:00
**mau5bot** is the stable bot, and runs on the lastest release version of CloudBot. (mau5bot is running on Ubuntu Server Oneric Ocelot/11.10 with Python 2.7.2)
**neerbot** is the unstable bot, and runs on the lastest development version of CloudBot. (neerbot is running on Debian Wheezy/Testing with Python 2.7.2)
2011-11-21 11:51:21 +01:00
### License
CloudBot is licenced under the GPL v3 license. The terms are as follows.
2012-02-28 10:05:17 +01:00
#### CloudBot/DEV
2011-11-21 11:53:32 +01:00
2012-02-28 09:48:46 +01:00
Copyright © 2011 Luke Rogers < http: / / www . dempltr . com / > - < lukeroge @ gmail . com >
2011-11-21 11:51:21 +01:00
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 / > .
