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