+--------+
|Q3Logger|
+--------+
BETA 2  version 1.0.1.0  by TroZ

About
--------------------------------------------------------------------------------
Q3Logger is a a freeware program that will take the games.log file generated by
a Quake 3:Arena server and generate several webpages containing statistics about 
the games played on that server. There will be one Overall Stats page, one 
Player Stats page, and one page of stats for each game played on the server. 

The main features are Game by Game and 'Lifetime' stats as well as Doom like 
Killer - Killee tables for all kills and also broken up by specific weapons. 

More info is available at http://members.xoom.com\troz_\q3logger\index.html


Installation
--------------------------------------------------------------------------------
Create an empty directory and place Q3Logger and a copy of your games.log file
in to  it. Creating an empty directory is important because if a file of the 
same name as one that q3logger creates already exists in that directory, it will 
be overwriten. 

Then, just double click on Q3logger and in a few seconds the statistics webpages 
will be created. 


Q3Logger can show a image of each level played and the models used by the 
players. Because of the Quake 3 License, I cannot distribute these images. 
However, it isn't too hard to setup yourself. Heres how: 

Inside you Q3Logger directory, create an 'images' directory. Then create a 
'levelshots' directory and a 'models' directory inside the 'images' directory. 
It should look like this:

+-q3logger 
  |-q3logger.exe 
  +-images 
  | +-levelshots
  | | |-q3dm0.jpg 
  | | |-q3dm1.jpg
  | | --etc. 
  | +-models 
  |   |-bones_blue.jpg 
  |   |-bones_bones.jpg 
  |   |-bones_default.jpg 
  |   |-bones_red.jpg 
  |   |-lucy_angel.jpg 
  |   --etc. 
  --webpages if you've run q3logger 

To get the level shots, open the pak0.pk3 file in you quake3/baseq3 directory 
with winzip. Then extract the images in the levelshots directory in the zipfile
to the levelshots directory you created. 

To get the images of the models is a little more difficult. Inside the pak file
are a series of \models\players\* directorys. There is one for each player. In 
each of these directories is 3 or more 'icon_*.tga' files. You first must 
extract these files and convert them to jpg files. I used Paint Shop Pro 
because it has a batch conversion routine to convert them all at once. The 
files also must be renamed. You must replace the word 'icon' in the filename 
with the players name. For example, the icon images in the sarge directory 
should be renamed to sarge_blue.jpg , sarge_default.jpg , sarge_krusade.jpg , 
sarge_red.jpg and sarge_roderic.jpg . Place all the converted, renamed files in 
the models directory. 

For more help with the images, see the example at the webpage. 
http://members.xoom.com/TroZ_/q3logger/index.html


FAQ
--------------------------------------------------------------------------------
Q: What is beta about this program? 
A: There are a few reasons this program is beta.
	First, it hasn't been tested extensively. It seems to work fine for me, 
	but I can't guarentee it won't delete your harddrive. 
	Second, it currently treats all games as deathmatch games. I think I'll 
	have it supporting Team DM by the next version, but currently I don't 
	see how I can track captures and assists for CTF. 
	Third, there are at least 1 kill type that I do not have 
	the kill number - type of kill association worked out for yet.  
	Finally, I want to add a few more features before calling it finished. 
	If you have any ideas, send them to me.  


Q: Can you tell me how to start a log? 
A: I have found that the server writes to the log when you are
	playing a multiplayer game as a server or in skirmish mode,
	but does not write to the log when playing the single player
	game. (I was hoping it would so I could see how much i
	crushed the bots.)  You can play vs the bots in skirmish if
	you want a log generated.
	The people who write the NOP log parser (http://www.n-o-p.com)
	suggest in their FAQ three console variables to set to enable logging.
	I haven't tried them myself, but you can go over to their site and take 
	a look if you want to try them.

Q: What do all these stats mean? 
A: The meaning of the stats:
	Kills - the number of times you killed an enemy.
	Deaths - the number of times an enemy killed you.
	Suicides - the number of times you killed yourself. This includes falling 
		out of the level, drowning, and killing yourself with rocket splash.
	Frags - KILLS - SUICIDES  This is what Quake 3 reports as your score in a 
		FFA game.
	Score - your score according to Quake 3, it will only be reported if you 
		are playing when the level ends do to the time or frag limit being hit.
	Kill Differential - KILLS - DEATHS  The number of people you kill minus the 
		number of people the killed you. If positive, you did ok in the game.
	Efficentcy - KILLS / ( KILLS + DEATHS + SUICIDES)  0-100%  Kills as a 
		percentage of kills, deaths, and suicides. If above 50%, you did ok in 
		the game.
	Skill - KILLS / (DEATHS  + SUICIDES)  Similar to Efficency, but ranges from 
		0 to infinity.  If above 1 you did ok in the game.
	HC - your Handycap. The amount of health you have.  Also used to report the 
		bot skill level with 'B:' and a number from 0 to 4.
	Ping - the average time it took for messages from your computer to reach the 
		server and back. Only reported if you are in the game when the level ends.
  
Q: I run a Quake 3 server, Is there anyway I can setup Q3logger to automatically 
	update the stats webpages? 
A: I believe so, but I haven't tried it myself. If you can setup a batch file 
	that runs about once an hour that copies the games.log file from your 
	Quake 3 server to the q3logger directory, and then runs the q3logger 
	program, and finally copies or moves all of the *.html files from the 
	Q3logger directory to your web site. Currently, I have only tested 
	q3logger without Quake 3 running. I'm not sure of the effect an 
	incomplete log file will have on q3logger, but it may work fine.
	If you do run a Quake 3 Server and use q3logger, tell me, I'd like to 
	look at your stats and play on your server an see how well I do.  
  
Q: What language was Q3Logger written in? Will you be releasing the source? 
A: Q3Logger is writen in C++ in about 3 days. If is do release the source code, 
	it won't be until I conseder it 'finished' and have 'cleaned it up' a 
	little. If you have any ideas for q3logger or think you can help, email me.  



History
--------------------------------------------------------------------------------
Version 1.0.1.0 - Dec 27 1999
	Fixed all known crashes
	Fixed handling of kills for kill tables - you can now have two of the same 
		bot play in the same game and kill table will be correct
	Kill table top scores now hilited
	Overall Kill tables now generated with less html code
	Better handing of game and player time - Game Exit reason listed if known

Version 1.0.0.2  Dec 18 1999
	Fixed the crash in disconnect before connect bug
	Fixed some mishandling of player time in game (still some potential 
		problems though)
	Now Handling Mod_Suicide and Mod_Telefrag kill types - still missing
		type 21

Version 1.0.0.1 origional release  Dec 15 1999
	support for colored names
	overall and per game stats
	killer / killee tables
	level and model images inserted in to html


Thanks
--------------------------------------------------------------------------------
I would like to thank the following people for theie help in debugging by 
sending in logs that would break Q3Logger or for giving me idea or for just
sending an email of encouragement.  THANK YOU ALL!

Brian Berger
DeepC
Fabian Huester
Jonathan Ritchie
Mike from TGD Computer Sales and Services Inc.
Ole Marius Kohmann
Sacha Narinx   (What country is .za?)
Todd Lawson
Vincent Rampal
Willem Moolenaar
	

--------------------------------------------------------------------------------
For more info see: http://members.xoom.com/TroZ_/q3logger/index.html
You can email me at: troz_@xoommail.com