Chaturbate

Apps Home | Create an App
Tip Menu IQ
Author: jjay543
Description Source Code Launch App Current Users
Created by: Jjay543
There are 7 other versions of this script.
/**
 * Name: Tip Menu IQ
 * Author: jjay543
 * Version: 0.31
 *
 * Phase 1:
 * - Configurable tip menu
 * - Up to 40 menu items
 * - Display menu in chat
 * - Match incoming tips to menu items by amount
 * - Track matched, unmatched, and ambiguous tips during the session
 * - Display notice when a user tips for a menu item
 *
 * Later phases:
 * - Store matched tip activity in $kv
 * - Analytics
 * - Price recommendations
 * - User segmentation
 * - Export/reporting
 */

// -----------------------------
// Settings
// -----------------------------

cb.settings_choices = [
    {
        name: 'menu_title',
        label: 'Menu Title',
        type: 'str',
        required: true,
        minLength: 1,
        maxLength: 80,
        defaultValue: 'Tip Menu'
    },
    {
        name: 'menu_notice_interval',
        label: 'Menu Notice Interval in minutes. Set to 0 to disable automatic menu notices.',
        type: 'int',
        required: true,
        minValue: 0,
        maxValue: 60,
        defaultValue: 5
    },
    {
        name: 'menu_footer',
        label: 'Menu Footer / Extra Text',
        type: 'str',
        required: false,
        minLength: 0,
        maxLength: 300,
        defaultValue: 'Type /menu or /tipmenu to see the tip menu.'
    },

    {name: 'menu_item_1_label', label: 'Menu Item #1 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: 'Thumbs Up'},
    {name: 'menu_item_1_amount', label: 'Menu Item #1 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 25},

    {name: 'menu_item_2_label', label: 'Menu Item #2 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_2_amount', label: 'Menu Item #2 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_3_label', label: 'Menu Item #3 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_3_amount', label: 'Menu Item #3 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_4_label', label: 'Menu Item #4 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_4_amount', label: 'Menu Item #4 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_5_label', label: 'Menu Item #5 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_5_amount', label: 'Menu Item #5 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_6_label', label: 'Menu Item #6 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_6_amount', label: 'Menu Item #6 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_7_label', label: 'Menu Item #7 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_7_amount', label: 'Menu Item #7 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_8_label', label: 'Menu Item #8 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_8_amount', label: 'Menu Item #8 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_9_label', label: 'Menu Item #9 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_9_amount', label: 'Menu Item #9 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_10_label', label: 'Menu Item #10 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_10_amount', label: 'Menu Item #10 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_11_label', label: 'Menu Item #11 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_11_amount', label: 'Menu Item #11 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_12_label', label: 'Menu Item #12 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_12_amount', label: 'Menu Item #12 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_13_label', label: 'Menu Item #13 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_13_amount', label: 'Menu Item #13 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_14_label', label: 'Menu Item #14 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_14_amount', label: 'Menu Item #14 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_15_label', label: 'Menu Item #15 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_15_amount', label: 'Menu Item #15 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_16_label', label: 'Menu Item #16 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_16_amount', label: 'Menu Item #16 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_17_label', label: 'Menu Item #17 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_17_amount', label: 'Menu Item #17 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_18_label', label: 'Menu Item #18 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_18_amount', label: 'Menu Item #18 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_19_label', label: 'Menu Item #19 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_19_amount', label: 'Menu Item #19 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_20_label', label: 'Menu Item #20 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_20_amount', label: 'Menu Item #20 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_21_label', label: 'Menu Item #21 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_21_amount', label: 'Menu Item #21 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_22_label', label: 'Menu Item #22 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_22_amount', label: 'Menu Item #22 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_23_label', label: 'Menu Item #23 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_23_amount', label: 'Menu Item #23 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_24_label', label: 'Menu Item #24 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_24_amount', label: 'Menu Item #24 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_25_label', label: 'Menu Item #25 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_25_amount', label: 'Menu Item #25 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_26_label', label: 'Menu Item #26 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_26_amount', label: 'Menu Item #26 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_27_label', label: 'Menu Item #27 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_27_amount', label: 'Menu Item #27 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_28_label', label: 'Menu Item #28 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_28_amount', label: 'Menu Item #28 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_29_label', label: 'Menu Item #29 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_29_amount', label: 'Menu Item #29 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_30_label', label: 'Menu Item #30 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_30_amount', label: 'Menu Item #30 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_31_label', label: 'Menu Item #31 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_31_amount', label: 'Menu Item #31 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_32_label', label: 'Menu Item #32 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_32_amount', label: 'Menu Item #32 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_33_label', label: 'Menu Item #33 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_33_amount', label: 'Menu Item #33 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_34_label', label: 'Menu Item #34 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_34_amount', label: 'Menu Item #34 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_35_label', label: 'Menu Item #35 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_35_amount', label: 'Menu Item #35 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_36_label', label: 'Menu Item #36 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_36_amount', label: 'Menu Item #36 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_37_label', label: 'Menu Item #37 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_37_amount', label: 'Menu Item #37 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_38_label', label: 'Menu Item #38 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_38_amount', label: 'Menu Item #38 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_39_label', label: 'Menu Item #39 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_39_amount', label: 'Menu Item #39 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0},

    {name: 'menu_item_40_label', label: 'Menu Item #40 - Description', type: 'str', required: false, minLength: 0, maxLength: 100, defaultValue: ''},
    {name: 'menu_item_40_amount', label: 'Menu Item #40 - Token Amount', type: 'int', required: false, minValue: 0, maxValue: 99999, defaultValue: 0}
];

// -----------------------------
// Variables
// -----------------------------

var APP_NAME = 'Tip Menu IQ';
var APP_VERSION = '0.31';
var NOTICE_COLOR = '#f4d599';
var ERROR_COLOR = '#f4c1bc';

var menuItems = [];

var matchedTipCount = 0;
var unmatchedTipCount = 0;
var ambiguousTipCount = 0;

var matchedTokenTotal = 0;
var unmatchedTokenTotal = 0;
var ambiguousTokenTotal = 0;

var totalTipCount = 0;
var totalTokenCount = 0;

// -----------------------------
// Functions
// -----------------------------

function loadMenuItems() {
    menuItems = [];

    addMenuItem(1, cb.settings.menu_item_1_label, cb.settings.menu_item_1_amount);
    addMenuItem(2, cb.settings.menu_item_2_label, cb.settings.menu_item_2_amount);
    addMenuItem(3, cb.settings.menu_item_3_label, cb.settings.menu_item_3_amount);
    addMenuItem(4, cb.settings.menu_item_4_label, cb.settings.menu_item_4_amount);
    addMenuItem(5, cb.settings.menu_item_5_label, cb.settings.menu_item_5_amount);
    addMenuItem(6, cb.settings.menu_item_6_label, cb.settings.menu_item_6_amount);
    addMenuItem(7, cb.settings.menu_item_7_label, cb.settings.menu_item_7_amount);
    addMenuItem(8, cb.settings.menu_item_8_label, cb.settings.menu_item_8_amount);
    addMenuItem(9, cb.settings.menu_item_9_label, cb.settings.menu_item_9_amount);
    addMenuItem(10, cb.settings.menu_item_10_label, cb.settings.menu_item_10_amount);
    addMenuItem(11, cb.settings.menu_item_11_label, cb.settings.menu_item_11_amount);
    addMenuItem(12, cb.settings.menu_item_12_label, cb.settings.menu_item_12_amount);
    addMenuItem(13, cb.settings.menu_item_13_label, cb.settings.menu_item_13_amount);
    addMenuItem(14, cb.settings.menu_item_14_label, cb.settings.menu_item_14_amount);
    addMenuItem(15, cb.settings.menu_item_15_label, cb.settings.menu_item_15_amount);
    addMenuItem(16, cb.settings.menu_item_16_label, cb.settings.menu_item_16_amount);
    addMenuItem(17, cb.settings.menu_item_17_label, cb.settings.menu_item_17_amount);
    addMenuItem(18, cb.settings.menu_item_18_label, cb.settings.menu_item_18_amount);
    addMenuItem(19, cb.settings.menu_item_19_label, cb.settings.menu_item_19_amount);
    addMenuItem(20, cb.settings.menu_item_20_label, cb.settings.menu_item_20_amount);
    addMenuItem(21, cb.settings.menu_item_21_label, cb.settings.menu_item_21_amount);
    addMenuItem(22, cb.settings.menu_item_22_label, cb.settings.menu_item_22_amount);
    addMenuItem(23, cb.settings.menu_item_23_label, cb.settings.menu_item_23_amount);
    addMenuItem(24, cb.settings.menu_item_24_label, cb.settings.menu_item_24_amount);
    addMenuItem(25, cb.settings.menu_item_25_label, cb.settings.menu_item_25_amount);
    addMenuItem(26, cb.settings.menu_item_26_label, cb.settings.menu_item_26_amount);
    addMenuItem(27, cb.settings.menu_item_27_label, cb.settings.menu_item_27_amount);
    addMenuItem(28, cb.settings.menu_item_28_label, cb.settings.menu_item_28_amount);
    addMenuItem(29, cb.settings.menu_item_29_label, cb.settings.menu_item_29_amount);
    addMenuItem(30, cb.settings.menu_item_30_label, cb.settings.menu_item_30_amount);
    addMenuItem(31, cb.settings.menu_item_31_label, cb.settings.menu_item_31_amount);
    addMenuItem(32, cb.settings.menu_item_32_label, cb.settings.menu_item_32_amount);
    addMenuItem(33, cb.settings.menu_item_33_label, cb.settings.menu_item_33_amount);
    addMenuItem(34, cb.settings.menu_item_34_label, cb.settings.menu_item_34_amount);
    addMenuItem(35, cb.settings.menu_item_35_label, cb.settings.menu_item_35_amount);
    addMenuItem(36, cb.settings.menu_item_36_label, cb.settings.menu_item_36_amount);
    addMenuItem(37, cb.settings.menu_item_37_label, cb.settings.menu_item_37_amount);
    addMenuItem(38, cb.settings.menu_item_38_label, cb.settings.menu_item_38_amount);
    addMenuItem(39, cb.settings.menu_item_39_label, cb.settings.menu_item_39_amount);
    addMenuItem(40, cb.settings.menu_item_40_label, cb.settings.menu_item_40_amount);
}

function addMenuItem(itemId, itemLabel, itemAmount) {
    if (itemLabel && itemAmount > 0) {
        menuItems.push({
            id: itemId,
            label: itemLabel,
            amount: itemAmount,
            hitCount: 0,
            tokenTotal: 0,
            ambiguousCount: 0,
            ambiguousTokenTotal: 0
        });
    }
}

function showMenuNotice(targetUser) {
    var menuText = '';

    menuText += cb.settings.menu_title;

    if (menuItems.length === 0) {
        menuText += '\nNo menu items are currently configured.';
    } else {
        for (var i = 0; i < menuItems.length; i++) {
            menuText += '\n' + menuItems[i].amount + ' - ' + menuItems[i].label;
        }
    }

    if (cb.settings.menu_footer) {
        menuText += '\n' + cb.settings.menu_footer;
    }

    cb.sendNotice(menuText, targetUser || '', NOTICE_COLOR);
}

function showHelp(targetUser) {
    var helpText = '';

    helpText += APP_NAME + ' Commands';
    helpText += '\n/menu - Show the tip menu';
    helpText += '\n/tipmenu - Show the tip menu';
    helpText += '\n!menu - Show the tip menu';
    helpText += '\n/tipmenuhelp - Show this help message';
    helpText += '\n/tipmenuiq - Show app status';
    helpText += '\n/tmiq - Show app status';
    helpText += '\n/tipmenustats - Show in-session menu stats';

    cb.sendNotice(helpText, targetUser || '', NOTICE_COLOR);
}

function showStatus(targetUser) {
    var statusText = '';

    statusText += APP_NAME + ' v' + APP_VERSION + ' Status';
    statusText += '\nMenu items loaded: ' + menuItems.length;
    statusText += '\nTotal tips this session: ' + totalTipCount;
    statusText += '\nTotal tokens this session: ' + totalTokenCount;
    statusText += '\nMatched menu tips: ' + matchedTipCount;
    statusText += '\nMatched menu tokens: ' + matchedTokenTotal;
    statusText += '\nAmbiguous menu tips: ' + ambiguousTipCount;
    statusText += '\nAmbiguous menu tokens: ' + ambiguousTokenTotal;
    statusText += '\nUnmatched tips: ' + unmatchedTipCount;
    statusText += '\nUnmatched tokens: ' + unmatchedTokenTotal;

    cb.sendNotice(statusText, targetUser || '', NOTICE_COLOR);
}

function showMenuStats(targetUser) {
    var statsText = '';

    statsText += APP_NAME + ' Menu Stats';
    statsText += '\nTotal tips: ' + totalTipCount;
    statsText += '\nTotal tokens: ' + totalTokenCount;
    statsText += '\nMatched menu tips: ' + matchedTipCount + ' / ' + matchedTokenTotal + ' tokens';
    statsText += '\nAmbiguous menu tips: ' + ambiguousTipCount + ' / ' + ambiguousTokenTotal + ' tokens';
    statsText += '\nUnmatched tips: ' + unmatchedTipCount + ' / ' + unmatchedTokenTotal + ' tokens';

    statsText += '\n\nMenu Item Activity:';

    var anyActivity = false;

    for (var i = 0; i < menuItems.length; i++) {
        if (menuItems[i].hitCount > 0 || menuItems[i].ambiguousCount > 0) {
            anyActivity = true;

            statsText += '\n' + menuItems[i].amount + ' - ' + menuItems[i].label + ': ';
            statsText += menuItems[i].hitCount + ' matched / ' + menuItems[i].tokenTotal + ' tokens';

            if (menuItems[i].ambiguousCount > 0) {
                statsText += ' | ' + menuItems[i].ambiguousCount + ' ambiguous';
            }
        }
    }

    if (!anyActivity) {
        statsText += '\nNo menu-item activity recorded yet.';
    }

    cb.sendNotice(statsText, targetUser || '', NOTICE_COLOR);
}

function findMenuItemsByAmount(amount) {
    var matches = [];

    for (var i = 0; i < menuItems.length; i++) {
        if (menuItems[i].amount == amount) {
            matches.push(menuItems[i]);
        }
    }

    return matches;
}

function recordAmbiguousMenuTip(matches, amount) {
    for (var i = 0; i < matches.length; i++) {
        matches[i].ambiguousCount++;
        matches[i].ambiguousTokenTotal += amount;
    }
}

function getCommandText(msgText) {
    if (!msgText) {
        return '';
    }

    return msgText.toLowerCase().replace(/^\s+|\s+$/g, '');
}

function menuNoticeTimer() {
    if (cb.settings.menu_notice_interval > 0) {
        showMenuNotice('');
        cb.setTimeout(menuNoticeTimer, cb.settings.menu_notice_interval * 60 * 1000);
    }
}

// -----------------------------
// Event Handlers
// -----------------------------

cb.onMessage(function(msg) {
    var commandText = getCommandText(msg.m);

    if (commandText === '/menu' || commandText === '/tipmenu' || commandText === '!menu') {
        showMenuNotice(msg.user);
        msg['X-Spam'] = true;
        return msg;
    }

    if (commandText === '/tipmenuhelp') {
        showHelp(msg.user);
        msg['X-Spam'] = true;
        return msg;
    }

    if (commandText === '/tipmenuiq' || commandText === '/tmiq') {
        showStatus(msg.user);
        msg['X-Spam'] = true;
        return msg;
    }

    if (commandText === '/tipmenustats') {
        showMenuStats(msg.user);
        msg['X-Spam'] = true;
        return msg;
    }

    return msg;
});

cb.onTip(function(tip) {
    var amount = tip.amount;
    var username = tip.from_user || tip.user || 'Someone';
    var matches = findMenuItemsByAmount(amount);

    totalTipCount++;
    totalTokenCount += amount;

    if (matches.length === 1) {
        matchedTipCount++;
        matchedTokenTotal += amount;

        matches[0].hitCount++;
        matches[0].tokenTotal += amount;

        cb.sendNotice(
            username + ' tipped for ' + matches[0].label + '!',
            '',
            NOTICE_COLOR
        );

    } else if (matches.length > 1) {
        ambiguousTipCount++;
        ambiguousTokenTotal += amount;

        recordAmbiguousMenuTip(matches, amount);

        for (var i = 0; i < matches.length; i++) {
            cb.sendNotice(
                username + ' may have tipped for ' + matches[i].label + '!',
                '',
                NOTICE_COLOR
            );
        }

    } else {
        unmatchedTipCount++;
        unmatchedTokenTotal += amount;
    }
});

// -----------------------------
// Start App
// -----------------------------

loadMenuItems();

cb.sendNotice(
    APP_NAME + ' v' + APP_VERSION + ' loaded. Menu items loaded: ' + menuItems.length + '. Type /tipmenuhelp for commands.',
    '',
    NOTICE_COLOR
);

if (cb.settings.menu_notice_interval > 0) {
    cb.setTimeout(menuNoticeTimer, cb.settings.menu_notice_interval * 60 * 1000);
}