home *** CD-ROM | disk | FTP | other *** search
/ Boldly Go Collection / version40.iso / TS / 14A / FALCONER.ZIP / FALCNR.DOC < prev    next >
Encoding:
Text File  |  1992-05-21  |  19.4 KB  |  485 lines

  1.                                FALCONER
  2.                            A MANAGER PROGRAM
  3.                             FOR FALCON 3.0D
  4.  
  5.                              (Release 3.1)
  6.  
  7.                 By Rob "Orinoco" Heittman (72700,1067)
  8.               Member Expert for PC Air Combat Simulation
  9.             CompuServe Flight Simulation Forum (GO FSFORUM)
  10.  
  11.                              DOCUMENTATION
  12.  
  13. IMPORTANT -----
  14.  
  15.   READ the file called README.NOW before continuing any further!
  16.  
  17. OVERVIEW -----
  18.  
  19.   Falconer is a freeware tool that lets you control every important 
  20.   aspect of your FALCON 3.0 ("F3") squadron and campaign.
  21.  
  22.   You can:
  23.  
  24.         Automatically reload your favorite squadron every time
  25.           you run FALCNR.
  26.         Automatically create "super squadrons" with max abilities for
  27.           each pilot, and no fatigue
  28.         Automatically eliminate all fatigue from your squadron
  29.         Automatically reorganize the roster in four different ways
  30.         Control ALL supplies and weaponry used on campaign
  31.       Edit pilot ability scores
  32.       Edit pilot rank
  33.       Edit pilot status (KIA, MIA, Active, etc.)
  34.         Export a single pilot and custom face to a pair of files
  35.         Export a squadron full of pilots to a file
  36.         Give or rescind any pilot's awards
  37.         Import a single pilot and custom face from a pair of files
  38.         Import a squadron full of pilots from a file
  39.       Print a pilot dossier
  40.       Print your Sierra Hotel sheet
  41.       Print a squadron roster
  42.       Reactivate/resurrect lost pilots
  43.         Replace any existing "pilot face" with part of a .PCX file
  44.         Replenish any planes lost in combat
  45.         Replenish ECM modules lost in combat
  46.         Replenish fuel used in combat
  47.         Run Greg Prete's Falcon Mapper at any time
  48.         Use Falconer as a shell for Falcon 3.0
  49.  
  50.  
  51. INSTALLING FALCONER -----
  52.  
  53.   If you're reading this file you must have unZIPped the FALCNR.ZIP 
  54.   file already.  You must make sure that the file FALCNR.EXE is in 
  55.   your FALCON 3.0 directory (typically C:\FALCON3).  If FALCONER is 
  56.   not in your F3 directory, it will not start and display an error 
  57.   message asking you to install it correctly.
  58.  
  59.   To run FALCONER, just log to the F3 directory and type FALCNR at the 
  60.   DOS prompt.
  61.  
  62.  
  63. LOADING A SQUADRON -----
  64.  
  65.   The first thing you need is an active squadron.  If you don't 
  66.   already have one, go back to F3 and "FORM" a squadron.
  67.  
  68.   From FALCONER, select "File Open..." from the menu by pressing [ALT-
  69.   F], followed by [O].  Alternatively, you can make menu selections 
  70.   with the mouse.  (Note: where possible FALCONER uses a CUA-compliant 
  71.   interface, so it should be quite familiar to most PC users)
  72.  
  73.   FALCONER will present you with a list of available squadrons which 
  74.   you may modify.  Any squadrons which you have deleted using the 
  75.   "DEACTIVATE" option in F3 _cannot_ be recovered.  Only active 
  76.   squadrons can be modified.
  77.  
  78.   If you have more than 6 active squadrons (F3 is still not known to
  79.   actively support more than 6), you will only see the first 6 of them
  80.   in the FALCONER menu.  You may not edit squadrons with a number 
  81.   higher than 6 in FALCONER.
  82.  
  83.   The squadrons will be identified by name and number.  Select the 
  84.   number of the squadron you want to modify.
  85.  
  86.   The on-screen frame will fill with pilots and statistics, and the 
  87.   other menu options will be activated.
  88.  
  89.  
  90. SAVING YOUR FILE -----
  91.  
  92.   After you have made changes to your squadron, you can save the file 
  93.   back to disk by selecting "File Save..." from the menu.  If you do 
  94.   NOT select "File Save..." the squadron data will not be changed, no 
  95.   matter what you do to the on-screen representation.
  96.  
  97.  
  98. INTERACTIVE EDITING -----
  99.  
  100.   The interactive editor is started by selecting "Edit Interactive" 
  101.   from the menu [ALT-E],[I].  You may use the arrow keys to move the 
  102.   cursor around the roster, to highlight an item to edit.  You press
  103.   one of several keys to perform an action on that item or pilot.
  104.   These keys are listed at the bottom of the screen.
  105.  
  106.   Interactive editing has six functions:
  107.  
  108.   AWARDING - if you highlight any part of a pilot record and press
  109.   the [A] key, you will be presented with a dialog box where you can
  110.   give or rescind any awards that pilot possesses.
  111.  
  112.   EXPORTING - if you highlight any part of a pilot record and press 
  113.   the [X] key, you can export that pilot to a special file on disk,
  114.   while simultaneously saving his "face" picture. You will be prompted
  115.   for a filename, which can be up to 8 characters.  Two files will be
  116.   created.  One will be given the extension .F3P -- for "Falcon 3
  117.   Pilot."  Another will be given the extension .F3F -- "Falcon 3 Face."
  118.  
  119.   FACE REPLACER - if you highlight any part of a pilot record and
  120.   press the [F] key, you will be able to replace that pilot's face
  121.   with part of a .PCX file.  This function is covered below in the
  122.   section "YFIF3 - Your Face in F3!"
  123.  
  124.   IMPORTING - if you highlight any part of a pilot record and press 
  125.   the [I] key, you can import a pilot from disk in that record slot.  
  126.   You will be prompted for an 8-character .F3P filename.  The .F3P 
  127.   file must already be in the F3 directory.  WARNING - the new pilot 
  128.   will be imported "over" the pilot you have highlighted.  The 
  129.   highlighted pilot will be lost permanently if you save the file to 
  130.   disk.  If an .F3F file is present, the pilot's face will be imported
  131.   into the appropriate slot in the face file.
  132.  
  133.   CHANGING DATA
  134.  
  135.   Every field on the screen (except slot #) can be edited.  To edit a 
  136.   field, move the cursor to that field and press the [ENTER] key.  For 
  137.   text fields like NAME or CALLSIGN, or numerical fields like DGFT 
  138.   (see below for abbreviations) you will be asked to enter the new 
  139.   text in a dialog box.  For multiple-choice fields like STAT, each 
  140.   time you press the [ENTER] key, the field will toggle between its 
  141.   various states.
  142.  
  143.   VIEWING AND PRINTING DOSSIERS
  144.  
  145.   If you highlight any part of a pilot record and press the [?] key, 
  146.   you will view the complete dossier for the pilot, including their 
  147.   air-to-air and air-to-ground kills.  If you select the button <PRINT 
  148.   Dossier> (press [TAB] to move the cursor to the button, then press 
  149.   [SPACE] to select it, or select it with the mouse) you can print 
  150.   that information to the printer on LPT1:.  A printer MUST be 
  151.   connected to LPT1 and online for this option to work.  If FALCONER 
  152.   cannot access your printer, you will get an error message.
  153.  
  154.   You can exit Interactive Edit by pressing the [ESC] key.
  155.  
  156.  
  157. SETTING AVAILABLE PILOTS -----
  158.  
  159.   In addition to the individual status flags for each pilot (KIA, MIA, 
  160.   ACTIVE, etc.), F3 keeps a separate list of the number of pilots you 
  161.   currently have available.  During a campaign, KIA's and MIA's are 
  162.   pushed to the BOTTOM of your pilot roster.  If F3 says you have less 
  163.   than 30 available pilots, then the ones at the bottom of the roster 
  164.   are not shown in your Pilot Info. screen.
  165.  
  166.   To simulate this effect, FALCONER "grays out" the appropriate number 
  167.   of pilots at the bottom of the roster if you have less than 30 
  168.   active pilots.
  169.  
  170.   The "Edit Set Available Pilots..." menu option allows you to change 
  171.   this number, and make campaign mode think you have more active 
  172.   pilots than you really do.  Remember, though, just because you can 
  173.   access the pilot record, if he's KIA or MIA, he still can't fly.  
  174.   You must manually change the KIA and MIA flags for each "greyed" 
  175.   pilot that you put back on the roster by increasing the number of 
  176.   "available pilots."
  177.  
  178.   When you play around with this, you will see why I have dubbed this 
  179.   the "waterline" value.  By decreasing the Available field, you raise 
  180.   the "waterline" and more pilots are "sunk."
  181.  
  182.  
  183. AUTO-UNFATIGUE -----
  184.  
  185.   With one menu selection ("Edit Auto-Unfatigue") you can reset your 
  186.   entire squadron's fatigue scores to 100.
  187.  
  188.  
  189. AUTO-PERFECT -----
  190.  
  191.   If you want to quickly create a "super squadron" all you have to do 
  192.   is select Auto-Perfect.  All your pilots' ability scores will jump 
  193.   to 100, and all fatigue will be reset to 100.
  194.  
  195.  
  196. AUTO-ORGANIZE -----
  197.  
  198.   This performs several housekeeping functions in one fell swoop.  
  199.   First, it organizes your pilots according to:
  200.  
  201.      STAT (Status. Non-active pilots go to the bottom like F3 expects)
  202.  
  203.   then according to the choice you made in your Config menu (which
  204.   can either be DGFT, BOMB, FLYG, or RANK) then by
  205.  
  206.      NAME (Alphabetical order)
  207.  
  208.   Finally it counts the number of non-active pilots and sets the
  209.   waterline to the first non-active pilot -- just like F3 expects.
  210.  
  211.   I suggest ALWAYS using Auto-Organize after doing any squadron 
  212.   editing that involves rank or status.  I have not had any problems 
  213.   with setting the waterline to strange values, or having pilots out 
  214.   of rank order -- but you never can tell.  Also, Auto-Organize makes 
  215.   the roster a LOT easier to read.
  216.  
  217.  
  218. EXPORT SQUADRON -----
  219.  
  220.   Once you have a squadron you like, you might want to save it for future
  221.   use.  Export Squadron will prompt you for a file name and let you save
  222.   all 30 pilot records into one file.  You can import this data into any
  223.   squadron later, without disturbing campaign or other peripheral
  224.   information.  The file is stored with the extension ".F3S" for Falcon
  225.   3 Squadron.
  226.  
  227.  
  228. IMPORT SQUADRON -----
  229.  
  230.   The opposite of Export Squadron, this allows you to import an .F3S file
  231.   back into any existing squadron.  FALCONER is packaged with two .F3S
  232.   files: the 386th and 387th Flight Simulation Forum Squadrons.  These are
  233.   stored under 386th.F3S and 387th.F3s.
  234.  
  235.  
  236. SQUADRON ROSTER -----
  237.  
  238.   You can print your squadron roster by selecting this menu option.  
  239.   Again, you must have a printer connected to LPT1 and active.
  240.  
  241.  
  242. SIERRA HOTEL -----
  243.  
  244.   This option prints your Sierra Hotel list.  It is based, like the one
  245.   in F3, on air to air kills alone.
  246.  
  247.   Release 2a includes a special routine that reorganizes information in
  248.   the .SQU file every time you save the file.  This routine prevents
  249.   the F3 "Sierra Hotel" display from showing erroneous information, as
  250.   is otherwise prone to happen when pilots are repeatedly resurrected.
  251.  
  252.  
  253. REPLENISH ECM -----
  254.  
  255.   If your squadron is on campaign, and you run out of ECM modules, you
  256.   can replenish the ECM modules by selecting this option.  This option
  257.   boosts the number of available ECM modules to 50.
  258.  
  259.  
  260. REPLENISH FUEL -----
  261.  
  262.   If your squadron runs out of fuel on campaign, you can replenish fuel
  263.   by selecting this option.  Boosts the amount of available fuel to
  264.   approximately 290,000 gallons.
  265.  
  266.  
  267. REPLENISH PLANES -----
  268.  
  269.   If your squadron is on campaign, and you are low on available planes,
  270.   you can replenish the planes using this option.  Also, if you want to
  271.   give yourself a challenge by _reducing_ the number of available
  272.   planes... you can use this option to do it.
  273.  
  274.   Enter a number of planes between 1 and 18.  If you attempt to use this
  275.   option on a squadron which is not active on campaign, you will receive
  276.   an error message.
  277.  
  278.  
  279. SUPPLY MANAGEMENT -----
  280.  
  281.   All other resources on campaign (weapons) can be controlled using this
  282.   function.  Your supply manifest will be shown.
  283.  
  284.   In the edit box provided, type in a new quantity you would like to
  285.   apply to the various weapons on the manifest.  To apply that quantity
  286.   to any weapon, either move the cursor to it using [TAB] and then
  287.   press [SPACE], or click on that weapon with the mouse.
  288.  
  289.  
  290. SHELL OPERATION -----
  291.  
  292.   You can use Falconer as a shell for Falcon 3.0!  Instead of running
  293.   FALCON3.EXE, use the provided F3.BAT file.  This will load Falconer,
  294.   and enable a special menu option to "Run Falcon 3.0."  After you run
  295.   Falcon 3.0 via Falconer, your squadron will be automatically reloaded
  296.   so you don't have to File..Open it again.
  297.  
  298.   At any time, regardless of whether you use F3.BAT, you can run Greg
  299.   Prete's Falcon Mapper (F3MAPS) utility.  You can also run Falconer from
  300.   within F3MAPS... thanks to coordination among members of the Flight
  301.   Simulation Forum.
  302.  
  303.  
  304. CONFIG MENU -----
  305.  
  306.   By selecting one of the Config menu options (a "bullet" appears by
  307.   the selected option), you can choose how Auto-Organize will sort your
  308.   roster.
  309.  
  310.  
  311. "YFIF3" - YOUR FACE IN F3! -----
  312.  
  313.   Version 2.5 of Falconer introduced a code module called YFIF3,
  314.   short for "Your Face in F3."  If you have a scanned photo of yourself
  315.   (or anyone else), in .PCX format and at the appropriate size, you
  316.   can replace one of the existing pilot faces with a cut-out from that
  317.   .PCX file!  The "correct" picture will then appear for you when you
  318.   fly in F3.
  319.  
  320.   IMPORTANT NOTE:  There is only one file that contains all 50 pilot
  321.   pictures, called PILOT.BIN.  Changes that Falconer makes to this
  322.   file are PERMANENT.  The first time you run Falconer 3.1, it will
  323.   make a copy of PILOT.BIN in PILOT.ABK.  If you need the stock faces
  324.   back for any reason, you may use the Restore Faces option in the
  325.   File menu.
  326.  
  327.   Select your pilot in INTERACTIVE mode, and press [F] to get to the
  328.   face editor.  You will first be asked to confirm the face to replace.
  329.   If you want to overwrite a different face, you may choose a different
  330.   face number, from 1 to 50.  If you do this, you will have to go back
  331.   into F3 to associate the new, replaced face with your pilot using the
  332.   "SELECT FACE" button.
  333.  
  334.   You will be asked for a .PCX filename.  The .PCX file must be 256
  335.   color, version 3-compatible, and preferably smaller than the 320x200
  336.   screen space (though this is not strictly necessary).  You will get
  337.   an error message or garbage on screen if you attempt to use a different
  338.   format of .PCX file.  The file should be in your Falcon 3 directory.
  339.  
  340.   If you are having format problems, the shareware program WINGIF does
  341.   an excellent job of converting other formats to .PCX and sizing them
  342.   appropriately.  Also, Windows 3.0 Paintbrush 256 color .PCX files are
  343.   compatible with FALCONER.  If you have a scanner program that runs
  344.   under Windows, try pasting to Paintbrush and saving as a .PCX file.
  345.  
  346.   At this point FALCONER must take the broad 256 color palette of your
  347.   picture, and try to mash it down into the narrow band of flesh tones
  348.   in the Falcon 3.0 palette.  Results will vary from "recognizable" to
  349.   "excellent," depending on how closely your scan matches the colors
  350.   in the Falcon palette.
  351.  
  352.   NOTE:  When your picture is displayed, you may see bright "STARS" of
  353.   white at various points.  This is because Falconer keeps one attribute
  354.   to itself to display "white" text on-screen.  Don't worry about the
  355.   "stars", they are only a display problem, and won't be saved in the
  356.   final picture.
  357.  
  358.   When the picture is displayed and the palette matched, you can select
  359.   the region to clip by moving the small black box with the arrow keys.
  360.   Press [ENTER] to confirm the region you want.  You will be reminded
  361.   that the change to PILOT.BIN is permanent, and asked to confirm the
  362.   face save operation.  If you don't like the results so far, this is
  363.   the time to bail out!  If you press [Y] the new face will be stored
  364.   permanently in PILOT.BIN.
  365.  
  366.   Tips for best results: use pictures with high contrast and a broad
  367.   band of flesh tones in the source palette.  What that means is: the
  368.   better the source scan, the better the results, basically!
  369.  
  370.  
  371. CAUTIONARY NOTICES AND LEGAL MUMBO JUMBO -----
  372.  
  373.   This program is freeware.  It may be copied freely and distributed 
  374.   as long as it is not modified in any way, and this documentation 
  375.   file is packaged with the executable program.
  376.  
  377.   No guarantees are made as to the compatibility of this program with 
  378.   Falcon 3.0D.  It has been tested thoroughly, however, remember that
  379.   the purpose of this program is to allow you to modify data that 
  380.   Falcon 3.0D does not want modified!  A combination of changes you
  381.   engineer via this program could conceivably destabilize a F3 
  382.   campaign and thence the program, though I believe it is highly 
  383.   unlikely.  It is also possible that future upgrades of F3 may be 
  384.   incompatible with this program.
  385.  
  386.   But read this carefully and understand it:
  387.  
  388.   THIS PROGRAM ALTERS FALCON 3.0D DATA.  ANY DAMAGE TO YOUR SYSTEM OR
  389.   FILES, EITHER DIRECT, INCIDENTAL, OR CONSEQUENTIAL, WILL NOT BE THE 
  390.   RESPONSIBILITY OF THE AUTHOR OF "FALCONER."  ADDITIONALLY, NO 
  391.   GUARANTEES ARE MADE CONCERNING SUPPORT OF THIS SOFTWARE.
  392.  
  393.  
  394. SUPPORT ANYWAY -----
  395.  
  396.   At the present, I am available to support this file via the Flight 
  397.   Simulation Forum on Compuserve (GO FSFORUM).  Leave a message in 
  398.   section 8, Modern Air Combat, if you have questions, comments, or 
  399.   suggestions about this program, or would like to solicit help with a 
  400.   problem.
  401.  
  402.  
  403. ABBREVIATIONS USED IN THE SCREEN AND PRINTED ROSTERS -----
  404.  
  405.   DGFT    =    Dogfighting Skill
  406.   BOMB    =    Bombing Accuracy
  407.   FLYG    =    Flying Skill
  408.   FATG    =     Fatigue
  409.   RANK    =    Rank
  410.    COL    =    Colonel
  411.    LTC    =     Lt. Colonel
  412.    MAJ    =    Major
  413.    CAPT    =    Captain
  414.    LT    =    Lieutenant
  415.   STAT    =    Pilot Status
  416.    ACTV    =    Active
  417.    KIA    =    Killed in Action
  418.    MIA    =     Missing in Action
  419.    INJ    =    Injured
  420.    C.M.    =    Court-Martialled
  421.    RET    =    Retired
  422.  
  423.  
  424. ADDITIONAL ABBREVIATIONS IN THE PRINTED ROSTER -----
  425.  
  426.   SORT    =    Sorties Flown
  427.   ATAK    =    Air To Air Kills (total)
  428.   ATGK    =    Air To Ground Kills (total)
  429.  
  430.  
  431. AWARD ABBREVIATIONS -----
  432.  
  433.   MOH   =       Medal Of Honor
  434.   AFC   =       Air Force Cross
  435.   SS    =       Silver Star
  436.   FC    =       Flying Cross
  437.   BS    =       Bronze Star
  438.   AM    =       Air Medal
  439.   PH    =       Purple Heart
  440.  
  441.  
  442. RELEASE HISTORY -----
  443.  
  444.   Release 1 --- provided for editing of pilot abilities and fatigue only.
  445.  
  446.   Release 2 --- enhanced and redesigned version with export, import, and
  447.                 printing features, as well as pilot resurrection and
  448.                 waterline adjustment.  Uploaded to CIS for a brief
  449.                 period... few if any copies in existence.
  450.  
  451.   Release 2a -- stabilized Sierra Hotel system, added plane replenisher
  452.                 feature based on FSFORUM input prior to the LIB inclusion
  453.                 of Release 2.  Only one copy made, for Steve "Auger"
  454.                 Edwards of FSFORUM.
  455.  
  456.   Release 2b -- included award grant/rescind system at the request of
  457.                 Steve Edwards.  Uploaded to CIS.
  458.  
  459.   Release 2.5 - necessary because of new .CAM file structure in Falcon
  460.                 3.0c, incompatible with previous versions.  Incorporates
  461.                 basic SMS/YFIF3 functions.
  462.  
  463.   Release 3.0 - includes shell operation.  Fixes bugs.  Works with 3.0D.
  464.                 Incorporates lateral scanner to prevent minor revisions
  465.                 from locking up system.  Face and squadron exporting.
  466.  
  467.   Release 3.1 - numerous minor revisions from 3.0.  Sort modes added to
  468.                 Auto-Organize.  Lateral scanner bypass implemented.
  469.                 YFIF3 parts changed to assembler for speed.  Prompt for
  470.                 save added.  Stack expanded to prevent lockups.  Auto
  471.                 reload feature added.
  472.  
  473. ENDNOTES -----
  474.  
  475.   Did you read the README.NOW file?  You really should, if you haven't!
  476.  
  477.   If you are getting this file from a BBS somewhere or another online
  478.   service --- please, drop in on FSFORUM, you don't know what you're
  479.   missing.  Give me a buzz in area 8.  Internet fiends, you can of course
  480.   reach me at 72700.1067@compuserve.com.
  481.  
  482.   Good luck, god speed, and for heaven's sake CHECK SIX!
  483.  
  484.                                          - Rob Heittman [FSFORUM]
  485.