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

Merge pull request #11 from TiagoDanin/patch-2

Browse Source 
Organization of command list of plugins
This commit is contained in:
Drew 2015-11-15 08:56:25 -05:00
commit b7aadc5247
1 changed files with 174 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

270
README.md
View File

@ -9,92 +9,19 @@ To start, send "/start" or say "Hello, otouto."
##Plugins ##Plugins
<table> <table>
<thead> <thead>
<tr>
<td>help.lua</td>
<td>/help [command]</td>
<td>List commands</td>
</tr>
<tr> <tr>
<td>about.lua</td> <td>about.lua</td>
<td>/about</td> <td>/about</td>
<td>Information about the bot</td> <td>Information about the bot</td>
</tr> </tr>
<tr> <tr>
<td>gSearch.lua</td> <td>admin.lua</td>
<td>/google &lt;query&gt;</td> <td>/admin [command]</td>
<td>Google Search</td> <td>Support for admin</td>
</tr>
<tr>
<td>gImages.lua</td>
<td>/images &lt;query&gt;</td>
<td>Google Images search</td>
</tr>
<tr>
<td>reddit.lua</td>
<td>/reddit [r/subreddit | query]</td>
<td>Posts from reddit</td>
</tr>
<tr>
<td>giphy.lua</td>
<td>/giphy [query]</td>
<td>Giphy search or random</td>
</tr>
<tr>
<td>xkcd.lua</td>
<td>/xkcd [search]</td>
<td>xkcd strips and alt text</td>
</tr>
<tr>
<td>gMaps.lua</td>
<td>/loc &lt;location&gt;</td>
<td>Google Maps search</td>
</tr>
<tr>
<td>imdb.lua</td>
<td>/imdb &lt;movie | TV series&gt;</td>
<td>IMDb movie/television info</td>
</tr>
<tr>
<td>urbandictionary.lua</td>
<td>/ud &lt;term&gt;</td>
<td>Urban Dictionary search</td>
</tr>
<tr>
<td>hackernews.lua</td>
<td>/hackernews</td>
<td>Top stories from Hackernews</td>
</tr>
<tr>
<td>time.lua</td>
<td>/time &lt;location&gt;</td>
<td>Get the time for a place</td>
</tr>
<tr>
<td>weather.lua</td>
<td>/weather &lt;location&gt;</td>
<td>Get the weather for a place</td>
</tr>
<tr>
<td>calc.lua</td>
<td>/calc &lt;expression&gt;</td>
<td>Solve math expression and convert units</td>
</tr>
<tr>
<td>dice.lua</td>
<td>/roll [arg]</td>
<td>Roll a die. Accepts D&amp;D notation</td>
</tr>
<tr>
<td>remind.lua</td>
<td>/remind &lt;delay&gt; &lt;message&gt;</td>
<td>Set a reminder for yourself or a group</td>
</tr>
<tr>
<td>8ball.lua</td>
<td>/8ball</td>
<td>Magic 8-ball</td>
</tr> </tr>
<tr> <tr>
<td>bandersnatch.lua</td> <td>bandersnatch.lua</td>
@ -106,16 +33,51 @@ To start, send "/start" or say "Hello, otouto."
<td>/bible &lt;verse&gt;</td> <td>/bible &lt;verse&gt;</td>
<td>King James Version</td> <td>King James Version</td>
</tr> </tr>
<tr>
<td>blacklist.lua</td>
<td>/blacklist</td>
<td>Blacklist</td>
</tr>
<tr> <tr>
<td>btc.lua</td> <td>btc.lua</td>
<td>/btc &lt;currency&gt; [amount]</td> <td>/btc &lt;currency&gt; [amount]</td>
<td>Bitcoin prices and conversion</td> <td>Bitcoin prices and conversion</td>
</tr> </tr>
<tr>
<td>calc.lua</td>
<td>/calc &lt;expression&gt;</td>
<td>Calculator</td>
</tr>
<tr>
<td>cats.lua</td>
<td>/calc &lt;expression&gt;</td>
<td>Solve math expression and convert units</td>
</tr>
<tr>
<td>chatter.lua</td>
<td>@[user_name_bot], [message]</td>
<td>Chatter Bot</td>
</tr>
<tr> <tr>
<td>commit.lua</td> <td>commit.lua</td>
<td>/commit</td> <td>/commit</td>
<td>http://whatthecommit.com</td> <td>http://whatthecommit.com</td>
</tr> </tr>
<tr>
<td>currency.lua</td>
<td>/cash &lt;from&gt; &lt;to&gt; [amount]</td>
<td>Convert an amount from one currency to another</td>
</tr>
<tr>
<td>dgmp.lua</td>
<td>/index and /listgroups</td>
<td>Plugin to display the groups, descriptions, etc.</td>
</tr>
<tr>
<td>dice.lua</td>
<td>/roll [arg]</td>
<td>Roll a die. Accepts D&D notation</td>
</tr>
<tr> <tr>
<td>dogify.lua</td> <td>dogify.lua</td>
<td>/dogify &lt;lines/separatedby/slashes&gt;</td> <td>/dogify &lt;lines/separatedby/slashes&gt;</td>
@ -126,16 +88,96 @@ To start, send "/start" or say "Hello, otouto."
<td>/echo &lt;text&gt;</td> <td>/echo &lt;text&gt;</td>
<td>Repeat a string</td> <td>Repeat a string</td>
</tr> </tr>
<tr>
<td>floodcontrol.lua</td>
<td>No command</td>
<td>Flood control</td>
</tr>
<tr> <tr>
<td>fortune.lua</td> <td>fortune.lua</td>
<td>/fortune</td> <td>/fortune</td>
<td>Random fortunes</td> <td>Random fortunes</td>
</tr> </tr>
<tr>
<td>gImages.lua</td>
<td>/images &lt;query&gt;</td>
<td>Google Images search</td>
</tr>
<tr>
<td>giphy.lua</td>
<td>/giphy [query]</td>
<td>Giphy search or random</td>
</tr>
<tr>
<td>gMaps.lua</td>
<td>/loc &lt;location&gt;</td>
<td>Google Maps search</td>
</tr>
<tr>
<td>gSearch.lua</td>
<td>/google &lt;query&gt;</td>
<td>Google Search</td>
</tr>
<tr>
<td>hackernews.lua</td>
<td>/hackernews</td>
<td>Top stories from Hackernews</td>
</tr>
<tr>
<td>hearthstone.lua</td>
<td>/hearthstone &lt;card&gt;</td>
<td>Information about a Hearthstone card</td>
</tr>
<tr>
<td>help.lua</td>
<td>/help [command]</td>
<td>List commands</td>
</tr>
<tr> <tr>
<td>hex.lua</td> <td>hex.lua</td>
<td>/hex &lt;number&gt;</td> <td>/hex &lt;number&gt;</td>
<td>Convert to and from hexadecimal</td> <td>Convert to and from hexadecimal</td>
</tr> </tr>
<tr>
<td>imdb.lua</td>
<td>/imdb &lt;movie | TV series&gt;</td>
<td>IMDb movie/television info</td>
</tr>
<tr>
<td>interactions.lua</td>
<td>No command</td>
<td>Welcome</td>
</tr>
<tr>
<td>kickass.lua</td>
<td>/torrent &lt;query&gt;</td>
<td>Search Kickass Torrents</td>
</tr>
<tr>
<td>lastfm.lua</td>
<td>/lastfm [username]</td>
<td>Get current- or last-played track</td>
</tr>
<tr>
<td>lmgtfy.lua</td>
<td>/lmgtfy</td>
<td>Open page of lmgtfy</td>
</tr>
<tr>
<td>moderation.lua</td>
<td>/modhelp</td>
<td>Support for moderator or admin</td>
</tr>
<tr>
<td>nick.lua</td>
<td>/nick &lt;nickname&gt;</td>
<td>Set your nickname for the bot</td>
</tr>
<tr>
<td>owm.lua</td>
<td>/weather &lt;location&gt;</td>
<td>Temperature and weather conditions</td>
</tr>
<tr> <tr>
<td>pokedex.lua</td> <td>pokedex.lua</td>
<td>/dex &lt;pokemon&gt;</td> <td>/dex &lt;pokemon&gt;</td>
@ -146,45 +188,81 @@ To start, send "/start" or say "Hello, otouto."
<td>/pun</td> <td>/pun</td>
<td>Puns</td> <td>Puns</td>
</tr> </tr>
<tr>
<td>reaction.lua</td>
<td>/reactions</td>
<td>Get a list emoticons</td>
</tr>
<tr>
<td>reddit.lua</td>
<td>/reddit [r/subreddit | query]</td>
<td>Posts from reddit</td>
</tr>
<tr>
<td>remind.lua</td>
<td>/remind &lt;delay&gt; &lt;message&gt;</td>
<td>Set a reminder for yourself or a group</td>
</tr>
<tr> <tr>
<td>slap.lua</td> <td>slap.lua</td>
<td>/slap [victim]</td> <td>/slap [victim]</td>
<td>Slap someone!</td> <td>Slap someone!</td>
</tr> </tr>
<tr>
<td>whoami.lua</td>
<td>/who</td>
<td>Get user and group IDs</td>
</tr>
<tr>
<td>nick.lua</td>
<td>/nick &lt;nickname&gt;</td>
<td>Set your nickname for the bot</td>
</tr>
<tr>
<td>wikipedia.lua</td>
<td>/wiki &lt;topic&gt;</td>
<td>Search Wikipedia</td>
</tr>
<tr> <tr>
<td>spotify.lua</td> <td>spotify.lua</td>
<td>/spotify &lt;music&gt;</td> <td>/spotify &lt;music&gt;</td>
<td>Search Spotify</td> <td>Search Spotify</td>
</tr> </tr>
<tr> <tr>
<td>youtube.lua</td> <td>time.lua</td>
<td>/youtube &lt;query&gt;</td> <td>/time &lt;location&gt;</td>
<td>Search Youtube</td> <td>Get the time for a place</td>
</tr> </tr>
<tr> <tr>
<td>translate.lua</td> <td>translate.lua</td>
<td>/translate [target lang]</td> <td>/translate [target lang]</td>
<td>Message to translate</td> <td>Message to translate</td>
</tr> </tr>
<tr>
<td>urbandictionary.lua</td>
<td>/ud &lt;term&gt;</td>
<td>Urban Dictionary search</td>
</tr>
<tr>
<td>weather.lua</td>
<td>/weather &lt;location&gt;</td>
<td>Get the weather for a place</td>
</tr>
<tr>
<td>whoami.lua</td>
<td>/who</td>
<td>Get user and group IDs</td>
</tr>
<tr>
<td>wikipedia.lua</td>
<td>/wiki &lt;topic&gt;</td>
<td>Search Wikipedia</td>
</tr>
<tr>
<td>xkcd.lua</td>
<td>/xkcd [search]</td>
<td>Xkcd strips and alt text</td>
</tr>
<tr>
<td>youtube.lua</td>
<td>/youtube &lt;query&gt;</td>
<td>Search Youtube</td>
</tr>
<tr>
<td>8ball.lua</td>
<td>/8ball</td>
<td>Magic 8-ball.</td>
</tr>
</tbody> </tbody>
</table> </table>
##Setup ##Setup
Requires Lua, lua-socket and lua-sec. [dkjson](http://github.com/LuaDist/dkjson/) is provided. Written for Lua 5.2 but will probably run on 5.3. Requires Lua, lua-socket and lua-sec. [dkjson](http://github.com/LuaDist/dkjson/) is provided. Written for Lua 5.2 but will probably run on 5.3.