Title    : ClanRing CRMod++ v5.0 Quake Competition Server
Filename : crmod50.zip
Version  : 5.0
Date     : March 14, 1999
Authors  : J.P. Grossman (a.k.a. Mephistopheles) and Paul Baker
Email    : jpg@ai.mit.edu, pbaker@mpog.com
URL      : http://www.mpog.com/clanring/crmod

This is a Quake1 NETQUAKE mod.  It does not work with Quakeworld.  Do not send
us email asking us to make a Quakeworld version; we're not going to.


What's new?
=======================================
The following changes are introduced by CRMod++ v5.0:

New Features (major)
------------
- Running commentary in observer modes
- Autopause: matches can be automatically paused when someone disconnects
- *Full* ghost restoration when match is paused (weapons, health, position, etc)
- 5 second countdown to match unpauses
- vastly improved auto-screenshot for dm3 match mode
- 'rockets' command shows which players have rockets (for observers only)
- 'badstats' command shows player blunders
- 'autostats' command dumps stats automatically after a match
- 'crban' administrator command allows banning of a single player
- 'nopractice' console command disables practice mode
- autokicks players who try to hack the admin code

New Features (minor)
------------
- 'help-stats' command lists stats commands
- added 'helpserver' alias for 'help-server'
- added 'ffa' alias for 'normal'
- background flash added to eyecam when player takes damage or gets health
- statistics are sorted by team
- quadstats includes number of quads for each team
- 'eff' abbreviation for 'efficiency' console command
- more intelligent client alivecheck pinging; only pings when necessary
- more careful color change checks
- added level changing commands to console (so 'dm3' = 'changelevel dm3')

Bug Fixes
---------
- fixed the freshspawn console command bug
- fixed the listen server timelimit/fraglimit etc. bug
- fixed the rare crash on disconnect bug
- fixed the even rarer double match start bug
- fixed timelimit 1 bug
- fixed pre-match touch trigger bug
- fixed the "observer steals mega health" bug
- fixed the "falling after discharge" bug
- fixed the "disconnect after gib" bug which prevented players from connecting
  to the server
- fixed the "bad teleport" bug in 'start' that could crash the server

Pausing Bug Fixes (*big* thanks to Izra'il and Molotov for catching these)
-----------------
- fixed double pause/double unpause bugs
- fixed pause after match end bug
- fixed item pickup on respawn during pause bug
- fixed backpack pause bug
- fixed paused missiles after aborted match bug
- fixed nailgun/lightning gun fire during pause bug
- fixed the "static player after joining paused match" bug

Description of Files
=======================================
readme.txt       - This file
manual.txt       - Clanring CRMod++ v5.0 user's manual
autoexec.cfg     - Server startup config file
crmod.cfg        - Config file used to set the administrator password
levels.cfg       - Config file used to set the level order
userdefs.cfg     - Config file used to set the MOTD and custom levels
progs.dat        - Quake program data file run by the server
crmake.exe       - Utility to add the userdefs to progs.dat (Win32 build)
crmake.linux     - Utility to add the userdefs to progs.dat (linux build)
entities\*.ent   - Optional entity files
cameras\*.cam    - Optional camera files

Setup and Installation
=======================================
1. Create a subdirectory in your Quake directory called 'crmod' or whatever
   else you feel like calling it.
   
2. Unzip the contents of crmod50.zip into this new subdirectory.  Make sure that
   whatever program you use to unzip the files preserves the directory structure
   contained in crmod50.zip.

3. Edit autoexec.cfg, crmod.cfg, levels.cfg and userdefs.cfg.  Each of these
   files is commented with editing instructions.

4. Run the crmake utility.  (crmake.exe in Win95/NT or crmake.linux in linux)

5. Start up your quake server with '-game crmod' in the command line replacing
   'crmod' with whatever name you gave your subdirectory.
   
Examples:  

  winquake.exe -condebug -zone 512 -game crmod -dedicated +hostname godzilla 
  unixded -condebug -zone 512 -game crmod -dedicated 16 +hostname bambi
  
It is *strongly* recommended that you place '-zone 512' in the command line.
Otherwise the server may crash with a Z_Malloc error when it tries to read
some of the larger camera/entity files included with the mod.  It is also
recommended that you use -condebug.  This will create a console log called
Qconsole.log in your crmod directory.  It is useful for seeing what has 
happened on your server, and it can also help the debugging process if you
encounter problems running crmod.

6. READ THE MANUAL!!!

Copyright
=======================================
All files included with this modification are Copyright 1998,
Idle Communications, Inc.

Author Information
=======================================
J.P. Grossman is a third year graduate student at M.I.T. in the department 
of Electrical Engineering and Computer Science.  He has been hacking Quake 
since Oct. '97 when he began working on the Elohim Server.  J.P. have been 
hacking computers in general for 20 years.  He started in grade 1 writing 
BASIC programs for a VIC-20 and saving them on a tape drive, often 
accidentally erasing the end of the previous program.

Paul Baker is a fourth year computer science student at UCLA-YEAH RIGHT!
Actually, he is currently working full-time at PC Center in Lombard, IL.
Prior to that he attended the College of DuPage in Glen Ellyn, IL after an
unsuccessful career at the University of Illinois at Urbana-Champaign.  He
has been working on QuakeC since April of 1997 when he took over the 
ClanRing Mod code from Steven Possehl.  Paul was first introduced to
computers at the age of 10 when he taught himself to write BASIC programs 
on an Atari Home Computer.  He also saved many programs to tape, but never
managed to overwrite the ends of previous ones. :)

Acknowledgements
=======================================
We would like to thank Ignatu (a.k.a. Frank Cabanski), who introduced Paul 
and J.P. to one another, for his patience and support throughout the early
stages of 4.0.  WE LOVE YOU FRANKY!  It would not have been possible to
create this server without the help of Tovi "Izra'il" Grossman, whose
suggestions, encouragement and bug reports, starting from the day the Elohim
Server was conceived, were invaluable.  Version 5.0 benefitted enormously
from the suggestions and bug reports of Mark "Turmoil" Santaniello and
Chris "Molotov" Ruvolo.  Thanks to Chris "ocor0ner" Van Wie from taking so
much pleasuer in making crmod crash - I owe you a drink. Thanks also to 
Justin Hays and Dan "Nesta" at apci for their suggestions and their help 
with beta testing the Elohim Server versions 2.0 and up.  

A big thanks goes to everyone on EFNet IRC, especially those in #ClanRing, 
#ClanChat, and #Club_Bastardo.  Without those spur of the moment testers, 
who knows how long this would have taken.  Another big thanks to Lemurboy 
(a.k.a. Joel Baxtor) and the rest of Clan9 for QSmack 
(http://lemur.stanford.edu/clan9/qsmack/) and their great suggestions and 
constant help and testing.  

Finally, thanks to everyone who has ever mailed in a suggestion or bug report;
this mod's for you!

License Agreement
=======================================
This modification is free for public and private non-commercial
use.  To use this modification for commercial purposes or to promote
any commercial venture, you must contact Idle Communications at 
ignatu@idle.com.

No modifications can be made to this mod with the exception
of the necessary config files as specified in this readme.

The ClanRing CRMod++ v5.0 Competition Server may be used on any server
without prior written permission of Idle Communications provided that:

1. No persons shall be charged to play on any server running the mod.
2. It is not modified in any way except as stated in the
   installation section of this readme file.
3. It is not used in any way to promote commercial entities or ventures.
4. No llamas are harmed during the use of the server.

You may not distribute any of the files included with this modification!

If you would like to license the source code to this mod, please
contact ignatu@idle.com.

Decompiling the progs.dat violates copyright and other applicable laws.
Don't do it!

Technical Support
=======================================
Send all questions/bug reports/comments/suggestions to crbug@mpog.com

Legal Notice
=======================================
The contents of this file and may change at any time, so don't blink. As with
all other mods, this software is provided "as is".  We are not responsible
for any personal losses or damages caused by this software which include, but
are not limited to, lack of sleep, reduced sex drive, nausea and vomiting,
loss of sight, serious bodily harm, financial destitution, termination of
relationships, death of pets or family members or self, loss of friends,
repetitive strain injury, lowered intelligence, and the complete erasure of 
all hard drive contents.  Of course, you can't wipe a hard drive with 
QuakeC.
Or can you? ;)

