                           ST Weapons Factory
                          Player Documentation
                              Version 2.3

ST Weapons Factory is a Quake2 modification by John Rittenhouse and the Reno Brothers.
Please visit http:/www.captured.com/weapons factory for information on how to connect
to a STWF server.

Installation
============
First, you will need to have the Q2 3.15 upgrade and Zoid's CTF modification.
You can get the full upgrade to 3.15:
(ftp://ftp.idsoftware.com/idstuff/quake2/q2-315-x86-full-ctf.exe)

Next, you will need to install the STWF files. Download the following:
http://asp.planetquake.com/dl/dl.asp?captured/weaponsfactory/wfclient22.zip

Unzip this file into your quake2\ctf directory. Note: This
will NOT interfere with playing other CTF games. These files are only used by
the ST Weapons Factory mod and will not replace any existing CTF files.

Many of the STWF servers will be running ST Weapons Factory maps. To play
these, download the STWF Maps zip file at:
http://asp.planetquake.com/dl/dl.asp?captured/weaponsfactory/stwfmaps5.zip

Unzip this into your quake2\ctf\maps directory. Or, visit the Maps section
and download the maps individually.

For those of you who want to set up your own server, you will
need to download the wfserver.zip file from the download section.

Connecting To A Server
======================
For a complete list of servers, click on the Server button on the STWF
Home Page. You can also use the STWF Gamespy Tab, or visit
the Planet Quake Server List at http://www.planetquake.com/servers
and look for server names with "(WF)" in them.

STARTING TO PLAY
================
The first thing you will need to do when entering a game is select a player
class.  Each of the six classes have advantages and disadvantages.

RECON
=====
Weapons:             Shotgun, Railgun, Sniper Riffle
Grenades:            Flare, Flash
Allowed Armor Types: Jacket
Max Armor:           50
Special Items:       Jetpack
Model:               Female

NURSE
=====
Weapons:             Infected Dart, Shotgun, Machine Gun, Needler
Grenades:            Normal, Concusion, Plague
Allowed Armor Types: Jacket, Combat
Max Armor:           125
Special Items:       None
Model:               Female

ENGINEER
========
Weapons:             Shotgun, Machine Gun, Armor Piercing Dart, Telsa Coil
Grenades:            Normal, Magnotron, Shock
Allowed Armor Types: Jacket
Max Armor:           200
Special Items:       Supply Depot, Jetpack, Alarms, Sentry Gun
Model:               Male

CYBORG
======
Weapons:             Shotgun, Grenade Launcher, Rocket Launcher,
                     Cluster Rocket, Lightning
Grenades:            Shrapnel, Laserball, Cluster
Allowed Armor Types: Jacket, Body, Combat
Max Armor:           200
Special Items:       Kamikaze, Plasma Bomb, Jetpack
Model:               Cyborg

MARINE
=====
Weapons:             Shotgun, Super Shotgun, Pulse Cannon, Chaingun,
                     Pellet Missile, Hyperblaster
Grenades:            Proximity, Goodyear, Turret
Allowed Armor Types: Jacket, Body
Max Armor:           300
Special Items:       Powershield, Alarms, Laser Defense
Model:               Male

ARSONIST
=====
Weapons:             Shotgun, Spontanious Human Combustion Riffle,
                     Flare Gun, Napalm Missile, Flamethrower
Grenades:            Normal, Napalm, Concussion
Allowed Armor Types: Jacket
Max Armor:           150
Special Items:       Earthquake
Model:               Cyborg


Binding Keys
=============
To get the most out of the game, you will want to bind a few
new keys. For help during the game, type "WFHELP"> at the console.
Here are some bind key examples:

   bind m cmd decoy
   bind b cmd grenade
   bind v +thrust
   bind n +rzoom
   bind i cmd grenade1
   bind o cmd grenade2
   bind p cmd grenade3
   bind . cmd grapple
   bind ; cmd special

With version 2.2, three keys are pre-bound for you. The "v" key for flying,
the "b" to select grenades, and the ";" key to bring up the "special" menu. Many
people have complained that the binding of keys is too complicated, so I've chosen
these three keys that are pre-bound for you, because these commands are critical
to playing the STWF mod.  So, the pre-bound keys are gone.  Instead, use
the WFHELP command to bring up the help menu, and select "Bind Keys Now"
to have STWF bind these three keys for you.


Homing Rockets
--------------
To use the homing rockets you will need 4 cells.
Homing is turned on by default, but if you bind a key to "cmd homing", you can turn the homing
feature on and off. Rockets without the homing on do twice the damage of rockets
that use homing.

Special Menu
------------
Use the ; key (or whatever is bound to the "cmd special" command) to open
the special menu for your class.  Many classes have special
capabilities that can be accessed through the menu.  For example, the engineer
can create sentry guns and supply depots this way.  The use of a menu reduces
the number of keys that need to be bound.

Off Hand Grapple
----------------
If you can't fly, try the off-hand grapple. When using this grapple, you
won't have to switch weapons.  To use it, bind a key to "cmd grapple" ("."
in above example).  Hit it once to extend it, hit it again to let go.

Sentry Gun
----------
As an engineer you can create one sentry gun through the special menu.
The sentry gun is a stationary gun that will automatically shoot at enemies.
When created, the sentry gun starts at level 1, which does the least damage
and fires the slowest.  You can upgrade the sentry gun to level 2 and three
through the special menu, which increases the rate of fire and the sensitivity
of the gun.

Decoys
------
Press your decoy key to turn on and off your decoy. Decoys are free.

Grenades
--------
Press your "b" key, or your grenade1, 2 or 3 key ("i","o" or "p"
in above example) to select what type of grenade will be thrown. Selecting
a grenade type will also select the grenade as your primary weapon and show
you the grenade view.

Jet Pack
--------
Holding down the thrust key will add thrust, letting go will turn it off.
You may notice when you try it the first time, holding it down does nothing.
That's because you also need to move forward at the same time. You also need
to look up or down to control where you go. I bind my right mouse
button to move forward, so to fly I hold down both the thrust key and my
mouse forward button. It may take a little getting used to.

Zoom In/Out
-----------
Holding down the zoom key ("n" in above example) will zoom in
your view while holding it down, and zoom out when you let go. NOTE:
The "+rzoom" command is actually an alias to the following commands:
    alias +rzoom "fov 30;+mlook"
    alias -rzoom "fov 90;-mlook"

If you prefer not to have your mlook settings changed, you should create
a different alias.

Map Voting
----------
If map voting is turned on in the server you are running, you can place a
vote for the next map at any time by typing "vote" in the console window.
The map with the highest number of votes will be chosen.  If no votes are
cast, the next map in the normal rotation will be selected.  A one minute warning
will be given to all players before the end of the round to remind them to vote.

Playing Sounds
--------------
You can play any available sound, and other players will be able to hear it.  Use
the "cmd wfplay" command to play the sounds.  Here are some examples to
get you started:
  cmd wfplay hello.wav
  cmd wfplay bless.wav
  cmd wfplay doh.wav
  cmd wfplay laugh2.wav
  cmd wfplay madhouse.wav
  cmd wfplay pickle.wav
  cmd wfplay planet.wav
  cmd wfplay reaper.wav

Don't forget, you can bind keys to your favorite sounds!

