archangelic
/
pinhook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix formatting

pull/5/head
M. Hancock 2017-10-31 10:32:11 -07:00 committed by GitHub
parent a3784102e5
commit 1181c84cfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.rst
View File

@ -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' This will start a basic bot and look for plugins in the 'plugins'
directory to add functionality. directory to add functionality.
Optional arguments are: \* ``port``: choose a custom port to connect to Optional arguments are:
the server (default: 6667) \* ``ops``: list of operators who can do
things like make the bot join other channels or quit (default: empty - ``port``: choose a custom port to connect to the server (default:
list) \* ``plugin_dir``: directory where the bot should look for plugins 6667)
(default: "plugins") - ``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 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 The function will need to accept a single argument in order to accept a
``Message`` object from the bot. ``Message`` object from the bot.
The ``Message`` object has the following attributes: \* ``cmd``: the The ``Message`` object has the following attributes:
command that triggered the function \* ``nick``: the user who triggered
the command \* ``arg``: all the trailing text after the command. This is - ``cmd``: the command that triggered the function
what you will use to get optional information for the command \* - ``nick``: the user who triggered the command
``channel``: the channel where the command was initiated \* ``ops``: the - ``arg``: all the trailing text after the command. This is what you
list of bot operators \* ``botnick``: the nickname of the bot 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 The plugin function **must** return one of the following in order to
give a response to the command: \* ``pinhook.plugin.message``: basic give a response to the command:
message in channel where command was triggered \*
``pinhook.plugin.action``: CTCP action in the channel where command was - ``pinhook.plugin.message``: basic message in channel where command
triggered (basically like using ``/me does a thing``) was triggered
- ``pinhook.plugin.action``: CTCP action in the channel where command
was triggered (basically like using ``/me does a thing``)
Examples 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 <https://github.com/archangelic/pinhook-tilde>`__.