ca.taffer.mm-quotebot

README

Moved

This repo is has been replaced by: https://codeberg.org/Taffer/ca.taffer.mm-quotebot

Everything in this repo should be considered out of date.

ca.taffer.mm-quotebot

A Mattermost quotation bot.

Inspired by Slack's Loading Messages and Slackbot.

I still don't know Go (see Rolly for more evidence!), so buckle up...

Quotations

Quotebot remembers quotes you tell it about, and spits them out again when you ask it to.

Commands:

• /quote - Regurgitate a random quote.
• /quote x - Show quote number x.
• /quote add genius quote - Store genius quote for later. Don't forget to include an attribution!
• /quote help - Show the help.
• /quote info - Show the number of quotes, the channel, and the interval.

Admin commands:

• /quote channel x - Monitor channel x for activity and randomly show quotes there.
• /quote delete x - Delete quote number x.
• /quote interval x - The time between automatically posting quotes in a channel.
• /quote list - List all known quotes.

Periodically posts a random quote to a specified channel. Default is every 60 minutes in ~town-square if there's activity there.

TODO: Make it periodically post. TODO: Monitor multiple channels.

Output:

I feel pretty. -- @shane

TODO: Handle responses, or make a Responsebot:

Quotebot could also handle responses, with a set of commands like this:

• /response add "trigger" "response text" - Say response text when someone writes trigger.

Admin commands for /response:

• /response list - List all known responses.
• /response delete "trigger" - Delete the response for trigger.

The responses would have their own channel separate from the quotes, and a 1/x chance of responding to a matched trigger so it doesn't get annoying.

It's like Speed but more stupid. -- @chris

Privacy

When Quotebot is monitoring a channel, it's just looking for activity. Specifically, it looks for:

• Messages being posted (but it ignores bots).
• Users joining the channel.
• Users leaving the channel.

Quotebot entirely ignores what's happening and only pays attention to the fact that something happened. None of the events are logged or stored in any way.

To see exactly what Quotebot is doing while monitoring, look at these functions in server/plugin.go:

• MessageHasBeenPosted()
• UserHasJoinedChannel()
• UserHasLeftChannel()

Credits

• Mattermost's plugin sample
• Icon from Nick Roach's GPL'd Circle Icons set.
• Thanks to Joram Wilander for pointing me in the right direction via the Mattermost ~Developer Toolkit channel.