mirror of
https://github.com/jlu5/PyLink.git
synced 2024-12-24 19:52:53 +01:00
Replace plugins/hooks.py with an example plugin in docs/
This commit is contained in:
parent
67d8bc8e1f
commit
7b69ff4733
42
docs/technical/plugin_example.py
Normal file
42
docs/technical/plugin_example.py
Normal file
@ -0,0 +1,42 @@
|
||||
# plugin_example.py: An example PyLink plugin.
|
||||
# You can add copyright notices and license information here.
|
||||
|
||||
# These two lines add PyLink's root directory to the PATH, so that importing things like
|
||||
# 'utils' and 'log' work.
|
||||
import sys, os
|
||||
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
||||
|
||||
import utils
|
||||
from log import log
|
||||
|
||||
import random
|
||||
|
||||
# Example PRIVMSG hook that returns "hi there!" when PyLink's nick is mentioned
|
||||
# in a channel.
|
||||
def hook_privmsg(irc, source, command, args):
|
||||
channel = args['target']
|
||||
text = args['text']
|
||||
if utils.isChannel(channel) and irc.pseudoclient.nick in text:
|
||||
utils.msg(irc, channel, 'hi there!')
|
||||
log.info('%s said my name on channel %s (PRIVMSG hook caught)' % (source, channel))
|
||||
utils.add_hook(hook_privmsg, 'PRIVMSG')
|
||||
|
||||
# Example command function. @utils.add_cmd binds it to an IRC command of the same name,
|
||||
# but you can also use a different name by specifying a second 'name' argument (see below).
|
||||
@utils.add_cmd
|
||||
def randint(irc, source, args):
|
||||
"""[<min>] [<max>]
|
||||
Returns a random number between <min> and <max>. <min> and <max> default
|
||||
to 1 and 10 respectively, if both aren't given."""
|
||||
try:
|
||||
rmin = args[0]
|
||||
rmax = args[1]
|
||||
except IndexError:
|
||||
rmin, rmax = 1, 10
|
||||
n = random.randint(rmin, rmax)
|
||||
utils.msg(irc, source, str(n))
|
||||
# You can also bind a command function multiple times, to different command names via a
|
||||
# second argument. Note that no checking is done at the moment to prevent multiple
|
||||
# plugins from binding to the same command names (the older command just gets replaced
|
||||
# by the new one!)
|
||||
utils.add_cmd(randint, "random")
|
@ -1,19 +0,0 @@
|
||||
# hooks.py: test of PyLink hooks
|
||||
import sys, os
|
||||
sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
||||
import utils
|
||||
from log import log
|
||||
|
||||
def hook_join(irc, source, command, args):
|
||||
channel = args['channel']
|
||||
users = args['users']
|
||||
log.info('%s joined channel %s (JOIN hook caught)' % (users, channel))
|
||||
utils.add_hook(hook_join, 'JOIN')
|
||||
|
||||
def hook_privmsg(irc, source, command, args):
|
||||
channel = args['target']
|
||||
text = args['text']
|
||||
if utils.isChannel(channel) and irc.pseudoclient.nick in text:
|
||||
utils.msg(irc, channel, 'hi there!')
|
||||
log.info('%s said my name on channel %s (PRIVMSG hook caught)' % (source, channel))
|
||||
utils.add_hook(hook_privmsg, 'PRIVMSG')
|
Loading…
Reference in New Issue
Block a user