GaraxiChat Help

GaraxiChat 2.2 User's Guide

Home

5. Client configuration (Applet look & feel configuration)

5.1 Server connecting configuration

5.2 User authentication setting

5.3 Font settings

5.4 Color settings

5.5 Widget look & feel setting

5.6 Avatars and Emoticons settings

5.7 Color theme and Language settings

5.8 External integration settings

5.9 Virtual domain settings for client applet


		<APPLET ARCHIVE="geekchat_chatter.jar,images_base.jar" WIDTH="640" HEIGHT="400" CODE="geek.chat.JavaChat" MAYSCRIPT>
		<PARAM NAME="cabbase" VALUE="geekchat_chatter.cab,images_base.cab">
		<!-- I am a comment. -->
		<PARAM NAME="server" VALUE="chat.garaxi.com">
		...
		... 
	<APPLET>

<PARAM NAME="cabbase" VALUE="geekchat_client.cab">

*** All directive names are "case sensitive" ***

5.1 Server directive configuration

server_port

Name : server_port
Type : number
Required : yes
Default : 2428
Detail : Connection port between Chat server and Chat applet. The connection port at server side must similar with the client side.
Example : <PARAM NAME="server_port" VALUE="2428">

default_channels

Name : default_channels
Type : channel name (string)
Required : no
Default : General
Detail : Default channel when user connect to server and automitcally join this default channel
Example : <PARAM NAME="default_channels" VALUE="General">

default_interval_message

Name : default_interval_message
Type : number (milliseconds)
Required : no
Default : 800 (0.8 sec.)
Detail : Time period per each message in miliseconds. For avoid user spamn message or flooding.
Example : <PARAM NAME="default_interval_message" VALUE="900">

static_applet

Name : static_applet
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "true" if you want to let applet retain in web browser memory and load only once.
Recommend it when you want to deploy it to the real web site.
Example : <PARAM NAME="static_applet" VALUE="true">

user_can_create_room

Name : user_can_create_room
Type : "true" or "false"
Required : no
Default : true
Detail : Set to "false" if you want to prevent user to create new room. Or set to "true" if you want to permit them to create their room.
Example : <PARAM NAME="user_can_create_room" VALUE="false">

enable_password_tab

Name : enable_password_tab
Type : "true" or "false"
Required : no
Default : true
Detail : Allow/Disallow user to change password via applet. This is ideally for the system that you want user to only chat and chat and chat .... and prevent user to change password .
Example : <PARAM NAME="enable_password_tab" VALUE="false">

enable_edit_profile

Name : enable_edit_profile
Type : "true" or "false"
Required : no
Default : true
Detail : Allow/Disallow user to edit user profile via applet.
Example : <PARAM NAME="enable_edit_profile" VALUE="false">

external_view_profile_url

Name : external_view_profile_url
Type : String of URL
Required : no
Default : not set
Detail : External profile lookup URL. In this case you want to auto popup new web browser windows and redirect to your profile page.
Example : <PARAM NAME="external_view_profile_url" VALUE="http://www.somewhere_somehow.com/profile?username=">
Applet will auto popup the new window and redirect to URL http://www.somewhere_somehow.com/profile?username=(username)

5.2 User authentication setting

nickname

Name : nickname
Type : nickname (string)
Required : no
Default : not set
Detail : Default nickname by default not set
Example : <PARAM NAME="nickname" VALUE="">

change_nickname

Name : change_nickname
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "true" if you want to disable users to change the "nickname" textfield. Recommend for the integration with existing member system.
Example : <PARAM NAME="change_nickname" VALUE="true">

auto_connect

Name : auto_connect
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "true" if you want to use together with "change_nickname" directive to let user auto connect to chat server after load the applet.
Example : <PARAM NAME="auto_connect" VALUE="true">

password

Name : password
Type : password (string)
Required : no
Default : not set and dangerous to set
Detail : Default password if capable
Example : <PARAM NAME="password" VALUE="">

only_anonymous

Name : only_anonymous
Type : "true" or "false"
Required : no
Default : false
Detail : Enable or disable the register and password box. Set it "true" you'll always login as anonymous.
Example : <PARAM NAME="only_anonymous" VALUE="true">

auto_anonymous

Name : auto_anonymous
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "true" if user failed on password authentication it will auto login user to system as anonymous login.
Example : <PARAM NAME="auto_anonymous" VALUE="true">

show_register

Name : show_register
Type : "true" or "false"
Required : true
Default : false
Detail : Set to "true" if you want to show "register" button and "false" if you want to hide it.
Example : <PARAM NAME="show_register" VALUE="true">

5.3 Font settings

widget_font

Name : widget_font
Type : Font format [FONT_NAME],[FONT_SIZE],[STYLE]
[FONT_NAME] = Name of font such as "Dialog"
[FONT_SIZE] = integer such as 10
[STYLE] = "plain","italic","bold","bold_italic"
Required : no
Default : "Dialog,10,plain"
Detail : Widget's font.
Example : <PARAM NAME="widget_font" VALUE="Dialog,10,plain">

nickname_font

Name : nickname_font
Type : Font format [FONT_NAME],[FONT_SIZE],[STYLE]
[FONT_NAME] = Name of font such as "Dialog"
[FONT_SIZE] = integer such as 10
[STYLE] = "plain","italic","bold","bold_italic"
Required : no
Default : "Dialog,10,bold"
Detail : Chat nickname's font.
Example : <PARAM NAME="nickname_font" VALUE="Dialog,10,bold">

message_font

Name : message_font
Type : Font format [FONT_NAME],[FONT_SIZE],[STYLE]
[FONT_NAME] = Name of font such as "Dialog"
[FONT_SIZE] = integer such as 10
[STYLE] = "plain","italic","bold","bold_italic"
Required : no
Default : "Dialog,10,plain"
Detail : Chat message's font.
Example : <PARAM NAME="message_font" VALUE="Dialog,10,plain">

5.4 Colors setting

applet_back_color

Name : applet_back_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 238,238,238
Detail : Color of whole applet background color
Example :
<PARAM NAME="applet_back_color" VALUE="238,238,238">
or
<PARAM NAME="applet_back_color" VALUE="#FFFFFF">

panel_chat_back_color

Name : panel_chat_back_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 238,238,238
Detail : Background color of each chat windows
Example :
<PARAM NAME="panel_chat_back_color" VALUE="238,238,238">
or
<PARAM NAME="panel_chat_back_color" VALUE="#FFFFFF">

panel_chat_fore_color

Name : panel_chat_fore_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 0,0,0
Detail : Color of whole applet foreground color
Example :
<PARAM NAME="panel_chat_fore_color" VALUE="238,238,238">
or
<PARAM NAME="panel_chat_fore_color" VALUE="#FFFFFF">

chat_back_color

Name : chat_back_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 255,255,255
Detail : Chat display area background color
Example :
<PARAM NAME="chat_back_color" VALUE="238,238,238">
or
<PARAM NAME="chat_back_color" VALUE="#FFFFFF">

chat_message_border_color

Name : chat_message_border_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 100,0,0
Detail : Color of chat message border.
Example :
<PARAM NAME="chat_message_border_color" VALUE="238,238,238">
or
<PARAM NAME="chat_message_border_color" VALUE="#FFFFFF">

chat_message_back_color

Name : chat_message_back_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 255,255,255
Detail : Color of the area inside border of each message.
Example :
<PARAM NAME="chat_message_back_color" VALUE="238,238,238">
or
<PARAM NAME="chat_message_back_color" VALUE="#FFFFFF">

default_message_fore_color

Name : default_message_fore_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 0,0,0
Detail : Default foreground color of user's message (If login as anonymous only)
Example :
<PARAM NAME="default_message_fore_color" VALUE="238,238,238">
or
<PARAM NAME="default_message_fore_color" VALUE="#FFFFFF">

default_message_back_color

Name : default_message_back_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 255,255,255
Detail : Default background color of user's message (If login as anonymous only)
Example :
<PARAM NAME="default_message_back_color" VALUE="238,238,238">
or
<PARAM NAME="default_message_back_color" VALUE="#FFFFFF">

default_name_fore_color

Name : default_name_fore_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 0,0,0
Detail : Default foreground color of user's nickname (If login as anonymous only)
Example :
<PARAM NAME="default_name_fore_color" VALUE="238,238,238">
or
<PARAM NAME="default_name_fore_color" VALUE="#FFFFFF">

default_name_back_color

Name : default_name_back_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 255,255,255
Detail : Default background color of user's nickname (If login as anonymous only)
Example :
<PARAM NAME="default_name_back_color" VALUE="238,238,238">
or
<PARAM NAME="default_name_back_color" VALUE="#FFFFFF">

table_back_color

Name : table_back_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 255,255,255
Detail : Background color of room list table and user list table
Example :
<PARAM NAME="table_back_color" VALUE="238,238,238">
or
<PARAM NAME="table_back_color" VALUE="#FFFFFF">

table_fore_color

Name : table_fore_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 0,0,0
Detail : Foreground color of room list table and user list table
Example :
<PARAM NAME="table_fore_color" VALUE="238,238,238">
or
<PARAM NAME="table_fore_color" VALUE="#FFFFFF">

toolbar_back_color

Name : toolbar_back_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 238,238,238
Detail : Background color of toolbar
Example :
<PARAM NAME="toolbar_back_color" VALUE="238,238,238">
or
<PARAM NAME="toolbar_back_color" VALUE="#FFFFFF">

toolbar_fore_color

Name : toolbar_fore_color
Type : Hex color format e.g. "#FFFFFF" or number of Red,Green,Blue color e.g. 255,255,255
Required : no
Default : 0,0,0
Detail : Foreground color of toolbar
Example :
<PARAM NAME="toolbar_fore_color" VALUE="0,0,0">
or
<PARAM NAME="toolbar_fore_color" VALUE="#FFFFFF">

5.5 Widget look & feel setting

show_roomlist

Name : show_roomlist
Type : "true" or "false"
Required : no
Default : true
Detail : Show rooms list panel (List of all rooms on server)
Example : <PARAM NAME="show_roomlist" VALUE="true">

show_border

Name : show_border
Type : "true" or "false"
Required : no
Default : true
Detail : Show chat applet border.
Example : <PARAM NAME="show_border" VALUE="true">

auto_popup

Name : auto_popup
Type : "true" or "false"
Required : no
Default : false
Detail : Enable chat applet automatically popup after login.
Example : <PARAM NAME="auto_popup" VALUE="true">

auto_popup_width

Name : auto_popup_width
Type : integer
Required : no
Default : not set
Detail : Auto popup screen width
Example : <PARAM NAME="auto_popup_width" VALUE="400">

auto_popup_height

Name : auto_popup_height
Type : integer
Required : no
Default : not set
Detail : Auto popup screen height
Example : <PARAM NAME="auto_popup_height" VALUE="300">

show_logo

Name : show_logo
Type : "true" or "false"
Required : no
Default : true
Detail : Show or not show logo on rooms list page.
Example : <PARAM NAME="show_logo" VALUE="true">

show_front_logo

Name : show_front_logo
Type : "true" or "false"
Required : no
Default : true
Detail : Show or not show logo on first page and rooms list page.
Example : <PARAM NAME="show_logo" VALUE="true">

logo_path

Name : logo_path
Type : Path of logo image
Required : no
Default : "images/thaigeek.gif"
Detail : Path of logo image
Example : <PARAM NAME="logo_path" VALUE="images/thaigeek.gif">

about_logo_path

Name : about_logo_path
Type : Path of logo image in the about section. This directive can be actived only when you purchase Rebranded Edition and ISP Rebranded Edition.
Required : no
Default : NONE
Detail : Path of logo image
Example : <PARAM NAME="about_logo_path" VALUE="images/thaigeek.gif">

enable_room_watchdog

Name : enable_room_watchdog
Type : "true" or "false"
Required : no
Default : true
Detail : Automatically enable or disable the "Room watch dog" check box. This option can be enable/disable your users to automatically update room counter.
Example : <PARAM NAME="enable_room_watchdog" VALUE="true">

enable_float_button

Name : enable_float_button
Type : "true" or "false"
Required : no
Default : false
Detail : Enable or disable float button
Example : <PARAM NAME="enable_float_button" VALUE="true">

enable_sound

Name : enable_sound
Type : "true" or "false"
Required : no
Default : false
Detail : Enable or disable whole applet to play sound
Example : <PARAM NAME="enable_sound" VALUE="true">

enable_sound_private

Name : enable_sound_private
Type : "true" or "false"
Required : no
Default : false
Detail : Enable or disable applet to play sound when receive private message.
Example : <PARAM NAME="enable_sound_private" VALUE="true">

enable_sound_room

Name : enable_sound_room
Type : "true" or "false"
Required : no
Default : false
Detail : Enable or disable applet to play sound when receive new message in room.
Example : <PARAM NAME="enable_sound_room" VALUE="true">

enable_sound_online_room

Name : enable_sound_online_room
Type : "true" or "false"
Required : no
Default : false
Detail : Enable or disable applet to play sound when new user join room.
Example : <PARAM NAME="enable_sound_online_room" VALUE="true">

enable_sound_leave

Name : enable_sound_leave
Type : "true" or "false"
Required : no
Default : false
Detail : Enable or disable applet to play sound when user leave from room.
Example : <PARAM NAME="enable_sound_leave" VALUE="true">

enable_private_message

Name : enable_private_message
Type : "true" or "false"
Required : no
Default : true
Detail : Enable or disable private message
Example : <PARAM NAME="enable_private_message" VALUE="true">

enable_private_popup

Name : enable_private_popup
Type : "true" or "false"
Required : no
Default : false
Detail : Enable or disable new priate message to auto popup.
Example : <PARAM NAME="enable_private_popup" VALUE="true">

enable_view_profile

Name : enable_view_profile
Type : "true" or "false"
Required : no
Default : true
Detail : Enable or disable other users to view profile.
Example : <PARAM NAME="enable_view_profile" VALUE="true">

maximum_character_per_message

Name : maximum_character_per_message
Type : integer
Required : no
Default : 400
Detail : Maximum characters per message
Example : <PARAM NAME="maximum_character_per_message" VALUE="700">

auto_load_roomlist

Name : auto_load_roomlist
Type : "true" or "false"
Required : no
Default : true
Detail : Allow/Disallow applet to automatically download room list.
Example : <PARAM NAME="auto_load_roomlist" VALUE="true">

auto_close_window

Name : auto_close_window
Type : "true" or "false"
Required : no
Default : false
Detail : Allow/Disallow web browser window to automatically close after logout.
Example : <PARAM NAME="auto_close_window" VALUE="true">

5.6 Avatars and Emoticons settings

user_icon_width

Name : user_icon_width
Type : integer
Required : no
Default : 16
Detail : The the size of avatar image.
Example : <PARAM NAME="user_icon_width" VALUE="25">

user_icon_height

Name : user_icon_height
Type : integer
Required : no
Default : 16
Detail : The the size of avatar image.
Example : <PARAM NAME="user_icon_height" VALUE="25">

user_icon_???

Name : user_icon_???
Type : path name of avatars image
Required : no
Default : not set
Detail : Set avatars images by directive name "user_icon_???" while "???" is number of avatars images in series of avatars.
Example :
<PARAM NAME="user_icon_1" VALUE="images/user_icons/icon01.gif">
<PARAM NAME="user_icon_2" VALUE="images/user_icons/icon02.gif">
<PARAM NAME="user_icon_3" VALUE="images/user_icons/icon03.gif">
........
........
<PARAM NAME="user_icon_100" VALUE="images/user_icons/icon100.gif">

random_user_icon

Name : random_user_icon
Type : "true" or "false"
Required : no
Default : false
Detail : Random avatars setting for anonymous user
Example : <PARAM NAME="random_user_icon" VALUE="true">

max_user_icon

Name : max_user_icon
Type : integer
Required : no
Default : 70
Detail : The total of avatars when using the single image file and let applet cut each image.
Example : <PARAM NAME="max_user_icon" VALUE="50">

user_icon_path

Name : user_icon_path
Type : String
Required : no
Default : images/avatars.gif
Detail : Path the single big images that contain many images inside and let's applet cut each image. Use this directive instead of "user_icon_???" directive can increase the applet loading performance.
Example : <PARAM NAME="user_icon_path" VALUE="images/somewhere.gif">

emoticons_width

Name : emoticons_width
Type : integer
Required : no
Default : 16
Detail : The the size of emoticons image.
Example : <PARAM NAME="emoticons_width" VALUE="25">

emoticons_height

Name : emoticons_height
Type : integer
Required : no
Default : 16
Detail : The the size of emoticons image.
Example : <PARAM NAME="emoticons_height" VALUE="25">

emoticons_???

Name : emoticons_???
Type : (sign of emoticon) + (space) + (path name of emoticon image)
Required : no
Default : not set
Detail : Set of emoticon images by directive name "emoticons_???" while "???" is number of avatars images in series of avatars.
Example :
<param name="emoticons_1" value=":-) images/emotions/emotion_01.gif">
<param name="emoticons_2" value=":-| images/emotions/emotion_02.gif">
<param name="emoticons_3" value=":-( images/emotions/emotion_03.gif">
<param name="emoticons_4" value=":-p images/emotions/emotion_04.gif">
<param name="emoticons_5" value=":-D images/emotions/emotion_05.gif">
<param name="emoticons_6" value=":-/ images/emotions/emotion_06.gif">
........
........
<param name="emoticons_100" value=":-O images/emotions/emotion_100.gif">

max_emoticon

Name : max_emoticon
Type : integer
Required : no
Default : 40
Detail : Maximum emoticon images int the single images emoticons use this directive with "emoticon_path" directive.
Example : <PARAM NAME="max_emoticon" VALUE="50">

emoticon_path

Name : emoticon_path
Type : String
Required : no
Default : images/emoticons.gif
Detail : Path the single big images that contain many images inside and let's applet cut each image. Use this directive instead of "user_icon_???" directive can increase the applet loading performance.
Example : <PARAM NAME="emoticon_path" VALUE="images/emoticons.gif">

5.7 Color theme and Language settings

default_theme

Name : default_theme
Type : String with 10 types "Bubbleblue","Orange","Snow","Strawberry","Indigo","Grape","Flower",BlueBerry","Lollipop" and "Banana"
Required : no
Default : "Snow"
Detail : Specify the default color theme for applet (available only chatter applet)
Example : <PARAM NAME="default_theme" VALUE="Indigo">

random_theme

Name : random_theme
Type : boolean "true" or "false"
Required : no
Default : false
Detail : Random display color theme.
Example : <PARAM NAME="random_theme" VALUE="true">

language

Name : language
Type : String 5 types "en" - English , "th" - Thai , "ar" - Arabic, "fr" - French and "de" - German
Required : no
Default : "en"
Detail : Language label that display in applet.
Example : <PARAM NAME="language" VALUE="de">

5.8 External integration settings

external_view_profile_url

Name : external_view_profile_url
Type : String of URL
Required : no
Default : blank
Detail : String of External URL that you want to display profile, ie. "http://yourdomain.com/profile,.php?username=" It will display the Web browser popup and aplet will attempt to append given "username" to string So the result of this example must be "http://yourdomain.com/profile.php?username=nickname" You must implement the profile page with yourself.
Example : <PARAM NAME="external_view_profile_url" VALUE="http://www.abcdefghijk.com/profile.php?username=">

external_view_profile_scrollbars

Name : external_view_profile_scrollbars
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "false" or "true" if you want to enable/disable profile dialog to display scrollbars.
Example : <PARAM NAME="external_view_profile_scrollbars" VALUE="false">

external_view_profile_location

Name : external_view_profile_location
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "false" or "true" if you want to enable/disable profile dialog to display location.
Example : <PARAM NAME="external_view_profile_location" VALUE="false">

external_view_profile_menubar

Name : external_view_profile_menubar
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "false" or "true" if you want to enable/disable profile dialog to display menubar.
Example : <PARAM NAME="external_view_profile_menubar" VALUE="false">

external_view_profile_toolbar

Name : external_view_profile_toolbar
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "false" or "true" if you want to enable/disable profile dialog to display toolbar.
Example : <PARAM NAME="external_view_profile_toolbar" VALUE="false">

external_view_profile_status

Name : external_view_profile_status
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "false" or "true" if you want to enable/disable profile dialog to display status bar.
Example : <PARAM NAME="external_view_profile_status" VALUE="false">

external_view_profile_resizable

Name : external_view_profile_resizable
Type : "true" or "false"
Required : no
Default : false
Detail : Set to "false" or "true" if you want to enable/disable profile dialog to resizable.
Example : <PARAM NAME="external_view_profile_resizable" VALUE="false">

external_view_profile_width

Name : external_view_profile_width
Type : integer
Required : no
Default : 480
Detail : The width of external profile dialog.
Example : <PARAM NAME="external_view_profile_width" VALUE="640">

external_view_profile_height

Name : external_view_profile_height
Type : integer
Required : no
Default : 400
Detail : The height of external profile dialog.
Example : <PARAM NAME="external_view_profile_height" VALUE="480">

5.9 Virtual domain settings for client applet

virtual_domain

Name : virtual_domain
Type : String of virtual domain
Required : no
Default : main
Detail : String of virtual domain name that you create in the "Admin Applet" see the picture below

In this picture above the name of virtual domain name is "some_chat".
By default the main virtual host name is "main" if you ommit to specify the virtual_domain directive it will automatically connect to the "main" virtual host.
Example : <PARAM NAME="virtual_domain" VALUE="some_chat">

Home