diff --git a/README.md b/README.md index 2762c1b..856984c 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,190 @@ The plugin-wielding, multi-purpose Telegram bot. Public bot runs on [@mokubot](http://telegram.me/mokubot). -Requires lua-socket and lua-sec. [dkjson](https://github.com/LuaDist/dkjson/) is provided. -Edit config.json with your bot API key, and other API keys if desirable. -Plugins which require an API key are disabled by default. +##Plugins -`lua bot.lua` +
about.lua | +/about | +Information about the bot | +
8ball.lua | +/8ball | +Magic 8-ball | +
bandersnatch.lua | +/bandersnatch | +Benedict Cumberbatch name generator | +
bible.lua | +/bible <verse> | +King James Version | +
btc.lua | +/btc <currency> [amount] | +Bitcoin prices and conversion | +
calc.lua | +/calc <expression> | +Solve math expression and convert units | +
commit.lua | +/commit | +http://whatthecommit.com | +
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 | +
fortune.lua | +/fortune | +Random fortunes | +
gSearch.lua | +/google <query> | +Google Search | +
gMaps.lua | +/loc <location> | +Google Maps search | +
gImages.lua | +/images <query> | +Google Images search | +
giphy.lua | +/giphy [query] | +Giphy search or random | +
hackernews.lua | +/hackernews | +Top stories from Hackernews | +
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 | +
pokedex.lua | +/dex <pokemon> | +Pokedex! | +
pun.lua | +/pun | +Puns | +
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! | +
time.lua | +/time <location> | +Get the time for a place | +
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 | +
xkcd.lua | +/xkcd [search] | +xkcd strips and alt text | +