Highlight Notepad Plugin

This plugin lets you record highlights in a "notepad" list. Using this list, the streamer can set the highlights on Twitch later and then clear the notepad.

A new highlight can be added once every minute. This prevents accidental duplicates during high volume chats (when a lot of allowed people would create a highlight at the same time).

Each highlight consists of a description (given by the person adding it), the name of the person adding the highlight and the current date and time.

A channel can have at most 200 highlights, which will be automatically deleted after two weeks.

At the moment, highlights are only kept in memory and not put in a persistent store. This means that they are lost whenever Kabukibot is restarted. This is an open TODO and will hopefully change soon. Until then: sorry.

Synopsis

Identifier:
highlights
Permissions:
highlights, reset_highlights
Commands:
!highlight, !get_highlights, !reset_highlights

Setup

Simply enable the plugin using the global command !k_enable:

#tester_mantester_man: !k_enable highlights
kabukibot: tester_man, the plugin "highlights" has been enabled.

Usage

To create a new highlight, use the !highlight command and give a short description and/or the stream time (basically any information that helps the streamer to find the spot in the VOD after the stream). Do not give the current time, because it's recorded automatically.

#tester_mantester_man: !highlight combine harvester yolo drop with a bike
kabukibot: tester_man, the highlight has been noted down, thank you.

If you do the command too early again, you will get a warning:

#tester_mantester_man: !highlight combine harvester yolo drop with a bike
kabukibot: tester_man, the last highlight was only 42 seconds ago. No need to highlight again.

To see the current highlight list, use !get_highlights:

#tester_mantester_man: !get_highlights
kabukibot: tester_man, the highlights are: #1 "combine harvester yolo drop with a bike"

To see all details, add "verbose" to the command:

#tester_mantester_man: !get_highlights verbose
kabukibot: tester_man, the highlights are: #1 "combine harvester yolo drop with a bike" (by tester_man, Sun, 13 Apr 2014 04:11:39 GMT")

Once the list has been looked through, it can be cleared by doing !reset_highlights:

#tester_mantester_man: !reset_highlights
kabukibot: tester_man, your one highlight has been deleted.

Permissions

Use the global commands !k_allow and !k_deny to control the permissions for this plugin.

highlights
Users with this permission may use the !highlight and !get_highlights commands. Moderators are usually a good choice for this permission.
reset_highlights
Users with this permission may use the !reset_highlights command. This should only be granted under special circumstances, for example to stream editors (i.e. people who can create Twitch highlights).

Example:

#tester_mantester_man: !k_allow highlights $mods
kabukibot: tester_man, granted permission "highlights" to $mods.