home *** CD-ROM | disk | FTP | other *** search
/ Magazyn Exec 3 / CD_Magazyn_EXEC_nr_3.iso / Recent / game / misc / gametracker.readme < prev    next >
Text File  |  2000-07-28  |  8KB  |  163 lines
  1. Short:    Gameserver browser for QW/Q/H2/Sin/Shogo
  2. Author:   SuRgEoN
  3. Uploader: v2615a@groenjord.dk
  4. Version:  0.5
  5. Type:     game/misc
  6. Requires: ixemul.library v47, Play16 and jpeg datatype (Aminet..)
  7.  
  8. Recommended: Powersnap2.2a(included), KingCon and some text speedup patch (Aminet..)
  9. Homepage:    SuRgEoN's Quake1 Goodies http://users2.50megs.com/surgeon/quake/quakeworld/
  10.  
  11.  
  12. Date: 19-JUL-00
  13.  
  14. GameTracker is a powerful script-based server browser and game launcher for Quake, QuakeWorld, 
  15. HereticII, Shogo & Sin. GameTracker relies on Qstat for retrieving server information.
  16. (Shogo support is available with Qstat2.3a and onwards. True HereticII support is available with 
  17. Qstat2.3e and onwards. Earlier Qstat versions fetches HereticII info using Quake2 protocol)
  18.  
  19. GameTracker lets you browse and monitor servers easily and lets you join or spectate the action on the 
  20. server of your choice (spectator mode is only supported with QuakeWorld). GameTracker has user 
  21. configurable server-filters for ping, gamedir, mapname and capacity. Along with the filter that 
  22. excludes empty servers, this lets you overlook a narrow selection of servers that interest you the 
  23. most. There's also an option to play a sample when a certain event occurs on a monitored server 
  24. (available with autorefresh option).
  25.  
  26. NOTE:
  27. Qstat is a gameserver-query tool by Steve Jankowski. The qstat executable included with GameTracker is 
  28. a straight compile of the source for version 2.2b, done by Elmar Hoffmann. If you want to use Qstat
  29. as stand alone program, or maybe in conjunction with your own frontend, remember to set stack to 
  30. 200000. Otherwise bad things will happen.
  31. Qstat source is available at: http://www.activesw.com/people/steve/qstat.html
  32.  
  33.  
  34. Installation & Configuration:
  35.  
  36. Just place the GameTracker dir where you wold prefer. You should copy qstat to C:
  37. If you use Qstat v2.3+, you should delete the "cache" dir or rename it to "cache22", and then 
  38. rename "cache23" dir to "cache". This is because Qstat cache-lists differ in the typestrings
  39. (example:"QW" for v2.2 - "QWS" for v2.3+). Therefore I have supplied 2 versions of the cachefiles.
  40. Ofcourse MasterCache and CustomCache generates lists that are compatible to the executables that 
  41. generated them. CustomCache requires the "qstatold" variable in gametracker.config to be set correctly, 
  42. for fully compatible output.
  43.  
  44. If you use amcheapo (QuakeWorld proxy), GameTracker can launch this proxy automatically
  45. and connect through it. You should have a proxy.cfg in id1/configs/ dir
  46. for setting up your default proxy commands, such as fps optimizations.
  47. Have a look at the example (in scripts/id1/configs dir).
  48. The path id1/configs/proxy.cfg can not be changed, unless you edit connect.rc in scripts/amcheapo.
  49. Also set the amcheapo env variable to 1 in GameTracker.config.
  50. If you have amcheapo running elsewhere than localhost, port 27500,
  51. you should change the proxycmdline in gametracker.config to suit your setup.
  52.  
  53. I HIGHLY RECOMMEND to install and run PowerSnap (archive is included). PowerSnap makes it easy 
  54. to copy and paste server addresses in the shell window or in quake console.
  55.  
  56. All settings are stored in GameTracker/gametracker.config You should edit this file to suit your setup !! - It 
  57. should be obvious how to do this. All settings are commented. Just don't change the names of the 
  58. env vars :) The vars you have to costumize are prefs for the supported games: (quakedir, qwcmdline, 
  59. qscmdline, h2dir, h2cmdline .... The rest can be left at default settings.
  60.  
  61. qstatold variable:
  62. Qstat v2.2 options and parameters are not compatible with version 2.3+. If you are using qstat2.3a 
  63. or later versions, you MUST set "qstatold" to "0"!
  64.  
  65. runram variable:
  66.  If you are short on RAM you should set "runram" to "0" - this will constrain GameTracker's memory 
  67. usage to around 100K, but there will be considerable amount of hd-access.
  68.  
  69. GameTracker can be upgraded with mapshots for any of the supported games - just copy the images to 
  70. /mapshots. They have to be in .jpg format and must comply with this name syntax: mapname.jpg 
  71. (example: the quake custom-map aerowalk would be "aerowalk.jpg")
  72.  
  73.  
  74. Usage:
  75.  
  76. Doubleclick GameTracker and select the options and actions you want. Everything should be pretty 
  77. straightforward.
  78.  
  79. GameTracker lets you query masterservers, cachefiles and single servers for easy monitoring and 
  80. launching of the QuakeWorld, Quake, HereticII, Shogo and Sin client executables. The interface 
  81. consists of a series of questions. All functions are accessed using requesters. PowerSnap is very
  82. usefull for copying addresses from the generated serverstats to the single-server query, since the
  83. address has to be typed in a string requester. It is from the single server query that you view the
  84. complete rules, refresh the stats on a server and monitor the development of matches and/or monitor
  85. the server for user-specified event to occur. Naturally you can also and join or spectate games when
  86. it seems interesting (spectator mode is only supported with QuakeWorld).
  87.  
  88. Note on pingfilter with QuakeWorld:
  89. If you chose a pingfilter, and then queries a masterserver, you might not get any servers listed, 
  90. although the servers that have registered with the master is within the range. This is because the 
  91. masterserver itself sometimes gets excluded by the ping filter. Use up-to-date static master lists
  92. to avoid this probem. These lists can be generated with MasterCache.
  93.  
  94.  
  95. Utils:
  96.  
  97. MasterCache is a tool for updating the QuakeWorld masterserver cachefiles (barrysworld, ocrana, 
  98. planetquake, id_limbo, fortressfest ...) Run this when the cachefiles gets outdated.
  99. Remember that qstat v2.2 and v2.3+input/output is incompatible, so you can't use the same files. If 
  100. you change executable from 2.2 to 2.3+, you should regenerate lists with the new executable, 
  101. before you use them with GameTracker or CustomCache.
  102.  
  103. CustomCache is a tool for generating filtered cache files. It can be used to split larger serverlists into 
  104. fitting categories (arena servers, duel servers etc). It can generate lists for all supported games
  105.  
  106. .......enjoy!
  107.  
  108. -SuRgEoN
  109.  
  110.  
  111.  Brief history:
  112.  
  113. v0.5:
  114. * Namechange to GameTracker (used to be QWbrowse)
  115. * Improved accuracy of ping filter (range 100 - 500 ms).
  116. * Progress indicator enabled - allowed by redirected output of all queries (v0.4+).
  117. * Can be run entirey from ram by setting appropriate config option (requires 1.2 MB).
  118. * Requesters are more readable and informative.
  119. * Alert "players": Optional SFX when server has a minimum # of active players.
  120. * Alert "mapname": Optional SFX when a particular map is active on server.
  121. * Alert "not full": Optional SFX when server (often full) becomes available for joining.
  122. * Alert "playername": Optional SFX when a particular player is on server.
  123. * Added a string requester to GameTracker, MasterCache and CustomCache
  124. * Memory flush before game-launch is now optional
  125. * Updated gametracker.config
  126. * Updated this document (as always)
  127. * Improved stability with amcheapo (QuakeWorld proxy)
  128. * Automatic launch of amcheapo if set in gametracker.config
  129.  
  130. v0.4 (not released)
  131. * Exdir filter added ( = exclude gamedir).
  132. * CustomCache had wrong requester titles - fixed.
  133.  
  134. v0.3:
  135. * Managed to get Qstat to run stable by increasing stack :)
  136. * Much improved performance (up to 300%), due to better use of Qstat options.
  137. * Support for Qstat v2.3+ (qstatold variable in qwbrowse.config).
  138. * Support for HereticII, Sin and Shogo.
  139. * Refresh option extended to master/file queries.
  140. * Auto-refresh option has been added to single-server-query mode.
  141. * Option for displaying all server-rules in single-query mode.
  142. * Filters for gamedir, capacity, mapname, and gamedir-capacity combination.
  143. * Filters for ping-limited server display.
  144. * Auto-displays ID maps (incl q1edge,base32b & death32c), ztndmX, ctfX, ctf2mX, missionpack 1&2.
  145. * Sound samples accompany actions.
  146. * A new tool, CustomCache, for generating and saving filtered serverlists.
  147. * Lots of new cache files (Quake, HereticII, Sin and Shogo).
  148. * Removed amigaguide generation - better filtering made it obsolete.
  149.  
  150. v0.2:
  151. * Added support for normal Quake.
  152. * Heavily improved configurability.
  153. * Improved readability of template output.
  154. * Added option to filter out empty servers.
  155. * Now QWBrowse doesn't quit when QuakeWorld or Quake is exited.
  156.  
  157. v0.1: (First public release)
  158.  
  159.  Future:
  160.  
  161. * Maybe more server-filters
  162. * Maybe improve GUI
  163.