Chaturbate

Bots Home | Create an App
Cleopatra Harem
Author: osumba
You are viewing version 116830. There is a newer version of this app. See the latest version of this app.

Description Source Code Launch Bot Current Users
Created by: Osumba
There are 33 other versions of this script.
/*************************************************************
 **
 ** Title: Cleopatra Harem
 ** Author: modified by osumba for a similar app contact: tablesalt90@gmail.com - @tablesalt90
 ** Version: 1.0
 ** Description: Chat bot for use by cleopatra_sinns - chaturbate.com/cleopatra_sinns
 **
 *************************************************************/


/*
 * Setup vars
 */

var neferutUsersArray = new Array();
var haremUsersArray = new Array();
var khekerutUsersArray = new Array();
var ipetnesutUsersArray = new Array();
var nomarchUsersArray = new Array();
var specialNames = new Array();
var tempString = "";
var tempArray = new Array();
var botVersion = "1.2.2";
var modelName = cb.room_slug;
var msgNotify = "";
var msgPublic = "";
var msgPrivate = "";
var msgModel = "";
var autoNotice1Text = "";
var autoNotice2Text = "";
var botTrigger = "/cleobot";

var modCommands = true;
var userGreets = true;
var genderEmotes = true;

var botMsgBg = '#BDDEDC';
var botAlertBg = '#D32B2B';
var botNoteBg = '#99FF66';

specialNames[0] = new Array('osumba',':egyptian Greetings powerful Osumba! Beware Osumba has entered the room!');
specialNames[1] = new Array('desamator','Beware mortal ones!!!! Mighty pharaoh desamator entered the room! Bow onto your knees for the PHARAOH!!!');
specialNames[2] = new Array('ale_qq',' Cleo crazy stalker is in the room! :hello ale_qq');

/*
 * Settings
 */
cb.settings_choices = [
		{		name: 'genderEmotes', 
				type: 'choice', 
				label: '**NEW FEATURE** Show gender of users in chat?',
        		choice1: 'Yes',
        		choice2: 'No', 
        		defaultValue: 'Yes'
        },
        {		name: 'autoNotice1',
				label: '**NEW FEATURE** Notification Message 1, use text and emotes',
				type: 'str',
				minLength: 0,
				maxLength: 512,
				required: false,
				defaultValue: ''
		},
		{		name: 'autoNotice1Interval',
				label: 'Show Notification 1 Every x Minutes',
				type: 'choice',
        		choice1: 2,
        		choice2: 5,
        		choice3: 8,
        		choice4: 10,
        		choice5: 12,				
				choice6: 15,
				choice7: 20,
				choice8: 25,
				choice9: 30,
				choice10: 45,
				choice11: 60,
        		defaultValue: 5
		},
        {		name: 'autoNotice2',
				label: 'Notification Message 2, use text and emotes',
				type: 'str',
				minLength: 0,
				maxLength: 512,
				required: false,
				defaultValue: ''
		},
		{		name: 'autoNotice2Interval',
				label: 'Show Notification 2 Every x Minutes',
				type: 'choice',
        		choice1: 2,
        		choice2: 5,
        		choice3: 8,
        		choice4: 10,
        		choice5: 12,				
				choice6: 15,
				choice7: 20,
				choice8: 25,
				choice9: 30,
				choice10: 45,
				choice11: 60,
        		defaultValue: 5
		},		
		{		name: 'modCommands', 
				type: 'choice', 
				label: 'Allow Moderators to use commands?',
        		choice1: 'Yes',
        		choice2: 'No', 
        		defaultValue: 'Yes'
        },
		{		name: 'userGreets', 
				type: 'choice', 
				label: 'Make special user announcements when they enter?',
        		choice1: 'Yes',
        		choice2: 'No', 
        		defaultValue: 'Yes'
        },
        {		name: 'neferutTag',
				label: '*** neferuts *** *** *** Tag for neferut users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[neferut]'
		},
		{		name: 'neferutList',
				label: 'List of neferut users, separated by space (their CB usernames exactly)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},
		{		name: 'neferutColor',
				label: 'Highlight color to use for neferut users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Cyan 73EBEB'
		},		
        {		name: 'haremTag',
				label: '*** harem *** *** *** Tag for harem users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[harem]'
		},
		{		name: 'haremList',
				label: 'List of harem users, separated by space (their CB usernames exactly)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},
		{		name: 'haremColor',
				label: 'Highlight color to use for harem users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Blue 73B5EB'
		},		
        {		name: 'khekerutTag',
				label: '*** khekeruts *** *** *** Tag for khekeruts users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[khekerut]'
		},
		{		name: 'khekerutList',
				label: 'List of khekeruts useres, separated by space (their CB usernames exactly)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},		
		{		name: 'khekerutColor',
				label: 'Highlight color to use for khekerut users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Red FF4A4A'
		},	        		
        {		name: 'ipetnesutTag',
				label: '*** ipetnesuts *** *** *** Tag for ipetnesut users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[ipetnesut]'
		},
		{		name: 'ipetnesutList',
				label: 'List of ipetnesut useres, separated by space (their CB usernames exactly)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},		
		{		name: 'ipetnesutColor',
				label: 'Highlight color to use for ipetnesut users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Purple CD73EB'
		},	   		
        {		name: 'nomarchTag',
				label: '*** nomarches *** *** *** Tag for nomarch users',
				type: 'str',
				minLength: 0,
				maxLength: 25,
				required: true,
				defaultValue: '[nomarch]'
		},
		{		name: 'nomarchList',
				label: 'List of nomarch useres, separated by space (their CB usernames exactly)',
				type: 'str',
				minLength: 0,
				maxLength: 10240,
				required: false,
				defaultValue: ''
		},		
		{		name: 'nomarchColor',
				label: 'Highlight color to use for nomarch users',
				type: 'choice',
        		choice1: 'None FFFFFF',
        		choice2: 'Green 91EB73',
        		choice3: 'Purple CD73EB',
        		choice4: 'Cyan 73EBEB',
        		choice5: 'Blue 73B5EB', 
        		choice6: 'Yellow FCED79',
				choice7: 'Red FF4A4A',
				choice8: 'Pink FF99F8',
				choice9: 'Orange FFC517',
        		defaultValue: 'Orange FFC517'
		},		

];

/*
 * handle tips from users
 */
var totalTipped = 0;
cb.onTip(function (tip) {
	var divStr = "";
	var msgText = "";
	var msgNotify = "";
	var tipAmount = parseInt(tip['amount']);
	var name = tip['from_user'];
	var modelName = cb.room_slug;	
	
	switch(tipAmount) {
		case 1111111:
			result = addUser(nomarchUsersArray, name);
			if (result instanceof Array) {
				nomarchUsersArray = result;
				msgPublic = name + ' is now ' + modelName + '\'s nomarch!!! Thank you for your tip!';
				msgModel = modelName + ', don\'t forget to add ' + name + ' to nomarches in the bot config!';

			}
			else {
				if (result == 'duplicate') {
					msgPublic = name + ' is already ' + modelName + '\'s nomarch!!! Thank you for your tip!';;
				}
				else {
					msgPublic = 'Failed to add user ' + name + ' to nomarches. Something went wrong!';
				}
			}		
			
		break;
		
		case 777:
			if (!userInArray (nomarchUsersArray, name) ) {
				result = addUser(ipetnesutUsersArray, name);
				if (result instanceof Array) {
					ipetnesutUsersArray = result;
					msgPublic = name + ' is now ' + modelName + '\'s ipetnesut!!! Thank you for your tip!';
					msgModel = modelName + ', don\'t forget to add ' + name + ' to ipetnesuts in the bot config!';

				}
				else {
					if (result == 'duplicate') {
						msgPublic = name + ' is already ' + modelName + '\'s ipetnesut!!! Thank you for your tip!';;
					}
					else {
						msgPublic = 'Failed to add user ' + name + ' to ipetnesuts. Something went wrong!';
					}
				}
			}
			else {
				msgPublic = name + ' is already has a higher status than ipetnesut! Status not changed. Thank you for your tip!';
			}			
		break;
		
		case 444:
			if (!userInArray (nomarchUsersArray, name) && !userInArray (ipetnesutUsersArray, name)) {				
				result = addUser(khekerutUsersArray, name);
				if (result instanceof Array) {
					khekerutUsersArray = result;
					msgPublic = name + ' is now ' + modelName + '\'s khekerut!!! Thank you for your tip!';
					msgModel = modelName + ', don\'t forget to add ' + name + ' to khekeruts in the bot config!';

				}
				else {
					if (result == 'duplicate') {
						msgPublic = name + ' is already ' + modelName + '\'s khekerut!!! Thank you for your tip!';;
					}
					else {
						msgPublic = 'Failed to add user ' + name + ' to khekeruts. Something went wrong!';
					}
				}
			}
			else {
				msgPublic = name + ' already has a higher status than khekerut! Status not changed. Thank you for your tip!';
			}			
		break;
		
		case 222:
			if (!userInArray (nomarchUsersArray, name) && !userInArray (ipetnesutUsersArray, name) && !userInArray (khekerutUsersArray, name)) {			
				result = addUser(neferutUsersArray, name);
				if (result instanceof Array) {
					neferutUsersArray = result;
					msgPublic = name + ' is now in ' + modelName + '\'s harem!!! Thank you for your tip!';
					msgModel = modelName + ', don\'t forget to add ' + name + ' to khekeruts in the bot config!';

				}
				else {
					if (result == 'duplicate') {
						msgPublic = name + ' is already in ' + modelName + '\'s harem!!! Thank you for your tip!';;
					}
					else {
						msgPublic = 'Failed to add user ' + name + ' to harem. Something went wrong!';
					}
				}
			}
			else {
				msgPublic = name + ' already has a higher status than neferut! Status not changed. Thank you for your tip!';
			}
		break;
		
		default:
			msgPublic = 'Thank you ' + name + ' for your tip of ' + tipAmount;
			if (tipAmount == 1) {
				msgPublic += ' token!';
			} else {
				msgPublic += ' tokens!';
			}
		break;
	}

	// Output any notices or command results to user
	if (msgPrivate.length > 0) {
		cb.chatNotice(msgNotify, name, botMsgBg,'','bold');
		msgPrivate = "";
	}
	
	// Output any public notices or command results
	if (msgPublic.length > 0) {
		cb.chatNotice(msgPublic, '', botMsgBg,'','bold');
		msgPublic = "";
	}		
	
	// Output any messages to the model
	if (msgModel.length > 0) {
		cb.chatNotice(msgModel, modelName, botMsgBg,'','bold');
		msgModel = "";
	}	

});

/*
 * handle user entrance messages
 */
cb.onEnter(function(user) {
	var lenOfSpecialNames = 0;
	var nameFound = false;
	var greeting = '';
	var modelName = cb.room_slug;	
	name = user['user'];

	lenOfSpecialNames = specialNames.length;

	for(i=0; i < lenOfSpecialNames; i++) {
		if (specialNames[i][0] == name) {
			greeting = specialNames[i][1];
			nameFound = true;
			break;
		}
	}
	
	if (nameFound && userGreets) {
		cb.chatNotice(greeting,'','#FFFFFF');
	}	
	else {
	
		if (userGreets) {
			if ( userInArray (haremUsersArray, user['user']) ) {
				cb.chatNotice('Welcome harem Member ' + user['user'] + ' to the room!','',haremColor,'','bold');
			}
			else {
				if ( userInArray (neferutUsersArray, user['user']) ) {
					cb.chatNotice('Welcome neferut ' + user['user'] + ' to the room!','',neferutColor,'','bold');
				}
				else 					{
					if (userInArray(khekerutUsersArray, user['user'])) {
						cb.chatNotice('Welcome khekerut ' + user['user'] + ' to the room!','',khekerutColor,'','bold');			
					}
					else {
						if (userInArray(ipetnesutUsersArray, user['user'])) {
							cb.chatNotice('Welcome ipetnesut ' + user['user'] + ' to the room!','',ipetnesutColor,'','bold');
						}
						else {
							if (userInArray(nomarchUsersArray, user['user'])) {
								cb.chatNotice('Welcome nomarch ' + user['user'] + ' to the room!','',nomarchColor,'','bold');
							}
						}
					}
				}
				
			}
		}
	}

	cb.chatNotice('\nWelcome to Cleopatra Sinns room! Cleopatra Court of the sun Bot is running - Tip to join Cleopatra Harem, 222 to be my Neferut, 444 to be my Khekerut Nesut or 777 to be my Ipet Nesut! Read profile for more!\n\n',user['user'],botMsgBg,'','bold');
	
	if (genderEmotes) {
	
		cb.chatNotice('Gender Emotes are enabled: :avatar_gen_male = Male User :avatar_gen_female = Female User\n :avatar_gen_couple = Couple User :avatar_gen_trans = Transgender User\n :avatar_gen_unknown = Gender Unknown\n\n',user['user'],'#ffffff','','bold');
	
	}
	
	if (modelName != 'cleopatra_sinns') {
		cb.chatNotice('\nThis is NOT cleopatra_sinns\'s room!\nThis bot was created for cleopatra_sinns chaturbate.com/cleopatra_sinns\nFollower her and visit her room on CB!\n\n\n',user['user'],botAlertBg,'','bold');
	}
	
	
    
}); 


/*
 * handle messages from users
 */
cb.onMessage(function(message) {
	
	var msg = message['m'];
	var name = message['user'];
	var commandProcessed = false;
	var gender = message['gender'];
	var modelName = cb.room_slug;
	
	var isMod = message['is_mod'];
	var isFan = message['in_fanclub'];
    var isTS = (name == 'osumba');	
	var isReal = (cb.room_slug == 'cleopatra_sinns');	
	var isModel = (name == cb.room_slug);
	var hasTokens = message['has_tokens'];
	var hasTipped = message['tipped_recently'];
	var isGrey = !(hasTokens || isMod || isModel || isFan);	

	var divStr = "";
	var tempAllowMsg = tempAllowMsg = "Only " + modelName;	

	var userArray = new Array();
	var userList = "";	
	var showOutput = true;
	var genderStr = "";
	
	if (modCommands) {
		tempAllowMsg = modelName + " and mods";
	}
	
	helpMsg = tempAllowMsg + " may use the following commands:\n"
			+ botTrigger + " view [harem] = list of level users\n"
			+ botTrigger + " useradd [harem] [username] = add username to level\n"
			+ botTrigger + " userdel [harem] [username] = delete username from level\n"
			+ botTrigger + " check [username] = show what level a user is in\n"
			+ botTrigger + " mods [on/off] = turns on/off mod commands\n"
			+ botTrigger + " greets [on/off] = turns on/off level user greetings\n"
			+ botTrigger + " status = show bot status\n"
			+ "*** NOTE: To make names stick add them in the bot config.";

// handle commands 
	if ( isModel || (isMod && (modCommands === true)) || isTS ) {

		if (msg.indexOf(botTrigger) > -1) {
			msgParam1 = getParam(msg,' ',1);	
			msgParam2 = getParam(msg,' ',2);
			msgParam3 = getParam(msg,' ',3);
			msgParam4 = getParam(msg,' ',4);	

			switch(msgParam1) {
				case 'help':
					message['X-Spam'] = true;
					divStr = makeDiv('_',50,50);
					
					msgPrivate = divStr + '\nCleopatra Harem Bot ver ' + botVersion + '\nCreated by cleopatra_sinns\n' + divStr + '\n';
					msgPrivate += helpMsg + '\n' + divStr;
				break;
				
				case 'view':
				case 'show':
				case 'list':
					// which user array do we need to display?
					var showOutput = true;
					message['X-Spam'] = true;
					
					switch(msgParam2) {
			
						case "harem":
							userArray = haremUsersArray;
						break;
						
						case "neferuts":
						case "neferut":
							userArray = neferutUsersArray;
						break;
						
						case "khekeruts":
						case "khekerut":
							userArray = khekerutUsersArray;
						break;
						
						case "ipetnesut":
						case "ipetnesuts":
							userArray = ipetnesutUsersArray;
						break;
						
						case "nomarch":
						case "nomarches":
							userArray = nomarchUsersArray;
						break;
						
						default:
							showOutput = false;
							msgPrivate = "You must provide a group name to list: harem neferuts khekeruts ipetnesuts nomarches";
							
						break;

					}
					if (showOutput === true) {
						userList = getUsers(userArray);
						arrayProperName = msgParam2.charAt(0).toUpperCase() + msgParam2.substring(1);
						
						if (userList.length > 1) {
							divStr = makeDiv('_',userList.length,50);
							msgPrivate = divStr + '\n' + arrayProperName + ' Users\n';
							msgPrivate += userList;
							msgPrivate += '\n' + divStr;
						}
						else {
							msgPrivate = 'No ' + arrayProperName + ' users found!';
						}
						
						if (!isModel) {
							msgModel = name + ' viewed the list ' + arrayProperName + ' Users.';
						}
					}					
				break;
				
				case 'useradd':
				case 'adduser':
				case 'add':
					var validSyntax = true;
					// check that we got 3 parameters
					if (msgParam3) {
						// which user array are we updating?
						switch(msgParam2) {
							
							case "harem":
								result = addUser(haremUsersArray, msgParam3);
								if (result instanceof Array) {
									haremUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of harem!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to the harem list in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in harem!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to harem. Something went wrong!';
									}
								}
								
							break;
							
							case "neferuts":
							case "neferut":
								result = addUser(neferutUsersArray, msgParam3);
								if (result instanceof Array) {
									neferutUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of neferuts!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to neferuts in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in neferuts!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to neferuts. Something went wrong!';
									}
								}							
							break;
							
							case "khekeruts":
							case "khekerut":
								result = addUser(khekerutUsersArray, msgParam3);
								if (result instanceof Array) {
									khekerutUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of khekeruts!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to khekeruts in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in khekeruts!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to khekeruts. Something went wrong!';
									}
								}								
							break;
							
							case "ipetnesut":
							case "ipetnesuts":
								result = addUser(ipetnesutUsersArray, msgParam3);
								if (result instanceof Array) {
									ipetnesutUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of ipetnesuts!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to ipetnesuts in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in ipetnesuts!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to ipetnesuts. Something went wrong!';
									}
								}							
							break;
							
							case "nomarch":
							case "nomarches":
								result = addUser(nomarchUsersArray, msgParam3);
								if (result instanceof Array) {
									nomarchUsersArray = result;
									msgPublic = name + ' added ' + msgParam3 + ' to the list of nomarches!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to add ' + msgParam3 + ' to nomarches in the bot config!';
									}
								}
								else {
									if (result == 'duplicate') {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' because they are already in nomarches!';
									}
									else {
										msgPrivate = 'Failed to add user ' + msgParam3 + ' to nomarches. Something went wrong!';
									}
								}							
							break;
							
							default:
								validSyntax = false;
								msgPrivate = 'You didn\'t supply a valid group to add the user to. Valid groups are:\n';
								msgPrivate += 'harem neferut khekerut ipetnesut nomarch ... choose only one.';
							break;
						}
					}
					else {
						validSyntax = false;
						msgPrivate = 'You must provide the group and the username you wish to add. For example,\n' + botTrigger + ' adduser harem someusername\n';
						msgPrivate += 'or ' + botTrigger + ' adduser nomarch someuser';
					}
					
					if (validSyntax === true) {
						message['X-Spam'] = true;
					}
					
				break;
				
				case 'userdel':
				case 'deluser':
				case 'delete':
				case 'remove':
					var validSyntax = true;
					// check that we got 3 parameters
					if (msgParam3) {
						// which user array are we updating?
						switch(msgParam2) {
							
							case "harem":
								result = delUser(haremUsersArray, msgParam3);
								if (result instanceof Array) {
									haremUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' from the harem list!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from the harem list in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in harem!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' from harem. Something went wrong!';
									}
								}
								
							break;
							
							case "neferuts":
							case "neferut":
								result = delUser(neferutUsersArray, msgParam3);
								if (result instanceof Array) {
									neferutUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' from the list of neferuts!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from neferuts in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in neferuts!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' from neferuts. Something went wrong!';
									}
								}							
							break;
							
							case "khekeruts":
							case "khekerut":
								result = delUser(khekerutUsersArray, msgParam3);
								if (result instanceof Array) {
									khekerutUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' from the list of khekeruts!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from khekeruts in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in khekeruts!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' from khekeruts. Something went wrong!';
									}
								}								
							break;
							
							case "ipetnesut":
							case "ipetnesuts":
								result = delUser(ipetnesutUsersArray, msgParam3);
								if (result instanceof Array) {
									ipetnesutUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' from the list of ipetnesuts!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from ipetnesuts in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in ipetnesuts!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' to ipetnesuts. Something went wrong!';
									}
								}							
							break;
							
							case "nomarch":
							case "nomarches":
								result = delUser(nomarchUsersArray, msgParam3);
								if (result instanceof Array) {
									nomarchUsersArray = result;
									msgPublic = name + ' removed ' + msgParam3 + ' to the list of nomarches!';
									// if model didn't issue command remind model to update the bot
									if (!isModel) {
										msgModel = modelName + ', don\'t forget to remove ' + msgParam3 + ' from nomarches in the bot config!';
									}
								}
								else {
									if (result == 'notfound') {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' because they are not in nomarches!';
									}
									else {
										msgPrivate = 'Failed to remove user ' + msgParam3 + ' to nomarches. Something went wrong!';
									}
								}							
							break;
							
							default:
								validSyntax = false;
								msgPrivate = 'You didn\'t supply a valid group to remove the user from. Valid groups are:\n';
								msgPrivate += 'harem neferut khekerut ipetnesut nomarch ... choose only one.';
							break;
						}
					}
					else {
						validSyntax = false;
						msgPrivate = 'You must provide the group and the username you wish to remove. For example,\n' + botTrigger + ' deluser harem someusername\n';
						msgPrivate += 'or ' + botTrigger + ' deluser nomarch someuser';
					}
					
					if (validSyntax === true) {
						message['X-Spam'] = true;
					}
				
				break;
				
				case 'check':
					if (msgParam2) {
						message['X-Spam'] = true;
						groupList = checkUser(msgParam2);
						
						msgPrivate = 'User ' + msgParam2 + ' found in: ' + groupList;
					}
				break;
				
				case 'modcommands':
				case 'mods':
					if(isModel || isTS) {
						if (msgParam2) {
							message['X-Spam'] = true;
							switch(msgParam2) {
								case "on":
									modCommands = true;
									msgPublic = name + ' has enabled Moderator commands!';
								break;
								
								case "off":
									modCommands = false;
									msgPublic = name + ' has disabled Moderator commands!';							
								break;
								
								default:
									// invalid option
									msgPrivate = 'Invalid option, you must use on or off. Example: ' + botTrigger + ' modcommands off';
								break;
							}
						}
						else {
							// missing on/off value
							msgPrivate = 'Missing option, you must use on or off. Example: ' + botTrigger + ' modcommands on';
						}
					}
				break;
				
				case 'greets':
				case 'greetings':
					if(isModel || isTS) {
						if (msgParam2) {
							message['X-Spam'] = true;
							switch(msgParam2) {
								case "on":
									userGreets = true;
									msgPublic = name + ' has enabled User Greetings!';
								break;
								
								case "off":
									userGreets = false;
									msgPublic = name + ' has disabled User Greetings!';							
								break;
								
								default:
									// invalid option
									msgPrivate = 'Invalid option, you must use on or off. Example: ' + botTrigger + ' greets off';
								break;
							}
						}
						else {
							// missing on/off value
							msgPrivate = 'Missing option, you must use on or off. Example: ' + botTrigger + ' greets on';
						}
					}			
				break;
				
				case "status":
				case "announce":
					message['X-Spam'] = true;
					msgPrivate = announceBot();
				break;
				
				default:
					message['X-Spam'] = true;
					msgPrivate = 'You must provide a command. Type ' + botTrigger + ' help\n ...to get a list of options.';
				break;
			
			
			}

			// Output any notices or command results to user
			if (msgPrivate.length > 0) {
				cb.chatNotice(msgPrivate, name, botMsgBg,'','bold');
				msgPrivate = "";
			}
			
			// Output any public notices or command results
			if (msgPublic.length > 0) {
				cb.chatNotice(msgPublic, '', botMsgBg,'','bold');
				msgPublic = "";
			}		
			
			// Output any messages to the model
			if (msgModel.length > 0) {
				cb.chatNotice(msgModel, modelName, botMsgBg,'','bold');
				msgModel = "";
			}
			
			
		}
	}
	
	// if user is in a group, add the group tag to their message
	// and change the background color
	if ( userInArray (haremUsersArray, name) ) {
		message['background'] = haremColor;
		message['m'] = haremTag + ' ' + message['m'];
	}
	else {
		if ( userInArray (neferutUsersArray, name) ) {
			message['background'] = neferutColor;
			message['m'] = neferutTag + ' ' + message['m'];
		}
		else 					{
			if (userInArray(khekerutUsersArray, name)) {
				message['background'] = khekerutColor;
				message['m'] = khekerutTag + ' ' + message['m'];
			}
			else {
				if (userInArray(ipetnesutUsersArray, name)) {
					message['background'] = ipetnesutColor;
					message['m'] = ipetnesutTag + ' ' + message['m'];
				}
				else {
					if (userInArray(nomarchUsersArray, name)) {
						message['background'] = nomarchColor;
						message['m'] = nomarchTag + ' ' + message['m'];
					}
				}
			}
		}
		
	}
	
	// if gender emotes are enabled, prefix message with correct gender
	if (genderEmotes) {
		switch (gender) {
			case 'm':
				genderStr = ':avatar_gen_male';
			break;
			
			case 'f':
				genderStr = ':avatar_gen_female';
			break;
			
			case 's':
				genderStr = ':avatar_gen_trans';
			break;
			
			case 'c':
				genderStr = ':avatar_gen_couple';
			break;
			
			default:
				genderStr = ':avatar_gen_unknown';
			break;
		}
		message['m'] = genderStr + ' ' + message['m'];
	}	
	
}); //end onMessage



/*
 * bot functions
 */

/*
 * display notification message and start interval timer
 */ 
function displayNotification1() {
	cb.chatNotice(autoNotice1Text,'',botNoteBg,'','bold');
	cb.setTimeout(displayNotification1, cb.settings.autoNotice1Interval * 60000);
}

function displayNotification2() {
	cb.chatNotice(autoNotice2Text,'',botNoteBg,'','bold');
	cb.setTimeout(displayNotification2, cb.settings.autoNotice2Interval * 60000);
}

/*
 * return parameter value from a message string
 * Req: msgString = full message as string
 * Req: splitChr = character to split on (usually space)
 * Req: paramNumber = number of the parameter to return (first is 0)
 * Return: paramValue = value of the requested parameter
 */
function getParam(msgString,splitChr,paramNumber) {
	var tempArray = new Array();
	
	tempArray = msgString.split(splitChr);
	paramValue = tempArray[paramNumber];

	return paramValue;
}

/*
 * build a variable length divider from a character
 * Req: divChr = the character to use for the divier, ie: _ - *
 * Req: strLen = length of the data to be divided (lenth of a string, or fixed)
 * Req: maxDivLen = the max number of characters the div can grow to
 * Return: divStr = string of repeated character that make the divider
 */
function makeDiv(divChr, strLen, maxDivLen) {
	var divLen = 0;
	var divStr = "";
	
	if (strLen > maxDivLen) {
		divLen = maxDivLen; 
	}
	else {
		divLen = strLen;
	}
	
	while (divStr.length < divLen) {
        divStr = divChr + divStr;
    }
    return divStr;	
}

/*
 * return array of users with the new user added, duplicate,
 * or error string.
 * Req: userArray = array of users to add the new user to
 * Req: username = username of new user
 * Return: array of users with new users added
 * On error: return "duplicate" if username in user array already
 * On error: return "failed" if user no duplicate and wasn't added
 */
function addUser(userArray, username) {
	var userArrayLength = userArray.length;
	username = username.toLowerCase();
	
	// check if username is in userarray
	usernameExists = userInArray(userArray, username);
	
	if (usernameExists === true) {
		return "duplicate"; // username found in array, return duplicate
	}
	else {

		// remove user from all user arrays
		delUserFromAll(username);
		
		// add username to array
		userArray[userArrayLength] = username;

		// check to see that addition of user worked
		usernameExists = userInArray(userArray, username);
		if (usernameExists === true) {
			return userArray; // it worked, return the array
		}
		else {
			return "failed"; // failed, return failed
		}
	}
}


/*
 * return array of users with the new user removed, duplicate,
 * or error string.
 * Req: userArray = array of users to add the new user to
 * Req: username = username of new user
 * Return: array of users with user removed
 * On error: return "notfound" if username not in user array
 * On error: return "failed" if user no duplicate and wasn't added
 */
function delUser(userArray, username) {
	var userArrayLength = userArray.length;
	var userElement = -1;

	username = username.toLowerCase();
	
	if (userInArray(userArray, username)) {
	
		userElement = getArrayElement(userArray, username);
		if (userElement > -1) {
			tempArray = removeArrayElement(userArray, userElement);
		
			if (!userInArray(userArray, username)) {
				// user was removed
				return tempArray;
			}
			else {
				// user was not removed, failed
				return "failed";
			}
		}
		else {
			//user element was not in array for some reason
			return "failed";
		}
	}
	else {
	  return 'notfound';
	}	
}

/*
 * remove a user from all groups
 * Req: username = name over user to remove
 * Return: none
 */
function delUserFromAll(username) {
	
		if ( userInArray(neferutUsersArray, username) ) {
			result = delUser(neferutUsersArray, username);
			if (result instanceof Array) {
				neferutUsersArray = result;
			}
		}
		if ( userInArray(haremUsersArray, username) ) {
			result = delUser(haremUsersArray, username);
			if (result instanceof Array) {
				haremUsersArray = result;
			}
		}									
		if ( userInArray(khekerutUsersArray, username) ) {
			result = delUser(khekerutUsersArray, username);
			if (result instanceof Array) {
				khekerutUsersArray = result;
			}
		}
		if ( userInArray(ipetnesutUsersArray, username) ) {
			result = delUser(ipetnesutUsersArray, username);
			if (result instanceof Array) {
				ipetnesutUsersArray = result;
			}
		}
		if ( userInArray(nomarchUsersArray, username) ) {
			result = delUser(nomarchUsersArray, username);
			if (result instanceof Array) {
				nomarchUsersArray = result;
			}
		}
	
}


/*
 * return the element or index number of an array value
 * Req: sourceArray =  array to parse
 * Req: value = value to find
 * Return: index of the element
 */
function getArrayElement(sourceArray, value) {
	var index = 0;
	
	for (i = 0; i < sourceArray.length; i++) {
		if (sourceArray[i] == value) {
			index = i;
		}	
	}
	
	return index;
}

/*
 * return an array with the indicated element removed
 * Req: sourceArray = array to be modified
 * Req: element = element to be removed
 * Return: the modified array
 */
function removeArrayElement(sourceArray,element) {
	
	sourceArray.splice(element, 1);
	
	return sourceArray;
}

/*
 * return boolean if user is in user array
 * Req: userArray = array of users to parse
 * Req: userName = name of user to parse fr
 * Returns: userFound = true or false
 */
function userInArray(userArray, username) {
	var userFound = false;
	
	username = username.toLowerCase();
	
	if (userArray.length > 0) {
		for(i=0; i < userArray.length; i++) {
			if (userArray[i] == username) userFound = true;
		}
	}
	
	return userFound;
}

/*
 * return a string of usernames from an array of users
 * Req: userArray = array of users
 * Return: string of of usersnames
 */
function getUsers(userArray) {
	var userList = "";
	
	for (i = 0; i < userArray.length; i++) {
		userList += userArray[i] + ' ';
	}
	
	return userList;
}

/*
 * return list of groups that a user is a member of
 * Req: username = username to find
 * Return: string with list of groups the user was found in
 */
function checkUser(username) {
	var groupList = "";
	
	username = username.toLowerCase();
	
	if (userInArray(haremUsersArray, username)) groupList += "harem ";
	if (userInArray(neferutUsersArray, username)) groupList += "neferuts ";
	if (userInArray(khekerutUsersArray, username)) groupList += "khekeruts ";
	if (userInArray(ipetnesutUsersArray, username)) groupList += "ipetnesuts ";
	if (userInArray(nomarchUsersArray, username)) groupList += "nomarches";
	
	return groupList;
}
function notModel() {
	var notModelMsg = '\n\n' + modelName + '! This bot was created for ';
	notModelMsg += 'cleopatra_sinns, you are not her! Please consider having your own ';
	notModelMsg += 'bot created. Contact cleopatra_sinns\n\n';
	return notModelMsg;
}
/*
 * Builds user arrays and strings based on data provided by bot
 * config settings
 */
function loadSettings() {

	// mod commands
	if (cb.settings.modCommands == 'Yes') {
		modCommands = true;
	}
	else {
		modCommands = false;
	}

	// greetings
	if (cb.settings.userGreets == 'Yes') {
		userGreets = true;
	}
	else {
		userGreets = false;
	}

	// gender emotes
	if (cb.settings.genderEmotes == 'Yes') {
		genderEmotes = true;
	}
	else {
		genderEmotes = false;
	}
	
	// load neferuts into array and other variables
	if (cb.settings.neferutList) {
		tempStr = cb.settings.neferutList.toLowerCase(); //make names all lowercase
		cb.settings.neferutList = tempStr.trim(); // remove extra spaces
		neferutUsersArray = cb.settings.neferutList.split(' ');
	}
	if (cb.settings.neferutTag) {
		neferutTag = cb.settings.neferutTag.trim();
	}
	if (cb.settings.neferutColor) {
		tempArray = cb.settings.neferutColor.split(' ');
		neferutColor = '#' + tempArray[1];
	}

	// load harem into array and other variables
	if (cb.settings.haremList) {
		tempStr = cb.settings.haremList.toLowerCase(); //make names all lowercase
		cb.settings.haremList = tempStr.trim(); // remove extra spaces
		haremUsersArray = cb.settings.haremList.split(' ');
	}
	if (cb.settings.haremTag) {
		haremTag = cb.settings.haremTag.trim();
	}
	if (cb.settings.haremColor) {
		tempArray = cb.settings.haremColor.split(' ');
		haremColor = '#' + tempArray[1];
	}

	// load khekerut into array and other variables
	if (cb.settings.khekerutList) {
		tempStr = cb.settings.khekerutList.toLowerCase(); //make names all lowercase
		cb.settings.khekerutList = tempStr.trim(); // remove extra spaces
		khekerutUsersArray = cb.settings.khekerutList.split(' ');
	}
	if (cb.settings.khekerutTag) {
		khekerutTag = cb.settings.khekerutTag.trim();
	}
	if (cb.settings.khekerutColor) {
		tempArray = cb.settings.khekerutColor.split(' ');
		khekerutColor = '#' + tempArray[1];
	}	

	// load ipetnesut into array and other variables
	if (cb.settings.ipetnesutList) {
		tempStr = cb.settings.ipetnesutList.toLowerCase(); //make names all lowercase
		cb.settings.ipetnesutList = tempStr.trim(); // remove extra spaces
		ipetnesutUsersArray = cb.settings.ipetnesutList.split(' ');
	}
	if (cb.settings.ipetnesutTag) {
		ipetnesutTag = cb.settings.ipetnesutTag.trim();
	}
	if (cb.settings.ipetnesutColor) {
		tempArray = cb.settings.ipetnesutColor.split(' ');
		ipetnesutColor = '#' + tempArray[1];
	}

	// load nomarch into array and other variables
	if (cb.settings.nomarchList) {
		tempStr = cb.settings.nomarchList.toLowerCase(); //make names all lowercase
		cb.settings.nomarchList = tempStr.trim(); // remove extra spaces
		nomarchUsersArray = cb.settings.nomarchList.split(' ');
	}
	if (cb.settings.nomarchTag) {
		nomarchTag = cb.settings.nomarchTag.trim();
	}
	if (cb.settings.nomarchColor) {
		tempArray = cb.settings.nomarchColor.split(' ');
		nomarchColor = '#' + tempArray[1];
	}	
	
	// load notifications
	if (cb.settings.autoNotice1) {
		autoNotice1Text = cb.settings.autoNotice1.trim();
	}
	
	if (cb.settings.autoNotice2) {
		autoNotice2Text = cb.settings.autoNotice2.trim();	
	}
	
}

function announceBot() {
	var divStr="";
	var statusMsg = "";
	
	divStr = makeDiv('*', 45, 45);
	
	statusMsg = divStr + '\nCleopatra Harem Bot ver ' + botVersion + '\nCreated by cleopatra_sinns\n' + divStr + '\n';
	statusMsg += 'Gender Emotes: ';
	if (genderEmotes) {
		statusMsg += 'On';
	}
	else {
		statusMsg += 'Off';
	}
	statusMsg += '\n';
	statusMsg += 'Mod Commands: ';
	if (modCommands) {
		statusMsg += 'On';
	}
	else {
		statusMsg += 'Off';
	}
	statusMsg += '\n';
	statusMsg += 'User Greetings: ';
	if (userGreets) {
		statusMsg += 'On';
	}
	else {
		statusMsg += 'Off';
	}
	statusMsg += '\n';
	statusMsg += 'Number of neferuts: ' + neferutUsersArray.length + '\n';
	statusMsg += 'Number in harem: ' + haremUsersArray.length + ' (tip 222)\n';
	statusMsg += 'Number of khekeruts: ' + khekerutUsersArray.length + ' (tip 444)\n';
	statusMsg += 'Number of ipetnesuts: ' + ipetnesutUsersArray.length + ' (tip 777)\n';
	statusMsg += 'Number of nomarches: ' + nomarchUsersArray.length + ' (read profile)\n';
	statusMsg += 'Type - ' + botTrigger + ' help - for list commands\n';
	statusMsg += divStr;

	return statusMsg;

}

loadSettings();

cb.chatNotice(announceBot(),'', botMsgBg,'','bold');
if (modelName !='cleopatra_sinns') cb.chatNotice(notModel(),modelName,botAlertBg,'','bold');
if (autoNotice1Text) cb.setTimeout(displayNotification1, cb.settings.autoNotice1Interval * 60000);
if (autoNotice2Text) cb.setTimeout(displayNotification2, cb.settings.autoNotice2Interval * 60000);