home *** CD-ROM | disk | FTP | other *** search
/ Game Killer / Game_Killer.bin / 719.DUKEEDIT.DOC < prev    next >
Text File  |  1992-10-19  |  18KB  |  392 lines

  1. █▓▒░ DukeEdit    Version 1.1    Documentation
  2.  
  3.      DukeEdit is (C) Copyright 1992 David Bollinger.
  4.      Duke Nukem is (C) Copyright 1991 Apogee Software.
  5.  
  6.  
  7.      What is "DukeEdit" ?
  8.         DukeEdit is a tool that allows you to view, edit and print the game 
  9.      maps of Apogee Software's Duke Nukem.  It will allow you to modify
  10.      existing levels or create completely new levels from scratch.  It will
  11.      work on all the levels of all three episodes of Duke Nukem.  It allows
  12.      you to edit two levels at once and supports cut and paste editing.  It
  13.      contains a complete reference describing every object in the Duke Nukem
  14.      world, and will support any printer capable of compressed mode printing.
  15.  
  16.      Unfortunately, due to the complexity of the game maps this tool is not
  17.      recommended for casual gamers.  It is intended primarily for experienced
  18.      computer users who would like to expand the worlds of Duke.
  19.  
  20.  
  21.      What about "DukeMap" ?
  22.         DukeMap was written approximately one year ago as the first utility
  23.      for viewing and printing the game maps of Duke Nukem.  It served its
  24.      purpose, but has since evolved into DukeEdit.  DukeEdit contains all
  25.      the features of DukeMap (minus several known bugs) while offering a
  26.      more detailed screen display and complete editing capabilities.
  27.  
  28.  
  29.      How to use DukeEdit:
  30.         1.  If you do not yet have a copy of Duke Nukem, get it!
  31.         2.  Register your copy with Apogee Software!
  32.         3.  Place the DukeEdit files in your Duke Nukem subdirectory.
  33.         4.  Type 'DukeEdit' from the command line.
  34.         5.  Register your copy of DukeEdit.
  35.  
  36.  
  37.      NOTE: DukeEdit requires an EGA or VGA display.
  38.  
  39.  
  40.      After loading, DukeEdit will attempt to load level one from episode
  41.      one.  If this level is present it will be displayed on the screen.
  42.      If this level is not present the screen will be blank.  You may
  43.      select a different episode or level by pressing 'L.'  If you are 
  44.      unable to load any levels press [Esc] to exit and verify that you
  45.      have installed DukeEdit in the appropriate directory.
  46.  
  47.  
  48. █▓▒░ THE DISPLAY
  49.  
  50.      Hopefully the symbols used on the screen maps are self-evident.
  51.      Most of them at least superficially resemble their counterparts in
  52.      the game.
  53.  
  54.      Some of the objects (such as jump boots, etc.) are displayed on screen
  55.      as the object itself, even though in the game the object is contained
  56.      within a grey disk.  This is for clarity - grey disks contain important
  57.      items and a screen full of grey disks is not very informative.
  58.  
  59.      On the other hand, treasure items contained within blue disks are simply
  60.      displayed as blue disks.  No point cluttering up the screen with lots
  61.      of extraneous symbols.  The free-standing treasures however are shown
  62.      as the actual object.  Red disks are similarly displayed.
  63.  
  64.      The status bar at the bottom of the screen contains the following info:
  65.           1.  The current editing screen (1 or 2)
  66.           2.  The current episode (1-9)
  67.           3.  The current level (1-9,A-C)
  68.           4.  The current shape and type
  69.           5.  The current cursor position
  70.  
  71.  
  72. █▓▒░ EDITING:
  73.  
  74.      Warning:  The world of Duke Nukem is a large and detailed place.
  75.      Editing this world requires both patience and persistence.
  76.      It will also probably require a great deal of experimentation - 
  77.           but hey, that's half the fun isn't it ?!
  78.  
  79.  
  80.      OBJECTS:
  81.      Each level of Duke Nukem is 128 units wide and 90 units tall.
  82.      At the bottom of the screen are two numbers labeled "XY:"
  83.      which allow you to keep track of your current location within the
  84.      level.  Note that the coordinates begin at 0  (0-127, 0-89).
  85.  
  86.      Each location within the level can contain one of many different
  87.      objects.  These objects are defined by two numbers:  SHAPE and TYPE.
  88.      These values are also displayed at the bottom of the screen and
  89.      indicate the shape and type of the object that the cursor is currently
  90.      positioned on.  Note that these values are in hexadecimal notation
  91.      (base 16).  This format was chosen because it most closely matches
  92.      the internal organization of objects used by Duke Nukem.  I apologize
  93.      if you are not fluent in hex, but decimal would have been much worse.
  94.  
  95.      SHAPE is a number in the range 00h - 30h that describes the overall
  96.      function of the object.  For example, is it background or a solid
  97.      object?
  98.  
  99.      TYPE is a number in the range 00h - E0h (usually) that describes the
  100.      object specifically.  If it is a solid object TYPE will tell you
  101.      what that object looks like.  For example, is it brick or stone?
  102.  
  103.      As you use the editor you will notice that it forbids you from
  104.      generating certain combinations of SHAPE and TYPE.  This is normal,
  105.      certain combinations are just not valid (or at least not useful).
  106.      I had to make a tradeoff in design on this point between ease-of-use
  107.      and mess-around-ability.  Ease-of-use won.
  108.  
  109.      A complete listing of SHAPES and TYPES is available in the
  110.      file DUKEEDIT.S&T.  I recommend that you print a copy of this list
  111.      before you begin editing.  In summary, you will find the following 5
  112.      categories of SHAPES:
  113.  
  114.           SHAPE #          WHAT IS IT?
  115.           -------          ------------------------
  116.             00             Empty
  117.           01 - 05          Flashers (blinky things)
  118.           06 - 17          Background (Duke can move through these)
  119.           18 - 2F          Solids (Duke cannot move through these)
  120.             30             Active Objects (This is all the fun stuff -
  121.                             incl. Duke himself, badguys, health, treasure...
  122.  
  123.      If the descriptions provided in DUKEEDIT.S&T are not adequate (and
  124.      I admit that some of these objects were difficult to describe in
  125.      words) you may wish to explore the included level WORLDAL1.S&T.  This
  126.      level is nothing more than a "shopping mall" of available non-active
  127.      objects.  They are arranged and grouped in order by SHAPE and TYPE number.
  128.  
  129.      The following commands will allow you to use WORLDAL1.S&T with
  130.      Duke Nukem (these commands assume you are using episode 1):
  131.           RENAME WORLDAL1.DN1 WORLDAL1.BAK
  132.           RENAME WORLDAL1.S&T WORLDAL1.DN1
  133.  
  134.  
  135.      KEYS     FUNCTION
  136.      ------   ---------------------------------------------
  137.      Arrows   move around
  138.  
  139.      Home     increments the current shape
  140.      End      decrements the current shape
  141.      PgUp     increments the current type
  142.      PgDn     decrements the current type
  143.  
  144.      Space    repeats last used object (see below)
  145.      Enter    sets last used object (see below)
  146.  
  147.      Ins      marks and cuts into buffer (see below)
  148.      Del      pastes from buffer (see below)
  149.  
  150.      L        load a level
  151.      P        print the currently loaded level
  152.      R        rename current level
  153.      S        save the current level
  154.  
  155.      T        toggle between edit screen 1 and 2
  156.  
  157.      Ctrl-X   clears entire level (prompts before clearing)
  158.  
  159.      F1       display help screen listing key functions
  160.  
  161.      Esc      quit DukeEdit (prompts before exiting)
  162.      ------------------------------------------------------
  163.  
  164.      Notes on keys:
  165.  
  166.      The load and save functions allow you to select from 9 different
  167.      episodes.  Be aware that the 3 episodes of Duke Nukem only recognize
  168.      a single episode.  The extra episodes are provided as working storage
  169.      locations for you.  In order to actually play any level of an episode
  170.      numbered above 3 you will have to rename it as appropriate.  The
  171.      rename function will accomplish this.  Once a level has been loaded
  172.      you may rename it to another episode or level before saving it.
  173.  
  174.      Each time you edit an object the program remembers that object.
  175.      The space bar allows you to later recall that object with a single
  176.      keystroke and place it at the current cursor location.  The Enter key
  177.      is in effect the opposite of the space bar: it sets the repeatable
  178.      object to the object at the current cursor location.  The Enter key
  179.      allows you to "pick up" existing objects for duplication.
  180.  
  181.      To copy more than a single object you must use the buffer commands:
  182.  
  183.      The Insert key can be used to copy a region into a temporary buffer.
  184.      Press Insert once to mark the first corner of the region.  Now define
  185.      the region by moving around with the arrow keys (the region will be
  186.      highlighted).  Pressing Insert a second time will complete the
  187.      operation.  Pressing Escape before pressing Insert a second time will
  188.      cancel the operation.
  189.  
  190.      The temporary buffer can be retrieved by pressing the Delete key.
  191.      The current cursor position defines the upper left corner of the
  192.      pasted block.  If there is insufficient room to perform the paste
  193.      a warning will be issued and the operation will be cancelled.
  194.      Note: pasting cannot be undone.
  195.  
  196.      I might suggest using the buffer to build a "library" level of
  197.      commonly used groups of objects.  Keep the library loaded in edit
  198.      screen 2, then while editing a new level on screen 1 you can cut and
  199.      paste from the library.
  200.  
  201.      Note: Delete was chosen as the paste key rather than Insert only because
  202.      it is usually a physically smaller key.  I believe that destructive keys
  203.      ought to be harder to get at than constructive keys.
  204.  
  205.      Ctrl-X clears the entire level.  It will ask for confirmation before
  206.      executing.
  207.  
  208.  
  209. █▓▒░ DESIGN GUIDELINES
  210.      Duke Nukem is amazingly forgiving in terms of the errors it will
  211.      allow in its level datafiles.  However, a well designed level will
  212.      obey the following guidelines:
  213.  
  214.      1.  Place one and only one Duke in each level.
  215.      2.  Place one and only one exit door in each level.
  216.      3.  Do not allow Duke to walk off the left or right sides of the level.
  217.      4.  Do not allow Duke to move below line 86 or above line 3.
  218.      5.  If you use the conveyor belts, make sure that the ends are
  219.          properly matched.
  220.      6.  If you use the teleporters, make sure that you use one and only one
  221.          of each type (there are two teleporters).
  222.      7.  Special objects such as the jump boots, grappling hook, robot glove,
  223.          etc., should not be duplicated within a level.
  224.      8.  Duke is 2 units tall although his object occupies only one unit.
  225.          The space just above Duke should be empty.  All paths that Duke is
  226.          expected to take must be at least two units tall.
  227.      9.  Several other objects also occupy more than 1 unit - allow room:
  228.          fans, teleporters, large techbots, rockets, reactor, etc.
  229.      10. Duke can only jump 3 units vertically, 4 with jump boots.  He can
  230.          jump 7 units horizontally, 8 with jump boots - and further if the
  231.          destination is below him.  Make sure he can reach his destination.
  232.      11. If you use keys, make sure that keys, keyholes and doors are
  233.          matched up logically.
  234.      12. If you use the duplicators (S&T #'s 3025, 3026, 3027) be aware that
  235.          they can function as either background or solid objects depending
  236.          on what they are next to.  Make sure they work the way you expect.
  237.      13. If you use the extension floor, make sure that it has something to
  238.          "run into" to stop its extension.
  239.      14. Place Dr. Proton only in the last level of an episode.
  240.  
  241.      The editor will not prevent you from disobeying these guidelines,
  242.      use common sense.  Typically if Duke Nukem finds too many of any given
  243.      object in a level it will remove them, beginning at the top left, leaving
  244.      the only the lower right copy.  If objects don't match up properly they
  245.      will probably simply not work.
  246.  
  247.  
  248. █▓▒░ PRINTING
  249.      
  250.      The maps used in Duke Nukem are too wide to fit on 8-1/2 x 11 paper
  251.      unless compressed printing is used.  DukeEdit will automatically set
  252.      your printer to compressed mode before printing if it finds a file
  253.      called DUKEEDIT.PTR that contains the escape sequence appropriate
  254.      for your printer.  The setup file included supports Epson and IBM
  255.      compatible printers that can be switched into compressed mode with
  256.      the sequence: \027\014  or  <ESC><SI>.
  257.  
  258.      The file DUKEEDIT.LSR contains the escape sequence for setting a
  259.      Hewlett-Packard Laserjet into compressed mode.  The following DOS
  260.      commands will make this file the active printer configuration:
  261.           RENAME DUKEEDIT.PTR DUKEEDIT.IBM
  262.           RENAME DUKEEDIT.LSR DUKEEDIT.PTR
  263.  
  264.      Other printers can be supported by inserting their commands with a 
  265.      text editor.  Or you may put your printer into compressed mode
  266.      manually.
  267.  
  268.      If you have a wide-carriage printer you can safely ignore all of
  269.      the above; the maps will fit perfectly at 10 CPI.
  270.  
  271.      NOTE:
  272.      Since the map is printed using text characters, which are not square,
  273.      the aspect ratio of the maps will be distored - they will appear to
  274.      be taller than they actually are.  This problem is more noticeable
  275.      on narrow-carriage printers.
  276.  
  277.  
  278.      The following symbols are used on the printed maps:
  279.  
  280.           ╬      Duke's starting position
  281.           ¥      Techbot - Badguy
  282.           c      Camera
  283.           ▓ ▒ ░  Various walls/floors/solid objects
  284.           < >    Conveyor belts
  285.           *      Spike ball (bouncing/exploding)
  286.           ┴ ┬    Spikes
  287.           ■      Various goodies, treasure
  288.           DUKE   Collect the letters
  289.           ∞      Health items (pepsi, drumstick, molecule)
  290.           ⌐      Gun, increased firepower
  291.           ≈      Flamejet
  292.           ≡      Electric field
  293.           k      Key
  294.           Φ      Keyhole
  295.           ║      Key operated door
  296.           X      Exit door
  297.           ─      Psuedo-floor generator
  298.           A      Rocket
  299.           S      Fan
  300.           Ω      Teleporter
  301.           ^      Elevator
  302.  
  303.      Notes:  Background objects are not displayed on the printed maps.
  304.              The duplicators are displayed as very light solid objects -
  305.              depending on their placement they may be simply background.
  306.  
  307.  
  308.  
  309. █▓▒░ LEGAL STUFF:
  310.  
  311.      DukeEdit is (C) Copyright 1992 David Bollinger, All Rights Reserved.
  312.  
  313.      Disclaimer:
  314.      The author makes no representations or warranties with respect to
  315.      this software or documentation, and specifically disclaims any
  316.      express or implied warranties of merchantability or fitness for
  317.      any purpose.  Further the author reserves the right to make changes
  318.      to any and all parts of the software, at any time, without obligations
  319.      to notify any person or organizations.  The author will not be
  320.      liable for any special, incidental, consequential, indirect or
  321.      similar damages due to loss of data or any other reason even if the
  322.      author has been advised of the possibility of such damages.  In no
  323.      event shall the author's liability for any damages ever exceed the
  324.      price paid for the license to use the software, regardless of the
  325.      form of the claim.
  326.  
  327.      Further the author is in no way affiliated with Apogee Software.
  328.      All programs and datafiles contained herein are original works
  329.      of authorship.  None of the programs or datafiles contained herein
  330.      shall be distributed with any of Apogee Software's products, nor
  331.      shall they be represented as having been approved for any use by
  332.      Apogee Software.
  333.  
  334.  
  335. █▓▒░ ETCETERA:
  336.  
  337.      DukeEdit is distributed as shareware and may be freely distributed
  338.      provided that all of the original files are included and have not
  339.      been modified or altered in any way.  This software may not be sold.
  340.      However, a reasonable service charge (not to exceed $7) may be asked in
  341.      order to cover handling and/or materials costs.
  342.  
  343.      This release of DukeEdit consists of the following files:
  344.           DUKEEDIT.EXE
  345.           DUKEEDIT.DOC
  346.           DUKEEDIT.S&T
  347.           DUKEEDIT.PTR
  348.           DUKEEDIT.LSR
  349.           WORLDAL1.S&T
  350.  
  351.  
  352.      If you use and enjoy this program I encourage you to support the
  353.      shareware concept by sending U.S. $10.00 to:
  354.  
  355.                                 David Bollinger
  356.                                 P.O. Box 894
  357.                                 Denair, CA  95316
  358.  
  359.  
  360.      In return you will receive the latest version of the program (please
  361.      specify 3 1/2" or 5 1/4" disks) as well as any levels that either I
  362.      have created or that have been submitted by other users.
  363.  
  364.      I heartily welcome all submissions of any levels that you may create.
  365.      I personally enjoy this game a great deal, and love exploring new
  366.      worlds created by other people.  All levels that are playable will
  367.      be shipped out with the registered version of the program so that
  368.      other users will also benefit from your creativity.  Appropriate
  369.      credit for design will be included in this .DOC file.
  370.  
  371.      I also welcome all comments and suggestions.
  372.  
  373. █▓▒░ RELEASE NOTES Version 1.1 11/15/92
  374.  
  375.      1.  Version 1.1 is the first publicly available version of DukeEdit.
  376.      2.  DukeEdit was written with Borland C++ 3.0 and Turbo Assembler 2.0.
  377.      3.  DukeEdit correctly identifies all teleporters.  (DukeMap did not).
  378.      4.  Under cetain circumstances, DukeMap would crash while printing if the
  379.          printer was not ready.  This has been corrected in DukeEdit.
  380.  
  381.  
  382.      (Note:  Certain shareware distributors require that instructional or
  383.       identification material be appended to the documentation file or
  384.       placed in a separate file to be included with the original program
  385.       files.  The author grants permission for this documentation file to
  386.       be modified for this purpose provided that the original text is left
  387.       intact.  The author also grants permission for additional files to be
  388.       included for this purpose provided that they are clearly identified as
  389.       not being part of the original program.)
  390.  
  391.  
  392.