home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / graphics / utility / trace / trace.doc < prev    next >
Encoding:
Text File  |  1993-02-26  |  10.9 KB  |  219 lines
  1.  
  2. Trace v1.0
  3.  
  4. --------------------------------------------------------------------------------
  5.  
  6. This program is FREE.  You may distribute it at will, provided you
  7.  
  8.         1) do not charge any money for it,
  9.         2) distribute it WITH the documentation, and
  10.         3) do not change the program or documentation in ANY WAY.
  11.  
  12. --------------------------------------------------------------------------------
  13.  
  14. 1.) Intro
  15.     -----
  16.  
  17.    TRACE.PRG is an interactive graphics/sound/text learning tool.  You can
  18. use it to link together various screen graphics with sound and text files,
  19. and merge the whole thing into an interactive presentation.
  20.  
  21.  
  22.  
  23. 2.) The "cover yer butt" section
  24.     ----------------------------
  25.  
  26.    This is my second program to be released into the public domain.  No one
  27. sued me when I released my first program (thank you very much), but I still
  28. feel compelled to add this little blurb.  I've downloaded enough software
  29. to have noticed that almost EVERYONE puts in a disclaimer of some kind.
  30. I copped this one from a public domain program.  It seems to have enough legal
  31. mumbo jumbo to discourage any litigious griper.
  32.  
  33.     This software is freeware.  As such, it is provided on an as-is basis,
  34.     with absolutely no warantees, either express or implied, including, but not
  35.     limited to performance, usefulness, reliability, fitness for a particular
  36.     purpose or merchantability.  The user assumes any and all risk involved in
  37.     the use of this software.  In no event will the author be liable for
  38.     direct, indirect, incidental, or consequential damages resulting from the
  39.     use of, or inability to use, this software.
  40.  
  41. So there!
  42.  
  43.  
  44. 3.) We are not alone
  45.     ----------------
  46.  
  47.    TRACE is much like Dave Beckers CONNECTIONS program.  I downloaded
  48. CONNECTIONS last weekend and was amazed at how similar it was to TRACE,
  49. which I have been working on for about 2 months quite independent from
  50. Mr. Becker.  In my view, CONNECTIONS is more of a full featured multimedia
  51. program, while TRACE is narrower in scope, but hopefully easier to use.
  52. I debated whether or not to release TRACE into the public domain, because
  53. it would be nice to have a "defacto standard" for Atari multimedia work, and
  54. I'd just as soon have CONNECTIONS fill that role.  But, the more I played
  55. with CONNECTIONS the more I missed some of TRACE's features, so I decided to
  56. upload TRACE to GEnie after all.
  57.  
  58. Some reasons for using CONNECTIONS:
  59.  
  60.    1.) If animations are important to you use CONNECTIONS.  TRACE doesn't
  61.        support them at all.
  62.  
  63.    2.) CONNECTIONS can display small graphics on the screen, TRACE only
  64.        deals with full screen displays.
  65.  
  66.    3.) CONNECTIONS allows you to run external applications as a part of the
  67.        multimedia session (admittedly I haven't gotten this feature to work
  68.        very well on my system, but it is available).
  69.  
  70.    4.) CONNECTIONS can display scrolling text windows, while TRACE is
  71.        limited to rather small static text displays.
  72.  
  73. Some reasons for using TRACE:
  74.  
  75.    1.) TRACE works in all three ST resolutions, CONNECTION only works in
  76.        monochrome.  Since I wanted TRACE to be geared to children, I
  77.        thought color graphics was a must.  Black and white pictures just
  78.        don't seem to hold a kids attention as well as a color picture no
  79.        matter how good the resolution.
  80.  
  81.    2.) TRACE uses Dave Baggett's freeware PLAY.PRG program to replay sound
  82.        samples.  PLAY.PRG is a fine program with many features that TRACE
  83.        can take advantage of, including utilizing the STe's DMA sound
  84.        capability.  To replay sound samples you MUST have PLAY.PRG in the
  85.        same directory as TRACE.PRG.
  86.  
  87.  
  88.  
  89. 4.) OK, OK, what'zit do?
  90.     --------------------
  91.  
  92.    TRACE allows you to create an interactive (there's that word again!)
  93. presentation using DEGAS picture files, sound files and text files.  You
  94. load a DEGAS picture onto the screen and, using the mouse, define areas on
  95. the picture which will playback sounds or display text or show another
  96. picture.  The pictures can be chained together to form an intricate (or
  97. simple) heirarchy of graphics, sounds and text.  There's a simple demo
  98. included in the download for you to try out.  If you click on TRACE.PRG,
  99. your'll be presented with a picture of the starship Enterprise.  Click on
  100. the "saucer section" and forward "drive section" to play some sound effects.
  101. Click on the warp nacelle to display a little text info.  Press the ESC key
  102. to end the program.
  103.  
  104.  
  105.  
  106. 5.) Getting started
  107.     ---------------
  108.  
  109.    The first thing you need to do is create a DEGAS picture and name it
  110. TRACE.PI?, were the '?' is 1,2 or 3 depending on what resolution you're
  111. working with.  TRACE also understands DEGAS compressed pictures, so you
  112. can create a compressed picture called TRACE.PC?.  Compressed pictures
  113. take up less disc space, but they take a moment to uncompress, which slows
  114. down the display a bit.  You decide which is more important to you.
  115. You'll also want some sound and text files, and some other picture files to
  116. work with.  Files used with TRACE must meet the following criteria:
  117.  
  118.    1.) Picture files must be in DEGAS "normal" or compressed format.
  119.  
  120.    2.) Text files must be normal, ASCII text files with the extention .TXT.
  121.        Each line must end with a CR/LF combination, and the maximum number
  122.        of lines in the file is 24 (actually the file can have more lines in
  123.        it, but TRACE will only display the first 24).  Most ASCII editors
  124.        will work just fine.
  125.  
  126.        Note: unlike CONNECTIONS, text information is not centered on the
  127.        screen when displayed.  The text will appear in a box that will be
  128.        positioned next to the mouse cursor.  For this reason the maximum
  129.        line length depends on where the text is displayed on the screen.
  130.        Play around with text files with long lines and you'll see what
  131.        I mean.
  132.  
  133.    3.) Sound files can use the signed or unsigned format, and the file
  134.        extension must denote the playback speed.  (i.e. the sound file
  135.        PHASER.096 is played back at 9600 Hz).  This file naming convention
  136.        has been championed by Dave Baggett and I highly recommend it.
  137.  
  138.    Now that you've got a picture called TRACE.PI? (or TRACE.PC?), hold down
  139. both the ALTERNATE and CONTROL keys and double click on TRACE.PRG.  Holding
  140. down the ALT and CNTRL keys while the program is loading puts TRACE into
  141. "create" mode which allows you to create your presentations.  (BEWARE, some
  142. other programs, like NEODESK and DCSHOWER, use a similar technique to invoke
  143. special options.  Actually holding down various combinations of the
  144. CTRL, ALT and SHIFT keys has become a much overused means of activating
  145. special features in all kinds of programs.  If TRACE doesn't appear to be
  146. going into CREATE mode, it may be because another program is intercepting
  147. the ALT/CTRL key press.  You'll have to try booting your computer without
  148. some accessories or auto-folder programs to find the offending program.
  149. Bummer.)  If you do NOT hold down ALT and CTRL while launching TRACE.PRG,
  150. the program goes into "play" mode and it will start your presentation from the
  151. TRACE.PI? picture, which is what happened when you ran the demo.
  152.  
  153.    When the file selector appears, select your TRACE.PI? picture file.
  154. Now begins the process of creating the TRACE.TR? file, which
  155. will contain the information used to recreate your presentation.
  156. If TRACE can't find TRACE.TR?, you'll be presented with a couple of dialogs
  157. to select which type of sound output device and driver to use as well as
  158. what sound format you'll be using.  All these parameters are passed to PLAY.PRG
  159. which does the actual sound playback, and you should read that programs
  160. documentation for more details.  If you're not going to be playing back sound
  161. samples, just select the defaults.
  162.    If you use other pictures in your presentation, you should invoke TRACE in
  163. create mode and select the other picture files so that *.TR? files can be
  164. created for them also.  (For instance, if you use the picture SMILES.PC2 in
  165. your presentation, you'll want to use TRACE to create the file SMILES.TR2,
  166. which will contain the sound, text and graphic information for that picture.)
  167. Each DEGAS picture file in your presentation should have an accompanying .TR?
  168. file.
  169.    OK, now your TRACE.PI? picture is on the screen.  Use the mouse to outline
  170. a section of the screen.  Use the old, familiar left-click-and-hold and drag
  171. technique to create a resizable box.  Once the box is defined, a file selector
  172. will appear.  Select the picture (PI? or PC?), sound or text file you want
  173. activated when the user clicks within the box you just defined.  Once you
  174. select a file, the outline box changes to a dashed line and the info is
  175. stored in the .TR? file.  (Selecting CANCEL from the file selector, causes
  176. the outline box to remain a dash-dot line, and the information is NOT
  177. stored.)  Continue selecting boxes on the screen and corresponding files.
  178. When you're done press the ESC key.
  179.    Repeat this process for each of your picture files, linking each piece of
  180. the screen to a sound or text file or another picture file.
  181.    To replay you presentation, run the TRACE.PRG program without holding the
  182. ALT and CTRL keys.
  183.  
  184.    That's about it.  Rather then go on and on with more instructions, I'll
  185. just say "try it!"  I've run TRACE many, many times while debugging code, so
  186. it seems pretty easy to me.  I'm sure I've left out some minor details, but
  187. if you play with it a while you'll get the hang of it.
  188.  
  189.  
  190.  
  191. 6.) A few notes
  192.     -----------
  193.  
  194.    TRACE stores its file information as whole, complete path names in the .TR?
  195. files.  I've found it convenient to go into the .TR? file and edit the
  196. path name to be relative (to the directory that contains TRACE.PRG).  You 
  197. might too.  Just use your favorite ASCII text editor.  You'll also notice
  198. that the first line in a .TR? file contains parameters passed to PLAY.PRG.
  199. You can edit that line also and use any of the parameters described in the
  200. PLAY.PRG documentation.
  201.  
  202.    For some reason, GEM doesn't recognize mouse clicks in the menu bar portion
  203. of the screen.  So, you won't be able to create a resizable box starting in the
  204. first 10 (med rez) or 20 (high rez) pixels from the top of the screen.  C'est
  205. la vie.
  206.  
  207.    If you don't have a harddrive, everything works MUCH better from a RAM disc.
  208. Copy TRACE.PRG and PLAY.PRG and your graphics/sound/text files onto the RAM
  209. disc and things will just zip.  There are a couple RAM discs that will
  210. automatically load files and work very well when you want to create a
  211. standalone TRACE presentation on floppy disc (Don't want little kids mucking
  212. with the hard drive? Hmmmm....)  I've used the RDE.PRG RAM disc that
  213. originally came with the Mark Williams C compiler.  It's available in the public
  214. domain on GEnie and works great.
  215.  
  216.    If anyone has gripes or suggestions, send them my way.  K.LORD on GEnie.
  217.  
  218. Keith Lord    2/21/93
  219.