Animist Software - Waychat Applet Configuration

General

Note that all of the Waychat Applet parameters are optional. When no parameters are supplied the chat will look rather plain but should still function normally.

Image URLS

Some Applet parameters, such as for textures and banners, specify image URLs that are loaded by the Waychat Applet. Because of the Java Applet security model, these images can only be loaded from the server specified in the 'codebase' attribute of the <Applet> tag. Therefore any images that you want to use on a hosted server must be e-mailed to Animist Software.

Server Port

There is a "port" parameter that specifies which port the Waychat Server is running on. (The server hostname is determined from the Applet codebase.) Unless you are told otherwise, you can omit this parameter and the default Waychat Server port will be used.

Applet Style

The Waychat™ client is available in two applet 'styles', floating and embedded. When Waychat is 'floating' it is opened up in a separate, resizable window. When Waychat is 'embedded' it is embedded within the Web page. The "style" parameter determines the default style that is used when the applet starts up. Users are able to change the style while the applet is running unless you force the


	<Param name="style" value="floating">

	<Param name="style" value="floating_only">

	<Param name="style" value="embedded">

	<Param name="style" value="embedded_only">

Language

Waychat is available in English (the default) and Italian. The language is specified as a two-character ISO Language Code ('en' for English or 'it' for Italian.) Examples:


	<Param name="language" value="en">

	<Param name="language" value="it">

Textures

You can pick the image used for the main Waychat background and for the background of components (the output window and user/room lists.) These are specified by the "backgroundTexture" and "componentTexture" parameters, respectively. The values of these parameters are image URLs. Texture images should be small to keep load time short, and should be tileable. The component texture should be very bright and low-contrast so that it is easy to read the black text on top of it. Examples:


	<Param name="backgroundTexture" value="tile.gif">

	<Param name="componentTexture" value="background.jpg">

Banners

Multiple banners can be specified for the Waychat client. When the user logs in a banner is chosen at random from the Applet parameters, and is displayed for the duration of the chat.

For each banner there are two Applet parameters. The "banner" parameter provides the URL for the banner image, which may be any size, GIF or JPEG, but must come from the same server that the Waychat client comes from.

Example single-banner setup:


	<Param name="banner" value="banner.jpg">

	<Param name="bannerURL" value="http://www.waychat.com/">

Multiple banners follow a careful naming sequence, with sequential numbers appended to the end of the parameter names.

Example multiple-banner setup:


	<Param name="banner1" value="someplace_banner.jpg">

	<Param name="bannerURL1" value="http://www.someplace.com/">
	<Param name="banner2" value="yahoo_banner.jpg">

	<Param name="bannerURL2" value="http://www.yahoo.com/">

<Param name="banner3" value="animist_banner.jpg"> <Param name="bannerURL3" value="http://www.animist.com/">

Action Buttons

The list of action buttons is defined in a manner similar to banners. For each action button there is a "button#" parameter which has the label text and an "action#" parameter which provides the action (a command to execute or a Web page URL to open). In order to have a user say something use the '/say' command. Examples:


	<Param name="button1" value="Smile">

	<Param name="action1" value="/emote smiles happily.">
	<Param name="button2" value="Hello">

	<Param name="action2" value="/say Hello!">

<Param name="button3" value="Waychat.com"> <Param name="action3" value="http://www.waychat.com/">