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