Akamaru/Mikubot-2
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Auf Upstream aktualisiert

Browse Source
This commit is contained in:
Andreas Bielawski 2016-06-15 15:42:42 +02:00
commit 4a21409bd6
1 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -13,11 +13,10 @@ otouto is free software; you are free to redistribute it and/or modify it under
| For Users | For Coders | | For Users | For Coders |
|:----------------------------------------------|:------------------------------| |:----------------------------------------------|:------------------------------|
| [Setup](#setup) | [Introduction](#introduction) | | [Setup](#setup) | [Plugins](#plugins) |
| [Control plugins](#control-plugins) | [Plugins](#plugins) | | [Control plugins](#control-plugins) | [Bindings](#bindings) |
| [Group Administration](#group-administration) | [Bindings](#bindings) | | [Group Administration](#group-administration) | [Output style](#output-style) |
| [List of plugins](#list-of-plugins) | [Output style](#output-style) | | [List of plugins](#list-of-plugins) | [Contributors](#contributors) |
| | [Contributors](#contributors) |
## Setup ## Setup
You _must_ have Lua (5.2+), luasocket, luasec, multipart-post, and dkjson installed. You should also have lpeg, though it is not required. It is recommended you install these with LuaRocks. You _must_ have Lua (5.2+), luasocket, luasec, multipart-post, and dkjson installed. You should also have lpeg, though it is not required. It is recommended you install these with LuaRocks.
@ -196,9 +195,6 @@ Additionally, antiflood can be configured to automatically ban a user after he h
* * * * * *
## Introduction
####todo
## Plugins ## Plugins
otouto uses a robust plugin system, similar to yagop's [Telegram-Bot](http://github.com/yagop/telegram-bot). otouto uses a robust plugin system, similar to yagop's [Telegram-Bot](http://github.com/yagop/telegram-bot).
@ -207,13 +203,14 @@ Most plugins are intended for public use, but a few are for other purposes, like
A plugin can have five components, and two of them are required: A plugin can have five components, and two of them are required:
| Component | Description | Required? | | Component | Description | Required? |
|:----------------|:---------------------------------------------|:----------| |:------------------|:---------------------------------------------|:----------|
| plugin:action | Main function. Expects `msg` table as an argument. | Y | | `plugin:action` | Main function. Expects `msg` table as an argument. | Y |
| plugin.triggers | Table of triggers for the plugin. Uses Lua patterns. | Y | | `plugin.triggers` | Table of triggers for the plugin. Uses Lua patterns. | Y |
| plugin:init | Optional function run when the plugin is loaded. | N | | `plugin:init` | Optional function run when the plugin is loaded. | N |
| plugin:cron | Optional function to be called every minute. | N | | `plugin:cron` | Optional function to be called every minute. | N |
| plugin.command | Basic command and syntax. Listed in the help text. | N | | `plugin.command` | Basic command and syntax. Listed in the help text. | N |
| plugin.doc | Usage for the plugin. Returned by "/help $command". | N | | `plugin.doc` | Usage for the plugin. Returned by "/help $command". | N |
| `plugin.error` | Plugin-specific error message; false for no message. | N |
The `bot:on_msg_receive` function adds a few variables to the `msg` table for your convenience. These are self-explanatory: `msg.from.id_str`, `msg.to.id_str`, `msg.chat.id_str`, `msg.text_lower`, `msg.from.name`. The `bot:on_msg_receive` function adds a few variables to the `msg` table for your convenience. These are self-explanatory: `msg.from.id_str`, `msg.to.id_str`, `msg.chat.id_str`, `msg.text_lower`, `msg.from.name`.