Chaturbate

Bots Home | Create an App
DANILOVERS
Author: danielle_ross
Description Source Code Launch Bot Current Users
There is 1 other version of this script.
/*  
 * 	Title: My Top Lovers
 * 	Author: noiett
 * 		Email: noiett.cb@gmail.com
 * 		Twitter: @biosandapps
 * 	Version: 1.3.2 Apr 12, 2018
 * 	Description: Customizable leaderboard app
 * 
 * 
*/

// CONSTANTS
var COLORS = [
	{name: 'Amaranth', 	code: '#c92572',	bgcode: '#f9eaf1'},	
	{name: 'Black',		code: '#000000',	bgcode: '#e8e8e8'},
	{name: 'Blue', 		code: '#016ea6',	bgcode: '#e3eff6'},	
	{name: 'SteelBlue',	code: '#4159b5',	bgcode: '#e7ebfb'},
	{name: 'DarkBlue', 	code: '#364785',	bgcode: '#e4e9f9'},
	{name: 'BrownRed', 	code: '#b31313',	bgcode: '#fbe9e9'},
	{name: 'DarkViolet',	code: '#9c3dc4',	bgcode: '#efdff4'},
	{name: 'SeanceViolet',	code: '#ba21bf',	bgcode: '#ffdffe'},	
	{name: 'Green', 	code: '#327939',	bgcode: '#e1f9e3'},
	{name: 'DarkGreen', 	code: '#436446',	bgcode: '#d0e8d3'},
	{name: 'Pink', 		code: '#FF00BA',	bgcode: '#ffe6f8'},    
	{name: 'Purple', 	code: '#800080',	bgcode: '#f1e4f1'},
	{name: 'Red', 		code: '#ff3232',	bgcode: '#f6e5e9'},
	{name: 'TorchRed', 		code: '#FF0040',	bgcode: '#ffe5e5'},	
	{name: 'Turquoise',	code: '#188b8c', 	bgcode: '#e2f6f6'},
	{name: 'SlateGray', 	code: '#708090',	bgcode: '#eaeff3'},
];

var HEARTS = [
	{name: 'Fuchsya',	icon: ':mtlhfu'},
	{name: 'Pink',		icon: ':mtlhpi'},
	{name: 'Purple', 	icon: ':mtlhpu'},
	{name: 'Red', 		icon: ':mtlhre'}
];

// Some useful characters
var HEART 	= '\u2665';	// ♥
    BDIAMOND 	= '\u2666';	// ♦
    BSTAR 	= '\u2605';	// ★
    WSTAR 	= '\u2606';	// ☆

// Number of Top Lovers to show
var loversMaxItems = 3;
    
// Variables for Settings   
var loversModelName = '';
var loversListColor = '';
var loversListBgColor = '';
var loversTextWeight = '';
var loversListTimer = 0;
var loversHearts = true;
var loversIcon = '';
var loversAnnounce = true;

// VARIABLES
var botVersion = "1.3.2";
var botDate = "Apr 12,  2018";
var botNoticeDelay = 500;
var loversList = [];

// TEXTS
var botCommand = '/bot';
var theHeader = ':mtlpheart My Top Lovers' + ' :mtlpheart2';
var loadText = 'Thank you for all your tips♥';

// SETTINGS
cb.settings_choices = [
	{
		name: 'model_lb',
		type: 'str',
		minLength: 0,
		maxLength: 21,
		required: true,
		defaultValue: cb.room_slug.charAt(0).toUpperCase() + cb.room_slug.slice(1),
		label: 'Model name to show'
	},
	{
		name: 'max_lb', 
		type: 'choice',
		choice1: 3,
		choice2: 4,
		choice3: 5,
		defaultValue: 3, 
		label: 'Number of Top Lovers',
	},
	{
		name: 'hearts_lb', 
		type: 'choice', 
		choice1: 'Yes', 
		choice2: 'No', 
		defaultValue: 'Yes', 
		label: 'Show hearts before Top Lovers\' messages'
	},
	{
		name: 'icons_lb', 
		type: 'choice', 
		label: 'Hearts color',
		choice1: 'Fuchsya', 
		choice2: 'Pink', 
		choice3: 'Purple', 
		choice4: 'Red', 		
		defaultValue: 'Fuchsya'
	},	
	{
		name: 'announce_lb', 
		type: 'choice', 
		choice1: 'Yes', 
		choice2: 'No', 
		defaultValue: 'Yes', 
		label: "Announce new Top Lover"
	},	
	{
		name: 'timer_lb', 
		type: 'choice',
		choice1: 1,
		choice2: 2,
		choice3: 3,
		choice4: 4,
		choice5: 5,
		choice6: 6,				
		choice7: 8,
		choice8: 10,
		choice9: 12,
		choice10: 15,
		choice11: 20,
		choice12: 30,
		choice13: 'Never',
		defaultValue: 6, 
		label: 'Top Lovers Display frequency (mins)'
	},	
	{
		name: 'color_lb', 
		type:'choice', 
		label:'Color scheme',
		choice1: 'Amaranth',
		choice2: 'Black', 
		choice3: 'Blue', 
		choice4: 'SteelBlue',
		choice5: 'DarkBlue',
		choice6: 'BrownRed',
		choice7: 'DarkViolet', 
		choice8: 'SeanceViolet',
		choice9: 'Green',
		choice10: 'DarkGreen',
		choice11: 'Pink',
		choice12: 'Purple',		
		choice13: 'Red',
		choice14: 'TorchRed',
		choice15: 'Turquoise',
		choice16: 'SlateGray',  	 
		defaultValue: 'Purple'
	},	
	{
		name: 'style_lb', 
		type: 'choice', 
		label: 'Leaderboard style',
		choice1: 'Classic', 
		choice2: 'Colored background',
		defaultValue: 'Colored background'
	},		
];

// FUNCTIONS 
cb.onMessage(function (msg) 
{
	// Some variables
	var name = msg['user'];
	var model = cb.room_slug;
	var isModel = (name == model);
  
	// Command /lovers
	if (msg.m.indexOf('/lovers') == 0 || msg.m.indexOf('!lovers') == 0)
	{
		var message = msg['m'].substr(1);
		var userParam = getParam(message,0);	
		var userParam2 = getParam(message,1);
		var userParam3 = getParam(message,2);
		var userParam4 = getParam(message,3);	
		var botPrefix = '/';
		var head = '';
		var userMsg = '';

		if (!userParam2) {
			model = model.charAt(0).toUpperCase() + model.slice(1);
			msg['m'] = msg['m'] + " (lovers list sent to " + msg['user'] + ")";
			if (loversList.length > 0) {
				head = ':mtlpheart ' + loversModelName + '\'s Lovers List :mtlpheart2';
				for (var i = 0; i < loversList.length; i++){
					/* Add \n before starting a new line */
					if (i > 0) {
						userMsg += '\n';
					}	      
					/* Add a new tipper if available */
					if (i < loversList.length) {
						userMsg += '' + (i + 1) + '. ' + loversList[i].name + '  (' + loversList[i].tokens + ' tks)';
					}
					else {
						userMsg += '' + (i + 1) + '. ---------------------';
					}	    
				}
			}
			else {
				userMsg = 'No lovers yet! Tip now and become the top lover!';
			}			
		}
		else {
			if (isModel) {
				msg['X-Spam'] = true;
				switch (userParam2)
				{
					case 'tip':
					case 'add':
						// Add a new tip
						if (userParam3 && userParam4) {
							if (isInteger(userParam4) && userParam4 > 0) {
								handleTip(userParam3, userParam4);
								userMsg = 'A tip of ' + userParam4 + 'tks from user ' + userParam3 + ' has been added to the Lovers List.';
							}
							else {
								userMsg = 'You need to pass an integer value greater than 0 (e.g. ' + botPrefix + userParam + ' ' + userParam2 + ' username 100).';
							}
						}
						else {
							userMsg = 'You need to pass a valid username and value (e.g. ' + botPrefix + userParam + ' tip username 100).';	
						}
					break;
					
					case 'remove':
						// Remove lover
						if (userParam3) {
							var objTipper = getTipper(userParam3);
							if (objTipper) {
								cbjs.arrayRemove(loversList, objTipper);
								userMsg = 'User ' + userParam3 + ' has been removed from the Lovers List.';
							}
							else {
								userMsg = 'User ' + userParam3 + ' is not in the Lovers List.';
							}
						}
						else {
							userMsg = 'You need to pass a valid username (e.g. ' + botPrefix + userParam + ' ' + userParam2 + ' username).';	
						}
					break;
								
					default:
						userMsg = 'You need to pass a valid option (e.g. ' + botPrefix + userParam + ' tip username 100).';	
					break;
				}
			}
		}
		
		// Workaround for CB bug: this delay prevents message from being broken by command text in the room
		if (head) cb.sendNotice(head,name,loversListColor,'#FFFFFF','bold');	
		setTimeout(function(){
			// Send Command response to user
			if (userMsg) cb.sendNotice(userMsg,name,loversListBgColor,loversListColor,'normal');
		}, botNoticeDelay);			
	}
	
	// Top Tipper? Let's add a heart to the msg
	if (loversHearts) {
		var pos = getTopLover(msg['user']);
		if (pos > 0) {
			msg['m'] = '' + loversIcon + pos + ' ' + msg['m'];
		}
	}  

	return msg;
});

/*
 * Handle new tip
 */
cb.onTip(function (tip) 
{
	var username = tip.from_user;
	var amount = tip.amount;
	var found = false;
	var isMVP = false;

	// Handle Lovers List
	if (loversList.length > 0) {
		isMVP = (username == loversList[0].name);
	}
	
	handleTip(username, amount);
	
	/* Is new Top Lover? Let's announce it! */
	if (!isMVP && loversList[0].name == username && loversAnnounce) {
		var msg = ':mtlstar ' + loversList[0].name + ' :mtlstar is the new Top Lover with ' + loversList[0].tokens + ' tokens!';
		cb.sendNotice(msg,'',loversListColor,'#ffffff','bold');
	}	
});

/*
 * Adds a new tip to the loversList Array, adding a new user if needed
 * @username : user who tipped
 * @tokens : amount tipped
 */
function handleTip(username, tokens)
{
	var found = false;
	tokens = parseInt(tokens);
	// Update tipper
	for (var i = 0; i < loversList.length; i++) {
		if (loversList[i].name == username) {
			loversList[i].tokens += tokens;
			found = true;
			break;
		}
	}
	
	// Add a new one
	if (!found) loversList.push({ name: username, tokens: tokens });
	     
	// Sort the array
	loversList.sort(function(a, b) {
		return b.tokens - a.tokens;
	});	     
}

/*
 * Returns the user object from the tippers list matching the name
 */
function getTipper(name) 
{
	if (loversList.length > 0) {
		for (var i=0; i<loversList.length; i++) {
			if (loversList[i].name == name) {
				return loversList[i];
			}
		}			
	}
	return 0;
}

/*
 * Returns the name of the lover with more tokens
 */
function getTopLover(name) 
{
	if (loversList.length > 0) {
		for (var i=0; i<Math.min(loversList.length, loversMaxItems); i++) {
			if (loversList[i].name == name) {
				return i+1;
			}
		}
	}
	cb.log('User not in the top ' + loversMaxItems + ' lovers.');
	return 0;
}

/*
 * Returns the name of the heart emote of a certain color
 */
function getHeartsIcon(name) 
{
	for (var i=0; i<HEARTS.length; i++) {
		if (HEARTS[i].name == name) {
			return HEARTS[i].icon;
		}
	}
	return false;
	cb.log('Error: Could not find the icon for this heart color: ' + name);
}

/*
 * Returns the code of a requested color name
 */
function getColorCode(name) 
{
	for (var i=0; i<=COLORS.length; i++) {
		if (COLORS[i].name == name) {
			return COLORS[i].code;
		}
	}
	return "#FFFFFF";
	cb.log('Error: Could not find the code for this color: ' + name);
}

/*
 * Returns the code of a requested color background
 */
function getBgColorCode(name) 
{
	for (var i=0; i<=COLORS.length; i++) {
		if (COLORS[i].name == name) {
			return COLORS[i].bgcode;
		}
	}
	return "#FFFFFF";
	cb.log('Error: Could not find the bgcode for this color: ' + name);
}

/*
 * Return parameter in a certain position in a string
 */
function getParam(msg, position) 
{
	var tmp = msg.split(' ');
	return tmp[position];
}

/*
 * Validates if number is Integer type
 * 
 */
function isInteger(value) {
  return !isNaN(value) && 
         parseInt(Number(value)) == value && 
         !isNaN(parseInt(value, 10));
}

/*
 * Sends the lovers list to the room
 */
function announceLoversList() 
{
	var target = '';
	var msgHead = '';
	var msgRoom = '';	
	
	/* Build the lovers list */
	if (loversList.length > 0) {
		
		/* Add header */
		msgHead = ':mtlpheart ' + loversModelName + '\'s Top Lovers :mtlpheart2';	
		
		for (var i = 0; i < loversMaxItems; i++){
			/* Add \n before starting a new line */
			if (i > 0) {
			msgRoom += '\n';
			}	      
		
			/* Add a new tipper if exists */
			if (i < loversList.length) {
				msgRoom += '' + (i + 1) + '. ' + loversList[i].name + '  (' + loversList[i].tokens + ' tks)';
			}
			else {
				msgRoom += '' + (i + 1) + '. ---------------------';
			}	    
		}
		
		/* More lovers? Invite viewers to see full list! */
		if (loversList.length > loversMaxItems) {
			msgRoom += '\nType /lovers to see the full list!';
		}
	}
	else {
		msgRoom = 'No lovers yet! Tip now and become the top lover!';
	}

	if (msgHead) cb.sendNotice(msgHead,target,loversListColor,'#FFFFFF','bold');
	cb.sendNotice(msgRoom,target,loversListBgColor,loversListColor,'normal');
	
	cb.setTimeout(announceLoversList, (loversListTimer * 60000));
}

/*
 * Builds user vars and arrays based on settings
 */
function loadSettings() 
{
	if (cb.settings.model_lb) {
		loversModelName = cb.settings.model_lb.trim();
	}
	
	if (!loversModelName) loversModelName = cb.room_slug.charAt(0).toUpperCase() + cb.room_slug.slice(1);
	
	if (cb.settings.color_lb) {
		loversListColor = getColorCode(cb.settings.color_lb);
	}
	
	if (cb.settings.style_lb == 'Colored background') {
		loversListBgColor = getBgColorCode(cb.settings.color_lb);
		loversTextWeight = 'bold';
	}
	else {
		loversListBgColor = '';
		loversTextWeight = 'normal';	
	}

	loversMaxItems = cb.settings.max_lb;
	if (cb.settings.timer_lb == 'Never') {
		loversListTimer = 0;
	}
	else {
		loversListTimer = cb.settings.timer_lb;
	}
	loversHearts = (cb.settings.hearts_lb == 'Yes') ? 1 : 0;
	loversAnnounce = (cb.settings.announce_lb == 'Yes') ? 1 : 0;
	loversIcon = getHeartsIcon(cb.settings.icons_lb);
	if (!loversIcon) loversIcon = ':001h';
}

/*
 * Setting up the bot at start
 */
function init()
{
	//Load values in settings to global variables
	loadSettings();
	
	// Start Lovers list
	if (loversListTimer) cb.setTimeout(announceLoversList, (loversListTimer * 70000));
	
	// Bot loaded message
	// Workaround for CB bug: this delay prevents message from being showed in wrong order
	setTimeout(function(){
		cb.sendNotice(theHeader,'',loversListColor,"#FFFFFF",'bolder');
		setTimeout(function(){
			cb.sendNotice(loadText,'','',loversListColor,'bold');
		}, 300);	
	}, botNoticeDelay);		
}

init();