home *** CD-ROM | disk | FTP | other *** search
/ Quake 'em / QUAKEEM.BIN / doom_i / program / wadsfx9b.exe / WS.DOC < prev    next >
Encoding:
Text File  |  1995-07-16  |  7.9 KB  |  163 lines
  1. ==============================================================================
  2. WadSFX v0.95         DOOM Sound Effects Editor         Rob McCafferty 09/16/94
  3. ==============================================================================
  4.  
  5. WHAT IT IS
  6. ----------
  7. WadSFX is a digital sound effects utility for DOOM.  It allows you to create
  8. a .WAD file from other sound WAD's and from .VOC files.  Sounds can be played
  9. from within the editor if you have a Sound Blaster compatible card.  The
  10. sounds will be used by DOOM if you do this: "DOOM -file mysounds.wad".
  11. You can use these files along with other WAD's (new levels, etc.) at the same
  12. time.  THIS PROGRAM DOES NOT MODIFY DOOM.WAD OR ANY OTHER DOOM FILES.  It
  13. creates new .WAD files.
  14.  
  15. This program will not work for the PC speaker sounds.  Sorry, but I don't know
  16. anything about the PC speaker sound format.  If you're playing DOOM thru a PC
  17. speaker, you're definately missing out!  The digital sounds rule!
  18.  
  19. This will also not work with Shareware versions of DOOM.  It would be easy
  20. for me to add support for it, but id Software requested that we don't make
  21. things that work with the Shareware version.  Besides, DOOM rules!  Isn't
  22. it about time you registered?
  23.  
  24.  
  25. THIS HERE FILE
  26. --------------
  27. The program is FAIRLY self-explanitory.  If you'd rather fumble through it
  28. instead of reading this file, please at least read from the "SOME NOTES"
  29. section on.  I suggest you at least scan thru it though, cause there are a
  30. few things that probably need explained.  You should also read the UPDATE
  31. file, which includes a list of known bugs.
  32.  
  33.  
  34. THE SCREEN
  35. -----------
  36. The top line of the screen is the status line.  This is where all messages
  37. and user input go.
  38.  
  39. The listbox is the large box on the left of the screen.  This shows the
  40. resource name, description and source for each of the 61 sound effects.  The
  41. resource name isn't important, it's just the internal name DOOM assigned to
  42. the sound.  It's really only useful to people who write DOOM utilities :>
  43. The 'Source' shows what file is supplying the sound.  It's initially just a
  44. row of dashes, meaning that DOOM is supplying all of the sounds.  These sounds
  45. will of course not be written out to a .WAD file.  When you load a .WAD or
  46. .VOC file, the name of the file containing the sound shows up here.
  47.  
  48. To the right of the listbox is the menu.  Just press the letter for the
  49. command you want.
  50.  
  51.  
  52. THE KEYS
  53. --------
  54. The UP & DOWN cursor keys, HOME and END scroll you through the sound list.
  55. ESC exits the program.  When an error message appears in the status line,
  56. press any key to clear it and return to the program.  When you're prompted
  57. for a filename or other text entry, ESC will abort the operation.  You can
  58. also press any key while a sound is playing to stop it.
  59.  
  60.  
  61. THE COMMANDS
  62. ------------
  63. L: Load WAD - Prompts you for a filename of a .WAD file, and loads it.  If you
  64. don't give an extension, .WAD is assumed.  All of the soundcard sounds will be
  65. loaded from the WAD.  All other data will be ignored.  The Source field on
  66. the screen will be updated for each of the sounds loaded.  Any sounds not
  67. replaced by the loaded WAD will remain as they were.  You can open up to 16
  68. WAD's at once.  At this time, ALL sounds replaced by the WAD will be loaded.
  69. There's no way to just pick certain ones.  If you need to do this, load the
  70. WAD and extract .VOC files for the sounds you want, then start over and load
  71. the VOC's back in.  Note that it IS possible to load DOOM.WAD this way, but
  72. there's no reason to do so.  If you do, all DOOM sounds will be written out
  73. to the .WAD file if you save it (all 623k of them!).  BTW, loaded WAD's WILL
  74. NOT be modified in any way (unless you accidently overwrite them).
  75.  
  76. S: Save WAD - Prompts for a filename for the new WAD, and saves the current
  77. sounds to it.  Sounds you haven't replaced (Source field is ------) will not
  78. be written.  DOOM will still supply it's default sounds for them.  If you
  79. don't give an extension, .WAD will be appended.  I think the name MUST end in
  80. .WAD for DOOM to load it though.  If the file already exists, it will be
  81. overwritten.  DO NOT attempt to write to a file that is loaded or the program
  82. will crash.
  83.  
  84. R: Read VOC - Prompts for a filename of a .VOC file, and loads it into the
  85. current slot.  If you don't enter an extension, .VOC is appended.  The .VOC
  86. file should be an 8-bit mono sample, sampled at 11025 HZ (DOOM will play it
  87. back at 11025 no matter what rate you actually sampled it at).  As far as I
  88. know, there's no limit on the size of the sample (I've used some over 100k)
  89. or the total size of the .WAD file (I've used some over 1 Meg).  Note that
  90. DOOM truncates certain sounds to a few seconds at playback, while it plays
  91. others over 10 seconds long!
  92.  
  93. W: Write VOC - Prompts for a filename for a new .VOC file and writes the
  94. current sound out to it.  The current sound can be supplied by DOOM, or by
  95. a .WAD file.  This will NOT work if the current sound is supplied by a .VOC
  96. file, because it would write out the same exact file as you loaded (the DOS
  97. COPY command is probably better for this!).  If the file exists, it will be
  98. overwritten.
  99.  
  100. K: Kill - Deletes the current sound, and resets the Source back to '------'.
  101. If there's nothing loaded in the current slot, nothing happens.
  102.  
  103. A: Kill All - Deletes ALL loaded sounds.  If none are loaded, nothing happens.
  104. You are prompted for confirmation first (press Y or N).
  105.  
  106. P: Play - Plays the current sound.  This works on ALL sounds.  If you haven't
  107. loaded anything in the current slot, the default DOOM sound is played.  This
  108. only plays sounds smaller than 64k.  Keep in mind that neither DOOM nor any of
  109. the other commands have this limitation, so you can create WAD's with sounds
  110. over 64k, you just can't play them from within the editor.  The only reason
  111. for this limitation is that I don't know how!  If anyone has code to play a
  112. sound > 64k thru a Sound Blaster, feel free to send it to me!  Note that the
  113. sounds aren't truncated to 64k, they're taken MOD 65536.  This means that if
  114. your sound is 65540 bytes long, you'll hear 4 bytes worth (about .00036
  115. seconds)!  BTW, 64k comes out to about 6 seconds.
  116.  
  117.  
  118. SOME NOTES
  119. ----------
  120. When sounds are 'loaded' from a WAD, they're not actually loaded.  Information
  121. about them is loaded so they can be found quickly, but the actual data stays
  122. on disk.  You will notice a slight delay when playing a sound from the editor
  123. if the sound is big.  This is the data being temporarily read into memory so
  124. it can be played.  Future versions may use EMS or XMS or something.
  125.  
  126. When .VOC's are loaded, the raw data is read into a temporary file called
  127. "WSTEMP.$$$".  If you ever see this file, you can delete it.  You probably
  128. won't though, cause the program deletes it when you exit.
  129.  
  130. YOU MUST HAVE THE 'BLASTER' VARIABLE SET TO USE THE PLAY COMMAND.  Actually,
  131. you must have it set to run the program or it will crash during
  132. initialization.  'nuff said.
  133.  
  134. Oh, something else important.  If you don't run this from your DOOM directory,
  135. set DOS variable "DOOMPATH" to the correct directory.  This is so sounds from
  136. DOOM.WAD can be read in and played.
  137.  
  138.  
  139. YOUR OWN RISK
  140. -------------
  141. This is a BETA version.  It could quite possibly have bugs.  Even if it was
  142. the final release, it could still quite possibly have bugs.  All I can tell
  143. you is that is hasn't trashed my disk yet or anything.
  144.  
  145.  
  146. REGISTRATION
  147. ------------
  148. If you use this program, registration is $49.95.  JUST KIDDING.  IT'S FREE!
  149. If you like it, please write and tell me so.  You can also do this, of course,
  150. if you think it sucks.  Sorry, but I don't have an Internet address yet.  I
  151. do, however, have a mailbox.
  152.  
  153. Send comments, suggestions, bug reports, etc. to:
  154.  
  155.         Rob McCafferty
  156.         242 W. Sanner St.
  157.           Somerset, PA  15501
  158.  
  159. If you make anything cool with this, please feel free to send it, or let me
  160. know where I can download it from!
  161.  
  162. Enjoy!
  163.