home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / anim / players / displ329.lha / Display.doc < prev    next >
Text File  |  1989-09-21  |  7KB  |  204 lines
  1. Display V3.29
  2.  
  3.  
  4. The Display module plays animations.  It understands several
  5. foramts, including: ANIM opt 3, ANIM opt 4, ANIM opt 5, Hash, and
  6. IFF animations.  All resolutions are supported, including HAM and
  7. PAL.  It is extremely versitile and useful.
  8.  
  9. LOAD ANIMATION REQUESTER
  10.  
  11.     A requester lets you select the animation that you want to
  12. play.  To exit the Display module, click the Cancel gadget in the
  13. requester.  The requester recognizes Hash and IFF animation
  14. directories, so it lists them as files.  To select an animation,
  15. click on the filename, then click the Load gadget.  It can take
  16. several minutes to load.  You can abort the loading at anytime by
  17. pressing the <esc> key on the keyboard.  If the animation is
  18. packed using the Hash format, the animation name will be suffixed
  19. with "PAC".  ANIM format animations may have no suffix or an
  20. "anim" suffix.  IFF format animations have "IFF" in the suffix. 
  21. The Snooze pointer will appear while the animation is loading.
  22.  
  23.     After the animation is loaded, it will begin playing.  If
  24. there is not enough memory for the entire animation, then only as
  25. much as can be loaded will play.  Hash format animations will
  26. "bounce", meaning they play from the beginning to end and back,
  27. continuously.  ANIM format animations "loop", meaning they cycle
  28. from beginning to end, then start over.  If the loading process
  29. is aborted by pressing the <esc> key, the animation only plays up
  30. to the last frame that was loaded into memory before the <esc>
  31. was pressed.  Pressing the <esc> key again while the truncated
  32. animation is playing will exit the animation.
  33.  
  34. PLAYING SPEED
  35.  
  36.     The function keys, <F2> through <F10> on the keyboard,
  37. control the playing speed.  Some animations will play at faster
  38. speeds.  This depends upon the amount of changes between each
  39. frame, the resolution, and whether or not the computer has an
  40. accelerator board.
  41.  
  42.         Key                Frames per Second
  43.  
  44.         <F2>                30    (if achievable)
  45.         <F3>                20    (if achievable)
  46.         <F4>                15    (if achievable)
  47.         <F5>                12    (default)
  48.         <F6>                10
  49.         <F7>                8
  50.         <F8>                6
  51.         <F9>                5
  52.         <F10>            4
  53.  
  54.     The <up/down arrow> keys on the keyboard also adjust the playing speed.
  55.  
  56.         Key                Function
  57.         
  58.         <up arrow>        increase by 1 frame per second
  59.         <down arrow>        decrease by 1 frame per second
  60.  
  61. DIRECTION
  62.  
  63.     The <left/right arrow> keys can change the animation's
  64. direction in Hash format ONLY.  They also pause the animation and
  65. advance the frame by one.
  66.  
  67.         Key                Function
  68.  
  69.         <right arrow>        animation advances forward 1 frame
  70.         <left arrow>    animation advances backward 1 frame
  71.  
  72. CONTINUOUS
  73.  
  74.     Some ANIM format animations have a special mode called
  75. "continuous", which has the first and second frames of the
  76. animation repeated at the end for smooth looping in high
  77. resolutions.  DPaint III stores ANIM files this way.
  78.  
  79. ONE SHOT (Video Mode)
  80.  
  81.     Of course, you may want to put your animation onto
  82. videotape.  When you record to video, you will want the animation
  83. to start at the beginning, (maybe hold a moment or two), then
  84. play through once, and finally, possibly hold for several
  85. seconds.  The One Shot mode allows you to do this easily and
  86. quickely.  Press the <o> key to activate One Shot mode.  The
  87. animation will pause until you press the left mouse button or
  88. <space> bar again.  The One Shot mode will remain activated until
  89. you press the <o> key a second time.
  90.  
  91. KEYBOARD COMMANDS
  92.  
  93.         Other keys are defined as follows:
  94.  
  95.         Key                Function
  96.  
  97.         <L> or <l>    toggle looping (Hash format only)
  98.         <O> or <o>    toggle "one-shot"
  99.         <C> or <c>    toggle "Continuous" (ANIM format only)
  100.         <M> or <m>    toggle mouse control
  101.         <P> or <p>    toggle pointer
  102.         <S> or <s>    toggle overscan
  103.         <B> or <b>    push Display screen to back
  104.         <esc>        quit playing or abort loading
  105.         <return>        toggle frame number
  106.         <enter>        speak frame number
  107.         <space>        unpause
  108.  
  109. RUN FROM THE CLI (Command Line Interface)
  110.  
  111.     To run the Display module from the CLI, use the following
  112. example.  
  113.  
  114.     Display -flags animationpathname
  115.  
  116.     flag            Definition
  117.  
  118.     C/c            -continuous
  119.     L/l            -looping (Hash only)
  120.     Fn/fn        -frame rate followed by a decimal number
  121.                 indicating the frames per second
  122.     O/o            -One Shot
  123.     M/m            -multiple files
  124.  
  125.     Frame Rate
  126.  
  127.     The animation playing speed, or frame rate, can be specified
  128. with the CLI command using the "f" or "F" flag, followed by the
  129. number of 1/60th of a second ticks you want.  For example, if you
  130. want the animation to play at 10 frames per second, divide 60 by
  131. 10 to get 6 ticks.  The animation will play no faster, depending
  132. on the issues stated above.  Keyboard control of the playing
  133. speed using the function keys override the frame rate command.
  134.  
  135. EXAMPLE
  136.  
  137.     Display -LF5 frames:anim/animationtest.PAC
  138.  
  139.     The above command states that a Hash format animation is to
  140. be loaded and played in the looping mode at 12 frames per second. 
  141. Since Display is being run from the CLI, no Animation requester
  142. will appear, (unless you specify "-M" for multiple files).
  143.  
  144. SUFFIX
  145.  
  146.     Hash format animations are identified by a "PAC" suffix on
  147. the filename.
  148.  
  149.     IFF format animations are identified by a "IFF" suffix on
  150. the filename.
  151.  
  152.     All other filenames are considered to be in ANIM format.
  153.  
  154. LOADING MULTIPLE DISK ANIMATIONS
  155.  
  156.     When you run the Display module from the CLI you can specify
  157. multiple filenames to be run all together as one animation, (even
  158. if they are on different disks), for Hash format ONLY.  Each
  159. animation must start with the last two frames of the previous
  160. one.  After the first file is loaded, the Load Animation
  161. requester will appear again.  You select another filename and it loads onto first one.  Again, the requester will appear.  You can
  162. combine as many files as you have memory for.  Click the Cancel
  163. gadget to start playing the combined animation.
  164.  
  165. IFF ANIMATIONS
  166.  
  167.     The IFF animation format consists of a directory, (which is
  168. the animation name), under which is a series of IFF pictures
  169. numbered consecutively: "1", "2", "3", "4"...  The Load Animation
  170. requester recognizes IFF animations because of the "IFF" suffix
  171. on the animation name.  When you select an IFF format animation
  172. filename, a second Load Animation requester will appear with the
  173. filenames "1", "2", etc.  Click on the frame you want to see,
  174. then click the Load gadget, the frame will be displayed. 
  175. Subsequent clicks of the left mouse button will show successive
  176. frames.  Clicking the right mouse button will return you to the
  177. requester so that you can select another frame.  Click the Cancel
  178. gadget to exit the IFF format.
  179.  
  180. VIEWING SINGLE IFF PICTURES
  181.  
  182.     If you click on a filename that is a single IFF picture the
  183. Display program will load and show that picture.  Hit the <esc>
  184. key to return to the requester.
  185.  
  186. NOTES ABOUT VERSION 3.29
  187.  
  188. This version of Display plays the animation on a draggable
  189. screen.  This means you can still multitask.  This version is
  190. also compatable with Animation:Soundtrack.  Included with this
  191. version of Display is "st_player", which enables you to play
  192. soundtrack files along with your animation.  If a soundtrack
  193. choreography and the sound files are present and the player can
  194. find them, Display will play the sounds with the animation. 
  195. Please consult the Animation:Soundtrack manual for further
  196. details.
  197.  
  198.     Display is being placed in the Public Domain by Hash
  199. Enterprises.  It is freely distributable as long as this .doc
  200. file, st_player, and Display.info are included.
  201.  
  202. Enjoy!
  203.     Hash Enterpises
  204.