ConferenceRoom Java Client 1.9
Command Reference
The following commands are available to the user in
the 1.9 series client. However, some commands are available only in the
non-restricted client version and are for more advanced usage.
The format of commands is: /[command] [argument1] [argument2 etc.]
- Restricted Command Set
- NICK [new nickname]
Changes your current nickname to a new one
- QUIT
Disconnect from the chat server
- LIST
Retrieve a list of available rooms on the chat server
- NAMES [room name]
Retrieve a list of nicknames in the room
- ME [action]
ACTION [action]
- SOUND
- FLOAT
If the client is currently embedded in a web page, this
command will detach it from that page
- EMBED
If the client is currently floating, this command will
embed it back in it's web page
- WHOIS [nickname]
WHOWAS [nickname]
Get detailed
information on a specific user
- CLEAR
No other commands are allowed in Restricted
mode.
Restricted mode only allows a connection to a single channel. If
the client is currently in a channel and a new channel is joined, the current
room will be parted.
- Normal Command Set
- NICK [new nickname]
Changes your current nickname to a new one
- JOIN [room name]
NEWJOIN [room name]
ROOM
[room name]
Join a new room
- PART
Leave the current room you're in
- QUIT
Disconnect from the chat server
- LIST
Retrieve a list of available rooms on the chat server
- NAMES [room name]
Retrieve a list of nicknames in the room
- ME [action]
ACTION [action]
- SOUND
- FLOAT
If the client is currently embedded in a web page, this
command will detach it from that page
- EMBED
If the client is currently floating, this command will
embed it back in it's web page
- WHOIS [nickname]
WHOWAS [nickname]
Get detailed
information on a specific user
- SHOW [room / nick]
If you have a window for that room or have
a private chat window to that user, this will cause it to come to the front
of the other windows
- SHOWTICKER
HIDETICKER Show or hide the ticker
- CLEAR
Any /[command] statements not specifically
checked for by the client are passed through to the server as-is. For
example,
/thisisacommand
will be passed directly to the server
even though the client does not recognize it-- maybe the server will.
- Applet Params
- override [list of params] unlocks specific params so that they
can be read from HTML source
- ssp [server side param file]
- lock [true/false] (false) locks the params to only be allowed
from server side param files
- backpack [true/false] (false)
- simple [true/false] (false) Simple UI mode, only allows one room
- restricted [true/false] (false) Restricted command set, also uses
simple UI mode
- fg [color] Default foreground (text, etc.) color
- bg [color] Default background color
- font [font name] Font to use
- style [BOLD, ITALIC] Font style to use
- size [point size] Font point size to use
- lurk [true/false] (false) Lurking mode, requires a user to give a
nickname before being able to speak, otherwise he remains an unspeaking
guest in a room
- room [room name]
channel [room name]
join [room name] Room
to join immediately after connecting to the chat server
- defaultinputchannel [room name] Even though you may be watching
another room, your typing will go to this room instead
- key [room key] Password to get into the room specified by the
room or channel param
- nick [nickname]
- guest Connect this user as a guest on the server which may also
bring the lurk param into play
- user [login name] (java)
- fullname [full name]
info [full name] (Java User)
- server [server name] Server to connect to. Not really necessary
since the applet will automatically try to connect back to it's server
- port [number] (6667) Port number to connect to
- pass [server password] Password to the server if set
- connect [true/false] (true) Automatically connect to the server
- helpfile [helpfile.html] File to attach to the Help button,
default is the Help.htm file provided with CR
- showjoins [true/false] (true) Show room joins by other
users
showJoins (1.8 compatibility)
- onlyshowchat [true/false] (false) Only show what people say,
filtering "junk" like joins/parts/etc.
- playsounds [true/false] (true)
- showbuttonpanel [true/false] (true)
buttonpanel (1.8
compatibility)
- showcolorpanel [true/false]
colorpanel (false)
- showticker [true/false] (true)
- joinsound [sound file]
joinSound (none) Sound file to play
when joining a channel
joinSound (1.8 compatibility)
- noticesound [sound file]
noticeSound (none) sound file to play
when receiving a notice
noticeSound (1.8 compatibility)
- timestamp [true/false] (false) Turn on timestamping
- list [list parameters] (none) Allows you to specify arguments to
the auto /LIST command
- listtime [seconds]
listTime (0) How often the rooms list is
automatically refreshed, 0 means never
listTime (1.8 compatibilty)
- ticker, ticker1, ticker2, ... ticker9 Set initial lines in the
ticker
- tickerfont [font name] (same as Font param) Font to use
- tickerstyle [BOLD, ITALIC] Font style to use
- tickersize [point size] Font point size to use
- tickerspeed [speed] (30) Milliseconds to pause when scrolling the
ticker
- tickerpause [time] (3s) Seconds to pause when a line reaches the
edge
- tickerlifetime [time] (0) How long the ticker will last
- tickerrepeat [times] (3) How many times to show the ticker before
expiring
- guicolors [colors]
guicolors1, guicolors2, ... guicolors9
- actions [action strings]
actions1, actions2, ... actions9
- sounds [sound strings]
sounds1, sounds2, ... sounds9
- nickprompt [prompt] (Your nickname)
- nameprompt [prompt] (Your email address)
- roomprompt [prompt] (Join channel)
- passprompt [prompt] (none) if provided, will ask for a server
password
- hideinput [true/false] (false) Hide the input bar
-
*** New in 1.9.33 ***
- idle [minutes] (0 [off]) Number of minutes to wait before
disconnecting the user for idling. 0 turns off idle detection
- showserverwindow [true/false] (true) show the server messages
window
- lurktext [text] (Please enter a nickname to participate) text to
show in the lurk mode nick change prompt
- usertext [text] (Users) text for the users column header
- roomstext [text] (Rooms) text for the rooms column header
- userwidth [int]
userWidth (25) percentage of channel displays
allocated to user list column
- roomswidth [int]
roomsWidth (25) percentage of channel
displays allocated to rooms list column
- usersbackgroundimage
usersforegroundimage (none) background
and foreground images for the users list area
- roomsbackgroundimage
roomsforegroundimage (none) background
and foreground images for the rooms list area
- historybackgroundimage
historyforegroundimage (none)
background and foreground images for the room history area
-
*** New in 1.9.34 ***
- floatnewwindows [true/false] (false) new private message and new
channels joined appear in automatically floating windows
- banner [-Client message-;-click URL-;-image-] backpack image
settings
note:client was replaced by banner
-
*** New in 1.9.35 ***
- showcolors [true/false] (true) show colors and font styles in
rooms
-
*** New in 1.9.37 ***
- showroomnames [true/false] (true) show room name buttons for easy
switching between rooms. If false floatnewwindows will be
automatically set to true
-
*** New in 1.9.39 ***
- loadmodules [string] (none) dynamic modules to load on startup.
Multiple modules separated by ,
-
*** New in 1.9.40 ***
- nicklock [true/false] (false) locks nicks to only one change
(unless they are subsequently Guest-ed)
-
*** New in 1.9.41 ***
- showusertitlebar [true/false] (true) show the titlebar for the
user columns (can be turned off if using background/foreground images)
- showhistorytitlebar [true/false] (true) show the titlebar for the
room history columns (can be turned off if using background/foreground
images)
- showroomstitlebar [true/false] (true) show the titlebar for the
rooms columns (can be turned off if using background/foreground images)
-
*** New in 1.9.43 ***
- showwindowbuttons [true/false] (true) show the close and
minimize/maximize buttons on windows
- lips [true/false] (false) show the lips column in the user list
- clickurl [String] In lips mode, a double click on a user name
will do a /furl to for that nick, eg,
clickurl=http://www.webmaster.com/?home=%u will furl to
clickurl=http://www.webmaster.com/?home=%user%
- singleroom [true/false] (false) if true, normal mode will only
allow a single room to be joined. Restricted mode already forces this
-
*** New in 1.9.47 ***
- historywatermark [true/false] (false) if true, history's
background image is centered
- userswatermark [true/false] (false) if true, user's background
image is centered
- roomswatermark [true/false] (false) if true, rooms's background
image is centered
- timestampsecs [true/false] (false) if true and timestamp is true,
shows seconds in the timestamp info
-
*** New in 1.9.48 ***
- image0, image1, image2, .. image63 set up to 64 images the user
can use in their chat. The value should be the image name and a description
of the image
ex. <param name=image5 value="smile.gif :)">
- linespacing (0) set the vertical line spacing for the history
area
- tickerfeed, tickerfeed1, tickerfeed2, ... tickerfeed9 set up to
10 external ticker files
- incomingprivatewindow [true/false] (false) if true incoming
private messages open a window
-
*** New in 1.9.50 ***
- commands [commands strings]
commands1, commands2, ...
commands9
-
*** New in 1.9.51 *** (BuddyList params)
- buddies [buddy, buddy, channel, ...] list of users or channels to
put on your temporary watch list
- buddybg [color] (bg param) background color for buddy list
- buddyfg [color] (fg param) foreground color for buddy list
- buddyonline [color] (fg param) color for online users in the
buddy list
- buddyoffline [color] (fg param) color for offline users in the
buddy list
- buddychannelactive [color] (fg param) color for active channels
in the buddy list
- buddychannelinactive [color] (fg param) color for inactive
channels in the buddy list
- buddysound [sound] sound to play when a new message comes in
-
*** New in 1.9.53 ***
- opimage [URL] (op.gif) Image to use in the user list for ops
- voiceimage [URL] (voice.gif) Image to use in the user list for
voice
-
*** New in 1.9.55 ***
- tickertopics [topic1,topic2,topic3,...] If set, will only show
newsflashes with one of the specified topics
- alltopics [topic1,description1];[topic2,description2];... set all
possible topics and descriptions of each, for use by the TickerTopics module
-
*** New in 1.9.59 ***
- uopimage [URL] (uop.gif) Image to use in the user list for uops
-
*** New in 1.9.61 ***
- noload [true/false] (false) Don't show the load progress meter
- noprompts [true/false] (false) Don't show any nickname, email, or
room prompts
- nosettings [true/false] (false) Don't show the Show User Settings
button on login window
-
*** New in 1.9.62 ***
- showavatars [true/false] (true) show user avatars
- maxavatarheight [height] (0) maximum height for avatar images
- avatar0, avatar1, .. avatar15 [image] up to 16 avatar images used
by the AvatarPanel. The value should be in the format [image] [name]
ex.
<param name=avatar6 value="spider.gif Spider">
-
*** New in 1.9.66 ***
- showsendbutton [true/false] (false) show a Send button on the
input bar
- usenameinnick [true/false] (false) use the value of the name
prompt in the nickname. It will be appended to the value of the nick prompt
with an underscore bar ( _ ) between
- makeuniquenick [true/false] (false) ensures a uniquely numbered
version of the requested nickname, by appending incrementing numbers to the
end of the name until a free one is found
-
*** New in 1.9.67 ***
- nouserbevel [true/false] (false) no bevel around the user list
area
- nohistorybevel [true/false] (false) no bevel around the history
area
- noroomsbevel [true/false] (false) no bevel around the rooms area
-
*** New in CR All 0.5 (combination of the normal ConferenceRoom client
and a miniclient) ***
- useminichat [true/false] (false) use the mini client without
prompting
- askclienttype [true/false] (false) prompt to use either the mini
client or the regular client, otherwise will load the one appropriate for
the Java support on the browser
-
*** New in CR All 0.8 (combination of the normal ConferenceRoom client
and a miniclient) ***
- encoding [name] (none) character encoding to use, defaults to the
user's OS default. Only used by the normal client, not the miniclient
-
*** New in CR All 0.9 (combination of the normal ConferenceRoom client
and a miniclient) ***
- mytextcolorindex (none) if set, causes you to use one of the
colors indexed by 0 to 15 by default. all other users will see the color
-
*** New in CR All 0.13 (combination of the normal ConferenceRoom client
and a miniclient) ***
- listnow [true/false] (false) immediately ask for a room list on
making a connection to the server. If you know that a lot of rooms will be
shown, you may want to turn this off as it will cause a delay for the user
to get into chat
- showconnectbutton [true/false] (true) show a connect/quit button
on the login screen
- loadmodules, loadmodules1, ... loadmodules9 *Updated* allow
multiple loadmodule lines to be specified
-
*** New in CR All 1.0 (combination of the normal ConferenceRoom client
and a miniclient) ***
- autolist [true/false] (false) automatically request a rooms list
every [listtime] seconds. The [listnow] param can still force an initial
list, even with autolist set false
- shownicknames [true/false] (true) show nicknames when people are
speaking
- Colors available to guicolors params
- actionColor (red)
- systemColor (orange)
- noticeColor (red)
- joinColor (green)
- quitColor (joinColor)
- kickColor (magenta)
- urlColor (blue)
- privateColor (gray)
- talkColor (black)
- youColor (black)
- soundColor (cyan)
- errorColor (red)
- operColor (blue)
- voiceColor (green)
- uopColor (teal)
- titleColor (lightGray)
- titleTextColor (black)
- sessionColor
- sessionTextColor
- messageColor
- messageTextColor
- tickerColor
- tickerTextColor
- tickerTextHiColor (urlColor)
- selectColor (lightGray)
- roomsColor (blue)
- usersColor (talkColor)
- buttonColor (darkGray)
- buttonDisabledColor (lightGray)
- inputColor = (white)
- inputTextColor (black)
- nickInputColor (white)
- nickInputTextColor (black)
- usersBackgroundColor
- historyBackgroundColor
- roomsBackgroundColor
- Tickers and Newsflashes
- The Java client features a tickertape that runs along the bottom of the
applet. You can feed the ticker using the ticker params, files
specified using the tickerfeed params, and using NewsFlashes once the
client is running. NewsFlashes can be sent by server administrators only,
using the /nflash [ticker line] command. The format of the
ticker params, the lines in the files specified by tickerfeed
params, and the /nflash lines are all the same.
- The format of the ticker lines is:
[<a [tag1=value1]
[tag2=value2]...>]Ticker Text[</a>]
The HTML tags are
optional, you can just provide the Ticker Text part.
- Available tags (with defaults in parentheses) are:
- reconnect [time] For tickerfeeds, time to wait before reloading
file. If not provided, the file will be loaded only once
- id [message id] If you want to reference the message again
later, provide an id for it
- topic [topic name] Tickers can optionally be categorized by
topic
- href [url] If you want to provide a URL to jump to if clicked
- target [windowname] ("newsflash") Name the window to open the
clicked URL in
- speed [time] (tickerspeed param) Sets how fast the ticker
scrolls
- pause [time] (tickerpause param) Sets how long the ticker
pauses when scrolled all the way over
- lifetime [time] (tickerlifetime param) Sets how long the ticker
remains active in real time
- repeat [count] (tickerrepeat param) Sets how many times the
ticker is shown before it expires
- remove [true/false] If set true and a valid id is provided,
removes the ticker from the queue
- urgent [true/false] If set true, the ticker is shown
immediately and not simply queued up
- img src [image URL] Set an image to use inside the ticker. The
image replaces "%i" in the ticker text
- Time Specifications
Times in the ticker tags are specified by default
in milliseconds. You can also specify them in seconds and minutes, using the
number, and appending either a s or m afterwards.
For
example:
5 minutes = 5m
20 seconds = 20s
- Example Ticker lines:
ticker=<a id=123
href=http://www.webmaster.com/update.htm repeat=5 lifetime=10m>Updates
available at WebMaster.com</a>
ticker4=<a id=ws1999
href=http://home.webmaster.com/sports/ urgent=true>Yankees Win the 1999
World Series</a>
ticker7=This is just a basic ticker, with no click
url
Public Methods Available to Javascript
- output(String str) send a string to the server, filtered through
the output parser
- room(String room) join a new room
- sound(String sound, String message) send a sound and message to
current room
sound(String sound, String target, String message) send
a sound and message to a specific target nick
- doChat() show the chat view
- doRooms() show the rooms view
- doSession() show the options view
- doFloat() float the interface
- doEmbed() embed the interface in the web page if floating
- doShow(String name) show the named view (a room, a private message
window, etc.)
- getCurrentRoom() get current active room if being viewed
- getCurrentRoomTopic() get current active room's topic if being
viewed
-
*** New in 1.9.34 ***
- getCurrentTarget() get current active window (either a room or
private message) if being viewed
-
*** New in 1.9.39 ***
- getSelectedUser() get currently selected nickname (if any)
- getSelectedUserRealName() get currently selected nickname's Real
Name (if any)
-
*** New in 1.9.46 ***
- nick() get current nick
-
*** New in 1.9.48 ***
- insert(String text) inserts text into the input bar of the active
window
-
*** New in 1.9.55 ***
- addTickerTopic(String topic) adds a topic to the accepted newsflash
topics list
- removeTickerTopic(String topic) removes a topic from the accepted
newsflash topics list
- getTickerTopics() returns a list of newsflash topics being accepted
by the ticker, comma-separated