The Kava Telnet Application

Configuration

The configuration file for the KTA controls which plugins it loads and what properties are set per plugin. It uses the standard Java™ Properties file format - a hash (#) indicates the start of a comment, and each line is a key/value pair assigned by an equality sign (=).

A config file that will create a basic terminal window connecting via telnet will look similar to this:

# General settings
plugins = Socket,Telnet,Terminal
pluginPath = de.mud.jta.plugin
layout.Terminal = Center
Help.url = http://www.example.com/help/
Socket.host = telnet.example.com
Socket.port = 23

To specify a config file for the KTA to use, the -config parameter must be specified when the KTA is started. As an application, the command is:

java -jar jta.jar -config myconfig.cfg

Or in an applet:

As a developer, you can read properties from the configuration file by registering as a ConfigurationListener and parsing the PluginConfig object that is passed into the listener function from the bus.

General Settings

plugins

This is a comma-delimited list of the class names of the plugins to use. For more informations on specific plugins, read this page. For example:

# Use SSH plugin for an SSH connection
plugins = Socket,SSH,Terminal

Note: this setting is REQUIRED.

pluginPath

This is the classpath the KTA will use to look for the plugins. The default for built-in plugins is de.mud.jta.plugin, but additional paths can be appended for adding custom components:

pluginPath = de.mud.jta.plugin:com.mirrabooka.ttc.io

Note: this setting is REQUIRED.

layout.X

The layout type to use for graphical plugin X. Unless using a secondary window, all the graphical plugins will be arranged in one of the cells of a Swing BorderLayout - North, East, South, West or Center:

layout.Terminal = Center
layout.Status = South

Note: this setting is REQUIRED for graphical plugins.

Help.url

The URL to load when the user opens the Help | About menu.

General Applet Settings

Socket.host

The host to connect to (IP address or hostname). By default this will either be the Applet server, or localhost.

Socket.port

The port to connect to. By default this will be 23 if the Telnet plugin is being used or 22 if the SSH or SecondaryWindowSSH plugin is being used.

Applet.detach

True/false to detach from the webpage. Default is false.

Applet.detach.fullscreen

True/false to go fullscreen. Default is false.

Applet.detach.immediately

True/false to detach immediately. Default is false.

Applet.detach.menuBar

True/false to add a menu bar to the detached window. Default is true.

Applet.detach.startText

The text used to start up the applet. Default is "Connect".

Applet.detach.startText

The text used to shut down the applet. Default is "Disconnect".

Applet.connect

True/false to connect on startup. Default is false.

Applet.disconnect

True/false to disconnect on leaving. Default is true.

Applet.disconnect.closeWindow

True/false to close the detached window on disconnect. Default is true.

Applet.Netscape.privilege

Comma-delimited list of Netscape privileges to ask for. For example:

Applet.Netscape.privilege = UniversalConnect,UniversalPrintJobAccess

ButtonBar Settings

ButtonBar.setup

The URL containing the button bar config file (see de/mud/jta/plugin/ButtonBar.java in the source code for an example).

ButtonBar.clearFields

True/false to clear textfields on enter key. Default is true.

Capture Settings

Capture.file.url

The URL specifying the page to post to.

Capture.file.url.params

The URL specifying the parameters to the page.

Capture.X.url

The URL specifying the page to post to, with the ID of X. X must be an integer starting from 1.

Capture.X.url.params

The URL specifying the parameters to the page with the ID of X. X must be an integer starting from 1.

Capture.X.url.name

The user-readable name for the page with the ID of X. X must be an integer starting from 1.

LocalProcess Settings

LocalProcess.dir

The working directory from which the process will be run.

LocalProcess.executable

The process to run.

MudConnector Settings

MudConnector.listURL

The URL containing the MUD list file. (see http://www.mudconnector.com/ for examples).

MudConnector.step

Unknown option. Default is 10.

Terminal Settings

Terminal.foreground

An HTML color code indicating the foreground/font color. Default is "#ffffff".

Terminal.background

An HTML color code indicating the background color. Default is "#000000".

Terminal.cursor.foreground

An HTML color code indicating the foreground/font color of the cursor. Default is "#000000".

Terminal.cursor.background

An HTML color code indicating the background color of the cursor. Default is "#ffffff".

Terminal.print.color

True/false to print in color or black-and-white. Default is false.

Terminal.border

The width of the border in pixels. Default is 2.

Terminal.borderRaised

True/false to indicate a raised border. Default is false.

Terminal.colorSet

The URL containing the color substitution config file (see de/mud/terminal/colorSet.conf in the source code for an example).

Terminal.scrollBar

The layout of the scrollbar - West or East. Default is "West".

Terminal.id

The terminal identification string. Default is "vt320".

Terminal.buffer

The number of lines in the scrollback buffer. Default is 100.

Terminal.size

A coordinate indicating the width and height of the terminal in characters. Default is "[80,24]".

Terminal.resize

Whether a resizing of the terminal should alter the font or screen size. Options are font, screen or none. Default is "font".

Terminal.font

The font to use in the terminal. Default is "Monospaced".

Terminal.fontStyle

The font style to use in the terminal. Options are plain, bold, italic or bold+italic. Default is "plain".

Terminal.fontSize

The font size in points. Default is 11.

Terminal.keyCodes

The URL containing the key code mapping file (see de/mud/terminal/keyCodes.conf in the source code for an example).

Terminal.VMS

True/false to set VMS-style emulation. Default is false.

Terminal.IBM

True/false to set IBM charset that some BBSes use. Default is false.

Terminal.encoding

The character encoding. The default for this should be ISO8859_1, but for some reason that doesn't work as it should so the default is now latin1.

Terminal.beep

The URL containing a WAV file to play when the terminal makes its default beep.

Timeout Settings

Timeout.seconds

The number of seconds to wait before timing out. Default is 60.

Timeout.command

The command to execute on timeout. Default is "exit".

Script Settings

Script.script

A bar-delimited list of expect/response pairs in the script. For example:

Script.script = login:|john|password:|smith

SecondaryWindowLogin

SecondaryWindowLogin.login

The login prompt to wait for. Default is "ogin:".

SecondaryWindowLogin.password

The password prompt to wait for. Default is "assword:".

SecondaryWindowLogin.incorrect

The login incorrect prompt to wait for. Default is "ogin incorrect".

SecondaryWindowLogin.loggedin

The logged in prompt to wait for.

SecondaryWindowLogin.error

The error prompt to wait for.

Shell Settings

Shell.command

The command to run. Default is "/bin/sh".

Socket Settings

Socket.relay

If set to anything other than null, activates relaying.

Socket.relayPort

The port on the Applet server to relay through to get to the real server. Default is 31415.

SSH Settings

SSH.user

The username for SSH autologin.

SSH.password

The password for SSH autologin. Note that anyone who can access the config file will be able to read the password in plain text.

Status Settings

Status.info

The URL containing the info to display on the status bar.

Status.font

The font to use on the status bar.

Status.fontStyle

The font style to use on the status bar. Options are plain, bold, italic or bold+italic.

Status.fontSize

The font size in points.

Status.foreground

An HTML color code indicating the foreground/font color.

Status.background

An HTML color code indicating the background color.

Status.interval

The sleep interval for stepping through status info lines.

URLFilter Settings

URLFilter.protocols

A comma-delimited list of protocols to listen for. Default is "http,ftp,gopher,file".