Skip to content

SilverRainZ/labots

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LABots
======

v1.3

Flexible IRC bot framework.

Features
--------

* Run multiple bots with single IRC instance
* Bots do not affect each other
* Useful and flexible IRC bot interface
* Dynamic {load,unload} bots when they are modified
* Asynchronous socket


Requires
--------

* python 3
* python-pyinotify >= 0.9.4
* python-tornado >= 3.2.2
* python-yaml


Usage
-----

Install LABots (optional): `python setup.py install`

Run LABots: Create file `config.yaml` as follow, and run `labots -c config.yaml`
in the same directory (If you don't want to install LABots in your system,
just run `./labots.py -c config.yaml` in project directory).

    config.yaml
    e.g:
        host: irc.freenode.net  # IRC server
        port: 6666              # Port
        nick: labots            # IRC bot nick name
        path: bots              # Path of bot scripts

    LABots will loads all bot scripts in `bots` directory, when script file
    (*.py) or configure file (*.json) changed, bot script will be reload
    automatically. file which name starts with `_` or `.` will be ignored.

Write a bot: See `bots/example.py` or <https://github.com/SilverRainZ/bots>


Bots
----

See <https://github.com/SilverRainZ/bots>.


References
----------

* https://github.com/lilydjwg/archrepo2
* https://github.com/nod/iobot
* https://github.com/LukeusMaximus/Python-IRC-Bot-Framework
* https://github.com/lilydjwg/winterpy


License
-------

GPL3