Chaturbate

Bots Home | Create an App
Smoker's Multiphasic Tip Menu
Author: smoker919
Description Source Code Launch Bot Current Users
There are 313 other versions of this script.
////////////////////////////////////////////////////////////////////////////////
// S M O K E R ' S   M U L T I P H A S I C   T I P   M E N U
// by Smoker919
//
// A familiar take on tip menus but with new features and a second, hidden menu
// for broadcasters to share with their special viewers
////////////////////////////////////////////////////////////////////////////////


// Constants ///////////////////////////////////////////////////////////////////

const GENERAL_COLOR_THEME = 'General color theme';
const CUSTOM_COLOR_THEME  = 'CUSTOM (enter colors below)';

const MULTI_LINE  = 'Multi line';
const SINGLE_LINE = 'Single line';

const DEFAULT_TEXT_COLOR = 'White';

const NOTICE_DELAY = 175;

const BROADCASTER = 'Broadcaster';
const MODS        = 'Mods';
const FAN_CLUB    = 'Fan Club';

const DEFAULT_MOD_THANK_YOU_MESSAGE       = 'Thank you %separator% %username%, my dear moderator %separator% for tipping';
const DEFAULT_MOD_TIPPED_FOR_MESSAGE      = 'Moderator %username% tipped for %separator% %tipmenuitem_description% %separator%';
const DEFAULT_FAN_CLUB_THANK_YOU_MESSAGE  = 'Thank you %separator% %username%, my loyal fan club member %separator% for tipping';
const DEFAULT_FAN_CLUB_TIPPED_FOR_MESSAGE = 'Fan club member %username% tipped for %separator% %tipmenuitem_description% %separator%';
const DEFAULT_BASIC_THANK_YOU_MESSAGE     = 'Thank you %separator% %username% %separator% for tipping';
const DEFAULT_BASIC_TIPPED_FOR_MESSAGE    = '%username% tipped for %separator% %tipmenuitem_description% %separator%';

const SEPARATOR_LINE = '\u2014'.repeat(24);

const DEFAULT_MAIN_MENU_TITLE = '%broadcaster_caps%\'s Tip Menu';
const MAIN_MENU_FOOTER = SEPARATOR_LINE + '\n\'FC\' denotes special fan club prices\n' + SEPARATOR_LINE;

const DEFAULT_HIDDEN_MENU_TITLE = '%broadcaster_caps%\'s Special Tip Menu';
const HIDDEN_MENU_FOOTER = SEPARATOR_LINE + '\nThis special menu is hidden from most users.\nThe broadcaster has deemed you worthy\nand important enough to enjoy using it.\n' + SEPARATOR_LINE;

const GROUPS_NONE = 'None';
const GROUPS_MODS_ONLY = 'Mods only';
const GROUPS_MODS_AND_FAN_CLUB_ONLY = 'Mods and fan club only';
const GROUPS_FAN_CLUB_ONLY = 'Fan club only';


// Class definitions ///////////////////////////////////////////////////////////

class ColorTheme {
    constructor(color) {
        this.color = color;
    }
}

class NamedColorTheme {
    constructor(name, colorTheme) {
        this.name = name;
        this.colorTheme = colorTheme;
    }
}

class Emoji {
    constructor(name, code, htmlCode) {
        this.name = name;
        this.code = code;
        this.htmlCode = htmlCode;
    }
}

class NoticesFields {
    constructor(thankYouMessage, tippedForMessage, colorTheme, separator) {
        this.thankYouMessage = thankYouMessage;
        this.tippedForMessage = tippedForMessage;
        this.colorTheme = colorTheme;
        this.separator = separator;
    }
}

class MenuMessages {
    constructor(titleMessage, itemsMessage, footerMessage) {
        this.titleMessage = titleMessage;
        this.itemsMessage = itemsMessage;
        this.footerMessage = footerMessage;
    }
}

class MainMenuItem {
    constructor(description, isEnabled, price, fanClubPrice) {
        this.description = description;
        this.isEnabled = isEnabled;
        this.price = price;
        this.fanClubPrice = fanClubPrice;
    }
}

class HiddenMenuItem {
    constructor(description, isEnabled, price) {
        this.description = description;
        this.isEnabled = isEnabled;
        this.price = price;
    }
}


// Reference collections ///////////////////////////////////////////////////////

const NAMED_COLOR_THEMES = [                                                     // contrast ratio
    new NamedColorTheme('Smoker\'s Theme',   new ColorTheme('#11443C')),         // 10.96
    new NamedColorTheme('Dark Green',        new ColorTheme('DarkGreen')),       // 7.43
    new NamedColorTheme('Dark Red',          new ColorTheme('DarkRed')),         // 10.01
    new NamedColorTheme('Dark Slate Blue',   new ColorTheme('DarkSlateBlue')),   // 9.06
    new NamedColorTheme('Fan Club Green',    new ColorTheme('#149718')),         // 3.83 - TODO: adjust to meet WCAG 2.0 standard of 4.5
    new NamedColorTheme('Indigo',            new ColorTheme('Indigo')),          // 12.95
    new NamedColorTheme('Medium Violet-Red', new ColorTheme('MediumVioletRed')), // 5.42
    new NamedColorTheme('Midnight Blue',     new ColorTheme('MidnightBlue')),    // 14.84
    new NamedColorTheme('Moderator Red',     new ColorTheme('#D90A16')),         // 5.24
    new NamedColorTheme('Newsprint',         new ColorTheme('Black')),           // 21
    new NamedColorTheme('Maroon',            new ColorTheme('Maroon')),          // 10.94
    new NamedColorTheme('Teal',              new ColorTheme('Teal')),            // 4.77
];
const DEFAULT_NAMED_COLOR_THEME = NAMED_COLOR_THEMES[0];

const EMOJIS = [
    new Emoji('Alien',             '\u{1F47D}'), // 👽
    new Emoji('Butterfly',         '\u{1F98B}'), // 🦋
    new Emoji('Camera with Flash', '\u{1F4F8}'), // 📸
    new Emoji('Confetti Ball',     '\u{1F38A}'), // 🎊
    new Emoji('Crown',             '\u{1F451}'), // 👑
    new Emoji('Crystal Ball',      '\u{1F52E}'), // 🔮
    new Emoji('Cupcake',           '\u{1F9C1}'), // 🧁
    new Emoji('Custard',           '\u{1F36E}'), // 🍮
    new Emoji('Cyclone',           '\u{1F300}'), // 🌀
    new Emoji('Dizzy',             '\u{1F4AB}'), // 💫
    new Emoji('Fire',              '\u{1F525}'), // 🔥
    new Emoji('Firecracker',       '\u{1F9E8}'), // 🧨
    new Emoji('Fireworks',         '\u{1F386}'), // 🎆
    new Emoji('Gem Stone',         '\u{1F48E}'), // 💎
    new Emoji('Glowing Star',      '\u{1F31F}'), // 🌟
    new Emoji('Growing Heart',     '\u{1F497}'), // 💗
    new Emoji('Heart with Arrow',  '\u{1F498}'), // 💘
    new Emoji('Hibiscus',          '\u{1F33A}'), // 🌺
    new Emoji('Honey Pot',         '\u{1F36F}'), // 🍯
    new Emoji('Ice Cream',         '\u{1F368}'), // 🍨
    new Emoji('Jack-O-Lantern',    '\u{1F383}'), // 🎃
    new Emoji('Kiss Mark',         '\u{1F48B}'), // 💋
    new Emoji('Light Bulb',        '\u{1F4A1}'), // 💡
    new Emoji('Lollipop',          '\u{1F36D}'), // 🍭
    new Emoji('Party Popper',      '\u{1F389}'), // 🎉
    new Emoji('Peach',             '\u{1F351}'), // 🍑
    new Emoji('Revolving Hearts',  '\u{1F49E}'), // 💞
    new Emoji('Ring',              '\u{1F48D}'), // 💍
    new Emoji('Rose',              '\u{1F339}'), // 🌹
    new Emoji('Shortcake',         '\u{1F370}'), // 🍰
    new Emoji('Skull',             '\u{1F480}'), // 💀
    new Emoji('Sparkler',          '\u{1F387}'), // 🎇
    new Emoji('Sparkling Heart',   '\u{1F496}'), // 💖
    new Emoji('Star',              '\u2B50'),    // ⭐
    new Emoji('Strawberry',        '\u{1F353}'), // 🍓
    new Emoji('Tulip',             '\u{1F337}'), // 🌷
    new Emoji('Two Hearts',        '\u{1F495}'), // 💕
    new Emoji('Unicorn',           '\u{1F984}'), // 🦄
    new Emoji('Wrapped Gift',      '\u{1F381}'), // 🎁
];


// Settings functions //////////////////////////////////////////////////////////

function generateMenuColorThemeSettingsItem(name, label) {
    var settings = {name: name, type: 'choice', label: label, defaultValue: DEFAULT_NAMED_COLOR_THEME.name, required: false};
    var i = 1;
    NAMED_COLOR_THEMES.forEach(item => {
        settings['choice' + i++] = item.name;
    });
    settings['choice' + i] = CUSTOM_COLOR_THEME;
    return settings;
}

function generateMessageColorThemeSettingsItem(name, label) {
    var settings = {name: name, type: 'choice', label: label, choice1: GENERAL_COLOR_THEME, defaultValue: GENERAL_COLOR_THEME, required: false};
    var i = 2;
    NAMED_COLOR_THEMES.forEach(item => {
        settings['choice' + i++] = item.name;
    });
    settings['choice' + i] = CUSTOM_COLOR_THEME;
    return settings;
}

function generateEmojiSeparatorSettingsItem(name, label) {
    var settings = {name: name, type: 'choice', label: label, choice1: 'RANDOM', defaultValue: 'RANDOM', required: false};
    var i = 2;
    EMOJIS.forEach(item => {
        settings['choice' + i++] = item.name;
    });
    return settings;
}


// Settings ////////////////////////////////////////////////////////////////////

cb.settings_choices = [
    // general
    {name: 'general', type: 'choice', label: '(1) ~~~~~~~~~~ GENERAL ~~~~~~~~~~', required: false},
    generateMenuColorThemeSettingsItem('general_colorTheme', GENERAL_COLOR_THEME),
    {name: 'general_customThemeColor', type: 'str', label: 'CUSTOM general theme color', defaultValue: '', required: false},
    {name: 'general_textWeight', type: 'choice', label: 'Text weight', choice1: 'Normal', choice2: 'Bold', choice3: 'Bolder', defaultValue: 'Bold', required: true},
    {name: 'general_menuFrequency', type: 'int', label: 'Menu frequency', minValue: 1, maxValue: 10, defaultValue: 4, required: false},
    {name: 'general_moderatorMessages', type: 'choice', label: 'MODERATOR MESSAGES ~~~~~', required: false},
    {name: 'general_moderatorThankYouMessage', type: 'str', label: 'Moderator thank you message', defaultValue: DEFAULT_MOD_THANK_YOU_MESSAGE, required: false},
    {name: 'general_moderatorTippedForMessage', type: 'str', label: 'Moderator tipped for message', defaultValue: DEFAULT_MOD_TIPPED_FOR_MESSAGE, required: false},
    generateMessageColorThemeSettingsItem('general_moderatorNoticesColorTheme', 'Moderator notices color theme'),
    {name: 'general_moderatorNoticesCustomThemeColor', type: 'str', label: 'CUSTOM moderator notices theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('general_moderatorMessagesSeparator', 'Moderator messages separator'),
    {name: 'general_fanClubMessages', type: 'choice', label: 'FAN CLUB MESSAGES ~~~~~', required: false},
    {name: 'general_fanClubThankYouMessage', type: 'str', label: 'Fan club thank you message', defaultValue: DEFAULT_FAN_CLUB_THANK_YOU_MESSAGE, required: false},
    {name: 'general_fanClubTippedForMessage', type: 'str', label: 'Fan club tipped for message', defaultValue: DEFAULT_FAN_CLUB_TIPPED_FOR_MESSAGE, required: false},
    generateMessageColorThemeSettingsItem('general_fanClubNoticesColorTheme', 'Fan club notices color theme'),
    {name: 'general_fanClubNoticesCustomThemeColor', type: 'str', label: 'CUSTOM fan club notices theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('general_fanClubMessagesSeparator', 'FanClub messages separator'),
    {name: 'general_defaultMessages', type: 'choice', label: 'DEFAULT MESSAGES ~~~~~', required: false},
    {name: 'general_defaultThankYouMessage', type: 'str', label: 'Default thank you message', defaultValue: DEFAULT_BASIC_THANK_YOU_MESSAGE, required: false},
    {name: 'general_defaultTippedForMessage', type: 'str', label: 'Default tipped for message', defaultValue: DEFAULT_BASIC_TIPPED_FOR_MESSAGE, required: false},
    generateMessageColorThemeSettingsItem('general_defaultNoticesColorTheme', 'Default notices color theme'),
    {name: 'general_defaultNoticesCustomThemeColor', type: 'str', label: 'CUSTOM default notices theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('general_defaultMessagesSeparator', 'Default messages separator'),

    // main menu
    {name: 'mainMenu', type: 'choice', label: '(2) ~~~~~~~~~~ MAIN TIP MENU ~~~~~~~~~~', required: false},
    {name: 'mainMenu_title', type: 'str', label: 'Menu title', defaultValue: DEFAULT_MAIN_MENU_TITLE, required: false},
    generateEmojiSeparatorSettingsItem('mainMenu_titleSeparator', 'Title separator'),
    generateEmojiSeparatorSettingsItem('mainMenu_itemSeparator', 'Item separator'),
    {name: 'mainMenu_style', type: 'choice', label: 'Style', choice1: MULTI_LINE, choice2: SINGLE_LINE, defaultValue: MULTI_LINE, required: false},
    // {name: 'mainMenu_fanClubDiscount', type: 'int', label: 'Fan club discount %', minValue: 0, maxValue: 50, defaultValue: 0, required: false},
    // {name: 'mainMenu_fanClubDiscountCap', type: 'int', label: 'Fan club discount cap', minValue: 0, defaultValue: 100, required: false},
    {name: 'mainMenu_item1_description', type: 'str', label: 'Item 1: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item1_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item1_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item2_description', type: 'str', label: 'Item 2: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item2_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item2_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item3_description', type: 'str', label: 'Item 3: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item3_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item3_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item4_description', type: 'str', label: 'Item 4: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item4_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item4_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item5_description', type: 'str', label: 'Item 5: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item5_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item5_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item6_description', type: 'str', label: 'Item 6: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item6_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item6_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item7_description', type: 'str', label: 'Item 7: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item7_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item7_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item8_description', type: 'str', label: 'Item 8: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item8_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item8_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item9_description', type: 'str', label: 'Item 9: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item9_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item9_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item10_description', type: 'str', label: 'Item 10: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item10_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item10_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item11_description', type: 'str', label: 'Item 11: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item11_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item11_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item12_description', type: 'str', label: 'Item 12: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item12_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item12_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item13_description', type: 'str', label: 'Item 13: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item13_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item13_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item14_description', type: 'str', label: 'Item 14: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item14_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item14_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item15_description', type: 'str', label: 'Item 15: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item15_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item15_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item16_description', type: 'str', label: 'Item 16: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item16_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item16_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item17_description', type: 'str', label: 'Item 17: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item17_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item17_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item18_description', type: 'str', label: 'Item 18: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item18_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item18_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item19_description', type: 'str', label: 'Item 19: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item19_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item19_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item20_description', type: 'str', label: 'Item 20: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item20_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item20_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item21_description', type: 'str', label: 'Item 21: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item21_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item21_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item22_description', type: 'str', label: 'Item 22: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item22_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item22_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item23_description', type: 'str', label: 'Item 23: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item23_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item23_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item24_description', type: 'str', label: 'Item 24: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item24_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item24_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item25_description', type: 'str', label: 'Item 25: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item25_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item25_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item26_description', type: 'str', label: 'Item 26: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item26_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item26_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item27_description', type: 'str', label: 'Item 27: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item27_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item27_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item28_description', type: 'str', label: 'Item 28: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item28_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item28_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item29_description', type: 'str', label: 'Item 29: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item29_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item29_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item30_description', type: 'str', label: 'Item 30: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item30_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item30_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item31_description', type: 'str', label: 'Item 31: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item31_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item31_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item32_description', type: 'str', label: 'Item 32: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item32_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item32_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item33_description', type: 'str', label: 'Item 33: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item33_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item33_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item34_description', type: 'str', label: 'Item 34: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item34_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item34_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item35_description', type: 'str', label: 'Item 35: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item35_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item35_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item36_description', type: 'str', label: 'Item 36: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item36_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item36_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item37_description', type: 'str', label: 'Item 37: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item37_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item37_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item38_description', type: 'str', label: 'Item 38: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item38_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item38_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item39_description', type: 'str', label: 'Item 39: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item39_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item39_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item40_description', type: 'str', label: 'Item 40: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item40_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item40_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item41_description', type: 'str', label: 'Item 41: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item41_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item41_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item42_description', type: 'str', label: 'Item 42: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item42_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item42_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item43_description', type: 'str', label: 'Item 43: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item43_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item43_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item44_description', type: 'str', label: 'Item 44: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item44_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item44_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item45_description', type: 'str', label: 'Item 45: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item45_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item45_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item46_description', type: 'str', label: 'Item 46: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item46_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item46_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item47_description', type: 'str', label: 'Item 47: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item47_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item47_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item48_description', type: 'str', label: 'Item 48: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item48_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item48_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item49_description', type: 'str', label: 'Item 49: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item49_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item49_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    {name: 'mainMenu_item50_description', type: 'str', label: 'Item 50: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'mainMenu_item50_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'mainMenu_item50_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},

    // (hidden) menu
    {name: 'hiddenMenu', type: 'choice', label: '(3) ~~~~~~~~~~ SPECIAL (HIDDEN) TIP MENU ~~~~~~~~~~', required: false},
    {name: 'hiddenMenu_title', type: 'str', label: 'Menu title', defaultValue: DEFAULT_HIDDEN_MENU_TITLE, required: false},
    generateMenuColorThemeSettingsItem('hiddenMenu_colorTheme', 'Hidden menu color theme'),
    {name: 'hiddenMenu_customThemeColor', type: 'str', label: 'CUSTOM hidden menu theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('hiddenMenu_titleSeparator', 'Title separator'),
    generateEmojiSeparatorSettingsItem('hiddenMenu_itemSeparator', 'Item separator'),
    {name: 'hiddenMenu_style', type: 'choice', label: 'Style', choice1: MULTI_LINE, choice2: SINGLE_LINE, defaultValue: MULTI_LINE, required: false},
    {name: 'hiddenMenu_groupsAvailableTo', type: 'choice', label: 'Groups available to', defaultValue: GROUPS_NONE, required: false,
        choice1: GROUPS_NONE,
        choice2: GROUPS_MODS_ONLY,
        choice3: GROUPS_MODS_AND_FAN_CLUB_ONLY,
        choice4: GROUPS_FAN_CLUB_ONLY},
    {name: 'hiddenMenu_individualsAvailableTo', type: 'str', label: 'Individuals available to', defaultValue: '', required: false},
    {name: 'hiddenMenu_item1_description', type: 'str', label: 'Item 1: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item1_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item2_description', type: 'str', label: 'Item 2: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item2_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item3_description', type: 'str', label: 'Item 3: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item3_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item4_description', type: 'str', label: 'Item 4: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item4_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item5_description', type: 'str', label: 'Item 5: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item5_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item6_description', type: 'str', label: 'Item 6: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item6_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item7_description', type: 'str', label: 'Item 7: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item7_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item8_description', type: 'str', label: 'Item 8: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item8_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item9_description', type: 'str', label: 'Item 9: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item9_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item10_description', type: 'str', label: 'Item 10: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item10_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item11_description', type: 'str', label: 'Item 11: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item11_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item12_description', type: 'str', label: 'Item 12: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item12_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item13_description', type: 'str', label: 'Item 13: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item13_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item14_description', type: 'str', label: 'Item 14: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item14_price', type: 'int', label: 'Price', minValue: 1, required: false},
    {name: 'hiddenMenu_item15_description', type: 'str', label: 'Item 15: ~~~~~ Description', defaultValue: '', required: false},
    {name: 'hiddenMenu_item15_price', type: 'int', label: 'Price', minValue: 1, required: false},
];


// Cached data /////////////////////////////////////////////////////////////////

var moderators = [];
var fanClubMembers = [];


// Settings variables //////////////////////////////////////////////////////////

// notices
var general_colorTheme;
var general_textWeight;
var general_menuFrequency;
var general_moderatorNoticesFields;
var general_fanClubNoticesFields;
var general_defaultNoticesFields;

// main menu
var mainMenu_title;
var mainMenu_titleSeparator;
var mainMenu_itemSeparator;
var mainMenu_style;
var mainMenu_items = [];

// (hidden) menu
var hiddenMenu_title;
var hiddenMenu_colorTheme;
var hiddenMenu_titleSeparator;
var hiddenMenu_itemSeparator;
var hiddenMenu_style;
var hiddenMenu_groupsAvailableTo = [];
var hiddenMenu_individualsAvailableTo;
var hiddenMenu_items = [];


// Functions to unpack settings ////////////////////////////////////////////////

function getValueFromSettings(settingsKey, defaultValue) {
    var value = cb.settings[settingsKey];
    return value ? value : defaultValue;
}

function generateMenuTitle(title) {
    if (title.indexOf('%broadcaster%') > -1) {
        title = title.replace('%broadcaster%', cb.room_slug);
    }
    if (title.indexOf('%broadcaster_caps%') > -1) {
        title = title.replace('%broadcaster_caps%', capitalizeFirstLetters(cb.room_slug));
    }
    return title;
}

/**
 * Captializes the first letter in the string
 * and every letter following an underscore.
 */
function capitalizeFirstLetters(str) {
    var chars = str.split('');
    var capitalizeNext = true;
    for (var i = 0; i < str.length; i++) {
        if (capitalizeNext) {
            if (isLetter(chars[i])) {
                chars[i] = chars[i].toUpperCase();
            }
            capitalizeNext = false;
        }
        if (chars[i] == '_') {
            capitalizeNext = true;
        }
    }
    return chars.join('');
}

const isLetterRegex = /[a-z]/
function isLetter(ch) {
    return isLetterRegex.test(ch);
}

const HTML_COLOR_CODE_REGEX = /^#[0-9A-Za-z]{6}$/;
function isValidHtmlColorCode(value) {
    return HTML_COLOR_CODE_REGEX.test(value);
}

function getNoticesFields(thankYouMessageKey, defaultThankYouMessage,
                          tippedForMessageKey, defaultTippedForMessage,
                          colorThemeKey, customThemeColorKey,
                          messageSeparatorKey,
                          noticeType) {
    const thankYouMessage = getValueFromSettings(thankYouMessageKey, defaultThankYouMessage);
    const tippedForMessage = getValueFromSettings(tippedForMessageKey, defaultTippedForMessage);
    const colorThemeChoice = String(cb.settings[colorThemeKey]);
    var colorTheme;
    if (colorThemeChoice == GENERAL_COLOR_THEME) {
        colorTheme = general_colorTheme;
    } else { // CUSTOM
        var customThemeColor = getValueFromSettings(customThemeColorKey, null);
        if (!isValidHtmlColorCode(customThemeColor) && customThemeColor !== null) {
            cb.sendNotice('Invalid color theme ame: \'' + customThemeColor + '\'.  Defaulting to the general color theme for ' + noticeType + ' notices.');
            colorTheme = general_colorTheme;
        } else {
            colorTheme = new ColorTheme(customThemeColor);
        }
    }
    const separator = getEmoji(messageSeparatorKey);
    return new NoticesFields(thankYouMessage, tippedForMessage, colorTheme, separator);
}

/**
 * Extracts a color theme from the settings.  If an HTML color code for a
 * custom theme is invalid, then the default theme is used instead.
 */
function getColorTheme(colorThemeNameKey, customColorKey) {
    const themeName = String(cb.settings[colorThemeNameKey]);
    var colorTheme;
    if (themeName == CUSTOM_COLOR_THEME) {
        var color = String(cb.settings[customColorKey]);
        if (!isValidHtmlColorCode(color)) {
            cb.sendNotice('Invalid HTML color code: \'' + color + '\'.  Defaulting to \'' + DEFAULT_NAMED_COLOR_THEME.name + '\' color theme.')
            colorTheme = DEFAULT_NAMED_COLOR_THEME.colorTheme;
        } else {
            colorTheme = new ColorTheme(color);
        }
    } else {
        var namedColorTheme = NAMED_COLOR_THEMES.find(theme => theme.name == themeName);
        if (!namedColorTheme) {
            cb.sendNotice('Invalid color theme name: \'' + themeName + '\'.  Defaulting to \'' + DEFAULT_NAMED_COLOR_THEME.name + '\' color theme.')
            namedColorTheme = DEFAULT_NAMED_COLOR_THEME;
        }
        colorTheme = namedColorTheme.colorTheme;
    }
    return colorTheme;
}

function splitCommaSeparatedUsernames(str) {
    str = str.trim();
    if (!str) {
        return [];
    }
    var array = str.toLowerCase().split(',');
    array.forEach((value, index, _) => {
        array[index] = value.trim();
    });
    return array;
}


// Initialize the bot //////////////////////////////////////////////////////////
// - unpack the settings
// - start sending the menus
// - warm the moderator and fan club members caches

function init() {
    // notices
    general_colorTheme = getColorTheme('general_colorTheme', 'general_customThemeColor');
    general_textWeight = String(cb.settings['general_textWeight']).toLowerCase();
    general_menuFrequency = cb.settings.general_menuFrequency;
    general_moderatorNoticesFields = getNoticesFields(
        'general_moderatorThankYouMessage', DEFAULT_MOD_THANK_YOU_MESSAGE,
        'general_moderatorTippedForMessage', DEFAULT_MOD_TIPPED_FOR_MESSAGE,
        'general_moderatorNoticesColorTheme', 'general_moderatorNoticesCustomThemeColor',
        'general_moderatorMessagesSeparator',
        'moderator'
    );
    general_fanClubNoticesFields = getNoticesFields(
        'general_fanClubThankYouMessage', DEFAULT_FAN_CLUB_THANK_YOU_MESSAGE,
        'general_fanClubTippedForMessage', DEFAULT_FAN_CLUB_TIPPED_FOR_MESSAGE,
        'general_fanClubNoticesColorTheme', 'general_fanClubNoticesCustomThemeColor',
        'general_fanClubMessagesSeparator',
        'fan club'
    );
    general_defaultNoticesFields = getNoticesFields(
        'general_defaultThankYouMessage', DEFAULT_BASIC_THANK_YOU_MESSAGE,
        'general_defaultTippedForMessage', DEFAULT_BASIC_TIPPED_FOR_MESSAGE,
        'general_defaultNoticesColorTheme', 'general_defaultNoticesCustomThemeColor',
        'general_defaultMessagesSeparator',
        'default'
    );

    // main menu
    mainMenu_title = generateMenuTitle(getValueFromSettings('mainMenu_title', DEFAULT_MAIN_MENU_TITLE));
    mainMenu_titleSeparator = getEmoji('mainMenu_titleSeparator');
    mainMenu_itemSeparator = getEmoji('mainMenu_itemSeparator');;
    mainMenu_style = cb.settings['mainMenu_style'];
    for (var i = 1; i <= 50; i++) {
        var description  = String(cb.settings['mainMenu_item' + i + '_description']);
        var isEnabled    = !description.startsWith('--');
        var price        = cb.settings['mainMenu_item' + i + '_price'];
        var fanClubPrice = cb.settings['mainMenu_item' + i + '_fanClubPrice'];
        if (description && isEnabled && (price || fanClubPrice)) {
            mainMenu_items.push(new MainMenuItem(description, isEnabled, price, fanClubPrice));
        }
    }
    mainMenu_items.sort((left, right) => {
        return left.price - right.price;
    });
    
    // (hidden) menu
    hiddenMenu_title = generateMenuTitle(getValueFromSettings('hiddenMenu_title', DEFAULT_HIDDEN_MENU_TITLE));
    hiddenMenu_colorTheme = getColorTheme('hiddenMenu_colorTheme', 'hiddenMenu_customThemeColor');
    hiddenMenu_titleSeparator = getEmoji('hiddenMenu_titleSeparator');
    hiddenMenu_itemSeparator = getEmoji('hiddenMenu_itemSeparator');
    hiddenMenu_style = cb.settings['hiddenMenu_style'];
    var groupsAvailableTo = String(cb.settings['hiddenMenu_groupsAvailableTo']);
    if (groupsAvailableTo == 'Mods only') {
        hiddenMenu_groupsAvailableTo.push(MODS);
    } else if (groupsAvailableTo == 'Mods and fan club only') {
        hiddenMenu_groupsAvailableTo.push(MODS);
        hiddenMenu_groupsAvailableTo.push(FAN_CLUB);
    } else if (groupsAvailableTo == 'Fan club only') {
        hiddenMenu_groupsAvailableTo.push(FAN_CLUB);
    }
    hiddenMenu_individualsAvailableTo = splitCommaSeparatedUsernames(String(cb.settings['hiddenMenu_individualsAvailableTo']));
    for (var i = 1; i <= 15; i++) {
        var description = String(cb.settings['hiddenMenu_item' + i + '_description']);
        var isEnabled   = !description.startsWith('--');
        var price       = cb.settings['hiddenMenu_item' + i + '_price'];
        if (description && isEnabled && price) {
            hiddenMenu_items.push(new HiddenMenuItem(description, isEnabled, price));
        }
    }
    hiddenMenu_items.sort((left, right) => {
        return left.price - right.price;
    });

    sendMenusAndRepeat();

    warmCaches();
}

function getMatchingMainMenuItems(price, isFanClubMember) {
    return mainMenu_items.filter(item => {
        if (isFanClubMember) {
            return item.fanClubPrice == price;
        }
        return item.price == price;
    });
}

function getMatchingHiddenMenuItems(price) {
    return hiddenMenu_items.filter(item => item.price == price);
}

function getEmoji(settingsKey) {
    var value = cb.settings[settingsKey];
    if (value == 'RANDOM') {
        return null;
    } else {
        return EMOJIS.find(item => item.name == value);
    }
}

function getRandomEmoji() {
    return EMOJIS[Math.floor(Math.random() * EMOJIS.length)];
}


// Send menus functions ////////////////////////////////////////////////////////

function sendMenusAndRepeat() {
    sendMenus();
    cb.setTimeout(sendMenusAndRepeat, general_menuFrequency * 60000);
}

function sendMenus(users = []) {
    const mainMenuMessages = generatemainMenuMessages();
    const hiddenMenuMessages = generateHiddenMenuMessages();

    if (users.length > 0) {
        users.forEach(user => {
            cb.setTimeout(() => cb.sendNotice(mainMenuMessages.titleMessage, user, general_colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight), NOTICE_DELAY);
            cb.setTimeout(() => cb.sendNotice(mainMenuMessages.itemsMessage, user, '', general_colorTheme.color, general_textWeight), NOTICE_DELAY * 2);
            cb.setTimeout(() => cb.sendNotice(mainMenuMessages.footerMessage, user, '', '', general_textWeight), NOTICE_DELAY * 3);
            if (hiddenMenuMessages && userCanAccessHiddenMenu(user)) {
                cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.titleMessage, user, hiddenMenu_colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight), NOTICE_DELAY * 4);
                cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.itemsMessage, user, '', hiddenMenu_colorTheme.color, general_textWeight), NOTICE_DELAY * 5);
                cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.footerMessage, user, '', '', general_textWeight), NOTICE_DELAY * 6);
            }
        });
    } else {
        cb.setTimeout(() => cb.sendNotice(mainMenuMessages.titleMessage, '', general_colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight), NOTICE_DELAY);
        cb.setTimeout(() => cb.sendNotice(mainMenuMessages.itemsMessage, '', '', general_colorTheme.color, general_textWeight), NOTICE_DELAY * 2);
        cb.setTimeout(() => cb.sendNotice(mainMenuMessages.footerMessage, '', '', '', general_textWeight), NOTICE_DELAY * 3);

        if (hiddenMenuMessages) {
            // send to Broadcaster
            cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.titleMessage, cb.room_slug, hiddenMenu_colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight), NOTICE_DELAY * 4);
            cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.itemsMessage, cb.room_slug, '', hiddenMenu_colorTheme.color, general_textWeight), NOTICE_DELAY * 5);

            // maybe send to mods
            if (hiddenMenu_groupsAvailableTo.includes(MODS)) {
                cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.titleMessage, '', hiddenMenu_colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight, 'red'), NOTICE_DELAY * 4);
                cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.itemsMessage, '', '', hiddenMenu_colorTheme.color, general_textWeight, 'red'), NOTICE_DELAY * 5);
                cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.footerMessage, '', '', '', general_textWeight, 'red'), NOTICE_DELAY * 6);
            }

            // maybe send to fan club
            if (hiddenMenu_groupsAvailableTo.includes(FAN_CLUB)) {
                cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.titleMessage, '', hiddenMenu_colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight, 'green'), NOTICE_DELAY * 7);
                cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.itemsMessage, '', '', hiddenMenu_colorTheme.color, general_textWeight, 'green'), NOTICE_DELAY * 8);
                cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.footerMessage, '', '', '', general_textWeight, 'green'), NOTICE_DELAY * 9);
            }

            // send to individuals
            hiddenMenu_individualsAvailableTo.forEach(user => {
                // don't double send the hidden menu
                if ((hiddenMenu_groupsAvailableTo.includes(MODS) && !moderators.includes(user)) &&
                    (hiddenMenu_groupsAvailableTo.includes(FAN_CLUB) && !fanClubMembers.includes(user))) {
                    cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.titleMessage, user, hiddenMenu_colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight), NOTICE_DELAY * 10);
                    cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.itemsMessage, user, '', hiddenMenu_colorTheme.color, general_textWeight), NOTICE_DELAY * 11);
                    cb.setTimeout(() => cb.sendNotice(hiddenMenuMessages.footerMessage, user, '', '', general_textWeight), NOTICE_DELAY * 12);
                }
            });
        }
    }
}

function generatemainMenuMessages() {
    const titleSeparator = mainMenu_titleSeparator == null ? getRandomEmoji() : mainMenu_titleSeparator;
    const itemSeparator = mainMenu_itemSeparator == null ? getRandomEmoji() : mainMenu_itemSeparator;
    const titleMessage = titleSeparator.code + ' ' + mainMenu_title + ' ' + titleSeparator.code;
    var itemsMessage = '';
    const isSingleLine = mainMenu_style == SINGLE_LINE;

    mainMenu_items.forEach(value => {
        if (value.description && value.isEnabled && (value.price || value.fanClubPrice)) {
            if (itemsMessage.length > 0) {
                itemsMessage += isSingleLine ? ' ' : '\n';
            }
            itemsMessage += itemSeparator.code + ' ' + value.description + ' (';
            if (value.price) {
                itemsMessage += value.price;
                if (value.fanClubPrice) {
                    itemsMessage += ' -- ';
                }
            }
            if (value.fanClubPrice) {
                itemsMessage += ':FC10-Smoker ' + value.fanClubPrice;
            }
            itemsMessage += ')'
        }
    });

    return new MenuMessages(titleMessage, itemsMessage, MAIN_MENU_FOOTER);
}

function generateHiddenMenuMessages() {
    if (hiddenMenu_items.length == 0) {
        return null;
    }

    const titleSeparator = hiddenMenu_titleSeparator == null ? getRandomEmoji() : hiddenMenu_titleSeparator;
    const itemSeparator = hiddenMenu_itemSeparator == null ? getRandomEmoji() : hiddenMenu_itemSeparator;
    const titleMessage = titleSeparator.code + ' ' + hiddenMenu_title + ' ' + titleSeparator.code;
    var itemsMessage = '';
    const isSingleLine = hiddenMenu_style == SINGLE_LINE;

    hiddenMenu_items.forEach((value) => {
        if (value.description && value.isEnabled && value.price) {
            if (itemsMessage.length > 0) {
                itemsMessage += isSingleLine ? ' ' : '\n';
            }
            itemsMessage += itemSeparator.code + ' ' + value.description + ' (' + value.price + ')'
        }
    });

    return new MenuMessages(titleMessage, itemsMessage, HIDDEN_MENU_FOOTER);
}

function tippingUserCanAccessHiddenMenu(tip) {
    return (tip['from_user_is_mod'] && hiddenMenu_groupsAvailableTo.includes(MODS)) ||
        (tip['from_user_in_fanclub'] && hiddenMenu_groupsAvailableTo.includes(FAN_CLUB)) ||
        hiddenMenu_individualsAvailableTo.includes(tip['from_user']);
}

function userCanAccessHiddenMenu(user) {
    return (hiddenMenu_groupsAvailableTo.includes(MODS) && moderators.includes(user)) ||
        (hiddenMenu_groupsAvailableTo.includes(FAN_CLUB) && fanClubMembers.includes(user)) ||
        hiddenMenu_individualsAvailableTo.includes(user);
}

function generateThankYouMessage(tip, thankYouMessage, separator) {
    while (thankYouMessage.indexOf('%separator%') > -1) {
        thankYouMessage = thankYouMessage.replace('%separator%', separator);
    }
    while (thankYouMessage.indexOf('%username%') > -1) {
        thankYouMessage = thankYouMessage.replace('%username%', tip['is_anon_tip'] ? 'anonymous user' : tip['from_user']);
    }
    while (thankYouMessage.indexOf('%tip_amount%') > -1) {
        thankYouMessage = thankYouMessage.replace('%tip_amount%', tip['amount'] == 1 ? '1 token' : tip['amount'] + ' tokens');
    }
    return thankYouMessage;
}

function generateTippedForMessage(tip, tippedForMessage, separator, value) {
    while (tippedForMessage.indexOf('%separator%') > -1) {
        tippedForMessage = tippedForMessage.replace('%separator%', separator);
    }
    while (tippedForMessage.indexOf('%username%') > -1) {
        tippedForMessage = tippedForMessage.replace('%username%', tip['is_anon_tip'] ? 'anonymous user' : tip['from_user']);
    }
    while (tippedForMessage.indexOf('%tip_amount%') > -1) {
        tippedForMessage = tippedForMessage.replace('%tip_amount%', tip['amount'] == 1 ? '1 token' : tip['amount'] + ' tokens');
    }
    while (tippedForMessage.indexOf('%tipmenuitem_description%') > -1) {
        tippedForMessage = tippedForMessage.replace('%tipmenuitem_description%', value.description);
    }
    return tippedForMessage;
}

function warmCaches() {
    cb.getRoomUsersData(usersData => {
        if (usersData['success']) {
            moderators = usersData['data']['moderator'];
            fanClubMembers = usersData['data']['fanclub'];
        } else {
            cb.sentNotice('Request to get room users data failed: ' + usersData['errorMessage']);
        }
    });
}


// CB callbacks ////////////////////////////////////////////////////////////////

cb.onTip(tip => {
    var noticesFields;
    if (tip['is_anon_tip']) {
        noticesFields = general_defaultNoticesFields;
    } else if (tip['from_user_is_mod']) {
        noticesFields = general_moderatorNoticesFields;
    } else if (tip['from_user_in_fanclub']) {
        noticesFields = general_fanClubNoticesFields;
    } else {
        noticesFields = general_defaultNoticesFields;
    }

    // send thank you message to all users
    var separator = noticesFields.separator ? noticesFields.separator.code : getRandomEmoji().code;
    var message = generateThankYouMessage(tip, noticesFields.thankYouMessage, separator);
    cb.sendNotice(message, '', noticesFields.colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight);

    // send tipped for message(s) to all users
    var hiddenTipMessage = '';
    if (tippingUserCanAccessHiddenMenu(tip)) {
        var matchingHiddenMenuItems = getMatchingHiddenMenuItems(tip['amount']);
        if (matchingHiddenMenuItems) {
            matchingHiddenMenuItems.forEach(value => {
                if (hiddenTipMessage.length > 0) {
                    hiddenTipMessage += '\n';
                }
                if (!noticesFields.separator) {
                    separator = getRandomEmoji().code;
                }
                hiddenTipMessage += generateTippedForMessage(tip, noticesFields.tippedForMessage, separator, value);
            });
        }
    }
    if (hiddenTipMessage) {
        cb.sendNotice(hiddenTipMessage, '', hiddenMenu_colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight);
    }

    var mainTipMessage = '';
    var matchingMainMenuItems = getMatchingMainMenuItems(tip['amount'], tip['from_user_in_fanclub'])
    if (matchingMainMenuItems) {
        matchingMainMenuItems.forEach(value => {
            if (mainTipMessage.length > 0) {
                mainTipMessage += '\n';
            }
            if (!noticesFields.separator) {
                separator = getRandomEmoji().code;
            }
            mainTipMessage += generateTippedForMessage(tip, noticesFields.tippedForMessage, separator, value);
        });
    }
    if (mainTipMessage) {
        cb.sendNotice(mainTipMessage, '', noticesFields.colorTheme.color, DEFAULT_TEXT_COLOR, general_textWeight);
    }
});

cb.onEnter(user => {
    if (user['user'] !== cb.room_slug) {
        cb.sendNotice(SEPARATOR_LINE + '\nWelcome, ' + user['user'] + '!\nType \'/menu\' to see the tip menu\n' + SEPARATOR_LINE, user['user'], '', '', general_textWeight);
    }
    if (user['is_mod']) {
        if (!moderators.includes(user['user'])) {
            moderators.push(user['user']);
        }
    }
    if (user['in_fanclub']) {
        if (!fanClubMembers.includes(user['user'])) {
            fanClubMembers.push(user['user']);
        }
    }
})

cb.onLeave(user => {
    if (user['is_mod']) {
        if (moderators.includes(user['user'])) {
            moderators = cbjs.arrayRemove(moderators, user['user']);
        }
    }
    if (user['in_fanclub']) {
        if (fanClubMembers.includes(user['user'])) {
            fanClubMembers = cbjs.arrayRemove(fanClubMembers, user['user']);
        }
    }
})

const ADD_TO_HIDDEN_MENU_REGEX = /^\/hidden-add (Mods|Fans|\@[a-z0-9_]+)$/;
const REMOVE_FROM_HIDDEN_MENU_REGEX = /^\/hidden-remove (Mods|Fans|\@[a-z0-9_]+)$/;
const SEND_MENUS_TO_USERS_CMD = /^\/menu( \@[a-z0-9_]+)+$/;

function addToHiddenMenu(groupOrUser) {
    switch (groupOrUser) {
        case 'Mods':
            if (!hiddenMenu_groupsAvailableTo.includes(MODS)) {
                hiddenMenu_groupsAvailableTo.push(MODS);
            }
            break;
        case 'Fans':
            if (!hiddenMenu_groupsAvailableTo.includes(FAN_CLUB)) {
                hiddenMenu_groupsAvailableTo.push(FAN_CLUB);
            }
            break;
        default:
            var user = groupOrUser.slice(1); // remove @
            if (!hiddenMenu_individualsAvailableTo.includes(user)) {
                hiddenMenu_individualsAvailableTo.push(user);
            }
    }
}

function removeFromHiddenMenu(groupOrUser) {
    switch (groupOrUser) {
        case 'Mods':
            if (hiddenMenu_groupsAvailableTo.includes(MODS)) {
                hiddenMenu_groupsAvailableTo = cbjs.arrayRemove(hiddenMenu_groupsAvailableTo, MODS);
            }
            break;
        case 'Fans':
            if (hiddenMenu_groupsAvailableTo.includes(FAN_CLUB)) {
                hiddenMenu_groupsAvailableTo = cbjs.arrayRemove(hiddenMenu_groupsAvailableTo, FAN_CLUB);
            }
            break;
        default:
            var user = groupOrUser.slice(1);
            if (hiddenMenu_individualsAvailableTo.includes(user)) {
                hiddenMenu_individualsAvailableTo = cbjs.arrayRemove(hiddenMenu_individualsAvailableTo, user);
            }
    }
}

cb.onMessage(message => {
    // broadcaster only commands
    const msg = message['m'].trim();
    if (message['user'] == cb.room_slug) {
        // grant moderators or fan club members or individuals access to the hidden menu
        if (ADD_TO_HIDDEN_MENU_REGEX.test(msg)) {
            var toAdd = msg.split(' ')[1];
            addToHiddenMenu(toAdd);
            if (toAdd.startsWith('@')) {
                toAdd = toAdd.slice(1);
            }
            message['X-Spam'] = true;
            message['m'] = msg + ' (' + toAdd + ' was granted access to ' + hiddenMenu_title +')';
        // revoke moderators' or fan club members' or individuals' access to the hidden menu
        } else if (REMOVE_FROM_HIDDEN_MENU_REGEX.test(msg)) {
            var toRemove = msg.split(' ')[1];
            removeFromHiddenMenu(toRemove);
            if (toRemove.startsWith('@')) {
                toRemove = toRemove.slice(1);
            }
            message['X-Spam'] = true;
            message['m'] = msg + ' (' + toRemove + '\'s access to ' + hiddenMenu_title + ' was revoked)';
        // list which groups and individuals have access to the hidden menu
        } else if (msg == '/hidden-list') {
            message['X-Spam'] = true;
            message['m'] = msg + ' (groups: {' + hiddenMenu_groupsAvailableTo + '}; individuals: {' + hiddenMenu_individualsAvailableTo + '})';
        }
    }
    // broadcaster and mod commands
    if (message['user'] == cb.room_slug || message['is_mod']) {
        // send the menu(s) to everyone in the roon
        if (msg == '/menu') {
            sendMenus();
            message['m'] = msg + ' (' + message['user'] + ' sent the tip menu to everyone in the room)';
        // send the menu(s) to specific people
        } else if (SEND_MENUS_TO_USERS_CMD.test(msg)) {
            var usersStr = msg.slice(msg.indexOf(' ') + 1);
            var usersArray = usersStr.split(' ');
            usersArray.forEach((value, index, _) => {
                usersArray[index] = value.slice(1);
            });
            sendMenus(usersArray);
            message['m'] = msg + ' (' + message['user'] + ' sent the tip menu to ' + usersArray + ')';
        // list the moderators and fan club members currently in the room
        } else if (msg == '/groups-list') {
            message['X-Spam'] = true;
            message['m'] = msg + ' (Mods: {' + moderators + '}; Fans: {' + fanClubMembers + '})';
        }
    // commands for other users
    } else {
        // send menu(s) to the poster
        if (msg == '/menu') {
            sendMenus([message['user']]);
            message['m'] = msg + ' (the tip menu was sent to ' + message['user'] + ')';
        }
    }
    // commands for everyone
    if (msg == '/help') {
        const separator = getRandomEmoji();
        const indent = '    ';
        var helpMsg = SEPARATOR_LINE + '\n';
        helpMsg += separator.code + ' Smoker\'s Multiphasic Tip Menu (v0.1) ' + separator.code + '\n';
        helpMsg += 'The following commands are available:\n';
        helpMsg += SEPARATOR_LINE + '\n';
        helpMsg += 'For broadcasters only:\n';
        helpMsg += indent + '/hidden-add <group or @user> - add a group (Mods or Fans) or an individual to the hidden menu\n';
        helpMsg += indent + '/hidden-remove <group or @user> - remove a group (Mods or Fans) or an individual from the hidden menu\n';
        helpMsg += indent + '/hidden-list - list the groups and individuals who have access to the hidden menu\n';
        helpMsg += SEPARATOR_LINE + '\n';
        helpMsg += 'For broadcasters and moderators:\n';
        helpMsg += indent + '/menu - send the tip menu to everyone in the room\n';
        helpMsg += indent + '/menu @<user_1> @<user_2> ... @<user_n> - send the tip menu to the specified users\n';
        helpMsg += indent + '/groups-list - list the moderators and fan club members currently in the room\n'
        helpMsg += SEPARATOR_LINE + '\n';
        helpMsg += 'For everyone else:\n';
        helpMsg += indent + '/menu - send the tip menu to yourself\n';
        helpMsg += SEPARATOR_LINE + '\n';
        helpMsg += 'For everyone:\n';
        helpMsg += indent + '/help - send this message to yourself\n';
        helpMsg += SEPARATOR_LINE;
        cb.sendNotice(helpMsg, message['user']);
        message['m'] = msg + ' (the help message was sent to ' + message['user'] + ')';
    }
    return message;
});


// Initialize the bot //////////////////////////////////////////////////////////

init();