home *** CD-ROM | disk | FTP | other *** search
/ Game Killer / Game_Killer.bin / 795.DEMITOR.DOC < prev    next >
Text File  |  1990-02-11  |  24KB  |  595 lines

  1.  
  2.  
  3.       DEMITOR version 1.0                (c) 1990 Laemming Wheeler
  4.  
  5.  
  6.  
  7.       INTRODUCTION
  8.       ************
  9.  
  10.       DEMITOR is a powerful editor for use with  Flight  Simulator
  11.       version 4 (IBM) demo files.  Using DEMITOR will allow you to
  12.       produce  higher  quality demos in much less time (this means
  13.       MORE flying time). Features:
  14.  
  15.       *    Edit comments and keys; both content and timing
  16.       *    Cut and splice demos
  17.       *    Link and remove mode files
  18.       *    Knock out sound during stall warnings
  19.       *    Use MACRO command language for easy view selection
  20.       *    Move message bar down and up during demo
  21.       *    Center text in message bar for easy viewing
  22.       *    Use special preview format for precise demo development
  23.       *    And more
  24.  
  25.  
  26.       DEMITOR is a shareware product;  if you find it a useful ad-
  27.       dition  to  your FS enjoyment,  please send the $10  DEMITOR
  28.       license fee to:
  29.  
  30.           Kyrna Wheeler
  31.           KikiWare
  32.           17 Ferguson Road
  33.           Warren, NJ
  34.           07060   USA
  35.  
  36.       Please include your return address or CIS # and specify  the
  37.       version you are licensing. Thank you,
  38.                                         Laemming Wheeler
  39.                                         DEMITOR author/Kyrna's dad
  40.                                         CIS 71317,2616
  41.  
  42.  
  43.       HOW DEMITOR WORKS
  44.       *****************
  45.  
  46.       A  simple  "demo"  is a file (extension: DEM) that preserves
  47.       the path of the aircraft and history of keys pressed  during
  48.       the  creation  of the demo,  and also stores comments (which
  49.       may have been added later) in a format similar to how movies
  50.       store information -- FRAMES.  DEMITOR reads these frames and
  51.       shows the comments and key-presses associated with each one,
  52.       allowing them to be changed as desired.  Demos may  be  more
  53.       complicated:  they  may  have MODE files attached.   DEMITOR
  54.       reads these too,  and will preserve them or delete  them  as
  55.       desired.
  56.  
  57.       While adding, removing, and editing comments are the easiest
  58.       activities  to understand and use,  doing the same with key-
  59.       press series requires some translation:  the  numbers  found
  60.       and displayed by DEMITOR are representations of the keys ac-
  61.       tually  pressed  during  the recording of the demo (the keys
  62.       themselves are translations of an action desired).
  63.  
  64.       For example:
  65.  
  66.       Action desired-     change the view direction to rear, left
  67.       First translation-     scroll-lock, PgDn keypresses
  68.       Second translation -   70,79 (scan codes of the keys)
  69.  
  70.       You've probably learned the first  translation  from  flying
  71.       Flight Simulator;  as for the second translation- better let
  72.       DEMITOR do it.  DEMITOR allows the entry of special comments
  73.       (which  shall be referred to as "macro commands") as if they
  74.       were normal comments.  After all the special macro  commands
  75.       (and comments) are entered,  DEMITOR will do the translation
  76.       automatically and store the results as key-press series.
  77.  
  78.       The  macro  command  translation  dictionary  is   a   user-
  79.       accessible text file called DEMITOR.KEY.  Make a printout of
  80.       this file for a complete list  of  macro  commands  supplied
  81.       with  this  version  of DEMITOR and detailed instructions on
  82.       what they do, how to use them,  and how to add your own cus-
  83.       tom macro commands to the file.
  84.  
  85.       In the above example, you would simply enter a macro command
  86.       "view(left,rear)"  and  (T)ranslate the file before (S)aving
  87.       to achieve the desired effect.
  88.  
  89.       Since timing of comments and views  is  often  important  in
  90.       demos,  DEMITOR  provides  another way to enter comments and
  91.       macro commands;  the storyboard file.   This is a  file  you
  92.       create  yourself  (using  your  favorite  non-formatted text
  93.       editor) with the extension BRD.  It  simply  consists  of  a
  94.       series  of lines describing which frame and what comment (or
  95.       macro) should be inserted. In our example,  if you wanted to
  96.       perform the view change at frame 51 the line would look like
  97.       this:
  98.  
  99.       51,"view(left,rear)"
  100.  
  101.       DEMITOR allows you to (I)mport the entire collection of com-
  102.       ments and macro commands.  (T)ranslate the result and (S)ave
  103.       the file and you now have a  demo  that  switches  the  view
  104.       direction to left,  rear at frame 51.  If in review you feel
  105.       that the view switch should take  place  one  frame  earlier
  106.       just change the frame reference in your story board file (to
  107.       50,"view....).   Reload  the  original  demo  into  DEMITOR,
  108.       (I)mport, (T)ranslate and (S)ave.
  109.  
  110.       There's a lot more we'll get  into  later.  First  let's  go
  111.       through  the  menus  to get a taste of all the options,  and
  112.       then discuss how to use them in a  practical  situation  (go
  113.       through the next section lightly;  you can come back for the
  114.       details when you need them).
  115.  
  116.  
  117.       DEMITOR MENUS
  118.       *************
  119.  
  120.       GENERAL
  121.       -------
  122.       DEMITOR.EXE and DEMITOR.KEY should reside in the same direc-
  123.       tory as your demos. Type DEMITOR<enter> to get started.
  124.  
  125.       The file DEMITOR.KEY must be present for DEMITOR to work.
  126.  
  127.       A hardcopy listing of DEMITOR.KEY should be  made  and  kept
  128.       handy as a reference.
  129.  
  130.       When  filenames  are requested the extension is optional and
  131.       understood to be DEM (exception: in the splicing menu  where
  132.       the  first  file  may  be  either  DEM  or  MOD  and must be
  133.       specified.
  134.  
  135.  
  136.       LOAD Menu
  137.       ---------
  138.       (S)elect demo: asks for the name of the demo to be loaded
  139.  
  140.       (L)ist demos: gives a listing of demos in the default direc-
  141.       tory
  142.  
  143.       (U)tilities: enter splice menu (allows linking of  modes  to
  144.       demos, demos to demos, and stealing a mode from another demo
  145.       for linking)
  146.  
  147.  
  148.       Load Notes:
  149.  
  150.       No extension is required for LOAD (always .DEM)
  151.  
  152.       If the requested file does not exist,  another filename will
  153.       be requested.
  154.  
  155.  
  156.       UTILITIES (Splice menu)
  157.       -----------------------
  158.       You must enter the names of two files  that  you  intend  to
  159.       connect together.  The first may be an existing demo or mode
  160.       file; the second,  an existing demo file.  When entering the
  161.       selection for the first file you must include the extension.
  162.       When  two  valid  files  have  been  entered  (in any order)
  163.       DEMITOR analyses them and proposes  the  splice  formula  it
  164.       will use.
  165.  
  166.       This  formula is not changeable directly but will serve as a
  167.       confirmation to those familiar  with  the  details  of  demo
  168.       splicing  that their choices are correct.  There is one com-
  169.       bination that DEMITOR needs  some  further  input  about  to
  170.       clarify  your intentions: when the first file is a demo with
  171.       a leading mode and the second, a demo file without a leading
  172.       mode. Here you are given the choice to do a straight demo to
  173.       demo splice or to "steal" only the leading mode of the first
  174.       file and link it to the second.
  175.  
  176.       When ready to do the splicing an output file selection  menu
  177.       will appear. The output file must be a demo and if no exten-
  178.       sion  is entered DEM is assumed.  It is forbidden by DEMITOR
  179.       to save back to the source file.  Progress  in  splicing  is
  180.       displayed  with  file  sizes  during the splicing operation.
  181.       Completion and acknowledgment will return you  to  the  LOAD
  182.       menu.
  183.  
  184.  
  185.       MAIN menu
  186.       ---------
  187.  
  188.       (I)mport: bring in a storyboard file
  189.       (V)iew: read and search frame contents
  190.       (T)ranslate:  interpret  and  activate  all  macro  commands
  191.       (M)ark: enable frame numbers to be shown onscreen during
  192.               playback
  193.       (S)ave: enter save menu
  194.  
  195.  
  196.       IMPORT
  197.       ------
  198.       This function requires a "storyboard" file existing  in  the
  199.       same directory having the same name as the loaded demo and a
  200.       .BRD  extension.    If this file is not present this feature
  201.       will do nothing. See story board notes later on.
  202.  
  203.  
  204.       MARK
  205.       ----
  206.       This feature will put  the  frame  #  into  all  uncommented
  207.       frames  of  the  loaded  demo.   This is never used on final
  208.       "takes" but on intermediate review copies.   Be careful when
  209.       naming  the review copies in order to avoid confusion ("now,
  210.       let me see, I think I called it...").
  211.  
  212.       Because  comments  that  are  not  immediately  followed  by
  213.       another will last on the screen longer than otherwise, using
  214.       (M)ark  will  cause artificially shorter screen life of com-
  215.       ments,  during the review playback (no big deal,  just  take
  216.       that  into account).   (M)arks also consume memory and bring
  217.       you a bit closer to FS4's demo size limit  (unspecified  but
  218.       you'll know it when you reach it).
  219.  
  220.  
  221.       TRANSLATE
  222.       ---------
  223.       This  feature will look through the loaded demo and identify
  224.       macro command instructions for key press insertions or  spe-
  225.       cial effects and automatically implement these.  If some in-
  226.       structions appear to be missed it will be due to misspelling
  227.       or that they do not appear on your current DEMITOR.KEY file.
  228.  
  229.       A  good  way  to  check  for  macro  "misfires"  is,   after
  230.       (T)ranslation, go into (V)iew and find (C)omments: this will
  231.       show all comments in sequence, one by one.  Since a success-
  232.       ful (T)ranslation of a macro command results in that command
  233.       being  removed  from  the comment section of the frame,  any
  234.       missed macros (e.g.- zooom(in) [should have been  zoom(in)])
  235.       will still be present and (V)iewable as a comment.
  236.  
  237.       (T)ranslation does not automatically take place when you use
  238.       the  (I)mport function.  You must (T)ranslate the (I)mported
  239.       and/or edited frames subsequent to their entry (if they  in-
  240.       volve    macro   commands;    regular   comments   need   no
  241.       (T)ranslation).  This is so you may save the raw entries  if
  242.       you  choose  (e.g.  -  to make a nice review copy of a demo,
  243.       (I)mport then (T)ranslate then (I)mport again.  When you run
  244.       this  demo  it  will  display  the  commands  as it executes
  245.       (hopefully) their actions.  If you do this DEMITOR will warn
  246.       you  that  you  are saving an un(T)ranslated file;  just say
  247.       yes, proceed anyway, in this special case).
  248.  
  249.  
  250.       (V)IEW (brings you to Frame view/edit menu)
  251.  
  252.       FRAME VIEW/EDIT menu
  253.       --------------------
  254.       (F)rame #:
  255.       (N)ext:
  256.       (P)revious:
  257.       find (C)omment:
  258.       or (K)ey:
  259.       (E)dit:
  260.       <esc>:
  261.  
  262.       First select the frame to  be  displayed  by  any  of  these
  263.       methods:
  264.  
  265.       (F) allows a specific frame # to be entered
  266.       (N) displays the next frame
  267.       (P) displays the previous frame
  268.       (C) will find the next commented frame
  269.       (K)  will  find  the next frame containing special keys per-
  270.       taining to view mode changes, view direction changes, map or
  271.       menu calls
  272.  
  273.       (E) allows editing of the currently displayed frame.    Good
  274.       for  manual touchup of comments and keys,  any key-press ex-
  275.       perimentation, and removal of extraneous key press sequences
  276.       (careful,  here,  that you don't screw  up  due  to  related
  277.       keypresses  appearing  in  multiple  frames-  see  Strategic
  278.       Considerations).
  279.  
  280.       Longer-than-standard comments are allowed (up to 70  charac-
  281.       ters)  When  saving you may choose to have the comments cen-
  282.       tered in the menu bar during playback or  left-justified  as
  283.       usual.
  284.  
  285.       Editing by hand is not generally recommended for use in con-
  286.       junction  with  the Import feature except on initial cleanup
  287.       of your demo (if you're using the import feature it's better
  288.       to make corrections to the storyboard file,   and  the  mode
  289.       instead  of correcting the modified demo by hand in order to
  290.       retain maximum flexibility in the development process).
  291.  
  292.       To delete an existing comment, (E)dit (C)omment <enter>.
  293.       To delete existing keys, (E)dit (K)eys <enter> (a harmless 0
  294.       will remain for that frame). For example, let's say you used
  295.       a map during the recording of your original demo,  but  have
  296.       decided  that  the map display is not helpful to the purpose
  297.       of the demo,  and you desire to remove  it:  first  identify
  298.       what the key series is for map (look at the DEMITOR.KEY file
  299.       and  observe  that "map(on)" = one key [69].  Next,  fire up
  300.       DEMITOR,  load the demo and  locate  this  key  (either  use
  301.       (V)iew  and  find ...(K)ey or make a marked demo and observe
  302.       the frame number at which the map turns on).  Choose  (E)dit
  303.       (K)eys and type in the all the keys in that frame except for
  304.       the [69].  The demo,  when saved will not have a map on com-
  305.       mand and therefore the map will no longer appear, as desired
  306.       (if you're a perfectionist,  you can knock off  the  map-off
  307.       keys [69,69],  as well,  in the same manner). This "cleaned-
  308.       up" demo now becomes the original for the  purposes  of  the
  309.       remaining editing or storyboard use.
  310.  
  311.       <esc> returns you to the main menu
  312.  
  313.  
  314.       SAVE menu
  315.       ---------
  316.       (S)elect: to enter the name of the demo to be saved
  317.       (L)ist: to get a listing of demos in the default directory
  318.       <esc>:  return to main menu (for those times when you remem-
  319.       ber something you forgot to  do;  like  (T)ranslate)  before
  320.       saving)
  321.  
  322.       When (S)aving you'll be asked about some options:
  323.  
  324.       If  the file has modes attached you will be given the option
  325.       to keep them or drop them.
  326.  
  327.       If the file exists you will be asked if you  want  it  over-
  328.       written.
  329.  
  330.       You  will  be  asked  if you want the message text centered.
  331.       While this option  offers  excellent  readability,  it  will
  332.       result in a larger file;  so if you are pushing the FS4 demo
  333.       size limit with your creation you just might want to  answer
  334.       no  to this one.  (M)arked frames are never centered for ob-
  335.       vious reasons, no matter what the reply to this question is.
  336.  
  337.       No extension is required when selecting the SAVE file  (it's
  338.       always DEM)
  339.  
  340.       It is forbidden by DEMITOR to save back to the source file.
  341.  
  342.       The  program  does terminate after saving.  To terminate the
  343.       program without saving choose Q at the MAIN menu.
  344.  
  345.  
  346.       DISCUSSION
  347.       **********
  348.  
  349.       STRATEGIC CONSIDERATIONS
  350.       ------------------------
  351.       You have more options available to you with DEMITOR  so  you
  352.       may  choose  to  alter your strategy when actually recording
  353.       the original demo (compared to pre-DEMITOR approaches).  For
  354.       example,  where the pre-DEMITOR strategy might have been  to
  355.       squeeze  in  every  single  possible view mode and direction
  356.       commands into the demo as  it's  being  recorded  (how  else
  357.       could you get them in there?), with DEMITOR you might choose
  358.       just  the  opposite  -  including  only  those commands that
  359.       enable you to fly the demo properly;  you know that you  may
  360.       add,  move or delete these entries as you desire,  after the
  361.       demo has been recorded.
  362.  
  363.       The next step after recording an acceptable version  of  the
  364.       demo  flight  is  to watch it a few times in order to decide
  365.       when and how it should be annotated (where to put what  com-
  366.       ments) and when and which additional view changes are needed
  367.       (and,  perhaps,  which  existing ones are no longer needed -
  368.       [e.g.- you might have consulted your map <Num Lock> to  help
  369.       you  find  your  way  but  decide  not to keep it because it
  370.       doesn't support the purpose of your demo]).
  371.  
  372.       This is an excellent time to use  the  (M)ark  feature:  run
  373.       DEMITOR,  load your original demo,  and choose (M)ark,  then
  374.       save to a DIFFERENT!  filename (you might add an "M" to  the
  375.       name).    This  (M)arked  demo is the one to review and take
  376.       notes about.  The frame numbers that appear  will  help  you
  377.       with the timing of the ideas you want to implement.   In ad-
  378.       dition to opportunities for comments and view commands,  you
  379.       should  also  note any particularly sensitive areas that you
  380.       want to make certain not to disturb.
  381.  
  382.       These areas are characterized by occurring over  a  span  of
  383.       frames,  not  just within one frame only.  A good example of
  384.       this is when a menu is called up during a demo- it  is  rare
  385.       for all the keys to be recorded for that action in one frame
  386.       only.  Therefore,  even  though  DEMITOR  *appends*  the key
  387.       series resulting from (T)ranslating a macro command  to  the
  388.       keys already in the designated frame, it has no way of know-
  389.       ing  for certain if these existing keys are part of a larger
  390.       sequence that may be disturbed by extra keys showing up.
  391.  
  392.       So by noting any sensitive areas you may easily be  able  to
  393.       avoid  asking  DEMITOR  to  disturb  these sections inadver-
  394.       tently. A corollary to this is;  if you see any inexplicable
  395.       funny  stuff popping up suddenly in a once-stable area,  you
  396.       may suspect the  possibility  that  you  have  inadvertently
  397.       asked  DEMITOR  to  stick some keys where they shouldn't go.
  398.       This will be rarely,  if at all,  a problem but it's best to
  399.       be forewarned, hence the disproportionate verbiage.
  400.  
  401.       When  you  do  have  a  good idea of what you're going to do
  402.       mapped out (hard copy, I hope) you pop back into DEMITOR and
  403.       call back the original demo (not the marked one).
  404.  
  405.       If you definitely want to get rid of  something  permanently
  406.       (like  the  map  views-  see  previous example) then use the
  407.       frame view/edit functions to do this (do it  in  conjunction
  408.       with  those notes you took).  After deleting every thing you
  409.       don't want,  (S)ave this as a new demo and use this cleaned-
  410.       up version as your original.
  411.  
  412.       How  you  introduce  the  comments  and  view changes,  etc.
  413.       depends on the quantity and the  degree  of  confidence  you
  414.       have  in  knowing where these should occur.  Few changes and
  415.       high confidence means use the editor directly to  enter  the
  416.       info (if you are using macro command instead of entering key
  417.       sequences  directly,  you  might  consider  saving this file
  418.       before you (T)ranslate it to make changes easier  to  do  if
  419.       necessary.   Extensive  comments  and  view  changes,  panel
  420.       switching,  etc.  and uncertainty  over  timing  (needs  ex-
  421.       perimentation) would imply using the story board technique.
  422.  
  423.       You'll  quickly  develop your own comfortable style once you
  424.       start playing with a few demos and see  what  each  part  of
  425.       DEMITOR has to offer.
  426.  
  427.  
  428.       STORYBOARD FILES
  429.       ----------------
  430.       These  files  must  have  the  same root name as the demo on
  431.       which it's intended to operate and the  extension  BRD.    A
  432.       storyboard  file is an ASCII text file that you create which
  433.       describes the macros,  and comments you want to place in the
  434.       demo and their locations (frame numbers). The format is
  435.  
  436.        [frame number],macro or text surrounded by quotes
  437.        .
  438.        .
  439.        0,"documentation comments"
  440.        .
  441.        .
  442.        -1,"end of file"
  443.  
  444.  
  445.       See the example     DEMITOR.BRD
  446.  
  447.       If you (M)ark a freshly made demo  and observe it running on
  448.       FS for a few cycles you should be able to get a good idea of
  449.       comments and view changes you'd like to use, and where. Make
  450.       some  notes  and use EDLIN or a non-formatted word processor
  451.       to generate a storyboard text file.   It's best to have  the
  452.       steps  in  order  of  frame  number  but not necessary (just
  453.       confusing).   In the event of duplicate frame numbers  being
  454.       present,  the  one  with  the latest postmark wins.   In the
  455.       event that a frame number is larger than the total frames in
  456.       a demo, it will be ignored.  There is no limit on the number
  457.       of entries in a storyboard file.   Comments longer  than  70
  458.       chars  will be truncated.   If you have a typo in a macro it
  459.       will show up as a comment in the demo,  after  (T)ranslation
  460.       for easy identification.
  461.  
  462.  
  463.       MINI-TUTORIAL
  464.       -------------
  465.       Fire up DEMITOR,  load DEMITOR.DEM,  (I)mport,  (T)ranslate,
  466.       (I)mport again,  and (S)ave (yes,  you want to  proceed...),
  467.       choosing the centered message option.   Fire up FS4 and take
  468.       a look at what you just did! Try again, using the (M)ark op-
  469.       tion, or add a comment of your own, or ...
  470.  
  471.  
  472.       ERRORS/PROBLEMS
  473.       ---------------
  474.       Troubles may show up in two ways:
  475.  
  476.       DEMITOR exiting with an error message (for  example-  if  it
  477.       cannot  recognize  a  mode  attached to a demo,  say the $8A
  478.       linking byte was left out during a manual link)
  479.  
  480.       or
  481.  
  482.       FS4 has difficulty in "flying" the edited demo (if you  have
  483.       loaded up one or more frames with too many keys [no, I don't
  484.       know  what's  too many;  it seems to depend on what the keys
  485.       are trying to do and the machine it's running on]).
  486.  
  487.       If the latter,  first reboot your system and retry the  demo
  488.       (just in case you are seeing the effects of a previously ob-
  489.       tained electronic hernia) before concluding that the trouble
  490.       is with the current demo.
  491.  
  492.       LIMITATIONS (known)
  493.       -------------------
  494.       Frames: 2000
  495.  
  496.       Macros in the KEY file: 100
  497.  
  498.       Embedded Mode files: 10 in addition to leading mode
  499.  
  500.  
  501.       REFERENCES
  502.       ----------
  503.       Microsoft Flight Simulator version 4 manual
  504.  
  505.       DEMOS.TXT: Jim Ross' instructive text  on how to make demos;
  506.       found in CIS GAMERS LIBRARY 10
  507.  
  508.  
  509.       ACKNOWLEDGMENTS
  510.       ---------------
  511.       The humor,  constructive criticism,  infallible bug-hunting,
  512.       hours of dedicated demo discovering and  the  friendship  of
  513.       the BETA team, Jim Ross and Mike Ward, have been a reward in
  514.       itself for the author.
  515.  
  516.       Encouraging discussions with Rick Lee and Jeff Horrocks, en-
  517.       thusiastic  flight  simulator  Section  Leaders on CIS,  and
  518.       Chris Manrique of SubLOGIC Corporation helped  immensely  in
  519.       trying to sort out what's important to FS4 fans.
  520.  
  521.       The  original  demo creator,  himself,  Hugo Feugen of Bruce
  522.       Artwick Organization, not only contributed encouragement and
  523.       wishes for increased popularity and use of the demo capacity
  524.       of FS;  he provided the key to splicing  demos  and  linking
  525.       modes.
  526.  
  527.       Finally  to  the  (unsuspecting)  suppliers of test material
  528.       (demos) that I used to  test  and  exercise  the  developing
  529.       editor prototypes: Charlie Gulick (RCFLYING: by far the most
  530.       key  presses),  Jeff Givens (VEALSILS: longest,  most memory
  531.       intensive),  and Rick Lee (his creative HIJACKER will become
  532.       a classic), I give my thanks. Thanks go as well to all those
  533.       demo-makers,  showing the potential for this most share-able
  534.       aspect of FS4.
  535.  
  536.  
  537.       LEGAL STUFF
  538.       -----------
  539.       Flight Simulator is a registered trademark of SubLOGIC  Cor-
  540.       poration used under license by Microsoft Corporation.
  541.  
  542.       Microsoft  is  a  registered trademark of Microsoft Corpora-
  543.       tion.
  544.  
  545.       IBM is a  registered  trademark  of  International  Business
  546.       Machines Corporation.
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.