home *** CD-ROM | disk | FTP | other *** search
/ The AGA Experience 2 / agavol2.iso / c / ppanim.doc / ppanim.doc
Text File  |  1978-08-11  |  9KB  |  224 lines
  1.  
  2.  
  3.                            PPAnim 1.0b User Manual
  4.  
  5.                                  Sep 22, 1991
  6.  
  7.  
  8.  
  9. Preface
  10. =======
  11.  
  12.    The programs and files in this distribution are freely distributable, but
  13. are also copyright (c) Nico François.  They may be freely distributed as long
  14. as no more than a nominal fee is charged to cover time and copying costs.
  15.    No commercial usage is permitted without written permission from the
  16. author.  Everything in this distribution must be kept together, in original
  17. unmodified form.
  18.  
  19.    The above is generally known as freeware.
  20.  
  21.    Coverdisks or diskmagazines need written permission of UGA to offer the
  22. Powerpacker utilities or Powerpacker/Reqtools libraries on their disk. For
  23. commercial use please read the copyright file on your original PP disk.
  24.  
  25.  
  26.    If you have suggestions or remarks about this program, or if you find
  27. any bugs, please let me know.
  28.  
  29.    Write to the following address:
  30.  
  31.                                 Nico François
  32.                                 Corbielaan 13
  33.                                 B-3060 Bertem
  34.                                 BELGIUM
  35.  
  36.  
  37. Contents
  38. ========
  39.  
  40. 1. An introduction
  41.  
  42. 2. Usage
  43.  
  44. 3. Features
  45.  
  46.  
  47. 1. An introduction
  48. ==================
  49.  
  50.    PPAnim was written to complement one of my other utilities, PowerPacker
  51. (a command and data cruncher).  It is used to play normal IFF ANIM #5 files or
  52. ANIM files crunched with PowerPacker.  The decrunching is done automatically
  53. so the user does not have to know if a file is crunched or not.  The ANIM #5
  54. format is used by most ANIM generating programs, including DPaint III and
  55. Videoscape 2.0.
  56.  
  57.    PPAnim uses 'powerpacker.library' and 'reqtools.library', so make sure
  58. these are present in your Libs: directory.  Double-click 'Install_libs' for
  59. an automatic installation.
  60.  
  61.    If you haven't got PowerPacker you are of course missing one of the main
  62. features of this program.  PowerPacker is available as shareware (up to
  63. version 2.3b) or as a commercial program (version 4.0a).  Order a copy from
  64. UGA, P.O.Box 881, 3700 AW Zeist, The Netherlands.  The commercial version
  65. offers several enhancements like 40 to 50 times faster crunching, overlay
  66. support, an ARexx port, and much more.
  67.  
  68.  
  69. 2. Usage
  70. ========
  71.  
  72.    PPAnim can be used in four different ways.
  73.  
  74. - First of all via the CLI:
  75.  
  76.    If you enter 'PPAnim ?' will get a usage template.  You use PPAnim like
  77. this:
  78.  
  79.    PPAnim [-h] [-j#] [-l#] [-r[#]] [-i] [-o] [<file|dir>]
  80.  
  81.    The program will by default load the ANIM file and play it in a loop.
  82. If the file was crunched using PowerPacker 2.0 or higher PPAnim will first
  83. decrunch it for you.  If the file was encrypted you will be prompted for the
  84. password.
  85.  
  86.    If you enter PPAnim without options, you will be presented with a file
  87. requester.  Entering PPAnim with a directory instead of a file as an argument
  88. will also get you a file requester, but it will be positioned in the directory
  89. you specified.
  90.  
  91.    PPAnim has several options:
  92.  
  93.      -h   :  This option is used to force HAM mode when no CAMG chunk is
  94.              found.  If you don't specify this option PPAnim will assume a
  95.              6 plane screen is extra-halfbrite.  (Note that it is wrong for
  96.              an Amiga IFF ANIM file not to have a CAMG chunk, especially
  97.              when there can be doubt about what display mode to pick!)
  98.      -j#  :  Set a delay between frames in jiffies.  A jiffie is 1/50s (PAL)
  99.              or 1/60s (NTSC).
  100.      -l#  :  Set number of times to loop.
  101.      -r[#]:  Select repeat mode instead of loop mode (see below) and
  102.              (optionally) set number of repeats.
  103.      -i   :  Force screen to be interlaced.
  104.      -o   :  Play the animation once, no loop (same as -l1 or -r1).
  105.  
  106.    The difference between loop mode and repeat mode is the following: in
  107. loop mode PPAnim expects the last two frames of the animation to be the same
  108. as the first two frames, this makes looping easy and above all fast (DPaint
  109. saves animations like this).  Some animations are not like this however and
  110. if you want these to loop correctly you must select repeat mode (-r), PPAnim
  111. will then simply restart the animation when it finishes (note that there may
  112. be a small hickup when the animation repeats because the first frame takes
  113. longer to draw than the rest).
  114.  
  115.    PPAnim can be made resident so it doesn't have to be loaded every time
  116. you use it, use the ARP ARes command or the c: Resident command for this.
  117. You can't make PPAnim resident when it is crunched!!  The file is supplied
  118. as an uncrunched command file with the pure bit set.  PPAnim is reentrant as
  119. well, so you can run it from several CLI's at the same time. (Not that this
  120. is very useful, but it's possible :-D)
  121.  
  122.    Example:   '1> PPAnim -j10 -i Hard1:anim/SlowInterlaced.anim'
  123.  
  124. - Via the WorkBench:
  125.  
  126.    There are three different ways of using PPAnim via the workbench: you
  127. can set the default tool of the (crunched) ILBM file to 'PPAnim', you can
  128. single click the PPAnim icon and then shift double click the animation icon or
  129. you can double-click the PPAnim icon and enter the filename in the string
  130. gadget (or filerequester) you will be presented with.
  131.    You set the default tool by single clicking the icon of the picture and
  132. selecting 'Info' from the workbench menu.  You will get a window with several
  133. gadgets in it, click in the string gadget where it says 'Default tool' and
  134. enter ':ppanim'.  PPAnim should be in the root directory of your disk for this
  135. to work, if e.g. it's in the C directory you should enter ':c/ppanim'.  Last
  136. of all select the 'Save' gadget.
  137.  
  138.    You can set the same options as from CLI by setting tooltypes in the
  139. animation's icon (NOT PPAnim's icon!).  PPAnim recognizes the following
  140. tooltypes (for more info see CLI options):
  141.  
  142.      TIMES=<number>       Set number of loops or repeats.
  143.      JIFFIES=<jiffies>    Set delay in jiffies.
  144.      REPEAT               Select repeat mode.
  145.      ONCE                 Play once only.
  146.      LACE                 Force interlace.
  147.  
  148.  
  149. NOTE: - PPAnim will add '.pp' to the filename when the file wasn't found.
  150.         This is very useful in the WorkBench enviroment: you can make an
  151.         icon for 'bird.anim' but name the file 'bird.anim.pp'.  Now the
  152.         WorkBench will show an icon with 'house.pic' as name, but if you
  153.         doubleclick it 'bird.anim.pp' will be played. (As long as there
  154.         is no 'bird.anim' file in the directory!)
  155.  
  156.  
  157. 3. Features
  158. ===========
  159.  
  160.    - PPAnim uses the file requester of reqtools.library.
  161.  
  162.    - PPAnim supports a change of the color palette during the animation.
  163.  
  164.    - Abort PPAnim by pressing 'Q', Esc, or the right mouse button.  The screen
  165.      can be dragged by an invisible drag bar at the top.
  166.  
  167.    - The pesky little mouse will be removed while playing.
  168.  
  169.    - PPAnim offers full overscan support, PAL or NTSC.  All Amiga display
  170.      modes (like HAM, EHB) are of course also supported.
  171.  
  172.    - Press 'L' to load another animation, you will be prompted for a filename.
  173.  
  174.    - Press 'S' or the left mouse button to start/stop the animation.  Press
  175.      'N' to advance a frame (when stopped).
  176.  
  177.    - PPAnim reads the 'DPAN' IFF chunk DPaintIII saves with animations to find
  178.      the rate at which to play the animation.  Note that user options override
  179.      this rate (-j# or JIFFIES=<j>).
  180.  
  181.    - PPAnim is short (only about 7K)!  A lot shorter than Sparta's ShowANIM,
  182.      and on top of that it has a lot more features :-)
  183.  
  184.    - PPAnim is compatible with Kickstart & Workbench 2.0.
  185.  
  186.  
  187.                         As always, I hope you find this program useful!
  188.  
  189.  
  190.                               PROGRAM HISTORY:
  191.  
  192. *****************************************************************************
  193. VERSION 1.0
  194.  
  195.      First release.
  196.  
  197. *****************************************************************************
  198. VERSION 1.0a
  199.  
  200.      Seemed that the asl requester no longer worked on the latest
  201.        Kickstart 2.0 (release V37). Fixed.
  202.      Asl requester doesn't show '.info' icon files.
  203.  
  204. *****************************************************************************
  205. VERSION 1.0b
  206.  
  207.      Asl and Arp requester removed.
  208.      PPAnim now uses the ReqTools file requester from reqtools.library.
  209.      Pressing Esc also aborts the animation.
  210.      Canceling the file requester will no longer load the last animation
  211.        again.
  212.  
  213. *****************************************************************************
  214.  
  215. PPAnim 1.0b written by Nico François (Yes, Nico is my first name :-)
  216.             special thanks to Jim Kent (whom I don't know :-) for making his
  217.                                        ANIM #5 decoding source public domain.
  218.  
  219. (c) 1991 Nico François
  220.  
  221.                                    //
  222.                        Thanks to \X/ Amiga for being the best computer ever!
  223.  
  224.