RealChat Software

3.2.2. Configuration Directives Reference



Common Configuration



Language

Type: text
Default: en

A valid ISO language code. These codes are the lower-case two-letter codes as defined by ISO-639. You can find a list of currently supported languages and instructions about how to download and install additional language packs at http://www.realchat.com/dl-lang.php/.

[Top]

windowWidth, windowHeight

Type: number
Default: not set

The overall dimensions of the applet main pop-up window in pixels. By default, the applet will resize its main window according to the screen size.

[Top]

windowResizable

Type: yes/no
Default: yes

Whether or not the user is able to resize the applet window.

[Top]

logoImage

Type: filename
Default: not set

The image to be displayed on top of the client applet. It can be either GIF or JPEG format. The logoImage file must reside in images/ subdirectory of the applet install path, as in the following example:

Config file: logoImage = header.gif

The applet looks for: /home/username/public_html/chat/images/header.gif

Tip: To speed things a bit, take a look at the JAR Manipulation section.

[Top]

logoImageAlignment

Type: left/center/right
Default: left

Logo image alignment.

[Top]

onLoadURL

Type: URL
Default: not set

The URL to open after the client applet loads. URL may be either a fully qualified URL, such as http://www.example.com/chat/banners.html, or a file relative to the client applet install path.

[Top]

onLoadURLTarget

Type: text
Default: _blank

The frame target to open onLoadURL in. The default value "_blank" will open the URL in a new browser window.

[Top]

onCloseURL

Type: URL
Default: not set

The URL to open after the client exits the chat session.

[Top]

onCloseURLTarget

Type: text
Default: _top

The frame target to open onCloseURL in.

[Top]

helpURL

Type: URL
Default: applet codebase + /help/

The URL to link the applet help button to, as in the following example:
http://www.example.com/chathelp.html

[Top]

offensiveWords

Type: comma separated list
Default: not set

RealChat Client applet supports real-time filtering of up to fifty pre-defined words. Each word from the list is replaced with '@#$!*'.

[Top]

useIconsAsAvatars

Type: yes/no
Default: yes

Whether to add chat icons to the avatar list.

[Top]

useAvatarsAsIcons

Type: yes/no
Default: no

Whether to add avatar icons to the chat icon list.

[Top]

soundSupportDisabled

Type: yes/no
Default: no

Whether to disable sound support. In some cases, you may want to disable sound support completely.

[Top]

preloadSounds

Type: yes/no
Default: no

Whether to load sounds during initialization or on demand. If you use No, this means a faster loading speed.

[Top]

maxMessageLength

Type: number
Default: 2000

The maximum message length for messages typed in the chat window.

[Top]

maxIconsPerLine

Type: number
Default: 20

An option to limit the count of icons (//x codes) displayed per line.

[Top]

defaultNick

Type: text
Default: not set

The default nickname to put on applet login prompt, as in the following example: defaultNick = Guest

[Top]

disableIRC

Type: yes/no
Default: no

Enables or disables IRC-like commands like /who and /join.

[Top]

embedded

Type: yes/no
Default: no

An option to run the applet within the current HTML page without launching a new window.

Note: This is a feature of Enterprise Edition.

[Top]

dosKey

Type: yes/no
Default: no

Enables or disables an option like a DOS key, so users can use the Up and Down arrows on the keyboard to invoke recently typed lines.

[Top]

ThemeNN

Type: formatted string

Definition of the theme menu items in the form: Descriptive name,File name. You can add up to thirty-two menu items here. This is usually set in RealChatClient.conf. All the theme .jar files must be present in the themes/ subdirectory of the chat client.

Example:

Theme0 = Clearwater, clearwater
Theme1 = Crystallized, crystallized
Theme2 = Metropolitan, metropolitan
Theme3 = Utopia, utopia

Note: The client starts with 'defaultTheme' selected.

More themes can be found at http://www.realchat.com/dl-skins.php.

It is also possible for you to create customized themes to perfectly match your web site. This topic is covered in the Notes and Procedures section.

[Top]

defaultTheme

Type: number
Default: 0

The default theme to start the client.

[Top]



Contents | Parent Topic | Previous Topic | Next Topic