home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / demos / genesis.dms / genesis.adf / STP.doc < prev    next >
Text File  |  1990-12-30  |  5KB  |  166 lines
  1.  
  2.      *************************************************************
  3.      *                  SoundTracker Player V1.0         *
  4.      *     Copyright © 1990 AUSTEX SOFTWARE (FreeWare Software)     *
  5.      *        Authors: Stephen J.Smith & Paul N.Goulding     *
  6.      *************************************************************
  7.  
  8.  
  9.             
  10.  
  11.  This program can be run as a background task to play SoundTracker Songs
  12. and Modules. The songs are listed one after another in a text script file
  13. which is read by the Player.
  14.  
  15.  
  16.  
  17.  STARTING THE PROGRAM
  18.  ~~~~~~~~~~~~~~~~~~~~
  19.  
  20.  From the CLI:
  21.  
  22.      Run STP Sample.script
  23.  
  24.  From the WORKBENCH:
  25.  
  26.     Click on the script file icon, hold the shift key, then
  27.     double click on the STP icon
  28.  
  29.     OR
  30.  
  31.     Double click on the script icon. (the one supplied)
  32.  
  33.  
  34.  OPTIONS
  35.  ~~~~~~~
  36.  
  37.  The program will open up a standard intuition window containing eight
  38. simple gadgets. These are;
  39.  
  40.  
  41.  
  42.     FILTER         - Selecting this will toggle the Amiga's filter 
  43.             on and off.
  44.     RANDOM        - With this selected, STP will load in a random
  45.             song from the script when the current song has
  46.             ended.
  47.     LOAD        - This will allow the selection of a new script
  48.             file. You need the ARP library to use this
  49.             feature.
  50.     RESET        - Starts playing the CURRENT song from it's
  51.             beginning.
  52.     PAUSE        - Pauses the current song. Skip song is disabled
  53.             during this mode.
  54.     <<        - Select the previous song in script. Note that
  55.             when the RANDOM option is on, that this will be
  56.             a random song selection
  57.     >>        - Select the next song in script. Note that when
  58.             the RANDOM option is on, that this will be a
  59.             random song selection.
  60.     STATUS        - Shows current status of the player.
  61.  
  62.  
  63.  DISPLAY WINDOW
  64.  ~~~~~~~~~~~~~~
  65.  
  66.  This window will display the immediate status of the player. The following
  67. messages can occur;
  68.  
  69.  "No Script !"    -    No script file is currently loaded
  70.  "  Error    "    -    An error has occured. This could be caused by
  71.             an empty/non-existent file or from a corrupted
  72.             song.
  73.  " Loading.. "    -    A new song is currently being loaded.
  74.  "UnPacking.."    -    A packed song has been loaded, unpacked and the
  75.             instruments are now being loaded in.
  76.  
  77.  If no errors have occurred, then the normal status message will appear.
  78.  
  79.  For e.g.
  80.  
  81.   Current song number ---> 01.04 00:32 <--- Time song has been playing
  82.  
  83.                   ^
  84.                   | 
  85.                   |
  86.                   +--- Current pattern number in song
  87.  
  88.  SCRIPT FILES
  89.  ~~~~~~~~~~~~
  90.  
  91.  The format of the script files is quite simple. STP uses a standard ascii
  92. input file for scripts. Each line of the file will contain information
  93. about the music to be played. 
  94.  
  95.                 PLEASE NOTE
  96.  
  97.  A SONG is a SoundTracker file which contains no instrument data, only the
  98. song patterns and notes. This means that you will have to Assign the
  99. ST-00:, ST-01: ST-02:  etc directories BEFORE you run the program so that
  100. the instruments can be loaded in.
  101.  A MODULE is a superset of a song and also contains the instrument data,
  102. and so the directories don't need to be assigned.
  103.  
  104.  
  105.  At the beginning of each line, there should be an ascii hash symbol '#'
  106. (it stands for command) followed by one of the following;
  107.  
  108.     's' - song
  109.     'm' - module
  110.     'r' - repeat
  111.         'e' - end of play
  112.  
  113. After this you should place a space (' ') and then the filename of the
  114. song/module that is to be played. The 'r' and 'e' options are mutually
  115. exclusive, and require no parameters after them.
  116.  
  117. Comments are allowed and are preceded by a semicolon ';'.
  118.  
  119.  
  120. This is an example STP script:-  (The boxes are just for clarity)
  121.  
  122. +-----------------------------------------------------------------------+
  123. |    #m st/st-00/modules/axel f.        ; Great song!        |
  124. |    #m st/st-00/modules/bluemonday        ; Another one        |
  125. |    #m st/st-00/modules/thing1        ; Not bad        |
  126. |  #e                                          ; Stop playing and close|
  127. +-----------------------------------------------------------------------+
  128.  
  129.  
  130. Another script file could be;
  131.  
  132.  
  133. +-----------------------------------------------------------------------+
  134. |  #m ST-00:modules/thing2        ; Great song            |
  135. |  #r                                   ; Go back to beginning...(play    |
  136. |                    ; forever)            |
  137. +-----------------------------------------------------------------------+
  138.  
  139.  That's it, so please Enjoy!
  140.  
  141.  
  142.  
  143.  NOTE: If the repeat length for an instrument has been set incorrectly
  144.        in a song, then this could result in noticeable garbage noises.
  145.        If this is the case, you will have to set the instrument
  146.        correctly using a SoundTracker program.
  147.  
  148.  
  149.  HISTORY
  150.  ~~~~~~~
  151.  
  152.  V0.7     Pre-release version. This version is now workbench compatible.
  153.      Packed songs are not yet supported.
  154.  V0.8    Now works with NTSC or PAL Amiga. Released.
  155.  V0.9   New window and options setup.
  156.  V1.0    Handles packed songs. Improved playroutine.
  157.  
  158.  
  159.      AUSTEX SOFTWARE
  160.      P.O. BOX 48
  161.      KIRWAN    4817
  162.      QUEENSLAND
  163.      AUSTRALIA
  164.  
  165. ----------------------------------------------------------------------------    
  166.