home *** CD-ROM | disk | FTP | other *** search
/ Audio Version 4.94 / audioversion4.94knowledgemediaresourcelibraryoctober1994.iso / msdos / modplay / vm2_24 / vm2.doc < prev    next >
Text File  |  1993-11-15  |  9KB  |  255 lines
  1.    Vectorballs Mod Player, v2.4, 11.93
  2.  
  3.    Written by Rhys of The Elven Nation.
  4.    Thanks to Codeblasters for Goldplay.
  5.  
  6.    REQUIRES:
  7.       80286 or compatible (or better)
  8.       VGA (or MCGA) video card
  9.       640k RAM (amount used depends on size of MODs)
  10.       .MOD files
  11.  
  12. -----------------------------------------------------------------------------
  13.  
  14.    You can download the latest version of Vectorballs Mod Player from
  15.    The Elven Nation's World Headquarters distribution site on internet.
  16.    Look in /TEN/pub/TEN or /TEN/pub/msdos/myprogs on
  17.    sunny.hawcc.hawaii.edu (128.171.143.7).  I don't know how long I
  18.    can keep this anonymous FTP site available, but I will fight tooth
  19.    and nail to keep it alive.
  20.  
  21.    Any e-mail can be sent to rhys@sunny.hawcc.hawaii.edu.
  22.  
  23. -----------------------------------------------------------------------------
  24.    Contents
  25. -----------------------------------------------------------------------------
  26.  
  27.    This is what is in the documentation (in order):
  28.  
  29.    PostCardWare Message
  30.    What it is...
  31.    How to start it...
  32.    Keys During Play
  33.    Disclaimer
  34.    DOS Error Codes
  35.    Future Plans
  36.    Known Bugs
  37.    Contact Info
  38.  
  39. -----------------------------------------------------------------------------
  40.    PostCardWare Message
  41. -----------------------------------------------------------------------------
  42.  
  43.    This program is postcardware...Send me a postcard from whereever you
  44.    are from and include your system specs.  (eg. 386/40, 5RAM-120HD,
  45.    SB-Pro (DMA:1, IRQ:7, PORT:$220), Tseng ET4K SVGA, DOS 5.0)
  46.  
  47.    Thanks to Gilles Valette from Reims, France for the ONLY POSTCARD I
  48.    HAVE RECEIVED FROM ANYBODY SINCE THE PROGRAM HAS BEEN RELEASED!
  49.    Sorry, but I thought I would get more than one (1) postcard. :)
  50.  
  51.    See the end of this document for contact information.
  52.  
  53. -----------------------------------------------------------------------------
  54.    What it is...
  55. -----------------------------------------------------------------------------
  56.  
  57.    VM2 is Mod player for the PC... (Yes, another one :).  What sets this
  58.    player apart from the others is that it provides an interactive
  59.    vectorball type of 3D environment with which to play with during
  60.    the music.
  61.  
  62.    Vectorballs are basically large 3D dots that compose a 3D object.  A Mod
  63.    is a convenient digital music format which originated on the Amiga.  It
  64.    has since migrated to various platforms, (thus the convenience), and has
  65.    become widespread.
  66.  
  67. -----------------------------------------------------------------------------
  68.    How to start it...
  69. -----------------------------------------------------------------------------
  70.  
  71.    VM2 requires the file VM2.DAT.  It must be in a directory in your path
  72.    and must have that exact name: VM2.DAT.
  73.  
  74.    VM2 also requires a configuration file.  Run VM2-CFG.EXE to create the
  75.    file.  Just answer the questions about your system's setup and VM2.CFG
  76.    will be saved.  VM2.CFG *must* reside in your path (sorry).
  77.  
  78.    To play a Mod, just use:
  79.       VM2 <Modname>
  80.    The .MOD extension is optional.
  81.  
  82.    Mods have become so commonplace now, you should have no trouble finding
  83.    some on a local BBS or Internet.  (A good place to check on Internet is
  84.    wuarchive.wustl.edu in /systems/amiga/...)
  85.  
  86.    I have included a sample Mod called Prelude, written by Clyde of
  87.    Triumph.  My apologies to Clyde, but I don't know how to contact
  88.    him for permission to distribute his Mod.
  89.  
  90. -----------------------------------------------------------------------------
  91.    Keys During Play
  92. -----------------------------------------------------------------------------
  93.  
  94.    All of this information is available in the program while the music
  95.    is playing.
  96.  
  97.    H
  98.    Display the online help screen.
  99.  
  100.    I
  101.    Display two screen of the MOD name and sample names.  Usually there
  102.    is something interesting written instead of sample names though.
  103.    
  104.    S
  105.    This toggles between "scrunched" and "normal" mirrored balls.  This
  106.    gives more of a water effect (?).  Which setting do you prefer?
  107.    (Default is un-scrunched)
  108.  
  109.    escape
  110.    Quit the program.  (novel idea eh? :)
  111.  
  112.    +
  113.    Speed up the rotation.
  114.  
  115.    -
  116.    Slow down the rotation.
  117.  
  118.    left arrow
  119.    Rotate vectorballs clockwise. (default)
  120.  
  121.    right arrow
  122.    Rotate vectorballs counter-clockwise.
  123.  
  124.    /
  125.    Display 16 vectorballs with mirror effect. (default)
  126.  
  127.    *
  128.    Display 8 vectorballs with mirror effect. (for slower machines)
  129.  
  130.    [
  131.    Decrease the master volume.  (Min is 0/Mute)
  132.  
  133.    ]
  134.    Increase the master volume.  (Max is 63)
  135.  
  136.    M
  137.    Toggles the sound on or off just like MUTE on your TV.
  138.  
  139.    1-4
  140.    Lock all vectorballs to channel 1-4.
  141.  
  142.    0
  143.    Set vectorballs to all channels. (default)
  144.  
  145.    F1-F7
  146.    Set vectorballs' method or pattern.  Just play with these to understand.
  147.    (F3 is default.)
  148.  
  149.    any other key (almost)
  150.    Stop the rotation if it is going--or start the rotation in the
  151.    opposite of its previous direction.
  152.  
  153. -----------------------------------------------------------------------------
  154.    Disclaimer
  155. -----------------------------------------------------------------------------
  156.  
  157.    Use this program at your own risk...I won't be responsible for anything.
  158.  
  159.    I have tested this program under Windows 3.1 (Windoze...) and it crashes.
  160.    Run it under DOS.  Could someone test it for me under OS/2 and let
  161.    me know the results?  Thanks.
  162.  
  163. ---------------------------------------------------------------------------
  164.    DOS Error Codes
  165. ---------------------------------------------------------------------------
  166.  
  167.    Whenever VM2 quits back to DOS due other than from normal quitting,
  168.    it will return a DOS error code which can be checked by an "if
  169.    errorlevel==x" statement in a batch file.  This was used for debugging
  170.    purposes, but I left it in just for the hell of it.  Here are the
  171.    errorlevels:
  172.  
  173.     0 : normal termination
  174.     1 : error on command line (usage)
  175.     2 : VGA requirement not met
  176.     3 : notice to reboot without memory manager
  177.     4 : MOD file could not be found or is invalid (1)
  178.     5 : MOD file could not be found or is invalid (2)
  179.     6 : MOD file could not be found or is invalid (3)
  180.     7 : not enough memory to play MOD
  181.     8 : VM2.DAT file could not be found
  182.     9 : VM2.CFG file could not be found
  183.    10 : VM2.CFG file could not be loaded
  184.    11 : VM2.CFG file invalid
  185.  
  186. ---------------------------------------------------------------------------
  187.    Future Plans
  188. ---------------------------------------------------------------------------
  189.  
  190.    Thanks to those of you (few) people who gave me suggestions on how
  191.    to improve VM2...You know who you are.  Priorities are in parentheses
  192.    with '1' being first priority and '+' being well you know...when I get
  193.    around to it. ;)
  194.  
  195.    (1) Add Gravis Ultrasound support (GUS).  This is currently under
  196.        development, and VM2-GUS should be available shortly.
  197.    (2) Add additional vectorball methods...[This one is not so easy.]
  198.        SORRY I didn't add any new methods this time around.  I just
  199.        couln't get any *good* ones to work.  Maybe next time.
  200.    (3) Use different (better) sound routines [maybe DSMI? & GUSMOD?]
  201.    (+) Faster/smoother routines. [like rewriting this in assembler--
  202.        some year]
  203.  
  204.    Plus, whatever else I forgot to mention...Send ideas!
  205.  
  206. ---------------------------------------------------------------------------
  207.    Known Bugs
  208. ---------------------------------------------------------------------------
  209.  
  210.    Fortunately, I only know of three bugs.
  211.    1) Don't run VM2 after running DMP.  DMP hoses up the timer
  212.       interrupt, and doesn't reset it.  This may happen with
  213.       other MOD players as well.
  214.    2) There are some old MODs which VM2 doesn't like.  Klisjepa.mod
  215.       is a prime example.  If you really want to listen to one of
  216.       those old mods, use a different player (sorry).
  217.    3) If you try to play a mod which is bigger than the amount of
  218.       memory you have free, the program will hang the computer.
  219.       I tried comparing the file size to the max contiguous
  220.       available memory on the heap, but this didn't seem to work.
  221.  
  222. ---------------------------------------------------------------------------
  223.    Contact Info
  224. ---------------------------------------------------------------------------
  225.  
  226.    Send bug reports, suggestions, ideas, comments, gripes, etc. to:
  227.  
  228.    E-mail:
  229.    rhys@sunny.hawcc.hawaii.edu
  230.  
  231.    (guaranteed valid until 12/93)
  232.    swalker@uhunix.uhcc.hawaii.edu
  233.    SWALKER@UHUNIX.BITNET
  234.  
  235.    Snail-Mail:
  236.    Mr. Sunny Walker
  237.    aka Rhys of The Elven Nation
  238.    PO Box 1424
  239.    Kamuela, HI  96743  USA
  240.    RE: VM2
  241.  
  242.    Or, if all else fails, send email to Freejack of The Elven Nation:
  243.    freejack@shell.portal.com
  244.  
  245.    Remember, please send the postcard with your system configuration.
  246.  
  247.    Don't hesitate to send better/faster/optimized code for MOD playing,
  248.    vectorball/solid-vector graphics or direct VGA programming. ;)
  249.    I know this program could be made a lot better if I knew how, so tell
  250.    me how I can do it.  BTW, VM2 is written in Turbo Pascal 7.0 using
  251.    a nice and fast ModeX library.
  252.  
  253.  
  254. Hope you enjoy it.
  255.