home *** CD-ROM | disk | FTP | other *** search
/ Doom I/II Collection / DM12.ISO / utils / doomez12 / readme.doc < prev   
Text File  |  1994-03-12  |  12KB  |  221 lines
  1.  
  2.                   DOCUMENTATION FILE FOR DOOMEZ VER 1.2 
  3.  
  4. ***************************************
  5. ***************************************
  6. PLEASE READ:
  7.  
  8. This v.1.2 of DOOMEZ supports alteration of DOOM 1.2 MODEM save files.  The
  9. modem command, "modem", has been added to the list of possible DOOMFIX.CFG 
  10. commands.  This command will cause BOTH player 1 and player 2 to be edited
  11. with the same alterations. (I debated on whether or not to allow users to have 
  12. the capability of editing modem players 1 and 2 separately, and decided that
  13. in the interests of game "fairness", both players should get equal editing.
  14. If you would like to edit modem players separately, please contact me.)  Note 
  15. that you must be running DOOM 1.2, and you must have the "ver 1.2" command in 
  16. DOOMFIX.CFG before the "modem" command will work. ALTHOUGH THE "modem" COMMAND 
  17. GIVES YOU MUCH MORE EDITING POWER, IT IS A VERY DANGEROUS COMMAND AS WELL.  
  18. IT CAN POTENTIALLY DESTROY A NON-MODEM SAVE FILE, SO USE IT CAREFULLY!
  19.  
  20. This version of DOOMEZ supports DOOM versions 1.1 and 1.2.  DOOMFIX must be
  21. told which version of DOOM you are running.  (There are so many non-constant 
  22. internal variables in the DOOM save files that I decided to have the user
  23. command DOOMFIX with the DOOM version number rather than having DOOMFIX
  24. read a DOOM save file and then try to decide which version of DOOM you are
  25. running.)  To command DOOMFIX to configure with your version of DOOM, just add 
  26. a "ver 1.1" or "ver 1.2" command (separated by spaces) to your DOOMFIX.CFG 
  27. file's top data line. If you omit the "ver" command in DOOMFIX.CFG, DOOMFIX 
  28. will ASSUME you are running DOOM 1.2!
  29.  
  30. DOOMEZ installation is now dependent upon which version of DOOM you're using.
  31. If using DOOM 1.2, install all DOOMEZ files to your \doom area.  If you are
  32. still running DOOM 1.1, install PLAYDOOM.BAT to your \doom area, and install
  33. the DOOMFIX files to your \doomdata area.
  34.  
  35. Note that you may have to alter PLAYDOOM.BAT depending on which version of
  36. DOOM you are running.  If you need to edit it, only one line will require
  37. alteration. Look at the PLAYDOOM.BAT file and find the notes highlighted with
  38. # characters.  
  39.  
  40. Most of the text that follows is the same as that included in version 1.0 of 
  41. DOOMEZ.
  42. ***************************************
  43. ***************************************
  44.  
  45.  
  46. DOOMEZ allows you to play any DOOM episode and mission while getting special
  47. weapons, ammo, and super powers.  It consists of a batch file, PLAYDOOM.BAT,
  48. and two DOOMFIX files - DOOMFIX.EXE and DOOMFIX.CFG.   PLAYDOOM is the file
  49. you will call for running this system and DOOMFIX is a special "in-line" DOOM
  50. save file editor.  PLAYDOOM runs DOOM in "developmental" mode -- a special
  51. mode which lets you do things such as warp to individual missions, setup
  52. skill levels, etc.  Since the DOOM developmental mode lets you do these things,
  53. you may ask, "Why do I need DOOMEZ when DOOM already lets me play any mission
  54. I want?"  The answer is that even though DOOM will send you to any mission, you
  55. will begin that mission with very little weapons, ammo, etc.  DOOM has a special
  56. "cheat" mode that will let you give yourself special ammo, health, and other
  57. things.  This mode is called during gameplay and consists of commands such as
  58. "iddqd", "idbehold", etc.  These modes are useful but you STILL don't get
  59. big weapon loads, super armour, etc.  DOOMFIX gives you lots of goodies that
  60. the built-in DOOM controls don't. 
  61.  
  62. PLEASE NOTE that you only need to run PLAYDOOM.BAT when you want to jump
  63. to a DOOM mission that is out-of-series with the ones you are currently
  64. playing.  Once you've run PLAYDOOM.BAT and you have a "super" DOOM save file,
  65. play DOOM normally until ready to skip to a new out-of-series mission.
  66.  
  67. DOOMFIX is a powerful DOOM save game editor.  In the DOOMEZ package, it runs
  68. as part of PLAYDOOM.BAT.  Read the discussion on DOOMFIX later in this file
  69. and then feel free to experiment with DOOMFIX.  It can be run on ANY DOOM save
  70. game file and there are MANY save game settings you can play with.  The DOOMEZ
  71. package comes with a "generic" DOOMFIX.CFG configuration file that I threw 
  72. together just to illustrate some of the things DOOMFIX can do. 
  73.  
  74.  
  75.  
  76.  
  77.  
  78. *******************************************************************************
  79.                           INSTALLATION 
  80.  
  81. Run PLAYDOOM by typing "playdoom" followed by command line arguments for the 
  82. episode, mission, and skill level you want.  Episodes are numbered 1-3, missions
  83. are numbered 1-9, and skill levels are 1-5 for DOOM 1.2 (1-4 in DOOM 1.1). 
  84. Typing "playdoom 3 2 4" will run episode 3, mission 2, and skill level 4 in 
  85. single-player mode.  Typing "playdoom" with no command line arguments will give
  86. you usage info.
  87.  
  88. Once begun, PLAYDOOM will run DOOM using the passed-in arguments. When DOOM
  89. has finished its opening setup and has given you a play screen, SAVE THE GAME
  90. BY PRESSING "F2" AND SELECT THE TOP SAVE GAME SLOT FOR SAVING. YOU MUST USE THE
  91. TOP SLOT IN ORDER TO WRITE THE DOOMSAV0.DSG SAVE GAME FILE.  DOOMEZ is packaged 
  92. and setup to use the DOOMSAV0.DSG save game file. Once you understand how 
  93. PLAYDOOM and DOOMFIX work, feel free to change the save game file from 
  94. doomsav0.dsg to any other DOOM save file.  Once again, DO NOT PLAY THE LOADED 
  95. GAME, JUST SAVE IT IN THE TOP SAVE SLOT IN THE SAVE MENU AND EXIT DOOM!  (DOOM 
  96. save game files are VERY complex, and you must rely on DOOM to give you an 
  97. initial episode, mission, and skill level setup.  This first run of DOOM gives 
  98. you a working save game file.)
  99.  
  100. Once DOOM has exited, DOOMFIX will take over and will edit the DOOMSAV0.DSG 
  101. save game file.  You will see a listing of the items that DOOMFIX is changing.
  102. See the following discussions on DOOMFIX if you want to change the items
  103. edited.  
  104.  
  105. Once DOOMFIX has finished, DOOM will begin again using the edited save game
  106. file.  You will notice major changes in your configuration -- more weapons,
  107. ammo, armour, etc.  Play DOOM normally from here on.  Your edited save game
  108. file is just a starting point for a mission.  Save over it or reload it 
  109. whenever you want.
  110.  
  111.  
  112.  
  113.  
  114.  
  115. *******************************************************************************
  116.                               DOOMFIX OPERATIONS 
  117.  
  118. DOOMFIX is an "in-line" DOOM save file editor.  Rather than presenting you
  119. with menues of items for editing, DOOMFIX reads a customized configuration
  120. file which tells it how to edit your save file.  This configuration file,
  121. DOOMFIX.CFG, is a simple ASCII text file that has only ONE ACTIVE LINE OF
  122. DATA.  The top data line in DOOMFIX.CFG is all that is read by DOOMFIX, and
  123. any editing you need to do is done on this single data line.  Print out the
  124. DOOMFIX.CFG file that came with DOOMEZ.  You will notice this file gives you
  125. a listing of all the available DOOMFIX commands.  Here are the rules for
  126. editing DOOMFIX.CFG:
  127.     1)    All commands are on the top data line in the file.
  128.     2)    All commands are separated by space characters.  Carriage
  129.         returns, line feeds, and other control characters are not
  130.         allowed as command delimiters or separators in the data line.
  131.     3)    Some commands consist of more than one string.  Be sure to enter
  132.         ALL of the command.  For example, the "inv" command requires
  133.         two extra parameters.  The command "inv 3 25" will make you
  134.         invisible for 3 minutes 25 seconds.  All ammo load commands
  135.         have two extra parameters - the first being the ammo load and
  136.         the second being the max possible load for that type of ammo.
  137.         The command "r 400 550" will load you with 400 rockets and your
  138.         current max rocket count is 550.  All parts of a command are 
  139.         separated with space characters.
  140.     4)    The commands can be entered in any order.  Just keep all the
  141.         parts of a single command together.  The length of the data 
  142.         line isn't critical.
  143.     5)      VERY IMPORTANT!  The LAST item in the command list MUST be the
  144.         name of the DOOM save file being edited.  The DOOMFIX.CFG
  145.         that came with DOOMEZ has the filename DOOMSAV0.DSG as the 
  146.         last item in the command list.  THIS IS WHY YOU MUST USE THE
  147.         TOP SAVE SLOT IN THE GAME FOR SAVING DATA. The top slot writes
  148.         data to doomsav0.dsg.  Feel free to change the last command
  149.         item filename to any other filename you want.  Just remember
  150.         what save filename you are editing!
  151.     6)    Once the commands and the trailing save filename have been
  152.         entered into the data line, just hit "return" or "enter" to
  153.         add a carriage return to the end of the line.  This will tell
  154.         DOOMFIX to stop reading the configuration data.  You can type
  155.         anything else you want into the file at this point -- personal
  156.         notes, descriptions of your edits, etc.  DOOMFIX READS THE TOP
  157.         DATA LINE ONLY!
  158.     7)    DOOMFIX supports DOOM 1.1 and 1.2 via a command in DOOMFIX.CFG.
  159.             Tell DOOMFIX which version of DOOM you are running via the 
  160.         "ver 1.1" and "ver 1.2" commands.
  161.     8)     DOOMFIX will edit a MODEM save file (both players are edited)
  162.         via the "modem" command.  Be careful with this command!
  163.              
  164. Editing the DOOMFIX.CFG is easy.  Here's an example of the top (and only) data
  165. line in a DOOMFIX.CFG file (note that only space characters are used to separate
  166. the commands and that a save filename is the last item in the list:
  167.     
  168. ver 1.2 modem a 200 bk ysk rs 3 20 rl r 300 400 iddqd doomsav0.dsg
  169.  
  170. The above example gives you armour at 200%, a blue key, a yellow skeleton key,
  171. a radiation suit that will be active for 3 minutes 20 seconds, a rocket 
  172. launcher, a rocket load of 300 with a max of 400 rockets, put you in "god"
  173. mode where you can't be hurt, and finally the doomsav0.dsg file will be the
  174. target of these edits.  The "ver 1.2" command will tell DOOMFIX to write the
  175. save file in DOOM 1.2 format and the "modem" command will cause both players
  176. in this file to be edited.  The save file was created during modem play,
  177. otherwise you would NOT use the "modem" command!  Experiment with your own 
  178. DOOMFIX.CFG files.  Be weary of very large, unusual parameters such as a health 
  179. of 500% or ammo loads over 999 pieces of a single type of ammo.  You may get 
  180. very unexpected results! For more DOOMFIX info, type "DOOMFIX ?".
  181.  
  182. Once you feel comfortable editing the DOOMFIX.CFG file commands, try editing
  183. DOOM save files outside of the PLAYDOOM.BAT routine.  Use it as you would
  184. any save file editor, with the exception being that you tell the routine what
  185. to edit via a configuration file as opposed to selecting menu items on a 
  186. screen. 
  187.  
  188.  
  189.  
  190.  
  191.  
  192. *******************************************************************************
  193.                          FINAL COMMENTS 
  194. DOOMEZ was not written to allow one to cheat his/her way through DOOM. 
  195. It is intended as a tool to allow your progression through DOOM in a 
  196. shorter-than-normal time span while still giving you LOTS of enjoyment and 
  197. fun with experimentation.  Please use it with this attitude in mind.  
  198.  
  199. If you have any questions or comments concerning this program, or YOU WISH TO 
  200. MAKE A DONATION of $5 (please make any checks payable to WAYNE SIKES), please 
  201. contact me at:
  202.  
  203. Wayne Sikes
  204. 435 Sego Lily
  205. Bosque Farms, NM  87068
  206.  
  207. CompuServe:        70733,1562
  208. Phone:      (505)-869-3522 (home)
  209.         (505)-844-8658 (work)
  210.  
  211. Feel free to distribute copies of these programs. The only thing I ask is 
  212. that you DO NOT MODIFY this text file, PLAYDOOM.BAT, or the DOOMFIX routines
  213. prior to distribution.  When distributing, PLEASE ALWAYS INCLUDE A COPY OF 
  214. THIS TEXT FILE.  If you include these programs in any retail or wholesale 
  215. software packages, compilations, libraries, archives, etc. please contact 
  216. me.  As with all my analysis and engineering software, these programs are
  217. copywritten by K & W Computer Works.
  218.  
  219. Thank you for using DOOMEZ and enjoy DOOM!
  220. *********************  END OF README.DOC FILE ***********************
  221.