TheMenu

Short Description:

TheMenu

Full Description

• The Menu is designed to be useful for both the broadcaster and the viewer. When a user enters your room for the first time, they will be shown your tip menu. On every subsequent visit, users will be shown "Type /menu at anytime to see the tip menu."


• The Menu has many unique and useful features.




• 
  
  

  Features

  
  
  Supports anonymous tipping
  Single line or multi line options
  Auto responder
  Color customization
  Image / emoji customization
  Up to 40 menu items
  Sorting options
  Most settings also configurable in chat
  
  



• 
  
  

  Updates

  
  
  Menu banner customization
  Contrast ratio correction
  Items Purchased Log
  Revamped interactive help menu
  Improved auto response handling
  
  








Update: July 20 2021



• This is a major update. Several new features have been added along with several improvements to existing features.


• Menu Banner Customization
  
  You can now customize the title banner of your tip menu. Adds gifs, emojis, your own custom text. Get creative, get weird, have fun. This is an optional feature. You can leave the setting blank and a default banner will be used. This setting is also configurable from within chat using the command /banner [your new banner]
  
  



• Contrast Ratio Correction
  
  Web accessibility is an important concept that is often overlooked. In Version 1 of this app, we ensure all text
  remain legible testing the contrast ratio the chosen color against a white background. When the contrast ratio
  falls below a certain threshold, we swap out the white background for a darker one.
  
  This works but it's not flexible. The minimum contrast ratio required is 3:1 as outlined in WCAG20 guidelines.. If the color you choose has a contrast ratio of 2.8:1, it would make more sense to slightly modify the primary menu color rather than use an alternative background color. Or at least have the option to do so. And now you do.
  
  With contrast ratio color correction enabled, if contrast ratio fails to meet the minimum requirements then, we gradually darken the chosen color's lightness value until that requirement is met. It's important to note - the hue and saturation are left untouched.
  
  Let's say you really like the color deepskyblue. Here's what that color would look like on an individual menu item without any adjustments:
  
  

  Do some dirty things with my partner (499)

  
  Not too bad. But it is a little hard to see. If you check the contrast ratio, you'll see that it has a contrast ratio of about 2.12:1 against a white background. We can do better. Let's see what it looks like when we use contrast ratio correction.
  
  
  
  • MinimumDo some dirty things with my partner (499)
  
  
  • 
    AverageDo some dirty things with my partner (499)
    
  
  
  • 
    MaximumDo some dirty things with my partner (499)
    
  
  
  • 
    NoneDo some dirty things with my partner (499)
    
  
  
  
  Note - The Maximum setting will greatly alter the color in a lot of cases and generally isn't needed for large text.
  
  
  
  
  
  



• Items Purchased Log
  
  Sometimes when a room gets very busy, it can be a challenge to keep up with who tipped for what and when. Maybe you want to verify that someone actually tipped for what they claim. Instead scrolling through the chat history, now can check the Items Purchased Log.
  
  To view the entire log you can simply type /log
  To view a specific member's purchases, type /log @[username]
  Note - the @ sign is optional but useful for quickly entering a name without having to type the whole thing out.
  Members who tip for menu items can view their own purchases as well by typing /list
  
  
  



• Interactive Help Menu
  
  The help feature now has dedicated sections for each command including a detailed introduction followed by usage examples and, in some cases, various shortcuts as well. I've tried very hard to make this app easy to use and understand. And there is still plenty to improve on in this area. If you find yourself confused or if you feel something could be worded better, please do leave a comment down below.
  
  

Startup Settings

Menu style



• Single line     Items are display left to right on a single line separated by spaces.
  
  
  
  


• Multi line     Items are displayed top to bottom as a list with one item per line.
  
  





Item Separator





• Choose a preset               


• Or define your own      :starskuromi  
  





Sort by price





• Lowest to highest


• Highest to lowest


• No sorting





Menu Color





• Choose from a list of preset colors


• Input your own hex color code

Chat Commands

You can use commands to quickly change some settings without having to restart the app. Any message starting with a '/' is considered a command and won't be displayed in chat. The only commands that display something publicly are /menu and /notice. Some commands simply toggle a setting on or off. Other commands need additional input from you in order to work. When you use a command successfully, you will see a confirmation message that it was successful. In some cases, you may also be shown a preview of your tip menu with the newly added changes. When you use a command incorrectly you will see a notification that the command didn't work and a hint on how to fix it. You (the broadcaster) are the only one who can see these messages. So feel free experiment with things. Try the help command for a more in depth breakdown of the commands available.

• /help  Display this help message


• /menu  Send the tip menu to everyone in the room


• /auto  Toggle the auto response on or off


• /mode  Switch between single line and multi line mode


• /layout  Same as mode


• /list <dark|light>  Display a list of color names and color samples.


• /color <name|hexcode> Change the menu color


• /div <text|graphic> Change the item divider


• /sep <text|graphic> Same as div


• /notice <text> Send a public notice to the room


• /banner <text> Edit the menu banner


• /title <text> Same as banner


• /log <@username> View a users tip menu purchases

June 20, 2020

• Major update coming very soon. For the time being, the number of possible menu items has been increased to 25.



April 19, 2020

• If you've been using this bot for a while, you may have noticed that some of the menu color options changed recently. If you were using a color that went missing from the menu options, it has now been restored. All of the original colors as well as several new ones are available to use. Sorry for any confusion that may have caused.

I'd like to say thank you to everyone for using The Menu. When I built it, I never imagined it would become as popular as it is today. I'm glad to see that so many people have found it useful.

This bot has been thoroughly tested. But nothing is ever perfect and sometimes bugs do slip through. If you find a bug please let me know in the comments down below. If you need help immediately, please send an email to  [email protected]

If there is a feature you would like added to The Menu, please leave a comment down below detailing the feature you'd like to see added.