From 1181c84cfb0b37b8aa181bc2b7d902806fa69ddb Mon Sep 17 00:00:00 2001 From: "M. Hancock" Date: Tue, 31 Oct 2017 10:32:11 -0700 Subject: [PATCH] fix formatting --- README.rst | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/README.rst b/README.rst index 77f1b71..f973f3c 100644 --- a/README.rst +++ b/README.rst @@ -32,11 +32,14 @@ To create the bot, just create a python file with the following: This will start a basic bot and look for plugins in the 'plugins' directory to add functionality. -Optional arguments are: \* ``port``: choose a custom port to connect to -the server (default: 6667) \* ``ops``: list of operators who can do -things like make the bot join other channels or quit (default: empty -list) \* ``plugin_dir``: directory where the bot should look for plugins -(default: "plugins") +Optional arguments are: + +- ``port``: choose a custom port to connect to the server (default: + 6667) +- ``ops``: list of operators who can do things like make the bot join + other channels or quit (default: empty list) +- ``plugin_dir``: directory where the bot should look for plugins + (default: "plugins") Creating plugins ~~~~~~~~~~~~~~~~ @@ -59,24 +62,23 @@ The function will need to be structured as such: The function will need to accept a single argument in order to accept a ``Message`` object from the bot. -The ``Message`` object has the following attributes: \* ``cmd``: the -command that triggered the function \* ``nick``: the user who triggered -the command \* ``arg``: all the trailing text after the command. This is -what you will use to get optional information for the command \* -``channel``: the channel where the command was initiated \* ``ops``: the -list of bot operators \* ``botnick``: the nickname of the bot +The ``Message`` object has the following attributes: + +- ``cmd``: the command that triggered the function +- ``nick``: the user who triggered the command +- ``arg``: all the trailing text after the command. This is what you + will use to get optional information for the command +- ``channel``: the channel where the command was initiated +- ``ops``: the list of bot operators +- ``botnick``: the nickname of the bot The plugin function **must** return one of the following in order to -give a response to the command: \* ``pinhook.plugin.message``: basic -message in channel where command was triggered \* -``pinhook.plugin.action``: CTCP action in the channel where command was -triggered (basically like using ``/me does a thing``) +give a response to the command: + +- ``pinhook.plugin.message``: basic message in channel where command + was triggered +- ``pinhook.plugin.action``: CTCP action in the channel where command + was triggered (basically like using ``/me does a thing``) Examples -------- - -There are some basic examples in the ``examples`` directory in this -repository. - -For a live and maintained bot running the current version of pinhook see -`pinhook-tilde `__.