About Custom Audio Support

Synopsis

This hack allows you to specify custom starting ambience tracks for every story mission and other audio related things.

Configuration

This is an example configuration for this hack with comments explaining how it works.

This configuration goes into CustomAudioSupport.xml in the root of your mod.

We do not recommend copying this entire example into your mod. We recommend only using what is necessary.

<?xml version="1.0" encoding="utf-8"?>
<CustomAudioSupport MusicSamplingRate="24000">
	<!--
	
	CustomAudioSupport.xml
		Control certain properties of the game's music system.

	<CustomAudioSupport>
		ForceMusicRMSLevel: Specify an RMS file to load at startup and use all the time. 
			This will prevent the game from ever unloading that level's RMS file.
			This means this can be used for seamless music when switching to/from the main menu and between levels.
		MusicSamplingRate: Defaults to 24,000. Optional.
		
	<Level>
		Index: The index of the level (zero-based).
		OR
		Number: The number of the level (one-based).
		
		StartAmbienceEventIndex: The ambience index that will be used for mission's that use 76 (interior).
		<Mission>
			Index: The index of the mission from 0 to 7.
				0 refers to the Tutorial in Level 1.
				0 refers to Mission 1 in Levels 2 to 7.
				7 does nothing in Levels 2 to 7 since there is only the 7 story missions and no tutorial.
			OR
			Number: Similar to index but works differently depending on the level.
				0-7 in Level 1.
				1-7 in Levels 2-7.

			StartAmbienceEventIndex: The ambience index that will be used when selecting the mission.
				76 means the mission starts in an interior and it will use the one specified on the level.
	<Interior>
		Name: The name of the interior.
		MusicEventIndex: The index of the music event to trigger when entering the interior.
		
	-->

	<Interior Name="KwikEMart" MusicEventIndex="20"/>
	<Interior Name="SpringfieldElementary" MusicEventIndex="21"/>
	<Interior Name="SimpsonsHouse" MusicEventIndex="19"/>
	<Interior Name="Krustylu" MusicEventIndex="19"/>
	<Interior Name="dmv" MusicEventIndex="23"/>
	
	<Level Index="0" StartAmbienceEventIndex="9">
		<Mission Index="0" StartAmbienceEventIndex="6" />
		<Mission Index="1" StartAmbienceEventIndex="6" />
		<Mission Index="2" StartAmbienceEventIndex="6" />
		<Mission Index="3" StartAmbienceEventIndex="6" />
		<Mission Index="4" StartAmbienceEventIndex="39" />
		<Mission Index="5" StartAmbienceEventIndex="6" />
		<Mission Index="6" StartAmbienceEventIndex="6" />
		<Mission Index="7" StartAmbienceEventIndex="26" />
	</Level>
	<Level Index="1" StartAmbienceEventIndex="7">
		<Mission Index="0" StartAmbienceEventIndex="4" />
		<Mission Index="1" StartAmbienceEventIndex="4" />
		<Mission Index="2" StartAmbienceEventIndex="4" />
		<Mission Index="3" StartAmbienceEventIndex="4" />
		<Mission Index="4" StartAmbienceEventIndex="4" />
		<Mission Index="5" StartAmbienceEventIndex="4" />
		<Mission Index="6" StartAmbienceEventIndex="4" />
		<Mission Index="7" StartAmbienceEventIndex="76" />
	</Level>
	<Level Index="2" StartAmbienceEventIndex="25">
		<Mission Index="0" StartAmbienceEventIndex="22" />
		<Mission Index="1" StartAmbienceEventIndex="22" />
		<Mission Index="2" StartAmbienceEventIndex="22" />
		<Mission Index="3" StartAmbienceEventIndex="29" />
		<Mission Index="4" StartAmbienceEventIndex="22" />
		<Mission Index="5" StartAmbienceEventIndex="24" />
		<Mission Index="6" StartAmbienceEventIndex="24" />
		<Mission Index="7" StartAmbienceEventIndex="76" />
	</Level>
	<Level Index="3" StartAmbienceEventIndex="51">
		<Mission Index="0" StartAmbienceEventIndex="76" />
		<Mission Index="1" StartAmbienceEventIndex="47" />
		<Mission Index="2" StartAmbienceEventIndex="48" />
		<Mission Index="3" StartAmbienceEventIndex="48" />
		<Mission Index="4" StartAmbienceEventIndex="48" />
		<Mission Index="5" StartAmbienceEventIndex="48" />
		<Mission Index="6" StartAmbienceEventIndex="48" />
		<Mission Index="7" StartAmbienceEventIndex="76" />
	</Level>
	<Level Index="4" StartAmbienceEventIndex="7">
		<Mission Index="0" StartAmbienceEventIndex="4" />
		<Mission Index="1" StartAmbienceEventIndex="4" />
		<Mission Index="2" StartAmbienceEventIndex="4" />
		<Mission Index="3" StartAmbienceEventIndex="4" />
		<Mission Index="4" StartAmbienceEventIndex="4" />
		<Mission Index="5" StartAmbienceEventIndex="4" />
		<Mission Index="6" StartAmbienceEventIndex="4" />
		<Mission Index="7" StartAmbienceEventIndex="76" />
	</Level>
	<Level Index="5" StartAmbienceEventIndex="70">
		<Mission Index="0" StartAmbienceEventIndex="67" />
		<Mission Index="1" StartAmbienceEventIndex="67" />
		<Mission Index="2" StartAmbienceEventIndex="64" />
		<Mission Index="3" StartAmbienceEventIndex="47" />
		<Mission Index="4" StartAmbienceEventIndex="64" />
		<Mission Index="5" StartAmbienceEventIndex="67" />
		<Mission Index="6" StartAmbienceEventIndex="67" />
		<Mission Index="7" StartAmbienceEventIndex="76" />
	</Level>
	<Level Index="6" StartAmbienceEventIndex="53">
		<Mission Index="0" StartAmbienceEventIndex="76" />
		<Mission Index="1" StartAmbienceEventIndex="57" />
		<Mission Index="2" StartAmbienceEventIndex="50" />
		<Mission Index="3" StartAmbienceEventIndex="76" />
		<Mission Index="4" StartAmbienceEventIndex="76" />
		<Mission Index="5" StartAmbienceEventIndex="57" />
		<Mission Index="6" StartAmbienceEventIndex="57" />
		<Mission Index="7" StartAmbienceEventIndex="76" />
	</Level>
</CustomAudioSupport>

History

1.22

Added support for a "Number" parameter on "Level" and "Mission" elements.

1.18

Added this hack.

Back to top