Go to file
Valentin Lorentz c51a22de39 Remove instructions for installing from Git from the README.
Install from Git is only supposed to be used by people who want
to contribute, anyway.
2017-07-29 18:05:35 +02:00
debian debian/compat is required, v9 or above 2016-08-06 16:35:10 -04:00
locales Squashed commit of the following: 2014-12-20 14:37:27 +01:00
man remove docs/ && move manpages to man/ 2014-12-08 09:52:42 +02:00
plugins MessageParser: Prevent empty matches from leaving unreplaced. 2017-07-21 20:05:18 +02:00
sandbox Remove fix_basestring. 2015-08-10 20:24:11 +02:00
scripts supybot-wizard: do not pollute the CWD before paths to directories are known. 2017-06-04 15:59:06 +02:00
src supybot-wizard: do not pollute the CWD before paths to directories are known. 2017-06-04 15:59:06 +02:00
test Fix tests from last commit 2016-03-15 08:35:46 -07:00
.gitattributes Remove test from .gitattributes 2015-03-04 00:32:40 -05:00
.gitignore Update .gitignore to include default wizard directories & confs [ci skip] 2014-11-20 17:43:57 -08:00
.mailmap mailmap: update my emails [skip ci] 2016-08-05 10:49:58 -07:00
.travis.yml travis: update Python versions. 2017-02-25 13:32:22 +01:00
CONTRIBUTING.md CONTRIBUTING.md: Fix grammar 2015-05-24 23:29:26 +02:00
ChangeLog Use gender-neutral pronouns everywhere 2014-07-13 17:23:11 +02:00
LICENSE.md License: Fix formatting again. (GH-862) 2014-09-22 05:27:09 +00:00
Makefile Fix typo. 2015-05-23 11:36:40 +02:00
README.md Remove instructions for installing from Git from the README. 2017-07-29 18:05:35 +02:00
RELNOTES supybot-botchk: Directly execute supybot instead of running it in sh 2013-08-23 21:42:01 -04:00
requirements.txt Use PySocks instead of SocksiPy-branch. Closes GH-1246. 2017-07-17 19:07:43 +02:00
setup.py setup.py: Fix download url. 2017-02-24 20:36:09 +01:00

README.md

Supybot is a robust (it doesnt crash), user friendly (its easy to configure) and programmer friendly (plugins are extremely easy to write) Python IRC bot. It aims to be an adequate replacement for most existing IRC bots. It includes a very flexible and powerful ACL system for controlling access to commands, as well as more than 50 builtin plugins providing around 400 actual commands.

Limnoria is a project which continues development of Supybot (you can call it a fork) by fixing bugs and adding features.

Build status

Master branch: Build Status (master branch)

Testing branch: Build Status (testing branch)

Limnoria supports CPython 2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6, nightly; and Pypy 2 and 3. It works best with CPython 3.4 and higher. Python 2.5 and older versions are not supported.

Support

Documentation

If this is your first install, there is an install guide. You will probably be pointed to it if you ask on IRC how to install Limnoria. TL;DR version:

sudo apt-get install python3 python3-pip
pip3 install --user limnoria
supybot-wizard

There is extensive documentation at doc.supybot.aperio.fr and at Gribble wiki. We took the time to write it; you should take the time to read it.

IRC channels

In English

If you have any trouble, feel free to swing by #supybot and #limnoria on freenode or #supybot at OFTC (we have a Limnoria there relaying, so either network works) and ask questions. Well be happy to help wherever we can. And by all means, if you find anything hard to understand or think you know of a better way to do something, please post it on the issue tracker so we can improve the bot!

In Other languages

Only in French at the moment, located at #supybot-fr on freenode.