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

update readmes

pull/20/head
Mallory Hancock 2018-01-10 14:42:55 -08:00
parent e0d3b1b2f5
commit f5ad601a08
2 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -27,6 +27,7 @@ Optional arguments are:
* `port`: choose a custom port to connect to the server (default: 6667) * `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) * `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") * `plugin_dir`: directory where the bot should look for plugins (default: "plugins")
* `log_level`: string indicating logging level. Logging can be disabled by setting this to "off". (default: "info")
### Creating plugins ### Creating plugins
In your chosen plugins directory ("plugins" by default) make a python file with a function. You can use the `@pinhook.plugin.register` decorator to tell the bot the command to activate the function. In your chosen plugins directory ("plugins" by default) make a python file with a function. You can use the `@pinhook.plugin.register` decorator to tell the bot the command to activate the function.
@ -50,6 +51,7 @@ The `Message` object has the following attributes:
* `channel`: the channel where the command was initiated * `channel`: the channel where the command was initiated
* `ops`: the list of bot operators * `ops`: the list of bot operators
* `botnick`: the nickname of the bot * `botnick`: the nickname of the bot
* `logger`: instance of `Bot`'s logger
The plugin function **must** return one of the following in order to give a response to the command: 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.message`: basic message in channel where command was triggered

3
README.rst
View File

@ -40,6 +40,8 @@ Optional arguments are:
other channels or quit (default: empty list) other channels or quit (default: empty list)
- ``plugin_dir``: directory where the bot should look for plugins - ``plugin_dir``: directory where the bot should look for plugins
(default: "plugins") (default: "plugins")
- ``log_level``: string indicating logging level. Logging can be
disabled by setting this to "off". (default: "info")
Creating plugins Creating plugins
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~
@ -71,6 +73,7 @@ The ``Message`` object has the following attributes:
- ``channel``: the channel where the command was initiated - ``channel``: the channel where the command was initiated
- ``ops``: the list of bot operators - ``ops``: the list of bot operators
- ``botnick``: the nickname of the bot - ``botnick``: the nickname of the bot
- ``logger``: instance of ``Bot``'s logger
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: give a response to the command: