Loki's Minions Capture the Flag 3.0
-----------------------------------

CLIENT INSTRUCTIONS:
--------------------

Unpack this zip file (if you use pkunzip, do it with a "-d") into your 
Quake 2 directory.  You are now ready to play!

If you have Gamespy, run it, then select from the menus "View->Custom Tab->Import".
Browse to your Quake2/lmctf directory and select "LM CTF.qst".  You now have a custom
tab to help you find LM CTF servers!


PLAYING A GAME:
---------------

The easiest way to play a game is to run Gamespy, tell it to update all servers, and
then click on your "LMCTF" game tab to find LMCTF servers.

If you already know the IP (internet protocol) address of the machine you want to
play on, simply run Quake2, and pull down the console.  Then type:

connect <server address>

Quake2 will know how to switch you to playing LMCTF.


HELP! I'M IN THE GAME!
----------------------

Players will automatically be assigned to either the red team or blue
team upon entering the game.  The action starts right away!  If you 
have forgotten how to play, and need some help, use the LMCTF menu
system to guide you.  From the console, type:

	ctfmenu

and a menu will appear.  From there, navigate the entries as you would
navigate your inventory, by using the inventory next, inventory previous,
and inventory use buttons.  If you don't have them bound to keys already,
try binding these:

	bind [ "invprev"
	bind ] "invnext"
	bind enter "invuse"

You can always exit a menu by hitting escape.

I highly recommend binding your "ctfmenu" to a key, such as "backspace".

From the main menu, you can switch to observer, change yours skin (and gender),
or switch teams.

Under the help menu, you can learn how to play, what the commands are, or
what your radio sounds are.



HEAD'S UP DISPLAY (HUD)
-----------------------

You will see a few changes to your display right away.

If you look directly at another player, you will notice a name appear in the lower left
hand corner of your screen.  This is the name of the player you are looking at.  If the
player's name is in GREEN, then they are a teammate.  If the name is in WHITE, then
they are are not on your team.

In the top right corner, you will see a picture and a number.  The number is your
current individual player score, and the picture is a portrait of you.  This is 
useful for telling what team you are on, and what you look like, so your friends can
recognise you ("Hey!  I'm the bald guy in red!").  Also, if you have the enemy flag, 
this icon will change to display a picture of a man holding a flag.

Lower down on the right side of the screen are two more pictures and two more numbers.
These correspond to the red team's flag status and score, and the blue team's flag
status and score.  When a team's flag is at home and safe, the team logo appears next
to the team score.  When the flag is stolen, this picture changes to look like an enemy
player carrying away your flag.  If the enemy flag carrier has dropped the flag and your
flag is lying around waiting to be returned, the icon changes to look like a tilted flag
that just lies there.

Right above these scores is a spot which will display a special icon if you pick up
a Strogg Artifact.  These Artifacts (Haste, Damage, Resistance, and Regeneration) give
their keeper special abilities.  You may only pick up one Artifact at a time, and so long
as you hold one, a picture of the Artifact will appear on your HUD.



CHANGING YOUR SKIN
------------------

If you look in the upper right corner of the screen, you will see a small portrait
of yourself.  If the person is wearing red clothes, you are on the red team.  Blue
clothes designate a member of the blue team.  Each team has 3 male and 2 female 
"skins" to choose from.

To choose a new skin, or change your gender, type "ctfmenu" on the console.  Then 
move down the menu items and select "Change Skin".  You will now be in a menu that
displays a list of skins.  Select the one you want, and you will see your portrait
in the upper left change to correspond to your new skin.  When you are happy with your
choice, hit escape to exit the menu.


CHANGING TEAMS
--------------

You can change teams either by selecting "Change Team" from the "ctfmenu", or
by typing a team command designating which team you want to be on.  For example,
to change to the red team, type:

	team red

or change to the blue team by typing:

	team blue


OBSERVER MODE
-------------

Using the "ctfmenu", you can select to "Become Observer".  This will turn you into a 
disembodied ghost which other players cannot see.  In this mode, you are part of neither
red team nor blue team, and can only watch the game, not play it.  You can fly through
walls and watch all the action of a game without interrupting the players.  As an
observer, if you select "ctfmenu" again, you can "Play CTF", which will automatically
drop you onto the team that needs you most.

To toggle observer mode from the console (skipping the menus), merely type:

	observe

and you will become an observer if you are not one, or join the game if you are already
observing.


CHASE CAM
---------

As an observer, you can choose to view the game action from a "chase camera", like 
those that are mounted on cars in the Indy 500.  You can only jump to chase cam mode
if you are already an observer (see above on how to become an observer).

To start your chase cam, type "ctfmenu" on the console, then select "chasecam" from the
observer menu list.  Or, merely type "chasecam" on the console to toggle the chasecam on
and off.

To switch who you are following, hit your weapon fire key or button.  You will cycle
to the next player.


TEAM RADIO
----------

You can communicate with your teammates using sounds through the use of a "radio".
Your radio lets you call out to all teammates such vital information as base status,
or whether offense is ready for it's next offensive.

To send a radio sound, type:

	play_team <sound>

where possible sounds include things such as, "clear", "status", "roger", and "defense".
For a full list of the sounds you can use, type:

	radiomenu

This will pop up a menu listing all the possible radio sounds that come with LMCTF.  You
can also use this menut to actually play sounds, by selecting a sound in the menu.

Players can only play one radio sound per second -- this is to prevent players from
abusing the radio.  If you decide you are tired of hearing other people go on and on
over your radio, you can turn your radio off by typing:

	radio 0

While the radio is off, you cannot send radio sounds to others.  To turn it back on 
again, type:

	radio 1



MAKING YOUR OWN RADIO SOUNDS
----------------------------

If you and your clan want to add radio sounds, it is quite simple.  First, create both
a male and female version of the sound you want to shout.  For example, if your sound
was "Get outta my way!", you would create two files, and name them:

	fem_outta.wav
	male_outta.wav

Make sure that the sounds are prefaced with "fem_" and "male_".  Also make sure the sounds
are Windows PCM .wav files of no more than 22 kHz.

Next, place these sounds in a "sound/radio" subdirectory of LMCTF, or place them in a pak
file with this directory in it.

Lastly, distribute this pak file (or .wav files) to your friends.  Anyone who doesn't have
it won't hear anything, and will just get a minor console error.


OFFHAND GRAPPLING HOOK
----------------------

Capture the Flag contains a grappling hook weapon that is not in standard Quake 2.  Many
are already familiar with it:  you fire the weapon, and a hook and cable shoot out.  If 
you hold down the fire key, it continues to fly away until it hits a surface, and reels
you in.

LMCTF contains an enhancement to the grappling hook, whereby if the server enables an
option, players can fire their grappling hook without having to switch to the grappling
hook weapon first.  This makes for interesting new gameplay in LMCTF, where players 
continue to fire weapons even when grappling across room.

If the LMCTF server you connect to supports this feature, known as the OFFHAND grapple,
you can bind a key as follows:

	bind space +hook

Now, for as long as you hold down the spacebar, you will grapple as if you had the grapple
weapon in hand and were holding down the fire key.

If the server you are on DOES NOT support OFFHAND grapple, then this key will merely
switch you to the grapple weapon.  This means you no longer have to worry about binding
a DIFFERENT key for the grappling hook when playing on OFFHAND supportted servers.


AUTOTEXT
--------

Autotext is a system of automatic text replacement.  Anytime you talk to someone using
say or say_team, the autotext system will automatically replace special character 
sequences with meaningful text.  Here is a list of supported autotext sequences:

%l  -- your current location
%a  -- your current armor amount
%h  -- your current health
%t  -- your currently carried artifact
%w  -- your currently equipped weapon
%n  -- your team name
%p  -- detailed position of where you are


So, if someone typed on their console:

> I am %l with %h carrying %t!  Meet me here!

It would be displayed as:

LM_Jormungard: I am at the red flag with 90 health carrying the Damage Artifact! Meet
me here!



FAQ
---

Q: I pop up the CTF menu, but I can't move in the menu using the arrow keys.  Why?

A: Due to the way Quake 2 is written, CTF can't detect arrow keys.  Instead, it wants you
to use the same keys you use to move around in your inventory list and select inventory
items.  If you don't have these keys bound, bind keys for "invnext", "invprev", and 
"invuse".



Q: Every time I try to change maps by typing "map base2", the game switches to "base2",
then restarts my maplist.  How do I stop this?

A: Two solutions.  First, try typing "gamemap base2" instead.  "gamemap" is a friendlier
command that doesn't restart the server every time.  A second solution is to rename the
"maplist.txt" file to something else so the server can't find it.  It will then let you 
change to whatever level you like anytime.


Q: How do I drop artifacts or the flag? Can I drop ammo?

A: Type "drop artifacts" or "drop flag".  You can drop ammo for your currently selected
weapon by typing "drop ammo".  Or you can "drop bullets", "drop rockets", or 
"drop grenades".


Q: "Can't find map 'q2ctf1'"  How do I play with id's Q2CTF maps?

A: Copy the "pak0.pak" file from your "Quake2/ctf" directory into your "Quake2/lmctf"
directory.  You are now ready to play.


Q: I can play the game, put other players don't seem to be carrying weapons, or they
look like they are wearing giant white diapers.  What is wrong?

A: You need to install "VWEAP", the visual weapons pak.  This is a pak used by many 
mods, and should be downloaded into your Quake2/baseq2 directory.  To find out how to
get the "VWEAP" pak, go to the LMCTF web page at:  http://www.planetquake.com/lmctf/




COMMAND LIST
------------

Commands you can use during the game:

	team <red/blue>
	id
		-- Centerprints the name of the player in front of you
	ctfhelp
		-- Gives a summary of commands
	flagstatus
		-- Tells you what has happened to the flag
	position
		-- Tells you your [x,y,z] coordinates, your
		   facing, and a text description of where
		   you are in the map.  Especially useful
		   for mapmakers
	
	ctfmenu
		-- Invoke the main CTF menu
	radiomenu
		-- Invoke the radio sounds menu
	radio <1/0>
		-- Turn on or off your radio
	observe
		-- Toggle observer mode
	chasecam
		-- Toggle chasecam mode (only works if you are already an observer)
	+hook
	-hook
		-- Use these commands in combination to use the "offhand"
		   grappling hook.  The "offhand" hook is a server side
		   option whereby the player doesn't have to switch weapons
		   to use the grappling hook.  If the offhand hook is disabled,
		   these command will merely select your hook weapon.



CREDITS
-------

Creator and Lead Programmer:  	Mike "LM_Jormungard" Scandizzo
Additional Programming:		Doug "LM_Surt" McCreary
Lead Artist:			Brad "Stupidsh!t" Klann
Additional Art:			Mike "LM_Jormungard" Scandizzo
Map Textures:			John "Der Kommissar" Staats
				John "Mr. White" Keffer
				Brad "Stupidsh!t" Klann
Sounds:				John "Mr. White" Keffer
				Brad "Stupidsh!t" Klann
New Models:			Jacob "Goose" Jaeggli
				Wicked
Env Artwork:			John "Der Kommissar" Staats
				Stecki
Maps:				Keith "Vampire" Mercer
				John "Mr. White" Keffer
				John "Der Kommissar" Staats
				DHeise ("ZugZug")
				Mark Major
				Suicide20
id Map Conversion:		Doug "LM_Surt" McCreary
Public Relations:		Wanker
				John "Der Kommissar" Staats
Web Page Design:		Brad "Stupidsh!t" Klann
Additional Contributions:	Fear-Berrys
				Kevin L. Kitchens
				ChronoKid
				Stephen "Lament" Maloney
VWEAP models and code:		Hentai

A special thanks to Clan Loki's Minions for their assistance in testing,
to id Software for the source code used to make this mod, and to Zoid for
helping me out with tracking down some nasty bugs.
				

Visit our web page at:

http://www.planetquake.com/lmctf/
	or
http://www.captured.com/lmctf/