home *** CD-ROM | disk | FTP | other *** search
/ Qu-ake / Qu-ake.iso / qu_ke / patches / 023 / FREPORT.TXT < prev    next >
Encoding:
Text File  |  1996-09-21  |  4.2 KB  |  130 lines
  1. Title    : FragReport
  2. Filename : freport.zip
  3. Version  : 1.20
  4. Date     : 96/09/21
  5. Author   : Ray Li
  6. Email    : ryl@crl.com
  7. Credits  : id Software, for making Quake! :)
  8.  
  9.  
  10. Type of Mod
  11. -----------
  12. Quake C  : yes
  13. Sound    : no
  14. MDL      : no
  15.  
  16.  
  17. Format of QuakeC
  18. ----------------
  19. unified diff  : no
  20. context diff  : no
  21. .qc files     : yes
  22. progs.dat     : yes
  23.  
  24.  
  25. Description of the Modification
  26. -------------------------------
  27.  
  28. This modification will keep track of frag statistics; namely, who killed
  29. whom how many times.  Good for finding out how you're doing against
  30. specific opponents:  whom to hunt down, and whom to avoid. :)  This
  31. modification is built off Quake v1.01
  32.  
  33.  
  34. How to Install the Modification
  35. -------------------------------
  36.  
  37. I've included two versions of this mod:  one is the modified
  38. progs.dat file, for users who want a quick look at how it
  39. operates, the other is the source code of the modified
  40. (defs.qc, client.qc, progs.src, weapons.qc) and new 
  41. (freport.qc) code for users to layer into their own versions 
  42. and/or extend.  Create a directory in the Quake directory and 
  43. unzip the file freport.zip into that directory.  You should
  44. have the following files in that directory
  45.  
  46.  FREPORT.TXT - this file
  47.  EDITING.TXT - directions on how to modify DEFS.QC, CLIENT.QC,
  48.                PROGS.SRC, and WEAPONS.QC if you want to build
  49.                FragReport into an already-modified code base
  50.                (or you could just use some sort of diff program).
  51.  PROGS.DAT   - the compiled QuakeC code containing the FragReport
  52.                mod
  53.  
  54.  CLIENT.QC   -
  55.  DEFS.QC     -
  56.  PROGS.SRC   - Modified QuakeC files
  57.  WEAPONS.QC  -
  58.  
  59.  FREPORT.QC  - New QuakeC file
  60.  
  61. The functionality and data for this mod reside almost entirely in
  62. FREPORT.QC.  The CLIENT.QC and WEAPONS.QC files contain interface
  63. function calls to FragReport, DEFS.QC has an added field member
  64. to the entity structure, for entity identification purposes.
  65. PROGS.SRC has been modified to include FREPORT.QC in compilation.
  66.  
  67. For patching Quake C, see the document "howpatch.txt", available
  68. from ftp.cdrom.com:/pub/idgames2/quakec
  69.  
  70.  
  71. Technical Details
  72. -----------------
  73.  
  74. 256 floats are used to maintain the 16 by 16 matrix of frags
  75. (wasteful, but it was easier that way), with the subscripting buried
  76. within the variable name.  It's been tested in LAN play with four
  77. players, with no noticeable problems.  I have absolutely no idea how
  78. (or IF) it runs with more people, or how it fares on an Internet
  79. server, so be forewarned!  Please let me know if you find any
  80. bugs.
  81.  
  82. By default, FragReport is called by IMPULSE 222; this can be
  83. changed for your own setup by changing the impulse number
  84. check in weapons.qc.  When invoked, FragReport will print
  85. information to the screen (going to the console is almost
  86. always required, as the print out is almost always >4 lines in
  87. length).  The following shows an example of a print-out after
  88. an IMPULSE 222 command:
  89.  
  90.  GotHim|GotYou|Name
  91.  ------------------
  92.     21 |    5 | AGGIE
  93.      3 |   31 | LONGHORN
  94.      5 |    0 | LEFT AT  55.6
  95.  --------------------------
  96.     29 |   36 | Suicides: 5
  97.  
  98. where "AGGIE" and "LONGHORN" are example opponents currently
  99. still in the game, and "LEFT AT  55.6" indicates someone who
  100. disconnected from the server at time=55.6 seconds.
  101.  
  102.  
  103. Author Information
  104. ------------------
  105.  
  106. This is my first QuakeC mod; I hope some of you find it useful.  It
  107. certainly has made our local network games more interesting, giving us
  108. another measuring stick to judge our performances against one another
  109. aside from just gross frag counts.  I'd love to hear from anyone who
  110. gets this running on a full-out 16-player NetQuake server!
  111.  
  112.  
  113. Copyright and Distribution Permissions
  114. --------------------------------------
  115.  
  116. Authors may use these modifications as a basis for other publically
  117. available work (but please give credit where credit is due).
  118.  
  119. You may distribute this Quake modification in any electronic
  120. format as long as this description file remains intact and unmodified
  121. and is retained along with all of the files in the archive.
  122.  
  123.  
  124. Availability
  125. ------------
  126.  
  127. This modification is available from the following places:
  128.  
  129. FTP   : ftp.cdrom.com in the pub/quake/quakec directory
  130.