home *** CD-ROM | disk | FTP | other *** search
/ Esprit de Apple Corps / EDAC-2.iso / Sound / MOD.Utilities / MODZap / MZ.Manual < prev   
Text File  |  1993-11-05  |  21KB  |  343 lines

  1.  
  2.                                      MODZap¬ v00.90b3
  3.                                                        Use and Care Guide
  4.                  By Ian Schmidt.  Copyright (c) 1992-93 Two Meg Software.
  5.  
  6. (This document is in standard IIgs Teach¬ format and needs Shaston 8 (built into your ROMs), Shaston 16, and Venice 14 (which are on :SystemTools1:System:Fonts:).)
  7.  
  8. MODZap¬ is an Amiga¬ music module player for the Apple IIgs personal computer.  It combines high playback quality with speed and a range of features to insure that MODs sound good.  MODZap¬'s primary mission is to reproduce modules conforming to
  9. the standard set by the ProTracker¬ program on the Amiga¬.  Support is also provided in a lesser form for StarTrekker¬ and NoiseTracker¬ modules.
  10.  
  11. Important note: ╥NoiseTracker╙ in this document usually refers to the Amiga¬ versions of the program.  NoiseTracker IIgs modules are not Amiga¬-compatible and
  12. you should not attempt to load or play them with MODZap¬. 
  13.  
  14. Prolog
  15.  
  16. This version of the program was almost not made avalible due to vocal insulting of myself by several people who apparently felt that free software was a bad thing.  After a lot of rethinking, and general insufferable begging from the likes of Scott Anderson and a bit of moral support from Michael Frankowski, I've decided to go ahead and release this advanced version, almost a year in the making. 
  17.  
  18. As always, I'd like to hear productive comments.  If you don╒t have something nice to say, say it to someone other than me, because I don╒t give a fuck anymore.  It╒s pathetic that many software developers are being driven away from the IIgs due to abuse from users at this time when new software is needed more than ever before.
  19.  
  20. System Requirements
  21.  
  22. An Apple IIgs¬ personal computer with at least 1.125 megs of memory.  GS/OS System Software version 6.0 or later is required.  MODZap¬╩automatically supports all stereo cards and ROM revisions.
  23.  
  24. Caveat Emptor
  25.  
  26. This version of MODZap¬ has several known bugs, and tends to crash in QuadraScope¬ mode.  Use another play mode until things are solidified.
  27.  
  28. New stuff since v00.81a
  29. (MODs which certain things fix are in brackets, with the actual titles in parens since people translate Amiga¬ filenames differently)
  30.  
  31.      Ñ MODZap now supports a full 5 octave range, which is important when playing
  32.         MODs composed on IBM PCs and Atari STs.
  33.      Ñ Unlike ╘that other player╒, you can now access your Classic Desk Accessories
  34.         from inside MODZap.
  35.      Ñ Finally wrote a custom list drawProc so now the instrument list is more 
  36.         informative.  The instrument number as seen in the scrolly player, the 
  37.         instrument type (looping, cached looping, or one-shot), and it╒s residency
  38.         (a ram card for swapped, a chip for cached, and a blue X for non-existant insts).
  39.      Ñ Wrote and tested brand-new swapper using loop-mode operation just like the
  40.         popular ShellPlay¬.  As a result, stereo mixing now works great.  Also, the
  41.        ╥phasing╙ effect heard in soniqTracker and NTGS where the same sample played   
  42.        twice in a row sounds slightly different is not in evidence here!
  43.      Ñ Notice: MODZap's prefs file is supposed to be sparse, so launching MZ from
  44.         a non-ProDOS disk will cause about 4k of disk space to be wasted.  There are
  45.         no other problems associated with this (everything will work normally).
  46.      Ñ There are tons of new Options, including a 'startup path' so you can
  47.         select a path for MODZap to automagically go to on startup (much like
  48.         Kangaroo¬ or SuperDataPath¬, only free =)
  49.      Ñ A fun memory-trashing bug which has been around a while got squished; this
  50.         means the end of random wackiness/hangs/crashes.
  51.     ╩Ñ There are lotsa new player modes: Oscilloscope, a 160x128 scope display of
  52.         MZ's current output, Oscilloscope (ZipGS) which is a 320x128 scope display for
  53.         people with ZipGS¬ accelerators (in beta testing, TWGS machines fared no
  54.         better than unaccelerated ones), and QuadraScope¬, which individually shows           
  55.         the output of each track like ProTracker¬ on the Amiga¬.
  56.      Ñ Instruments may now be cached in DOCRAM for faster performance and cleaner
  57.         sound.  Since the cache manager is new, there is an option to disable it in
  58.         preferences.  There also is a new cache indicater light in the Pumpy Player¬
  59.         which glows brighter the more tracks are playing from cache.  This is actually
  60.         the opposite behavior from the cache LED on the ZipGS¬ accelerator card.
  61.      Ñ The FXLasers¬ have been rescaled so they come up to full brightness quickly
  62.         and fade away more slowly.  This allows you to better see what's going on;
  63.         formerly the lasers would take so long to trip that if there was a fast series
  64.         of effects, you'd just barely see the laser start to appear before it was reset
  65.         by the next effect.  Additionally, there is a new Aqua laser for the position
  66.         jump F/X.
  67.      Ñ There are several new key-equivalents: OA-J for Jukebox, OA-I to save an 
  68.         instrument, and OA-S for the new Save Module item.
  69.      Ñ When saving instruments, the instrument's name as shown in the list is now the
  70.        default filename, instead of the MOD's filename.  
  71.      Ñ Fixed looping so it doesn't loop 65535 times (MOD.TechMaru [TechMaru])
  72.      Ñ Fixed tone portamentos so they stop correctly at the target. (MOD.Nebulos [Nebulos])
  73.      Ñ Fixed arpeggios so they work without an accompanying note (MOD.Taking [taking on the world])
  74.      Ñ Added Ultra-Turbo mode for GNO users.  This mode runs with no animations at all, which dramatically increases avalible processor time. 
  75.      Ñ Prefs can now be saved...once you set things up how you like, click the Save Prefs button in the Options dialog and they'll be saved to disk, in your user folder for AppleShare users.
  76.      Ñ You now may optionally turn off the safety net of filename prefix/suffix checking and select filenames yourself.
  77.  
  78. Previously implemented MODZap¬ Features:
  79.  
  80.     Ñ Plays modules directly from the disk image.  This means much shorter loading 
  81.         time, with only a brief pause after loading to build some tables for speedy
  82.         playing.  Other IIgs players convert the MODule to bizzare internal formats,
  83.         losing the ability to support all of the MOD format's subtle features.  And,
  84.         since this conversion is done as the file is loaded, this slows down loading
  85.         time dramatically, as GS/OS is optimized for large transfers.
  86.      Ñ Frequency meters in the Pumpy Player¬.  Tracks 1 and 2 are on the left
  87.         side of the screen; tracks 3 and 4 are on the right.  Frequency is as you may 
  88.         already expect; higher on the screen is higher frequency.  All pitch-based
  89.         effects like Portamento, Vibrato, and Arpeggio show up on the meters and
  90.         are fun to watch; DragonsFunk puts on the best show of any MOD I currently 
  91.         have.
  92.      Ñ Fun keyboard provided so that you can play with instruments.  The keyboard
  93.         has a 3-octave range.  MODZap¬ supports the full 5 octave range possible with
  94.         certain IBM-based MOD trackers.
  95.      Ñ Includes resources and auxtype needed for perfect harmony with Finder¬ 6.0.
  96.      Ñ Smart volume conversion, so MODZap¬ is out-of-the-box compatible with all
  97.         IIgs stereo cards, with no special setup needed.
  98.      Ñ Supports more special effects than any other module player on IIgs.
  99.      Ñ Highly accurate mathematical modeling of the Amiga¬ sound hardware, so pitch
  100.         effects and tuning are guaranteed correct, as are little things like stereo
  101.         output positions.
  102.      Ñ Takes full advantage of new System 6 features.
  103.      Ñ Uses GS/OS in the most efficient way possible,  resulting in substantially         
  104.         shorter load time for modules.
  105.      Ñ Runs correctly on a standard 2.8 Mhz IIgs,  even under the GNO¬╩Multitasking
  106.         System.
  107.  
  108. ==============
  109. Using MODZap¬
  110. ==============
  111.  
  112. When you run the program, the splash screen will appear and a short digitized sound
  113. clip will play.  Click the mouse button to continue the program.  To skip this intro,
  114. simply hold down the Open Apple key once the program begins running.
  115.  
  116. There are lots of ways to open modules with MODZap¬....
  117.  
  118. 1) Use Open MODule... and select one.
  119. 2) Use Force 31 Instrument or Force 15 Instrument if you have one that the 
  120.      auto type checker botches for some reason.
  121. 3) Use Jukebox... to grab a whole bunch to hear in a row.
  122. 4) Install the MODZap.Icons file and double click a module from the Finder¬.
  123.  
  124. Once you have one open by whatever means, the Module Control Panel will appear.  It will show you the title, type, and creator program (if possible...only StarTrekker¬ has a distinctive signature of all the popular Amiga¬ Trackers).
  125. The control panel includes a list of instruments containing information as follows:
  126.  
  127. Instrument number
  128. |
  129. |    Instrument residency: a ramcard for swapped, a chip for cached, and an X for N/A.
  130. |    |
  131. 3 > O  BigTubeGuitar  
  132.    |
  133.   Instrument type: an arrow for one-shot, a loop for looping, and a loop with a ramcard for cached looping.  
  134.  
  135. Additionally there is a keyboard you can click on to play whatever instrument╒s
  136. name is highlighted in the list.
  137.  
  138. Playing the module once it is loaded is very simple.  Just select Play MOD from the
  139. Sound menu.  The Graphic Player will pop up and the module will begin.  (this happens automatically in Jukebox mode).  To stop playback for any reason, press
  140. the Option key on your keyboard or click the mouse button. Otherwise playback will end when the module is done.  Note that some modules have a Position Jump command so that they loop forever; this is especially true of modules from games or demos.  If that is the case the module will loop forever and the only way to stop it is using the Option key or mouse button.  There is a scrolly subdisplay at the bottom of the
  141. screen arranged as follows:
  142.  
  143.         The leftmost column of the display shows 4 information items relating to the
  144.         current song.  The topmost one is the number of positions in the song, the next
  145.         one down is the current position number, the third one is the current block
  146.         number, and the bottommost one is the number of the bottommost position in
  147.         the block shown on the scrolling part of the subdisplay.
  148.  
  149. Several keys can be used while a module is playing.  1-4 toggle the disable/enabled
  150. status of tracks 1-4.  The spacebar pauses and unpauses playback.  The Esc key exits the player if you are in single mode, and aborts the jukebox if you are in jukebox mode.
  151.  
  152. More About the Jukebox:
  153.  
  154. There are some standard behaviors supported by the Jukebox; here goes.
  155. Open Apple-clicking adds files to a selection.  Shift-clicking selects everything between the current selection and the nearest other selection.  Open Apple-clicking an already selected file deselects that file.  MODZap imposes no limit on the number of MODs selectable in Jukebox mode other than that the filenames must all fit in avalible free memory (this is very hard to do even with the largest MOD collections!).
  156.  
  157. =============
  158. Menu Options
  159. =============
  160.  
  161. There are several options avalible in the Options item of the Options menu.  They are as follows:
  162.  
  163.       Ñ PAL/NTSC (soniqTRACKER¬ calls these 50 and 60 Hz respectively).  99% of 
  164.          MODules are PAL (50 Hz) but due to the way early Amiga¬ trackers worked
  165.          some older modules created on United States Amigas¬ may be NTSC.  If
  166.          a song sounds too slow, try NTSC.  There is no other way to distinguish,
  167.          although some modules may come with documentation which tells you what
  168.          setting to use (eg MOD.Sandman.PAL or MOD.Everybody.NTSC).
  169.       Ñ╩Ignore Tuning allows you to ignore the fine-tune bytes in MODules in case
  170.          a module sounds weird with them.
  171.       Ñ Ignore Arpeggios allows you to ignore arpeggios in case you get a MODule
  172.          which sounds weird with them.  v00.75 added rangechecking so that some 
  173.          modules which formerly needed this option shouldn't now.
  174.  
  175. There are key equivalents for some of the items in the dialog box: A toggles the Ignore Arpeggios check box, T toggles the Ignore Tuning check box, Return is the same as the Okay button, and Open Apple-period (.) is the same as the Cancel button.
  176.  
  177. Additionally, one item is in the Options menu so that you may conviently access it without disk swapping:
  178.  
  179.       Ñ╩Loop Music allows you to determine if MODules play once or repeat until
  180.          you press the Option key or click.  Note that this has effect in Jukebox mode 
  181.          also so you must press Option or click to allow the Jukebox to switch to the
  182.          next one in the series.
  183.  
  184. =================
  185. Selectable MODs
  186. =================
  187. MODs must meet certain criteria to appear in the Open and Jukebox dialogs.
  188.  
  189. o Their type must be TXT or BIN, or $F4 with an aux $6900.
  190. o Their name must start with MOD. or end with .MOD (case is now insensitive) unless
  191.    Ignore MOD./.MOD is checked in the Options dialog.
  192.  
  193. ==================================================
  194. Effect Commands Supported and their Laser colors
  195. ==================================================
  196. *NOTE: the ProTracker definitions are used by MODZap.  E-effects will still show up on the lasers for StarTrekker modules, but will have no effect on playback*
  197. *NOTE2: If no color is stated, that effect doesn't trip the lasers*
  198.  
  199. 0 - Arpeggio if nonzero effect data, no effect otherwise (Purple if Arp.)
  200. 1 - Pitchslide up  (Red)
  201. 2 - Pitchslide down (Blue)
  202. 3 - Tone Portamento (Green)
  203. 4 - Vibrato (Purple)
  204. 5 - Tone Portamento with Volume Slide (Yellow)
  205. 6 - Vibrato with Volume Slide (Yellow)
  206. 9 - Sample position jump (Green)
  207. A - Volume slide (Red)
  208. B - Song position jump (Aqua)
  209. C - Set volume (Blue)
  210. D - Break to next position (Aqua)
  211. E - Multiple effects (all of these are White)
  212.   E1 - Fine pitchslide up
  213.   E2 - Fine pitchslide down
  214.   E6 - Set Loop/Jump to Loop (includes undocumented mode used by MOD.BassBins)
  215.   E9 - Retrigger note
  216.   EA - Fine Volume Slide Up
  217.   EB - Fine Volume Slide Down
  218.   EC - Note Cut    
  219. F - Set tempo (Red)
  220.  
  221. Note that some effects are ignored deliberately; this includes the following:
  222.  
  223. 8 and E8 are not defined on any Amiga¬ tracker.
  224. E0 controls the Amiga¬ hardware filter; the IIgs has no such beast.
  225. EF is a 'useless' effect which was removed as of ProTracker¬ 1.3 on the Amiga; Lars Hamre told me that since its not supported on the Amiga any more I shouldn't support it on the IIgs. (heh)
  226.  
  227. =================
  228. Comparison Chart
  229. ===============
  230.  
  231. Note:  This is mainly on stuff that's important to me.  Your wish list probably is (heck, should be) different...
  232.  
  233. Typographer╒s note: the following table is set in TrueType¬ Monaco 12; Monaco is included when you purchase Alan Bird╒s excellent Pointless¬.
  234.  
  235. Feature           MODZap¬ 0.90  NoiseTracker¬ 1.1 soniqTRACKER¬ 0.63 ShellPlay 0.6b3
  236. -----------------------------------------------------------------------------------
  237. Compatibility:
  238. NoiseTracker¬       Yes              Yes                 Yes           Yes
  239. ProTracker¬         Yes              Limited             Yes           Yes
  240. StarTrekker¬        Yes              Limited             Yes           Yes
  241. Others              No               SoundSmith¬         No            No
  242. Sonic Blaster¬      Yes              Yes                 Yes***        Yes***
  243.  
  244. # of Effects:       21               3                   19            29
  245.  
  246. Other:
  247. Swap method:        Loop-mode        Swap-mode           Swap-mode     Loop-mode
  248. Filtering:          N/A              Yes                 Yes           N/A
  249. Sound quality:      Excellent        Very Good           Very Good     Excellent
  250. DOCRAM Caching      Yes              Yes                 Yes           No
  251. Smart volume        Yes              Yes                 No            Yes
  252. Smart looping       Yes              No                  Yes           Yes
  253. Editor              No               Yes*                No            No
  254. OS                  GS/OS 6.0        ProDOS 8            GS/OS 5.0.2   GS/OS 6.0
  255. Keyboard            Yes              Yes                 No            No
  256. Graphicless Player  Yes              Yes                 No            Yes
  257. Jukebox             Yes              No                  Yes           No
  258. Tuning              Yes              No                  Yes           Yes
  259. ╥Scrolly╙ Player    Yes              Yes                 No            No
  260. Bouncing Notes      No               Yes                 No            No
  261. Freq. meters        Yes              No                  Yes           No
  262. Lasers              Yes              No                  No            No
  263. Loading speed       Excellent        Poor                Good          Good
  264. State**             Excellent        Good                Excellent     Excellent
  265.  
  266. * NoiseTracker GS has 2 save formats, neither of which are Amiga MODules.
  267. ** I.E., number and severity of known bugs.  There has been at least one documented case of NoiseTracker destroying a hard disk partition.  NoiseTracker also crashes frequently during song entry and editing. (even the 1.1 version which I programmed).
  268. *** The AE Sonic Blaster card has problems with very high output levels.  MODZap¬, SoundSmith¬, NoiseTracker GS¬, and many others lower the levels slightly to compensate; soniqTRACKER and ShellPlay allow you to manually compensate for this.
  269.  
  270. ===========
  271. Other Stuff
  272. ==========
  273.  
  274. MODZap¬ is Freeware.  This means that it may be distributed freely anywhere and
  275. you are under no obligation whatsoever.  GEnie, America Online, CompuServe, and
  276. the Internet are all allowed to distribute MODZap¬, as is Big Red Computer Club.
  277. Other shareware/PD publishing companies may distribute MODZap¬ provided no more than $5.00 US is charged for the diskette.  I don't believe in ripping people off just
  278. because they don't have a modem.  
  279.  
  280. MODZap is copyright (c) 1992-93 Ian Schmidt and Two Meg Software.  All Rights Reserved under applicable laws.  Please respect copyrights and do not use any code from MODZap¬ without permission.  If you would be interested in a tool or link
  281. module to play MODules, let me know.
  282.  
  283. Excerpt from ╥Mission╙ copyright (c) 1987 Anthem Records and CORE Music Publishing.
  284. Two Meg Software is a trademark of Ian Schmidt.
  285. Amiga is a trademark of Commodore Business Machines, Inc.
  286. GEnie is a service mark of General Electric Information Services Company.
  287. America Online is a service mark of AOL, Inc.
  288. Sonic Blaster is a trademark of Applied Engineering, a division of AE Research.
  289. CompuServe is a service mark of CompuServe, Inc, a division of H&R Block.
  290. SoundSmith is a trademark of Huibert Aalbers.
  291. Finder and Apple IIgs are trademarks of Apple Computer, Inc.
  292.  
  293. Known modules with problems:
  294.  
  295. None at this time!
  296.  
  297. Known modules with what sound like problems but aren't:
  298.  
  299. MOD.XMASPudding [xmas pudding mix] - the beginning of block 17 stutters, rap-style.
  300. This is caused by a Jump Loop command NOT a program bug.
  301.  
  302. Author's picks: (new and improved!)
  303. These modules are ones which work with MODZap¬ and are worth finding in my opinion...
  304.  
  305. MOD.Cortouchka [cortouchka!] (Cool generic hard rock MOD with nice guitars).
  306. MOD.ProgFunk [Progressive Funk] (Neither progressive nor funky, cool anyhow)
  307. MOD.RIAD [Rhythm_Is_A_Dancer] (At ~915k, the biggest MOD I know of; nice clean samples; brag at 640k-barrier IBMmers heh heh)
  308. MOD.Lotus3 [L3-CD3-Lotus3] (Amazing tour de force of what MODs could be if authors did a better job)
  309. Hunter.MOD [SOFTHUNTER.MOD] (Bach's Toccata and Fugue in Gmin; no pipe organ in sight though *sigh*)
  310. MOD.AbFucker [AbFucker] (fun for fans of hardcore house; very short tho)
  311. HouseOut.MOD [Get your house out] (U4ia does house; obnoxious yet fun)
  312. HouseNoLiving [House of no living 3] (Way cool classical choir intro and ending; way generic house middle)
  313. XMASMix [xmas mix] (Not to be confused with xmas pudding mix, this MOD does XMAS tunes in a jazz style instead of techno)
  314.  
  315. MODZap¬ was made possible by the following:
  316.  
  317. ╥DYA╙ Matt Keller for the most excellent Pumpy Player¬.
  318.  
  319. James Brookes for the cool ╥WoodTracker╙ QuadraScope design and artwork.
  320.  
  321. Lars ╥Zap╙ Hamre, author and inventor of ProTracker for the Amiga, for his valuable hints and information on PTrkr ╘undocumented features╒.
  322.  
  323. Tim ╥Forget GNO, I╒ve got the Side Project from Hell╙ Meekins for not making it abundantly clear to asshole extrordinaire Chuckie T. that he isn't with the Dysfunctional Brady Bun....err, One World Software ╥Wizards╙.
  324.  
  325. My greatest sympathies to anyone too stupid to realize that VAMPS is a joke of the worst kind, especially if you've paid money to download one or more of the disks.
  326.  
  327. Jawaid ╥No, really, its your bug╙ Bazyar for forgetting who the actual GNO beta testers are.
  328.  
  329. Brian ╥RedWine╙ Cervany for letting me play with and tape record his Amiga.
  330.  
  331. Steve ╥I don't have any╙ Bilgrien for support beyond the call of duty.
  332.  
  333. Everyone at Warner Bros. who worked on Tiny Toons.
  334.  
  335. Lee, Lifeson, and Peart for their wonderful concert in St. Louis on 6/12/92.
  336.  
  337. Scott Anderson, Mike Frankowski, and Joshua Thompson.
  338.  
  339. Hellos to the following:
  340.  
  341. ╥Robo╙ Dave Lyons, Marc -30- Sira, Brian ╥p-p-peach nectar╙ Tao, The Omega Concern, and of course The Mid.
  342.  
  343. MODZap¬ has been brought to you by the letter ╘F╒.