Before You Begin
----------------
Before you begin the actual configuration of the robot, here are a few
things that you need to know. First, the robot compiles under Java JDK
1.2.1. If you are running a previous version, then you must get the latest
version from Sun. It is available at (http://java.sun.com/products/jdk/1.2/).

Secondly, MUDs, MOOs, etc. all run on, sometimes unspoken, rules of etiquette.
In many of these environments you must let the owners of the environment know
that you are running a robot. Some MUDs/MOOs, etc. do not allow just anyone
to run robots. Before you go any further check with your MUD owner to make
sure that running a robot is alright.

Finally, if you are not experienced in MUDs/MOOs, etc. please first spend some 
time in the environment learning it, before you set out to run a robot. Running
robots can be a difficult undertaking.

Configuring By Hand
-------------------
This section describes how to configure the robot by hand.

1. Unpack your robot.

1.1. If you have received the distribution as a tar file use the following
     command to unpack it:
	tar -xvf v3.6.2.jar

1.2. If you have received the distribution as a zip file use winzip or pkzip
     to unpack it.

2. Change to the directory where the distribution has been unpacked.

3. You should see a number of directories and files including:
	processes    -- directory where the robot processes reside.
	plugins      -- contains a variety of plugin files to modify the 
                        behavior of the robot.
	lib          -- contains the necessary JAR files to run the robot.
	mstar        -- contains the sources and binaries for the file 
                        mstar.jar. This is the low-level abstraction of the 
                        robot.
	util         -- contains sources and binaries for the file
                        util.jar.
	os           -- contains sources and binaries for the file os.jar. This 
                        is the code that makes up the operating system of the
                        robot.
	properties   -- contains example properties files for several different
                        types of robots.
	docs         -- contains documents about adding and changing the
                        functionality of the robot.
	INSTALLATION -- this file.

4. Copy the default.properties file from the properties directory to the 
   current directory and rename it to robot.properties. This is the vanilla
   properties file that you will use to configure your robot.

5. Edit the robot.properties file. You should see a file similar to this:

	########################################
	#
	# Foomud
	#
	########################################
	robot.name:		muddweller
	robot.description:	You see someone who lives in the mud.
	robot.host:		foomud.com
	robot.port:		4201
	robot.password:		somepasswordhere
	robot.mudType:		TinyMud

   The file is made up of two parts. The text to the left of the colon (:) are
   the property names that are used to configure the robot's attributes. The
   text to the right of the colon are the values that define attributes about
   the robot. The white space in between names and values can either be spaces,
   tabs or a combination of both. Lines that start with a hash mark (#) are
   comments.

5.1. If you have not already done so, you need to name your robot. This is a 
     very important step as the name frequently drives the personality of the 
     robot.  Whatever name you decide on, set the property robot.name to be the 
     name of the robot that you have chosen.

5.2. After you have decided on a name you need to create a description for the
     robot. Once again, this is a very important step that should be given some
     consideration. Once you have written the description of the robot set the
     robot.description to be the description you have chosen.

5.3. Set the hostname where the robot will log into. This is the host that the
     MUD/MOO etc. runs on.

5.4. Set the port of the MUD/MOO etc. For MUDs 4201 is typical, for LambdaMOOs
     7777 is the default. PennMush is also at 4201.

5.5. You will need to set the password for the robot next.

5.6. Save the file.

6. To start the robot type:

	tween
