Chaturbate

Bots Home | Create an App
Smoker's Beginner Bot - Alpha
Author: smoker919
Description Source Code Launch Bot Current Users
There are 7 other versions of this script.
////////////////////////////////////////////////////////////////////////////////
// S M O K E R ' S   B E G I N N E R   B O T
// by Smoker919
//
// The open-source alternative to all-in-one bots for beginner broadcasters
////////////////////////////////////////////////////////////////////////////////


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

// counts
const MAX_WELCOME_MESSAGE_LINES           = 5;
const MAX_NEW_FOLLOWER_MESSAGE_LINES      = 2;
const MAX_ON_TIP_MESSAGE_LINES            = 2;
const MAX_ON_FAN_CLUB_JOIN_MESSAGE_LINES  = 2;
const MAX_ON_MEDIA_PURCHASE_MESSAGE_LINES = 2;
const MAX_NOTICES                         = 20;
const MAX_TIP_MENU_ITEMS                  = 50;
const MAX_ALT_TIP_MENU_ITEMS              = 15;
const SPIN_THE_WHEEL_PRIZE_COUNT          = 12;

const YES = 'Yes';
const NO  = 'No';

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

const DEFAULT_TEXT_COLOR = 'White';

const NOTICE_DELAY = 175;

// placeholders
const SEPARATOR_PLACEHOLDER                 = '%separator%';
const BROADCASTER_PLACEHOLDER               = '%broadcaster%';
const USERNAME_PLACEHOLDER                  = '%username%';
const MEDIA_TYPE_PLACEHOLDER                = '%media_type%';
const MEDIA_NAME_PLACEHOLDER                = '%media_name%';
const TIP_AMOUNT_PLACEHOLDER                = '%tip_amount%';
const TIP_MENU_ITEM_DESCRIPTION_PLACEHOLDER = '%tipmenuitem_description%';

// default messages
const DEFAULT_WELCOME_MESSAGE           = ''; // TODO
const DEFAULT_NEW_FOLLOWER_MESSAGE      = 'Thank you ' + SEPARATOR_PLACEHOLDER + USERNAME_PLACEHOLDER + SEPARATOR_PLACEHOLDER + ' for following me';
const DEFAULT_ON_TIP_MESSAGE            = 'Thank you ' + SEPARATOR_PLACEHOLDER + USERNAME_PLACEHOLDER + SEPARATOR_PLACEHOLDER + ' for tipping';
const DEFAULT_ON_FAN_CLUB_JOIN_MESSAGE  = 'Thank you ' + SEPARATOR_PLACEHOLDER + USERNAME_PLACEHOLDER + SEPARATOR_PLACEHOLDER + ' for joining my fan club';
const DEFAULT_ON_MEDIA_PURCHASE_MESSAGE = 'Thank you ' + SEPARATOR_PLACEHOLDER + USERNAME_PLACEHOLDER + SEPARATOR_PLACEHOLDER + ' for purchasing my ' + MEDIA_TYPE_PLACEHOLDER + ' ' + MEDIA_NAME_PLACEHOLDER;
const DEFAULT_TIPPED_FOR_MESSAGE        = USERNAME_PLACEHOLDER + ' tipped for ' + SEPARATOR_PLACEHOLDER + TIP_MENU_ITEM_DESCRIPTION_PLACEHOLDER + SEPARATOR_PLACEHOLDER;

// notice titles
const DEFAULT_LEADERBOARD_TITLE        = SEPARATOR_PLACEHOLDER + ' ' + BROADCASTER_PLACEHOLDER + '\'s Leaderboard ' + SEPARATOR_PLACEHOLDER;
const DEFAULT_TIP_MENU_TITLE           = SEPARATOR_PLACEHOLDER + ' ' + BROADCASTER_PLACEHOLDER + '\'s Tip Menu ' + SEPARATOR_PLACEHOLDER;
const DEFAULT_SECONDARY_TIP_MENU_TITLE = SEPARATOR_PLACEHOLDER + ' ' + BROADCASTER_PLACEHOLDER + '\'s Secondary Tip Menu ' + SEPARATOR_PLACEHOLDER;

// tip menu styles
const MULTI_LINE  = 'Multi line';
const SINGLE_LINE = 'Single line';

// help message sepataor
const SEPARATOR_LINE = '\u2014'.repeat(24);


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

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

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

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

class UserTipSummary {
    constructor(user) {
        this.user = user;
        this.regularTipsTotal = 0;
        this.regularTipsLastTime = undefined;
        this.allTipsTotal = 0;
        this.allTipsLastTime = undefined;
    }

    addTip(amount, time, anonymous) {
        if (!anonymous) {
            this.regularTipsTotal += amount;
            this.regularTipsLastTime = time;
        }
        this.allTipsTotal += amount;
        this.allTipsLastTime = time;
    }
}

class TipMenuItem {
    constructor(description, enabled, price, fanClubPrice) {
        this.description = description;
        this.enabled = enabled;
        this.price = price;
        this.fanClubPrice = fanClubPrice;
    }
}


// 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 generateColorThemeSettingsItem(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 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: '(0) ~~~~~ GENERAL ~~~~~', required: false},
    generateColorThemeSettingsItem('general_defaultColorTheme', GENERAL_COLOR_THEME),
    {name: 'general_defaultCustomThemeColor', type: 'str', label: 'CUSTOM general theme color', defaultValue: '', required: false},
    {name: 'general_defaultTextWeight', type: 'choice', label: 'Text weight', choice1: 'Normal', choice2: 'Bold', defaultValue: 'Bold', required: false},
    {name: 'general_modWhispersEnabled', type: 'choice', label: 'Moderator whispers enabled', choice1: YES, choice2: NO, defaultValue: NO, required: false},

    // welcome message
    {name: 'welcomeMessage_enabled', type: 'choice', label: '(1) ~~~~~ WELCOME Message: ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    generateColorThemeSettingsItem('welcomeMessage_colorTheme', 'Color theme'),
    {name: 'welcomeMessage_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('welcomeMessage_separator', 'Separator'),
    {name: 'welcomeMessage_line1', type: 'str', label: 'Message: ~~~~~ Line 1', defaultValue: '', required: false},
    {name: 'welcomeMessage_line2', type: 'str', label: 'Line 2', defaultValue: '', required: false},
    {name: 'welcomeMessage_line3', type: 'str', label: 'Line 3', defaultValue: '', required: false},
    {name: 'welcomeMessage_line4', type: 'str', label: 'Line 4', defaultValue: '', required: false},
    {name: 'welcomeMessage_line5', type: 'str', label: 'Line 5', defaultValue: '', required: false},

    // new follower message
    {name: 'newFollowerMessage_enabled', type: 'choice', label: '(2) ~~~~~ NEW FOLLOWER Message: ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    generateColorThemeSettingsItem('newFollowerMessage_colorTheme', 'Color theme'),
    {name: 'newFollowerMessage_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('newFollowerMessage_separator', 'Separator'),
    {name: 'newFollowerMessage_line1', type: 'str', label: 'Message: ~~~~~ Line 1', defaultValue: DEFAULT_NEW_FOLLOWER_MESSAGE, required: false},
    {name: 'newFollowerMessage_line2', type: 'str', label: 'Line 2', defaultValue: '', required: false},

    // on tip message
    {name: 'onTipMessage_enabled', type: 'choice', label: '(3) ~~~~~ ON TIP Message: ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'onTipMessage_minimumTip', type: 'int', label: 'Minimum tip', minValue: 1, defaultValue: 1, required: false},
    generateColorThemeSettingsItem('onTipMessage_colorTheme', 'Color theme'),
    {name: 'onTipMessage_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('onTipMessage_separator', 'Separator'),
    {name: 'onTipMessage_line1', type: 'str', label: 'Message: ~~~~~  Line 1', defaultValue: DEFAULT_ON_TIP_MESSAGE, required: false},
    {name: 'onTipMessage_line2', type: 'str', label: 'Line 2', defaultValue: '', required: false},

    // on fan club join message
    {name: 'onFanClubJoinMessage_enabled', type: 'choice', label: '(4) ~~~~~ ON FAN CLUB JOIN Message: ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    generateColorThemeSettingsItem('onFanClubJoinMessage_colorTheme', 'Color theme'),
    {name: 'onFanClubJoinMessage_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('onFanClubJoin_separator', 'Separator'),
    {name: 'onFanClubJoinMessage_line1', type: 'str', label: 'Message: ~~~~~ Line 1', defaultValue: DEFAULT_ON_FAN_CLUB_JOIN_MESSAGE, required: false},
    {name: 'onFanClubJoinMessage_line2', type: 'str', label: 'Line 2', defaultValue: '', required: false},

    // on media purchase message
    {name: 'onMediaPurchaseMessage_enabled', type: 'choice', label: '(5) ~~~~~ ON MEDIA Purchase Message: ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    generateColorThemeSettingsItem('onMediaPurchaseMessage_colorTheme', 'Color theme'),
    {name: 'onMediaPurchaseMessage_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('onMediaPurchase_separator', 'Separator'),
    {name: 'onMediaPurchaseMessage_line1', type: 'str', label: 'Message: ~~~~~ Line 1', defaultValue: DEFAULT_ON_MEDIA_PURCHASE_MESSAGE, required: false},
    {name: 'onMediaPurchaseMessage_line2', type: 'str', label: 'Line 2', defaultValue: '', required: false},
];

// leaderboard
cb.settings_choices.push(
    {name: 'leaderboard_enabled', type: 'choice', label: '(6) ~~~~~ LEADERBOARD ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'leaderboard_noticeFrequency', type: 'int', label: 'Notice frequency (minutes)', minValue: 1, maxValue: 10, defaultValue: 5, required: false},
    {name: 'leaderboard_maxLength', type: 'int', label: 'Max length', minValue: 3, maxValue: 10, defaultValue: 5, required: false},
    {name: 'leaderboard_title', type: 'str', label: 'Title', defaultValue: DEFAULT_LEADERBOARD_TITLE, required: false},
    generateEmojiSeparatorSettingsItem('leaderboard_titleSeparator', 'Title separator'),
    generateEmojiSeparatorSettingsItem('leaderboard_itemSeparator', 'Item separator'),
    generateColorThemeSettingsItem('leaderboard_colorTheme', 'Color theme'),
    {name: 'leaderboard_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
    generateEmojiSeparatorSettingsItem('leaderboard_separator', 'Separator'),
);

// notices
cb.settings_choices.push(
    {name: 'notices_enabled', type: 'choice', label: '(7) ~~~~~ NOTICES ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'notices_frequency', type: 'int', label: 'Frequency (minutes)', minValue: 1, maxValue: 10, defaultValue: 2, required: false},
    generateColorThemeSettingsItem('notices_colorTheme', 'Color theme'),
    {name: 'notices_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
);
for (var i = 1; i <= MAX_NOTICES; i++) {
    cb.settings_choices.push(
        {name: 'notices_notice' + i, type: 'str', label: 'Notice ' + i, defaultValue: '', required: false},
    );
}

// tip menu
cb.settings_choices.push(
    {name: 'tipMenu_enabled', type: 'choice', label: '(8) ~~~~~ TIP MENU ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'tipMenu_title', type: 'str', label: 'Title', defaultValue: DEFAULT_TIP_MENU_TITLE, required: false},
    generateEmojiSeparatorSettingsItem('tipMenu_titleSeparator', 'Title separator'),
    generateEmojiSeparatorSettingsItem('tipMenu_itemSeparator', 'Item separator'),
    {name: 'tipMenu_style', type: 'choice', label: 'Style', choice1: MULTI_LINE, choice2: SINGLE_LINE, defaultValue: MULTI_LINE, required: false},
    generateColorThemeSettingsItem('tipMenu_colorTheme', 'Color theme'),
    {name: 'tipMenu_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
    {name: 'tipMenu_onTipMessage', type: 'str', label: 'On tip message', defaultValue: DEFAULT_TIPPED_FOR_MESSAGE, required: false},
);
for (var i = 1; i <= MAX_TIP_MENU_ITEMS; i++) {
    cb.settings_choices.push(
        {name: 'tipMenu_item' + i + '_description', type: 'str', label: 'Item ' + i + ': ~~~~~ Description', defaultValue: '', required: false},
        {name: 'tipMenu_item' + i + '_price', type: 'int', label: 'Price', minValue: 1, required: false},
        {name: 'tipMenu_item' + i + '_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    );
}

// secondary tip menu
cb.settings_choices.push(
    {name: 'tipMenu2_enabled', type: 'choice', label: '(9) ~~~~~ SECONDARY TIP MENU ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'tipMenu2_title', type: 'str', label: 'Title', defaultValue: DEFAULT_TIP_MENU_TITLE, required: false}, // TODO
    generateEmojiSeparatorSettingsItem('tipMenu_titleSeparator', 'Title separator'),
    generateEmojiSeparatorSettingsItem('tipMenu_itemSeparator', 'Item separator'),
    {name: 'tipMenu2_style', type: 'choice', label: 'Style', choice1: MULTI_LINE, choice2: SINGLE_LINE, defaultValue: MULTI_LINE, required: false},
    generateColorThemeSettingsItem('tipMenu_colorTheme', 'Color theme'),
    {name: 'tipMenu2_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
    {name: 'tipMenu2_onTipMessage', type: 'str', label: 'On tip message', defaultValue: DEFAULT_TIPPED_FOR_MESSAGE, required: false},
);
for (var i = 1; i <= MAX_ALT_TIP_MENU_ITEMS; i++) {
    cb.settings_choices.push(
        {name: 'tipMenu2_item' + i + '_description', type: 'str', label: 'Item ' + i + ': ~~~~~ Description', defaultValue: '', required: false},
        {name: 'tipMenu2_item' + i + '_price', type: 'int', label: 'Price', minValue: 1, required: false},
        {name: 'tipMenu2_item' + i + '_fanClubPrice', type: 'int', label: 'Fan club price', minValue: 1, required: false},
    );
}

// hidden show controls
cb.settings_choices.push(
    {name: 'hiddenShow_enabled', type: 'choice', label: '(10) ~~~~~ HIDDEN SHOW CONTROLS ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'hiddenShow_modsCanControl', type: 'choice', label: 'Moderators can control', choice1: YES, choice2: NO, defaultValue: YES, required: false},
);

// spin the wheel
cb.settings_choices.push(
    {name: 'wheel_enabled', type: 'choice', label: '(11) ~~~~~ SPIN THE WHEEL ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'wheel_pricePerSpin', type: 'int', label: 'Price per spin', minValue: 1, defaultValue: 1, required: false},
    {name: 'wheel_maxSpinsPerTip', type: 'int', label: 'Max spins per tip', minValue: 1, maxValue: 3, defaultValue: 1, required: false},
    {name: 'wheel_uniquePrizesForMultipleSpins', type: 'choice', label: 'Unique prizes for multiple spins', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'wheel_noticeFrequency', type: 'int', label: 'Notice frequency (minutes)', minValue: 1, maxValue: 60, defaultValue: 5, required: false}, // TODO: maybe 2, 5, 10, 15, 30, 60
    generateColorThemeSettingsItem('wheel_colorTheme', 'Color theme'),
    {name: 'wheel_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
);
for (var i = 1; i <= SPIN_THE_WHEEL_PRIZE_COUNT; i++) {
    cb.settings_choices.push({name: 'wheel_prize' + i, type: 'str', label: 'Prize #' + i, required: false});
}

// roll the dice
cb.settings_choices.push(
    {name: 'dice_enabled', type: 'choice', label: '(12) ~~~~~ ROLL THE DICE ~~~~~', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'dice_pricePerRoll', type: 'int', label: 'Price per roll', minValue: 1, defaultValue: 25, required: false},
    {name: 'dice_maxRollsPerTip', type: 'int', label: 'Max rolls per tip', minValue: 1, maxValue: 3, defaultValue: 1, required: false},
    {name: 'dice_uniquePrizesForMultipleRolls', type: 'choice', label: 'Unique prizes for multiple rolls', choice1: YES, choice2: NO, defaultValue: NO, required: false},
    {name: 'dice_rollsToActivateRarePrize', type: 'int', label: 'Rolls to activate rare prize', minValue: 0, defaultValue: 50, required: false},
    {name: 'dice_rarePrizeChance', type: 'int', label: 'Rare prize chance once activated, 1 in', minValue: 1, defaultValue: 200, required: false},
    {name: 'dice_noticeFrequency', type: 'int', label: 'Notice frequency (minutes)', minValue: 1, maxValue: 60, defaultValue: 5, required: false}, // TODO: maybe 2, 5, 10, 15, 30, 60
    {name: 'dice_winnersToRetain', type: 'int', label: 'Winners to retain', minValue: 10, maxValue:100, defaultValue: 15, required: false},
    generateColorThemeSettingsItem('dice_colorTheme', 'Color theme'),
    {name: 'dice_customThemeColor', type: 'str', label: 'CUSTOM theme color', defaultValue: '', required: false},
    {name: 'dice_prize2', type: 'str', label: 'Prize for 2 (2.78%)', required: false},
    {name: 'dice_prize3', type: 'str', label: 'Prize for 3 (5.56%)', required: false},
    {name: 'dice_prize4', type: 'str', label: 'Prize for 4 (8.33%)', required: false},
    {name: 'dice_prize5', type: 'str', label: 'Prize for 5 (11.11%)', required: false},
    {name: 'dice_prize6', type: 'str', label: 'Prize for 6 (13.89%', required: false},
    {name: 'dice_prize7', type: 'str', label: 'Prize for 7 (16.67%)', required: false},
    {name: 'dice_prize8', type: 'str', label: 'Prize for 8 (13.89%', required: false},
    {name: 'dice_prize9', type: 'str', label: 'Prize for 9 (11.11%)', required: false},
    {name: 'dice_prize10', type: 'str', label: 'Prize for 10 (8.33%)', required: false},
    {name: 'dice_prize11', type: 'str', label: 'Prize for 11 (5.56%)', required: false},
    {name: 'dice_prize12', type: 'str', label: 'Prize for 12 (2.78%)', required: false},
    {name: 'dice_rarePrize', type: 'str', label: 'Rare prize (empty for none)', required: false},
);


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

// new follower statistics
var startingFollowers;

// leaderboard
var userTipSummaries = [];


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

// general
var general_defaultColorTheme;
var general_defaultTextWeight;
var general_modWhispersEnabled;

// welcome message
var welcomeMessage_enabled;
var welcomeMessage_colorTheme;
var welcomeMessage_separator;
var welcomeMessage_message;

// new follower message
var newFollowerMessage_enabled;
var newFollowerMessage_colorTheme;
var newFollowerMessage_separator;
var newFollowerMessage_message;

// on tip message
var onTipMessage_enabled;
var onTipMessage_minimumTip;
var onTipMessage_colorTheme;
var onTipMessage_separator;
var onTipMessage_message;

// on fan club join message
var onFanClubJoinMessage_enabled;
var onFanClubJoinMessage_colorTheme;
var onFanClubJoinMessage_separator;
var onFanClubJoinMessage_message;

// on media purchase message
var onMediaPurchaseMessage_enabled;
var onMediaPurchaseMessage_colorTheme;
var onMediaPurchaseMessage_separator;
var onMediaPurchaseMessage_message;

// leaderboard
var leaderboard_enabled;
var leaderboard_noticeFrequency;
var leaderboard_maxLength;
var leaderboard_titleSeparator; 
var leaderboard_title; 
var leaderboard_itemSeparator; 
var leaderboard_colorTheme;
var leaderboard_separator;

// notices
var notices_enabled;
var notices_frequency;
var notices_colorTheme;
var notices_notices;
var notices_nextNoticeIndex = 0;

// tip menu
var tipMenu_enabled;
var tipMenu_titleSeparator;
var tipMenu_title;
var tipMenu_itemSeparator;
var tipMenu_style;
var tipMenu_colorTheme;
var tipMenu_onTipMessage;
var tipMenu_items = [];

// secondary tip menu
var tipMenu2_enabled;
var tipMenu2_titleSeparator;
var tipMenu2_title;
var tipMenu2_itemSeparator;
var tipMenu2_style;
var tipMenu2_colorTheme;
var tipMenu2_onTipMessage;
var tipMenu2_items = [];

// hidden show
var hiddenShow_enabled;
var hiddenShow_modsCanControl;

// spin the wheel
var wheel_enabled;
var wheel_pricePerSpin;
var wheel_maxSpinsPerTip;
var wheel_uniquePrizesForMultipleSpins;
var wheel_colorTheme;
var wheel_customColorTheme;
var wheel_prizes = [];

// roll the dice
var dice_enabled;
var dice_pricePerRoll;
var dice_maxRollsPerTip;
var dice_uniquePrizesForMultipleRolls;
var dice_rollsToActivateRarePrize;
var dice_rarePrizeChance;
var dice_colorTheme;
var dice_customColorTheme;
var dice_prizes = [];
var dice_rare_prize;


// Function to unpack the settings /////////////////////////////////////////////

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

/**
 * 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 getColorThemeFromSettings(colorThemeNameKey, customThemeColorKey) {
    const colorThemeName = String(cb.settings[colorThemeNameKey]);
    var colorTheme;
    if (colorThemeName == CUSTOM_COLOR_THEME) {
        var themeColor = String(cb.settings[customThemeColorKey]);
        if (!isValidHtmlColorCode(color)) {
            cb.sendNotice('Invalid HTML color code: \'' + themeColor + '\'.  Defaulting to \'' + DEFAULT_NAMED_COLOR_THEME.name + '\' color theme.')
            colorTheme = DEFAULT_NAMED_COLOR_THEME.colorTheme;
        } else {
            colorTheme = new ColorTheme(themeColor);
        }
    } else {
        var namedColorTheme = NAMED_COLOR_THEMES.find(theme => theme.name == colorThemeName);
        if (!namedColorTheme) {
            cb.sendNotice('Invalid color theme name: \'' + colorThemeName + '\'.  Defaulting to \'' + DEFAULT_NAMED_COLOR_THEME.name + '\' color theme.')
            namedColorTheme = DEFAULT_NAMED_COLOR_THEME;
        }
        colorTheme = namedColorTheme.colorTheme;
    }
    return colorTheme;
}

function generateTitle(message, separator) {
    if (!separator) {
        separator = getRandomEmoji();
    }
    while (message.indexOf(SEPARATOR_PLACEHOLDER) > -1) {
        message = message.replace(SEPARATOR_PLACEHOLDER, separator.unicode);
    }
    if (message.indexOf(BROADCASTER_PLACEHOLDER) > -1) {
        message = message.replace(BROADCASTER_PLACEHOLDER, capitalizeFirstLetters(cb.room_slug));
    }
    return message;
}

/**
 * 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);
}

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

function generateMultiLineMessageFromSettings(maxLines, settingsKeyPrefix, defaultMessage) {
    var message = '';
    for (var i = 1; i <= maxLines; i++) {
        var key = settingsKeyPrefix + i;
        if (cb.settings[key]) {
            if (message) {
                message += '\n';
            }
            message += cb.settings[key];
        }
    }
    return message ? message : defaultMessage;
}


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

function init() {
    // general
    general_defaultColorTheme = getColorThemeFromSettings('general_defaultColorTheme', 'general_defaultTextWeight');
    general_defaultTextWeight = String(cb.settings.general_defaultTextWeight).toLowerCase();
    general_modWhispersEnabled = cb.settings.general_modWhispersEnabled;

    // welcome message
    welcomeMessage_enabled = String(cb.settings.welcomeMessage_enabled) == YES;
    welcomeMessage_colorTheme = getColorThemeFromSettings('welcomeMessage_colorTheme', 'welcomeMessage_customThemeColor');
    welcomeMessage_separator = getEmoji('welcomeMessage_separator');
    generateMultiLineMessageFromSettings(MAX_WELCOME_MESSAGE_LINES, 'welcomeMessage_line', DEFAULT_WELCOME_MESSAGE);

    // new follower message
    newFollowerMessage_enabled = String(cb.settings.newFollowerMessage_enabled) == YES;
    newFollowerMessage_colorTheme = getColorThemeFromSettings('newFollowerMessage_colorTheme', 'newFollowerMessage_customThemeColor');
    newFollowerMessage_separator = getEmoji('newFollowerMessage_separator');
    generateMultiLineMessageFromSettings(MAX_NEW_FOLLOWER_MESSAGE_LINES, 'newFollowerMessage_line', DEFAULT_NEW_FOLLOWER_MESSAGE);

    // on tip message
    onTipMessage_enabled = String(cb.settings.onTipMessage_enabled) == YES;
    onTipMessage_minimumTip = cb.settings.onTipMessage_minimumTip;
    onTipMessage_colorTheme = getColorThemeFromSettings('onTipMessage_colorTheme', 'onTipMessage_customThemeColor');
    onTipMessage_separator = getEmoji('onTipMessage_separator');
    generateMultiLineMessageFromSettings(MAX_ON_TIP_MESSAGE_LINES, 'onTipMessage_line', DEFAULT_ON_TIP_MESSAGE);

    // on fan club join message
    onFanClubJoinMessage_enabled = String(cb.settings.onFanClubJoinMessage_enabled) == YES;
    onFanClubJoinMessage_colorTheme = getColorThemeFromSettings('onFanClubJoinMessage_colorTheme', 'onFanClubJoinMessage_customThemeColor');
    onFanClubJoinMessage_separator = getEmoji('onFanClubJoinMessage_separator');
    generateMultiLineMessageFromSettings(MAX_ON_FAN_CLUB_JOIN_MESSAGE_LINES, 'onFanClubJoinMessage_line', DEFAULT_ON_FAN_CLUB_JOIN_MESSAGE);

    // on purchase media message
    onMediaPurchaseMessage_enabled = String(cb.settings.onMediaPurchaseMessage_enabled) == YES;
    onMediaPurchaseMessage_colorTheme = getColorThemeFromSettings('onMediaPurchaseMessage_colorTheme', 'onMediaPurchaseMessage_customThemeColor');
    onMediaPurchaseMessage_separator = getEmoji('onMediaPurchaseMessage_separator');
    generateMultiLineMessageFromSettings(MAX_ON_MEDIA_PURCHASE_MESSAGE_LINES, 'onMediaPurchaseMessage_line', DEFAULT_ON_MEDIA_PURCHASE_MESSAGE);

    // notices
    notices_enabled = String(cb.settings.notices_enabled) == YES;
    notices_frequency = cb.settings.notices_frequency * 60 * 1000;
    notices_colorTheme = getColorThemeFromSettings('notices_colorTheme', 'notices_customThemeColor');
    for (var i = 1; i <= 20; i++) {
        // don't include empty notices
        if (cb.settings['notices_notices' + i]) {
            notices_notices.push(cb.settings['notices_notices' + i]);
        }
    }
    
    // leaderboard
    leaderboard_enabled = String(cb.settings['leaderboard_enabled']) == YES;
    leaderboard_noticeFrequency = cb.settings['leaderboard_noticeFrequency'] * 60 * 1000;
    leaderboard_maxLength = cb.settings['leaderboard_maxLength'];
    leaderboard_title = String(cb.settings.leaderboard_title);
    leaderboard_titleSeparator = getEmoji('leaderboard_titleSeparator'); 
    leaderboard_itemSeparator = getEmoji('leaderboard_itemSeparator'); 
    leaderboard_colorTheme = getColorThemeFromSettings('leaderboard_colorTheme', 'leaderboard_customThemeColor');
    leaderboard_separator = getEmoji('leaderboard_itemSeparator');
    // TODO: generate static leaderboard notice if separator is not random

    // tip menu
    tipMenu_enabled = String(cb.settings.tipMenu_enabled) == YES;
    tipMenu_title = cb.settings.tipMenu_title; 
    tipMenu_titleSeparator = String(getEmoji('tipMenu_titleSeparator'));
    tipMenu_itemSeparator = getEmoji('tipMenu_itemSeparator');
    tipMenu_style = String(cb.settings.tipMenu_style);
    tipMenu_colorTheme = getColorThemeFromSettings('tipMenu_colorTheme', 'tipMenu_customThemeColor');
    tipMenu_onTipMessage = getValueFromSettings('tipMenu_onTipMessage', DEFAULT_TIPPED_FOR_MESSAGE);
    for (var i = 1; i <= MAX_TIP_MENU_ITEMS; i++) {
        const description  = String(cb.settings['tipMenu_item' + i + '_description']);
        const enabled      = description.startsWith('--');
        const price        = 'tipMenu_item' + i + '_price';
        const fanClubPrice = 'tipMenu_item' + i + '_fanClubPrice';
        if (description && enabled && (price || fanClubPrice)) {
            tipMenu_items.push(new TipMenuItem(description, enabled, price, fanClubPrice));
        }
    }
    sortMenuItems(tipMenu_items);
    // TODO: generate static tip menu notice if separator is not random
    
    // secondary tip menu
    tipMenu2_enabled = String(cb.settings.tipMenu2_enabled) == YES;
    tipMenu2_title = cb.settings.tipMenu2_title; 
    tipMenu2_titleSeparator = getEmoji('tipMenu2_titleSeparator');
    tipMenu2_itemSeparator = getEmoji('tipMenu2_itemSeparator');
    tipMenu2_style = String(cb.settings.tipMenu2_style);
    tipMenu2_colorTheme = getColorThemeFromSettings('tipMenu2_colorTheme', 'tipMenu2_customThemeColor');
    tipMenu2_onTipMessage = getValueFromSettings('tipMenu2_onTipMessage', DEFAULT_TIPPED_FOR_MESSAGE);
    for (var i = 1; i <= MAX_ALT_TIP_MENU_ITEMS; i++) {
        const description  = String(cb.settings['tipMenu2_item' + i + '_description']);
        const enabled      = description.startsWith('--');
        const price        = 'tipMenu2_item' + i + '_price';
        const fanClubPrice = 'tipMenu2_item' + i + '_fanClubPrice';
        if (description && enabled && (price || fanClubPrice)) {
            tipMenu2_items.push(new TipMenuItem(description, enabled, price, fanClubPrice));
        }
    }
    sortMenuItems(tipMenu2_items);
    // TODO: generate static tip menu notice if separator is not random
    
    // hidden show
    hiddenShow_enabled = String(cb.settings['hiddenShow_enabled']) == YES;
    hiddenShow_modsCanControl = String(cb.settings.hiddenShow_modsCanControl) == YES;

    // spin the wheel
    // TODO

    // roll the dice
    // TODO

    // get initial follower count
    cb.getRoomOwnerData(ownerData => {
        if (ownerData['success']) {
            startingFollowers = ownerData['followers'];
        }
    });


    // leaderboard
    if (leaderboard_enabled) {
        scheduleNextLeaderboardNotice();
    }
    
    
    if (tipMenu_enabled && tipMenu_items) {
        initTipMenuNotices();
    }



    if (notices_enabled) {
        initNoticesNotices();
    }

}

function scheduleAndSendLeaderboardNotice() {
    scheduleNextLeaderboardNotice();
    sendLeaderboardNotice();
}

function scheduleNextLeaderboardNotice() {
    cb.setTimeout(scheduleAndSendLeaderboardNotice, leaderboard_noticeFrequency);
}

function sendLeaderboardNotice() {
    sendLeaderboardNoticeTo('');
}

function sendLeaderboardNoticeTo(toUser) {
    const isBroadcaster = toUser == cb.room_slug;

    cb.sendNotice('XXXXX summaries: ' + JSON.stringify(userTipSummaries));
    var summariesClone = userTipSummaries.map(a => {return {...a}});
    cb.sendNotice('XXXXX summaries clone: ' + JSON.stringify(summariesClone));

    summariesClone.sort((left, right) => {
        if (isBroadcaster) {
            if (left.allTipsTotal == right.allTipsTotal) {
                return left.allTipsLastTime - right.regularTipsLastTime;
            } else {
                return right.allTipsTotal - left.allTipsTotal;
            }
        } else {
            if (left.regularTipsTotal == right.regularTipsTotal) {
                return left.regularTipsLastTime - right.regularTipsLastTime;
            } else {
                return right.regularTipsTotal - left.regularTipsTotal;
            }
        }
    });

    var leaderboardTitle = generateTitle(leaderboard_title, leaderboard_titleSeparator);

    var noticeText = '';
    for (var i = 0, len = Math.min(leaderboard_maxLength, summariesClone.length); i < len; i++) {
        if (noticeText.length > 0) {
            noticeText += '\n';
        }
        noticeText += (i + 1) + '. ' + summariesClone[i].user + ': ' + (isBroadcaster ? summariesClone[i].allTipsTotal : summariesClone[i].regularTipsTotal);
    }

    cb.sendNotice(leaderboardTitle, toUser, leaderboard_colorTheme.color, DEFAULT_TEXT_COLOR, general_defaultTextWeight);
    cb.sendNotice(noticeText, toUser, '', leaderboard_colorTheme.color, general_defaultTextWeight);
}


function initTipMenuNotices() {
    // TODO
}

function initNoticesNotices() {
    // TODO
}


// Other functions /////////////////////////////////////////////////////////////


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

function getMatchingTipMenuItems(amount) {
    return tipMenu_items.filter(item => {
        return item.amount == amount;
    });
}


function getRandomEmojiSeparator() {
    return emojiSeparators[Math.floor(Math.random() * emojiSeparators.length)];
}


function sendTipMenu() {
    var titleMessage = tipMenu_titleSeparator + ' ' + tipMenu_title + ' ' + tipMenu_titleSeparator + '\u00A0';
    var itemsMessage = '';
    var isSingleLine = tipMenu_style == 'Single line';
    tipMenu_items.forEach((value) => {
        if (value.description && value.amount && value.isEnabled == YES) {
            if (itemsMessage.length > 0) {
                itemsMessage += isSingleLine ? ' ' : '\n';
            }
            itemsMessage += tipMenu_itemSeparator + ' ' + value.description + ' (' + value.amount + ')'
            if (!isSingleLine) {
                itemsMessage += '\u00A0';
            }
        }
    });
    if (isSingleLine) {
        itemsMessage += '\u00A0';
    }
    cb.sendNotice(titleMessage, '', general_defaultColorTheme.colorTheme.color, DEFAULT_TEXT_COLOR, general_defaultTextWeight);
    cb.sendNotice(itemsMessage, '','', general_defaultColorTheme.colorTheme.color, general_defaultTextWeight);
}

/**
 * Captializes the first character in the string if is a letter,
 * and then 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 IS_LETTER_REGEX = /[a-z]/

function isLetter(ch) {
    return IS_LETTER_REGEX.test(ch);
}

function generateUsername(username) {
    return capitalizeFirstLetters(username);
}

function sortMenuItems(menuItems) {
    menuItems.sort((left, right) => {
        if (left.price && right.price) {
            return left.price - right.price;
        } else if (left.price) {
            return left.price - right.fanClubPrice;
        } else if (right.price) {
            return left.fanClubPrice - right.price;
        } else {
            return left.fanClubPrice - right.fanClubPrice;
        }
    });
}


// CB callback handlers ////////////////////////////////////////////////////////

function onEnterHandler(user) {
    if (welcomeMessage_enabled) {
        // send welcome message to user
        var message = welcomeMessage_message.replace('%username%', user['user']);
        cb.sendNotice(message, user['user'], welcomeMessage_colorTheme.colorTheme.color, DEFAULT_TEXT_COLOR, general_defaultTextWeight);
    }
}

function onFollowHandler(user) {
    if (newFollowerMessage_enabled) {
        // send new follower message to all users
        var message = generateNewFollowerMessage(user['user']);
        cb.sendNotice(message, '', newFollowerMessage_colorTheme.colorTheme.color, DEFAULT_TEXT_COLOR, general_defaultTextWeight);
    }
}

function generateNewFollowerMessage(user) {
    var message = newFollowerMessage_message;
    if (message.indexOf(USERNAME_PLACEHOLDER) > -1) {
        message = message.replace(USERNAME_PLACEHOLDER, generateUsername(user));
    }
    return message;
}

function onTipHandler(tip) {
    if (leaderboard_enabled) {
        cb.sendNotice('XXXXX summaries before recording tip: ' + JSON.stringify(userTipSummaries));
        // record the tip
        const now = new Date().getTime();
        var summary = userTipSummaries.find(value => value.user = tip['from_user']);
        cb.sendNotice('XXXXX summary found: ' + summary);
        if (summary) {
            cb.sendNotice('XXXXX 1');
            summary.addTip(tip['amount'], now, tip['is_anon_tip']);
        } else {
            cb.sendNotice('XXXXX 2');
            summary = new UserTipSummary(tip['from_user'], tip['amount'], now, tip['is_anon_tip']);
            summary.addTip(tip['amount'], now, tip['is_anon_tip']);
            userTipSummaries.push(summary);
        }
        cb.sendNotice('XXXXX summaries after recording tip: ' + JSON.stringify(userTipSummaries));
    }
    if (onTipMessage_enabled) {
        // send thank you message to all users
        var message = generateOnTipMessage();
        cb.sendNotice(message, '', onTipMessage_colorTheme.colorTheme.color, DEFAULT_TEXT_COLOR, general_defaultTextWeight);
    }
    if (tipMenu_enabled) {
        var matchingTipMenuItems = getMatchingTipMenuItems(tip['amount'])
        if (matchingTipMenuItems) {
            // send tip message to all users
            var message = '';
            matchingTipMenuItems.forEach((value) => {
                if (message.length > 0) {
                    message += '\n';
                }
                var separator = getRandomEmojiSeparator().code;
                message += tipMenu_onTipMessage
                    .replace('%username%', tip['is_anon_tip'] ? 'anonymous user' : tip['from_user'])
                    .replace('%tip_amount%', tip['amount'] == 1 ? '1 token' : tip['amount'] + ' tokens')
                    .replace('%separator%', separator)
                    .replace('%separator%', separator)
                    .replace('%tipmenuitem_description%', value.description)
                    + '\u00A0';
                });
            cb.sendNotice(message, '', tipMenu_colorTheme.colorTheme.color, DEFAULT_TEXT_COLOR, general_defaultTextWeight);
        }
    }
}

function generateOnTipMessage(tip) {
    var separator = onTipMessage_separator ? onTipMessage_separator : getRandomEmojiSeparator().code;
    var message = onTipMessage_message;
    while (message.indexOf(SEPARATOR_PLACEHOLDER) > -1) {
        message = message.replace(SEPARATOR_PLACEHOLDER, separator);
    }
    if (message.indexOf(USERNAME_PLACEHOLDER) > -1) {
        message = message.replace(USERNAME_PLACEHOLDER, tip['is_anon_tip'] ? 'anonymous user' : generateUsername(tip['from_user']));
    }
    if (message.indexOf(TIP_AMOUNT_PLACEHOLDER) > -1) {
        message = message.replace(TIP_AMOUNT_PLACEHOLDER, tip['amount'] == 1 ? '1 token' : tip['amount'] + ' tokens');
    }
    return message;
}

function fanClubJoinHandler(user) {
    if (onFanClubJoinMessage_enabled) {
        // send thank you message to all users
        var message = generateJoiningFanClubMessage(user['user']);
        cb.sendNotice(message, '', newFollowerMessage_colorTheme.colorTheme.color, DEFAULT_TEXT_COLOR, general_defaultTextWeight);
    }
}

function generateJoiningFanClubMessage(user) {
    var message = onFanClubJoinMessage_onFanClubJoinedMessage;
    if (message.indexOf(USERNAME_PLACEHOLDER) > -1) {
        message = message.replace(USERNAME_PLACEHOLDER, generateUsername(user));
    }
    return message;
}

function onMediaPurchaseHandler(user, media) {
    if (onMediaPurchaseMessage_enabled) {
        // send thank you message to all users
        var message = generateMediaPurchaseMessage(user['user'], media['type'], media['name']);
        cb.sendNotice(message, '', onMediaPurchaseMessage_colorTheme.colorTheme.color, DEFAULT_TEXT_COLOR, general_defaultTextWeight);
    }
}

function generateMediaPurchaseMessage(user, mediaType, mediaName) {
    var message = onMediaPurchaseMessage_message;
    while (message.indexOf(SEPARATOR_PLACEHOLDER) > -1) {
        message = message.replace(SEPARATOR_PLACEHOLDER, onMediaPurchaseMessage_separator);
    }
    if (message.indexOf(USERNAME_PLACEHOLDER) > -1) {
        message = message.replace(USERNAME_PLACEHOLDER, generateUsername(user));
    }
    if (message.indexOf(MEDIA_TYPE_PLACEHOLDER) > -1) {
        message = message.replace(MEDIA_TYPE_PLACEHOLDER, mediaType);
    }
    if (message.indexOf(MEDIA_NAME_PLACEHOLDER) > -1) {
        message = message.replace(MEDIA_NAME_PLACEHOLDER, mediaName);
    }
    return message;
}

const HIDDEN_SHOW_REGEX = /^(\/hs|\/hiddenshow) (start|stop|add( [a-z0-9_]+)+|remove( [a-z0-9_]+)+|list|status)$/;

const NOTICES_REGEX = /^(\/menu|\/wheel|\/help)( [a-z0-9_]+)?$/;

function onMessageHandler(message) {
    var msg = message['m'].trim();
    if (tipMenu_enabled) {
        if (msg == '/menu') {
            sendTipMenu();
        }
    }
    // if (ticketShow_enabled) {

    // }

    // if (whispers_enabled) {
    //     if (msg.indexOf('/psst ') == 0) {

    //     }
    // }
    return message;
}

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

cb.onEnter(onEnterHandler);

cb.onFollow(onFollowHandler);

cb.onTip(onTipHandler);

cb.onFanclubJoin(fanClubJoinHandler);

cb.onMediaPurchase(onMediaPurchaseHandler);

cb.onMessage(onMessageHandler);


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

init();