https://github.com/thor77/thor2

My IRC-Bot named Thor2
https://github.com/thor77/thor2

Last synced: about 8 hours ago
JSON representation

My IRC-Bot named Thor2

• Host: GitHub
• URL: https://github.com/thor77/thor2
• Owner: Thor77
• Created: 2014-05-04T17:22:31.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-18T10:57:49.000Z (over 10 years ago)
• Last Synced: 2024-09-11T01:56:02.885Z (about 2 months ago)
• Language: Python
• Size: 1.01 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Thor2

=====

My IRC-Bot named Thor2

START HERE

==========

## The bot.cfg-File

#### Server-Section

    

| Key  |       Description      |    Type |

|------|:----------------------:|--------:|

|  ip  |  ip of the IRC-server  | string  |

| port | port of the IRC-server | integer |

#### IRC-Section

| Key      |     Description     |   Type |

|----------|:-------------------:|-------:|

| realname | realname of the bot | string |

|   nick   |   nick of the bot   | string |

#### Bot-Section

| Key        |                      Description                      |    Type |

|------------|:-----------------------------------------------------:|--------:|

|    call    |                  char before commands                 |  string |

|   channel  |                    channel to join                    |  string |

| debuglevel |  0 => nothing 1 => important messages 2 => everything | integer |

### Set Auth-Password

Append this line to the \_\_init\_\_.py:  

    bot.setAuthPassword('pw') # set the auth password to 'pw'

    

## Sample Plugin

Place your plugin in the plugins-folder, it will be load automatically at startup.

You can reload plugins using the reload-command!  

    from plugin import Plugin

    class MyPlugin(Plugin):

        def onLoad(self):

            # called on load

            # register events and add commands here

            self.addCommand('mytestcommand', self.mytestcommand_func, 'a simple test command', 0)

            # cmd, function, helpstring, needed level

            

            # for a eventlist look down here

            self.registerEvent('onUserMessage', self.onMessage)

            

        def onMessage(self, eventobj):

            msg = eventobj.getMessage()

            sender = eventobj.getSender()

            

        def mytestcommand_func(self, sender, args):

            # sender: sender of the message

            # dict with args (everything after the command)

            # mytestcommand thor77

            nick = args[0] # thor77

            self.sendMessage('Hi %s!' % nick) # Hi thor77!

Events

======

## onUserMessage

### Methods

    getMessage  

    getSender

## onSelfJoin

### Methods

    getChannel

## onUserJoin

### Methods

    getUser

## onUserQuit

### Methods

    getUser

## onUserNickChange

### Methods

    getOldNick

    getNewNick

TODO

====

- unload Plugins through a command

- load Plugins through a command

- Permission System | DONE