Chaturbate

Apps Home | Create an App
Password Room by theknight2000
Author: theknight2000
Description Source Code Launch App Current Users
Created by: Theknight2000
There are 2 other versions of this script.
/*
*  Title:		Passwoom Room By theknight2000
*  Author:		TheKnight2000
*  Version: 	1.0 (08/27/13)

Summary:
Set a goal for a password show. Viewers must buy a ticket to watch. Empowers trusted moderators with 
commands to help manage and setup the show. Tracks first and second place high tippers.

Description:
When goal is reached, send out the password to the tippers using the commands provided. Exceptions can be made by
moderators with the ability to add users manually. Cool when you need to include your regulars in the show.
The app also keeps track of and highlights first and second place highest tipper messages.

List of commands:
	!tippers = See the current list of users that have tipped enough for the show
	!sendpw <user>  = Sends password out to a user or all tippers via chat message (mods only)
	!adduser <user> = Allows user list to be manually adjusted (mods only)
	!changepw = Allows the pw to be changed as needed (broadcaster only)
	!starttimer = Set a count down to reach goal or buy tickets (broadcaster only)
	!time = Time left on the clock if timer is set (mods only)
	!cmds = See list of commands (mods only)
	

Status:
-------------------------
TODO:
*  When chatNotice supports styles, stress mods vs. users in tip list for clarity
*  When PMs are possible, send pw via PM so it stays available to user (lost in chat)
*/

// vars
var total_tipped = 0;
var first_high_tip_username = null;
var first_high_tip_amount = 0;
var second_high_tip_username = null;
var second_high_tip_amount = 0;
var timerMinutes = 60;
var timerStarted = false;

var firstTimeInit = true;
var password_override = null;
var description = "Ticket to the Show by TheKnight2000 is running!";

var COMMAND_SEND_PASSWORD = '!sendpw';
var COMMAND_ADD_USER = '!adduser';
var COMMAND_TIPPER_LIST = '!tippers';
var COMMAND_CHANGE_PASSWORD = '!changepw';
var COMMAND_START_TIMER = '!starttimer';
var COMMAND_SEE_COMMANDS = '!cmds';
var COMMAND_TIMER = '!time';

function getCommandList() {
	return nl + '\n' +
			COMMAND_SEND_PASSWORD + " <user>  (no user sends to all)\n" +
			COMMAND_ADD_USER + " <user> (no user adds you if allowed)\n" +
			COMMAND_CHANGE_PASSWORD + "   Change the show password\n" +
			COMMAND_START_TIMER + " <minutes>\n" +
			COMMAND_TIMER + "  Time left\n" +
			nl;
}

var CONFIG_COLOR_FIRST_PLACE = '#FFF700';
var CONFIG_COLOR_SECOND_PLACE = '#B0FAFF';

var nl = '--------------------------------------------';

cb.settings_choices = [
    {name: 'goal', type: 'int', minValue: 1, defaultValue: 200, label: "Token goal"},
    {name: 'goal_description', type: 'str', minLength: 1, maxLength: 255, defaultValue: "Password show when goal is reached, tip for the password!", label: "Goal Description"},
    {name: 'buyin', type: 'int', minValue: 1, defaultValue: 25, label: "Token amount required to buy into password show"},
    {name: 'password', type: 'str', minLength: 1, maxLength: 255, defaultValue: "", label: "Password (no spaces)"},
    {name:'include_mods', type:'choice',
        choice1:'Yes',
        choice2:'No', defaultValue:'Yes', label: "Moderators can add users (and themselves)?"}
];

var userList = new Array();
var userTipTotals = {};

// handlers
cb.onTip(function(tip) {
	// track total tips
    total_tipped += tip['amount'];
    if (total_tipped > cb.settings.goal) total_tipped = cb.settings.goal;
    
    // track all user tip counts, set a first and second place dude
    trackTips(tip['from_user'],tip['amount']);
    
    // track users for password show
    if (tip['amount'] >= cb.settings.buyin) {
    	addUser(tip['from_user']);
    }
    
    updateSubject();
    cb.drawPanel();
});


cb.onDrawPanel(function(user) {
    return {
        'template': '3_rows_of_labels',
        'row1_label': 'Tip Received / Goal :',
        'row1_value': '' + total_tipped + ' / ' + cb.settings.goal,
        'row2_label': 'First Place Tipper:',
        'row2_value': format_username(first_high_tip_username) + ' (' + first_high_tip_amount + ')',
        'row3_label': 'Second Place Tipper:',
        'row3_value': format_username(second_high_tip_username) + ' (' + second_high_tip_amount + ')'
    };
});

cb.onMessage(function (msg) {
	// user commands
	if (msg['m'].indexOf(COMMAND_TIPPER_LIST) > -1) {
		cb.log('cmd received: ' + COMMAND_TIPPER_LIST);
    	cb.chatNotice(nl+'\nTicket holders are:  ' + getUserList() + '\n'+nl);
    }
    
	// mod commands (don't know if is_mod includes broadcaster)
	if (msg['m'].indexOf(COMMAND_SEND_PASSWORD) > -1) {
		cb.log('cmd received: ' + COMMAND_SEND_PASSWORD);
		if (msg['is_mod'] || msg['user'] == cb.room_slug) {
			var cmdval = getCommandValue(msg['m']);
			if (cmdval) {
				sendPasswordToUser(cmdval);
				cb.chatNotice('** Password sent to ' + cmdval,msg['user']);
			} else {
				cb.chatNotice('** ' + msg['user'] + ' sent password to ticket holders');
				sendPasswordToUsers();			
			}
		}
	}
    if (msg['m'].indexOf(COMMAND_ADD_USER) > -1) {
		cb.log('cmd received: ' + COMMAND_ADD_USER);
    	if ((msg['is_mod'] && cb.settings.include_mods == 'yes') || msg['user'] == cb.room_slug) {
    		var cmdval = getCommandValue(msg['m']);
        	if (cmdval) {
        		addUser(cmdval);
        		cb.chatNotice('** Password sent to ' + cmdval,msg['user']);
        		cb.chatNotice('** Password sent to ' + cmdval + 'by ' + msg['user'],cb.room_slug);	// inform broadcaster
        	} else { 
        		addUser(msg['user']); // mods can add themselves if no cmd value
        		cb.chatNotice('** ' + msg['user'] + ' self added to list',cb.room_slug);	// inform broadcaster
        	}
    	}
    }
    if (msg['m'].indexOf(COMMAND_CHANGE_PASSWORD) > -1) {
		cb.log('cmd received: ' + COMMAND_CHANGE_PASSWORD);
    	if (msg['user'] == cb.room_slug) {
    		var cmdval = getCommandValue(msg['m']);
        	if (cmdval) {
        		setPassword(cmdval);
        		cb.chatNotice('** Password changed to ' + cmdval + '.\nInform moderators and ticket holders with !sendpw',msg['user']);
        		msg['m'] = COMMAND_CHANGE_PASSWORD + ' ******';
        	}
    	} else {
    		cb.chatNotice('** Command only available to broadcaster',msg['user']);
    	}
    }
    if (msg['m'].indexOf(COMMAND_START_TIMER) > -1) {
    	cb.log('cmd received: ' + COMMAND_START_TIMER);
    	if (msg['user'] == cb.room_slug) {
    		var cmdval = getCommandValue(msg['m']);
    		if (timerStarted) {
    			cb.chatNotice('** Timer already running',msg['user']);
    		} else {
        		if (cmdval) startTimer(cmdval);
        		else cb.chatNotice('** Please provide countdown time in minutes',msg['user']);  			
    		}
    	} else {
    		cb.chatNotice('** Command only available to broadcaster',msg['user']);
    	}
    }
    if (msg['m'].indexOf(COMMAND_SEE_COMMANDS) > -1) {
    	cb.log('cmd received: ' + COMMAND_SEE_COMMANDS);
    	if (msg['is_mod'] || msg['user'] == cb.room_slug) {
    		cb.chatNotice(getCommandList(),msg['user']);
    	}
    }
    if (msg['m'].indexOf(COMMAND_TIMER) > -1) {
    	cb.log('cmd received: ' + COMMAND_TIMER);
    	if (msg['is_mod'] || msg['user'] == cb.room_slug) {
    		cb.chatNotice('** [' + timerMinutes + ' minutes] remaining!');
    	}
    }

    if (msg['user'] == first_high_tip_username)  {
        msg['background'] = CONFIG_COLOR_FIRST_PLACE;
    }
    if (msg['user'] == second_high_tip_username) {
    	msg['background'] = CONFIG_COLOR_SECOND_PLACE;
    }

    return msg;
});



// helper functions
function updateSubject() {
	var newSubject = '';
	if (firstTimeInit) {
		newSubject += description + ' ';
		firstTimeInit = false;
    }
	newSubject += getRoomSubject();
    cb.changeRoomSubject(newSubject);
}
function getRoomSubject() {
	return cb.settings.goal_description +
    " [" + tips_remaining() + " tokens remaining] \n\n Tip " + cb.settings.buyin + 
    " tokens to enter. \n\n Type " + COMMAND_TIPPER_LIST + " to see ticket holders. Mods use " + 
    COMMAND_SEE_COMMANDS + " to see all commands";
}


function tips_remaining() {
    var r = cb.settings.goal - total_tipped;
    if (r < 0) {
        return 0;
    } else {
        return r;
    }
}

function format_username(val) {
    if (val === null) {
        return "--";
    } else {
        return val.substring(0, 12);
    }
}


function addUser(user) {
	if (userList.indexOf(user) < 0) {
		userList.push(user);
		sendPasswordToUser(user);
	}
}
function removeUser(user) {
	if (userList.indexOf(user) > -1) {
		userList.splice(indexOf(user), 1);
	}
}
function getUserList() {
	if (userList.length < 1) return 'No tickets sold!';
	else return userList.toString();
}
function isTicketed(user) {
	if (userList.indexOf(user) > -1) return true;
	return false;
}
function sendPasswordToUsers() {
	for (var i=0; i<userList.length; i++) {
		cb.log('sent pw to ' + userList[i]);
		cb.chatNotice(getPasswordMessage(),userList[i]);
	}
}
function sendPasswordToUser(u) {
	cb.chatNotice(getPasswordMessage(),u);
}
function getPasswordMessage() {
	return nl+'\nYour tip allows you to join the password show!\nPassword is between brackets [' + 
		getPassword() + ']  \nShow will begin when goal is met or time expires.\nDO NOT give the password to others.\n'+nl;
}

function getCommandValue(cmd) {
	var value = null;
	try {
		if (cmd.indexOf(' ') > -1) {
			var cmda = cmd.split(" ",2);
			value = cmda[1];
		}
	} catch (err) {
		cb.log('issue getting command value for ' + msg['m']);
	}
	return value;
}
function setPassword(pw) {
	password_override = pw;
}
function getPassword() {
	if (password_override) return password_override;
	return cb.settings.password;
}

function trackTips(user,tip) {
	if (user in userTipTotals)  {
		userTipTotals[user] = userTipTotals[user] + tip;
	} else {
		userTipTotals[user] = tip;
	}
	var usertips = userTipTotals[user];
	
	if (usertips > first_high_tip_amount) {
		cb.chatNotice('*** New High Tipper!  ' + user);
		second_high_tip_amount = first_high_tip_amount;
		second_high_tip_username = first_high_tip_username;
		first_high_tip_amount = usertips;
		first_high_tip_username = user;
	} else if (usertips > second_high_tip_amount) {
		cb.chatNotice('*** New Second Best Tipper!  ' + user);
		second_high_tip_amount = usertips;
		second_high_tip_username = user;
	}
}

function startTimer(mins) {
	try {
		if (parseInt(mins) < 61 && mins > 0) {
			timerMinutes = mins;
			timerStarted = true;
			cb.changeRoomSubject('Timer started! Only [' + timerMinutes + ' minutes] remaining to tip for a ticket! '+getRoomSubject());
			if (mins <= 10) {
				cb.setTimeout(timerAdvert, (1 * 60000));	
			} else {
				cb.setTimeout(timerAdvert, (10 * 60000));	
			}
		}
	} catch (err) {
		cb.log(err.message);
	}
}
function timerAdvert() {
	if (timerMinutes <= 10) {
		timerMinutes--;		
	} else {
		timerMinutes = timerMinutes - 10;
	}

	if (timerMinutes == 0) {
		timerStarted = false;
		cb.changeRoomSubject('*** Time Is Up! ***'+getRoomSubject());
	} else {
		cb.changeRoomSubject('*** [' + timerMinutes + ' minutes] left to tip at least ' + cb.settings.buyin + ' for a ticket! '+getRoomSubject());
		if (timerMinutes <= 10) {
			cb.setTimeout(timerAdvert, (1 * 60000));	// remind every minute when close
		} else {
			cb.setTimeout(timerAdvert, (5 * 60000));	// remind every 5 minutes
		}
	}
}



function init() {
    updateSubject();
}

init();