home *** CD-ROM | disk | FTP | other *** search
/ Toolkit for DOOM / DOOMTOOL.ISO / doomhack / dhe199e.zip / DEHACKED.HLP < prev    next >
Text File  |  1994-08-22  |  18KB  |  379 lines

  1.                 DeHackEd v. 2.0
  2.               By Greg Lewis (Tree)
  3.              gregory.lewis@umich.edu
  4.             The 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 on 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 three sections:
  19.  
  20.     1.  Command Line Options
  21.     2.  DeHackEd.ini Options
  22.     3.  Available Keys
  23.     4.  Ammo Editor
  24.     5.  Thing Editor
  25.        a. Thing fields
  26.        b. Bit fields
  27.     6.  Frame Editor
  28.  
  29.   So, without further ado, here it is!
  30.  
  31.  
  32. 1. *** Command Line Options
  33. \------=====================
  34.  
  35.   First, an explanation of command line options.  The full command line
  36. syntax for DeHackEd is:
  37.  
  38.     dehacked [doompath] [-load <patchname>] [-save <patchname>]
  39.  
  40.   [doompath] is optional, and specifies a different location for the
  41. doom files, doom.exe and doom.wad, other than the current directory.  
  42.  
  43.   -load <patchname> will update the doom.exe file with the patch called
  44. <patchname> and return to the DOS prompt--great for batch files!.  And,
  45. conversely, the -save <patchname> option will save the current doom.exe
  46. status to a patch file named <patchname> and return to the DOS prompt.
  47. These options are similar to 'l' and 's' in DeHackEd, although when used
  48. in DeHackEd the 'l' option requires a 'w' after it to actually write the
  49. changes to the doom.exe file.  See section 2 for more info on 'l', 's',
  50. and 'w'.
  51.  
  52.   A note about patch files:  Patch files save ALL the info on Frames,
  53. Ammo, Things, Weapons, Sound, Sprites, and Text, NOT just changed data.
  54. Saving only changed data would involve complications with just what was
  55. 'changed' (don't ask, just trust me!).  This way, if several people load
  56. a specific patch, you KNOW everyone will have the same doom.exe file.
  57.  
  58.   Example command line:
  59.  
  60.     dehacked c:\games\doom -load morfmons.deh
  61.  
  62.   This will start DeHackEd, using the doom.exe file found in c:\games\doom,
  63. will update it with the info from the morfmons.deh patch file, and return
  64. to the DOS prompt.  And of course, just typing a plain 'dehacked' will take
  65. you straight into the DeHackEd main program.
  66.  
  67.  
  68. 2. *** DeHackEd.ini Options
  69. \------==============
  70.  
  71.   Included with DeHackEd 2.0 is a new DeHackEd.ini file, which can specify
  72. several parameters for DeHackEd, so that they don't need to be typed in
  73. every time.  A summary of the allowable command line options follows:
  74.  
  75.   OK, so they're not in here yet.  So sue me!
  76.  
  77.  
  78. 3. *** Available Keys
  79. \------==============
  80.  
  81.   Available keys are as follows:
  82.  
  83.   ESC   Exits to DOS.  'Nuff said.
  84.  
  85.   Enter Edits the current field, if it is an editable field.
  86.  
  87.   C     The copy command.  This will copy information from one entry to
  88.     another.  The syntax is fairly basic:  enter the number of the
  89.     entry to copy FROM, and the entry number to copy TO.  A clipboard
  90.     for Things is available as Thing #104 (Thing #128 for Doom 1.6),
  91.     which is just a temporary storage Thing (and is not actually
  92.     present in the Doom.exe file).  Note that the Thing names will
  93.     not change... the Thing name is not
  94.     actually in the Doom.exe, and is just included for your own
  95.     benefit.  The Thing # is also only for the convenience of the
  96.     hacker, and is not in the doom.exe file.  A specific Thing # will
  97.     always have the same Thing Name, and this cannot be changed.
  98.  
  99.   D     Change numeric mode to Decimal.  This displays all numbers as
  100.     normal decimal numbers.  'H' will switch to hexidecimal displays,
  101.     which may be helpful sometimes.
  102.  
  103.   G     Goes to a specific Thing.  If you know exactly which Thing or
  104.     Frame you want to see, jump right to it without bothering to
  105.     arrow or page down.  The Things now have a goto window, arranged
  106.     alphabetically by name.  That's so that you don't need to remember
  107.     lots of Thing numbers all the time!
  108.  
  109.   H     Displays all numbers in the hexidecimal number format.  Useful
  110.     for those true hackers who live in hex their whole lives.  Use
  111.     'D' to return to the normal decimal world.
  112.  
  113.   J     Jumps to the information in the current field, in it's respec-
  114.     tive editor.  For example, if you are in the Thing editor, and the
  115.     'Death Frame' is highlighted, and you press the 'j' key, you will
  116.     jump to the Frame editor, with the corresponding Frame number high-
  117.     lighted.  A very handy tool for moving around the various editors.
  118.  
  119.   L     Loads a patch file.  You must enter the patch filename, and it
  120.     will replace the current information.  Note that 'w' must still
  121.     be used to make the changes permanent.  You can also do this
  122.     from the command line by typing
  123.         dehacked -load <filename>
  124.     One caveat:  the load feature is not working too well in 2.0 yet.
  125.     You can load 1.2 patches into 1.2 exe's, and 1.6 patches into
  126.     1.6 exes, but that's about it.  1.6 -> 1.2 WON'T work, and 1.2 ->
  127.     1.6 probably won't work either, ever.  I'll see how far I get.
  128.  
  129.   R     Runs Doom.  This option is slightly tempermental, for reasons
  130.     unknown to me.  If you have plenty of memory, try hitting it to see
  131.     if it'll work.  It allows you to quickly test-run Doom, to check out
  132.     the changes you've made (remember to hit 'w' before running!).  
  133.     After Doom finishes, you will be returned to your current place in 
  134.     the editor to continue working.
  135.  
  136.   S     Save a patch file.  You must enter the patch filename, and it
  137.     will save all editable material to the patch file.  It saves either
  138.     a 1.2 patch or 1.6 patch depending on what doom.exe you are editing
  139.     at the time.  You can also do this from the command line by typing
  140.         dehacked -save <filename>
  141.  
  142.   U     Undo all changes.  This reloads the information straight from the
  143.     doom.exe file, and will return you to your most recent save of the
  144.     doom.exe file.
  145.  
  146.   W     Writes all changes to the doom.exe file.  This step is necessary
  147.     to get any results!
  148.  
  149.   F2    Thing Editor.  This is the main Thing editor, the default screen in
  150.     DeHackEd 1.3.  See section 3 for more detailed Thing info.
  151.  
  152.   F3    Frame Table.  Displays Frame information, in a list format.
  153.     See section 3 for more detailed Frame info.
  154.  
  155.   F4    Ammo/Weapon Editor.  This allows you to edit the ammo and weapon
  156.     amounts and graphics.
  157.  
  158.   F5    Sound Table.  A jolly good table of all the sounds.  Editing of the
  159.     sounds is included in this version of DeHackEd.
  160.  
  161.   F6    Sprite Table.  A handy list of all the sprites, in case someone
  162.     needs it.  Also has recently added editing capabilities.
  163.  
  164.   F7    Text Editor.  This shows all the text strings in the Doom.exe file.
  165.     Currently they cannot be edited, but somehow I'll put editing capa-
  166.     bilities in before the final release of DeHackEd.
  167.  
  168.   F8    Thing List.  This is a Table version of the Thing editor.  It shows
  169.     only the most important Thing information, and is meant as a quick-
  170.     reference guide.
  171.  
  172.  
  173. 4. *** Ammo Editor
  174. \------====================
  175.  
  176.   Weapon Name:       The name of the weapon (not editable)
  177.   Ammo Type:         A pithy description.  This will be 'N/A' when an 
  178.     'unknown' ammo type is given for the Ammo Number.  Ammo type 5 is 
  179.     listed as "Unlimited".
  180.   Ammo Number:       0=bullets       3=rockets
  181.              1=shells        4= ??? (none)
  182.              2=cells         5=unlimited (fist/chainsaw)
  183.   Max ammo cap:      The starting capacity for the current type of ammo.  
  184.     It's listed on the right side of the slash on the status bar.  
  185.     Backpacks will double this limit automatically.  This will be 'N/A' 
  186.     for unknown ammo types.
  187.   Ammo per item:     How much ammo you get when you pick up a power-up of the 
  188.     current ammo type.  For example, normally the bullet power-up gives 
  189.     you 10 bullets.  This value is multiplied by 5 for the 'large' 
  190.     power-ups, i.e. boxes of rockets, boxes of shells, etc.  Different 
  191.     difficulty modes also change this.  Also 'N/A' for unknown types.
  192.   Bobbing1-3 frame:  Frame numbers for the bobbing weapon.  This is the
  193.     number that Doom refers to in the Frame list, for more information.
  194.   Shooting frame:    Frame played when the weapon shoots.
  195.   Firing frame:      Frame that actually shows the "flames" from the
  196.     weapon.
  197.  
  198.  
  199. 5. *** Thing Editor
  200. \------====================
  201.  
  202. a.  Thing fields
  203.  
  204.   This is the first thing you see when you start up DeHackEd.  It is also
  205.   one of the main areas of the program.  Edit Things by typing highlighting
  206.   the desired field and hitting Enter.
  207.  
  208.   Thing Number:      The number of the Thing.  Basically it's just for
  209.     reference, numbered in order according to how the Things are stored 
  210.     in the doom.exe file.  Note: these are different between 1.2 and 
  211.     1.6, because new Things have been added!
  212.   Thing Name:        A short descriptive name for the Thing.  This info
  213.     is NOT stored in the Doom.exe file, and thus you can't edit it, and 
  214.     it will always remain the same.  So a Thing #55 (the rocket launcher
  215.     in Doom 1.2) will always be described as a "Rocket Launcher", even if 
  216.     you change it to something entirely different, like a Cacodemon.
  217.   Thing ID#:         This is the Thing's 'identification number' which is 
  218.     used in level developement (WAD files).  Wherever this number appears 
  219.     in a WAD file, this Thing will appear.
  220.   Hit Points:        How much damage it can sustain.  For all non-living 
  221.     Things, it's generally 1000 (not necessary though).
  222.   Speed:             How fast it can go.  Projectiles have their speed
  223.     multiplied by 65536, but DeHackEd displays projectiles the same way 
  224.     it does normal speeds (so you don't need to wade though large numbers 
  225.     for projectile speeds).  Whether a certain is a projectile or not is
  226.     determined by bit #10, 'Projectile/player'.  If that bit is set, the
  227.     speed is displayed as a Projectile, otherwise it is a "normal" speed.
  228.     Basically though, just ignore it and DeHackEd will take care of it
  229.     for you.  :-)
  230.   Width:             The radius of the Thing is.  A narrow Thing is harder 
  231.     to hit!  Also multiplied by 65536, but DeHackEd handles the 
  232.     computations.  Also, to fit a Thing through a narrow passageway, you 
  233.     need to have the passage slightly wider than twice it's width.  Thus 
  234.     a passage must be 33 to allow the Marine through, even though his 
  235.     actual width is 16.
  236.   Height:            Same as width, but it's height.  Duh.  :-)
  237.   Missile Damage:    If it's a projectile, how much damage it does upon 
  238.     "death" (explosion).  Note that Lost Souls have this set to 3.
  239.   Reaction Time:     For monsters, their reaction time.  Lower=quicker to 
  240.     attack,  higher=slower to attack.
  241.   Pain Chance:       Chance out of 256 that a monster's action/attack will 
  242.     be interrupted by an injury.  The Lost Soul always will (256), and 
  243.     the Spider Boss very rarely will (40).
  244.   Mass:              Thing's mass.  Set a trooper's to 1 and watch him fly!  
  245.     Note the Cyberdemon has a high mass, and your rockets don't budge 
  246.     him much.
  247.   Bits:              This is the actual value of all of the bits.  Just
  248.     change this one number if you want to set all of the bits at once
  249.     to something.  See also the Bit fields portion of the text, coming
  250.     up in a few pages or so.
  251.  
  252.   SOUNDS
  253.   Alert:             Sound made when the monster first spots the player,
  254.     or a projectile is launched.  These all point to the sounds in the 
  255.     Sound table.
  256.   Attack:            Sound made during a close attack.
  257.   Pain:              Sound made when the Thing is injured.
  258.   Death:             Sound made when the Thing dies.  For projectiles and 
  259.     barrels, the sound of it's explosion.
  260.   Action:            Sound made when the Thing is just milling around.
  261.  
  262.   FRAMES
  263.   First Normal:      What an inactive thing looks like, or a monster that's 
  264.     not yet active.  All frame numbers refer to the Frame table.  Only
  265.     the first frame is listed, you will need to refer to that Frame
  266.     entry in the Frame table to find out if it's actually a sequence of
  267.     frames.
  268.   First Moving:      A movable Thing's "first steps."
  269.   Injury:            Frame played for an injured Thing.
  270.   Close Attack:      Attacks that are close (clawing imps).
  271.   Far Attack:        Attacks that are far away (imp winding up for a
  272.             fireball attack).
  273.   Death:             Monster death or barrel/projectile explosion.
  274.   Explode Death:     Exploding death (slop!) for players, troopers,
  275.             imps, and sargeants.
  276.   Respawn:           This is the frame that's shown when the Thing comes
  277.     back to life due to the ArchVile.  This field is only shown for 
  278.     Doom 1.6.
  279.  
  280.  
  281. b.  Bit Editor
  282.  
  283.    0.Gettable Thing:      Something that can be picked up by the player, like
  284.         an ammo clip.
  285.    1.Obstacle:            Something that can't be walked through.
  286.    2.Shootable Thing:     It will only take damage if this is set.  Note that
  287.         barrels also have this set.
  288.    3.Total Invisibility:  The Thing just can't be seen, no-how, no-way.  It
  289.         won't even show up with iddt-iddt.  The technical reason for this
  290.         is that it isn't included in the list of objects in the Sector, and
  291.         thus isn't even considered for drawing.
  292.    4.'Automatics':        From Jason Gorski:  "Okay well if you don't want
  293.         your weapons to auto-lock onto something set the automatics to yes."
  294.         Basically Things like PUFF, TFOG, BLUD, and projectiles.
  295.    5.Unknown              If you find out any Unknown bits, please let me know!
  296.    6.In Pain:             Used internally by the doom.exe to determine if a
  297.         monster is in pain or not.
  298.    7.Unknown
  299.    8.Hangs From Ceiling:  For those gory legs & mangled bodies.  Have it set,
  300.         well, if the Thing hangs from the ceiling!
  301.    9.No Gravity:          Used for floating monsters and Things that aren't on
  302.         the ground.
  303.   10.Proj/players:        Set for projectiles and players... ??
  304.   11.Can pick up items:   This Thing (like the player) can pick up Gettable
  305.         Things.
  306.   12.No Clipping:         Same effect as idspispopd, but also effective for
  307.         monsters.
  308.   13.Unknown
  309.   14.Floating:            For floating monsters, like the Cacodemon and the
  310.         Lost Soul.
  311.   15.Semi-No Clipping:    Kinda like idspispopd, kinda not.  You can't walk
  312.         through walls, or trigger any linedefs, but you can walk over any
  313.         height cliffs.
  314.   16.Projectiles:         Set for projectiles.
  315.   17.Disappearing Weapon: This is used for weapons such as the shotgun that
  316.         the sargeants use, so that it disappears when picked up in a multi-
  317.         player game.  Normal weapons do not have this set, however, because
  318.         they stick around in normal multi-player games when picked up.
  319.   18.Partial Invisibilty: The Spectre effect.
  320.   19.Blood (vs. puffs):   Whether a thing bleeds (bit off) or puffs (bit on)
  321.         when hit.  The barrel is the only default Thing that has this set.
  322.   20.Sliding Helpless:    ??  (Try setting this and bit 7??)
  323.   21.Unknown
  324.   22.Counts for Kill%     This Thing counts as part of the Kill% at the end
  325.         of the level.
  326.   23.Counts for Item%     Basically just like Kill%.
  327.   24.Unknown
  328.   25.Not in Deathmatch:   Things not present in Deathmatch mode, such as keys
  329.         and the normal "Player" starting spots (deathmatch spots are used
  330.         instead).
  331.   26.Color 1              00-greens->green        01-greens->browns
  332.   27.Color 2              10-greens->indigo       11-greens->dark red
  333.   28.Unknown
  334.   29.Unknown              Perhaps these are unused???
  335.   30.Unknown
  336.   31.Unknown
  337.  
  338. 6. *** Frame Editor
  339. \------====================
  340.  
  341.   This displays the majority of the Frame information.  Each frame has four
  342.   editable fields.  The only two fields that are NOT shown on the screen
  343.   are always 0 in all of the Frames.  Go figure.
  344.  
  345.   Frame #:            This is the number that is actually included
  346.         in the Thing FRAME fields.
  347.   Name:               A lookup done on the Text info in the doom.exe file,
  348.         specified by a reference to the Sprite #, the Sprite Table, and
  349.         the Sprite subnumber.
  350.   Sprite #:           The sprite that is shown for this Frame.
  351.   Sprite Sub #:       The individual "picture" (for lack of a better
  352.         word... I think the technical term is "lump") suffix for this Frame.
  353.         In the Doom.wad, there is (for example) a Sprite called TROO, for the
  354.         trooper.  The sub # specifies which TROO picture to use... TROOA,
  355.         TROOB, TROOC, etc.
  356.   Bright Sprite:      This check box is not actually included in the
  357.         Doom.exe file.  The Sprite subnumber is multiplied by 32768 if the
  358.         Sprite is to always be displayed at it's full brightness.  I've
  359.         just changed that into a check box to make it easier to make a
  360.         Sprite bright, or not-bright.  Sprites that are always displayed
  361.         at their full brightness are Lost Souls, plasma bullets, etc... they
  362.         are always visible no matter what the lighting is.
  363.   Next Frame #:       Which Frame to play next.  You can skip a few shotgun
  364.         frames this way, to make the super-fast ("combat") shotgun.
  365.   Duration:           How long the frame stays on the screen.  Make 'em
  366.         all 1 to make the super fast shotgun *really* be super fast!  Notice
  367.         that the notoriously slow BFG has a value of 20 and 10 for a few of
  368.         its Frames.  (hint hint... =)
  369.   Code pointer:       An offset in the doom.exe file to where it should
  370.         look for the "action" associated with this Frame.  It appears after
  371.         more digging that this value is really useless.  The actual location
  372.         in the code is specified by a relocation table elsewhere in the
  373.         doom.exe, which is referred to instead of the code pointer.
  374.  
  375.  
  376.   That's about it.  Any more question?  Feel free to write me at
  377.     gregory.lewis@umich.edu
  378. for more information.  Have fun!
  379.