//////////////////////////////////
lOkO Q2 beta 0.13 - December 2004
//////////////////////////////////

lOkO QuikStart
--------------
This document covers a subset of the configuration options for the lOkO mod,
read the LOKOMANUAL.txt document for complete details.


Installation
------------
Unzip the zip archive into your Quake2 directory, preserving the directory
structure in the archive; two directories are created in the Quake2 directory,
loko and lokonav.

You need to copy the ctf pak file to either the loko game directory or 
the quake2\baseq2 directory if you haven't already done so.

To Play Capture the flag you need player skin files named ctf_r.pcx,
ctf_r_i.pcx, ctf_b.pcx and ctf_b_i.pcx for each player model you wish to
use. Extract these files for the male and female player models from the 
ctf pak file into the quake2\baseq2\male and quake2\baseq2\female 
directories to show these models on the add bot menu when playing CTF.

Starting the Game
-----------------

Start a deathmatch game:

	quake2 +set game loko +set deathmatch 1 +set ctf 0 

Start a Capture the Flag game:

	quake2 +set game loko +set deathmatch 1 +set ctf 1 


NOTE: If you run the lOkO dll with the Quake2 Evolved engine:

	version .23 : add '+set game_engine 2' the command line

	version .26b or .26c: add '+set game_engine 3' the command line

	greater than version .26c: no need to set game_engine, defaults to 0

The svstatus Command
--------------------
There are tons of server cvars that are used to configure the lOkO bot, even 
I can't remember them all, so I added the svstatus command which displays almost 
all of the server cvar names and their current values.


Adding Bots
-----------
You must be the server operator to add bots.

Press F2 to run the add bot menu

OR

type "botmenu" at the console to run the add bot menu

OR

Add a deathmatch/ctf bot at the console:

	sv addbot [skill] [model/skin] [name]   

	sv addbot team [skill] [model/skin] [name]   

        skill is 1, 2, 3 or 4, 4 is the highest skill bot
        team is red or blue
	All items inside [] are optional and if unspecified the dll will
	select a random value for skill, model/skin and/or name



Configuring Available Weapon Fire Modes
---------------------------------------
You must be the server operator to set theses cvars:

        weapons_mode 0		only default Q2 fire modes

        weapons_mode 1		only napalm fire modes

        weapons_mode 2		all fire modes in "cost mode" (the default)

        weapons_mode 3		Arms for Heads: upgrade your weapons by picking
				up gibbed heads

        weapons_mode 4		the server operator chooses one firemode per
				weapon; RTFM ...

        weapons_mode 5		all fire modes in "low cost mode" 


Enable/Disable Monster Sidekicks
--------------------------------
  By default, deathmatch monsters are turned OFF by having the server cvar
monster_mode set to 0; set monster_mode to 1 to enable Monster Sidekicks.
It is strongly recommended to set the server cvar no_target_speaker to 1
when enabling any deathmatch monsters to prevent sound index overflow; when
no_target_speaker is set to 1 target_speaker entities on the map don't spawn
and their sounds are never loaded. These are both 'latched' cvars that won't 
take effect until the level is changed. See the lOkO manual for info on 
changing the costs of monster sidekicks and other commands to spawn deathmatch 
monsters.


Server Spawned Deathmatch Monsters
----------------------------------
  The server cvar monster_mode also controls if server spawned monsters are 
allowed in the game.

	monster_mode 2		monster fight for a CTF team

	monster_mode 3		monsters can be killed, re-spawning in 20 seconds

	monster_mode 4		monsters are immortal

   CTF monsters are spawned by the ctfmonster server command or loaded in a
team monster file (.tmo); the other server spawned monsters are spawned by the 
spawnitem server command or loaded from monster files (.mon). see the 
LOKOMANUAL.txt file for more info.


Other Server Options
--------------------
These server cvars are set to 1 to enable, 0 to disable: all are 
enabled by default.

	drop_backpacks   players drop packs full of the weapons and ammo
			 when fragged

	pro_rocket	 rocket speed, damage and blast radius more like Classic 
			 Quake and weapon switching speed doubled

	location_damage	 the railgun and beratta blaster do more/less damage 
			 depending upon the location on the victim the shot hits

	sticky_grapple	 the ctf grapple hook sticks to players


These server cvars are set to 1 to enable, 0 to disable: all are 
DISABLED by default.

	start_jetpack	all players start with the jetpack; the jetpack
			tech does not spawn.

	start_voodoo	all players can re-animate gibbed heads; the voodoo tech
			does not spawn.

	start_haste	all players have the abilities of the haste tech
			(double fire rate of weapons); the haste tech does
			not spawn.
	
	start_vampire	all players have the abilities of the vampire tech
			(damage dealt increases health); the vampire tech does
			not spawn.

	no_footsteps	turns off footstep sounds for all players

	save_bots	bots respawn when the level changes

	game_tag	play a game of tag; the player with the tag tech is "it",
			gets 666 health, all weapons, ammo capacity increased,
			full ammo and 5 frag points for each frag; killing "it"
			gets you 20 frag points.


Other server cvars and their default values:

	respawn_safety	the number of seconds of invinciblity players get when
			entering the game or respawning; players cannot shoot
			weapons during this time.
			Default value: 3.0

There are tons of other server cvars, read the manual...

Monster Sidekick Client Commands
--------------------------------

	Command		Monster Created		Default Ammo Cost
	----------	---------------		-----------------
	sidekick 1	soldier			75 shells

	sidekick 2	infantry		150 bullets

	sidekick 3	gunner			75 grenades

	sidekick 4	chick			75 rockets

	sidekick 5	tank			40 slugs

	sidekick 6	gladiator		150 cells
	
           Run the command at the console or bind keys as desired ie. 

              bind i "sidekick 2"

           Pressing the i key will spawn an infantry monster at your location.


	bestsidekick ###### 

The bestsidekick command takes a number argument of up to six digits, 
specifying the order of preference of sidekicks, each digit
corresponding to the number argument you'd use to specify the sidekick 
to spawn with the sidekick command. The digits are tested from left to right; 
the leftmost digit specified is tested first; if you have enough ammo in your 
inventory then that monster sidekick is spawned, if not then the second digit
from the left is tested, etc

Run the command at the console or bind keys as desired ie. 

	bind z "bestsidekick 534126"

Pressing the z key will first test if you have enough slugs to spawn a tank (5), 
then enough grenades to spawn a gunner (3), then enouch rockets to spawn a 
chick (4), etc. 

If you already have a monster sidekick and you issue the sidekick or 
bestsidekick command your monster sidekick will attempt to teleport to
your location.


Changing to Alternate Firemodes
-------------------------------
Repeatedly pressing the key associated with using a weapon will cycle thru
all the available firemodes for a weapon, ie. pressing the '4' key will cycle
thru all the machinegun firemodes.

Also, the 'cyclefiremode' command will cycle thru all the available firemodes
of your current weapon. Bind a key, ie. 'bind KP_PLUS "cyclefiremode"'



Bind Some Other Keys
--------------------
These aliases are built into the dll; bind a key to each:

	+jetpack	turns on/off jetpack thrust

	+hook		shoots/retracts the off-hand hook

	+ctfgrapple	pressing the key bound to this will switch weapons
			to the ctf grapple and fire it; releasing the key will
			unhook the ctf grapple and switch back to your last
			weapon


Bind these client commands to keys:

	laser		toggles the laser site on/off

	ammohud		toggles the ammo hud on/off

	nohud		toggles the entire hud on/off

	detpipe		detonates all pipe bombs you have placed

	scanner		toggles the radar scanner off/on

	tosshead	tosses a re-animated gibbed head in the air

	airstrike	launches an air strike

	ycam		toggles the ycam (3rd Person Perspective) on/off

        zoom 1		magnifies the player's view to three different
 			magnification levels

	cyclefiremode	cycles thru all available firemodes of your
			current active weapon.

	opendoor	opens doors when playing on Action Quake2 levels and the
			server cvar aq2_doors is set to 1


If you don't know how to bind a key, at the console type:

      bind <keyname> <command>

ie.   bind a "airstrike"

or    bind w "+hook"


Still More Commands...
----------------------

	killercam	when using the chase cam, toggles the behavior of the
			camera to follow the killer of the player you are
			watching when he/she gets fragged or keep following
			the fragged player when they respawn.

