Mikubot 2 - Neu & besser
This repository has been archived on 2021-04-24. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
Drew b7aadc5247 Merge pull request #11 from TiagoDanin/patch-2
Organization of command list of plugins
2015-11-15 08:56:25 -05:00
loc added cron jobs for plugins 2015-08-28 23:15:01 -07:00
plugins removed spaghetti code 2015-09-24 19:44:43 -04:00
.gitignore added spotify plugin (thanks to @TiagoDanin) 2015-09-22 22:27:36 -04:00
bindings.lua add hearthstone plugin 2015-09-07 11:19:36 -04:00
bot.lua removed spaghetti code 2015-09-24 19:44:43 -04:00
config.lua.default added youtube (@TiagoDanin) 2015-09-23 14:48:54 -04:00
console.lua added spotify plugin (thanks to @TiagoDanin) 2015-09-22 22:27:36 -04:00
dkjson.lua added cron jobs for plugins 2015-08-28 23:15:01 -07:00
example-plugin.lua added cron jobs for plugins 2015-08-28 23:15:01 -07:00
LICENSE added cron jobs for plugins 2015-08-28 23:15:01 -07:00
README.md Organization of command list of plugins 2015-11-15 11:41:09 -02:00
utilities.lua added cron jobs for plugins 2015-08-28 23:15:01 -07:00

otouto

The plugin-wielding, multi-purpose Telegram bot.

Public bot runs on @mokubot.

To start, send "/start" or say "Hello, otouto."

##Plugins

about.lua /about Information about the bot
admin.lua /admin [command] Support for admin
bandersnatch.lua /bandersnatch Benedict Cumberbatch name generator
bible.lua /bible <verse> King James Version
blacklist.lua /blacklist Blacklist
btc.lua /btc <currency> [amount] Bitcoin prices and conversion
calc.lua /calc <expression> Calculator
cats.lua /calc <expression> Solve math expression and convert units
chatter.lua @[user_name_bot], [message] Chatter Bot
commit.lua /commit http://whatthecommit.com
currency.lua /cash <from> <to> [amount] Convert an amount from one currency to another
dgmp.lua /index and /listgroups Plugin to display the groups, descriptions, etc.
dice.lua /roll [arg] Roll a die. Accepts D&D notation
dogify.lua /dogify <lines/separatedby/slashes> Create a doge image
echo.lua /echo <text> Repeat a string
floodcontrol.lua No command Flood control
fortune.lua /fortune Random fortunes
gImages.lua /images <query> Google Images search
giphy.lua /giphy [query] Giphy search or random
gMaps.lua /loc <location> Google Maps search
gSearch.lua /google <query> Google Search
hackernews.lua /hackernews Top stories from Hackernews
hearthstone.lua /hearthstone <card> Information about a Hearthstone card
help.lua /help [command] List commands
hex.lua /hex <number> Convert to and from hexadecimal
imdb.lua /imdb <movie | TV series> IMDb movie/television info
interactions.lua No command Welcome
kickass.lua /torrent <query> Search Kickass Torrents
lastfm.lua /lastfm [username] Get current- or last-played track
lmgtfy.lua /lmgtfy Open page of lmgtfy
moderation.lua /modhelp Support for moderator or admin
nick.lua /nick <nickname> Set your nickname for the bot
owm.lua /weather <location> Temperature and weather conditions
pokedex.lua /dex <pokemon> Pokedex!
pun.lua /pun Puns
reaction.lua /reactions Get a list emoticons
reddit.lua /reddit [r/subreddit | query] Posts from reddit
remind.lua /remind <delay> <message> Set a reminder for yourself or a group
slap.lua /slap [victim] Slap someone!
spotify.lua /spotify <music> Search Spotify
time.lua /time <location> Get the time for a place
translate.lua /translate [target lang] Message to translate
urbandictionary.lua /ud <term> Urban Dictionary search
weather.lua /weather <location> Get the weather for a place
whoami.lua /who Get user and group IDs
wikipedia.lua /wiki <topic> Search Wikipedia
xkcd.lua /xkcd [search] Xkcd strips and alt text
youtube.lua /youtube <query> Search Youtube
8ball.lua /8ball Magic 8-ball.

##Setup

Requires Lua, lua-socket and lua-sec. dkjson is provided. Written for Lua 5.2 but will probably run on 5.3.

You must have a Telegram bot and auth token from the BotFather to run this bot. telegram-cli is not required.

###Configuration

To begin, copy config.lua.default to config.lua and add the relevant information.

Most config.lua entries are self-explanatory.

Add your bot API key, and other API keys if desirable. The plugins which require API keys that are not provided are disabled by default. The provided Giphy key is the public test key, and is subject to rate limitaton.

The "fortune.lua" plugin requires the fortune program to be installed on the host computer.

"time_offset" is the time difference, in seconds, between your system clock. It is sometimes necessary for accurate output of the time plugin.

"admins" table includes the ID numbers, as integers, of any privileged users. These will have access to the admin plugin and any addition privileged commands.

"people" table is for the personality plugin: ["55994550"] = "topkecleon"

ID number must be a string. The second string is the nickname to be given to the identified user when a personality greeting is triggered.

To run:

lua bot.lua

##Support

Do not private message me for support.

For support for otouto as well as general Lua and bot assistance, please join the Bot Development group (send "/join 16314802" to @Liberbot. After you read the rules and the pastebin, I will assist you there.

###PS

Since there seems to be some confusion on the matter, otouto is not a port of yagop's telegram-bot. I am friends with yagop, and he is part of the Bot Development group, but our codebases are and always have been entirely separate. otouto was a CLI bot like telegram-bot before the new API, but they were entirely separate, non-intermingled projects.