home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR2 / DK2MAP11.ZIP / DUKE2MAP.DOC < prev    next >
Text File  |  1994-01-22  |  11KB  |  246 lines
  1. █▓▒░ DUKE2MAP Version 1.1 Documentation
  2.      Copyright 1994 David Bollinger
  3.  
  4.  
  5. █▓▒░ INTRODUCTION
  6.  
  7.      Duke2Map is a utility for displaying the maps of Apogee Software's
  8.      Duke Nukem 2.  It is fully user-configurable and can therefore be
  9.      set up to provide any level of detail required.  It is NOT an editor.
  10.  
  11.  
  12. █▓▒░ INSTALLATION
  13.  
  14.      Copy the Duke2Map files into the same directory as Duke Nukem 2.
  15.      Alternatively, place the original .ZIP file in your Duke Nukem 2
  16.      directory and unzip the file to the current directory.  The program
  17.      must be run from this directory.
  18.  
  19.  
  20. █▓▒░ FILES
  21.  
  22.      DUKE2MAP.EXE     the executable program
  23.      DUKE2MAP.DOC     this documentation file
  24.      ACTOR.D2M        configuration file
  25.      CZONE1.D2M       configuration file
  26.      CZONE2.D2M       configuration file
  27.      CZONE3.D2M       configuration file
  28.      CZONE4.D2M       configuration file
  29.      CZONE5.D2M       configuration file
  30.      CZONE6.D2M       configuration file
  31.      CZONE7.D2M       configuration file
  32.      CZONE8.D2M       configuration file
  33.      CZONE9.D2M       configuration file
  34.      CZONEA.D2M       configuration file
  35.      CZONEB.D2M       configuration file
  36.      CZONEC.D2M       configuration file
  37.      CZONED.D2M       configuration file
  38.      CZONEE.D2M       configuration file
  39.      256X128.LJ4      sample printer configuration file for HP LaserJet 4
  40.      128X256.LJ4      sample printer configuration file for HP LaserJet 4
  41.  
  42.  
  43. █▓▒░ INSTRUCTIONS
  44.  
  45.      From your Duke Nukem 2 directory type DUKE2MAP to start the program.
  46.      Within a few seconds the map of level 1 should be displayed on screen.
  47.  
  48.      Possible problems:
  49.      No map displayed  :  Verify that the program is installed in the same
  50.                           directory as Duke Nukem 2. In particular, verify
  51.                           that the file NUKEM2.CMP is in this directory.
  52.      Random map display:  Verify that all config files are located in the
  53.                           same directory as Duke Nukem 2.  In particular,
  54.                           verify that the CZONE?.D2M file that matches the
  55.                           status line display is in this directory.
  56.  
  57.  
  58.      Controls   : arrow keys - scroll the screen through the level
  59.                   A          - toggle actor display on/off
  60.                   F          - write map to file EP#LV#.MAP
  61.                   L          - load a level, enter the episode (1-4)
  62.                                and the level (1-8) on the status line
  63.                   T          - toggle display between actor/level information
  64.                                on the status line
  65.                   V          - display a very rough overview map on a VGA
  66.                                screen.  (note that the map may be split in
  67.                                order to fit it on screen).  once displayed,
  68.                                press any key to return to regular display.
  69.                   Esc        - quit
  70.  
  71.  
  72.      Status Line: ACTOR/LEVEL- indicates if ACTOR or LEVEL data is displayed
  73.                   Episode    - which episode is currently displayed
  74.                   Level      - which level is currently displayed
  75.                   CZ         - the CZONE graphics file used on this level
  76.                   ObID       - the object ID# of the object at the cursor
  77.                   X,Y        - the map coordinates of the cursor
  78.  
  79.      Map File   : The maps of Duke Nukem 2 come in several different sizes,
  80.                   all of which are quite large, and therefore printing the
  81.                   maps becomes quite a challenge.  As a work-around, this
  82.                   program will save the map to a file.  It is then left to
  83.                   your imagination to figure out how to print this file on
  84.                   your particular printer.  If you are fortunate enough to
  85.                   have access to a HP LaserJet 4 you may use the supplied
  86.                   control files 256X128.LJ4 and 128X256.LJ4 to setup your
  87.                   printer in a mode which will print most level files on a
  88.                   single page (although in microscopic print).  The
  89.                   following commands should accomplish this:
  90.  
  91.                        COPY 256X128.LJ4 LPT1
  92.                            (or COPY 128X256.LJ4 LPT1, depending on map size)
  93.                        COPY EP#LV#.MAP LPT1
  94.  
  95.                   Sorry I haven't come up with a better solution yet.
  96.  
  97.                   1.1 - Perhaps the VGA display screen could be captured and
  98.                         printed from a graphics program to provide a rough
  99.                         overview map.
  100.  
  101.      Misc.      : Note that although all objects only require a single
  102.                   map position for storage, most of them appear much larger
  103.                   within the game.
  104.  
  105.  
  106. █▓▒░ DISPLAY & CONFIGURATION FILE:
  107.  
  108.      For those who are brave of heart, you may experiment with modifying
  109.      the configuration files.  Since I expect only the most hardened
  110.      hackers to have the determination to undertake this torture, the
  111.      following discussion is rather technical and assumes familiarity
  112.      with hex notation.
  113.  
  114.      First, a few definitions:
  115.  
  116.      EPISODE  : A collection of levels
  117.      LEVEL    : A single map within an episode
  118.      CZONE    : The graphics file associated with a level
  119.      OBJECT   : any single map object within a level
  120.      OBJECT ID: The 4 digit hex code that identifies a map object
  121.  
  122.      There are two types of objects:
  123.      level objects : the "dead" physical elements of Duke's world
  124.      actor objects : the active critters and things; the fun things
  125.  
  126.      Actor objects are common throughout the game, and are defined within
  127.      a single configuration file ACTOR.D2M.  The level objects vary depending
  128.      on the CZONE of the current LEVEL, and therefore require separate
  129.      configuration files, for example CZONE1.D2M, CZONE2.D2M, etc.
  130.  
  131.      Decoding for display:
  132.  
  133.      In order to display the map data on screen it must first be decoded
  134.      into a more meaningful set of display characters.  The decoding process
  135.      is based on a set of default character mappings which may be overridden
  136.      through the configuration files CZONE#.D2M and ACTOR.D2M.  The decoding
  137.      proceeds as follows:
  138.  
  139.      I.  ACTOR CONFIG FILE:
  140.          A.  DEFAULTS:  By default an actor object will map to the display
  141.              character whose ASCII code is the object's shape.
  142.          B.  An entry within the ACTOR configuration file will cause all
  143.              actor objects which match the specified range to map to the
  144.              specified display character.
  145.  
  146.      II. CZONE CONFIG FILES:
  147.           A.  DEFAULTS:
  148.               1.  When a configuration file is not found:  By default a level
  149.                   object will map to the display character whose ASCII code
  150.                   is the object's type.
  151.               2.  When a configuration file is found:  By default a level
  152.                   object will appear blank.
  153.           B.  An entry within the appropriate CZONE configuration file will
  154.               cause all level objects which match the specified range to
  155.               map to the specified display character.
  156.  
  157.  
  158. █▓▒░ TECHNICAL SPECIFICATION OF CONFIGURATION FILE FORMAT
  159.  
  160.      1.  The configuration file is a standard ASCII document.
  161.  
  162.      2.  Lines cannot contain leading spaces.
  163.  
  164.      3.  A semicolon in the first character position indicates a comment
  165.          line that will be ignored.
  166.  
  167.      4.  Any additional characters following the required data on any line
  168.          will be treated as a comment.  A semicolon is not strictly required
  169.          to identify this text as a comment, but it is perhaps stylistically
  170.          more pleasing.
  171.  
  172.      5.  All numeric values are specified in hex notation.
  173.          Case is not significant, although consistency improves readability.
  174.  
  175.      6.  All configuration files recognize the following formats:
  176.  
  177.          OBID BF C        ; to specify a single object
  178.          OBID - obid BF C ; to specify a range of objects
  179.  
  180.          Where "OBID" is an object ID
  181.            and "obid" is an object ID >= "OBID"
  182.            and "BF"   is a color attribute
  183.                          the first digit is the Background color
  184.                          the second digit is the Foreground color
  185.            and "C"    is a display character
  186.  
  187.          example: 1000 - 1FF8 1F ░
  188.                   will display all objects with an object ID between 1000
  189.                   (hex) and 1FF8 (hex) as a white on blue block character.
  190.  
  191.  
  192. █▓▒░ EXAMPLES/SUGGESTIONS/RECOMMENDATIONS FOR CONFIGURATION FILE ENTRIES
  193.  
  194.      =========================================================================
  195.      Display character general recommendations for level objects
  196.      space  -  insignificant background (or foreground)
  197.        ░    -  significant background, helps define look of the level
  198.        ▒    -  semi-solids, such as those that can be walked through and
  199.                yet stood upon, or to distinguish different types of solids
  200.        ▓    -  completely solid objects, cannot move through these objects
  201.      -------------------------------------------------------------------------
  202.      Avoid using the full solid block character █ (219 dec) for level objects
  203.      since it makes it more difficult to identify the actor box objects ▄
  204.      (220 dec).   Unless, of course, you change the box object characters
  205.      as well.
  206.      -------------------------------------------------------------------------
  207.      The config file is processed sequentially - decode ranges should begin
  208.      with the most general and proceed to the most specific.  Otherwise, the
  209.      specific decodes will be overwritten by the general decodes.  See the
  210.      first decode line of the supplied ACTOR config file for an example.
  211.      -------------------------------------------------------------------------
  212.  
  213. █▓▒░ MISCELLANEOUS
  214.  
  215.      This program may be freely distributed in its original form.
  216.      This program is provided without any warranties, expressed or implied.
  217.  
  218.      This is neither a product of, nor supported by, Apogee Software.
  219.      The author of this program is not affilliated with Apogee Software.
  220.      This program is not approved for any use by Apogee Software.
  221.      All trademarks are the property of their respective owners.
  222.  
  223.      (If you have problems with this program, please don't bother Apogee.)
  224.  
  225.      Please send comments/suggestions to:
  226.  
  227.                              David Bollinger
  228.                              PO Box 894
  229.                              Denair, CA  95316
  230.  
  231.                              or
  232.  
  233.                              CompuServe ID  72510,3623
  234.  
  235. █▓▒░ REVISION HISTORY
  236.  
  237.      1.0  01/04/94.  First release.  Works only on shareware episode 1
  238.  
  239.      1.1  01/24/94.  Added support for all 4 episodes.  Changed level loading
  240.                      keys.  When writing map file to disk the display actor
  241.                      toggle is checked, allowing map files of only level
  242.                      objects to be created.  Added VGA overview map, changed
  243.                      some object colors so they are more distinguishable on
  244.                      VGA map.
  245.  
  246.