---------------------------------------------
L-Fire CTF Version 0.85a - Release June 14, 1998
---------------------------------------------

----
Info
----
L-Fire CTF is a modification to ID's official Threewave CTF.  

You can visit the L-Fire CTF web site at http://yyz.com/LFire or email to
quake2@yyz.com.


-------------------
Configuration Files
-------------------
The following files are needed by L-Fire CTF:
BANNED.CFG     - List of IP addresses to ban.
                 See instructions inside the file.
SHUTUP.CFG     - List of players that are not allowed to chat.
                 See instructions inside the file.
LHELP.TXT      - This file is displayed when the LHELP command is issued.
MOTD.TXT       - Message of the day.
                 See instructions inside the file.


---------------
Highscore Files
---------------
The highscore files are stored in the Scores directory.  There should be a
score file for each level with the file being named after the level with
a ".txt" extension.  For example, the score file for McKinley Revival
is "q2ctf1.txt" and the Outlands is "q2ctf4.txt".  The blank score files for
the 5 ID CTF levels are already provided for you, and a "Scores.txt" is
provided as a blank template for new levels - or if you want to clear
the highscores.  Do not edit the highscore files by hand unless you're
sure you know what you're doing.  The lines in the highscore files
are in a specific order, and comments within the files are not supported.


-----------------------
Highscore Configuration
-----------------------
So that the highscore lists make sense, make sure you set the fraglimit to 0,
and set a timelimt of something like 30 minutes.  Also, set a capturelimit
so you don't have teams getting 30 captures in the middle of the night so
they can get outrageous highscores.


-----------------------
Configuration Directory
-----------------------
The configuration files are by default stored in the directory
Quake2/CTF/LFireCfg and the highscore files are stored in
Quake2/CTF/LFireCfg/Scores.  The root configuration directory "LFireCfg"
can be changed through the "configdir" cvar.  If you want to run more than
one L-Fire CTF server on the same machine, then the "configdir" cvar needs
to be different for each server.  For example, changing "configdir" in your
server.cfg file to "SecondCfg" would change the config and highscore
pathnames to Quake2/CTF/SecondCfg and Quake2/CTF/SecondCfg/Scores,
respectively.

---------------------
Configuration Options
---------------------
Here's a list of cvars and what they do:

configdir      - specifies the configuration directory (default LFireCfg)
weaponflags    - controls weapon banning and quick weapon switching
antispam       - spam detection
teambalance    - team balance messages
highscores     - highscore saving and display
spawnprotect   - number of seconds invulnerable after respawning
vwep           - visible weapons mod
vweprestrict   - model restriction to male, female, or cyborg
idledetect     - time in minutes a player will be considered idle and moved
                 to spectator
greennames     - makes player names appear in green in console messages

Changes to the configdir, highscores, and vwep cvars only take effect
when the server is restarted.  All others can be changed on the fly.
By default, all of the options are turned ON, spawn protection is set
for two seconds, and idledetect is set to 15 minutes.
The default weaponflags will ban the BFG and turn on quick weapon switching.
Changing which weapons are banned only takes effect after a level change.
Changes to the quick weapon switching take effect immediately.

----------------
Weaponflags CVAR
----------------

WF_QUICK_SWITCH         1
WF_BAN_SHOTGUN          2
WF_BAN_SUPERSHOTGUN     4
WF_BAN_MACHINEGUN       8
WF_BAN_CHAINGUN         16
WF_BAN_GRENADELAUNCHER  32
WF_BAN_ROCKETLAUNCHER   64
WF_BAN_HYPERBLASTER     128
WF_BAN_RAILGUN          256
WF_BAN_BFG              512

The weaponflags CVAR works like the dmflags cvar.  For each flag you want to
set, you add the value to the weaponflags value.

The default weaponflags is set as 513, which is WF_QUICK_SWITCH and
WF_BAN_BFG to activate quick weapon switching and ban the BFG.


------------
Known Issues
------------

Highscore List Size
-------------------
The highscore list holds 15 players, which is just about the maximum you can
fit on the screen for most users; however, the list may be too big in 
terms of number of characters of text.  In some cases, players with bad
connections can overflow when the highscore list is displayed.
I'm planning to make the highscore list have less text to avoid
overflow problems.

Occasional Non-Reconnect
------------------------
It happens very infrequently, but every once in a while, a player will not
automatically reconnect when the server changes levels.  Instead, he's left
staring at the Quake console.  The player can simply reconnect with a
"connect <IP>".  I'm trying to figure out why this happens.

Idle Detection 
--------------
The idle detection feature is sometimes missing idle players.  Also, when a
player is detected as idle and is moved to spectator, the player may overflow.


---------------------
Copyright/Permissions
---------------------

This mod is copyright (c) 1998, Kai Kenner.
This mod was created solely for my own use, so it is distributed AS IS.
You may distribute this archive so long as this readme.txt file and all other
files are distributed together.

You may only distribute this mod and archive for free.

