
                =======================================
                   Lithium II Mod v1.02 for Quake II
                =======================================

By Matt "WhiteFang" Ayres (matt@lithium.com)
Available at www.planetquake.com/lithium

Lithium II is a very configurable server side deathmatch modification
for Quake II v3.14.  Clients do not need to download anything.

Main Features
----------------------------------------------------------------------------
   * All features are toggleable and configurable.  Use the ones you want.
   * Menu system for in-game remote administration and client settings.
   * Runes; strength, resist, regen, haste, and vampire.
   * Improved HUD with frags, frags/hr, players, your place, current rune.
   * Optional HUD that displays ammo counts.
   * Damage, speed, and radius adjustable for all weapons.
   * Obituaries with your enemy highlighted in green text.
   * Grappling hook (red laser style).
   * Faster respawning as more players join.
   * Configurable map queue with randomize option.
   * Customizable MOTD.
   * Observer fly-thru mode.
   * Chasecam to follow other players around (cam is client adjustable).
   * Player ID, to identify who you're looking at.
   * Safety time period for player spawns.
   * No camp option kills campers (default off).
   * Options to kick chat and kill flooders.
   * IP banning, also min and max ping requirements.
   * Adjust start/max values for health, ammos, and armor.  Also setup which
     weapons clients will start with.
   * Server configuration and toggles implemented as cvars.  This allows
     .cfg files for startup and instant changes on the server console.
   * Based on v3.14 game source, and compiled for Windows (gamex86.dll),
     Linux (gamei386.so) and Solaris (gamesparc.so).
   * VWep support, see which weapon your enemy is using!  (requires a pak).
   * GSLog frag logging (Gibstats Log Standard).


Installation
----------------------------------------------------------------------------
Create a "lithium" directory in your Quake II directory and copy the
included files there.  You can run either a dedicated server (console
only) or a listen server (where you can play on that machine as well).

To start the server, start a DOS prompt and change to your Quake II
directory.  For a dedicated server, use this command line:

   quake2.exe +set dedicated 1 +set game lithium +exec lithium.cfg

For a listen server, use this command line:

   quake2.exe +set deathmatch 1 +set game lithium +exec lithium.cfg

An analog modem is not an adequate connection to run a server.  To really
run a server, you need a partial or full T1 internet connection or better.


Configuration
----------------------------------------------------------------------------
If you'd like to alter the configuration, simply edit lithium.cfg.  Please
see config.txt for help.  When installing over an old version of Lithium II,
it is recommended that you use the new lithium.cfg and modify that.

A normal.cfg is provided, which contains the Quake II defaults to run a
plain vanilla server.  Note that if no .cfg file is specified on the command
line, the internal defaults will be used (lithium.cfg represents those).

Any of the commands you see in the .cfg files can be entered directly to
the server console.  The change will take effect immediately for any
setting, except the no_* variables (which will take effect next map).

Adjust the maxclients value accordingly in lithium.cfg.  You can modify
the MOTD to your liking by editing the motd.txt in the lithium directory.
Note that the deathmatch setting is implied for dedicated servers.

If you don't want your server listed publicly, set public 0 in lithium.cfg.


Administration
----------------------------------------------------------------------------
If you'd like to use the in-game remote administration feature, you'll
need to set the admin_code variable in lithium.cfg.  The default is 0,
which disables the feature.

In the game, to access the admin menu, simply type "admin" on the console.
You will be prompted for the admin_code.

Please note that numbers you type in the admin menus are detected by key
bindings.  If you've changed the binds for your number keys, you'll have a
problem.  Unfortunately this is the only way to detect those keys being
pressed in the game .dll code.


Playing
----------------------------------------------------------------------------
Clients require no special files to play on Lithium servers.  There is
nothing they need to download.  Simply connect and play.  That's the
beauty of server side mods.

Client commands:
   drop rune  Drop your current rune
   +scores    Quake 1 style scoreboard
   +hook      Grappling hook
   observe    Observer mode
   chase      Chasecam mode
   chaselist  List the clients chasing you
   bestweap   Toggle best weapon pickup
   id         Toggle player identity
   hud        Toggle Lithium/Ammo HUD
   menu       Lithium II main menu
   admin      Admin menu

It's recommended that you bind keys to "drop rune", +scores, and +hook.
For example, you'd type something like this on the console (or add to
your autoexec.cfg in your quake2\lithium directory):

   bind d "drop rune"
   bind tab +scores
   bind q +hook


Runes:
   Strength (Red)     You inflict 2x damage
   Resist   (Blue)    You take 1/2 damage
   Haste    (Yellow)  You fire twice as fast
   Regen    (Green)   Your health regenerates slowly
   Vampire  (Purple)  You gain health for damage inflicted


Future Features
----------------------------------------------------------------------------
No guarantees on anything or the order they'll be added!  I have many
things planned.  A few of them include:

   * Teamplay options
   * Competition modes
   * CTF II support
   * Eraser bots
   * Quick weapon switching option
   * FragTrak, comprehensive and compact frag tracking system


Notes
----------------------------------------------------------------------------
I appreciate feedback, bug reports, new ideas, and comments (good or bad).
I've been updating this server code in between working on Quake II map
editing support in Qoole (www.qoole.com).  I plan to continue working
on both, so watch for updates.  My email is matt@lithium.com.  Sorry if
I don't reply, as I get a lot of email, but know that I do read it all.

I'm on EFNet IRC as WhiteFang, you can find me in #Qoole, #Lithium, and
other Quake related channels.  If I don't respond to a private msg, I'm
either away or busy.  Don't be offended, but I will eventually read what
you sent.  I absorb all :-)  I simply can't respond to everything.

I'm running a Lithium Quake II Mod mailing list for discussion about this
mod and Quake II mods in general.  You can opt for daily digests of the
mail list now.  Also an announce list is available, for those of you only
interested in hearing about updates.  To subscribe, send an email with
"subscribe" in the message (not the subject), to the appropiate address:

   q2-request@lithium.com
   q2-digest-request@lithium.com
   q2-announce-request@lithium.com
