flexible tip menu

Short Description:

Tip menu with sorting, normalization of the labels, single/multi line choice, color choice, up to 99 items, optional module to thank tippers

Full Description

Flexible tip menu usage & configuration details

English
This is a tip menu app for Chaturbate.
Fill in your prices and their description, and the bot will repeat them in the chat as notices for your viewers to see.
const lang = 'en';
Espaol
Esto es un bot de tip menu para Chaturbate.
Rellenas tus precios y su descripcion, y el bot los repetir en el chat con noticias a los usuarios.
El admin panel "Launch Bot" mismo se puede cambiar al espaol: para hacer esto, cambia a "es" el variable lang al principio del codigo fuente.
const lang = 'es';
Franais
Ceci est un bot de tip menu pour Chaturbate.
Remplissez vos prix et leur description, et le bot se chargera de les rappeler dans le chat.
Le panneau de configuration "Launch Bot" peut lui-mme tre affich en franais : pour cela, modifier "fr" la variable lang au dbut du code source.
const lang = 'fr';

One great feature of this bot is the ability to fill in the tip menu items as you think them up, and not worry about the order in which you write them or the specifics of what you write. Just put the amount first in the box, and the display format will be handled globally by the app. It's configurable too. Any empty menu item box will be ignored. Menu items that don't start with a number are ignored as well.

There are two levels of configuration: the settings in the "Launch Bot" admin panel to make the menu look how you want it to, and inside the source code to adjust the admin panel itself. All the options are described below.

Why not configure everything in the "Launch Bot" page? One example is to translate the admin panel itself; another is the number of items: if 99 menu items are too many for you, feel free to reduce that value in the code of the app: the admin panel will be shorter as a result.

Please feel free to discuss improvements and issues on GitHub (or to read a proper changelog).

A. Adding visuals to your notices

All text boxes in the admin panel can display graphics (if you choose to do so). There are two kinds of graphics:

Emoji & the like
those can be emoji or plain text that just happens to look like an image, for example the snowman:
they can be copy/pasted directly
the way to look them up is either by "emoji" or "unicode" searches

Emoticons
they can be animated or not
they can't be copy/pasted without using their code
they are entered as text, with a colon followed by the name of the GIF
as an example, :heart2 displays , while :heart7 translates to and :crownsilver shows as
one way to look them up is by hovering the mouse cursor over such an image in the chat, and after a few seconds you will see its code in a tooltip
another way is to start typing a colon in the chat followed by a letter and the chat will suggest emote codes for you: click one and you will get a preview of the image
any user on CB can upload an image of their choice and thus create a new :code for the chat and for apps to use

B. Variables in the source code

lang
the language of the admin panel
it can be one of "en", "es" or "fr"

nb_of_menu_items
the number of menu items that can be configured from the admin panel

enable_thank_tippers
enable/disable the "Thank Tippers" module of the app (its options will or will not be present in the admin panel depending on this)
true to enable, or false to disable

C. Global settings in the admin panel

App name
if set, this will be displayed in the chat at the top of the tip menu

Errors shown to
either the broadcaster or the moderators will be able to see the errors in the configuration of the app (in the chat), or nobody

Thank tippers
if set to "n/a", the module is disabled
otherwise, tippers are thanked either publicly or privately

D. Thank Tippers module settings in the admin panel

Thank tippers above tokens
allows to avoid thanking every single low tip
NB: this is off-by-one on purpose, so that to thank people for their tips from 25 tokens and up, you have to set this to 24

Thank tippers publicly background color
color of the background for the public notice
written in CSS/HTML format [1]

Thank tippers publicly text color
color of the text for the public notice
written in CSS/HTML format [1]

Thank tippers publicly boldness
thickness of the the text for the public notice
NB: "bold" and "bolder" are often the same

Thank tippers publicly format
template to format the public notice
available variables are: {AMOUNT} for the tip amount, {TIPPER} for the tipper's nickname, {SERVICE} for the label of the item corresponding to the tip amount

Thank tippers privately background color
color of the text for the private notice
written in CSS/HTML format [1]

Thank tippers privately text color
color of the text for the private notice
written in CSS/HTML format [1]

Thank tippers privately boldness
thickness of the the text for the private notice
NB: "bold" and "bolder" are often the same

Thank tippers privately format
template to format the private notice
available variables are: {AMOUNT} for the tip amount, {TIPPER} for the tipper's nickname, {SERVICE} for the label of the item corresponding to the tip amount

Thank tippers remind tip note format
template to format the personal reminder of the tip message (to its author, not in public chat)
same format options as the private thanks
available variables are: {MESSAGE}

E. Tip Menu settings in the admin panel

Tip menu shown to
whether to enable the tip menu at all, show it to everyone or to a subset of users

Tip menu header
if set, will be displayed after the app name and before the first item

Tip menu footer
if set, will be displayed at the end of the tip menu

Inline separator
if left empty, the tip menu will be multiline
otherwise, the tip menu will be displayed all in one line: in that case, the separator an be a comma or a dash or whatever text should appear between two tip menu items

Inline spacing
if the inline separator is set, this option can be used to apply spacing to either side of the separator
for example, a comma might need only "right" spacing, while a dash might be better with spacing on both sides

Menu background color
color of the background for the whole tip menu
written in CSS/HTML format [1]

Menu text color
color of the text for the whole tip menu
written in CSS/HTML format [1]

Menu boldness
thickness of the the text
NB: "bold" and "bolder" are often the same

Menu repeat minutes
number of minutes before the menu is displayed again in the chat

Menu item prefix
text that is prepended to all menu items
allows the use of :emoticons
Menu item suffix
text that is appended to all menu items
allows the use of :emoticons
Menu item display format
all subsequent menu items will be reformatted to this pattern
remember to include both {AMOUNT} and {LABEL}
available variables are: {AMOUNT}, {LABEL}
see examples below
allows the use of :emoticons
Sort order
in which order to sort the items (can be disabled too)

Menu item XYZ
must start with a number followed by a text label
anything else will be ignored by the app (handy to disable an item temporarily)
allows the use of :emoticons

[1] Feel free to use a tool like this one to pick your colors (focus on the "HEXA" label that changes as you click on different colors). This app accepts both lowercase and uppercase color codes, and the # symbol is not required at the start.