home *** CD-ROM | disk | FTP | other *** search
/ Game Killer / Game_Killer.bin / 204.AFTMAPED.TXT < prev    next >
Text File  |  1988-04-23  |  19KB  |  412 lines

  1.                    * AFTMAPED *
  2.  
  3.                 Map File Editor for
  4.          Chuck Yeager's Advanced Flight Simulator/Trainer
  5.                 by Electronic Arts
  6.  
  7.  
  8.                COPYRIGHT (c) 1988  Bill Crow
  9.  
  10.               Release A.00.00 4/23/88
  11.  
  12.  
  13.                  Bill Crow
  14.                  1681 Grizilo Drive
  15.                  San Jose, CA 95124
  16.  
  17.                CompuServe: [76703,632]
  18.                   MCI Mail: BCROW
  19.  
  20.  
  21.  
  22.  
  23. THE REQUISITE LEGAL STUFF
  24.  
  25. The files in this ARChive are for use with Electronic Art's "Chuck
  26. Yeager's Advanced Flight Trainer" and "Chuck Yeager's Advanced Flight
  27. Simulator" for PC compatibles.  Users are free to use this for any
  28. non-commercial purpose, and distribute it to others as long as the
  29. complete ARChive file is distributed, including this documentation.
  30. The ARChive file may be uploaded to other non-commercial bulletin
  31. boards, and may be distributed via public domain software libraries,
  32. as long as no fees are charged other than a reasonable disc
  33. duplication fee.  Any other use of the material in this ARChive file
  34. requires the express written consent of the author.  
  35.  
  36.     THE AUTHOR MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS
  37.     MATERIAL, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  38.     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  39.     PURPOSE.  THE AUTHOR SHALL NOT BE LIABLE FOR ERRORS CONTAINED
  40.     HERIN OR FOR INCIDENTAL OR CONSEQUENTIAL DAMAGES IN
  41.     CONNECTION WITH THE FURNISHING, PERFORMANCE, OR USE OF THIS
  42.     MATERIAL.  
  43.  
  44.  
  45. CONTRIBUTING TO THE CAUSE
  46.  
  47. This software is copyrighted by the author.  You are free to use it
  48. for any non-commercial purpose.  There is no required registration or
  49. license fees.  It's free!  There is also no restriction on what you do
  50. with the new or modified mapfiles you create with this program.  
  51.  
  52. If you like AFTMAPED, and you would like to encourage me to continue
  53. to improve this program, and work on other related tools and utilities,
  54. you are welcome to send me a contribution of $20.00 to the address
  55. listed above.  In return for your $20.00, I'll send you the Microsoft
  56. QuickBASIC 4.0 source code to the latest version of AFTMAPED, laserset
  57. documentation, and additional documentation and utilities that I have
  58. created while working and playing with AFT.  
  59.  
  60.  
  61. SUPPORT
  62.  
  63. If you have questions, comments, bug reports or enhancement requests
  64. for AFTMAPED, leave me an electronic message on CompuServe either via
  65. EasyPlex or in the message area of the HP Forum (GO HP).  I'll do my
  66. best to respond to reported errors with updated versions uploaded to
  67. CompuServe.
  68.  
  69.  
  70. INTRODUCTION
  71.  
  72. Chuck Yeager's Advanced Flight Trainer (a.k.a. Chuck Yeager's Advanced
  73. Flight Simulator) has to be one of the best pieces of entertainment
  74. software I have ever found.  Not only is it a a tour-de-force of
  75. graphics animation and flight dynamics simulation, its design allows
  76. for lots of customization and expansion.  As many have discovered the
  77. aircraft specification files (.FLY) and the race course definition
  78. files (.RAC) are easily modifiable with a simple ASCII editor.  The
  79. program also allows you to create your own stunts for training and
  80. formation flying.  Also, when flying the races, your own best flights
  81. are saved and used to control the competitive airplanes in subsequent
  82. races.
  83.  
  84. The one thing that I wanted to be able to change, but could not, was
  85. the scenery and obstacles available.  While AFT provides a good
  86. variety of obstacles and scenery variations, I had my own ideas about
  87. how I would like to arrange buildings, gates, runways, mountains and
  88. other scenery components to create my own special environment.
  89.  
  90. All the information to control the specific scenery is contained in
  91. the sixteen MAPxx files.  These are binary files, and not editable
  92. with a standard ASCII editor.  However, after several hours spent with
  93. DEBUG, I was able to decode the formats of the MAPxx files and start
  94. creating my own scenery.  While it was possible to do so using DEBUG,
  95. it was a slow, tedious and error-prone procedure.  So, I created
  96. AFTMAPED, an editor to display, print and edit the contents of the AFT
  97. MAPxx files.
  98.  
  99.  
  100. THE AFT WORLD
  101.  
  102. The AFT world is 40 miles square, made up of sixteen 10x10 mile
  103. squares.  Each of the MAPxx files corresponds to one square as
  104. follows:
  105.  
  106.      +-----------+-----------+-----------+-----------+
  107.      |           |           |           |           |
  108.      |           |           |           |           |
  109.      |   MAP21   |   MAP31   |   MAP01   |   MAP11   |
  110.      |           |           |           |           |
  111.      |           |           |           |           |
  112.      +-----------+-----------+-----------+-----------+         
  113.      |           |           |           |           |         N
  114.      |           |           |           |           |         |
  115.      |   MAP20   |   MAP30   |   MAP00   |   MAP10   |      W -+- E
  116.      |           |           |           |           |         |
  117.      |           |           |           |           |         S 
  118.      +-----------+-----------+-----------+-----------+
  119.      |           |           |           |           |
  120.      |           |           |           |           |
  121.      |   MAP23   |   MAP33   |   MAP03   |   MAP13   |
  122.      |           |           |           |           |
  123.      |           |           |           |           |
  124.      +-----------+-----------+-----------+-----------+
  125.      |           |           |           |           |
  126.      |           |           |           |           |
  127.      |   MAP22   |   MAP32   |   MAP02   |   MAP12   |
  128.      |           |           |           |           |
  129.      |           |           |           |           |
  130.      +-----------+-----------+-----------+-----------+
  131.  
  132.  
  133. The world "wraps around" in both dimensions.  If you fly off any edge,
  134. you reappear at the same point on the opposite edge.  For example, if
  135. you leave the home airport and fly North for forty miles, you will be
  136. right back where you started.
  137.  
  138. The home airport (where all flights begin) is located in the lower
  139. left corner of MAP00, near the center of the world.  Actually, the
  140. balloon to the southwest of the airport is in the exact lower left
  141. corner of MAP00.
  142.  
  143.  
  144. INSIDE THE MAPxx FILE
  145.  
  146. Each MAPxx is 256 bytes in size.  It contains a list of up to 85
  147. 3-byte object definition records.  Each 3-byte record consists of an
  148. object code, X coordinate and Y coordinate.  There are 31 usable
  149. object codes, described in more detail in the tables that follow.  
  150.  
  151. The X and Y coordinates can be any integer value from 0 through 255.
  152. (0,0) specifies the lower left (Southwest) corner of the square, and
  153. (255,255) is almost at the upper right (Northeast) corner.  The X
  154. value specifies the East-West longitudinal position and the Y
  155. coordinate specifies the North-South latitudinal position.  Since the
  156. 10x10 mile square is divided into 256 steps in each direction, each
  157. addressable step represents approximately 200 feet.  (206' 3" to be
  158. precise.)  By the way, the spots displayed on the ground are spaced
  159. approximately 100 feet apart (103' 1.5" for those who really care),
  160. meaning that there are 2 spots for every addressable step.  In other
  161. words, two objects cannot be placed any closer together than 2 spots
  162. in either dimension.  All objects are placed on the ground (at 0'
  163. elevation) with the exception of one of the balloons, which is fixed
  164. at 300' elevation.
  165.  
  166.  
  167. STARTING AFTMAPED
  168.  
  169. Before editing a map file, make a copy!  Whatever you do, don't edit
  170. the files on your original AFT diskette.  Copy the files to another
  171. diskette or to your hard disc.  I have AFT installed on a hard disc,
  172. and before I started any editing, I made copies of all the MAPxx files
  173. using the following MS-DOS command:
  174.  
  175.                  COPY MAP??. MAP??.SAV
  176.  
  177. Then if I ever accidentally corrupt a MAPxx file, I can copy the
  178. corresponding MAPxx.SAV file without having to go back to the original
  179. program diskette.
  180.  
  181. Start AFTMAPED with the following command:
  182.  
  183.            [d:][path]AFTMAPED [mapfile]
  184.  
  185. If AFTMAPED is in your current directory or in a directory specified
  186. your current PATH, there is no need to specify the drive and path.
  187. If you are using MS-DOS 2.x, you CANNOT specify the drive and path, so
  188. you must place AFTMAPED in the current directory or in a directory
  189. specified by your current PATH.
  190.  
  191. If you do not specify a mapfile as a command line argument, you will
  192. be prompted for the file.  If the file does not exist, you will be
  193. asked if you want to create a new file.  If for any reason AFTMAPED
  194. cannot open the specified file, an appropriate error will be displayed
  195. and you will be prompted for another mapfile filename.
  196.  
  197. If a mapfile is specified on the command line, AFTMAPED will
  198. terminate, returning to the MS-DOS command prompt when you exit from
  199. the map list.  However, if the mapfile is specified when AFTMAPED
  200. prompts for the filename, exiting from the map list will return you to
  201. the mapfile prompt to select another file.
  202.  
  203. If you press <Enter> without entering a filename at the mapfile
  204. prompt, AFTMAPED will exit, returning to the MS-DOS command prompt.
  205.  
  206.  
  207. THE AFTMAPED DISPLAY
  208.  
  209. The primary display for AFTMAPED is a list of mapfile records,
  210. starting with the first twenty.  A typical display looks like this:
  211.  
  212. IDX  OBJ  DESCRIPTION                        X     Y         FILE             
  213.   1  [30] Balloon,  Green, at 300'         [  0] [  0]   00: 01 00 00
  214.   2   23  Mountain, Large White Pyramid      64    64    03: 1F 40 40
  215.   3   23  Mountain, Large White Pyramid     192   192    06: 1F C0 C0
  216.   4   23  Mountain, Large White Pyramid      64   192    09: 1F 40 C0
  217.   5   23  Mountain, Large White Pyramid     192    64    0C: 1F C0 40
  218.   6    3  Building, Small White               5     6    0F: 37 05 06
  219.   7    4  Building, Large White              14     5    12: 3F 0E 05
  220.   8    2  Building, Green Blockhouse         17     8    15: 05 11 08
  221.   9    1  Building, Blue House w/Roof         1     4    18: 03 01 04
  222.  10    1  Building, Blue House w/Roof         1    10    1B: 03 01 0A
  223.  11    5  Hangar,   N/S,   Blue/White         2     4    1E: 11 02 04
  224.  12    5  Hangar,   N/S,   Blue/White         3     4    21: 11 03 04
  225.  13    5  Hangar,   N/S,   Blue/White         4     4    24: 11 04 04
  226.  14    7  Wall,     N/S,   Black/White        0     7    27: 0B 00 07
  227.  15    7  Wall,     N/S,   Black/White       18     2    2A: 0B 12 02
  228.  16    7  Wall,     N/S,   Black/White       18     7    2D: 0B 12 07
  229.  17    9  Runway,   N/S,   Blue/Green         1     7    30: 15 01 07
  230.  18    9  Runway,   N/S,   Blue/Green         4     7    33: 15 04 07
  231.  19   11  Runway,   E/W,   Blue/Green         4     4    36: 19 04 04
  232.  20   11  Runway,   E/W,   Blue/Green         4     7    39: 19 04 07
  233.  
  234.  
  235. For each record, the following information is displayed:
  236.  
  237.             IDX: The integer object index within this file.
  238.             OBJ: The integer object code, in decimal.
  239.     DESCRIPTION: A brief description of the scenery object.
  240.               X: The X coordinate (longitude), in decimal.
  241.               Y: The Y coordinate (latitude), in decimal.
  242.            FILE: The hexidecimal offset and contents for this
  243.                  record as it is actually stored in the mapfile.
  244.  
  245.  
  246. SCENERY OBJECTS
  247.  
  248. Here is a table of the scenery objects available, and their decimal
  249. object codes, as used in AFTMAPED.  The colors listed in the
  250. description are based on AFT's default RGB color settings with a CGA
  251. or EGA display.  These colors will be different when using a different
  252. display or palette setting.  See the description of the "D" command
  253. later in this document to instruct AFTMAPED to list alternate color
  254. combinations.  
  255.  
  256.                OBJ
  257.               CODE  DESCRIPTION
  258.               ----  -----------------------------   
  259.                 1   Building, Blue House w/Roof
  260.                 2   Building, Green Blockhouse
  261.                 3   Building, Small White
  262.                 4   Building, Large White
  263.                 5   Hangar,   N/S,   Blue/White
  264.                 6   Gate,     N/S,   Blue/White
  265.                 7   Wall,     N/S,   Black/White
  266.                 8   Wall,     N/S,   Blue/White
  267.                 9   Runway,   N/S,   Blue/Green
  268.                10   Runway,   SW/NE, Blue/Green
  269.                11   Runway,   E/W,   Blue/Green
  270.                12   Runway,   NW/SE, Blue/Green
  271.                13   Runway,   N/S,   Black
  272.                14   Runway,   SW/NE, Black
  273.                15   Runway,   E/W,   Black
  274.                16   Runway,   NW/SE, Black
  275.                17   River,    N/S,   Blue/Black
  276.                18   River,    SW/NE, Blue/Black
  277.                19   River,    E/W,   Blue/Black
  278.                20   River,    NW/SE, Blue/Black
  279.                21   Lake,     Blue/Black Hexagon
  280.                22   Mountain, Small White Pyramid
  281.                23   Mountain, Large White Pyramid
  282.                24   Mountain, E/W Green Wedge
  283.                25   Field,    Blue/Green on Black
  284.                26   Field,    Blue/Black on Green
  285.                27   Field,    Blue/Green on White
  286.                28   Field,    Blue/Black
  287.                29   Field,    Blu/Grn/Blk, Raised
  288.                30   Balloon,  Green, at 300'
  289.                31   Balloon,  Green, on Ground
  290.  
  291.  
  292. NAVIGATING IN THE AFTMAPED DISPLAY
  293.  
  294. The current record is always indicated by a highlight line, and
  295. brackets surrounding the object code and coordinate values.  You can
  296. change the current record, and display additional records in the file
  297. using the following single-key commands:
  298.  
  299.         Up Arrow: Move back one record.
  300.       Down Arrow: Move forward one record.
  301.            Pg Up: Move back one page (20 records).
  302.            Pg Dn: Move forward one page (20 records).
  303.             Home: Move to the first record in the list.
  304.              End: Move to the last record in the list.
  305.  
  306.  
  307. EDITING COMMANDS
  308.  
  309. The following single-key commands are used to change the contents of
  310. the mapfile, based on the current record selected.
  311.  
  312.        E: Edit the current record.
  313.  
  314.           You are prompted at the bottom of the display to 
  315.           enter new decimal values for the object code and
  316.           X and Y coordinates.  Pressing <Enter> without 
  317.           providing a new value will leave the current value
  318.           unchanged.
  319.  
  320.      Del: Cut the current record.
  321.  
  322.           The current record is "cut" from the list, but
  323.           preserved in a temporary "clipboard".  It can be
  324.           restored using the Ins key.
  325.  
  326.      Ins: Paste a new record at the current position.
  327.  
  328.           The record contained on the temporary "clipboard"
  329.           (from a previous Cut command) is inserted at the 
  330.           current record position, moving all subsequent
  331.           records down one position.  If there has been no
  332.           previous Cut command, a blank record is inserted.
  333.           The blank record will serve as a placeholder until
  334.           it is edited with the E command.  If blank records
  335.           are left in the file, they will be ignored by AFT.
  336.  
  337.  
  338. OTHER COMMANDS
  339.  
  340. The following single-key commands can be used any time the object list
  341. is displayed (other than while editing the current record):
  342.  
  343.        H: HELP - Displays a brief description of all commands.
  344.  
  345.        O: OBJECT LIST - Displays a list of the different
  346.           objects available, including the object code, hex
  347.           file code and object description.  This is a useful
  348.           reference, since objects must be specified by their
  349.           object code when editing a record.
  350.  
  351.        D: DISPLAY - Changes the colors listed in the object
  352.           descriptions based on what type of display is used when
  353.           running AFT.  By default, the colors listed are based
  354.           on AFT's default RGB setting with a CGA or EGA display.
  355.           AFTMAPED can also display the descriptions based on the
  356.           colors that are shown when running AFT using the "New
  357.           Palette" choice from the "SYS" menu and an EGA display,
  358.           or when connected to a monochrome display using a
  359.           Hercules Graphics Adapter.  The display color mapping
  360.           currently selected is indicated by the code displayed
  361.           in brackets in the lower-right of the object list: 
  362.  
  363.                   [CGA] - "RGB" with a CGA or EGA display
  364.                   [EGA] - "New Palette" with an EGA display
  365.                   [MDA] - Hercules display
  366.  
  367.           NOTE: This command does not change the values stored
  368.           in the file.  It only changes the descriptions that
  369.           AFTMAPED shows, to more accurately reflect what is 
  370.           displayed when running AFT.
  371.  
  372.        S: SAVE - The current map list is saved to the file.
  373.  
  374.        Q: QUIT - The current map list is saved to the file 
  375.           and AFTMAPED prompts for a new file (if no file was
  376.           specified on the command line) or exits.
  377.  
  378.      Esc: The current map list is discarded and AFTMAPED
  379.           prompts for a new file (if no file was specified on
  380.           the command line) or exits.
  381.  
  382.        P: The current map list is listed to LPT1.
  383.  
  384.        C: Temporarily suspend AFTMAPED and access the MS-DOS 
  385.           command prompt.  This is very handy to rename the
  386.           file you are currently editing if you want to save
  387.           the changed version in memory without losing the 
  388.           previous file.  Use the MS-DOS EXIT command to
  389.           return to AFTMAPED.
  390.  
  391.  
  392. ADDITIONAL TECHNICAL NOTES
  393.  
  394. While it is possible to pack the 85 objects stored in a mapfile in a
  395. close region of the ten mile square, some care must be exersized.  The
  396. more three dimensional objects located in a close reason, the slower
  397. the simulator will operate.  Placing several mountains or buildings
  398. close togther may slow operation to an unacceptable level.  Use three
  399. dimensional objects judicially, and spread scenery objects throughout
  400. the ten mile square.  Keep this in mind as you design your ultimate 
  401. scenery environment!  
  402.  
  403. AFTMAPED allows you to insert and delete records while editing a file.
  404. While editing, you can create up to 170 records -- twice the number
  405. that can be saved.  However, when saving the file, only the first 85
  406. records will be recorded.  If there are less than 85 records, the
  407. remaining bytes in the file will be filled with nulls, which AFT
  408. interprets as the end of file.
  409.  
  410.  
  411.                -##-  END OF DOCUMENTATION FILE  -##-
  412.