The manual for FCChat 3.x is not yet available. While this manual is for version 2.x, most of it is still relevant to verson 3.0. For full 3.0 support, please direct your inquiries to our email support: email@example.com.
Please read The FCChat UserGuide prior to using this manual. The UserGuide contains installation and configuration information, as well as several tutorials aimed at those who are getting started with the chat.
1 User Guide
1.1 System Requirements
You must have either Flash player 8 or higher or HTML5 websockets installed on your browser
Fully Supported Browsers:
- Internet Explorer 6+
- Firefox 1.5+
- Opera 9+
- Google Chrome 3.0+
- Safari 3+
* Some of the features may not be available on browsers that are not fully supported.
1.2 FCChat Widget Display
The FCChat widget may be displayed on a particular site as an embedded control, a floating toolbar, or both.
The widget displayed as an embedded control.
The widget as part of the FCChat floating toolbar.
The main components of the widget are:
(A) Open ChatCenter Button
(B) On/Off Button
(C) Online link
(D) New Message Link
(D) Friends Link
1.2.1 Open ChatCenter Button
Opens the ChatCenter, which is the main chat window. If the chat has been configured to require logins, you may be presented with a dialog asking you to sign in before you can access the chat center.
1.2.2 On/Off Button
Use the on/off button to toggle the chat on or off. If you do not wish to use the chat it is probably best to leave it off. By turning it off, you make yourself invisible to other users. When the chat is on, your online presence is known to all other online users.
1.2.3 Online Link
1.2.4 New Messages Link
Opens the Online dialog box, shown at the right.
The online dialog box shows a list of users that are currently online. In the example above, the current user is 'its_me'. There is a second user visiting the site: 'other_person'. By clicking the plus symbol next to 'other_person', 'its_me' may add them to their friends list. By clicking on 'other_person', 'its_me' may engage them in a chat conversation, invite them to share a document, play a game, etc. A user is available for chat when their name is underlined. The icon near the top of the dialog box is the set avatar icon. Clicking on the set avatar icon will open a new window where you can easily select an avatar. If you are not signed in to the chat, your screen name may appear as 'guest'.
1.2.5 Friends Link
Opens the New Messages dialog box, shown at the right.
The new messages dialog box displays private chat messages that you send, and that are sent to you by other users. In the example above, the current user, 'its_me', has sent a chat to 'other_person'. 'other_person' has responded by saying hello. Notice that the messages appear in a bottom to top order. By clicking the plus symbol next to 'other_person', 'its_me' may add them to their friends list. By clicking on 'other_person', 'its_me' may engage them in a chat conversation, invite them to share a document, play a game, etc. A user is available for chat when their name is underlined. At the bottom of the dialog, there is a chat box where you can type your messages. (Remember, you must click on a user's name first before you can send them a message.) Above the chat box, there are icons for various functions (doodlepad, games, video chat, etc) These functions allow you to interact on a one on one basis with another user.
Opens the Friends dialog box, shown below.
The friends dialog box shows a list of people who you have added as your friends. In the example above, the current user, 'its_me', has added one friend: 'other_person'. You add/remove friends by clicking the +/- symbol that appears next to their name. You may add as many friends as you like. To send a chat to a friend, click on their name. FCChat remembers who your friends are, so that when 'its_me' returns to the site at a later time, 'other_person' will still be in their friends list. FCChat makes it easy to see if your friends are online at any given time.
1.3 ChatCenter layout.
The ChatCenter Window...
1.3.1 The chat room window (A).
Conversations in this window are viewable by all room members. Room participants are listed in window D.
1.3.2 The private chat window. (B)
In this window, you can carry on a private conversation with another online user. The private chat window also allows you to carry on multiple private chats at the same time.
1.3.3 The online user window. (C)
This window has the title "Who's Connected', and lists all the users who are currently online and signed in to the chat system. It does not list users who have their chats turned off.
1.3.4 The chat room members window. (D)
This window lists all the users that are currently chatting in the specified room. In the illustration above, both kobe and bob are currently chatting in the room 'The Lobby'. When you first open up the chat panel, you are assigned to the default room, which is chosen by the administrator. After that, you may change to any of the available rooms (See 184.108.40.206 View/Change Rooms.
). When you close the chat panel, you are removed from the room list; however, you are still listed in the online user window, and may still receive private messages from other users.
1.3.5 The private group window. (E)
The private group window was included to allow convenient access to users you wish to converse with privately. In order for a user to appear in this window, you must add them to your private group (See 220.127.116.11 Add/Remove a user from your private group.
). You may add multiply users to your private group, but you may only chat with the user that is currently selected. A user is selected when they are highlighted in green, and have a little arrow by them. To select a user, simply hover over the desired user and click on their container.
1.3.6 The message text box. (F)
This is where you type in your chats.
1.3.7 Send to Room button. (G)
Sends the chat to the room you're currently in. Your chat message appears in window A.
1.3.8 Send Private button. (H)
Sends the chat to the currently selected user. Your message will appear in that user's private group window, and in your private group window. If the recipient of your message has their chat panel closed, the message will still appear in their private message alert box (See 1.2 FCChat Display
1.3.9 Send to room by default. (I)
When this is checked, if you type a message and press the enter key, your message will be sent the chat room (window A) by default.
1.3.10 Send private by default. (J)
When this is checked, if you type a message and press the enter key, your message will be sent the private chat (window B) by default.
1.3.11 Options Button. (K)
Opens the options dialog box. (See 1.6.1 Options Dialog box
1.3.12 Help Button. (L)
Opens the help panel.
1.3.13 Close Button. (M)
Closes the chat panel.
1.3.14 Text format icons. (N)
Inserts bold, italic, or underlined text. Place the text you wish to format between the two tags.
eg. Entering "Hello, my name is =b= bob =b= " will be displayed as "Hello, my name is bob
1.3.15 Insert image icon. (O)
Inserts an image into your message. Place the image you wish to insert between the image tags.
eg. If you have an image named cat.jpg
, insert it into your chat message like this: "Hello, this is my cat [[cat.jpg]]
" (Of course, you will need to upload the image first. See 1.3.16 Upload image icon. (P)
1.3.16 Upload image icon. (P)
Opens the upload image dialog box. Before you can share images in your messages, you need to upload them. You may upload images in the GIF, JPEG, and PNG formats only. The chat administrator may place restrictions on the size of images you may upload.
1.3.17 Create avatar icon. (Q)
Opens the create avatar dialog box. From this dialog, you may choose from the selection of gallery avatars, or upload your own.
1.3.18 Add smiley icon. (R)
Choose a smiley to add to your message.
1.3.19 Clear room. (S)
Clears the current room. After clearing, you may still access the message history by clicking on 'Previous Messages'.
1.3.20 Turn room alerts on/off. (T)
When room alerts are on, you will receive a notification, displayed in the chat room window, whenever someone enters or exits the room.
1.3.21 Filter private conversations. (U)
When this icon is checked, only the private chats from the user selected in the private group window will be displayed. If no user is selected, all private messages will still be displayed.
1.3.22 Sliders. (V)
Use these to resize the chat panel dimensions.
1.3.23 Video chat icon. (W)
This button opens the video chat window.
1.3.24 Webcam icon. (X)
Clicking on this icon allows you to view the person's webcam.
1.3.25 Maximize/Split-screen mode. (Y)
Clicking the maximize window button sends the chat into the split screen mode (if enabled). The split-screen mode is discussed in 1.7 Chat Modes
1.3.26 Trash Icon. (Z)
Clicking the trash icon will delete all messages in the private chat.
1.4 User's Chat Status
The little square to the left of each user's name displays the user's chat status according to the following legend:
1.5 User's Dialog Box
Click on any online*
user's name and their dialog box will appear:
*Clicking on an offline user's name will bring up their profile
1.5.1 User Dialog box controls
From the dialog box, you may perform the following functions.
18.104.22.168 Send a private message.
Enter your message in the text box and press 'Send Private'.
22.214.171.124 Add/Remove a user from your private group.
When this box is checked, the user will appear in your private group window. A newly added user automatically becomes actively selected.
When this box is checked, the user's link will change to red, indicating that they have been blocked. A blocked user is prohibited from sending you private messages. You, however, may still send private messages to them (unless, of course, they block you).
126.96.36.199 View profile.
Clicking this link will bring up the user's profile page. If the chat panel is open, this page will appear in the chat room window.
188.8.131.52 View status.
Clicking this link will bring up the user's current chat status. The status report will appear in your private group window. The status report states the user's current room, how long the user has been online, how long they have been idle, and shows any actions (room blocks, etc.) taken by moderators against this user.
184.108.40.206 Sign in.
If you are logged in as a guest, your user dialog box will display a 'sign in' link. Select this link and you will be presented with a dialog box which asks you to enter a screen name and a password. If this is your first time logging in, you may enter any name and password you desire, as long as that name has not already been taken by another user. Screen names and passwords may be between 3 and 15 characters long. Only letters, numbers and underscores are allowed. Your name and password will be stored so that the system will remember you whenever you return. Unfortunately, your password cannot be recovered if you forget it; however, you can always create another account. These accounts are not permanent
and may deleted from time to time.
If you have administrator/moderator privileges, then your user dialog box will display a 'mod' link. Selecting this link will take you to the moderator control panel.
1.6 Options Dialog Box
To open the options box, click on the 'Options' button on the chat panel.
1.6.1 Options Dialog box controls
From the options box, you may perform the following functions.
220.127.116.11 View/Change Rooms.
The current room is highlighted in green. Simply click on a room to enter that room. The number to the right of each room represents the number of users currently chatting in it. If a room is locked, you must provide the correct password to enter it. If a room is grayed out/disabled it means that you are not allowed to enter.
18.104.22.168 Display/Hide Timestamp.
With this option, chats will appear with or without timestamp info.
22.214.171.124 Change Mode.
Toggle between the Window and Split-screen modes. (See 1.7 Chat Modes
126.96.36.199 Configure Sounds.
Enable or disable the various sound effects that are triggered when a user sends a message or enters/leaves a room.
188.8.131.52 Change Font Size/Color.
Changes font display characteristics for greater accessibility.
184.108.40.206 Remove a user from the block list.
Click on any user's name in the list and then press remove.
1.7 Chat Modes
The examples above demonstrate the main features of the chat in the Window mode
. When in the Window mode, you may open and close the chat panel from any page in which the toolbar is displayed.
If you would rather chat and surf the site simultaneously, there is an alternative, called Split-screen mode
. To get to the Split-screen mode, open the options box and click on Mode:Split-screen. Then your chat layout will look something like this:
A view of the site in Split-screen mode. The right panel contains the chat system. From the left panel, you may navigate to any page in your domain. The sliders allow you to adjust the size and width of the two panels.
1.8 Video Chat
To access the video chat, click on the Video chat icon (1.3.19)
above the message text box. To view another user's webcam, click on the Webcam icon (1.3.20)
below their screen-name.
The video chat components. The window on the left is the video pool. The video pool window automatically resizes itself when you add or remove video screens. You may view a maximum of 5 other user's webcams. When you click on a user's video screen, you will open an expanded view of their webcam (the right window). The expanded view window is resizable.
2 Administrator Guide
2.1 Installing FCChat|
Instructions for installing FCChat may vary, depending on your installation type.
A tutorial which guides you through the process of installing and configuring the chat client may be found in the User Guide
2.2 Chat Client Configuriation
2.3 Additional Client Configuration topics: Setting up Images/Avatars.
The chat client configuration file is located at fcchat/config/config.js
within your fcchat installation. You will open this file with a text editor (like notepad) in order to make configuration changes. (NOTE:
Wordpress, Joomla, Drupal and PHPBB3 installations have the FCChat configuration built in to their dashboards, so there is no need to edit the configuration file directly.)
: When you upgrade to a new version of FCChat, your old configuration file will be erased. Therefore, you should make a backup copy of the config file before upgrading, so that you can transfer your configuration settings over to the new file. This does not apply to Wordpress, Joomla, Drupal and PHPBB3 installations, where updates are handled automatically, and previous configurations are preserved.
2.2.1 Connecting to the chat server
2.2.2 FCChat and jQuery version
The connection parameters are shown below:
Once you have activated FCChat
, you will receive the chat_id
values that are necessary in order to make a connection to the chat server. Enter those values in the configuration file, as the above example shows.
In FCChat version 3.x it is not really necessary to change the port
from their defualt values.
2.2.3 Global Configuration
Version info shown below:
fields convey the current version of FCChat.
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.
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 changes and information contained within the template carry over from one version to the next. Wordpress, Joomla, Drupal, and PHPBB3 installations do not make use this template, as seemless updates are already built in. See Using the global configuration template for seemless updates
for more details.
// GLOBAL CONFIGURATION
should be enabled if you are using the global configuration file.
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.
Branding section shown below:
small_logo:"", //around 16x16
big_logo:"", //around 80x80
startText:"Click here to join our chat.",
loginText:"Please please sign using your site account.",
full_page_loading:"Yourdomain chat will load momentarily",
full_page_login:"Welcome to Yourdomain chat. Sign in to enter.",
A 16x16 (approx) logo for your site. Insert the full path to the image file. ie. http://www.mysite.com/image.png.
A 80x80 (approx) logo for your site. Insert the full path to the image file. ie. http://www.mysite.com/image.png.
The title displayed on the embedded widget..
Title displayed on the branding bar. Add the branding bar to the toolbar by inserting 'fullpage:logo' into toolbar_items field below.
Width of the branding bar.
Text displayed by the widget when it starts up.
Text displayed by the login panel when user integration is enabled.
A message that is displayed when a user opens the ChatCenter window. The message could contain instructions and/or a welcoming message.
Text displayed when the full page chat is loading.
Text displayed if the full page chat requires signin.
2.2.6 User Integration
Permisions section shown below:
When true, guests are required to login to gain access to the chat.
If no, guests may not send chats in the rooms (they can still observe).
Allow guest accounts to use the video chat.
If this is false, guest accounts will be hidden, by default, in the online panel, chatroom members panel, etc. However, a link will be provided, in each panel, to diplay the guest users.
Videoconferencing can be accessed only in rooms designated for video chat.
2.2.7 Alignment of dialog boxes with respect to the widget.
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
Specifies the type of integration.
The URL of your site's login page. The user will be redirected here if they have not signed in.
2.2.8 Setting the Default Language
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
Choices are "left","right", or "auto". The "auto" setting automatically detects alignment
2.2.9 Setting the Style Templates
Language Section shown below:
//LANGUAGE (templates located in the languages folder)
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.
Style Template Section shown below:
// STYLE TEMPLATES
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
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
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.11 Embedded Widget Control Configuration
Quickstyling Section shown below:
// QUICK STYLING
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.12 Toolbar Options
Embedded Control Section shown below:
//Embedded control box
The parameters above control certain aspects of the embedded FCChat widget
, 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:
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.)
, if set to false, will hide the embedded control. Use this mode if you only wish to display the floating toolbar
, sets the amount of spacing around the widget control.
2.2.13 Floating Toolbar Configuration - Desktop/Laptop options
Embedded Control Section shown below:
Show or hide the toolbar.
2.2.14 Floating Toolbar Configuration Continued: Options for mobile browsers
(some comments have been removed for clarity):
// DESKTOP/LAPTOP TOOLBAR OPTIONS
toolbar_layout:0, // 0 = compact | 1 = full width
The parameters above control certain aspects of the floating toolbar
when viewed from a desktop or laptop.
has two settings: 0 - compact (the toolbar only takes up as much space as needed) 1- fullwidth (the toolbar span the entire width of the browser window).
sets the location of the floating toolbar. Choices are "topleft", "topright", "bottomleft", and "bottomright".
you can add this if you run the toolbar in the topleft or topright position, but you want to lower it a certain amount, from the absolute top of the page (perhaps because you have a banner or something there).
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
has two settings: 1 (fully extended) , or 0 (minimized).
adds custom buttons to the toolbar. Refer to this tutorial for a full discussion: Custom Buttons for the Toolbar
2.2.15 Mobile Browser - Large Display Toolbar Items
Floating toolbar mobile options section shown below (some comments have been removed for clarity):
//MOBILE TOOLBAR OPTIONS
mobile_toolbar_mode:2, // 0 - simplified, 1 - regular, 2 - auto choose
mobile_banner_position:"bottomleft", // Choices are bottomleft and topleft
fixed_toolbar_position:"bottomleft", // Choices are bottomleft and topleft
The parameters above control certain aspects of the floating toolbar
when viewed from a mobile platform.
0 - simplified (No toolbar addons will be displayed) 1 - regular (toolbar addons will be displayed) 2 - auto choose (the chat will determine the mode based on the available width).
Small screen displays will show a resizable, fixed position banner for the toolbar, if possible.
topleft or bottomleft are the choices, which basically allow you to display the banner at the top or bottom of the screen.
A regex containing a list of devices that should not run the mobile toolbar banner mode.
Small screen displays will show a fixed position toolbar (not resizable), if possible. This is a fallback mode from use_mobile_banner.
topleft or bottomleft are the choices, which basically allow you to display the toolbar at the top or bottom of the screen.
you can add this if you run the toolbar in the topleft position, but you want to lower it a certain amount, from the absolute top of the page (perhaps because you have a banner or something there).
A regex containing a list of devices that should not run the fixed toolbar mode.
Small screen displays will show the toolbar as an inline element at the top of the page (not a fixed element). This is a fallback mode from use_fixed_toolbar.
Height of the toolbar.
you can add this if you want to lower the toolbar a certain amount, from the absolute top of the page (perhaps because you have a banner or something there).
A regex containing a list of devices that should not run the static banner mode.
2.2.16 Mobile Browser - Small Display Toolbar Items
// MOBILE TABLET/LARGE DISPLAY OPTIONS
Default list of toolbar items to run on large mobile displays (like tablets).
2.2.17 Chatcenter window modes
// MOBILE PHONE/SMALL DISPLAY OPTIONS
Default list of toolbar items to run on small mobile displays (like mobile phones).
2.2.15 Chatcenter window size
Chatcenter window modes section shown below:
// CHATCENTER WINDOW MODES
chatcenter_layout:0, // 0 - Chatrooms and Messages 1 - messages only
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.
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.
, 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.16 Parameters relating to chat rooms and chat messages
Chatcenter window size section shown below:
// CHATCENTER WINDOW SIZE
determines the width of the Chatcenter application window.
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..
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.17 Setting the location of the full page chat
2.2.18 Environmental variables
CHAT ROOM PARAMS section shown below:
// CHAT ROOM PARAMS
disabled_room_msg:"You must be a member to enter this room.",
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.
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.
The usage of these parameters are explained in the tutorial, Setting up member only rooms
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.
is the number of message a room will contain after an automatic refresh. It should be a number between 0 and room_message_limit
is the maximum size of a single chat message.
2.2.19 Enabling/disabling the new user prompt
Environmental section shown below:
determines whether the chat is on or off.
When this is enabled, the browser tab will serve to alert the user when new messages arrive.
When this is enabled, chat history pages will not be available.
If this is set to true, the word 'typing...' will appear next to a user's name when they are typing a message.
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.
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.
2.2.20 Enabling/disabling the nickname prompt
User prompt section shown below:
// Prompt user to sign in to chat
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.21 Letting users connect with Facebook
Nickname section shown below:
// Prompt guests to enter a 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.22 Setting up Country Flags
Facebook Connect section shown below:
//ALLOW FACEBOOK LOGINS
: If true, users will have the option of connecting to the chat with their Facebook account.
: The url of the proxy server that provides the Facebook Connect interface.
2.2.23 User Profiles
Country Flags section shown below:
//get your free api key from http://ipinfodb.com/register.php
turns the country flag option on or off.
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.24 Configuration of Images, Avatars, and Smileys
Profiles section shown below:
Refer to. Importing user profiles
, for the proper usage of this parameter.
2.2.25 Games Options
IMAGES AVATARS SMILEYS section shown below:
//IMAGES AVATARS SMILEYS
current_domain:"fastcatsoftware.com", // set this to your domain
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.
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
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.
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.
The scripting environment of your site. Choices are "php" and "asp".
Location of the avatar storage folder. If blank, the default location is used.
Location of the images storage folder. If blank, the default location is used.
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)
The height, in pixels, of the avatar image displayed next to a user's screen name.
Allow users to change their avatar.
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.26 Setting up Smileys
Games section shown below:
//GAME ID'S should match game names in language file
Set to false if you want to disable two player games.
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.27 Setting up the video chat
Smileys Section shown below:
* IMPORTANT-READ THIS: In smileys, You
* must escape any single quotes with three backslashes.
* ie, a wink emoticon '-) must be encoded as \\\'-)
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:
See also Changing the size of the smileys panel
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.
As of FCChat version 220.127.116.11, an optional fourth field may be inserted into the smiley list. This field controls the height of the smiley images as they appear in the smiley dialog box. Here is an example:
In the example above, the first two smileys would have a display height of 32 pixels in the smiley panel. The third smiley, which lacks the fourth parameter, would be displayed in the smiley dialog box at its default height.
2.2.28 Translator Configuration
Video Section shown below:
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.
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.
Sets the maximum number of simultaneous streams that the chat client will allow.
Width (in pixels) captured by a user's webcam,
Height (in pixels) captured by a user's webcam,
Width (in pixels) captured by a user's webcam when high definition is available,
Height (in pixels) captured by a user's webcam when high definition is available,
Capture rate (frames per second)
Higher quality means less compression. Range is 0-100.
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
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.29 Transliteration Configuration
Translator Section shown below:
Enables/disables the translator.
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.
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/
The base url of the translation api.
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.
Translator Section shown below:
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.31 Miscellaneous Configuration Variables
Cookies Section shown below:
cookie_expires:1, //0 - end of session //1 - never
FCChat sets cookies on the user's browser to maintain application state.
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.
MISC Section shown below:
dir: window["fc_chat_path"] || "/FCChat/",
Allow users to post links to external sites.
When a user presses the 'Help' button, they are directed to this link, By default, help_link points to this manual.
If true, the help link will be shown.
If true, the user list link will be shown.
If true, the room settings panel will automatically open after the ChatCenter window has loaded.
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.
Sets the default "pin state" of the application windows. When true, windows open in the "pinned" state by default.
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)
If set to true, the toolbar will not be shown on the page.
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.
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.
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)
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.
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.3 Changing the size of the smileys 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):
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:
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
2.5.2 Floating Toolbar 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.3 ChatCenter 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).
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.
2.7 Toolbar Items
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
18.104.22.168 Search Window. (A)
2.6.3 Administrative Functions
In this window, the results of your search queries are displayed.22.214.171.124 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'.
126.96.36.199 Common Query Select Box (C)
Select from the following queries:
1) Show all users
188.8.131.52 User Administration Window. (D)
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).
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 184.108.40.206 Single User Moderation
220.127.116.11 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.
18.104.22.168 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.
22.214.171.124 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'.
126.96.36.199 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.
188.8.131.52 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 184.108.40.206 Setting Server Configuration Variables
220.127.116.11 User Integration (M,N)
See also 18.104.22.168 Setting Up user integration
22.214.171.124 Switch Administrator. (O)
Takes you to a login screen where you may sign in to the administration panel as a different user.
126.96.36.199 File Editor (P)
You may edit the configuration and style files using the file editor. See also 188.8.131.52 Using the File Editor
184.108.40.206 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.
220.127.116.11 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.
18.104.22.168 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**.
22.214.171.124 Add/Remove Blocked IPs
(Administrator privileges required)
126.96.36.199 Add/Remove A Phrase from the Chat Text Filter
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 188.8.131.52.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.
(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.
184.108.40.206 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.
220.127.116.11 Reboot Chat
(Administrator privileges required)
18.104.22.168 Setting Server Configuration Variables
(Administrator privileges required)
22.214.171.124 Setting up User Integration
You may edit a few select server configuration variables via the administration panel -- 'guestNames, 'showTyping', 'useAvatars', and 'showNewestMessages'. See also, 126.96.36.199 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.
188.8.131.52 Using the File Editor
Please refer to the User guide
for tutorials concerning user integration, or contact Fastcat support for more info.
Coming Soon. Please contact Fastcat support for more info about this topic.
184.108.40.206 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.
220.127.116.11.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.
18.104.22.168.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.
22.214.171.124.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.
126.96.36.199.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.
188.8.131.52.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.
184.108.40.206.6 Promote to Moderator
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.
220.127.116.11.7 Promote to Administrator
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.
The site administrative account (this is the first account that appears in the server conifiguration file, usually named admin) may grant/revoke administrator status.
18.104.22.168.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
22.214.171.124.9 Change password
Administrators may change the password of their own account, or acccount with less privileges than them.
2.7.1 Adding 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
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"
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:
The interface to the chat.
Opens a dialog containing a list of sharing options.
A search function for wordpress sites. Opens a search dialog.
A search function for wordpress sites, where the search input appears in the menu.
Adds the branding bar to the toolbar. The branding bar can be configured from the FCChat Configuration (specifically, in the BRANDING section).