Below is the full list of Parameters taken from the official ChatSpace help documents.
If true, the Action button appears in the input area. false removes it. Default is true.
e.g. action=false
When true, members can be sent on Web and Room Tours. Default is true.
e.g. allowtour=false
If true, when a private message is sent the color of the message will either be voiceColor if the person is "voiced" or operColor if the person is a Moderator, or guestColor if the person nickname starts with "guest". If this parameter is false the message is always in the talkColor
operColor = cyan or blue depending on the background
voiceColor = green or dark green depending on the background
talkColor = is the default color of the speaker.
Default is false.
Specifies the background color between the chat area and the buttons/border area. This parameter is expressed as a hexadecimal number of the format RRGGBB, for red, green and blue values.
e.g. background=FFCCAA
Default is 000066
Specifies the path to the graphics file (relative to the codebase) which appears as the background of the chat message area. This setting can help enhance the visual look of the applet. Note, the background image should be wide and high enough to cover the chat area background. Also, large images may also lead to longer download times.
e.g. backimage=images/background_image.gif
Default is no image
Specifies the background color of the chat area.
e.g. bg=FF0000
Default is FFFFFF
If false, the buddy list tab is not displayed.
e.g. buddyList=false
Default is true
Specifies the name of the room to join. This value will appear in the applet login section if set.
e.g. channel=Lobby
There is no default value.
Specifies the color if the rooms tab section of the applet.
e.g. channelsColor=00FF00
Default is F8F8EE
Specifies the pixel size of the buttons along the top of the applet. The buttons are square so this value is used for both the width and height.
e.g. chatButtonsSize=16
Default is 25 pixels width and height.
Related to the buttons along the top of the applet. It specifies the number of pixels between the bottom of the frame and the bottom of the buttons. This is used when changing skins to shift the top buttons higher or lower in relation to the skin.
e.g. chatButtonsLowerMargin=1
Default is 5 pixels
Makes the buttons at the top of the applet visible or invisible, value is true or false.
e.g. chatButtonsVisible=false
Default is true
If true, the Color selection buttons are shown in the input area. false removes them.
e.g. chatcolor=false
Default is true
If this value is true, messages are displayed with colors if necessary.
e.g. color=true
Default is true
Performs an initial connect automatically if a nickname is specified. If this value is false, the member is not signed on immediately and may enter other values in the nick, Email, room and password fields.
e.g connect=false
Default is false
If false, copy and/or pasting chat and input text is disabled.
e.g. copyPaste=false
Default is true
Makes the create room button visible or invisible. This is the button displayed to the right of the input area when the rooms tab is visible.
e.g. createRoomButtonVisible=false
Default is true
Specifies whether or not the ChatSpace branding image appears in the lower right corner of the interface. This parameter is disabled in ChatSpace FREE Edition.
e.g. csbranding=false
Default is true
Specifies the color of the flashing cursor in the input area.
e.g. cursorColor=00FF00
Default is black
Specifies the amount of time, in minutes, that bans will remain in force before being automatically removed.
e.g. defaultBanTime=60
Default is an empty string (permanently ban)
If a room name is specified here, then member input is sent to the named room, instead of the room the member is in. The value must be prefixed with a "#" character.
e.g. defaultInputChannel=#screenRoom
There is no default. The room the user is currently in receives the message
When true, all members are automatically set to "Do Not Disturb" mode, which means that private messages will not be received from anyone.
e.g. dnd=false
Default is false
This parameter should be set to true if the applet is loaded from an embedded script, for example embed.js. If true, when the members list html file is displayed (when the user clicks the list members button in the applet), extra parameters are passed across, these are needed due to javascript permission problems that may occur under certain circumstances.
e.g. embed=true
Default is false
If true, the Emotions button appears in the input area. If false, the Emotions button is not displayed.
e.g. emotions=false
Default is true
Specifies the foreground color of the chat area. This color should not be the same as the background color.
e.g. fg=00FF00
The default is light gray
When true, enables the file transfer functionality of the applet. When false, users may not use the file transfer feature.
e.g. fileTransfer=false
The default is true
Specifies the name of the font used throughout the applet (excluding the input area).
e.g. font=monospaced
Default is no font specified, it uses the default font on the system usually “Dialog”
Sets a member's Full Name when signing on. This is not the “Name” field of the profile. It is only displayed to IRC clients using the /who and the /whois commands.
e.g. fullname=ChatSpace Java Client
Default is empty string.
Provides the location of the help page, which is displayed when members click the “?” icon in the upper right corner of the interface.. The default is the help.htm in the main (Data) ChatSpace Java directory. HelpUrl is passed the user’s current nickname and password.
e.g. helpURL=http://www.acme.com/clienthelp.htm
Default is help.htm in main ChatSpace Java directory.
If true, the area where the user types is hidden.
e.g. hideInput=true
Default is false.
Hides the login screen when the applet is initializing if all needed information is supplied in the web page at startup. The needed information is nickname and room.
e.g. hideLogin=true
Default is false.
Prevents the applet from flickering as a the logout process is being performed
e.g. hideLogout=true
Default is false.
Sets the room text box on the applet login tab visible or invisible. If this parameter is true, the room parameter must be supplied in the html page.
e.g. hideRoomPrompt=true
Default is false.
This parameter specifies the number of chat messages the ChatSpace Java Client maintains before rolling off the oldest messages.
e.g. history=100
Default is 500
This parameter has the same functionality as the fullName parameter above
Specifies the pixel width (and height) of the input buttons (those buttons below the input area). These buttons are square so this value specifies both the width and height. This parameter is useful when combined with your customized skin.
e.g. inputButtonsSize=16
Default is 25
Makes the buttons at the bottom left of the input area visible or invisible
e.g. inputButtonsVisible=false
Default is true
Makes the input section at the bottom of the applet visible or invisible. The input section is the area when the user types messages.
e.g. inputFieldVisible=false
Default is true
Specifies the size of the input area font.
e.g. inputFontSize=14
Default is not specified, the default font size of the browser is used
Specifies whether or not the member is prompted about entering input and pressing enter when first signing on.
e.g. inputPrompt=true
Default is false
This parameter performs the same functions as parameter “channel” above.
Specifies the names of rooms (comma separated) to have the user enter when he first signs on.
e.g. joinRooms=Lobby,Show
Default is nothing.
If True, members will see other members joining and leaving the room.
e.g. joins=false
Default is true
The name of the sound file to play whenever a member joins the room. To turn off the sound specify an empty string. The default is to not play a sound unless the member checks the box on the session panel. Sounds must be in 8bit mono au format. WAV sounds will not work.
e.g. joinSound=joinRoom.au
Default is join.au
If the room has a key set on it to restrict entry, this param specifies the value of that key. If not specified, and the room does have a key set, then the member will be presented with a pop-up box prompting him for the key word before he can get into the room.
e.g. key=xcvzdf
There is no default
If using the joinRooms command to join multiple rooms at once, this parameter can be used to specify the keys to each of the rooms to be joined. This parameter must list the keys in the same order as the rooms specified in the joinRooms command. The keys are separated by commas
e.g. if joinRooms=Lobby,Room1,Room2,Room3 and you wish to specify the keys for Lobby Room1 and Room 3, Room 2 does not have a key, you would specify
keys=key1,key2,,key4
There is no default
Specifies the sound the room moderators hear when someone knocks for entry into an invite-only room. To turn off the sound, specify an empty string.
e.g. knockSound=splash.au
Default is knock.au
Specifies the maximum number of rooms in the auto-refreshing list. If the number of rooms on the server exceeds this limit, then the list can be refreshed using the /list command.
e.g. listcount=100
Default is 500
Controls how often the rooms list is refreshed on the client.
e.g. listTime=80
Default is 60
Specifies the background color of the room members list.
e.g. membersColor=006600
Default is F8F8EE
Provides the location of the members list. The default is the members.htm in the main (Data) ChatSpace directory. MembersUrl is passed the user’s current nickname and password.
e.g. membersURL=http://www.acme.com/memberslist.htm
Default is members.htm in main ChatSpace Data directory.
Specifies the width (in relative percent) of the member names list section of the Java Client. If this parameter is coded 0, the member list will be hidden, but can be dragged to any width by clicking on the right edge of the window, and dragging the 'sash' to the desired width. The width can be adjusted by using the mouse.
e.g userWidth=15
Default is 20
Specifies the sound members hear when they receive a normal message. To turn off the sound, specify an empty string.
e.g. msgSound=msgsnd.au
Default is msg.au
Description : turns the multiple rooms feature on or off. When this feature is true, the user can be in more than one room at once.
e.g. multipleRooms=true
Default is false, single room mode only
Specifies the value of the name prompt on the sign-on panel. This is normally not used.
e.g. nameprompt=Your name
Default is name
Sets the member's nickname when signing on. The member can change this before signing on if the Java Client presents a prompt for the nickname and room.
e.g. nick=mary
Default is nothing
Specifies the value of the nickname prompt on the sign-on panel.
e.g. nickPrompt=Your nickname
Default is Nickname
The name of the sound file to play when a notice message arrives for the member. To turn off the sound specify an empty string.
e.g. noticeSound=notice1.au
Default is notice.au
Also see autoMsgColors setting above. Sets the text color if the person who is an operator.
e.g operColor=FF0000
The default is black, this parameter should be specified when autoMsgColors setting is true
This parameter is used only in the web page and cannot be used inside a parameter file. It allows the user to specify a path to the parameters file on the server which contains the settings for the applet. This path is relative to the applet code base
e.g. paramPath=parameters/myparams.prm
Default is nothing, no parameters file is used. All parameters are read from the html page.
This value provides a password used to validate a user’s access to the server. If enforced, this value must match a password on the client class definition in the Configuration Tool. If passwords are not required by the server, then this field is irrelevant.
e.g. pass=zxcdf
Default is nothing.
Specifies the value of the password prompt on the sign-on panel. If no value is provided, the password prompt will not be shown. This password may be used to compare the password on the client class definitions in the Configuration Tool.
e.g. passPrompt=YourPassword
Default is nothing
If true, the room's welcome sound will be played to new members as they join the room. This is not the "ChatSpace" sound that is played when the applet starts. This is a file in c:\Program Files\ChatSpace\Community Server\CSServer\Data\Sounds\RoomWelcomes\roomNameHere.au
e.g. playRoomWelcomeSound=true
Default is false
If true, the message of the day is shown in its own popup dialog after login.
e.g. popupMotd=true
Default is false
One or more ports, separated by commas, that the Java Client will attempt to connect to ChatSpace on. Usually, this is the same as the “ChatPorts” listed in the ChatSpace Configuration Tool’s General Tab, Advanced section. If all ports listed here are tried and connection still cannot be made, ChatSpace will "tunnel" the chat data over the HTTP protocol.
e.g. ports=7000,667,443
Default is nothing, no ports specified, the port parameter below will be used instead
This parameter specifies the specific TCP/IP communications port on which the ChatSpace Java Client connects to the ChatSpace server. The value to specify with this setting can be found in the ChatSpace Server Controls, Configuration Tool's General Tab, Advanced section.
e.g. port=7000
Default is 6667
If true, member sees his own text in the rooms prefixed by his own nickname. Whether true or false, userB will always see userA's text prefixed by userA's nickname.
e.g. prefixSelf=false
Default is true
Specifies the sound to use when member is prompted. To turn off the sound, specify an empty string.
e.g. promptsound=prompt.au
Default is prompt.au
If true, all quieted users in a room will display last in the users list.
e.g. quietLast=true
Default is false
Specifies the web page URL that members are sent to when they Quit the chat. If not specified, the user is redirected to the chat login page. If specified as an empty string "" then the login tab of the applet is display and no redirect is made, if a url is specified this is redirected to on a quit.
e.g. This will redirect to this url on a quit.
quitURL=http://www.acme.com
This will go back to the login tab in the client when the user quits.
quitURL=
Default is nothing, the user is redirected to the login page (login.htm)
This parameter specifies the target frame for the quit url (quitURL param above).
e.g. QuitURLTarget=_top
Default is _self
If this parameter is true then a random color is chosen and this color becomes the color of the current users chat text.
e.g. randomUserColor=true
Default is not specified and the users color is always 009393
Description: Provides a link to the appropriate lightweight membership system page when an unregistered member tries to view his profile.
e.g. registerViaURL=true
Default is false, the standard "Register" button is displayed.
This parameter specifies period between successive “keep alive” events. The keep-alive event is used to monitor the state of the connection between the chat client and server. It is used to specify how quickly a dropped connection is detected, the lower the reconnection time, the more quickly a broken connection is detected, but the more network traffic is generated.
e.g. reconnectTime=30
Default is 60
If true, allows the client to issue commands that only lead to signon and sending messages into a room. The member may not change rooms.
e.g. restricted=true
Default is false
Same parameter as channel.
This parameter specifies the message to appear in the popup when a user attempts to join a room that is already full. You can include {0} in the text to position the name of the room in the sentence.
e.g. roomFullMessage="{0} is full right now. Please try another room."
Default is the default room is full message.
If true, room options are only available to room moderators and above. A message dialog will appear if a normal user tries to view room options. If false (default) room options are visible to all.
e.g. roomOptionsAuthOnly=true
Default is false
The text to display next to the room text box in the applet login tab.
e.g. roomPrompt=Raum
Default is Room
When true, the rooms tab is added to the interface, between the Chat and the Options tabs.
e.g. rooms=false
Default is true
Makes the send button visible or invisible. The send button is located next to the input area.
e.g. sendButtonVisible=false
Default is true
Sets the name of the server the client will connect to. The applet must be digitally signed for this parameter to work correctly, due to the permissions needed.
e.g. server=chat.chatspace.com
Default is the server that the applet was loaded from (requires no special permissions)
Description: shows a URL link to the privacy page at the bottom of the member profile. If true, the page shown is c:\Program Files\ChatSpace\Community Server\CSServer\Data\Java\Profile_Privacy.htm
e.g. ShowProfilePrivacyLink=true
Default is false, no link is shown.
If true, the pop menu is displayed when the user holds down the the send button. If false, no menu is shown.
e.g. showActions=false
Default is true
If true, the chat options and room options buttons are shown.
e.g. showCmds=false
Default is true
Displays a message when other members join the same room he/she is in.
e.g. showJoins=false
Default is true
If true, adds the URL to access the Java client to each member's name information (seen with /WHOIS command or Profile button). This is useful to determine the web page used to gain access to the Java client.
e.g. showURL=true
Default is false
Specifies the size of the font used throughout the applet.
e.g. size=12
Default is the default font system of the browser
Sets the path relative to the codebase for the location of the skins graphic files.
e.g. skinsPath=images/skins/blue
Default is no skins path. Skins are loaded from inside the applet archive (the JAR or CAB).
If true, the Sound button is shown along the bottom row of the java client. false removes the button.
e.g. sound=true
Default is true
Specifies the name of the .gif file in the Java\images directory which is shown next to the sounds that members play in the room.
e.g. soundGraphicFilename=images/icon_sound.gif
Default is images/icon_sound.gif
This parameter sets the directory where additional sounds are available from (in addition to the default sounds).
e.g. specialSounds=soundsmic
Will load the sounds from the c:\Program Files\ChatSpace\Community Server\CSServer\Data\Sounds\soundsmic directory as well as the c:\Program Files\ChatSpace\Community Server\CSServer\Data\Sounds directory.
Specifies the style of the font (plain, bold, or italic).
e.g style=bold
Default is not specified, the value is take from the default browser font (usually plain)
If true, Person to Person chat windows are “docked” as tabs on the client interface, rather than as free-floating windows.
e.g tabbedp2p=true
Default is false
If true, tabs are shown along the top of the client, allowing the user to switch between rooms.
e.g tabs=false
Default is true
Also see autoMsgColors setting above. Sets the text color if the person who is talking to the user.
e.g talkColor=00FF00
Default is black. This parameter should be specified when autoMsgColors setting is true
This parameter specifies the height of the title bar in the chat area in pixels.
e.g. titleHeight=30
Default is 25
When true, members are prompted to confirm their permission before being sent on a tour of a room or web address.
e.g. tourprompt=false
Default is true
Specifies the color of the text in the tool tip area. The tool tip area is below the input area and the right of the input buttons.
e.g For red tool tip text,
toolTipTextColor=FF0000
Default is white
Specifies the port on which to HTTP tunnel from the ChatSpace Java Client to the server. If the applet is not already in tunnel mode, this parameter will force the applet to tunnel via HTTP. This parameter is useful for getting though firewalls or proxies (see proxyPort, proxyHost parameter specifications above). When the applet is tunneling, all communication is formatted to appear as HTML pages to proxies or firewalls between the client and server.
e.g. tunnelPort=80
Default is not specified, the applet will tunnel if needed (the client will autodetect this) on the default HTTP port in which it was served, usually port 80.
Sets the color of the url links which appear in the chat window. This value is an integer IRC color value between to 1 and 16 inclusive.
e.g. For a red url,
urlColor=4
Default is light blue
Sets the member's username when signing on. The member can change this before signing on if the Java Client presents a prompt for the username.
e.g. user=JClient
Default is java
Tells the applet to send and receive using Unicode. This setting must be used when a foreign language (non-English) is used during a chat session.
e.g. useUnicode=true
Default is false, all chat data transferred is non-unicode
Also see autoMsgColors setting above. Sets the text color if the person who has voice.
e.g voiceColor=00FF00
Default is black. This parameter should be specified when autoMsgColors setting is true
On the Profile page, if this parameter is specified, it will display a "Profile" button. When this button is clicked, the webprofile url specified will be shown. The target nickname and member parameters will be appended to the URL.
e.g. webprofile=http://www.acme.com/profileprocessor.aspDefault is no Profile button visible on the Profile screen.
Sets the color of your the chat text.
e.g. youColor=FF0000
©2008 Stelivo, Inc. All rights reserved. Oliver Cozzi