
		****  R I S E N 3 D  S O U N D - DECEMBER 2021 ****
 
  
===================================================================================
 No music with "Creative SoundFont Synthesizer" 
===================================================================================

 Midi files will not play with this at all. If trying to use this then you
 will see (assuming a midi file is to be played) BAD FILE or MIDI DEVICE
 displayed in Risen3D's Control Panel SOUND (hit F4 to get this up).

 Since it is normally better to use the Microsoft GS Wavetable SW synth
 it is recommended that this is set as the midi device.

===================================================================================
 SFX volume affected when changing the midi volume  
===================================================================================

 A user reported on the forum that changing the midi volume
 affected the sfx volume. This fault is rare and despite Risen3D
 having been tested with many types of sound chips and cards this fault
 has never been encountered (and therefore cannot be diagnosed). It
 appears to be caused when using a low cost, defeatured sound card.
 
 There are two things that can be tried;

  a) Put -useFMODs on the Launcher's command line to force fmod to
     use a software mixer specifically for use with defeatured sound
     cards or, if this does not correct the problem,

  b)  put -FMODmidi on the Launcher's command line to force fmod
      to play midi files instead of Risen3D's internal midi sequencer.
      Note that fmod's midi player (versions up to 00044403 have been
      tried) does not always give the best results. Compare between
      the two using Doom E1M5's mus file to hear the difference. This
      has nothing to do with Risen3D and is solely an fmod problem.
      Note that no midi device selection will be shown when using fmod
      to play midis.

===================================================================================
 PLAYING PREDEFINED MUSIC LISTS
===================================================================================

 A list of predefined music files to be played on a map by map basis can be
 externally set up and then used by Risen3D.

 A list file must have the .r3m extension and must be placed in the folder
 R3DLaunch\music.  Since it is much easier to use the Launcher to build
 lists using the browse facility it is recommended this should be used.

 If installing ogg music from our site then playlists will be added
 automatically and can be selected using the Launcher.

 NOTE: CD support was removed a while ago. If desperate to play a CD then
       you can use Window's MediaPlayer and just ALT-TAB out to change a
       track.

 DEFINING CUSTOM PLAYLISTS

 This can be (and is best done) using the Launcher. Lists can be defined
 using notepad and can be selected to run using the MANUAL button in the
 Launcher. For more info see Launcher help.

 To define the external music file you wish to play for a particular map
 then put the MAPNAME followed by a space and then the fullpath\filename.
 To ensure that paths with spaces in the folder names are properly de-
 coded enclose the fullpath\filename in double quotes.

 For example if you wanted to play a .mp3 for episode 2 map 3 of DOOM
 then, as an example, you would put in the list;

 E2M3 "e:\mymp3s\cher\The Greatest Hits\01_Believe.mp3"

 For DOOM2 map 10 then an example would be;

 MAP10 "c:\mp3s\anyold.mp3"

 This would work without the double quotes.  Note that if a path has
 spaces and is not enclosed in double quotes then Risen3D will exit
 with a script error.

 File types that can be played are .mod, .it, .s3m, .mid and .mp3.

 You can put the definitions in any order and limit it to just those
 maps you want to play a predefined file with.  That is not all maps
 need to be defined and definitions need not be ordered. You can
 also use DOOM and DOOM2 mapnames in the same list so it will play
 with either game.  E.g.;

 E1M3 demomus.mod
 E1M5 "h:\music\rock\cher\The Greatest Hits\01_Believe.mp3"
 MAP02 demomus.mod
 MAP23 "h:\music\rock\cher\The Greatest Hits\01_Believe.mp3"

 Using an external list with -extmus will override the maps own
 music including those with MUS THINGS (see MusInfo.txt).

 In the game itself you can revert to playing the maps own music
 definitions with the console command;

 playmusic map

 or press TOGGLE in ControlPanel SOUND (press F4 to get this up).

 Note that if a map has MUS THINGS then these are still tracked
 even when overridden so returning to the default map music will
 play the music currently set with a MUS THING.

 You can return to files defined in the list by using;

 playmusic list

 If you wish to bypass the Launcher ensure no playlists are selected
 then put -extmus listname on the command line.  Do NOT add the .r3m
 extension to the command line listname although the actual file MUST
 have this extension.


=============================================================================
 REVERB SOUND with Windows 98 and later Windows OS's
=============================================================================

 Reverb will not work with the Creative AudigySE card.  The card must
 support at least EAX 4.0 but this only supports EAX 3.0.

 The Audigy2 supports EAX 4.0 and the X-Fi range EAX 5.0 so reverb will
 work with these cards.

 Note that sound cards prior to the Creative Audigy (SB 16 for example)
 cause reverb to be applied to the music.  There's no simple fix for
 this.

 Note: For reverb to work 3D sound must be enabled.

 3D sound With Vista and newer requires a Creative Audigy (2 or 4 series)
 or X-Fi sound card and you will need to use the Creative Alchemy
 modification to get reverb to work. The limitation is that this is only
 possible with the Audigy2/4 or X-Fi cards. This has been caused by
 Microsoft removing some key software that was present up to and
 including XP from Vista on (the Hardware Abstraction Layer) for
 reasons of security. Note that Windows7 XP emulation does not fix
 the omission of the HAL layer.

 Fixes are available for both Vista and later Windows OS's. Installing the mod is
 straightforward. Go to;

    http://connect.creativelabs.com/alchemy

 to download and install the mod.  When run select 'add unspecified game'
 and tell it to install files to the Risend3D\bin folder.  This will add
 two files - dsound.dll and dsound.ini.

 Alternatively see our website for full details of how to download
 and install Creative's Alchemy mod.

 Following this 3D sound effects should play correctly.

 -----------------------------------------------------------------------
 DSOAL ( Direct Sound via OpenAL wrapper )

 For Sound chips installed on your PC's motherboard (and possibly cards not
 made by Creative Labs) reverb may be able to be enabled using DSOAL.

 Please read 3D Sound.txt found in R3D_Docs\3DSound\ for more info.
 
===================================================================================
 PLAYING FILES IN THE GAME AND PLAYMUSIC OPTIONS
===================================================================================

 You can override any music that's playing when in the game by dropping the
 console and typing playmusic (or pm) with the parameters as follows;

 1)	FILES
	ENTER;	playmusic file path/filename
	Where filename is a .mid, .it, .s3m, .mod, .mp3 or .ogg
	Path can either be relative to the games directory or, where this is
	not the case, the complete path. For example if you have created a
        folder called 'midi' in the Risen3D directory (and placed your midi
	files there) then just enter; pm midi/filename to play it. With no
	C:/ (or D or whatever) at the start then it will be assumed that the
	path is relative to the Risen3D folder.

	NOTE \ cannot be used. When typing a path use /

 2)	LIST
	ENTER;	playmusic list
	Plays current list entry for the map in play assuming a list
	has been loaded and has an entry for the current map.

 3)	LUMP	(name of music lump in the current wad/pwad)
	ENTER;	playmusic lump lumpname
	If the lump is a recognised music file then it will be played.

 4)	MAP
	ENTER; playmusic map
	Returns to playing the default map music.

 5)	DEFN entry	(not normally required)
	ENTER; playmusic trackname
	where trackname is that defined in the defn for the current map.

 NOTE: playing CD's is no longer supported.

 Music must be enabled in all cases. FMOD must be active for any file type to
 be played other than mus or midi types. Mus files can be played using LUMP
 else they should be dumped using the global command line -dumpmidis (see
 further down) which converts all mus files in the currently selected
 iwad/pwad to midi files and then dumps them to the /Risen3D/R3Ddump/ folder.
 From there they can be selected/placed where you want them allowing the FILE
 option to be used.

 In all cases, whilst in the map, the track will be looped.
 Pressing the PAUSE key will also pause any music playing.


===================================================================================
 VOLUME SETTINGS
===================================================================================

 Use F4 to go to the Risen3D SOUND options.
 ESC-OPTIONS-SOUND will also take you there.

 Note that no volume is displayed if using a USB connection to an external
 midi device. The device's own volume control should be used.


===================================================================================
 MIDI PROBLEMS and MUS compress
===================================================================================

 If you get problems with poor quality music sound or sluggish perform-
 ance then open windows START\Settings\Control Panel.  In the control
 panel select the Multimedia Icon.  Check that under the Audio tab in
 the Playback Preferred device box the (Use any available device) is
 set.  Do not use "Game compatible" as this will cause problems with
 both quality of sound and speed of the game.

 Under MIDI ensure the Single instrument radio button is selected.

 Distorted sound

 This usually happens with midis that have had the volumes increased at
 the time of creating the midi file.  This was probably because Win98
 and the Creative SB card often had problems with playing midis softly.
 In WinXP the Audigy drivers have been frigged to play midis more loudly
 but some will overload the card internally and no amount of fiddling
 with volumes corrects this.

 The situation can be improved by going to the Audi Panel in Risen3D
 and setting the MUS compress to 0.5  This effectively halves the
 maximum volumes set in the midi file.

 NOTE; MUS compress only works with MUS files.  These are converted to
 midi internally and, in the process, the MUS compress setting is taken
 into account.

 MUS compress can also be used to make converted MUS to MIDI files softer
 or louder by setting a value for 0.5 to 2.  1 means no change. If using
 2 then all the midi volume events are multiplied by 2.  If a volume
 exceeds the maximum allowed than it is clipped to the MAX volume. Thus
 this does not increase the volume by 2 it purely increases the volume
 of notes that are less than the maximum.  As such a compression value
 other than 1.0 will reduce the dynamic range.


===================================================================================
 -dumpmidi GLOBAL LAUNCHER COMMAND LINE OPTION
===================================================================================

 DUMP MUS/MIDI LUMPS as MIDI FILES

 You can dump all the mus songs in loaded wads/pwads (note usual precedence
 rules apply) by putting the required wads (as per normal) on the command
 line together with -dumpmidis.   This will dump all mus files after
 first converting them to midi files into the R3Dmidis directory in the
 games folder.  This directory will be created if it doesn't exist.  The
 files can then be played with a standard midi player (e.g. Winamp or
 Windows Media Player).  If the lumps were already in MIDI format then
 they will be dumped as they stand - this is notified in Risen3D.out.

 Note that Risen3D's MUS to MIDI converter separates out all the channels
 making it much easier to display these files in notation format with a
 suitable midi editor.


===================================================================================
 NOTE 1 - General channel support 
===================================================================================

 128 channels are best but the launcher can set this to 64 if problems are
 encountered. Testing with various cards/chips, however, has not unearthed
 any issues.


===================================================================================
 Note 2 - Speaker settings
===================================================================================

 Speaker settings cannot be changed from within Risen3D and should be set
 using Windows applications.

 These should already be set to suit your sound system but, if unsure, then
 using START/Control Panel/Sounds, Speech and Audio Devices/Sounds and Audio
 Devices to bring up the Sounds and Audio Devices Properties box select the
 Audio tab and under Sound Playback select Advanced.

 In the Speakers section set "Monitor stereo speakers" or "2.1 speakers"
 or 5.1 if you have the necessary hardware. 3D sounds will work with 5.1
 setups (woofer plus 2 front and 2 back speakers and 1 centre speaker).




G.M.J.	Previous version written November 2018 - revised December 2021
