2012-04-02 19:03:24 +02:00
# CloudBot/DEV
2011-11-21 00:24:54 +01:00
2012-02-29 03:00:12 +01:00
## About
2012-02-29 03:47:11 +01:00
2012-02-29 06:13:46 +01:00
CloudBot is a Python IRC bot 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
2012-02-29 20:45:18 +01:00
* Easy to use wrapper
* Intuitive configuration
* Fully controlled from IRC
* Fully compatable with existing skybot plugins
2012-02-29 03:14:30 +01:00
* Easily extendable
2012-02-29 05:38:44 +01:00
* Thorough documentation
2012-02-29 03:14:30 +01:00
* Cross-platform
* Muti-threaded, efficient
2012-02-29 03:34:36 +01:00
* Automatic reloading
* Little boilerplate
2011-11-21 00:24:54 +01:00
2012-02-29 03:00:12 +01:00
## Download
2012-02-29 03:47:11 +01:00
2012-03-05 04:13:19 +01:00
Get CloudBot at [git.io/getcloudbotirc ](http://git.io/getcloudbotirc "Get CloudBot from Github!" ).
2012-02-29 03:20:15 +01:00
Unzip the resulting file, and continue to read this document.
2012-02-28 09:48:46 +01:00
2012-02-29 03:00:12 +01:00
## Install
2012-02-29 03:47:11 +01:00
2012-04-19 12:52:23 +02:00
Before you can run the bot, you need to install a few Python modules. These are `lXML` and `BeautifulSoup` . These can be installed with PIP (The Python package manager):
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 11:10:17 +01:00
2012-02-29 06:13:46 +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 21:21:24 +01:00
For `.spell` to work, we also need a library called `Enchant` . On Debian based systems, install it 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 21:21:24 +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-03-02 01:16:14 +01:00
For the wrapper to work best, install `screen` , or `daemon` :
`sudo apt-get install screen`
`sudo apt-get install daemon`
2012-02-29 03:20:15 +01:00
If you are a user of another Linux disto, use your package manager to install the dependencies, or, for other operating systems, use **Google** to locate source packages you can install.
2012-02-29 03:00:12 +01:00
2012-03-04 02:32:58 +01:00
Once you have installed the required dependencies, run the bot¹:
2011-11-21 00:24:54 +01:00
2012-03-02 01:16:14 +01:00
`./cloudbot start`
2012-02-02 17:49:12 +01:00
2012-02-29 21:21:24 +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-03-02 01:16:14 +01:00
`./cloudbot start`
2011-11-21 00:24:54 +01:00
2012-03-05 04:13:19 +01:00
and it will connect to any server(s) you have added to the config. (Config docs at the [wiki ](http://git.io/cloudbotircconfig ))
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-03-05 04:13:19 +01:00
To configure your CloudBot, visit the [Config Wiki Page ](http://git.io/cloudbotircconfig ).
2012-02-29 02:54:07 +01:00
2012-03-05 04:13:19 +01:00
To write your own plugins, visit the [Plugin Wiki Page ](http://git.io/cloudbotircplugins ).
2012-02-29 02:54:07 +01:00
2012-03-05 04:13:19 +01:00
More at the [Wiki Main Page ](http://git.io/cloudbotircwiki ).
2012-02-29 02:54:07 +01:00
2012-02-29 03:47:11 +01:00
## Support
2012-04-13 19:33:12 +02:00
The developers reside in [#CloudBot ](irc://irc.esper.net/cloudbot ) on [EsperNet ](http://esper.net ) and would be glad to help you.
2012-02-29 03:47:11 +01:00
2012-02-29 21:26:07 +01:00
If you think you have found a bug/have a idea/suggestion, please **open a issue** here on Github.
2012-02-29 03:47:11 +01:00
2012-02-29 06:13:46 +01:00
## Example CloudBots
2012-02-28 10:12:46 +01:00
2012-02-29 06:13:46 +01:00
The developers of CloudBot run two CloudBots 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 21:23:28 +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-03-04 02:32:58 +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
2012-03-04 02:32:58 +01:00
CloudBot runs on **Python** *2.7.x* . It is developed on **Debian** *Wheezy/Testing* and **Ubuntu** *11.10* with **Python** *2.7.2* .
2012-02-29 03:20:15 +01:00
2012-03-30 18:03:34 +02:00
It **requires Python modules** `lXML` , `BeautifulSoup` , `Enchant` , `psutil` , and `HTTPlib2` .
2012-02-28 09:57:35 +01:00
2012-03-02 01:59:25 +01:00
The programs `screen` or `daemon` are recomended for the wrapper to run optimaly.
2012-03-04 02:32:58 +01:00
**Windows** users: Windows compatibility with the wrapper and some plugins is **broken** (such as the ping), but we do intend to add it.³
2011-11-21 11:51:21 +01:00
2012-02-29 03:00:12 +01:00
## License
2012-02-29 21:26:07 +01:00
CloudBot is **licensed** under the **GPL v3** license. The terms are as follows.
2012-02-28 10:15:13 +01:00
2012-04-02 19:03:24 +02:00
CloudBot/DEV
2011-11-21 11:53:32 +01:00
2012-03-05 04:13:19 +01:00
Copyright © 2011 ClouDev - < [cloudev.github.com](http://cloudev.github.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 / > .
2012-03-02 01:24:13 +01:00
2012-03-04 02:33:38 +01:00
## Notes
2012-03-02 01:27:00 +01:00
2012-03-04 02:32:58 +01:00
¹ if you prefer to run the bot with a custom backend/run it manually, or are on **Windows** , run the bot with `./bot.py`
2012-03-02 01:24:41 +01:00
2012-03-04 02:32:58 +01:00
² or whatever version [neersighted ](http://git.io/neersighted ) is currently hacking on
2012-03-02 01:24:41 +01:00
2012-03-04 02:32:58 +01:00
³ eventually