https://github.com/eggpi/ec09bot

A tiny fun IRC bot.
https://github.com/eggpi/ec09bot

Last synced: about 1 year ago
JSON representation

A tiny fun IRC bot.

• Host: GitHub
• URL: https://github.com/eggpi/ec09bot
• Owner: eggpi
• License: mit
• Created: 2011-07-09T19:27:25.000Z (about 15 years ago)
• Default Branch: master
• Last Pushed: 2012-05-22T15:20:30.000Z (about 14 years ago)
• Last Synced: 2025-05-05T23:13:25.698Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 179 KB
• Stars: 6
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE.txt

Awesome Lists containing this project

README

          
A very simple, extensible IRC bot.

Simple usage

------------

- Adding a command

    Write a callable in commands/\.py and add \

to command\_modules in commands/\_\_init\_\_.py. This callable will get called

when a user requests your command.

    The command name, callable and aliases should be declared in a global

variable called *command\_description* in commands/\.py. It

should be an iterable of tuples (*command name*, *callable*, *aliases*), where

*aliases* is an iterable of aliases.

    Thus in the common case in which your file defines a single command,

a declaration like:

    ```python

    command_description = [("foo", foobar, ("bar", "baz"))]

    ```

    suffices to declare a command "foo", with aliases "bar" and "baz". That is,

the callable foobar gets called when a user issues either !foo, !bar or !baz.

    The callable receives as argument the EC09Bot instance. If any other words

were passed in the command invocation, they are passed as additional arguments

to the callable (EC09Bot will handle the exception when a wrong number of

arguments are provided, so only make the callable accept \*args if you really

need that).

    If the callable's return value is not None, it is sent back as a

hightlighted message to the calling user.

    The nick of the user that invoked the command will be available as the

'sendernick' attribute of the EC09Bot instance passed to the command. The raw

message can be accessed in the 'raw\_message' attribute, in the off-chance that

you might need that.

    A special case for this is adding a fortune command (that is, a command

that returns a fortune cookie). These are all defined in commands/fortune.py,

just add your command there and it will show up among the other commands.

- Removing a command

    Simply remove the command module's name from command\_modules in

commands/\_\_init\_\_.py.

    Fortune commands are once again an exception. Remove the command from

commands/fortune.py in order to disable it.