home *** CD-ROM | disk | FTP | other *** search
/ DeathMatch 2 for Doom 2 / Deathmatch2.bin / utils / dehacked / dehacked.hlp < prev    next >
Text File  |  1994-09-11  |  27KB  |  560 lines
  1.                 DeHackEd v. 2.0
  2.               By Greg Lewis (Tree)
  3.              gregory.lewis@umich.edu
  4.            The premiere Doom.exe hack editor!
  5.  
  6.  
  7.   This is a general help file for DeHackEd version 2.0.  For more specific
  8. product information, see the file DEHACKED.TXT.  If the information
  9. contained here is not specific enough, or you want more technical details,
  10. get a copy of the the doom.exe hack specs written by Matt Fell.  They are
  11. available for FTP at infant2.sphs.indiana.edu, in the directory
  12. /pub/doom/wad_edit/doomhack, and are called DEHACKER.ZIP.  And, if you
  13. are more interested in simply finding fun stuff to experiment with,
  14. check out "Fun with DeHackEd" (dhefun??.txt) bundled with the program.  It
  15. was written by Dan Lottero, and includes all sorts of wild things to do!
  16.  
  17.  
  18.   This help file is arranged in the following nine sections:
  19.  
  20.     1.  Command Line Options
  21.     2.  DeHackEd.ini Options
  22.     3.  Patch File Info
  23.     4.  Available Keys
  24.     5.  Thing Editor
  25.        a. Thing fields
  26.        b. Bit fields
  27.     6.  Frame Editor
  28.     7.  Ammo Editor
  29.     8.  Sound Editor
  30.     9.  Sprite Editor
  31.        10.  Text Editor
  32.  
  33.   So, without further ado, here it is!
  34.  
  35.  
  36.  1. *** Command Line Options
  37. \------======================
  38.  
  39.   First, an explanation of command line options.  The full command line
  40. syntax for DeHackEd is:
  41.  
  42.     dehacked [doompath] [-load <patchname>] [-save <patchname>]
  43.  
  44.   [doompath] is optional, and specifies a different location for the
  45. doom files, doom.exe and doom.wad, other than the current directory.  
  46.  
  47.   -load <patchname> will update the doom.exe file with the patch called
  48. <patchname> and return to the DOS prompt--great for batch files!.  And,
  49. conversely, the -save <patchname> option will save the current doom.exe
  50. status to a patch file named <patchname> and return to the DOS prompt.
  51. These options are similar to 'l' and 's' in DeHackEd, although when used
  52. in DeHackEd the 'l' option requires a 'w' after it to actually write the
  53. changes to the doom.exe file.  See section 4 for more info on 'l', 's',
  54. and 'w'.
  55.  
  56.   Example command line:
  57.  
  58.     dehacked c:\games\doom -load suprwep4.deh
  59.  
  60.   This will start DeHackEd, using the doom.exe file found in c:\games\doom,
  61. will update it with the info from the suprwep4.deh patch file, and return
  62. to the DOS prompt.  And of course, just typing a plain 'dehacked' will take
  63. you straight into the DeHackEd main program.
  64.  
  65.  
  66.  2. *** DeHackEd.ini Options
  67. \------======================
  68.  
  69.   Included with DeHackEd 2.0 is a new DeHackEd.ini file which can specify
  70. several parameters for DeHackEd.  They allow you to customize where you
  71. want your patch files located, what your doom files are named, and more.
  72. Note: you must keep a space on both sides of the equal signs for a
  73. parameter to be processed properly.  A summary of the allowable command 
  74. line options follows:
  75.  
  76.   #     Start comment lines with a pound sign.  Anything after the pound 
  77.     sign is ignored.
  78.   doomexe = <exename>
  79.     This is the name of your doom.exe file, and full path if necessary.
  80.     You can change this easily to determine whether you are working
  81.     with a Doom 1.2 exe or a Doom 1.666 exe.  This doesn't need to be
  82.     included if you are running DeHackEd from the directory that your
  83.     doom.exe file resides in.
  84.   doomwad = <wadname>
  85.     This is the name of your doom.wad file, and full path if necessary.
  86.     This must be a registered wad file, not a shareware file.  This is
  87.     needed for verification that you are really registered, and not
  88.     just trying to fake it.  Once again, if this is in the same 
  89.     directory that DeHackEd is run from you don't need this parameter.
  90.   doompath = <path>
  91.     This is the path from which you want Doom to be run.  This is only
  92.     used when using the 'r'un option from inside DeHackEd.
  93.   doomargs = <Doom parameters>
  94.     These are command-line parameters that are fed to Doom when it's
  95.     run using the 'r'un option from within DeHackEd.  Useful if you
  96.     are using DeHackEd for a custom patch for a WAD you are writing;
  97.     you can simply include a '-file <wadname>' in this line, and
  98.     Doom will load your level every time DeHackEd runs it.
  99.   patchdir = <path>
  100.     This is the directory that DeHackEd will look in for patch files.
  101.     A nifty way of keeping all of your thousands of .DEH files out
  102.     of the Doom main directory.
  103.  
  104.   The following parameters are all totally optional, and need only be 
  105. used if you are doing some "custom" doom.exe hacking.
  106.   doomver = <0 | 1>
  107.     This is the version of Doom you are hacking.  0 is Doom 1.2 and
  108.     1 is Doom 1.666.  This *must* be included if any of the following 
  109.     options are set.
  110.   doomsize = <size>
  111.     The size of your Doom.exe file.  I've had a few people complain
  112.     that they have a non-standard doom.exe file size, and this may
  113.     fix your problem simply by changing this.  If you get erroneous
  114.     results though, you may have to play with the following params...
  115.   thingoff = <offset>
  116.   soundoff = <offset>
  117.   frameoff = <offset>
  118.   spriteoff = <offset>
  119.   ammooff = <offset>
  120.   weaponoff = <offset>
  121.   textoff = <offset>
  122.     These are the offsets in the doom.exe file for their corresponding
  123.     data chunks.  Read Matt Fell's specs if you don't understand what
  124.     these sections are, they are explained fairly clearly (among the
  125.     rest of the information in the file).  PLAY WITH THESE AT YOUR OWN
  126.     RISK.
  127.  
  128.  
  129.  3. *** Patch File Info
  130. \------=================
  131.  
  132.   This is some more info on patch files, which may help explain any
  133. difficulties you are having with them.
  134.  
  135.   Patch files save ALL the info on Frames, Ammo, Things, Weapons, Sound, 
  136. Sprites, and Text, NOT just changed data.  Saving only changed data would 
  137. involve complications with just what was 'changed' (don't ask, just trust 
  138. me!).  This way, if several people load a specific patch, you KNOW 
  139. everyone will have the same doom.exe file.
  140.  
  141.   The patch files that DeHackEd 1.3 created saved only 4 pieces of info:
  142. the Frames, Things, Ammo and Weapons.  If you are editing Doom 1.2, 
  143. DeHackEd 2.0 will only save those pieces of information in order to
  144. create a patch file compatible with DeHackEd 1.3.  
  145.  
  146.   It is a good idea to save back-up patch files before messing around
  147. with your doom.exe file.  The standard naming convention for back-up 
  148. patches is "normal??.deh", where the ?? are replaced with 12 or 16,
  149. depending on your doom version.  Those files are then also used for
  150. merging patches, as a "clean" patch of your doom.exe file.  For example,
  151. if you are merging in a patch for Doom 1.666, DeHackEd expects to find a
  152. clean patch file called "normal16.deh" in your patch directory.
  153.  
  154.   If anyone is interested in the actual make-up of the patch files (for
  155. compatibility with your own doom exe editor, or for any other purposes)
  156. please contact me and I'll let you know the format that they are stored
  157. in.
  158.  
  159.  
  160.  4. *** Available Keys
  161. \------================
  162.  
  163.   Available keys are as follows:
  164.  
  165.   ESC   Exits to DOS.  Or, if you are in an input box, or just about
  166.     *anywhere* in the program for that matter, it will back you
  167.     out to whatever you had previously been doing.  This is certainly
  168.     an improvement over 1.3, as many of you will attest.  :-)
  169.  
  170.   Enter Edits the current field, if it is an editable field.  To leave an
  171.     editing box if you hit Enter by mistake, simply hit ESC.
  172.  
  173.   Space Views, plays, or displays the current field, if applicable.  If
  174.     you are on a "frame" field, such as any of the Thing frames, or
  175.     any field in the Frame table, or the Frame fields in the Ammo 
  176.     editor, you can see the frame that you've got highlighted simply 
  177.     by hitting the spacebar.  (Note:  If you are on the "Next Frame"
  178.     field in the Frame editor you WILL see the next frame, not the
  179.     current frame.)  If the frame you are viewing is the first in a
  180.     series of frames, repeatedly pressing the spacebar will cycle 
  181.     through all of the frames.  Escape will exit.  The spacebar will
  182.     also view the full text strings in the Text Editor.  And it will
  183.     also play the sounds when you are in a sound field (currently not
  184.     inplemented yet).
  185.  
  186.   C     The copy command.  This will copy information from one entry to
  187.     another.  The syntax is fairly bas