home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 4 / CDPD_IV.bin / amfm / amfm6 / utilities / proplay2 / proplay.doc.pp / proplay.doc
Text File  |  1994-06-20  |  14KB  |  443 lines
  1.  
  2.  
  3.  
  4.  
  5.                      ProPlay V2.0 - The Module Player
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                           Written by Ivar Hagen
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.               ReqTools & PowerPacker libraries © Nico François
  22.  
  23.  
  24.                   Designed by Ivar Hagen & Göran Larsson
  25.  
  26.  
  27.             Custom gadgets, icon & documentation by Göran Larsson
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35. General note about the documentation
  36. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  37.  
  38. This docfile is written on a basic level, especially the section "How to
  39. use the ReqTools filerequester". I wasn't sure whether I should remove it
  40. or not, but I've decided to keep it. I'm quite sure that everyone except
  41. absolute beginners will skip it.
  42.  
  43. However, I have have tried to write this doc in a way so it will be easy for
  44. everyone to find the part they are looking for. I hope you like it!
  45.  
  46.  
  47.  
  48. Disclaimer
  49. ­­­­­­­­­­
  50.  
  51. ProPlay is distributed 'as is'. It has shown to be stable in everyday use,
  52. but we take NO responsibility for software and/or hardware (VERY unlikely :-))
  53. damage caused by use of this program.
  54.  
  55. PD/SW distributors may only sell ProPlay for a nominal fee, ie. the
  56. cost for magnet media and shipping.
  57.  
  58. ProPlay is ShareWare. This means that if you use it and like it, you should
  59. pay a small amount of money to the author, Ivar Hagen. For more info, look
  60. in the end of this docfile. Support the ShareWare concept!
  61.  
  62.  
  63.  
  64. Preface
  65. ­­­­­­­
  66.  
  67. ProPlay was meant to be a small and fast program which behaves well together
  68. with other programs, where many other module-players fail. Since the last
  69. release, 1.3, ProPlay has grown dramatically in features.
  70.  
  71.  
  72.  
  73. ProPlay V2.0 features
  74. ­­­­­­­­­­­­­­­­­­­­­
  75.  
  76. * Supports ProTracker/NoiseTracker/StarTrekker/SoundTracker type of modules
  77.  
  78. * Written in 100% assembly language
  79.  
  80. * Requires KickStart & Workbench 2.04 or higher
  81.  
  82. * Uses ReqTools.library by Nico François
  83.  
  84. * Supports modules crunched with PowerPacker
  85.  
  86. * Executable from both Workbench and Shell
  87.  
  88. * Creates it's own process from Shell
  89.  
  90. * Tape-alike controlpanel for easy and fast use
  91.  
  92. * Real-time timer :)
  93.  
  94. * Zoom gadget
  95.  
  96. * Random play mode
  97.  
  98. * Muting mode
  99.  
  100. * Shows remaining or elapsed time of the module playing
  101.  
  102. * Configurable Module directory, Pattern, Muting Level and Random Play
  103.  
  104. * Keyboard shortcuts for all options. Now you will never have to use your
  105.   mouse! :-)
  106.  
  107. * Won't mess upp with NTSC Amigas, uses CIA timing for correct speed
  108.  
  109. * Works on ALL Amigas
  110.  
  111.  
  112.  
  113. How to install ProPlay
  114. ­­­­­­­­­­­­­­­­­­­­­­
  115.  
  116. The ProPlay archive should contain the following files:
  117.  
  118.  
  119. * ProPlay                 Guess! :-)
  120. * ProPlay.info
  121.  
  122. * ProPlay.doc             The file you are looking at.
  123. * ProPlay.doc.info
  124.  
  125. * Install Libraries      Script to install the libraries required
  126. * Install Libraries.info  to run ProPlay.
  127.  
  128. * ReqTools.library        Library by Nico François for nice requesters.
  129.  
  130. * PowerPacker.library     Library by Nico François for crunced modules.
  131.  
  132.  
  133.  
  134. Running ProPlay from Shell
  135. ­­­­­­­­­­­­­­­­­­­­­­­­­­
  136.  
  137. Simply type "ProPlay" in the Shell. It's as simple as that. :-)
  138.  
  139.  
  140.  
  141. Running ProPlay from WorkBench
  142. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  143.  
  144. Is very easy, you will only have to doubleclick the ProPlay-icon. A window
  145. with some info and the copyright notices appears.
  146.  
  147. When you've got rid of it by either pressing <Return>, clicking on the
  148. "Click Anwhere" gadget or clicking anywhere else the filerequester pops
  149. up.
  150.  
  151.  
  152.  
  153. How to use the ReqTools filerequester
  154. ­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­­
  155.  
  156. All gadgets in bold type can be executed by pressing <Return>.
  157.  
  158.  
  159. Scrolling:    You can scroll up/down in the file listing with the scroll
  160.               bar on the left side of the window, or by the small arrows
  161.               below the scroll bar.
  162.  
  163.  
  164. Directory     If you want to load a tune from a different directory than
  165. selection:    the current one, there are several ways to do that.
  166.  
  167.           #1. Press right mousebutton. Now you will have a listing of
  168.               devices and assigns instead of the file listing.
  169.               If you select an assign it will naturally list the device and
  170.               directories it is assigned to. Let us say that you have
  171.           assigned ST-00: to DF1:Music, then if you select the
  172.           assign ST-00: ProPlay will jump to DF1:Music.
  173.  
  174.           #2. Type the device and directory name directly into the directory
  175.               window, like this:
  176.  
  177.               DH0:Music/Tracks
  178.  
  179.               Then ProPlay will show the file listing of the directory
  180.               Music/Tracks on the device DH0:
  181.               If you write the device name instead of the volume name,
  182.               ReqTools will change to the name of the volume. For example,
  183.               if you write as exemplified above, and the name of the
  184.               (hard)drive is HardDisk 1:, ReqTools will change
  185.               automatically to that.
  186.  
  187.  
  188. The Get-      If you are in the device- and directory list and want to return
  189. gadget:       to the last directory you were watching, press the Get gadget.
  190.               This gadget also updates the file listing in the current
  191.               directory.
  192.  
  193.  
  194. Module        When you are in the directory you want to, you can select a
  195. selection:    track by doubleclick on it's filename or write it in the
  196.               filename-window. If you want to select several tracks at
  197.               one time, press the <Shift> key, and keep it down while
  198.               you click on the tunes you want to listen to.
  199.           NB! If you choose multiple files no error messages will
  200.           be displayed. If a file error occur the next module
  201.           will automatically be loaded into memory, thus
  202.           providing you with non-stop music.
  203.  
  204.  
  205. The All-      To select all tracks in the current directory,
  206. gadget:       press the All gadget.
  207.  
  208.  
  209. The Clear-    This gadget will remove all marked files in the current
  210. gadget:       directory.
  211.  
  212.  
  213. Pattern-      In the pattern window you can select what filenames
  214. gadget:          that should be displayed by default in the filerequester,
  215.           using wildcards.
  216.           For example if you want to list all files with the four
  217.           first letter "Mod.", then you just write "Mod.#?" in the
  218.           pattern window.
  219.           Or more complex filelisting such as:
  220.  
  221.               (mod.[a-e,p-x]#?|#?.pp)
  222.  
  223.               This will list mod. files starting with a through e and
  224.               p through x as well as all files ending with ".pp".
  225.  
  226. The Match     Here you can mark several files with a special pattern, using
  227. gadget:       wildcards. Read about wildcards above for more info.
  228.  
  229.  
  230. The Hide/     This gadget disables/enables the showing of .info files.
  231. Show .info    The default setting is hide.
  232. gadget:
  233.  
  234.  
  235. The Disks     If you click this gadget you will have a list of devices and
  236. gadget:       assigns in your system. You can also select this option by
  237.               clicking right mousebutton.
  238.               If you want to get back to the last directory you were in,
  239.               press the Get gadget.
  240.               For more info, read the "Directory selection" section.
  241.  
  242.  
  243. The Parent    If you click this gadget ProPlay will jump one step back in
  244. gadget:       the directory tree.
  245.  
  246.  
  247. The Cancel &  Will result in the same thing, i.e. ProPlay jumps to its own
  248. quit-gadget:  window where you can quit the program.
  249.               If you have not selected any module for playing ProPlay
  250.               continues to play the active module, or if there isn't a
  251.               current module ProPlay will respond "Now playing: Nothing"
  252.  
  253.  
  254.  
  255. The ProPlay-window
  256. ­­­­­­­­­­­­­­­­­­
  257.  
  258. Is quite self explanatory, anyway, here are some short instructions:
  259.  
  260.  
  261. |<<            The Skip backwards gadget.
  262.                If you have selected several tunes, this will load the last
  263.                one playing. Otherwise, it will open the filerequester.
  264.                Keyboard shortcut: Arrow up
  265.  
  266. <<             The Rewind gadget.
  267.                Jumps one position back in the tune. This is also possible
  268.                when the tune is paused or stopped.
  269.                Keyboard shortcut: Arrow left
  270.  
  271.  
  272. ||             The Pause gadget.
  273.                Pauses the tune. You can restart it by pressing this gadget
  274.                again, or press Play.
  275.                Keyboard shortcut: P
  276.  
  277.  
  278. >              The Play gadget.
  279.                When you load at tune, it will automatically start playing.
  280.                However, if you have pressed the Pause gadget and select
  281.                Play the tune will continue from its current position.
  282.                If you have pressed the Stop gadget and press Play, the
  283.                tune will restart from the first position.
  284.                Keyboard shortcut: <Return>
  285.  
  286.  
  287. []             The Stop gadget.
  288.                Use this one only if you want to replay the tune from the first
  289.                position.
  290.                Keyboard shortcut: S
  291.  
  292.  
  293. >>             The Fast forward gadget.
  294.                Similar to the Rewind gadget, but does the opposite.
  295.                Keyboard shortcut: Arrow right
  296.  
  297.  
  298. >>|            The Skip forward gadget.
  299.                If you have selected several tunes, this will load the next
  300.                one. Otherwise, it will open the filerequester.
  301.                Keyboard shortcut: Arrow down
  302.  
  303.  
  304. Timer Mode:    There are two timer modes. Remaining shows how much time there
  305.                is left on the tune playing, and Elapsed shows for how long
  306.                time the current tune has been playing.
  307.                Modules with lots of tempochanges the calculated time will not
  308.                always have 100% accurate time (99.9% is more likely :-)).
  309.                Keep in mind that some modules have empty spaces in their
  310.                last pattern so moments of silence is likely to occur.
  311.  
  312.  
  313. Small Window:  Removes all the gadgets on ProPlays window thus giving a smaller
  314.                window. The keyboard shortcuts are still working, ofcourse.
  315.  
  316.  
  317. Random:        If you select several tunes to for playing, you can play them
  318.                in random order by using the Random gadget. Select some tunes
  319.                in the filerequester, press OK, and then press Random on the
  320.                ProPlay window. If you want to (randomly) skip to the next
  321.                tune, press the Skip Backwards or Skip Forward gadgets.
  322.                If you want to select new tunes for random playing you have to
  323.                stop the music with the Stop gadget or simply deselect random
  324.                playing by pressing the Random gadget.
  325.  
  326.  
  327. Muting:        Mutes the volume. Nice when the telephone rings and you can't
  328.                reach your stereo or its remote control to turn the music
  329.                down! :)
  330.  
  331.  
  332. Info:          Displays some info about the tune currently loaded. The module-
  333.                name may differ from the filename, ProPlay shows the name of
  334.                the module, not the file.
  335.                You can also view the samplenames by clicking on the Samples
  336.                gadget.
  337.  
  338.  
  339. Config:        Here you can configure the following things:
  340.  
  341.                Module Dir:   The place where ProPlay will look for modules.
  342.                              Default setting is ST-00:Modules
  343.  
  344.                Pattern:      The pattern used (see the section "How to use the
  345.                              ReqTools filerequester/Pattern-gadget").
  346.                              Default setting is Mod.#?
  347.  
  348.                Muting Level: The level ProPlay will mute when that option is
  349.                              turned on. Default setting is 70%.
  350.  
  351.                Random Play:  Decides if ProPlay will have random play as
  352.                              default. Default setting is off.
  353.  
  354.                Save:         Will save the current settings to the file
  355.                              S:ProPlay.config
  356.                              Note: older versions of ProPlays config-file are
  357.                              not compatible with the 2.0 version.
  358.  
  359.                Use:          Keeps the current settings in the system but will
  360.                              not save them.
  361.  
  362.                Cancel:       Exits with the settings you had prior to entering
  363.                                 the config window.
  364.  
  365.  
  366.  
  367.  
  368. Future plans
  369. ­­­­­­­­­­­­
  370.  
  371. Auto adapt to screen font settings
  372.  
  373. Double-buffered playing of separate 8SVX samples
  374.  
  375. ARexx-port
  376.  
  377. Full-screen oscilloscope
  378.  
  379.  
  380.  
  381. Thanks to
  382. ­­­­­­­­­
  383.  
  384. Greetings to the users at these bulletin board systems for helping me
  385. program my first real system-friendly program:
  386.  
  387. "Home Sweet Home" the home of Crusaders in Norway NiKom and Camelot
  388. in Stockholm, Sweden
  389.  
  390. Thanks to all the talented musicians who create excellent music with
  391. the Amiga.
  392.  
  393. Also thanks to Göran Larsson for typing this doc file, helping me with
  394. the non-programming stuff and extensive (?;)) beta-testing.
  395.                __
  396.           __  ///
  397.           \\\///
  398. Thanks to  \XX/ Amiga for beeing the BEST computer ever!
  399.  
  400.  
  401.  
  402. Known bugs:
  403. ­­­­­­­­­­­
  404.  
  405. ProPlay can sometimes cause the serial device to loose incoming
  406. signals. I don't know why this happens nor how to fix it.
  407. Just press the stop gadget, or close down ProPlay and restart
  408. it to get around the problem for now.
  409.  
  410.  
  411.  
  412. At last...
  413. ­­­­­­­­­­
  414.  
  415. Write to me for paying the ShareWare of $15, bug reports, suggestions etc.
  416.  
  417. Mail:    Ivar Hagen
  418.     Äppelgränd 5
  419.         151 68 Södertälje
  420.     SWEDEN
  421.  
  422. FidoNet: 2:201/632                     - ArtLine BBS
  423.  
  424. UseNet:  Ivar_Hagen%cave@sweden.eu.net       - The Misty Cave
  425.  
  426.  
  427.       "Support the programmers and the programmers will support you!"
  428.  
  429.  
  430.  
  431.  
  432.  
  433. And if you want to reach me, Göran, for any reson...
  434.  
  435. FidoNet: 2:201/344.0                         - SkyNet BBS
  436.  
  437. UseNet:  Goran_Larsson%cave@sweden.eu.net    - The Misty Cave
  438.  
  439.  
  440.  
  441. ... send all your flames to Ivar! ;-)
  442.  
  443.