https://github.com/moutix/taemin

A beautiful IRC bot
https://github.com/moutix/taemin

bot irc python

Last synced: about 1 year ago
JSON representation

A beautiful IRC bot

• Host: GitHub
• URL: https://github.com/moutix/taemin
• Owner: Moutix
• License: mit
• Created: 2016-01-20T17:31:33.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2022-03-18T14:25:56.000Z (over 4 years ago)
• Last Synced: 2024-11-16T11:05:58.452Z (over 1 year ago)
• Topics: bot, irc, python
• Language: Python
• Homepage:
• Size: 1.1 MB
• Stars: 4
• Watchers: 5
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# Taemin

A beautiful IRC bot

[![Build Status](https://travis-ci.org/ningirsu/taemin.svg?branch=master)](https://travis-ci.org/ningirsu/taemin)

## Setup

The usual way:

    cd taemin

    python setup.py install

 

Now just run the bot with

    /usr/local/bin/taemin

Or if /usr/local/bin is in your path:

    taemin

 

## Run taemin as a service

If you're running on debian, just copy the file located in the inid.d folder in /etc/init.d/taemin

Then run:

    service taemin start

    

## Configuration

To adjust the configuration of taemin, just edit the configuration file:

    vim /etc/taemin/taemin.yml

## Contribute

To add a plugin, just copy the example folder:

    cp -r taemin/plugins/example taemin/plugins/yourplugin

Change the class TaeminExample to YourPluginClass in the file:

    taemin/plugins/yourplugin/plugin.py

You can now add the functions of your choice in the different handlers (on_pubmsg, on_join, on_privmsg, on_quit, on_part)

To enable your plugin just add in the plugins section on your configuration file:

    plugins.yourplugin.plugin: "YourPluginClass"