Botkit is a program, and a framework that helps to create modular Telegram Bots.
plugins {
id 'org.jetbrains.kotlin.jvm' version '1.5.0'
id 'org.jetbrains.kotlin.plugin.serialization' version '1.5.0'
}
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
implementation 'com.github.AgeOfWar:Botkit:2.7'
}Usage: java -jar ${programFile.name} [options]
where options include:
-token=<token> overrides token in bot.json
-? -h -help prints this help message to the output stream
help [command] - Shows list of all available commands
reload [plugin|*] - Reloads enabled plugin
debug - Enables or disables verbose errors
stop - Stops Botkit
enable <plugin|*> - Enables plugin in 'plugins' folder or pass url to enable remote plugin
disable <plugin|*> - Disables enabled plugin
plugins - Shows list of all enabled and available plugins
api <method name> [parameters] - Makes a call to the Telegram Bot API
Plugins can add custom commands
This plugin re-sends messages
package com.example.myplugin
import com.github.ageofwar.botkit.plugin.*
import com.github.ageofwar.ktelegram.*
class MyPlugin : Plugin() {
override suspend fun init() {
registerUpdateHandlers(RepeatCommand(this))
}
}
class RepeatCommand(private val plugin: Plugin) : PluginUpdateHandler {
override suspend fun Plugin.handle(update: Update) = update.handleMessage { message ->
val content = message.toMessageContent()
if (content != null) {
api.sendMessage(message.messageId, content)
}
}
}Remember to add botkit.properties file in your resource source set:
name=MyPlugin
pluginClassName=com.example.myplugin.MyPlugin
apiVersion=2.7| Botkit version | apiVersion | supported apiVersion |
|---|---|---|
| 2.8.4 | 2.9 | 2.3 - 2.9 |
| 2.8 | 2.8 | 2.3 - 2.8 |
| 2.7 | 2.7 | 2.3 - 2.7 |
| 2.6 | 2.6 | 2.3 - 2.6 |
| 2.5 | 2.5 | 2.3 - 2.5 |
| 2.4 | 2.4 | 2.3 - 2.4 |
| 2.3 | 2.3 | 2.3 |
| 2.2 | 2.2 | 2.2 |
| 2.1 | 2.1 | 2.0 - 2.1 |
| 2.0 | 2.0 | 2.0 |
| 1.3 | 1.3 | 1.0 - 1.3 |
| 1.2 | 1.2 | 1.0 - 1.2 |
| 1.1 | 1.0 | 1.0 |
| 1.0 | 1.0 | 1.0 |
| Function | Description |
|---|---|
Plugin.registerUpdateHandler(UpdateHandler) |
registers a handler for Telegram updates |
Plugin.registerConsoleCommand(PluginCommand) |
registers a handler for console commands |
Plugin.registerLogger(PluginLogger) |
registers a botkit logger |
Plugin.dispatchConsoleCommand(String) |
executes a console command |
Plugin.log(String?) / Plugin.warning(String?) / Plugin.error(String?,Throwable?) |
logging methods |
Plugin.withPlugin<reified T : Plugin>(T.() -> R): R |
uses external plugin |
Plugin.readFile(...) / Plugin.readFileOrCopy(...) |
utility method for plugin data reading |
Plugin.writeFile(...) |
utility method for plugin data writing |
Plugin.readJsonFileAs(...) / Plugin.writeFile(...) |
utility methods for json data reading/writing |
String.template(vararg Pair<String, Any?>): String |
formats a string, see Freemarker |
[
{
"scope": {"type": "default"},
"commands": [
{"command": "kick", "description": "Kicks an user"},
{"command": "help", "description": "Shows an help message"},
{"command": "hello", "description": "Says hello"}
]
}
]Adding this file into plugin data folder will update your bot commands when the plugin is enabled.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent