pinhook/README.md

64 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2017-09-27 19:03:20 +00:00
# pinhook
a pluggable irc bot framework in python
2017-09-28 13:34:07 +00:00
2017-10-02 17:28:39 +00:00
## Tutorial
### Installation
```
2017-10-31 17:27:33 +00:00
$ pip install pinhook
2017-10-02 17:28:39 +00:00
```
### Creating the Bot
To create the bot, just create a python file with the following:
```python
import pinhook.bot
2017-10-02 17:48:46 +00:00
bot = pinhook.bot.Bot(
channels=['#foo', '#bar'],
nickname='ph-bot',
server='irc.freenode.net'
)
2017-10-02 17:28:39 +00:00
bot.start()
```
This will start a basic bot and look for plugins in the 'plugins' directory to add functionality.
2017-10-02 17:48:46 +00:00
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")
2018-01-10 22:42:55 +00:00
* `log_level`: string indicating logging level. Logging can be disabled by setting this to "off". (default: "info")
2017-10-02 17:48:46 +00:00
### 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.
The function will need to be structured as such:
```python
import pinhook.plugin
@pinhook.plugin.register('!test')
2017-10-10 15:56:41 +00:00
def test_plugin(msg):
message = '{}: this is a test!'.format(msg.nick)
2017-10-02 17:48:46 +00:00
return pinhook.plugin.message(message)
```
2017-10-10 15:56:41 +00:00
The function will need to accept a single argument in order to accept a `Message` object from the bot.
2017-10-02 17:48:46 +00:00
2017-10-10 15:56:41 +00:00
The `Message` object has the following attributes:
2017-10-02 17:48:46 +00:00
* `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
2017-10-10 15:56:41 +00:00
* `channel`: the channel where the command was initiated
* `ops`: the list of bot operators
* `botnick`: the nickname of the bot
2018-01-10 22:42:55 +00:00
* `logger`: instance of `Bot`'s logger
2017-10-02 17:48:46 +00:00
2017-10-02 18:30:14 +00:00
The plugin function **must** return one of the following in order to give a response to the command:
2017-10-02 18:25:59 +00:00
* `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`)
2017-10-02 18:19:54 +00:00
## 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).