home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 24 / CD_ASCQ_24_0995.iso / vrac / aafdoc.zip / AAFUPL.TXT < prev    next >
Text File  |  1995-06-15  |  5KB  |  113 lines
  1.                             AAFUPL
  2.  
  3. These are a few suggested guidelines on uploading files made with
  4. BAO/Mallard's Aircraft and Adventure Factory to library
  5. 15/Aircraft/Adventure on this forum. None of these are required
  6. by any means, but the sysops (and users) will appreciate it if
  7. you will consider these matters.
  8.  
  9. I. Adventures
  10.  
  11. Of course a bare minimum is the YOURFILE.ADV file, which you will
  12. have created with AAF.EXE from YOURFILE.TXT (or whatever
  13. extension).
  14.  
  15. You may very well want to include YOURFILE.TXT, which will give
  16. other users and wannabe adventure designers an idea on how to
  17. proceed. If you do so, consider adding comments (lines beginning
  18. with ";") to your .TXT file to provide some help.
  19.  
  20. If your adventure requires starting at a certain position, you
  21. may well want to include a mode file (YOURFILE.MOD). This will
  22. also allow users to "Load adventure with mode". It is also
  23. possible to start at a certain position by using
  24. SETPOSITION(NORTH,EAST,ALTITUDE), but unfortunately this does not
  25. determine heading.
  26.  
  27. Of course if your adventure requires certain ASD scenery, either
  28. supply that, or refer users to other files in the scenery
  29. library, lib 6.
  30.  
  31. As usual in FS, if you want to specify a certain plane in your
  32. .MOD file or otherwise, and it is not a standard (Cessna, Lear,
  33. etc.), include the .SIM file for that plane.
  34.  
  35. One of the problems here is the size of the digital sound (.VOC)
  36. files which are used with most adventures. Use some discretion
  37. here. If the .VOCs are really huge, you might want to consider
  38. uploading them to a *separate* file in the library, and then
  39. noting with your main file that they are available there. If
  40. there are not too many .VOCs, you may feel free to include them
  41. in your basic .ZIP file. Robert Mackay and I have adopted the
  42. convention of using .V01 -- .V99 extensions on our .VOC files, to
  43. make them obvious in a directory. Do not bother to "pack" your
  44. .VOC files; PKZIP won't handle them anyway. Rather keep the size
  45. down by using a low sampling rate (at least for voice), such as
  46. 4000.
  47.  
  48. If you use .PCX files for VIEW(X,"YOURFILE.PCX") [where X =
  49. number of seconds], you can do just that if you have only one
  50. file. If there is more than one, we suggest YOURFILE.P01 -- .P99.
  51.  
  52. There are some warnings you should issue (in your docs) for
  53. certain conditions. For example, if you have the pilot set the
  54. transponder and/or if you check it in your adventure file, users
  55. should *not* have FRAME.DRV in their CONFIG.FS4, since that
  56. driver replaces the transponder frequency with frame rate. And if
  57. your adventure and/or accompanying scenery file was *not* created
  58. with the MAGROT.DRV (magnetic rotation driver) installed, be sure
  59. to tell the user again to omit that driver from CONFIG.FS4.
  60.  
  61. And as for documentation. This should include:
  62.  
  63. 1. How to get started: mode file if any, ASD scenery if any, load
  64. adventure. If you're presupposing ASD scenery, give user the
  65. amount of static and dynamic memory to reserve.
  66.  
  67. 2. What to do. If you require user, for example, to press "x"
  68. after each ATC transmission, point that out. Or what COM
  69. frequency to tune in order to receive further instructions.
  70.  
  71. 3. A brief description of what the adventure is supposed to do.
  72. Sometimes you will want to be a little cagey here, in case your
  73. adventure features certain unforeseen consequences (unforeseen by
  74. users, that is: *you* know what will happen).
  75.  
  76. 4. Specify if default scenery or a scenery disk is required.
  77.  
  78. Of course I think my own stuff (CMIBMI.ZIP/CBVOCS.ZIP) is an
  79. absolutely perfect model of what should be done!
  80.  
  81. II. Aircraft
  82.  
  83. Bare minimums are YOURFILE.SIM and YOURFILE (no extension): the
  84. first is the plane itself, and the second a "driver" which
  85. determines certain loading characteristics of the plane.
  86.  
  87. You may want to include your "crated" plane (YOURFILE.AFX), to
  88. allow users either to see what you've done, or to use your plane
  89. as a model for their own (we hope you will). If you do so, also
  90. include the "source SIM" file specified when you assembled the
  91. plane, if it differs from the stock .SIMs provided with FS.
  92.  
  93. ( Note from Jim: if I were to include my .AFX/source SIM, I would
  94. also want to put a note in my documentation to the effect that
  95. this plane is not to be changed and reassembled, and released to
  96. the public domain, without the explicit permission of the author.
  97. I myself am going to include a copyright notice with all my
  98. adventures and planes [if I ever do one!]. )
  99.  
  100. If you happen to have saved your plane out as a SEE04 library
  101. object (YOURFILE.SC0), you might want to send that along, too.
  102. This is particularly the case if you don't include the .AFX.
  103.  
  104. Documentation:
  105.  
  106. A general description of the plane, and as much information as
  107. you can provide about its flying characteristics. "V" speeds
  108. (when to rotate, retract flaps, etc.) very helpful. Possibly the
  109. sources for the information used in creating the plane. And notes
  110. for any tricks you may have used in designing the plane.
  111.  
  112.  
  113.