{"desc":"The ChatBox is comming soon. It will be available in version 3.6."}
 

FCChat V3.X

Product Manual

2 Administrator Guide


where is it
2.1 Installing FCChat

Instructions for installing FCChat may vary, depending on your installation type. A tutorial that guides you through the process of installing and configuring the chat client may be found in the User Guide.


2.2 Accessing the FCChat Configuriation

The location of the FCChat configuration depends on your installation type. For WordPress, Joomla 1.6+, Drupal 7+, or PhpBB 3+ installations, the configuration is built into the dashboard for your site adminstration. (For wordpress users, go to Settings >> FCChat Settings from the wp dashboard)

For other installation types, the recommended method for configuring your chat is to use the global configuration template (FCChat/config/global.config.js).  A tutorial on this method may be found here. Alternatively, site administrators with these installation types may edit the main configuration file (FCChat/config/config.js) directly.


2.3 Configuriation Parameters Explained

A full discussion of FCChat configuration parameters follows. These parameters may be found in the FCChat Settings page (for installations with built in configuration settings) and/or in the main configuration file (FCChat/config/config.js).

2.2.1 Connecting to the chat server

The connection parameters are shown below:
	//CONNECTION
	chat_id:"1000_00000000000",
	host:"66.197.216.85",
	port:443,
	policy_port:443,

Once you have activated FCChat, you will receive the chat_id and host values that will allow you to make a connection to the chat server. Enter those values in your configuration, as the above example shows.

In FCChat version 3.x it is not really necessary to change the port or policy_port from their defualt values.


2.2.2 FCChat and jQuery version

Version info shown below:
	//VERSION
	version:"3.5.0.4",
	subversion:"1",
	jQuery_stable:"1.8.1",

The version and subversion fields convey the current version of FCChat.

The jQuery_stable parameter indicates the version of jQuery that FCChat is using. FCChat will load the required version of jQuery if it is not already present in the web page, or if the version in the page is older than the one specified by the parameter.


2.2.3 Global Configuration

This section allows you to set up a global configuration template file (global.config.js), which may be placed outside the fcchat folder. The global configuration template allows you install updates more easily, because the configuration settings contained within the template carry over from one version to the next. Installations which have a built in configuration, such as WordPress and Joomla, generally do not make use of this file. For more details, see Using the global configuration template for seemless updates.

	// GLOBAL CONFIGURATION
	use_global_configuration:true,
	global_configuration_url:"", 

use_global_configuration should be enabled if you are using the global configuration file.

global_configuration_url is the full path to the global configuration file. ie. http://yoursite.com/global.config.js This should be set only if you wish to place the global.config.js file somewhere other than the root of your site.


2.2.4 Branding

Branding section shown below:
	// Branding
	small_logo:"", //around 16x16
	big_logo:"", //around 80x80
	widget_title:"ChatCenter",
	branding_bar_title:"Yourdomain Chat", 
	branding_bar_width:140, 
	startText:"Click here to join our chat.",
	loginText:"Please please sign using your site account.",
	autoGreet:"Wellcome!! ",
	full_page_loading:"Yourdomain chat will load momentarily",
	full_page_login:"Welcome to Yourdomain chat. Sign in to enter.",

small_logo A 16×16 (approx) logo for your site. Insert the full path to the image file. ie. http://www.mysite.com/image.png.

big_logo A 80×80 (approx) logo for your site. Insert the full path to the image file. ie. http://www.mysite.com/image.png.

widget_title The title displayed on the embedded widget..

branding_bar_title Title displayed on the branding bar. Add the branding bar to the toolbar by inserting ‘fullpage:logo’ into toolbar_items field below.

branding_bar_width Width of the branding bar.

startText Text displayed by the widget when it starts up.

loginText Text displayed by the login panel when user integration is enabled.

autoGreet A message that is displayed when a user opens the ChatCenter window. The message could contain instructions and/or a welcoming message.

full_page_loading Text displayed when the full page chat is loading.

full_page_loading Text displayed if the full page chat requires signin.



2.2.5 Permissions

Permisions section shown below:
	// PERMISSIONS
	require_login:false, 
	guests_can_chat:true, 
	guests_can_video_chat:true,
	videoconerence_only_in_designated_rooms:false,

require_login When true, guests are required to login to gain access to the chat.

guests_can_chat If no, guests may not send chats in the rooms (they can still observe).

guests_can_video_chat Allow guest accounts to use the video chat.

videoconerence_only_in_designated_rooms Videoconferencing can be accessed only in rooms designated for video chat.



2.2.6 User Integration

The user integration section allows you to sync your site user accounts with the chat. Refer to the FCChat User Guide for info on how to set up user integration.

	// USER INTEGRATION
	user_integration_bridge:"",
	login_redirect:"",

user_integration_bridge Specifies the type of integration.

login_redirect The URL of your site’s login page. The user will be redirected here if they have not signed in.



2.2.7 Alignment of dialog boxes with respect to the widget.

The alignment of dialog boxes depends on where the widget has been placed in the page. For instance, if the widget is in the right sidebar, then the best alignment is “left”, so that the dialogs open more toward the center of the page.

	// Align Online, New messages and Friends boxes
	alignment:"auto", // "left","right", or "auto

alignment Choices are “left”,”right”, or “auto”. The “auto” setting automatically detects alignment



2.2.8 Setting the Default Language

Language Section shown below:
	//LANGUAGE (templates located in the languages folder)
	language_template:"english.js",

Set language_template to the name of the language file you want (for instance, english.js). The language templates are in the fcchat/languages folder, so make sure a file for your language exists before setting this parameter.


2.2.9 Setting the Style Templates

Style Template Section shown below:
	// STYLE TEMPLATES
	templates:{
		alldomains:{
			widget:"widget_default_header.js",
			toolbar:"toolbar_default.js",
			application_window:"chatcenter_light_gray.js"
		}
	},

Set widget to the name of the style template file you want (for instance, widget_default_header.js). The widget style templates are found in the fcchat/styles folder, and they are prefixed by the word “widget”. The widget templates offer differing themes and or configurations of the embedded FCChat widget.

Set toolbar to the name of the style template file you want (for instance, toolbar_default.js). The toolbar style templates are found in the fcchat/styles folder, and they are prefixed by the word “toolbar”. The toolbar templates offer differing themes and or configurations of the floating toolbar.

Set application_window to the name of the style template file you want (for instance, chatcenter_light_gray.js). Application window templates are found in the fcchat/styles folder as well. They are prefixed by the word “chatcenter”. The application window templates offer different themes for the application window.


2.2.10 Quickstyling

Quickstyling Section shown below:
	// QUICK STYLING
	quickstyling:{
		alldomains:{
			widget:{
				background_css:"",
				width_prop_offsets:"0:0:0", 
				height_offset:0, 
				text_top_offset:0, 
				height_prop_offsets:"0:0:0", 
				width_offset:0, 
				logo_top_offset:0,
				logo_left_offset:0,
				logo_css:"",
				title_css:"",
				full_page_button_css:"",
				off_button_css:"",
				infobox_css:"",
				base_font_css:"",
				title_font_css:"",
				alert_css:"",
				link_css:"",
				link_hover_css:"",
				link_disabled_css:"",
				info_css:""
			},
			toolbar:{
				background_css:"",
				divider_css:"",
				width_prop_offsets:"0:0:0", 
				text_top_offset:0, 
				off_button_left_offset:0,
				base_font_css:"",
				alert_css:"",
				link_css:"",
				link_hover_css:"",
				link_disabled_css:"",
				info_css:""
			},
			dialog:{
				border_css:"",
				title_background_css:"",
				title_css:"",
				link_css:""
			},
			application_window:{
				frame_color:"",
				title_css:""
			},
			full_page_css_obj:{
			}
		}
		
	}, 

Quickstyling offers a way to quickly customize the basic style and layout of the chat to fit your site’s needs. It is designed to be quicker and easier to implemenent than other methods of customization (namely, editing the style templates directly, or using the Template Overrides Api). However, the drawback is that it lacks the level of control associated with these other methods. We will not give details of each parameter’s function here. Instead, refer to this tutorial as an example of correct usage: Styling the chat with Quickstyling.


2.2.11 Embedded Widget Control Configuration

Embedded Control Section shown below:
	//Embedded control box
	absolute_positioning:false,
	control_visible:true,
	control_padding:"0px",

The parameters above control certain aspects of the embedded FCChat widget.

absolute_positioning, if set to false, will display the widget in the flow of page elements. This is the default setting. If set to true, the widget will be displayed at a fixed location (coordinate) within the page. If you set this parameter to true, you must also set the desired coordinates. In order to set the x,y coordinates, do the following:

a) Open the current widget style template file, located in the styles directory of your FCChat installation, with a text editor (ie fcchat/styles/wiget_default_header.js). To see which style template you are currently using, refer to the styles section of the config file. For wordpress users, use the plugin editor, in the wordress administration screen, to open/edit these files. Plugins >> Editor.

Find the following text within the widget style template:
	FCChatConfig.styles.widget={
	control:{
		top:0, //for absolute positioning
		left:310, //"     "
	
b) Set top:<Y_COORDINATE>,

(Where <Y_COORDINATE> is a number representing the distance from the top of the page to the chat widget, in pixels.)

c) Set left:<X_COORDINATE>,

(Where <X_COORDINATE> is a number representing the distance from the left side of the page to the chat widget, in pixels.)

control_visible, if set to false, will hide the embedded control. Use this mode if you only wish to display the toolbar component.

control_padding, sets the amount of spacing around the widget control.


2.2.12 Toolbar Configuration: Show/Hide the Toolbar

	// TOOLBAR OPTIONS
	show_toolbar:true,


show_toolbar Set to false in order to hide the toolbar


2.2.13 Toolbar Configuration Continued: Desktop/Laptop Options

Configuration shown below (some comments have been removed for clarity):
	toolbar_layout:0, // 0 = compact | 1 = full width
	toolbar_position:"bottomright",  
	toolbar_insert_top_spacer:false,
	toolbar_items:["friendscenter","social_media:social_media"], 
	toolbar_default_display:1, // 1 = normal | 0 = minimized
	custom_buttons:{
		
	},

The parameters above control certain aspects of the floating toolbar in desktop or laptop environments.

toolbar_layout has two settings: 0 (The toolbar will only take up enough space on the page as is necessary to show all of its components. The toolbar may be minimized in this mode.) , 1 (The toolbar will extend accross the full width of the web page. The toolbar may not be minimized in this mode.)

toolbar_position sets the location of the floating toolbar. Choices are “topleft”, “topright”, “bottomleft”, and “bottomright”.

toolbar_insert_top_spacer Attempts to create space for the toolbar at the top of a web page, by pushing other page elements down. The purpose of this setting is so that the toolbar, when placed in the topleft or topright position, will not overlap other page elements.

toolbar_items contains a list of items that will be displayed in the toolbar. The order that items appear in this list is also the order that they will be rendered in the toolbar. The list MUST contain “friendscenter”. The other items in the list are optional. To see what other items are available, refer to the Adding Toolbar Items section.

toolbar_default_display has two settings: 1 (fully extended) , or 0 (minimized).

custom_buttons adds custom buttons to the toolbar. Refer to this tutorial for a full discussion: Custom Buttons for the Toolbar.



2.2.14 Toolbar Configuration Continued: Options for mobile browsers

Configuration shown below (some comments have been removed for clarity):
	// MOBILE TOOLBAR OPTIONS
	mobile_toolbar_mode:2, // 0 - simplified, 1 - regular, 2 - auto choose
	
	use_mobile_banner:false,
	mobile_banner_position:"bottomleft", // Choices are bottomleft and topleft
	mobile_banner_exclude:/none/i,
	
	use_fixed_toolbar:false,
	fixed_toolbar_position:"bottomleft", // Choices are bottomleft and topleft
	fixed_toolbar_insert_top_spacer:false,
	fixed_toolbar_exclude:/none/i,
	
	use_static_banner:true,
	static_banner_height:35,
	static_banner_offset_top:0,
	static_banner_exclude:/none/i,
	
	// MOBILE TABLET/LARGE DISPLAY OPTIONS
	large_device_toolbar_items:["friendscenter","social_media:social_media"],
	
	// MOBILE PHONE/SMALL DISPLAY OPTIONS
	small_device_toolbar_items:["friendscenter","social_media:social_media"], 
	
	// --END MOBILE BROWSER OPTIONS

The parameters above control certain aspects of the toolbar when viewed from a mobile platform such as a mobile phone or tablet. For more information on mobile integration, read the Mobile Integration Tutorial.

mobile_toolbar_mode If set to 1, all the items in the toolbar items list will be shown. If set to 0, then only the “friendscenter” item will be shown. If set to 2, the the chat will choose between one of the two previous options, based on available screen width. This mode does not apply when the toolbar is running in the “mobile banner” mode.

use_mobile_banner enables the “mobile banner” mode, which is a mode of operation optimized for small screen devices. In this mode, the toolbar will automatically resize itself to fit in the available display window. This mode is available for small screen devices which have full fixed positioning support, such as iphone/ipod ios 6+, android 4+ phones, and blackberry 7+ phones..

mobile_banner_position Choices are “bottomleft” and “topleft”.

mobile_banner_exclude A regex containing a list of devices to be prohibited from using this mode. This has been included because the “mobile banner” mode may not display correctly on some devices. The regex is matched against the browser’s user agent string. An example would be: mobile_banner_exclude:/ipod|iphone|ipad/i,.

use_fixed_toolbar enables the “fixed toolbar” mode, which is the standard way of displaying the toolbar. In this mode, the toolbar will be fixed at the top or bottom of the page, and will scale with the page contents. This mode is available for devices which have full fixed positioning support, such as iphone/ipod ios 6+, android 4+ phones, and blackberry 7+ phones.

fixed_toolbar_position Choices are “bottomleft” and “topleft”.

fixed_toolbar_insert_top_spacer Attempts to create space for the toolbar at the top of a web page, by pushing other page elements down. The purpose of this setting is so that the toolbar, when placed at the top of the page, will not overlap other page elements.

fixed_toolbar_exclude A regex containing a list of devices to be prohibited from using this mode. This has been included because the “fixed toolbar” mode may not display correctly on some devices. The regex is matched against the browser’s user agent string. An example would be: fixed_toolbar_exclude:/ipod|iphone|ipad/i,.

use_static_banner The “static banner” mode is the same as the “fixed toolbar” mode above, except that the static banner is not “fixed” and will scroll with the page. This is a fallback mode for devices that do not support fixed positioning.

static_banner_height The height of the banner, when running in this mode.

static_banner_offset_top sets the location of the toolbar relative to the top left corner of the viewing window.

static_banner_exclude A regex containing a list of devices to be prohibited from using this mode. This has been included because the “static banner” mode may not display correctly on some devices. The regex is matched against the browser’s user agent string. An example would be: static_banner_exclude:/ipod|iphone|ipad/i,.

large_device_toolbar_items contains a list of items that will be displayed in the toolbar, when shown in a mobile device with sufficient screen width, as determined by the chat. The order that items appear in this list is also the order that they will be rendered in the toolbar. The list MUST contain “friendscenter”. The other items in the list are optional. To see what other items are available, refer to the Adding Toolbar Items section.

small_device_toolbar_items contains a list of items that will be displayed in the toolbar, when shown in a mobile device with a small screen width, as determined by the chat. The order that items appear in this list is also the order that they will be rendered in the toolbar. The list MUST contain “friendscenter”. The other items in the list are optional. To see what other items are available, refer to the Adding Toolbar Items section.



2.2.14 Chatcenter window modes

Chatcenter window modes section shown below:
	// CHATCENTER WINDOW MODES
	chatcenter_layout:0, // 0 - Chatrooms and Messages 1 - messages only
	open_chatcenter_in_new_tab:false,
	allow_split_screen_mode:true,

chatcenter_layout If set to 0, the chat window will operate in “ChatCenter mode”, that is, both chat rooms and private messages will be available to users. If this is set to 1, the chat window will operate in “MsgCenter mode”. In this mode, no chatrooms will be available. The MsgCenter mode is intended for sites that want to user the instant messageing service exclusively.

open_chatcenter_in_new_tab If this option is set to true, when you click on a chat room from the “Chat Rooms” Dialog box, the chatroom will open in a separate tab (full page), instead of in the Chatcenter application window.

allow_split_screen_mode, if set to true, enables a user to access the split screen mode, either from the options panel, or from the maximize button on the ChatCenter window.



2.2.15 Chatcenter window size

Chatcenter window size section shown below:
	// CHATCENTER WINDOW SIZE
	window_width:853,
	window_height_offset:-160,
	chat_room_height_offset:105,

window_width determines the width of the Chatcenter application window.

window_height_offset determines the height of the Chatcenter application window. The baseline height of the ChatCenter window is 568 px. An offset of -80, as shown above, reduces the height to 568-80, or 488px. The maximum height the chat window can attain is 573 px..

chat_room_height_offset sets the height of the Chat Room panel. If the parameter is positive, more space will be allocated for the Chat Room panel, and less for the Messages panel. A negative value produces the opposite affect. The Chat Room overall height may not be smaller than 200px.



2.2.16 Parameters relating to chat rooms and chat messages

CHAT ROOM PARAMS section shown below:
	// CHAT ROOM PARAMS
	skip_roomlist:false,
	default_room_index:2,
	disabled_rooms:[],
	disabled_room_msg:"You must be a member to enter this room.",
	hidden_rooms:[],
	room_message_limit:300,
	min_room_messages:50,
	max_chat_size:2000,

skip_roomlist When set to true, Clicking “Chat Rooms” will open the default chat room (pointed to by default_room_index) directly, bypassing the chat room list.

default_room_index The index of the default room. 0 is the index of the first room. Rooms are indexed in the order they were created, not by their position in the room list.

disabled_rooms
disabled_room_msg
hidden_rooms The usage of these parameters are explained in the tutorial, Setting up member only rooms.

room_message_limit is the maximum number of chat messages a room may contain before automatically refreshing itself. Limiting the number of chat messages in this way improves the performance of the chat in a high usage room. A smaller number means better performance, but at the same time, more refreshes. A refresh involves reducing the number of displayed messages in the room to min_room_messages. The refresh occurs silently and unobtrusively, so that the chatters will not be distracted by it.

min_room_messages is the number of message a room will contain after an automatic refresh. It should be a number between 0 and room_message_limit.

max_chat_size is the maximum size of a single chat message.



2.2.17 Setting the location of the full page chat

Full page section shown below:
	// FULL PAGE
	full_page_url:"",

full_page_url The url of the full page chat. The usage of this parameter is explained in the tutorial, Changing the location (URL) of the Full Page Chat.



2.2.18 Environmental variables

Environmental section shown below:
	// ENVIRONMENTAL
	default_on:true,
	set_tab:true,
	no_chat_history:false,
	showTyping:true,
	display_timestamp:false,
	sounds_on:true,
	mobile_regex:/iphone|ipod|android|mobile|blackberry|bb10|mini|	windowssce|palm/i,
	tablet_regex:/ipad|tablet/i,
	fixed_support_regex:/cpu os [6-9]|iphone os [6-9]|android [4-9]|bb10|	(?=.*blackberry)(?=.*version/[7-9])/i,
	

default_on determines whether the chat is on or off.

set_tab When this is enabled, the browser tab will serve to alert the user when new messages arrive.

no_chat_history When this is enabled, chat history pages will not be available.

show_typing If this is set to true, the word ‘typing…’ will appear next to a user’s name when they are typing a message.

display_timestamp If this is set to true, the date and time will be attached to all current chat messages. This is the default setting, however, individual users may also set this parameter through the options panel.

sounds_on If this is set to true, the chat will provide sound alerts when a user sends a message, enters room or exits a room. This is the default setting, however, individual users may also set this parameter through the options panel.

mobile_regex A regex containing a list of mobile device identifiers. This regex is matched against the browser’s user agent string.

tablet_regex A regex containing a list of tablet identifiers. This regex is matched against the browser’s user agent string.

fixed_support_regex A regex containing a list of mobile device identifiers which are known to fully support fixed positioning. This regex is matched against the browser’s user agent string.



2.2.19 Enabling/disabling the new user prompt

User prompt section shown below:
	// Prompt user to sign in to chat
	prompt_user:true,

prompt_user is set to true by default. When a new user comes to your site, an info bubble will pop up next to the toolbar, inviting them to participate in the chat. If you want to disable this, set the above parameter to false.



2.2.20 Enabling/disabling the nickname prompt

Nickname section shown below:
	// Prompt guests to enter a nickname
	prompt_nickname:true,

prompt_nickname is set to true by default. When a new user comes to your site, and opens the chat interface, they will be asked to enter a nickname for their guest account (or alternatively, to sign in). Only guest accounts are prompted in this way. Set to false to disable.



2.2.21 Letting users connect with Facebook

Facebook Connect section shown below:
	//ALLOW FACEBOOK LOGINS
	facebook_connect:true,
	fb_connection_url:"http://chat.fastcatsoftware.com:8080",

facebook_connect: If true, users will have the option of connecting to the chat with their Facebook account.

facebook_connection_url: The url of the proxy server that provides the Facebook Connect interface.



2.2.22 Setting up Country Flags

Country Flags section shown below:
	//COUNTRY FLAGS
	show_country_flags:true,
	//get your free api key from http://ipinfodb.com/register.php
	ipinfodb_api_key:"",

show_country_flags turns the country flag option on or off.

ipinfodb_api_key FCChat uses 2 different geolocation services to determine a visitors country: HostIP and IPInfoDB. IPInfoDB requires an api key to access their service, which you can obtain for free from http://ipinfodb.com/register.php. It seems that IPInfoDB is the better of the two services, so you really do need to get an api key if you want to take full advantage of the country flag option. Please do not use our api key, there is a limit the the request load that can be placed on a single api key.

Note: You need to have PHP installed on your site to use the country flag option.


2.2.23 User Profiles

Profiles section shown below:
	// PROFILES
	import_profiles:"",

import_profiles Refer to. Importing user profiles, for the proper usage of this parameter.



2.2.24 Configuration of Images, Avatars, and Smileys

IMAGES AVATARS SMILEYS section shown below:
	//IMAGES AVATARS SMILEYS
	
	upload_images_enabled:false,
	allow_crossdomain_images:true,
	current_domain:"fastcatsoftware.com", // set this to your domain
	import_default_avatar:true,
	script_type:"php",
	avatars_dir:"",
	images_dir:"",
	smileys_dir:"",
	avatar_sz:18,
	change_avatar:false,
	show_avatar_in_chats:true,

upload_images_enabled If this option is set to true. Users will be able to upload images from their hard drive to your site, and display these images in their chat messages.

allow_crossdomain_images If this option is set to true, users will be able to provide a link to an image located on another site, and display this image in their chat messages. If false, users may only link to images residing on the current domain, specified by the current_domain property.

current_domain The current domain, ie. fastcatsoftware.com (don’t include http or www). Images links in chat messages are always allowed if they originate from within the current domain.

import_default_avatar This parameter is for use with sites that have integrated their user accounts with the chat. If true, FCChat will utilize (when available) a user’s site avatar when they connect with their site account.

script_type The scripting environment of your site. Choices are “php” and “asp”.

avatars_dir Location of the avatar storage folder. If blank, the default location is used.

images_dir Location of the images storage folder. If blank, the default location is used.

smileys_dir Location of the smileys storage folder. If blank, the default location is used. More info on smileys can be found in the section, Setting Up Smileys.

FCChat images are stored in the directory ‘FCChat/html/images’ and avatars in ‘FCChat/html/images/avatars’. Set write permissions for both of these directories if you allow user to upload images/avatars. (For Linux: 777 or -rwxrwxrwx within your FTP Client)

avatar_sz The height, in pixels, of the avatar image displayed next to a user’s screen name.

change_avatar Allow users to change their avatar.

show_avatars_in_chats If true, the avatar image is displayed next to a user’s screen name in their chat messages. If false, it is not. Note: This does not turn off avatars in the side panels (online, Friends, Room Members).



2.2.25 Games Options

Games section shown below:
	//GAMES
	allow_games:true,
	//GAME ID'S should match game names in language file
	game_ids:[2,1,256,325,86,6,254,1822,607,1723,225,
	4,1607,102,327,274,3,26,6346,562,1840,557,29,255,
	272,2227,5286,567,15,1658,64,3177,330,329,273,11,
	1661,12],
	

allow_games Set to false if you want to disable two player games.

game_ids A list of game ids. This list should match the list of game names found in the language file. Each id corresponds to a different game, for instance, 2 is chess, 1 is backgammon, etc. The order of the ids determine the ordering of the games in the games menu. Refer to the come2play.com developer documentation for more info on available games.



2.2.26 Setting up Smileys

Smileys Section shown below:
	//SMILEYS
	/* 
	 * IMPORTANT-READ THIS: In smileys, You 
	 * must escape any single quotes with three backslashes.
	 * ie, a wink emoticon '-) must be encoded as \'-)
	 */
	smileys:[['sm1.gif', ':-)','18',],['sm2.gif',':-)0','24'],
	['sm3.gif',':-)1','15'],['sm4.gif',':-)2','20'],
	['sm5.gif',':-)3','16'],['sm6.gif',':-)4','18'],['sm7.gif',':-)5','26'],
	['sm8.gif',':-)6','23'],['sm9.gif',':-)7','23'],['sm10.gif',':-)8','28'],
	['sm11.gif',':-)9','22'],['sm12.gif',':-)10','36'],['sm13.gif',':-)11','30'],
	['sm14.gif',':-)12','15'],['sm15.gif',':-)13','18'],['sm16.gif',':-)14','21'],
	['sm17.gif',':-)15','28'],['sm18.gif',':-)16','15']],
	
	

smileys A formatted list of smileys.

You may add your own custom smileys to the chat or download them from any number of free smiley sites on the web. Place your smiley images in the directory: FCChat/html/images/smileys. To use these smileys in the chat, edit the parameter above as follows:

smileys:[[‘SMILEY_IMAGE_NAME_1’, ‘EMOTICON_1′,’SMILEY_IMAGE_HEIGHT_1’], [‘SMILEY_IMAGE_NAME_2’, ‘EMOTICON_2′,’SMILEY_IMAGE_HEIGHT_2’], …,[‘SMILEY_IMAGE_NAME_N’, ‘EMOTICON_N’,’SMILEY_IMAGE_HEIGHT_N’]],  

SMILEY_IMAGE_NAME_1 is the name of your first smiley image, ie. happyface.gif.
EMOTICON_1 is the text you want to associate with this smiley, ie. :-).
SMILEY_IMAGE_HEIGHT_1 is the height, in pixels, of your first smiley image.

You must enter these three parameters for each smiley you want to include. Be vary careful that you use the correct syntax. A mistake in syntax may result in an error which will prevent the chat from being displayed. It is recommended that you make a backup copy of the config file before editing smileys, so that you have something to revert back to. Note: You must escape any single quotes in your emoticons by preceding them with a three backward slashes ( \’ )

Below is an example of a correctly formatted smiley list, which includes three smileys.

smileys:[[‘happyface.gif’, ‘:-)’,’18’,],[‘sadface.gif’,’:-(‘,’24’],[‘surprised.gif’,’:-o’,’15’]],

See also Changing the size of the smiley panel


2.2.27 Setting up the video chat

Video Section shown below:
	//VIDEO
	video_enabled:true,
	video_access_level:3, 
	max_video_streams:100,
	capture_width:160,
	capture_height:120,
	hd_capture_width:320,
	hd_capture_height:240,
	fps:8,
	quality:95,
	show_a_v_icon:false,
	
	

The video chat client is disabled by default. If you signed up for a video chat account, you will need to set the video_enabled parameter to true in order to enable it.

video_access_level Defines the kind of video chat access that will be available on the site. This parameter takes four values: 0 – no access, 1 – private video chat only, 2 – public video chat only, 3 – both public and private video chat.

max_video_streams Sets the maximum number of simultaneous streams that the chat client will allow.

capture_width Width (in pixels) captured by a user’s webcam,

capture_height Height (in pixels) captured by a user’s webcam,

hd_capture_width Width (in pixels) captured by a user’s webcam when high definition is available,

hd_capture_height Height (in pixels) captured by a user’s webcam when high definition is available,

fps Capture rate (frames per second)

quality Higher quality means less compression. Range is 0-100.

show_a_v_icon Show the audio video icon next to rooms which allow video chat. This icon is only meaningful if you have set videoconerence_only_in_designated_rooms to true.

Increasing capture_width, capture_height and quality will increase the video resolution. Increasing fps will make the video appear less choppy. Of course, increasing any of these values will also increase the video bandwidth consumption, which may degrade the quality of the video for users with slow connections.


2.2.28 Translator Configuration

Translator Section shown below:
	//TRANSLATOR
	trans_enabled:true,
	trans_default_on:false,
	trans_default_language_code:"en",
	trans_url:"http://api.microsofttranslator.com/V2/Ajax.svc/",
    	trans_appid:"4690BC25149C7E7E98E4A356B8C807D6A7132424",
	
	

trans_enabled Enables/disables the translator.

trans_default_on If you want all chats translated into a specific language by default, set this to true. Otherwise, no default translation will take place. A user may override any default settings by selecting/deselecting a translation language in the options panel.

trans_default_language_code A two letter language code representing the default translation language. The list of available language codes is found in the current ChatCenter style template (fcchat/styles/ folder). The list of language names may be found in the current language file (fcchat/languages/ folder)

trans_url The base url of the translation api.

trans_appid The application id used to make requests to the translation service. You can use the default value provided, but at some point, you may want to get your own appID. Go to http://www.microsofttranslator.com/dev/ in order to sign up for your free appID.



2.2.29 Transliteration Configuration

Translator Section shown below:
	//TRANSLITERATION
    	transliteration_enabled:true,
	
	

transliteration_enabled Enables/disables the translateration service.

The transliteration service is powered by Google. The FCChat transliteration application automatically loads all available languages into the transliteration menu.


2.2.30 Cookies

Cookies Section shown below:
	//COOKIES
    	cookie_expires:1, //0 - end of session //1 - never
	user_cookie:"fc_UID2", 
	session_cookie:"fc_Anon_ChatToken",
	mod_cookie:"fc_Anon_ChatToken",
	data_cookie:"fc_anon_data",
	

FCChat sets cookies on the user’s browser to maintain application state.

cookie_expires takes 2 values. 0 – cookies expire at the end of the session (when the user closes the browser). 1 – cookies never expires.

The other cookie related parameters above set the names of the cookies that FCChat uses. Ordinarily, you will not need to change these settings. The only instance in which it is necessary to change the cookie names is if you are running 2 or more different versions of FCChat on the same domain, which required different application states. Then you must change the cookie names for each version, in order to avoid conflics.


2.2.31 Miscellaneous Configuration Variables

MISC Section shown below:
	//MISC
        allow_links:true,
	help_link:"http://www.fastcatsoftware.com/chat/manual2.2.html",
	show_help_button:true,
	show_user_list:true,
	show_settings_on_open:false,
	pin_windows:true,
	pinned_by_default:true,
	preload_images:false,
	noshow:false,
	flashEnabled:'test',
	websocketEnabled:'test',
	userbox_mode:0,
	zindex_base:0,
	domain:null,
	dir: window["fc_chat_path"] || "/FCChat/",
	alt_dir: "",
	

allow_links Allow users to post links to external sites.

help_link When a user presses the ‘Help’ button, they are directed to this link, By default, help_link points to this manual.

show_help_button If true, the help link will be shown.

show_user_list If true, the user list link will be shown.

show_settings_on_open If true, the room settings panel will automatically open after the ChatCenter window has loaded.

pin_windows Enables/disables window “pinning”. Application windows may be pinned/unpinned from their fixed position on the screen. A pinned window remains in place as a user scrolls up and down the page. An unpinned window scrolls with the page. The pin icon at the top left corner of the application window toggles the pin state.

pinned_by_default Sets the default “pin state” of the application windows. When true, windows open in the “pinned” state by default.

preload_images When this is enabled, the chat will preload all of its images. This may make image transitions a bit smoother; however, it will increase bandwidth consumption. (Default: false)

noshow If set to true, the toolbar will not be shown on the page.

flashEnabled If set to ‘test’, FCChat will determine whether the user’s browser is capable of running Flash. The other values this parameter can take are true or false, but these are really only used for debugging purposes.

websocketEnabled If set to ‘test’, FCChat will determine whether the user’s browser is capable of running HTML5 websockets. The other values this parameter can take are true or false, but these are really only used for debugging purposes.

userbox_mode When this is set to 0, you must click on a screen-name in order to view the userbox. When it is set to 1, the userbox will pop up automatically when you hover over a screen-name (Default: 0)

zindex_base Many of the elements of FCChat use the z-index property for stacking. To avoid potential conficts with page elements, and to make sure that the chat window is not hidden by page elements, the base z-index of FCChat elements is adjustable. Raising the value of this parameter brings the chat window closer to the foreground of the page. (Default: 0)

The last three parameters in this section should not be changed under ordinary operation of the chat.


2.3 Additional Client Configuration topics: Setting up Images/Avatars.

See also 2.2.24 Configuration of Images, Avatars, and Smileys

2.3.1 Creating Avatar Galleries.

In order to create an custom avatar gallery, you will need to obtain some avatar images and upload them to the directory FCChat/html/images/avatars. You will find many free avatar gallery sites on the web, which you may use to stock your avatar gallery. Alternatively, you can create your own avatars.

To designate a particular avatar image as the default avatar, rename the file default.gif. (The default avatar must be a gif image.)

2.3.2 Setting Server Side Image/Avatar Properties

In fcchat/html/config/php_config.php (or asp_config.asp), you are given the following options:

ALLOW_UPLOADS  If this option is enabled, users may upload their own avatars from their computer’s hard drive.

USE_GRAVATAR  If this option is enabled, users may link to their Gravatar avatars.

USE_BOARD_AVATARS  Depricated. If this option is enabled, users may link their forum avatar to the chat.

USE_GALLERY  If this option is enabled, users may choose an avatar from the gallery of avatar images located in the html/images/avatars folder.

MAX_IMAGE_SIZE  The maximum size of uploaded images, in kilobytes.

IMAGE_WIDTH/IMAGE_HEIGHT  The maximum width and height of uploaded avatars. The two parameters must have the same value.

MAX_DIR_SIZE  The maximum size (in bytes) of the upload directory. When this limit is exceeded, no further uploads will be allowed.


2.3.1 Changing the size of the smiley panel.

It is recommended that you use template overrides to change the width and height of the smiley panel; though, if necessary, you may also edit the style templates directly.

Cut and paste the following into the template overrides section of your FCChat configuration (or, if you do not have a built in configuration, into the template overrides section of global.config.js file):

setOption(“FCChatConfig.styles.chat_window.main_panel.tools_panel.smileys.width”,250);
setOption(“FCChatConfig.styles.chat_window.main_panel.tools_panel.smileys.height”,200);


Change the width and height numbers to whatever you want.


2.4 Additional Client Configuration topics: Page Level Configuration.

When you change the configuration variables in FCChat/config/config.js, these changes are applied globally to all pages in which the toolbar is installed. If you wish to have a special configuration for a particular page, you need to use page level configuration.

In order to employ page level configuration, insert a script tag into the body section of your web page.

Let’s say, for instance, that you want to change the greeting on a particular page. Simply place the configuration variable ‘autoGreet’ between the script tags, as follows:

<script type="text/javascript">
FCChatConfig.autoGreet="Hello Folks!";
</script>

Because you are referencing ‘autoGreet’ outside the configuration file, you need to preface if with FCChatConfig.


2.5 Chat Client Style Templates

2.5.1 Embedded Widget Style Template

In order to change the style parameters of the embedded chat widget, go to the fcchat/styles folder and open the current widget style template (To see which widget style template you are currently using, refer to the styles section of the config file).

2.5.2 Floating Toolbar Style Template

In order to change the style parameters of the floating toolbar, go to the fcchat/styles folder and open the current toolbar style template (To see which toolbar style template you are currently using, refer to the styles section of the config file).

2.5.3 ChatCenter Style Template

In order to change the style parameter of the ChatCenter Window, go to the fcchat/styles folder and open the current ChatCenter style template (To see which ChatCenter style template you are currently using, refer to the styles section of the config file).


2.6 FCChat Administration

FCChat comes with a built in administration panel. There are two levels of administrative privileges, administrators and moderators. Administrators are granted full privileges. Moderators are granted a limited set of privileges.

2.6.1 Getting to the Administration Panel.

Administrators and moderators gain access to the administration panel through their user dialog box. Open the chat panel and click on your screen name. If you have administrative privileges (ie. if the words <admin> or <mod> appear next to your screen name), you will see, in your user dialog box, a link that says ‘mod’. Click on this link and you will be taken to the administration panel.

2.6.2 Administration Panel Layout.

A view of the administration panel. Click to enlarge

2.6.2.1 Search Window. (A) In this window, the results of your search queries are displayed.

2.6.2.2 User Search Box. (B) Search for a particular user, or a group of users, with the User Search box. A search consisting of the letter ‘a’, for instance, will bring up all users whose screen names begin with ‘a’.

2.6.2.3 Common Query Select Box (C) Select from the following queries:
1) Show all users
2) Show globally blocked users (Users that have been blocked from chatting in all rooms)
3) Show users blocked from sending private chats.
4) Show auto-blocked users (users that have been automatically blocked by the system for possible spamming activities)
5) Show users blocked in current room.
6) Show blocked IPs (only administrators have access to this function)
7) Show Moderators
8) Show Administrators
9) Show Chat Text Filter (only administrators have access to this function)
10) Show Screen Name Filter (only administrators have access to this function).


2.6.2.4 User Administration Window. (D) Load a user into the User Administration Window by clicking on their name in the Search Window. Moderate the activities of individual users through this window. (See 2.6.3.10 Single User Moderation)

2.6.2.5 Add to Blocked IPs (E) Adds to the list of (permanently) blocked IPs. You may display this list by selecting ‘Show blocked IP’s’ from (C). The ‘remove’ option after each member of the list allows you to remove that item from the list.

2.6.2.6 Add word/phrase to chat text filter (F) Adds a word or phrase to the chat text filter list. You may display this list by selecting ‘Show Chat Text Filter’ from (C). The ‘remove’ option after each member of the list allows you to remove that item from the list. The chat will filter (block) any sequence of characters you enter from being used in chat messages; thus, you must be carefull when entering a short phrase. For instance, entering ‘ant’ into the filter would block ‘ant’, ‘plant’, ‘antimony’, and any other phrase containing the sequence ‘ant’. A maximum of 50 characters is allowed per phrase.

2.6.2.7 Add word/phrase to screen name filter (G) Adds a word or phrase to the screen name filter list. You may display this list by selecting ‘Show Screen Name Filter’ from (C). The ‘remove’ option after each member of the list allows you to remove that item from the list. The chat will filter (block) any sequence of characters you enter from being used in screen names; thus, you must be carefull when entering a short phrase. For instance, entering ‘ant’ into the filter would block ‘ant’, ‘grant’, ‘anthony’, and any other screen name containing the sequence ‘ant’.

2.6.2.8 Reboot Chat. (H) Reboots the chat server. This will clear all rooms and delete all users. The reboot does not happen immediately. Instead, clicking ‘Reboot Chat’ schedules the server to reboot itself within the next 300 seconds. This function is not cancellable.

2.6.2.9 Update Select Server Configuration Variables. (I,J,K,L) You may update the values of the server configuration variables ‘guestNames’, ‘showTyping’, ‘useAvatars’, and ‘showNewestMessages’. See also 2.6.3.7 Setting Server Configuration Variables.

2.6.2.10 User Integration (M,N) See also 2.6.3.8 Setting Up user integration.

2.6.2.11 Switch Administrator. (O) Takes you to a login screen where you may sign in to the administration panel as a different user.

2.6.2.12 File Editor (P) You may edit the configuration and style files using the file editor. See also 2.6.3.9 Using the File Editor.

2.6.2.13 Server Configuration Viewer. (Q) From this window, you may view you current chat server configuration, specified by the file FCChatserver/conf/chatserver.config, which is located on the machine hosting your chat server. If you are not physically hosting the chat server yourelf, this file is not directly editable. In this situation, you may only make changes to the chat server configuration through the administration panel controls, or by contacting your chat server host, and asking them to manually update the file.

2.6.3 Administrative Functions

2.6.3.1 Room Administration (Create/Edit/Delete/Clear) (Administrator privileges required)

From the administration panel, open the “Options” dialog in the Chat Room Window to view the room list. You will see the above functions clearly marked.

2.6.3.2 Censor Chat Message

When in the administration panel, the word ‘Censor’ appears next to each chat message in the Chat Room Window. Click on this to censor the associated chat message. When a message is censored, the entire message is replaced by the phrase **Comment Deleted**.

2.6.3.3 Add/Remove Blocked IPs (Administrator privileges required)

Use the ‘Block IP’ control to add an IP to the blocked IP list. IPs blocked in this way are blocked permanently. (There is a second way to block an individual user’s IP. See 2.6.3.10.5 Block User’s IP). To remove a blocked IP, select ‘Show Blocked IPs’ from the Common Queries Select Box. A list of blocked IPs will appear. Beside each one, you will see the remove option.

2.6.3.4 Add/Remove A Phrase from the Chat Text Filter (Administrator privileges required)

Use the ‘Add word/phrase to chat text filtered Phrase’ control to add a word or phrase the chat text filter. Adding a word to this filter automatically censors that word in chat messages. A censored word, such as ‘dirty’, for instance, will appear in chats as *****. The chat will filter (block) any sequence of characters you enter from being used in chat messages; thus, you must be carefull when entering a short phrase. For instance, entering ‘ant’ into the filter would censor ‘ant’, ‘plant’, ‘antimony’, and any other phrase containing the sequence ‘ant’. To remove a word from the word filter, select ‘Show Chat Text Filter’ from the Common Queries Select Box. A list of filtered phrases will appear. Beside each phrase, you will see the remove option.

2.6.3.5 Add/Remove A Phrase from the Screen Name Filter (Administrator privileges required)

Use the ‘Add word/phrase to screen name filter’ control to add a word or phrase the screen name filter. Adding a word to this filter automatically blocks any user from signing in with a screen name whose characters contain the filtered phrase. The chat will filter (block) any sequence of characters you enter from being used in screen names; thus, you must be carefull when entering a short phrase. For instance, entering ‘ant’ into the filter would block ‘ant’, ‘grant’, ‘anthony’, and any other screen name containing the sequence ‘ant’. To remove a word from the screen name filter, select ‘Show Screen Name Filter’ from the Common Queries Select Box. A list of filtered phrases will appear. Beside each phrase, you will see the remove option.

2.6.3.6 Reboot Chat (Administrator privileges required)


2.6.3.7 Setting Server Configuration Variables (Administrator privileges required)

You may edit a few select server configuration variables via the administration panel — ‘guestNames, ‘showTyping’, ‘useAvatars’, and ‘showNewestMessages’. See also, 2.6.2.9 Update Select Server Configuration Variables. (I,J,K,L) above. The other variables found in the server configuration file cannot be edited through the administration panel They must be changed by directly editing the file. Since you do not have direct access to the server configuration file, if the need arises, you may contact a Fastcat representative and we will update your configuration file for you.

2.6.3.8 Setting up User Integration

Please refer to the User guide for tutorials concerning user integration, or contact Fastcat support for more info.

2.6.3.9 Using the File Editor

Coming Soon. Please contact Fastcat support for more info about this topic.

2.6.3.10 Single User Moderation

The functions below are accessible after loading a user into the User administration Window. To do this, perform a search for a user, and click on their name in the Search Window.

2.6.3.10.1 Block in Room(s)

You may block a user from chatting in any particular room, or globally (in all the rooms at once) if you have enough privileges.

2.6.3.10.2 Release Auto Blocks

This function releases the auto-block placed on a user. An auto-block may be generated when the system suspects that a user is attempting to spam with private chat messages. An auto-block blocks a user from sending private chats for a period equal to autoLockingInterval, a configuration variable found in chatserver.config, whose default value is 900 seconds. Auto-blocks are controlled by two additional configuration parameters, offlineUserMsgThreshold and blockThreshold, whose definitions are given in chatserver.config.

2.6.3.10.3 Boot User

This function disconnects a user from the chat server. It does not prevent them from returning, however. If you want to keep them from coming back you must use this in conjunction with IP blocking.

2.6.3.10.4 Delete all Messages

This Function censors all a user’s chat messages at once. Administrators have this privilege by default. Administrators may grant or revoke this privilege from moderators. The affect of this command is not instantaneous, unlike single message censorship. End users will not notice any change until they refresh and reload their chat panels. Thus, if you need something removed instantaneously, use single message deletion.

2.6.3.10.5 Block User’s IP

This function is for use by administrators only. You may place two types of IP blocks on users, a temporary block, lasting for 30 minutes, and a permanent block. Most of the time you will want to use the temporary block, since permanent blocks can potentially make the chat inaccessible to more than just the intended recipient of the block. To remove an IP block, select ‘Show blocked IPs’ in the Common Query Select Box. When the list of blocked IPs appears, select the remove option from the IP you want to delete from the list.
Note:Simply blocking a user’s IP will not remove them from the chat if they are already connected. You must use this command in conjunction with the Boot User Command in order to ‘Kick and Ban’ a user.

2.6.3.10.6 Promote to Moderator

Administrators may promote user to moderator status. They may also assign or revoke the following privileges:

1) Allow/Deny global message blocking.
2) Allow/Deny private message blocking.
3) Allow/Deny Delete all messages privilege.

2.6.3.10.7 Promote to Administrator

The site administrative account (this is the first account that appears in the server conifiguration file, usually named admin) may grant/revoke administrator status.

2.6.3.10.8 Set Title

Administrators may assign a title to user accounts, such as “Staff”, “Customer Support”, “Senoir Member”, “Guest Speaker” etc. in order to highlight special accounts

2.6.3.10.9 Change password

Administrators may change the password of their own account, or acccount with less privileges than them.


2.7 Toolbar Items

From FCChat/config/config.js
  
   toolbar_items:["friendscenter","social_media:social_media",
   "search:wordpress:wp_search"], 

2.7.1 Adding toolbar items

toolbar_items, above, contains a comma separated list of items that will be displayed in the toolbar. The order that items appear in this list is also the order that they will be rendered in the toolbar. The list MUST contain “friendscenter”. The other items in the list are optional.

Premade toolbar items are found in the fcchat/toolbar_items/ folder. The items will change over time, but we present, here, the ones that are present at the time of this writing. To include a toolbar item, add the colon separated path to the toolbar item, to the toolbar_items list.

For instance, the social_media item is located in the social_media/ subfolder, so when you add it to the list you will write “social_media:social_media” (The actual file name is social_media.js, but you will omit the .js part).

The wp_search (wordpress search) item is located in the search/wordpress/ subfolder, so when you add it to the list you will write “search:wordpress:wp_search”

WARNING: Do not add any content from the custom_buttons/ subfolder. This is a special folder reserved for creating customized buttons.

Here are some the the available items:


friendscenter The interface to the chat.



“social_media:social_media” Opens a dialog containing a list of sharing options.



“search:wordpress:wp_search” A search function for wordpress sites. Opens a search dialog.
“search:joomla:joomla_search” …for Joomla
“search:phpbb3:phpbb3_search” …for PHPBB




“search:wordpress:wp_search_in_menu” A search function for wordpress sites, where the search input appears in the menu.
“search:joomla:joomla_search_in_menu” …for Joomla
“search:phpbb3:phpbb3_search_in_menu” …for PHPBB



“fullpage:logo” Adds the branding bar to the toolbar. The branding bar can be configured from the FCChat Configuration (specifically, in the BRANDING section).




If you have a pre-sales question, submit your inquiry via our sales contact page. For general, non-sales inquiries, contact us at support@fastcatsoftware.com.

Solution Graphics