README
¶
Yatzie - A telegram bot written in Golang
A customizable, pluggable Bot for telegram. Work in progress.
Demo bot: @yatzie_bot
Bot Commands
| Name | Description | Usage |
| 9gag | 9GAG for telegram | /gag: Send random image from 9gag |
| admin | Administration plugin, enable, disable and list active plugins | /load [plugin] - Load the specified plugin /unload [plugin] - Unloads the specified plugin /listplugins - List all plugins enabled/disabled |
| dogr | Create a doge image with words. | /doge BLA BLA BLA - Create a doge image with the words. |
| Searches Google and send results | /search [terms]: Searches Google and send results /imgsearch [terms]: Searches Google Images and send results |
|
| hal | Let the bot listen and learn | say something to him or mention him (@bot) |
| hello | Let the bot says hello | /hi to say hello |
| help | Help plugin. Get info from other plugins. | /help: Show list of plugins |
| imdb | IMDB plugin for Telegram | /imdb [movie] |
| 8ball | Magic 8Ball | /8ball [question] |
| norris | Send a random Chuck norris quote | /norris |
| nsfw | Gets a random boobs or butts pic | /boobs: Get a boobs NSFW image. :underage: /butts: Get a butts NSFW image. :underage: |
| xkcd | Send comic images from xkcd | /xkcd (id): Send an xkcd image and title. If not id, send the latest one |
Installation
go build github.com/go-telegram-bot/yatzie
Configuration
The bot reads a json file for configuration:
{
"Token" : "XXXXXXX",
"CommandPrefix" : "/",
"BrainFile" : "Brain",
"Administrators" : {
"telegramusername" : true,
"telegramusername2" : true
}
}
- Token: required - Telegram's Botfather will give you one
- CommandPrefix - optional, you can change /help in !help for example
- BrainFile - it's the base name for the brain database
Run
$ yatzie -c yatzie.conf -l yatzie.log
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
plugins
|
|
|
hal
The hal plugin uses microhal to give the bot a little bit of soul If mentioned or talked directly, this plugin make your bot answer
|
The hal plugin uses microhal to give the bot a little bit of soul If mentioned or talked directly, this plugin make your bot answer |
|
shared
|
|
|
registry
Plugin register themselves here, the registry keep tracks of plugins to redirect the messages
|
Plugin register themselves here, the registry keep tracks of plugins to redirect the messages |
Click to show internal directories.
Click to hide internal directories.