Chaturbate

Bots Home | Create an App
MechamusumeBot
Author: roboperv
Description Source Code Launch Bot Current Users
Created by: Roboperv
There are 5 other versions of this script.
/*
A Chaturbate bot for MechaMusume (https://chaturbate.com/mechamusume/)
Author: roboperv (robopervert@gmail.com)
Inspired by acrazyguy's vote app for Kati3Kat. :Pbow
*/

var debug = false;

// Variables used in the apps logic
var votesThisSession = 0;
var votesPerDisplay = 3;
// TODO: Notify based on a timeout instead?

// Convenience variables
var roomHost = cb.room_slug;
var allUsers = '';

// Convenient color codes.
// Character colors are hard-coded because CB doesn't have a color picker widget for the performers.
var COLOR = {
    mechaBlue: '#49d1f9',
    mechaRed: '#ec1864',
    mechaBlack: '#000102',
    asuka: '#f62a36',
    motoko: '#dea6c9',
    jinx: '#56dcff',
    ryuko: '#c00e24',
    notice: '#6900CC',
    red: '#FF1407',
    lightPurple: '#EEE5FF',
    brown: '#995B00',
    amber: '#E56B00',
    modred: '#DC0000',
    bluegrey: '#144D8C',
    magenta: '#E509E5',
    blue: '#000099'
};


var voteBoardColor = COLOR.mechaRed;
var voteBoardBGColor = '';
var helpColor = COLOR.mechaBlack;
var reminderColor = COLOR.mechaRed;


cb.settings_choices = [
    {
        'name': 'character1Name',
        'type': 'str',
        'label': 'Character 1 Name',
        'minLength': 1,
        'maxLength': 255
    },
    {
        'name': 'character1Tag',
        'type': 'choice',
        'required': true,
        'label': 'Choose a 1-word label for this character.',
        'choice1': 'asuka',
        'choice2': 'motoko',
        'choice3': 'jinx',
        'choice4': 'ryuko',
        'defaultValue': 'asuka'
    },
    {
        'name': 'character1Cost',
        'type': 'int',
        'label': 'How many tokens per vote for character 1?  (This must be a unique value for each character).',
        'minValue': 1,
        'defaultValue': 31
    },
    {
        'name': 'character1Tally',
        'type': 'int',
        'label': 'How many votes did this character previously have?',
        'defaultValue': 0,
        'required': false
    },
    {
        'name': 'character2Name',
        'type': 'str',
        'label': 'Character 2 Name',
        'minLength': 1,
        'maxLength': 255
    },
    {
        'name': 'character2Tag',
        'type': 'choice',
        'required': true,
        'label': 'Choose a 1-word label for this character.',
        'choice1': 'asuka',
        'choice2': 'motoko',
        'choice3': 'jinx',
        'choice4': 'ryuko',
        'defaultValue': 'asuka'
    },
    {
        'name': 'character2Cost',
        'type': 'int',
        'label': 'How many tokens per vote for character 2?  (This must be a unique value for each character).',
        'minValue': 1,
        'defaultValue': 32
    },
    {
        'name': 'character2Tally',
        'type': 'int',
        'label': 'How many votes did this character previously have?',
        'defaultValue': 0,
        'required': false
    }
];


// Pull out the values from cb.settings into an object we can use internally.
var info = {
    character1: {
        name: cb.settings['character1Name'],
        tag: cb.settings['character1Tag'],
        cost: parseInt(cb.settings['character1Cost'], 10),
        tally: parseInt(cb.settings['character1Tally'], 10)
    },
    character2: {
        name: cb.settings['character2Name'],
        tag: cb.settings['character2Tag'],
        cost: parseInt(cb.settings['character2Cost'], 10),
        tally: parseInt(cb.settings['character2Tally'], 10)
    }
};


// Register a function that gets called whenever a tip is received.
cb.onTip(function (tip) {
    var userName = tip['from_user'];
    var tipAmount = parseInt(tip['amount'], 10);

    var characterN;

    // If the user tips an amount that could be for either character, ask them which to vote for.
    if ((tipAmount % info.character1.cost === 0) && (tipAmount % info.character2.cost === 0)) {
        var char1VoteAmount = votesFor('character1', tipAmount);
        var char2VoteAmount = votesFor('character2', tipAmount);

        var ambiguousVoteMessageToMods = "Ask " + userName + " which character they want to vote for.\n\"/addvotes " + info.character1.tag.toLowerCase() + " " + char1VoteAmount + "\" if " + info.character1.name + ".\n\"/addvotes " + info.character2.tag.toLowerCase() + " " + char2VoteAmount + "\" if " + info.character2.name + ".";

        cb.sendNotice("Tell the mods which character you want to vote for!", userName, '', COLOR.red, 'bolder');
        cb.sendNotice(ambiguousVoteMessageToMods, '', '', COLOR.magenta, 'bold', 'red');
        cb.sendNotice(ambiguousVoteMessageToMods, roomHost, '', COLOR.magenta, 'bold');
    }
    else if ((tipAmount % info.character1.cost === 0) && (tipAmount >= info.character1.cost)) {
        characterN = 'character1';
    }
    else if ((tipAmount % info.character2.cost === 0) && (tipAmount >= info.character2.cost)) {
        characterN = 'character2';
    }

    var voteAmount = 0;

    if (characterN !== undefined) {
        voteAmount = votesFor(characterN, tipAmount);
    }

    if (voteAmount > 0) {
        increaseTally(characterN, voteAmount);

        if (voteAmount >= 5) {
            displayAfterVoteMessage(allUsers, characterN, voteAmount, userName, 'bolder');
            displayVoteBoard(allUsers);
        } else {
            displayAfterVoteMessage(allUsers, characterN, voteAmount, userName, '');
        }

        votesThisSession++;
        if (votesThisSession % votesPerDisplay === 0) {
            displayVoteBoardReminder(allUsers);
        }
    }
});


function votesFor (character, amount) {
    if (debug) { cb.log("votesFor(" + character + ", " + amount + ")"); }
    return Math.floor(amount / info[character].cost);
}

function increaseTally (character, amount) {
    if (debug) { cb.log("increaseTally(" + character + ", " + amount + ")"); }
    info[character].tally += amount;
}

function setTally (character, amount) {
    if (debug) { cb.log("setTally(" + character + ", " + amount + ")"); }
    info[character].tally = amount;
}

function validTag (charTag) {
    var tag = String(charTag).toLowerCase();
    if (debug) { cb.log("validTag(" + charTag + ")?: " + ((tag === info.character1.tag.toLowerCase()) || (tag === info.character2.tag.toLowerCase()))); }
    return ((tag === info.character1.tag.toLowerCase()) || (tag === info.character2.tag.toLowerCase()));
}

function validNumber (number) {
    if (debug) { cb.log("validNumber(" + number + ")?: " + !isNaN(parseInt(number, 10))); }
    return !isNaN(parseInt(number, 10));
}


commandRegex = function () {
    // This is wrapped in a function to avoid polluting the top-level namespace with variables.
    // The regex is broken into pieces to make it more verbose (javascript is limited in this regard).

    var slash = "(?:\\/)";  // Required
    var commandName = "(\\S+)";  // Required
    var charName = "(\\S+)?";  // Optional
    var voteAmount = "(\\d+)?";  // Optional
    var space = "(?: )?";  // Optional
    var commandRegex = new RegExp("^" + slash + commandName + space + charName + space + voteAmount, "i");

    return commandRegex;
}();


// Register a function that gets called whenever a message is sent to the chat room.
cb.onMessage(function (msg) {
    var m = msg['m'].toLowerCase();
    var userName = msg['user'];
    var isMod = msg['is_mod'];
    var isRoomHost = (userName === roomHost);

    // TODO: Make a separate regex for /votes, to simplify this logic.
    if (commandRegex.test(m)) {
        var commandSplit = m.match(commandRegex);  // [m, "match1", "match2", "match3"]
        var command = commandSplit[1];
        var charTag = commandSplit[2];
        var number = commandSplit[3];

        switch(command) {
            case "vote":
                displayVoteBoard(userName);
                msg['X-Spam'] = true;
                return;
            case "votes":
                displayVoteBoard(userName);
                msg['X-Spam'] = true;
                return;
            case "mbhelp":
                displayHelp(userName, (isMod || isRoomHost));
                msg['X-Spam'] = true;
                return;
        }

        if ((isMod || isRoomHost)) {
            if (command === "display") {
                displayVoteBoard(allUsers);
                msg['X-Spam'] = true;
                return;
            }

            if (validNumber(number) && validTag(charTag)) {
                var voteAmount = parseInt(number, 10);
                var characterN = tagToNumber(charTag);

                if ((characterN !== undefined)) {
                    switch (command) {
                        case "addvote":
                            increaseTally(characterN, voteAmount);
                            displayVoteBoard(userName);
                            msg['X-Spam'] = true;
                            return;
                        case "addvotes":
                            increaseTally(characterN, voteAmount);
                            displayVoteBoard(userName);
                            msg['X-Spam'] = true;
                            return;

                        case "settally":
                            setTally(characterN, voteAmount);
                            displayVoteBoard(userName);
                            msg['X-Spam'] = true;
                            return;
                        case "setvote":
                            setTally(characterN, voteAmount);
                            displayVoteBoard(userName);
                            msg['X-Spam'] = true;
                            return;
                        case "setvotes":
                            setTally(characterN, voteAmount);
                            displayVoteBoard(userName);
                            msg['X-Spam'] = true;
                            return;
                    }
                }
            }
        }
    }
});  // Look at all those braces!


function tagToNumber (charTag) {
    if (debug) { cb.log("tagToNumber(" + charTag + ")"); }
    if (validTag(charTag)) {
        var tag = charTag.toLowerCase();
        if (tag === info.character1.tag.toLowerCase())
            return "character1";
        else if (tag === info.character2.tag.toLowerCase())
            return "character2";
    }
}


// TODO: Make mod help messages a different color than the regular help message.
function displayHelp (user, isMod) {
    var helpMessage = "";
    if (isMod) {
        helpMessage += "\nMod Commands:\n";
        helpMessage += "/mbhelp: See this help message (for yourself).\n";
        helpMessage += "/votes: See the vote board (for yourself).\n";
        helpMessage += "/display: Display the vote board to everyone.\n";
        helpMessage += "/addvotes character number: Manually add a number of votes to a character's tally.\n";
        helpMessage += "/settally character number: Manually set a character's tally to a specific number.\n";
        helpMessage += "Characters: " + info.character1.tag.toLowerCase() + ", " + info.character2.tag.toLowerCase() + "\n";
    } else {
        helpMessage += "Vote for my next cosplay character!\n";
        helpMessage += "Type /votes to see the vote board.\n";
        helpMessage += "Tip " + info.character1.cost + " tokens to vote for " + info.character1.name + ".\n";
        helpMessage += "Tip " + info.character2.cost + " tokens to vote for " + info.character2.name + ".\n";
        helpMessage += "Tip multiples of " + info.character1.cost + " or " + info.character2.cost + " to cast more votes at once.\n"
        helpMessage += "Check my bio for more info!";
    }

    cb.sendNotice(helpMessage, user, '', helpColor, 'bold');
}


// TODO: Find a way for the roomhost to set colors for each character using cb.settings_choices.
function displayAfterVoteMessage (user, characterN, amount, userName, fontWeight) {
    fontWeight = fontWeight || '';  // '' is the default value if no value is supplied for fontWeight.
    var charTag = info[characterN].tag;
    var charColor = COLOR[charTag];
    var msg = "** " + userName + " **" + " cast " + amount + " vote" + (amount > 1 ? "s" : "") + " for " + info[characterN].name + "!";
    cb.sendNotice(msg, user, '', charColor, fontWeight);
}


// TODO: Use :emoticons in the vote board.
// TODO: Can we color each line individually? A: Yes, but that requires sending multiple notices.
function displayVoteBoard (user) {
    // Set user='' to send to room.

    var dashedLine = "-----------------------------------";

    var character1Line = "* " + info.character1.name + ": " + info.character1.tally;
    var character2Line = "* " + info.character2.name + ": " + info.character2.tally;

    var voteBoard = dashedLine + "\n";
    voteBoard += character1Line + "\n";
    voteBoard += character2Line + "\n";
    voteBoard += dashedLine;

    cb.sendNotice(voteBoard, user, voteBoardBGColor, voteBoardColor, 'bold');
}


function displayVoteBoardReminder (user) {
    var reminder = "Type /votes to see the vote board, or /mbhelp for more info!";
    cb.sendNotice(reminder, user, '', reminderColor, 'bold');
}


// Register a function that gets called whenever a user enters the room.
cb.onEnter(function (viewer) {
    displayHelp(viewer['user'], viewer['is_mod']);
});


function init () {
    var modMessage = "MechaBot Vote App started!\n";
    modMessage += "Type /mbhelp to see the list of commands available to mods.\n";
    cb.sendNotice(modMessage, roomHost, '', helpColor, 'bold');
    cb.sendNotice(modMessage, '', '', helpColor, 'bold', 'red');

    var userMessage = "Vote for my next cosplay character!\n";
    userMessage += "Type /votes to see the vote board.\n";
    userMessage += "Type /mbhelp and check my bio for more info!";
    cb.sendNotice(userMessage, allUsers, '', helpColor, 'bold');

    displayVoteBoard(allUsers);
}

init();