home *** CD-ROM | disk | FTP | other *** search
/ Crazy Collection 12 / CC-12_1.iso / update / doompack / data.a00 / WOD12.ZIP / WOD.DOC < prev    next >
Encoding:
Text File  |  1995-05-27  |  5.2 KB  |  152 lines
  1. --------------------------------------------------
  2. DOCUMENTATION FOR WOD DEATHMATCH DOOM LAUNCHER 1.2
  3. --------------------------------------------------
  4.  
  5. $Id: wod.doc 1.2 1995/05/27 18:21:26 Timbo Exp $
  6.  
  7. [1] Introduction
  8. ----------------
  9.  
  10. WOD is a program designed to speed up the loading of DOOM deathmatch
  11. levels by automatically transferring wadfiles and command line
  12. information from the person starting the game to the other players.
  13. I don't know about anyone else, but we used to spend an inordinate
  14. amount of time mucking about making sure everyone had the same wadfile
  15. and restarting games because people didn't type in the right parameters
  16. etc, etc, when they started up DOOM.  WOD attempts to solve this hideous
  17. and criminal waste of DOOM players' time.
  18.  
  19.  
  20. [2] Installation
  21. ----------------
  22.  
  23. All that is needed to run WOD is a copy of WOD.EXE in your DOOM
  24. directory.  If you wish to use some of the tricky options available,
  25. you might want to create a WOD.CFG in your DOOM directory.  See the
  26. "Options and Switches" section of this document for more information.
  27.  
  28.  
  29. [3] Usage
  30. ---------
  31.  
  32. WOD is invoked very simply - the player wanting to start up a game
  33. simply executes WOD with any parameters that they want to be passed to
  34. DOOM.  The machine doing this is called the master.  Players wishing to
  35. play execute WOD without any parameters.  These machines are called
  36. slaves.  Command line options are passed directly on to IPXSETUP.EXE once
  37. game information has been exchanged between the master machine and the
  38. slave machines.
  39.  
  40. For example, the command line
  41.  
  42. C:\GAMES\DOOM>wod -file spam.wad -altdeath -nodes 3
  43.  
  44. would try to start up a three player game using the wad file "spam.wad"
  45. using the alternate deathmatch rules.  If no "-nodes" command is specified,
  46. WOD defaults to a four player game.
  47.  
  48. NOTE : since the IPX comms unit I have used is not interrupt driven (in
  49. terms of the API it presents), you must install a disk cache program (e.g
  50. SMARTDRV) with write cacheing enabled.  If no disk cache is installed, the
  51. transfer of WAD files will take a really long time resulting in other
  52. slave machine timing out.  Players who don't install disk caches should
  53. be fragged unmercifully.
  54.  
  55.  
  56. [4] Options and switches
  57. ------------------------
  58.  
  59. As mentioned above, WOD accepts any command line options given to it and
  60. passes them on to IPXSETUP.EXE.  Commonly used command line options and
  61. other information can be placed in a file called WOD.CFG in the DOOM
  62. directory.  The format of this file is described below.
  63.  
  64.  - Lines starting with a "-" are considered command line options and are
  65.    added to the command line when everyone executes IPXSETUP.EXE.  Only
  66.    one command line option can be specified per line.  Note that command
  67.    line options from this file are only added if the machine is acting as
  68.    a master system otherwise they are ignored.
  69.  
  70.  - Lines starting with "#" are considered comments and ignored.  Blank
  71.    lines are also ignored.
  72.  
  73.  - Lines not starting with a "-" are configuration variables.  Configuration
  74.    variables in the current implementation are as follows :
  75.  
  76.       WADDIR <path>         Specify a directory to keep transferred WAD
  77.                             files in.  All access to WAD files are done
  78.                             to files in this directory.
  79.  
  80. At the moment, WOD does not check for multiple instances of the same
  81. parameter so if you have two "-timer" options, strange things may happen.
  82. An example WOD.CFG can be found in the archive file that WOD comes in.
  83.  
  84.  
  85. [5] Bug reports and comments
  86. ----------------------------
  87.  
  88. The present version of WOD does not have very much error checking
  89. implemented so you may get the occasional runtime error.
  90.  
  91. Read-only WAD files don't work.
  92.  
  93. The system may lock up occasionally due to packet driver/operating system
  94. weirdness.  This seems to happen if people quit out of WOD and restart
  95. it before DOOM has started up properly.
  96.  
  97. Send any bug reports or comments about the WOD program to
  98. wod-bugs@frungy.cbr.fidonet.org
  99.  
  100.  
  101. [6] Copying and distribution policy
  102. -----------------------------------
  103.  
  104. This program may be distributed freely but not charged for.  WOD is
  105. (c) 1995 by Tim Potter.  It's OK to put WOD on a CD-ROM, but please send
  106. me some email first.
  107.  
  108.  
  109. [7] Acknowlegements and thanks
  110. ------------------------------
  111.  
  112. Thanks to Rafy Marootians for lending me his spare PC for initial testing
  113. of WOD.
  114.  
  115. Thanks to the ANU Engineers/ex-Engineers/assorted misfits playtesting
  116. team :
  117.  
  118.   Oliver White                  Rafy Marootians
  119.   Brian Kavanaugh               David Austin
  120.   Rohan Talip                   Paulius Stepanas
  121.  
  122.  
  123. [8] Revision history
  124. --------------------
  125.  
  126. Version 1.2
  127.  
  128. - Release version!
  129. - Fixed bugs in WADDIR configuration variable
  130. - Updated documentation
  131.  
  132.  
  133. Version 1.1
  134.  
  135. - Fixed bugs due to master/slave startup timing problems
  136.  
  137.  
  138. Version 1.0
  139.  
  140. - Wrote some documentation
  141. - Fixed/added lots of stuff :
  142.  
  143.     - defaults to 4 nodes if "-nodes" not specified on command line
  144.     - can now abort initial registration process by pressing any key
  145.     - loads command line stuff from WOD.CFG
  146.  
  147.  
  148. Version 0.9
  149.  
  150. - Initial version of program
  151. - Underwent extensive testing (BLAM!)
  152.