2012-02-29 03:03:13 +01:00
# CloudBot/DEV
2011-11-21 00:24:54 +01:00
2012-02-29 03:00:12 +01:00
## About
2012-02-29 03:14:30 +01:00
`CloudBot` is very heavily based on [`Skybot` ](http://git.io/skybot ) by [rmmh ](http://git.io/rmmh ).
2012-02-28 10:03:52 +01:00
2012-02-29 03:14:30 +01:00
### Goals
* Easily extendable
* Though documentation
* Cross-platform
* Muti-threaded, efficient
* Intuitive configuration
* Fully controlled from in IRC
2011-11-21 00:24:54 +01:00
2012-02-29 03:00:12 +01:00
## Download
Get `CloudBot` at [git.io/getcloudbot ](http://git.io/getcloudbot "CloudBot" ).
2012-02-28 09:48:46 +01:00
Unzip, and follow the install directions.
2012-02-29 03:00:12 +01:00
## Install
Before you can run the bot, you need to install a few `Python` modules. These are `lXML` , `BeautifulSoup` , `MyGengo` , and `HTTPlib2` . These can be installed with PIP (The `Python` packager):
2012-02-28 09:48:46 +01:00
2012-02-28 19:33:35 +01:00
`sudo pip install lxml`
2012-02-28 09:48:46 +01:00
2012-02-28 19:33:35 +01:00
`sudo pip install beautifulsoup`
2012-02-28 21:35:00 +01:00
`sudo pip install mygengo`
2011-11-21 00:24:54 +01:00
2012-02-28 21:35:00 +01:00
`sudo pip install httplib2`
2012-02-28 11:10:17 +01:00
2012-02-29 03:00:12 +01:00
On `Debian` based systems, you can get pip with
2012-02-28 19:33:35 +01:00
`sudo apt-get install pip`
2012-02-29 03:00:12 +01:00
For .spell to work, we also need a library called `Enchant` . On `Debian` based systems, install with
2012-02-28 09:48:46 +01:00
`sudo apt-get install python-enchant`
2011-11-21 00:24:54 +01:00
2012-02-29 03:00:12 +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 19:33:35 +01:00
2012-02-28 09:48:46 +01:00
`sudo apt-get install whois`
2011-11-21 00:32:16 +01:00
2012-02-29 03:00:12 +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.
2012-02-28 09:48:46 +01:00
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-29 03:14:30 +01:00
It will generate a default config for you. Once you have edited 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
2012-02-29 03:00:12 +01:00
## Documentation
2012-02-29 02:54:07 +01:00
2012-02-29 03:14:30 +01:00
To configure your `CloudBot` , visit the [Config Wiki Page ](http://git.io/cloudbotconfig ).
2012-02-29 02:54:07 +01:00
2012-02-29 03:14:30 +01:00
To write your own plugins, visit the [Plugin Wiki Page ](http://git.io/cloudbotplugins ).
2012-02-29 02:54:07 +01:00
More at the [Wiki Home Page ](http://git.io/cloudbotwiki ).
2012-02-29 03:00:12 +01:00
## Example `CloudBot`s
2012-02-28 10:12:46 +01:00
2012-02-29 03:00:12 +01:00
The developers of `CloudBot` run two `CloudBot` s on [Espernet ](http://esper.net ).
2012-02-28 10:03:52 +01:00
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-29 03:14:30 +01:00
**mau5bot** is the stable bot, and runs on the latest release version of `CloudBot` . (mau5bot is running on `Ubuntu Server` Oneric Ocelot/11.10 with `Python` 2.7.2)
2012-02-29 03:00:12 +01:00
2012-02-29 03:14:30 +01:00
**neerbot** is the unstable bot, and runs on the latest development version of `CloudBot` . (neerbot is running on `Debian` Wheezy/Testing with `Python` 2.7.2)
2012-02-29 03:00:12 +01:00
## Requirements
`CloudBot` runs on `Python` 2.7.x. It is developed on `Debian` Wheezy/Testing with `Python` 2.7.2.
2012-02-28 09:57:35 +01:00
2012-02-29 03:14:30 +01:00
`Windows` users: `Windows` compatibility is broken, but we do intend to add it back. (Eventually)
2011-11-21 11:51:21 +01:00
2012-02-29 03:00:12 +01:00
## License
2012-02-29 03:14:30 +01:00
`CloudBot` is licensed under the GPL v3 license. The terms are as follows.
2012-02-28 10:15:13 +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
2012-02-29 02:54:07 +01:00
along with CloudBot. If not, see < http: / / www . gnu . org / licenses / > .