Music.tbl - Revision history

Goober5000: /* Related Links */

2022-11-26T05:06:50Z

Androgeos Exeunt: Added tables list.

2020-10-13T04:21:55Z

Added tables list.

← Older revision		Revision as of 04:21, 13 October 2020
Line 1:		Line 1:
	{{TableVersion\|5307}}		{{TableVersion\|5307}}
			{{Tables}}
	<code>'''music.tbl'''</code> is a [[Tables\|table file]] used by the ''FreeSpace'' game engine to define the [[music]] played during the game.		<code>'''music.tbl'''</code> is a [[Tables\|table file]] used by the ''FreeSpace'' game engine to define the [[music]] played during the game.

Androgeos Exeunt: /* $Name: */ Missing full-stops and extra clarification for Victory 2 added.

2020-10-09T14:18:48Z

$Name:: Missing full-stops and extra clarification for Victory 2 added.

← Older revision		Revision as of 14:18, 9 October 2020
Line 68:		Line 68:
	\| 3 \|\| Enemy Arrival during Ambience \|\| Plays when a hostile unit arrives while Ambience is playing.		\| 3 \|\| Enemy Arrival during Ambience \|\| Plays when a hostile unit arrives while Ambience is playing.
	\|-		\|-
	\| 4 \|\| Battle 1 \|\| Battle track 1.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 2		\| 4 \|\| Battle 1 \|\| Battle track 1.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 2.
	\|-		\|-
	\| 5 \|\| Battle 2 \|\| Battle track 2.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 3		\| 5 \|\| Battle 2 \|\| Battle track 2.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 3.
	\|-		\|-
	\| 6 \|\| Battle 3 \|\| Battle track 3.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 1		\| 6 \|\| Battle 3 \|\| Battle track 3.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 1.
	\|-		\|-
	\| 7 \|\| Allied Arrival during Battle \|\| Plays when a friendly unit arrives while any Battle track is playing.<br/>By default, plays on top of other audio tracks without seguing; in FSO builds, if <code>+Allied Arrival Overlay: NO</code> is added below <code>$Soundtrack Name:</code>, the currently playing track will segue into this instead.		\| 7 \|\| Allied Arrival during Battle \|\| Plays when a friendly unit arrives while any Battle track is playing.<br/>By default, plays on top of other audio tracks without seguing; in FSO builds, if <code>+Allied Arrival Overlay: NO</code> is added below <code>$Soundtrack Name:</code>, the currently playing track will segue into this instead.
Line 80:		Line 80:
	\| 9 \|\| Victory 1 \|\| Plays when a goal is completed.<br/>Segues into Victory 2, Ambience, or a Battle track depending on the remaining goals and hostile units remaining, and whether Victory 2 has already been called.		\| 9 \|\| Victory 1 \|\| Plays when a goal is completed.<br/>Segues into Victory 2, Ambience, or a Battle track depending on the remaining goals and hostile units remaining, and whether Victory 2 has already been called.
	\|-		\|-
	\| 10 \|\| Victory 2 \|\| Victory 1 segues into this track when all goals are completed ''and'' there are absolutely no hostile units present.<br/>Is only called once; if additional goals are validated in-mission and/or new hostile units arrive, Victory 1 will ~~not~~ segue into ~~this~~ track.		\| 10 \|\| Victory 2 \|\| Victory 1 segues into this track when all goals are completed ''and'' there are absolutely no hostile units present.<br/>Is only called once; if additional goals are validated in-mission and/or new hostile units arrive after this track has already been played, Victory 1 will segue into Ambience or a Battle track.
	\|-		\|-
	\| 11 \|\| Goal Failed \|\| Plays when the goals of a mission are failed.<br/>Is not ~~usually~~ called in-game.		\| 11 \|\| Goal Failed \|\| Plays when the goals of a mission are failed.<br/>Does not appear to be called in-game.
	\|-		\|-
	\| 12 \|\| Player Dies \|\| Plays when the player is killed and goes to the death screen		\| 12 \|\| Player Dies \|\| Plays when the player is killed and goes to the death screen.
	\|}		\|}
	{{Table3610\|		{{Table3610\|

Androgeos Exeunt: /* Soundtrack */ Reducing the amount of emphasis to increase the emphasis of the remaining amount.

2020-08-31T13:27:35Z

Soundtrack: Reducing the amount of emphasis to increase the emphasis of the remaining amount.

← Older revision		Revision as of 13:27, 31 August 2020
Line 14:		Line 14:

	== Soundtrack ==		== Soundtrack ==
	'''Each''' individual soundtrack ~~should~~ start with <code>#SoundTrack Start</code> ~~and~~ end with <code>#SoundTrack End</code> and ~~'''require'''~~ the following lines in between:		'''Each''' individual soundtrack '''must''' start with <code>#SoundTrack Start</code>, end with <code>#SoundTrack End</code>, and have the following lines in between:
	# <code>$Soundtrack Name:</code>		# <code>$Soundtrack Name:</code>
	# One of the following:		# One of the following:

Androgeos Exeunt: /* $Name: */ Technically, everything except Comments is "required", so I'm changing this word.

2020-08-07T10:18:58Z

$Name:: Technically, everything except Comments is "required", so I'm changing this word.

← Older revision		Revision as of 10:18, 7 August 2020
Line 48:		Line 48:
	{\| border=1 cellpadding=4 style="border-collapse: collapse; border: solid 1px #995050;"		{\| border=1 cellpadding=4 style="border-collapse: collapse; border: solid 1px #995050;"
	\|- align="center" colspan=3 style="background:#351515; border: solid 1px #995050;"		\|- align="center" colspan=3 style="background:#351515; border: solid 1px #995050;"
	! $Name: (''~~'required'~~'') !! Filename !! Number of Measures (''m'') !! Samples per Measure (''s'') !! Comments (optional)		! $Name: (''fixed'') !! Filename !! Number of Measures (''m'') !! Samples per Measure (''s'') !! Comments (optional)
	\|- align="left"		\|- align="left"
	\| <code>$Name:</code> \|\| <code>FS2_Amb_A01.wav</code> \|\| <code>25.0</code> \|\| <code>105840</code> \|\| <code>; * Ambience</code>		\| <code>$Name:</code> \|\| <code>FS2_Amb_A01.wav</code> \|\| <code>25.0</code> \|\| <code>105840</code> \|\| <code>; * Ambience</code>

Androgeos Exeunt: /* $Name: */ Even MORE accurate statements.

2020-07-27T06:24:00Z

$Name:: Even MORE accurate statements.

← Older revision		Revision as of 06:24, 27 July 2020
Line 64:		Line 64:
	\| 1 \|\| Ambience \|\| Normal track.<br/>Plays when nothing is happening or units are out of combat range.<br/>Loops on itself until another situation is called, but if Ambience 2 is defined in FSO builds, will usually segue to it.		\| 1 \|\| Ambience \|\| Normal track.<br/>Plays when nothing is happening or units are out of combat range.<br/>Loops on itself until another situation is called, but if Ambience 2 is defined in FSO builds, will usually segue to it.
	\|-		\|-
	\| 2 \|\| Allied Arrival during Ambience \|\| Plays when a friendly unit arrives while Ambience is playing.		\| 2 \|\| Allied Arrival during Ambience \|\| Plays when a friendly unit arrives while Ambience is playing.<br/>By default, plays on top of other audio tracks without seguing; in FSO builds, if <code>+Allied Arrival Overlay: NO</code> is added below <code>$Soundtrack Name:</code>, the currently playing track will segue into this instead.
	\|-		\|-
	\| 3 \|\| Enemy Arrival during Ambience \|\| Plays when a hostile unit arrives while Ambience is playing.		\| 3 \|\| Enemy Arrival during Ambience \|\| Plays when a hostile unit arrives while Ambience is playing.
Line 74:		Line 74:
	\| 6 \|\| Battle 3 \|\| Battle track 3.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 1		\| 6 \|\| Battle 3 \|\| Battle track 3.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 1
	\|-		\|-
	\| 7 \|\| Allied Arrival during Battle \|\| Plays when a friendly unit arrives while any Battle track is playing		\| 7 \|\| Allied Arrival during Battle \|\| Plays when a friendly unit arrives while any Battle track is playing.<br/>By default, plays on top of other audio tracks without seguing; in FSO builds, if <code>+Allied Arrival Overlay: NO</code> is added below <code>$Soundtrack Name:</code>, the currently playing track will segue into this instead.
	\|-		\|-
	\| 8 \|\| Enemy Arrival during Battle \|\| Plays when a hostile unit arrives while any Battle track is playing		\| 8 \|\| Enemy Arrival during Battle \|\| Plays when a hostile unit arrives while any Battle track is playing.
	\|-		\|-
	\| 9 \|\| Victory 1 \|\| Plays when a goal is completed.<br/>Segues into Victory 2, Ambience, or a Battle track depending on the remaining goals and hostile units remaining, and whether Victory 2 has already been called.		\| 9 \|\| Victory 1 \|\| Plays when a goal is completed.<br/>Segues into Victory 2, Ambience, or a Battle track depending on the remaining goals and hostile units remaining, and whether Victory 2 has already been called.

Androgeos Exeunt: Increased accuracy of statements.

2020-07-27T06:14:38Z

Increased accuracy of statements.

← Older revision		Revision as of 06:14, 27 July 2020
Line 32:		Line 32:

	===== +nocreate =====		===== +nocreate =====
	This flag should be added if the soundtrack is intended to completely overwrite an existing soundtrack.		This flag should be added if the soundtrack is intended to completely overwrite an existing soundtrack with the exact same name.

	===== +Cycle: FS1 =====		===== +Cycle: FS1 =====
	This cycles the ~~NRML~~ and ~~BTTL~~ tracks the FS1 way, instead of the FS2 way.		This cycles the Normal and Battle tracks the FS1 way, instead of the FS2 way.

	===== +Allied Arrival Overlay: NO =====		===== +Allied Arrival Overlay: NO =====
Line 97:		Line 97:
	\|}		\|}

	The order and situation of the lines '''cannot be changed''' and are '''required''' in order for the engine to parse the audio files in the correct situations. If there is no audio file available for any of the situations (such as Battle 3, for instance), a placeholder line denoting an empty track should still be included, ~~like so~~:		The order and situation of the lines '''cannot be changed''' and are '''required''' in order for the engine to parse the audio files in the correct situations. If there is no audio file available for any of the situations (such as Battle 3, for instance), a placeholder line denoting an empty track should still be included, such as the bolded code below:
	...		...
	$Name: FS2_Btl_A02.wav 27.8 81415 ; * Battle 2		$Name: FS2_Btl_A02.wav 27.8 81415 ; * Battle 2
Line 200:		Line 200:
	* The following flag can be added after <code>$Name:</code> in modular tables:		* The following flag can be added after <code>$Name:</code> in modular tables:
	=== +nocreate ===		=== +nocreate ===
	This flag should be added if the track is intended to completely overwrite an existing track.}}		This flag should be added if the track is intended to completely overwrite an existing track with the exact same name.
			}}

	=== $Filename: ===		=== $Filename: ===

Androgeos Exeunt: /* $Name: */ Got distracted while editing this table...

2020-07-26T04:28:37Z

$Name:: Got distracted while editing this table...

← Older revision		Revision as of 04:28, 26 July 2020
Line 92:		Line 92:
	! Order !! Situation !! Details		! Order !! Situation !! Details
	\|- align="left"		\|- align="left"
	\| 13 \|\| Ambience 2 \|\| Normal track~~—if~~ Ambience 3 is defined, usually segues into it, otherwise segues into Ambience		\| 13 \|\| Ambience 2 \|\| Normal track.<br/>Plays when nothing is happening or units are out of combat range.<br/>If Ambience 3 is defined, usually segues into it, otherwise segues into Ambience.
	\|-		\|-
	\| 14 \|\| Ambience 3 \|\| Normal track~~—usually~~ segues into Ambience		\| 14 \|\| Ambience 3 \|\| Normal track.<br/>Plays when nothing is happening or units are out of combat range.<br/>Usually segues into Ambience.
	\|}		\|}

Androgeos Exeunt: /* Soundtrack */ Added a note regarding format priority and clearly mentioned FSO-exclusive list allowances.

2020-07-26T04:26:26Z

Soundtrack: Added a note regarding format priority and clearly mentioned FSO-exclusive list allowances.

← Older revision		Revision as of 04:26, 26 July 2020
Line 16:		Line 16:
	'''Each''' individual soundtrack should start with <code>#SoundTrack Start</code> and end with <code>#SoundTrack End</code> and '''require''' the following lines in between:		'''Each''' individual soundtrack should start with <code>#SoundTrack Start</code> and end with <code>#SoundTrack End</code> and '''require''' the following lines in between:
	# <code>$Soundtrack Name:</code>		# <code>$Soundtrack Name:</code>
	# 12-14 lines, all starting with <code>$Name:</code>~~; OR~~		# One of the following:
	# 14 lines, all starting with <code>$String:</code>		::* 12 lines, all starting with <code>$Name:</code>
			{{Table3610\|
			::* 12-14 lines, all starting with <code>$Name:</code>
			::* 14 lines, all starting with <code>$String:</code>
			}}

	=== $Soundtrack Name: ===		=== $Soundtrack Name: ===
Line 58:		Line 62:
	! Order !! Situation !! Details		! Order !! Situation !! Details
	\|- align="left"		\|- align="left"
	\| 1 \|\| Ambience \|\| Normal track~~—plays~~ when nothing is happening or units are out of combat range		\| 1 \|\| Ambience \|\| Normal track.<br/>Plays when nothing is happening or units are out of combat range.<br/>Loops on itself until another situation is called, but if Ambience 2 is defined in FSO builds, will usually segue to it.
	\|-		\|-
	\| 2 \|\| Allied Arrival during Ambience \|\| Plays when a friendly unit arrives while Ambience is playing		\| 2 \|\| Allied Arrival during Ambience \|\| Plays when a friendly unit arrives while Ambience is playing.
	\|-		\|-
	\| 3 \|\| Enemy Arrival during Ambience \|\| Plays when a hostile unit arrives while Ambience is playing		\| 3 \|\| Enemy Arrival during Ambience \|\| Plays when a hostile unit arrives while Ambience is playing.
	\|-		\|-
	\| 4 \|\| Battle 1 \|\| Battle track 1~~—plays~~ when units are in combat range~~; usually~~ segues into Battle 2		\| 4 \|\| Battle 1 \|\| Battle track 1.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 2
	\|-		\|-
	\| 5 \|\| Battle 2 \|\| Battle track 2~~—plays~~ when units are in combat range~~; usually~~ segues into Battle 3		\| 5 \|\| Battle 2 \|\| Battle track 2.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 3
	\|-		\|-
	\| 6 \|\| Battle 3 \|\| Battle track 3~~—plays~~ when units are in combat range~~; usually~~ segues into Battle 1		\| 6 \|\| Battle 3 \|\| Battle track 3.<br/>Plays when units are in combat range.<br/>Usually segues into Battle 1
	\|-		\|-
	\| 7 \|\| Allied Arrival during Battle \|\| Plays when a friendly unit arrives while any Battle track is playing		\| 7 \|\| Allied Arrival during Battle \|\| Plays when a friendly unit arrives while any Battle track is playing
Line 74:		Line 78:
	\| 8 \|\| Enemy Arrival during Battle \|\| Plays when a hostile unit arrives while any Battle track is playing		\| 8 \|\| Enemy Arrival during Battle \|\| Plays when a hostile unit arrives while any Battle track is playing
	\|-		\|-
	\| 9 \|\| Victory 1 \|\| Plays when a goal is completed		\| 9 \|\| Victory 1 \|\| Plays when a goal is completed.<br/>Segues into Victory 2, Ambience, or a Battle track depending on the remaining goals and hostile units remaining, and whether Victory 2 has already been called.
	\|-		\|-
	\| 10 \|\| Victory 2 \|\| ~~Plays~~ when all goals are completed ''and'' there are absolutely no hostile units present~~; is~~ only called once		\| 10 \|\| Victory 2 \|\| Victory 1 segues into this track when all goals are completed ''and'' there are absolutely no hostile units present.<br/>Is only called once; if additional goals are validated in-mission and/or new hostile units arrive, Victory 1 will not segue into this track.
	\|-		\|-
	\| 11 \|\| Goal Failed \|\| Plays when the ~~primary~~ goals of a mission are failed~~; does~~ not ~~appear to be~~ called in-game		\| 11 \|\| Goal Failed \|\| Plays when the goals of a mission are failed.<br/>Is not usually called in-game.
	\|-		\|-
	\| 12 \|\| Player Dies \|\| Plays when the player is killed and goes to the death screen		\| 12 \|\| Player Dies \|\| Plays when the player is killed and goes to the death screen
Line 101:		Line 105:

	====Filename====		====Filename====
	The filename of the audio file must also include its file extension. FS1 and FS2 only support the playback of Waveform Audio (.wav) files; FSO supports the playback of ~~.wav~~ and OGG ~~vorbis~~ (.ogg) files.		The filename of the audio file must also include its file extension. FS1 and FS2 only support the playback of Waveform Audio (<code>.wav</code>) files.

			{{Table36\|
			FSO supports the playback of Waveform Audio and OGG Vorbis (<code>.ogg</code>) files.

			If there are two versions of the same file—one in Waveform Audio and one in OGG Vorbis format—FSO will typically attempt to play the OGG Vorbis version, even if the referenced file in <code>music.tbl</code> has a <code>.wav</code> file extension. In addition, if <code>$Name:</code> references a file that has the <code>.ogg</code> file extension, but only a Waveform Audio version of the file is available, FSO will still play the latter as if it is referenced directly in <code>music.tbl</code>.
			}}

	====Number of Measures and Samples per Measure====		====Number of Measures and Samples per Measure====

Androgeos Exeunt: /* $Soundtrack Name: */ Made the example clearer.

2020-07-26T03:04:31Z

$Soundtrack Name:: Made the example clearer.

← Older revision		Revision as of 03:04, 26 July 2020
Line 20:		Line 20:

	=== $Soundtrack Name: ===		=== $Soundtrack Name: ===
	<code>$Soundtrack Name:</code> is immediately followed by the name of the soundtrack. This primarily affects how the soundtrack is referred to in [[FRED]] as well as its variants. The name of the soundtrack can be prefixed with a number to keep listings organised, such as:		<code>$Soundtrack Name:</code> is immediately followed by the name of the soundtrack. This primarily affects how the soundtrack is referred to in [[FRED]] as well as its variants. The name of the soundtrack can be prefixed with a number to keep listings organised, such as the underlined code below:
	~~<u>~~$Soundtrack Name:~~</u>~~ <u>1: Genesis</u>		$Soundtrack Name: <u>1: Genesis</u>

	==== Flags ====		==== Flags ====

← Older revision		Revision as of 05:06, 26 November 2022
Line 261:		Line 261:
	== Related Links ==		== Related Links ==
	* [https://www.hard-light.net/forums/index.php?topic=89836.msg1787087 Music tables 301 \| Hard Light Productions Forums]		* [https://www.hard-light.net/forums/index.php?topic=89836.msg1787087 Music tables 301 \| Hard Light Productions Forums]
			* [https://web.archive.org/web/20010314181125/http://ml.warpcore.org/fdl/199911/msg00204.html Archived post about music.tbl from the FreeSpace Developer List]

	[[Category:Tables]]		[[Category:Tables]]