home *** CD-ROM | disk | FTP | other *** search
/ Zodiac Super OZ / MEDIADEPOT.ISO / FILES / 06 / REX210.ZIP / MAPEDIT.DOC < prev    next >
Text File  |  1995-02-02  |  12KB  |  245 lines
  1.  
  2. Imperium Rex World Map Editor (MAPEDIT) v1.0 Documentation
  3. ----------------------------------------------------------
  4. Copyright (c) 1994 Brainstorm Software
  5.  
  6.  
  7. 0. PRELIMINARIES
  8.  
  9. MAPEDIT has been developed in its entirety by Glenn Robins.
  10. This is FREEWARE but cannot be distributed separately from the Imperium Rex
  11. v2.00 software package - see LICENSE.TXT.
  12.  
  13.  
  14. CONTENTS
  15.  
  16.      1. HARDWARE REQUIREMENTS
  17.      2. RELATED FILES
  18.      3. DESCRIPTION AND FUNCTIONALITY
  19.           3.1  WORLD MENU FUNCTIONS
  20.           3.2  REGION MENU FUNCTIONS
  21.      4. CLOSING COMMENTS
  22.      
  23.  
  24. 1. HARDWARE REQUIREMENTS
  25.  
  26.      - Any 80x86 processor (of course, the faster the better).
  27.      - About 200K of conventional RAM.
  28.      - No sounds are generated, so you donÆt even need a PC speaker!  (This
  29.      way, you are less likely to be caught by your boss at work while
  30.      drawing up a map).
  31.      - Colour monitor.
  32.      - VGA with 512K of video memory for support of 320x200x256 mode.
  33.      - Mouse is required, with a recent mouse driver (last few years).
  34.      
  35.  
  36. 2. RELATED FILES
  37.  
  38.      The following files constitute the map editor program:
  39.      
  40.      MAPEDIT .EXE   - Map editor
  41.      MAPEDIT .VML   - Graphics library
  42.      MAPEDIT .BML   - Graphics library
  43.      MAPEDIT .FNT   - Character font
  44.      MAPEDIT .DOC   - Program documentation
  45.      
  46.      
  47. 3. DESCRIPTION AND FUNCTIONALITY
  48.  
  49.      This is an enhanced world map editor with more functionality than the
  50.      one built into the Game Manager/Editor (REXEDIT).  It allows you to
  51.      edit the map on a grid while simultaneously viewing the 1:1 scale map
  52.      in another window, and also provides the ability to copy sections of
  53.      the map to file which may then be imported into another map.
  54.      
  55.      The program is completely mouse-driven, and so a Microsoft or Mouse
  56.      Systems mouse must be installed and usable.  NO KEYBOARD INPUT WILL BE
  57.      ACCEPTED, except for entering filenames.  Therefore, do not run the
  58.      program without a mouse - if you do, you will have to reboot to exit.
  59.      
  60.      You may not reference any files that exist outside the default
  61.      directory when loading or saving.  You should then make sure that
  62.      there will be enough disk space for saving, and that all files that
  63.      need to be accessible are in the default startup directory.
  64.      
  65.      Once started, the program will enter SURFACE PLOTTING MODE, where
  66.      clicking the LEFT button on the map grid will place the selected
  67.      surface (indicated at the bottom right); and clicking the RIGHT button
  68.      anywhere will select a different surface type to assign to the
  69.      "plotting pen" (the mouse cursor).  All button controls, such as the
  70.      scrolling buttons, surface type buttons, and the menu item buttons,
  71.      are all available for selection in this mode.  Note that you may hold
  72.      down the LEFT button to manually "paint" an area on the grid.
  73.      
  74.      The map grid view may be moved by using either the scroll buttons, or
  75.      by clicking in the 1:1 scale map window at the top right.  The black
  76.      box in this window indicates the viewing area of the map grid.  This
  77.      box may be dragged around the map by holding down the LEFT button,
  78.      which continually updates the map grid viewing area.  Since the
  79.      location pointed to by the mouse cursor corresponds to the upper left
  80.      corner of the viewing box, moving this box to for example the bottom
  81.      right corner will require holding down the LEFT button and dragging
  82.      the viewing box to the corner.  Note that once you press and hold the
  83.      LEFT button in the map window, you may move the mouse cursor anywhere
  84.      and the viewing box will try to follow.
  85.      
  86.      The other types of boxes that will at some time appear superimposed on
  87.      the map window are region selection boxes, which are yellow; and copy
  88.      destination boxes, which are white.  These boxes also appear in the
  89.      map grid viewing area (but of course may exceed the boundaries of the
  90.      viewport).  Selecting the size and position of these boxes can only be
  91.      done in the map grid viewing area, and not in the 1:1 scale map
  92.      window.
  93.      
  94.      The colour scheme used for surface types is consistent with that used
  95.      in REX and REXEDIT.  The icons representing the surfaces are a little
  96.      different, due to the degradation in display resolution.
  97.      
  98.      Note that on-line help is not provided, mainly because MAPEDIT is
  99.      supposed to be easy to use and understand with the help of this
  100.      manual!
  101.      
  102.      3.1  WORLD MENU FUNCTIONS
  103.      
  104.           LOAD
  105.                Loads a new world map into memory from file.  The map file
  106.                must be selected from a file list, which may be cancelled by
  107.                clicking the RIGHT button.  This command may also double as
  108.                a directory command, so long as you remember to abort.  If
  109.                changes were made since last saving, you will be alerted.
  110.                
  111.           SAVE
  112.                Saves the world map in memory to file.  The map filename
  113.                must be entered manually, without a path reference.  This
  114.                may be aborted by hitting ESCAPE or clicking the RIGHT
  115.                button.  Clicking the LEFT button while in the filename
  116.                input field acts like a RETURN and accepts the input.  You
  117.                will be alerted if the file exists and may then choose to
  118.                cancel, or replace.
  119.           
  120.           CLEAR
  121.                This will clear the current map in memory to WATER.  If
  122.                changes were made since last saving, you will be alerted.
  123.                
  124.           STATS
  125.                Presents a window showing surface coverage broken down in
  126.                percentage by type, as well as free memory and disk space on
  127.                the default drive.  The percentages were rigged to add up to
  128.                100% to compensate for integer rounding errors, and so
  129.                percentages that are really small (on the order of 0.1%) may
  130.                not be accurate.
  131.                
  132.           QUIT
  133.                Quits program.  You will be alerted first if changes were
  134.                made since last save.
  135.                
  136.                
  137.      3.2  REGION MENU FUNCTIONS
  138.      
  139.           SELECT
  140.                Press this button to change mode to area selection.  In this
  141.                mode, you will be asked to select the top left corner of the
  142.                region.  At this point, you may either click on the button
  143.                again (which releases it) to clear the current region
  144.                selection (if any) and abort the procedure; or you may
  145.                select the bottom right corner of the region of interest.
  146.                The region will be surrounded by a yellow outline box.
  147.                
  148.                Region selection is necessary for the SAVE, FILL and COPY
  149.                functions.
  150.                
  151.                As stated above, this function also doubles as a region
  152.                selection CLEAR command by double-clicking on the SELECT
  153.                button.  There is no functional purpose for clearing the
  154.                selection, other than to eliminate the distraction of the
  155.                YELLOW box if no longer needed.
  156.                
  157.           IMPORT
  158.                Use this function to copy the contents of a region saved to
  159.                file previously (using the REGION/SAVE function) to a
  160.                specific location in the current map in memory.
  161.                
  162.                Once the button is pressed, a window will appear with a list
  163.                of files in the current default directory that have a .REG
  164.                extension.  You may select the desired file, or click the
  165.                RIGHT button to abort the procedure.
  166.                
  167.                Once a region file is selected, you will be placed in an
  168.                import mode, where you are asked to select the location of
  169.                the upper left corner of the region that will be imported.
  170.                This area will be outlined in WHITE and will always appear
  171.                at first in the very top left corner of the map, to indicate
  172.                its size.  If you select a location such that the region
  173.                will not fit on the map, you will be notified and the
  174.                destination outline will be reset.  You may elect to cancel
  175.                this procedure by pressing the IMPORT button again so as to
  176.                release it.  Otherwise, the copy is initiated by clicking
  177.                (again) on the grid at the location of the upper left
  178.                corner, which is emphasized by being boxed in separately; if
  179.                you do not select this corner, the WHITE box will be moved
  180.                to the new location, until this corner is double-clicked in
  181.                this manner.  Once the copy is performed, there is no
  182.                possibility of undoing it.
  183.                
  184.                If a region is selected (the YELLOW box), it will have no
  185.                effect on the IMPORT process.
  186.                
  187.           SAVE
  188.                Use this function to save the selected region (in YELLOW) to
  189.                file.  If no region is selected, you will be notified and
  190.                this function will have no effect.
  191.                
  192.                If this function is chosen with a selected region, you will
  193.                be asked to type the name of the region file, without a path
  194.                reference or extension (a .REG extension will be added
  195.                internally).  This may be aborted by hitting ESCAPE or
  196.                clicking the RIGHT button.  Clicking the LEFT button while
  197.                in the filename input field acts like a RETURN and accepts
  198.                the input.  You will be alerted if the file exists and may
  199.                then choose to cancel, or replace.
  200.                
  201.           
  202.           FILL
  203.                Press this button if you have a selected region (in YELLOW)
  204.                that you want completely filled with the currently selected
  205.                surface type.  This act will be instantaneous and will not
  206.                prompt you for confirmation, so be careful - there is no way
  207.                to undo this.  If you have no region selected, you will be
  208.                notified and the function will have no effect.
  209.                
  210.           COPY
  211.                This is similar to the IMPORT function except that it uses
  212.                the selected area on the map as the source region.  If no
  213.                region is selected (in YELLOW) then you will be notified and
  214.                this function will have no effect.
  215.                
  216.                Once this button is pressed, you will be asked to select the
  217.                location of the destination region in the same way as the
  218.                IMPORT function (with the WHITE box).  This procedure may
  219.                also be aborted by again pressing the COPY button to release
  220.                it.
  221.                
  222.                This function will not permit the source and destination
  223.                regions to overlap.  If you specify the position of an
  224.                overlapping destination region, you will be notified and
  225.                then forced to reselect a position.  If for some reason this
  226.                is not satisfactory, the alternative is to SAVE a region to
  227.                file and to then IMPORT it.
  228.                
  229.  
  230. 4. CLOSING COMMENTS
  231.  
  232.      If you are curious, with my I/O library already written (about two
  233.      years ago), I was able to develop this program from start to finish in
  234.      less than two weeks, and mostly during evenings.
  235.      
  236.      One important thing to note while using this program is that if the
  237.      mouse pointer graphic is moved to either edge of the screen, the image
  238.      will wrap around from one end of the screen to the other (but of
  239.      course not the pointer itself).  This is a limitation of the method
  240.      used for drawing vectorized icons, and not related in any way to your
  241.      mouse driver.
  242.  
  243. <END OF DOCUMENT MAPEDIT.DOC>
  244.  
  245.