home *** CD-ROM | disk | FTP | other *** search
/ Deathday Collection / dday.bin / menus / dmfe / dmfe.doc next >
Text File  |  1994-01-22  |  10KB  |  200 lines
  1.  
  2.     DMFE version 0.0.1 - DMAUD Front-End, January 1994 by Douglas Reedy
  3.  
  4.                Because good code requires little documentation,
  5.                       this documentation is lengthy.
  6.  
  7.     WHAT?
  8.     -----
  9.     DMFE provides a simple front-end to Bill Neisius' excellent utility,
  10.     DMAUD, which allows you to swap out the sound files used by i.d.
  11.     Software's great DOOM adventure game with sound files of your own
  12.     choosing. DMAUD supports WAV, VOC, SND, AU, and other formats
  13.     at any sampling rate; DMAUD will convert them as necessary.
  14.  
  15.     DMFE creates a DOS batch file that calls DMAUD to quickly replace
  16.     the current DOOM sounds with your selections. DMFE can also recall
  17.     your selections for later tweaking if you pass the name of the DOS
  18.     batch file (usually MAKEMAUD.BAT) back to DMFE on the command line.
  19.  
  20.     DMFE relies on DMAUD for the following tasks:
  21.  
  22.         1) To preview sounds in the DOOM .WAD file
  23.         2) To finally alter the DOOM .WAD with the sounds you've selected
  24.            from your own personal collection via the MAKEMAUD.BAT batch file.
  25.  
  26.     In short, you'll need DMAUD for DMFE to be of any use whatsoever.
  27.  
  28.  
  29.     WHY?
  30.     ----
  31.     We're not really sure. Assumably because you've played DOOM until
  32.     your eyes have begun to bleed. In your twisted state, you've
  33.     rationalized that playing DOOM just ONE MORE TIME would somehow be
  34.     justified if the sounds were different. Enter DMAUD.
  35.  
  36.     DMFE is the parasitic tick that feeds on the life blood of DMAUD.
  37.     Swapping DOOM sounds becomes easier with DMFE, and you can reuse
  38.     your new selections later when you to tweak one or two of them.
  39.     DMFE creates a simply batch file, MAKEMAUD.BAT, that feeds the
  40.     hungry DMAUD beast with the DOOM slot numbers and sound files you
  41.     select during your DMFE session.
  42.  
  43.  
  44.     HOW?
  45.     ----
  46.     First, make sure you have extracted DMAUD to your DOOM directory.
  47.     DMAUD works with the DOOM.WAD or DOOM1.WAD file, depending on your
  48.     version of DOOM. If DMAUD can't see the .WAD file, it will tell you
  49.     so during your DMFE session. This can be rather messy.
  50.  
  51.     Second, extract the DMFE files to your DOOM directory.
  52.     DMFE works with DMAUD, and if DMFE can't see DMAUD, it will tell you
  53.     so during your DMFE session. This can also be rather messy.
  54.  
  55.     You are now ready to start DMFE:
  56.  
  57.         E:\DOOM> DMFE [ENTER]
  58.  
  59.     DMFE checks for the presence of a configuration file, DMFE.CFG.
  60.  
  61.     If found, DMFE will load the locations of directories that contain
  62.     sound files on your system. Presently DMFE only loads 3 directories;
  63.     one per WAV, VOC, and SND formats, in that order. You can edit
  64.     the DMFE.CFG file with the editor of your choosing, assuming said
  65.     editor writes standard ASCII text. DOS 5/6's EDIT is a sound choice.
  66.  
  67.     If DMFE.CFG is not found in the current directory, you will be prompted
  68.     for the three afore-mentioned directories in a very spartan, no-frills
  69.     way. This means that you only get one chance to type things correctly.
  70.     Use your DOS editor to change DMFE.CFG, or just blow it away and run
  71.     DMFE again.
  72.  
  73.     In addition to the pathnames to your sounds files, DFME prompts for the
  74.     name of a DOS sound player utility which presumably came with your
  75.     sound device. For example, the Pro Audio Spectrum comes with a utility
  76.     called PLAYFILE.EXE which plays WAV and VOC (but not SND) files from DOS.
  77.     A great utility for general-purpose playback of WAV/VOC/SND/AU/etc files
  78.     is PLANY by DMAUD's author, Bill Neisius.
  79.  
  80.     Once you've given DMFE the configuration information (or once the
  81.     existing configuration file is found and loaded), DMFE will attempt
  82.     to load all of the sound files it finds in the directories you entered.
  83.  
  84.     If DMFE can't find any sound files at all, it will terminate with an
  85.     error message telling you so. You'll need to either edit the DMFE.CFG
  86.     file or delete it and run DMFE again to correct this problem.
  87.  
  88.     If DMFE finds sound files, it proceeds to display a list the 49 DOOM
  89.     sound slots, a description for each slot, a sample number, and a
  90.     filename for the replacement sound, ie:
  91.  
  92.          1: Pistol fire                              0:  [ none ]
  93.           .
  94.           .
  95.           .
  96.         49: Player punching                          0:  [ none ]
  97.  
  98.     The following keystrokes are active during your DMFE session:
  99.  
  100.     KEYSTROKE       DESCRIPTION
  101.     --------------  --------------------------------------------------------
  102.     Down Arrow      Increment slot number (move down the list of slots)
  103.     Up Arrow        Decrement slot number (move up the list of slots)
  104.     Right Arrow     Increment the soundfile list by one (1)
  105.     Left Arrow      Decrement the soundfile list by one (1)
  106.     PageDown        Increment the soundfile list by ten (10)
  107.     PageUp          Decrement the soundfile list by ten (10)
  108.     Home            Go to top of soundfile list (0)
  109.     End             Go to end of soundfile list (x)
  110.     Delete          Remove (zero) replacement sound from current slot (0)
  111.     ENTER           Playback the replacement sound using your DOS player
  112.     Ctrl-ENTER      Playback the original slot sound using DMAUD
  113.     Any other key   Jump to the next soundfile whose name begins with <key>
  114.     ESC-ESC         Save your selections to the MAKEMAUD.BAT batch file.
  115.                     (Any existing MAKEMAUD.BAT will be renamed automatically.)
  116.     ------------------------------------------------------------------------
  117.  
  118.     NOTE: DMFE attempts to redirect any textual output from your DOS sound
  119.           player to the NUL device to prevent your DMFE session from getting
  120.           cluttered with extraneous messages. If your DOS player bypasses
  121.           the BIOS or does not recognize the command-line options provided by
  122.           DMFE, previewing a replacement sound file by pressing ENTER may not
  123.           be worthwhile. The solution here is either to simply not press ENTER
  124.           or to obtain a well-behaved player such as PLANY.
  125.  
  126.           DMFE also attempts to redirect the textual output from DMAUD to
  127.           the NUL device when Ctrl-ENTER is used to playback the original
  128.           sound file from the current DOOM .WAD file. However, any error
  129.           messages from DMAUD will not be redirected.
  130.  
  131.     WHEN?
  132.     -----
  133.     The first time you run DMFE and save your selections with ESC-ESC,
  134.     the initial MAKEMAUD.BAT batch file will be created. If a MAKEMAUD.BAT
  135.     file already exists in the current directory, DMFE will rename it and
  136.     write a new MAKEMAUD.BAT batch file. The name DMFE selects is based on
  137.     your computer's internal clock, so pay attention to the message DMFE
  138.     spits out when you press ESC-ESC.
  139.  
  140.     You may wish to later tweak the replacement sound settings after you
  141.     have saved them with DMFE and given them a test drive in DOOM. To do
  142.     so, simply pass the name of the .BAT file DMFE created back to DMFE
  143.     when you start the program, ie:
  144.  
  145.         E:\DOOM> dmfe makemaud.bat [ENTER]
  146.  
  147.                       or
  148.  
  149.         E:\DOOM> dmfe 172382.bat [ENTER]
  150.  
  151.     In order for this to work properly, DMFE must be able to find the
  152.     the exact same sound filename in the directories you've told it to
  153.     scan. If you rename, move, or delete a sound file or change the
  154.     original search directory in DMFE.CFG, you'll see "[ none ]" in the
  155.     slot where the sound file had been. Common sense is applicable here.
  156.  
  157.  
  158.     WHERE?
  159.     ------
  160.     If you have any comments or suggestions, feel free to write me on
  161.     the internet: welch@zaphod.mps.ohio-state.edu.
  162.  
  163.     DMFE is freeware. Distribute it wherever you like, just don't alter
  164.     the original archive in any way or a host of Demon Lords will pay
  165.     a visit to you as you sleep. And you'll get a nasty hangnail, too.
  166.  
  167.     And now, the obligatory disclaimer: use DFME entirely at your own risk.
  168.     But using DFME, you agree to hold me harmless for whatever misfortune
  169.     might befall you, for whatever reason.
  170.  
  171.     For example, I am not responsible if, when you run DFME, your:
  172.  
  173.         ■ hard disk stops spinning or suddenly bursts into flames
  174.         ■ monitor explodes and rips off your face
  175.         ■ monitor implodes and sucks in your toupee
  176.         ■ CPU superheats and burns through the motherboard
  177.         ■ floppy drive motors spin in reverse, and only on Sundays
  178.         ■ sound device feeds back and blows your speakers
  179.         ■ CD-ROM becomes a write-only read-once device
  180.         ■ heart stops because you over-exerted yourself typing "DMFE"
  181.         ■ modem starts calling up young boys to come over and "play"
  182.         ■ modem starts dialing 1-900 or 1-976 phone sex numbers
  183.         ■ keyboard becomes pressure-sensitive and will only operate
  184.           at high velocities.
  185.  
  186.     These, and any other problem you experience, are yours to keep.
  187.     I am not, will not, and will never be held responsible for anything.
  188.     Period. If you don't agree to these terms, you aren't licensed to
  189.     run DMFE on any system you own and I invite you to delete DFME now.
  190.  
  191.     Isn't it sad that needs to be said at all?
  192.  
  193.     For the rest of you, I sincerely hope you find DMFE useful. Your
  194.     comments/suggestions will serve to motivate me to improve DMFE.
  195.  
  196.     Enjoy!
  197.  
  198.     Douglas Reedy
  199.     welch@zaphod.mps.ohio-state.edu
  200.