yamtest-01

Short Description:

Yet Another Menu (YAM): Limited-stock items + purchase history

Full Description

This is a low-frills menu bot, which does a few things I don't remember ever seeing. The streamer can add and remove items, import/export the menu, and wipe the menu and purchase history. Mods and the streamer can both adjust limits, reset hit counters, and view the purchase history.

Quickstart/Examples

Broadcaster: play these in order to get a feel for the bot.

/yam add dance 20 4
    Adds menu item 'dance' at price 20, which can be purchased 4 times.

/yam add jump around~24
    Adds menu item 'jump around' at price 24, which can be purchased an unlimited number of times.

/yam price 2 33
    Changes price of item 2 ('jump around') to 33.

/yam unlimit 1
    Removes the purchase limit of the 1st item of the menu ('dance').

/yam limit 1 0
    Disables the item, it will display as "sold out".

/yam limit 1 30
    Sets a 30-purchase limit on the item, implicitly reactivates it.

/yam export
    Produces a string of menu items for copy/pasting: dance~20~0|jump around~33~-1.

/yam delete 1
    Deletes the item (which should now be empty).

/yam import dance~20~20|jump around~33~-1
    Unpacks and adds a 20-token, 30-purchase 'dance' item. The 'jump around' item is skipped, as a 33-token item already exists in the menu.

/yam list
    Sends a notice of the listing to the user, with entry numbers (mod/streamer) or not (everyone else).

/yam reset 1
    Resets the hit counter for item #1, making it available again if it was sold out.

/yam hide
    No more auto-displays of the menu.

/yam show
    The menu now displays...

/yam interval 1
     ...every minute.

General Behavior

Management of individual items is menu driven. /yam list spits out the menu as a numbered list; YAM acts on those item numbers (not names), as shown in the examples above.

Once a menu item has more purchases than its assigned limit, it will display as 'sold out' to the public. Mods+Streamer will see both the item name and the 'sold out' text.

Entire menus can be exported and imported as a single line, pipe ('|') and tilde('~') separated. Copy them off for safekeeping, keep multiple copies to load whatever suits your mood for a given day or show.

Supported Commands

Letters in parentheses are abbreviated versions of those commands, e.g. "/yam l" is shorthand for "/yam list".

Available to streamer

• /yam (a)dd [name] [price] {limit} - add item to menu, at [price] and optional {limit}.


• /yam (d)elete [num] - delete item [num] from menu.


• /yam (p)rice [num] [price] - sets the [price] of item [num] from menu, if the price doesn't exist already


• /yam i(m)port [full-menu] - add a set of items whose prices aren't already in the menu. [Full-menu] is internally separated by '~', externally by '|'. (e.g.: 'dance~5~10|jump~20').


• /yam e(x)port - dumps all item names, prices, and limits, to a string for use with "import" - formatted as above.


• /yam (w)ipe - remove all menu items.


• /yam show - allow the menu to display itself in the public chat.


• /yam hide - prevent the menu from displaying itself in the public chat.

Available to mods + streamer.
Any [num] value below must be the number of the item as displayed in the "list" command (e.g '/yam reset 4' to reset the 4th item in your menu):

• /yam l(i)mit [num] [qty] - limits menu item #[num] to quantity [qty]. Set to 0 to disable an item.


• /yam (u)nlimit [num] - removes limit on item #[num].


• /yam r(e)set [num] - resets hit count of item #[num].


• /yam (h)istory - print purchase history, reverse-time order. History supports 3 filtering options:


• /yam history item [num] - all purchases for item #[num].


• /yam history price [p] - all purchases for item price [p].


• /yam history user [u] - all purchases for user [u].




• /yam (cl)earhist - clear out the order history.


• /yam (l)ast {qty} - print up to {qty} (default 10) most recent purchases. Also supports item/price/user filtering, as '/yam history' above. Note: in such cases, [qty] is required:


• /yam last [qty] item [num] - [qty] purchases for item #[num].


• /yam last [qty] price [p] - [qty] purchases for item price [p].


• /yam last [qty] user [u] - [qty] purchase for user [u].




• /yam interval [1-20] - sets the menu's public display interval, between 1-20 minutes

Available to anyone

• /yam (l)ist - print a numbered list of current items. Only streamers will see item descriptions for out-of-stock items.


• /yam help - print this list