mirror of
https://github.com/jlu5/PyLink.git
synced 2024-11-01 09:19:23 +01:00
70 lines
3.0 KiB
Python
70 lines
3.0 KiB
Python
# example.py: An example PyLink plugin.
|
|
from pylinkirc import utils
|
|
from pylinkirc.log import log
|
|
|
|
import random
|
|
|
|
# Example PRIVMSG hook that returns "hi there!" when PyLink's nick is mentioned
|
|
# in a channel.
|
|
|
|
# irc: The IRC object where the hook was called.
|
|
# source: The UID/numeric of the sender.
|
|
# command: The true command name where the hook originates. This may or may not be
|
|
# the same as the name of the hook, depending on context.
|
|
# args: The hook data (a dict) associated with the command. The available data
|
|
# keys differ by hook name (see the hooks reference for a list of which can
|
|
# be used).
|
|
def hook_privmsg(irc, source, command, args):
|
|
channel = args['target']
|
|
text = args['text']
|
|
|
|
# irc.pseudoclient stores the User object of the main PyLink client.
|
|
# (i.e. the user defined in the bot: section of the config)
|
|
if utils.isChannel(channel) and irc.pseudoclient.nick in text:
|
|
irc.msg(channel, 'hi there!')
|
|
# log.debug, log.info, log.warning, log.error, log.exception (within except: clauses)
|
|
# and log.critical are supported here.
|
|
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
|
|
# irc: The IRC object where the command was called.
|
|
# source: The UID/numeric of the calling user.
|
|
# args: A list of command args (excluding the command name) that the command was called with.
|
|
def randint(irc, source, args):
|
|
# The 'help' command uses command functions' docstrings as help text, and formats them
|
|
# in the following manner:
|
|
# - Any newlines immediately adjacent to text on both sides are replaced with a space. This
|
|
# means that the first descriptive paragraph ("Returns a random...given.") shows up as one
|
|
# line, even though it is physically written on two.
|
|
# - Double line breaks are treated as breaks between two paragraphs, and will be shown
|
|
# as distinct lines in IRC.
|
|
|
|
# Note: you shouldn't make any one paragraph too long, since they may get cut off. Automatic
|
|
# word-wrap may be added in the future; see https://github.com/GLolol/PyLink/issues/153
|
|
"""[<min> <max>]
|
|
|
|
Returns a random number between <min> and <max>. <min> and <max> default to 1 and 10
|
|
respectively, if both aren't given.
|
|
|
|
Example second paragraph here."""
|
|
try:
|
|
rmin = args[0]
|
|
rmax = args[1]
|
|
except IndexError:
|
|
rmin, rmax = 1, 10
|
|
n = random.randint(rmin, rmax)
|
|
|
|
# irc.reply() is intelligent and will automatically reply to the caller in
|
|
# right context. If fantasy is loaded and you call the command via it,
|
|
# it will send replies into the channel instead of in your PM.
|
|
irc.reply(str(n))
|
|
|
|
# You can also bind a command function multiple times, and/or to different command names via a
|
|
# second argument.
|
|
utils.add_cmd(randint, "random")
|