164 lines
7.4 KiB
HTML
164 lines
7.4 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset='utf-8'>
|
|
<meta http-equiv="X-UA-Compatible" content="chrome=1">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
|
<link href='https://fonts.googleapis.com/css?family=Architects+Daughter' rel='stylesheet' type='text/css'>
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/stylesheet.css" media="screen" />
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/pygment_trac.css" media="screen" />
|
|
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
|
|
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
|
|
<title>CloudBot by ClouDev</title>
|
|
</head>
|
|
|
|
<body>
|
|
<header>
|
|
<div class="inner">
|
|
<h1>CloudBot</h1>
|
|
<h2>The easy to use, open source Python IRC Bot!</h2>
|
|
<a href="https://github.com/ClouDev/CloudBot" class="button"><small>View project on</small>GitHub</a>
|
|
</div>
|
|
</header>
|
|
|
|
<div id="content-wrapper">
|
|
<div class="inner clearfix">
|
|
<section id="main-content">
|
|
<h1>
|
|
<a name="cloudbot" class="anchor" href="#cloudbot"><span class="octicon octicon-link"></span></a>CloudBot</h1>
|
|
|
|
<h2>
|
|
<a name="about" class="anchor" href="#about"><span class="octicon octicon-link"></span></a>About</h2>
|
|
|
|
<p>CloudBot is a Python IRC bot based on <a href="http://git.io/skybot">Skybot</a> by <a href="http://git.io/rmmh">rmmh</a>.</p>
|
|
|
|
<h2>
|
|
<a name="getting-and-using-cloudbot" class="anchor" href="#getting-and-using-cloudbot"><span class="octicon octicon-link"></span></a>Getting and using CloudBot</h2>
|
|
|
|
<h3>
|
|
<a name="download" class="anchor" href="#download"><span class="octicon octicon-link"></span></a>Download</h3>
|
|
|
|
<p>Get CloudBot at <a href="https://github.com/ClouDev/CloudBot/zipball/develop" title="Get CloudBot from Github!">https://github.com/ClouDev/CloudBot/zipball/develop</a>.</p>
|
|
|
|
<p>Unzip the resulting file, and continue to read this document.</p>
|
|
|
|
<h3>
|
|
<a name="install" class="anchor" href="#install"><span class="octicon octicon-link"></span></a>Install</h3>
|
|
|
|
<p>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.</p>
|
|
|
|
<p>These can be installed with <code>pip</code> (The Python package manager):</p>
|
|
|
|
<pre><code>[sudo] pip install -r requirements.txt
|
|
</code></pre>
|
|
|
|
<p>If you use <code>pip</code>, you will also need the following packages on linux or <code>pip</code> will fail to install the requirements.
|
|
<code>python, python-dev, libenchant-dev, libenchant1c2a, libxslt-dev, libxml2-dev.</code></p>
|
|
|
|
<h4>
|
|
<a name="how-to-install-pip" class="anchor" href="#how-to-install-pip"><span class="octicon octicon-link"></span></a>How to install <code>pip</code>
|
|
</h4>
|
|
|
|
<pre><code>curl -O http://python-distribute.org/distribute_setup.py # or download with your browser on windows
|
|
python distribute_setup.py
|
|
easy_install pip
|
|
</code></pre>
|
|
|
|
<p>If you are unable to use pip, there are Windows installers for LXML available for <a href="https://pypi.python.org/packages/2.7/l/lxml/lxml-2.3.win-amd64-py2.7.exe">64 bit</a> and <a href="https://pypi.python.org/packages/2.7/l/lxml/lxml-2.3.win32-py2.7.exe">32 bit</a> versions of Python.</p>
|
|
|
|
<h3>
|
|
<a name="run" class="anchor" href="#run"><span class="octicon octicon-link"></span></a>Run</h3>
|
|
|
|
<p>Before you run the bot, rename <code>config.default</code> to <code>config</code> and edit it with your preferred settings.</p>
|
|
|
|
<p>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:</p>
|
|
|
|
<p><code>python bot.py</code></p>
|
|
|
|
<p>On Windows you can usually just double-click <code>bot.py</code> to start the bot, as long as you have Python installed correctly.</p>
|
|
|
|
<h2>
|
|
<a name="getting-help-with-cloudbot" class="anchor" href="#getting-help-with-cloudbot"><span class="octicon octicon-link"></span></a>Getting help with CloudBot</h2>
|
|
|
|
<h3>
|
|
<a name="documentation" class="anchor" href="#documentation"><span class="octicon octicon-link"></span></a>Documentation</h3>
|
|
|
|
<p>To configure your CloudBot, visit the <a href="http://git.io/cloudbotircconfig">Config Wiki Page</a>.</p>
|
|
|
|
<p>To write your own plugins, visit the <a href="http://git.io/cloudbotircplugins">Plugin Wiki Page</a>.</p>
|
|
|
|
<p>More at the <a href="http://git.io/cloudbotircwiki">Wiki Main Page</a>.</p>
|
|
|
|
<p>(some of the information on the wiki is outdated and needs to be rewritten)</p>
|
|
|
|
<h3>
|
|
<a name="support" class="anchor" href="#support"><span class="octicon octicon-link"></span></a>Support</h3>
|
|
|
|
<p>The developers reside in <a>#CloudBot</a> on <a href="http://esper.net">EsperNet</a> and would be glad to help you.</p>
|
|
|
|
<p>If you think you have found a bug/have a idea/suggestion, please <strong>open a issue</strong> here on Github.</p>
|
|
|
|
<h3>
|
|
<a name="requirements" class="anchor" href="#requirements"><span class="octicon octicon-link"></span></a>Requirements</h3>
|
|
|
|
<p>CloudBot runs on <strong>Python</strong> <em>2.7.x</em>. It is currently developed on <strong>Windows</strong> <em>8</em> with <strong>Python</strong> <em>2.7.5</em>.</p>
|
|
|
|
<p>It <strong>requires the Python module</strong> lXML.
|
|
The module <code>Enchant</code> is needed for the spellcheck plugin.
|
|
The module <code>PyDNS</code> is needed for SRV record lookup in the mcping plugin.</p>
|
|
|
|
<p><strong>Windows</strong> users: Windows compatibility some plugins is <strong>broken</strong> (such as ping), but we do intend to add it. Eventually.</p>
|
|
|
|
<h2>
|
|
<a name="example-cloudbots" class="anchor" href="#example-cloudbots"><span class="octicon octicon-link"></span></a>Example CloudBots</h2>
|
|
|
|
<p>You can find a number of example bots in <a title="Connect via IRC to #CloudBot on irc.esper.net">#CloudBot</a>.</p>
|
|
|
|
<h2>
|
|
<a name="license" class="anchor" href="#license"><span class="octicon octicon-link"></span></a>License</h2>
|
|
|
|
<p>CloudBot is <strong>licensed</strong> under the <strong>GPL v3</strong> license. The terms are as follows.</p>
|
|
|
|
<pre><code>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/>.
|
|
</code></pre>
|
|
</section>
|
|
|
|
<aside id="sidebar">
|
|
<a href="https://github.com/ClouDev/CloudBot/zipball/master" class="button">
|
|
<small>Download</small>
|
|
.zip file
|
|
</a>
|
|
<a href="https://github.com/ClouDev/CloudBot/tarball/master" class="button">
|
|
<small>Download</small>
|
|
.tar.gz file
|
|
</a>
|
|
|
|
<p class="repo-owner"><a href="https://github.com/ClouDev/CloudBot"></a> is maintained by <a href="https://github.com/ClouDev">ClouDev</a>.</p>
|
|
|
|
<p>This page was generated by <a href="https://pages.github.com">GitHub Pages</a> using the Architect theme by <a href="https://twitter.com/jasonlong">Jason Long</a>.</p>
|
|
</aside>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</body>
|
|
</html> |