[#11] Add a system for scripts to add help and the bot to retrieve and display it.

eojthebrave commented 9 years ago

Resolves #11

Adds bot.help API that can be used to add and get specific help text, and a summary option to retrieve a list of all registered help texts.
Adds a script that interfaces with the bot.help API in order to allow for display of help message by the bot itself.
Provides basic documentation for adding help text to your own scrips.

Example:

<@eojthebrave> joebot: help?
<joebot> Detailed information is available with "BOTNAME: help <feature>?" where <feature> is one of: factoids, help
<@eojthebrave> joebot: help?
<joebot> Detailed information is available with "BOTNAME: help <feature>?" where <feature> is one of: factoids, help
<@eojthebrave> joebot: help factoids?
<joebot> Set factoids with "BOTNAME: Metal is great." or  "BOTNAME: cats are furry." or "BOTNAME: ping is <reply>WHAT?!". You can use the !who placeholder, it will be replaced with the nick of the user performing the query. Retrieve with "Robots?" or "BOTNAME: cheer!" Forget with "BOTNAME: delete factoid ping".

q0rban commented 9 years ago

I love this so much.

eojthebrave commented 9 years ago

Thanks for the feedback @q0rban. I think I've addressed all your issues with the code. Yay help!

Lullabot / lubot

[#11] Add a system for scripts to add help and the bot to retrieve and display it. #29