File:Containers sample multidim4.png

2023-05-27T05:38:04Z

Jg18:

File:Containers sample multidim3.png

2023-05-27T05:35:27Z

Jg18:

File:Containers sample multidim2.png

2023-05-27T05:31:31Z

Jg18:

2022-08-07T03:26:15Z

Jg18: Example of text replacement with containers

== Summary ==
Example of text replacement with containers

File:Containers sample replace.png

2022-08-07T03:21:57Z

Jg18: Example of Replace Container Data using a screenshot from FRED's Events Editor.

== Summary ==
Example of Replace Container Data using a screenshot from FRED's Events Editor.

Variable

2022-08-07T03:12:29Z

Jg18:

'''Variables''' (also called '''SEXP variables''') allow you to store pieces of information for later use. Normally, SEXP trees use fixed values. Consider this basic one:

is-destroyed-delay
2
GTT Spomer
send-message
#Command
High
Spomer destroyed

All these values are fixed. If you wanted Command to send a message five (not two) seconds after the Spomer is destroyed, you would need a second Event with 5 instead of 2. If, however, the "delay" value (2) were a variable, you could manipulate the delay between the Spomer's death and Command sending the message in a more convenient and flexible way in one Event. Variables are dynamic values that can be changed during the course of the mission.

==Basics==
Right-click on any argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Replace Variable'''. If your Events window is empty, create an Event.

[[Image:VariableBox.png|center|The Add Variable window]]

*'''Add Variable''' allows you to create a new variable. If you're using FreeSpace Open, your Add Variable window looks like the image above. You can add a number or a string-based variable. Number-based variables must contain numbers only, while string-based values can use letters. From a technical point of view, it's unimportant how you name your variable. Then set your variable's default value.
**In our example, let's create a number-based variable that is named "TurretsDown" and its default value is 0.
*'''Modify Variable''' allows you to change a variable that you've already created. You can modify only one variable at a time. This feature is not to be confused with the [[modify-variable]] one.
*'''Replace Variable''' replaces the currently selected SEXP argument with the variable of your choice.
**If you clicked on "0" in the example, you could change it to TurretsDown using Replace Variable --> TurretsDown. If the "0" is changed to TurretsDown (which receives a red icon), then you've been successful. Now the Event will come true if TurretsDown equals 3.

Variable values can be changed using the [[modify-variable]] SEXP, which you can find under Add Operator --> Change --> Special. A sample Event that adds 1 to a number-based variable looks like:

[[Image:VariableEvent.JPG|center]]

== Four Types of Variables ==

There are five types of variables. Hover the mouse over each variable name in the variable window to display additional information.

'''Standard variables:''' This type of variables are used in one mission only. If the player ends the mission in any way (jumping out, dying, restarting, etc.), all the standard variables will be reset to their default values. Whether the player is allowed to progress in the campaign or not is inconclusive (compare campaign-persistent variables). This is the default variable type, and requires no boxes to be checked in the variable window.

'''Network variables:''' are only relevant in a multiplayer game. Non-network variables are only ever altered on the server. This means that they can not be used in messages or scripting because all the client machines will only ever have the default value. If you need to have the value of a variable display in a message you will need to mark it as a network variable. ''

'''Save on Mission Complete:''' A type of persistent variable that will save when the player clicks Accept to go to the next mission. If the player is killed or quits during a mission, and changes made to this variable are not stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

'''Save on Mission Close:''' A type of persistent variable that will save when the player leaves the mission. If the player is killed or quits during a mission, and changes made to this variable are stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

'''Eternal:''' Eternal is a flag you can add to BOTH 'Save on Mission Complete' and 'Save on Mission Close' to tell the game to not delete that variable even if the campaign ends or a different campaign is started. It does not reset upon the end of the current campaign, or the selection of a new campaign. Thus it can be used and referred to by other campaigns.

== Variables and Messages ==
Variables can also be used in messages. To do this, use the variable's name preceded by the '$' token (for example "$killcount"), and in-game this will be replaced with the value of the variable. Input is case-sensitive. It works for both numeric and string variables.

==Example Mission==
:''Main Article: [[Variables example mission]]''

This is a mission in which the player must take down all four of the Sathanas's main beam weapons to win the mission. This is like [[Bearbaiting]], except this mission is solely made as a variables tutorial. The juggernaut will not fire at you or jump out.

==See Also==
*[[Counting with variables]]
*[[SEXP Container]]

==Links==

*[http://homepage.ntlworld.com/karajorma/FAQ/fredretail.html#variables Karajorma's FreeSpace FAQ on variables]
* Fred Zone examples for variables [http://fredzone.hard-light.net/cetanu_adv-fred-lessons.shtml] [http://fredzone.hard-light.net/cetanu_adv-fred-lessons-2.shtml]

[[Category:FRED]]

SEXP Container

2022-08-07T03:10:31Z

Jg18:

''For cargo containers, see [[Containers]].''

'''SEXP containers''' allow you to store groups of pieces of information for later use.

As opposed to a [[Variable|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.

Consequently, containers allow for handling data in much more sophisticated ways than variables.

Containers first appeared in FS2 Open 22.2.0.

==Overview==

Get started with containers using FRED's "Add/Modify Container" dialog, which you can reach from the right-click menu:

The new [[#SEXPs and Replace Container Name|Replace Container Name]] and [[#Replace Container Data|Replace Container Data]] submenus are explained below.

Containers come in two types:
* '''List container''' - an ordered sequence of values, sort of a cross between Python lists and deques
* '''Map container''' - pairs of keys associated with data, like Lua tables or Python dictionaries

Just as variables have a type of either string or number, a container's data and a map container's keys have a type of either string or number.

==Features==

===Replace Container Data===

Similar to how Replace Variable allows you to access data stored in variables, Replace Container Data allows you to access data stored in containers.

Use one of the following list modifiers to access data in list containers:
* Get_First
* Remove_First
* Get_Last
* Remove_Last
* Get_Random
* Remove_Random
* At

The list modifier options appear in the Replace Data submenu in FRED.

The At list modifier allows you to access data at a specific position in the list. Specify the index using Number under the Add Data submenu. The first item is at index 0.

The Get_First, Get_Last, and At list modifiers just retrieve the data, but the Remove_First and Remove_Last modifiers both retrieve the data and remove it from the container.

To access map container data, specify the key using Edit Data.

The container modifier can also be the value of a variable (use Replace Variable), the "special argument" if relevant (use Replace Data), or even a nested usage of Replace Container Data.

====Restrictions on Replace Container Data usage====

You can't use Replace Container Data in the "argument list" of special argument SEXPs, such as any-of, but you can use it in the "condition" or "actions" parts of those SEXPs. This applies for all special argument SEXPs, not just the ones that now take containers as arguments (see [[#Special argument list options|Special argument list options]] below).

===Text replacement===

Similar to text replacement for variables with $VariableName$, you can access container data in the text used in
* Command briefings
* Briefings
* Debriefings
* Messages
* Scripting
* Subtitles
* Debug SEXP

For list containers, use the format '''&ListContainerName&ListModifier&''', where '''ListModifier''' is one of the modifiers listed above. To access the first data item in the list, use the modifier '''At0'''.

For map containers, use the format '''&MapContainerName&MapKey&'''.

Container data and map keys ''are'' case-sensitive, but container names and list modifiers ''are not''.

===SEXPs and Replace Container Name===

You can access the Status and Change SEXPs from the new Containers subcategory in the Status and Change categories for Replace/Insert/Add Operator.

====Status SEXPs====
* is-container-empty
* get-container-size
* list-has-data
* list-data-index
* map-has-key
* map-has-data-item

====Change SEXPs====
* add-to-list
* remove-from-list
* add-to-map
* remove-from-map
* get-map-keys
* clear-container
* copy-container
* apply-container-filter

====Conditional SEXPs====
* for-container-data
* for-map-container-keys

FRED's built-in SEXP help explains how they work.

To specify the SEXP arguments that are container names, use the Replace Container Name submenu from FRED's right-click menu. You can specify those arguments using Replace Variable or Replace Container Data, too.

===Persistence===

Containers support the same persistence options that variables do, except for "Network" (Issue #3708).

===Multidimensionality===

For both text replacement and Replace Container Data, you can chain accesses to container data. The data stored in the first container should be formatted as &ContainerName&.

Unlike the other containers features, there is no equivalent for variables.

====Multidimensionality example 1====

In the above screen shots, if the random-of in the first screen shot happens to select "Taurus" as the special argument, then the ship "Taurus" will send the message "Ah! A plot is revealed!".

====Multidimensionality example 2====

If I have two map containers, Map1 and Map2, and I want to display the data associated with the key "Key 1" from one of the two map containers, selected at random, I'd have a list container called Maps whose entries are '''&Map1&''' and '''&Map2&'''.

The expression to use in text replacement is '''&Maps&Get_Random&Key 1&'''.

To do the same thing in FRED's SEXP tree, I'd first use Replace Container Data with Maps using the list modifier Get_Random, and then I'd add "Key 1" using the String option under the Add Data submenu.

===Special argument list options===

For some SEXPs that are used with when-argument, you can use a mix of strings, list containers of string data, and/or map containers of string keys (map data can be any type) as arguments.

The string data/keys will then be included among the options for the special argument in that SEXP.

When the containers' contents change, the special argument options they provide will change as well.

These SEXPs are supported:
* any-of
* every-of
* number-of
* first-of
* random-multiple-of

Use the "Replace Container Name" submenu to include containers as arguments.

====Restrictions on usage in special argument list====

# You can't use validate-argument or invalidate-argument with containers. However, validate-all-arguments and invalidate-all-arguments will apply to container arguments as well.
# You also can't use validate-argument or invalidate-argument with arguments retrieved from containers.
# You can't use change SEXPs or Remove_* list modifiers on a container as part of a when-argument SEXP if the container is one of the arguments. However, it's OK to use the container with Get_*/At list modifiers or as an argument to any status SEXP or to a change SEXP that doesn't modify it, such as the map container in get-map-keys. It's also OK to modify containers that aren't among the arguments.

==Remaining Features==

# Network persistence ([https://github.com/scp-fs2open/fs2open.github.com/issues/3708 Issue #3708])
# Add/Modify Container dialog for qtFRED ([https://github.com/scp-fs2open/fs2open.github.com/issues/3818 Issue #3818]) but qtFRED's SEXP tree should fully support containers.

[[Category:FRED]]

Containers

2022-08-07T03:06:51Z

Jg18: add link to SEXP Container page

''For the FRED feature, see [[SEXP Container]].''

'''Cargo containers''' are "ships" in [[FS1]] and [[FS2]] that are used to carry supplies. They are transported by various freighters, usually matching one type of container to one type of freighter, (with the exception of the [[GTFr Poseidon]]) though most freighters can carry any container without issue.

More information about the [[Great_War-era_craft|FS1 containers]] and [[FreeSpace_2-era_craft|FS2 containers]] can be found in their respective ship databases.

Below is a quick image reference to all FS1 and FS2 cargo containers.

==Terran Cargo Containers==

===TC-TRI===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Tctri-old.jpg|center|TC-TRI]]
|-
| style="width:200px;text-align: right"|[[TC-TRI]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |300
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 249 m
|}

===TC 2===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Tc2_Tsc2-old.jpg|center|TC 2]]
|-
| style="width:200px;text-align: right"|[[TC 2]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |300
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 35 m
|}

===TSC 2===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Tc2_Tsc2-old.jpg|center|TSC 2]]
|-
| style="width:200px;text-align: right"|[[TSC 2]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |600
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 35 m
|}

===TAC 1===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Tac1-old.jpg|center|TAC 1]]
|-
| style="width:200px;text-align: right"|[[TAC 1]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |1200
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 58 m
|}

===TTC 1===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Ttc1-old.jpg|center|TTC 1]]
|-
| style="width:200px;text-align: right"|[[TTC 1]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |800
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 26 m
|}

==Vasudan Cargo Containers==

===VC 3===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Vc_3_320x240.jpg|center|VC 3]]
|-
| style="width:200px;text-align: right"|[[VC 3]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |300
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 12 m
|}

===VAC 4===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Vac4-old.jpg|center|VAC 4]]
|-
| style="width:200px;text-align: right"|[[VAC 4]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |1200
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 25 m
|}

===VAC 5===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Vac5-old.jpg|center|VAC 5]]
|-
| style="width:200px;text-align: right"|[[VAC 5]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |1200
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 53 m
|}

==Shivan Cargo Containers==

===SAC 3===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Sac3-old.jpg|center|SAC 3]]
|-
| style="width:200px;text-align: right"|[[SAC 3]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |300
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 243 m
|}

===SC 5===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Sc5-old.jpg|center|SC 5]]
|-
| style="width:200px;text-align: right"|[[SC 5]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |300
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 20 m
|}

===SAC 2===
{|
|-
| style="width:400px;background: #000000" colspan=2 |[[Image:Sac2-old.jpg|center|SAC 2]]
|-
| style="width:200px;text-align: right"|[[SAC 2]]
|-
| style="width:200px" |[[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| style="width:200px" |1200
|-
| [[Technical_Terms_and_Definitions#Length|Length]]
| 33 m
|}

[[Category:Ship]]

SEXP Container

2022-08-07T03:05:37Z

Jg18:

''For cargo containers, see [[Containers]].''

'''SEXP containers''' allow you to store groups of pieces of information for later use.

As opposed to a [[Variable|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.

Consequently, containers allow for handling data in much more sophisticated ways than variables.

Containers first appeared in FS2 Open 22.2.0.

==Overview==

Get started with containers using FRED's "Add/Modify Container" dialog, which you can reach from the right-click menu:

The new Replace Container Name/Data submenus are explained below.

Containers come in two types:
* '''List container''' - an ordered sequence of values, sort of a cross between Python lists and deques
* '''Map container''' - pairs of keys associated with data, like Lua tables or Python dictionaries

Just as variables have a type of either string or number, a container's data and a map container's keys have a type of either string or number.

==Features==

===Replace Container Data===

Similar to how Replace Variable allows you to access data stored in variables, Replace Container Data allows you to access data stored in containers.

Use one of the following list modifiers to access data in list containers:
* Get_First
* Remove_First
* Get_Last
* Remove_Last
* Get_Random
* Remove_Random
* At

The list modifier options appear in the Replace Data submenu in FRED.

The At list modifier allows you to access data at a specific position in the list. Specify the index using Number under the Add Data submenu. The first item is at index 0.

The Get_First, Get_Last, and At list modifiers just retrieve the data, but the Remove_First and Remove_Last modifiers both retrieve the data and remove it from the container.

To access map container data, specify the key using Edit Data.

The container modifier can also be the value of a variable (use Replace Variable), the "special argument" if relevant (use Replace Data), or even a nested usage of Replace Container Data.

====Restrictions on Replace Container Data usage====

You can't use Replace Container Data in the "argument list" of special argument SEXPs, such as any-of, but you can use it in the "condition" or "actions" parts of those SEXPs. This applies for all special argument SEXPs, not just the ones that now take containers as arguments (see [[#Special argument list options|Special argument list options]] below).

===Text replacement===

Similar to text replacement for variables with $VariableName$, you can access container data in the text used in
* Command briefings
* Briefings
* Debriefings
* Messages
* Scripting
* Subtitles
* Debug SEXP

For list containers, use the format '''&ListContainerName&ListModifier&''', where '''ListModifier''' is one of the modifiers listed above. To access the first data item in the list, use the modifier '''At0'''.

For map containers, use the format '''&MapContainerName&MapKey&'''.

Container data and map keys ''are'' case-sensitive, but container names and list modifiers ''are not''.

===SEXPs and Replace Container Name===

You can access the Status and Change SEXPs from the new Containers subcategory in the Status and Change categories for Replace/Insert/Add Operator.

====Status SEXPs====
* is-container-empty
* get-container-size
* list-has-data
* list-data-index
* map-has-key
* map-has-data-item

====Change SEXPs====
* add-to-list
* remove-from-list
* add-to-map
* remove-from-map
* get-map-keys
* clear-container
* copy-container
* apply-container-filter

====Conditional SEXPs====
* for-container-data
* for-map-container-keys

FRED's built-in SEXP help explains how they work.

To specify the SEXP arguments that are container names, use the Replace Container Name submenu from FRED's right-click menu. You can specify those arguments using Replace Variable or Replace Container Data, too.

===Persistence===

Containers support the same persistence options that variables do, except for "Network" (Issue #3708).

===Multidimensionality===

For both text replacement and Replace Container Data, you can chain accesses to container data. The data stored in the first container should be formatted as &ContainerName&.

Unlike the other containers features, there is no equivalent for variables.

====Multidimensionality example 1====

In the above screen shots, if the random-of in the first screen shot happens to select "Taurus" as the special argument, then the ship "Taurus" will send the message "Ah! A plot is revealed!".

====Multidimensionality example 2====

If I have two map containers, Map1 and Map2, and I want to display the data associated with the key "Key 1" from one of the two map containers, selected at random, I'd have a list container called Maps whose entries are '''&Map1&''' and '''&Map2&'''.

The expression to use in text replacement is '''&Maps&Get_Random&Key 1&'''.

To do the same thing in FRED's SEXP tree, I'd first use Replace Container Data with Maps using the list modifier Get_Random, and then I'd add "Key 1" using the String option under the Add Data submenu.

===Special argument list options===

For some SEXPs that are used with when-argument, you can use a mix of strings, list containers of string data, and/or map containers of string keys (map data can be any type) as arguments.

The string data/keys will then be included among the options for the special argument in that SEXP.

When the containers' contents change, the special argument options they provide will change as well.

These SEXPs are supported:
* any-of
* every-of
* number-of
* first-of
* random-multiple-of

Use the "Replace Container Name" submenu to include containers as arguments.

====Restrictions on usage in special argument list====

# You can't use validate-argument or invalidate-argument with containers. However, validate-all-arguments and invalidate-all-arguments will apply to container arguments as well.
# You also can't use validate-argument or invalidate-argument with arguments retrieved from containers.
# You can't use change SEXPs or Remove_* list modifiers on a container as part of a when-argument SEXP if the container is one of the arguments. However, it's OK to use the container with Get_*/At list modifiers or as an argument to any status SEXP or to a change SEXP that doesn't modify it, such as the map container in get-map-keys. It's also OK to modify containers that aren't among the arguments.

==Remaining Features==

# Network persistence ([https://github.com/scp-fs2open/fs2open.github.com/issues/3708 Issue #3708])
# Add/Modify Container dialog for qtFRED ([https://github.com/scp-fs2open/fs2open.github.com/issues/3818 Issue #3818]) but qtFRED's SEXP tree should fully support containers.

[[Category:FRED]]

SEXP Container

2022-08-07T03:03:10Z

Jg18: add FRED category

''For cargo containers, see [[Containers]].''

'''SEXP containers''' allow you to store groups of pieces of information for later use.

As opposed to a [[Variable|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.

Consequently, containers allow for handling data in much more sophisticated ways than variables.

==Overview==

Get started with containers using FRED's "Add/Modify Container" dialog, which you can reach from the right-click menu:

The new Replace Container Name/Data submenus are explained below.

Containers come in two types:
* '''List container''' - an ordered sequence of values, sort of a cross between Python lists and deques
* '''Map container''' - pairs of keys associated with data, like Lua tables or Python dictionaries

Just as variables have a type of either string or number, a container's data and a map container's keys have a type of either string or number.

==Features==

===Replace Container Data===

Similar to how Replace Variable allows you to access data stored in variables, Replace Container Data allows you to access data stored in containers.

Use one of the following list modifiers to access data in list containers:
* Get_First
* Remove_First
* Get_Last
* Remove_Last
* Get_Random
* Remove_Random
* At

The list modifier options appear in the Replace Data submenu in FRED.

The At list modifier allows you to access data at a specific position in the list. Specify the index using Number under the Add Data submenu. The first item is at index 0.

The Get_First, Get_Last, and At list modifiers just retrieve the data, but the Remove_First and Remove_Last modifiers both retrieve the data and remove it from the container.

To access map container data, specify the key using Edit Data.

The container modifier can also be the value of a variable (use Replace Variable), the "special argument" if relevant (use Replace Data), or even a nested usage of Replace Container Data.

====Restrictions on Replace Container Data usage====

You can't use Replace Container Data in the "argument list" of special argument SEXPs, such as any-of, but you can use it in the "condition" or "actions" parts of those SEXPs. This applies for all special argument SEXPs, not just the ones that now take containers as arguments (see [[#Special argument list options|Special argument list options]] below).

===Text replacement===

Similar to text replacement for variables with $VariableName$, you can access container data in the text used in
* Command briefings
* Briefings
* Debriefings
* Messages
* Scripting
* Subtitles
* Debug SEXP

For list containers, use the format '''&ListContainerName&ListModifier&''', where '''ListModifier''' is one of the modifiers listed above. To access the first data item in the list, use the modifier '''At0'''.

For map containers, use the format '''&MapContainerName&MapKey&'''.

Container data and map keys ''are'' case-sensitive, but container names and list modifiers ''are not''.

===SEXPs and Replace Container Name===

You can access the Status and Change SEXPs from the new Containers subcategory in the Status and Change categories for Replace/Insert/Add Operator.

====Status SEXPs====
* is-container-empty
* get-container-size
* list-has-data
* list-data-index
* map-has-key
* map-has-data-item

====Change SEXPs====
* add-to-list
* remove-from-list
* add-to-map
* remove-from-map
* get-map-keys
* clear-container
* copy-container
* apply-container-filter

====Conditional SEXPs====
* for-container-data
* for-map-container-keys

FRED's built-in SEXP help explains how they work.

To specify the SEXP arguments that are container names, use the Replace Container Name submenu from FRED's right-click menu. You can specify those arguments using Replace Variable or Replace Container Data, too.

===Persistence===

Containers support the same persistence options that variables do, except for "Network" (Issue #3708).

===Multidimensionality===

For both text replacement and Replace Container Data, you can chain accesses to container data. The data stored in the first container should be formatted as &ContainerName&.

Unlike the other containers features, there is no equivalent for variables.

====Multidimensionality example 1====

In the above screen shots, if the random-of in the first screen shot happens to select "Taurus" as the special argument, then the ship "Taurus" will send the message "Ah! A plot is revealed!".

====Multidimensionality example 2====

If I have two map containers, Map1 and Map2, and I want to display the data associated with the key "Key 1" from one of the two map containers, selected at random, I'd have a list container called Maps whose entries are '''&Map1&''' and '''&Map2&'''.

The expression to use in text replacement is '''&Maps&Get_Random&Key 1&'''.

To do the same thing in FRED's SEXP tree, I'd first use Replace Container Data with Maps using the list modifier Get_Random, and then I'd add "Key 1" using the String option under the Add Data submenu.

===Special argument list options===

For some SEXPs that are used with when-argument, you can use a mix of strings, list containers of string data, and/or map containers of string keys (map data can be any type) as arguments.

The string data/keys will then be included among the options for the special argument in that SEXP.

When the containers' contents change, the special argument options they provide will change as well.

These SEXPs are supported:
* any-of
* every-of
* number-of
* first-of
* random-multiple-of

Use the "Replace Container Name" submenu to include containers as arguments.

====Restrictions on usage in special argument list====

# You can't use validate-argument or invalidate-argument with containers. However, validate-all-arguments and invalidate-all-arguments will apply to container arguments as well.
# You also can't use validate-argument or invalidate-argument with arguments retrieved from containers.
# You can't use change SEXPs or Remove_* list modifiers on a container as part of a when-argument SEXP if the container is one of the arguments. However, it's OK to use the container with Get_*/At list modifiers or as an argument to any status SEXP or to a change SEXP that doesn't modify it, such as the map container in get-map-keys. It's also OK to modify containers that aren't among the arguments.

==Remaining Features==

# Network persistence ([https://github.com/scp-fs2open/fs2open.github.com/issues/3708 Issue #3708])
# Add/Modify Container dialog for qtFRED ([https://github.com/scp-fs2open/fs2open.github.com/issues/3818 Issue #3818]) but qtFRED's SEXP tree should fully support containers.

[[Category:FRED]]

Variable

2022-08-07T03:02:43Z

Jg18:

'''Variables''' (also called '''SEXP variables''') allow you to store pieces of information for later use. Normally, SEXP trees use fixed values. Consider this basic one:

is-destroyed-delay
2
GTT Spomer
send-message
#Command
High
Spomer destroyed

All these values are fixed. If you wanted Command to send a message five (not two) seconds after the Spomer is destroyed, you would need a second Event with 5 instead of 2. If, however, the "delay" value (2) were a variable, you could manipulate the delay between the Spomer's death and Command sending the message in a more convenient and flexible way in one Event. Variables are dynamic values that can be changed during the course of the mission.

==Basics==
Right-click on any argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Replace Variable'''. If your Events window is empty, create an Event.

[[Image:VariableBox.png|center|The Add Variable window]]

*'''Add Variable''' allows you to create a new variable. If you're using FreeSpace Open, your Add Variable window looks like the image above. You can add a number or a string-based variable. Number-based variables must contain numbers only, while string-based values can use letters. From a technical point of view, it's unimportant how you name your variable. Then set your variable's default value.
**In our example, let's create a number-based variable that is named "TurretsDown" and its default value is 0.
*'''Modify Variable''' allows you to change a variable that you've already created. You can modify only one variable at a time. This feature is not to be confused with the [[modify-variable]] one.
*'''Replace Variable''' replaces the currently selected SEXP argument with the variable of your choice.
**If you clicked on "0" in the example, you could change it to TurretsDown using Replace Variable --> TurretsDown. If the "0" is changed to TurretsDown (which receives a red icon), then you've been successful. Now the Event will come true if TurretsDown equals 3.

Variable values can be changed using the [[modify-variable]] SEXP, which you can find under Add Operator --> Change --> Special. A sample Event that adds 1 to a number-based variable looks like:

[[Image:VariableEvent.JPG|center]]

== Four Types of Variables ==

There are five types of variables. Hover the mouse over each variable name in the variable window to display additional information.

'''Standard variables:''' This type of variables are used in one mission only. If the player ends the mission in any way (jumping out, dying, restarting, etc.), all the standard variables will be reset to their default values. Whether the player is allowed to progress in the campaign or not is inconclusive (compare campaign-persistent variables). This is the default variable type, and requires no boxes to be checked in the variable window.

'''Network variables:''' are only relevant in a multiplayer game. Non-network variables are only ever altered on the server. This means that they can not be used in messages or scripting because all the client machines will only ever have the default value. If you need to have the value of a variable display in a message you will need to mark it as a network variable. ''

'''Save on Mission Complete:''' A type of persistent variable that will save when the player clicks Accept to go to the next mission. If the player is killed or quits during a mission, and changes made to this variable are not stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

'''Save on Mission Close:''' A type of persistent variable that will save when the player leaves the mission. If the player is killed or quits during a mission, and changes made to this variable are stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

'''Eternal:''' Eternal is a flag you can add to BOTH 'Save on Mission Complete' and 'Save on Mission Close' to tell the game to not delete that variable even if the campaign ends or a different campaign is started. It does not reset upon the end of the current campaign, or the selection of a new campaign. Thus it can be used and referred to by other campaigns.

== Variables and Messages ==
Variables can also be used in messages. To do this, use the variable's name preceded by the '$' token (for example "$killcount"), and in-game this will be replaced with the value of the variable. Input is case-sensitive. It works for both numeric and string variables.

==Example Mission==
:''Main Article: [[Variables example mission]]''

This is a mission in which the player must take down all four of the Sathanas's main beam weapons to win the mission. This is like [[Bearbaiting]], except this mission is solely made as a variables tutorial. The juggernaut will not fire at you or jump out.

==See Also==
*[[Counting with variables]]

==See also==

* [[SEXP Container]]

==Links==

*[http://homepage.ntlworld.com/karajorma/FAQ/fredretail.html#variables Karajorma's FreeSpace FAQ on variables]
* Fred Zone examples for variables [http://fredzone.hard-light.net/cetanu_adv-fred-lessons.shtml] [http://fredzone.hard-light.net/cetanu_adv-fred-lessons-2.shtml]

[[Category:FRED]]

SEXP Container

2022-08-07T02:59:35Z

Jg18: First draft, no images yet

''For cargo containers, see [[Containers]].''

'''SEXP containers''' allow you to store groups of pieces of information for later use.

As opposed to a [[Variable|SEXP variable]], which stores only one value, a SEXP container stores a collection of values.

Consequently, containers allow for handling data in much more sophisticated ways than variables.

==Overview==

Get started with containers using FRED's "Add/Modify Container" dialog, which you can reach from the right-click menu:

The new Replace Container Name/Data submenus are explained below.

Containers come in two types:
* '''List container''' - an ordered sequence of values, sort of a cross between Python lists and deques
* '''Map container''' - pairs of keys associated with data, like Lua tables or Python dictionaries

Just as variables have a type of either string or number, a container's data and a map container's keys have a type of either string or number.

==Features==

===Replace Container Data===

Similar to how Replace Variable allows you to access data stored in variables, Replace Container Data allows you to access data stored in containers.

Use one of the following list modifiers to access data in list containers:
* Get_First
* Remove_First
* Get_Last
* Remove_Last
* Get_Random
* Remove_Random
* At

The list modifier options appear in the Replace Data submenu in FRED.

The At list modifier allows you to access data at a specific position in the list. Specify the index using Number under the Add Data submenu. The first item is at index 0.

The Get_First, Get_Last, and At list modifiers just retrieve the data, but the Remove_First and Remove_Last modifiers both retrieve the data and remove it from the container.

To access map container data, specify the key using Edit Data.

The container modifier can also be the value of a variable (use Replace Variable), the "special argument" if relevant (use Replace Data), or even a nested usage of Replace Container Data.

====Restrictions on Replace Container Data usage====

You can't use Replace Container Data in the "argument list" of special argument SEXPs, such as any-of, but you can use it in the "condition" or "actions" parts of those SEXPs. This applies for all special argument SEXPs, not just the ones that now take containers as arguments (see [[#Special argument list options|Special argument list options]] below).

===Text replacement===

Similar to text replacement for variables with $VariableName$, you can access container data in the text used in
* Command briefings
* Briefings
* Debriefings
* Messages
* Scripting
* Subtitles
* Debug SEXP

For list containers, use the format '''&ListContainerName&ListModifier&''', where '''ListModifier''' is one of the modifiers listed above. To access the first data item in the list, use the modifier '''At0'''.

For map containers, use the format '''&MapContainerName&MapKey&'''.

Container data and map keys ''are'' case-sensitive, but container names and list modifiers ''are not''.

===SEXPs and Replace Container Name===

You can access the Status and Change SEXPs from the new Containers subcategory in the Status and Change categories for Replace/Insert/Add Operator.

====Status SEXPs====
* is-container-empty
* get-container-size
* list-has-data
* list-data-index
* map-has-key
* map-has-data-item

====Change SEXPs====
* add-to-list
* remove-from-list
* add-to-map
* remove-from-map
* get-map-keys
* clear-container
* copy-container
* apply-container-filter

====Conditional SEXPs====
* for-container-data
* for-map-container-keys

FRED's built-in SEXP help explains how they work.

To specify the SEXP arguments that are container names, use the Replace Container Name submenu from FRED's right-click menu. You can specify those arguments using Replace Variable or Replace Container Data, too.

===Persistence===

Containers support the same persistence options that variables do, except for "Network" (Issue #3708).

===Multidimensionality===

For both text replacement and Replace Container Data, you can chain accesses to container data. The data stored in the first container should be formatted as &ContainerName&.

Unlike the other containers features, there is no equivalent for variables.

====Multidimensionality example 1====

In the above screen shots, if the random-of in the first screen shot happens to select "Taurus" as the special argument, then the ship "Taurus" will send the message "Ah! A plot is revealed!".

====Multidimensionality example 2====

If I have two map containers, Map1 and Map2, and I want to display the data associated with the key "Key 1" from one of the two map containers, selected at random, I'd have a list container called Maps whose entries are '''&Map1&''' and '''&Map2&'''.

The expression to use in text replacement is '''&Maps&Get_Random&Key 1&'''.

To do the same thing in FRED's SEXP tree, I'd first use Replace Container Data with Maps using the list modifier Get_Random, and then I'd add "Key 1" using the String option under the Add Data submenu.

===Special argument list options===

For some SEXPs that are used with when-argument, you can use a mix of strings, list containers of string data, and/or map containers of string keys (map data can be any type) as arguments.

The string data/keys will then be included among the options for the special argument in that SEXP.

When the containers' contents change, the special argument options they provide will change as well.

These SEXPs are supported:
* any-of
* every-of
* number-of
* first-of
* random-multiple-of

Use the "Replace Container Name" submenu to include containers as arguments.

====Restrictions on usage in special argument list====

# You can't use validate-argument or invalidate-argument with containers. However, validate-all-arguments and invalidate-all-arguments will apply to container arguments as well.
# You also can't use validate-argument or invalidate-argument with arguments retrieved from containers.
# You can't use change SEXPs or Remove_* list modifiers on a container as part of a when-argument SEXP if the container is one of the arguments. However, it's OK to use the container with Get_*/At list modifiers or as an argument to any status SEXP or to a change SEXP that doesn't modify it, such as the map container in get-map-keys. It's also OK to modify containers that aren't among the arguments.

==Remaining Features==

# Network persistence ([https://github.com/scp-fs2open/fs2open.github.com/issues/3708 Issue #3708])
# Add/Modify Container dialog for qtFRED ([https://github.com/scp-fs2open/fs2open.github.com/issues/3818 Issue #3818]) but qtFRED's SEXP tree should fully support containers.

SEXP Containers

2022-08-07T02:04:20Z

Jg18: Redirected page to SEXP Container

#REDIRECT [[SEXP Container]]

SEXP Variable

2022-08-07T02:00:52Z

Jg18: Redirected page to Variable

#REDIRECT [[Variable]]

Variable

2022-08-07T02:00:29Z

Jg18:

'''Variables''' (also called '''SEXP variables''') allow you to store pieces of information for later use. Normally, SEXP trees use fix values. Consider this basic one:

is-destroyed-delay
2
GTT Spomer
send-message
#Command
High
Spomer destroyed

All these values are fixed. If you wanted Command to send a message five (not two) seconds after the Spomer is destroyed, you would need a second Event with 5 instead of 2. If, however, the "delay" value (2) were a variable, you could manipulate the delay between the Spomer's death and Command sending the message in a more convenient and flexible way in one Event. Variables are dynamic values that can be changed during the course of the mission.

==Basics==
Right-click on any argument in the Events list and look at the three options at the bottom of the menu, '''Add Variable''', '''Modify Variable''', and '''Replace Variable'''. If your Events window is empty, create an Event.

[[Image:VariableBox.png|center|The Add Variable window]]

*'''Add Variable''' allows you to create a new variable. If you're using FreeSpace Open, your Add Variable window looks like the image above. You can add a number or a string-based variable. Number-based variables must contain numbers only, while string-based values can use letters. From a technical point of view, it's unimportant how you name your variable. Then set your variable's default value.
**In our example, let's create a number-based variable that is named "TurretsDown" and its default value is 0.
*'''Modify Variable''' allows you to change a variable that you've already created. You can modify only one variable at a time. This feature is not to be confused with the [[modify-variable]] one.
*'''Replace Variable''' replaces the currently selected SEXP argument with the variable of your choice.
**If you clicked on "0" in the example, you could change it to TurretsDown using Replace Variable --> TurretsDown. If the "0" is changed to TurretsDown (which receives a red icon), then you've been successful. Now the Event will come true if TurretsDown equals 3.

Variable values can be changed using the [[modify-variable]] SEXP, which you can find under Add Operator --> Change --> Special. A sample Event that adds 1 to a number-based variable looks like:

[[Image:VariableEvent.JPG|center]]

== Four Types of Variables ==

There are five types of variables. Hover the mouse over each variable name in the variable window to display additional information.

'''Standard variables:''' This type of variables are used in one mission only. If the player ends the mission in any way (jumping out, dying, restarting, etc.), all the standard variables will be reset to their default values. Whether the player is allowed to progress in the campaign or not is inconclusive (compare campaign-persistent variables). This is the default variable type, and requires no boxes to be checked in the variable window.

'''Network variables:''' are only relevant in a multiplayer game. Non-network variables are only ever altered on the server. This means that they can not be used in messages or scripting because all the client machines will only ever have the default value. If you need to have the value of a variable display in a message you will need to mark it as a network variable. ''

'''Save on Mission Complete:''' A type of persistent variable that will save when the player clicks Accept to go to the next mission. If the player is killed or quits during a mission, and changes made to this variable are not stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

'''Save on Mission Close:''' A type of persistent variable that will save when the player leaves the mission. If the player is killed or quits during a mission, and changes made to this variable are stored. They are reset upon the reset of the current campaign, or the selection of a new campaign.

'''Eternal:''' Eternal is a flag you can add to BOTH 'Save on Mission Complete' and 'Save on Mission Close' to tell the game to not delete that variable even if the campaign ends or a different campaign is started. It does not reset upon the end of the current campaign, or the selection of a new campaign. Thus it can be used and referred to by other campaigns.

== Variables and Messages ==
Variables can also be used in messages. To do this, use the variable's name preceded by the '$' token (for example "$killcount"), and in-game this will be replaced with the value of the variable. Input is case-sensitive. It works for both numeric and string variables.

==Example Mission==
:''Main Article: [[Variables example mission]]''

This is a mission in which the player must take down all four of the Sathanas's main beam weapons to win the mission. This is like [[Bearbaiting]], except this mission is solely made as a variables tutorial. The juggernaut will not fire at you or jump out.

==See Also==
*[[Counting with variables]]

==Links==

*[http://homepage.ntlworld.com/karajorma/FAQ/fredretail.html#variables Karajorma's FreeSpace FAQ on variables]
* Fred Zone examples for variables [http://fredzone.hard-light.net/cetanu_adv-fred-lessons.shtml] [http://fredzone.hard-light.net/cetanu_adv-fred-lessons-2.shtml]

[[Category:FRED]]

Enhanced sound

2015-06-17T23:34:01Z

Jg18: Added link to OS X OpenAL Soft test builds

{{Note|Enhanced sound requires the [http://kcat.strangesoft.net/openal.html OpenAL Soft] driver. See [[#How to get OpenAL Soft|How to get OpenAL Soft]] below.}}

Enhanced sound was merged into master on June 1, 2015, as of Git commit d7f54dd.

Enhanced sound adds
*Support for 128 audio channels instead of 32
*Support for more control over how the game prioritizes sounds in a mission

Enhanced sound is enabled by default, but it's disabled if you are not using [http://kcat.strangesoft.net/openal.html OpenAL Soft]. See [[#How to get OpenAL Soft|How to get OpenAL Soft]] below.

You can also manually disable enhanced sound with the "Disable enhanced sound" launcher flag under the "Audio" flags.

==How to get OpenAL Soft==
===Windows===
#First, you need to get the OpenAL32.dll file. You can download version 1.16.0 [http://www.mediafire.com/download/csdkp5psozmq2b1/OpenAL32.dll here].
#Alternatively, to get OpenAL32.dll from its original source:
##Download from the [http://kcat.strangesoft.net/openal.html#download OpenAL Soft site] the file whose name ends with "-bin.zip", such as openal-soft-1.16.0-bin.zip.
##Open the .zip file and rename soft_oal.dll found in the bin\Win32\ folder to OpenAL32.dll.
#Once you have OpenAL32.dll:
#Copy it to your FreeSpace 2 or TC folder.
#Make sure to put a copy of OpenAL32.dll in both your FreeSpace 2 folder and the root folders of any TCs you have.

===Linux===
Linux uses OpenAL Soft, so you don't need to do anything.

However, you may wish to build from source either the most recent stable release from the [http://kcat.strangesoft.net/openal.html#download OpenAL Soft site] or even the latest commit from their Git repository.

===OS X===
See [http://www.hard-light.net/forums/index.php?topic=89919.0 this thread] for OS X builds that use OpenAL Soft.

==For modders==
===Overview===
Enhanced sound provides control through two values that you can set through extensions of sounds.tbl:
*'''Priority''': how important the sound is
*'''Limit''': how many instances of the sound can be playing at hte same time

The engine has hardcoded default priorities and limits, as described [[#More on default prioritiies/limits|below]].

You can set custom values for priorities limits using a .tbm file extending sounds.tbl. The [[Sounds.tbl]] page has details on how to specify custom [[Sounds.tbl#+Priority:|priorities]] and [[Sounds.tbl#+Limit:|limits]].

{{Warning|If you create a TC and want to use enhanced sound, then you '''MUST''' set custom priorities/limits for your TC's gameplay sounds. Otherwise the game may sound strange, because the game will use the default values for FS2 retail.}}

{{Note|If you create an FS2 mod that adds new gameplay sounds, then it is '''strongly''' recommended that you specify priorities/limits for those sounds.
}}

===More on default prioritiies/limits===
The FSO engine has hardcoded default priorities limits for the 192 gameplay sound entries in the FS2 retail sounds.tbl. You can see the current list in the source code's [https://github.com/scp-fs2open/fs2open.github.com/blob/master/code/gamesnd/gamesnd.cpp code\gamesnd\gamesnd.cpp] file.
Look for the line starting with
<pre>
static EnhancedSoundData Default_sound_priorities[NUM_RETAIL_GAMEPLAY_SOUNDS] =
</pre>

Sounds outside this range are assigned a generic default priority of Medium-High and limit 1.

===Tips on selecting priorities/limits===

The first answer in [http://gamedev.stackexchange.com/questions/2253/audio-design-and-xaudio2-performance-issues this thread] has some details:

"The methods to prioritise [sounds] can include :

"a) Volume - the lowest being the least important.
[''FSO already takes volume into account when deciding whether to replace a currently playing sound.'']

"b) Priority - a value you set yourself based on the importance of the sound and the likely hood that the user will notice the sound dropping out. Background music, for example, should be set to never be dropped. A random cricket sound for ambience should be high on the list.

"c) Grouping [or ''limit''] - If you have gunshot sounds for example, once they have hit a hard limit (say 15) you would stop adding new gunshot sounds as they wouldn't add to the overall mix.
[''Grouping/limits is also needed to prevent clipping, which is why in FSO, the warp-in sound has a low limit of 2. The super-loud warp-ins were occurring because this limit wasn't being enforced, meaning there was no limit at all.'']"

Enhanced sound

2015-06-03T22:34:38Z

Jg18: First draft of enhanced sound page

{{Note|Enhanced sound requires the [http://kcat.strangesoft.net/openal.html OpenAL Soft] driver. See [[#How to get OpenAL Soft|How to get OpenAL Soft]] below.}}

Enhanced sound was merged into master on June 1, 2015, as of Git commit d7f54dd.

Enhanced sound adds
*Support for 128 audio channels instead of 32
*Support for more control over how the game prioritizes sounds in a mission

Enhanced sound is enabled by default, but it's disabled if you are not using [http://kcat.strangesoft.net/openal.html OpenAL Soft]. See [[#How to get OpenAL Soft|How to get OpenAL Soft]] below.

You can also manually disable enhanced sound with the "Disable enhanced sound" launcher flag under the "Audio" flags.

==How to get OpenAL Soft==
===Windows===
#First, you need to get the OpenAL32.dll file. You can download version 1.16.0 [http://www.mediafire.com/download/csdkp5psozmq2b1/OpenAL32.dll here].
#Alternatively, to get OpenAL32.dll from its original source:
##Download from the [http://kcat.strangesoft.net/openal.html#download OpenAL Soft site] the file whose name ends with "-bin.zip", such as openal-soft-1.16.0-bin.zip.
##Open the .zip file and rename soft_oal.dll found in the bin\Win32\ folder to OpenAL32.dll.
#Once you have OpenAL32.dll:
#Copy it to your FreeSpace 2 or TC folder.
#Make sure to put a copy of OpenAL32.dll in both your FreeSpace 2 folder and the root folders of any TCs you have.

===Linux===
Linux uses OpenAL Soft, so you don't need to do anything.

However, you may wish to build from source either the most recent stable release from the [http://kcat.strangesoft.net/openal.html#download OpenAL Soft site] or even the latest commit from their Git repository.

===OS X===
OS X requires special FSO builds that use OpenAL Soft.

At this time, no such builds are available. The SCP is working on it.

==For modders==
===Overview===
Enhanced sound provides control through two values that you can set through extensions of sounds.tbl:
*'''Priority''': how important the sound is
*'''Limit''': how many instances of the sound can be playing at hte same time

The engine has hardcoded default priorities and limits, as described [[#More on default prioritiies/limits|below]].

You can set custom values for priorities limits using a .tbm file extending sounds.tbl. The [[Sounds.tbl]] page has details on how to specify custom [[Sounds.tbl#+Priority:|priorities]] and [[Sounds.tbl#+Limit:|limits]].

{{Warning|If you create a TC and want to use enhanced sound, then you '''MUST''' set custom priorities/limits for your TC's gameplay sounds. Otherwise the game may sound strange, because the game will use the default values for FS2 retail.}}

{{Note|If you create an FS2 mod that adds new gameplay sounds, then it is '''strongly''' recommended that you specify priorities/limits for those sounds.
}}

===More on default prioritiies/limits===
The FSO engine has hardcoded default priorities limits for the 192 gameplay sound entries in the FS2 retail sounds.tbl. You can see the current list in the source code's [https://github.com/scp-fs2open/fs2open.github.com/blob/master/code/gamesnd/gamesnd.cpp code\gamesnd\gamesnd.cpp] file.
Look for the line starting with
<pre>
static EnhancedSoundData Default_sound_priorities[NUM_RETAIL_GAMEPLAY_SOUNDS] =
</pre>

Sounds outside this range are assigned a generic default priority of Medium-High and limit 1.

===Tips on selecting priorities/limits===

The first answer in [http://gamedev.stackexchange.com/questions/2253/audio-design-and-xaudio2-performance-issues this thread] has some details:

"The methods to prioritise [sounds] can include :

"a) Volume - the lowest being the least important.
[''FSO already takes volume into account when deciding whether to replace a currently playing sound.'']

"b) Priority - a value you set yourself based on the importance of the sound and the likely hood that the user will notice the sound dropping out. Background music, for example, should be set to never be dropped. A random cricket sound for ambience should be high on the list.

"c) Grouping [or ''limit''] - If you have gunshot sounds for example, once they have hit a hard limit (say 15) you would stop adding new gunshot sounds as they wouldn't add to the overall mix.
[''Grouping/limits is also needed to prevent clipping, which is why in FSO, the warp-in sound has a low limit of 2. The super-loud warp-ins were occurring because this limit wasn't being enforced, meaning there was no limit at all.'']"

Enhanced sound

2015-06-02T22:51:44Z

Jg18: Aded placeholder

Coming soon...

Sounds.tbl

2015-06-02T21:16:42Z

Jg18: Update for enhanced sound

{{TableVersion| d7f54dd (Git commit)}}

The '''sounds.tbl''' is a file for defining the various sounds played ingame.

This table is one of the [[Modular Tables]] and can be extended with xxx-snd.tbm

[[Tables|List of Tables]]

==Format==
*Table file consists of several sections
*First section defines the sound for the actual game play. It begins at '''#Game Sounds Start''' and ends at'''#Game Sounds End'''
*Second section defines the interface sounds. It starts at '''#Interface Sounds Start''' and ends at '''#Interface Sounds End'''
*Third section defines the flyby sounds for different species. It begins at '''#Flyby Sounds Start''' and ends at '''#Flyby Sounds End'''
*This table has two possible syntax's, the first being the SCP Syntax and the second being the Retail Syntax
**The SCP Syntax is newer, easier to read, and likely preferred for modular tables and extendability
**The Retail Syntax is the syntax used by the retail tables which was kept in place to keep retail compatibility
*Most of the sounds are hardcoded in the engine (that is, the engine expects sound 33 to be the missile rearm sound, as an example). Modders should follow the retail table layout, and not assign sound numbers smaller than 250 to their custom sounds. This avoids index collisions.

==SCP Syntax==
{{Note|Many retail sound names are hardcoded to a specific type of sound, so removing entries is not recommended. However adding new ones or altering existing ones is possible. See the [[Hardcoded sounds|hardcoded sounds]] for a list of which sounds have hardcoded names.}}

In most entries, the name of the file ('''Second''' value) can be replaced with 'empty' if the particular sound index is not in use.

===#Game Sounds Start===
Notes
*Cockpit sounds are in general non-3D sounds
*All the other in-flight sounds are, in general, 3D sounds
*Non-3D sounds do not require the '''+3D Sound''' entries

Example Line
<pre>
$Name: 6
+Filename: breakup
+Preload: no
+Volume: 0.60
+3D Sound:
+Attenuation start: 100
+Attenuation end: 800
+Priority: High
+Limit: 3
</pre>

====$Name:====
*Specifies the sound handle which FSO will use to identify the sound from other tables
*If +nocreate is to be used, it must come after '''$Name:''' and before the '''String'''
*Syntax: '''String'''
{{Warning|
The name may not contain any whitespace (space or tab characters) or the old parsing code will be used.}}

====+nocreate====
*Allows editing of the sound without creating a new sound handle
*Must be placed after '''$Name:''' and before the '''String'''
*Example
**<pre>$Name: +nocreate SoundName</pre>

====+Filename:====
*The name of the actual sound file to play
*Always required, even if +nocreate is used.
*To specify no sound file, use "empty" (without the quotes)
*If +nocreate is used and you don't want to change the original filename, then use <same> (including the <>)
*Syntax: '''String'''

====+Preload:====
*Specifies whether FSO should always preload the sound before the mission or not
*Optional if +nocreate is used, required otherwise
*Syntax: '''Boolean'''

====+Volume:====
*Specifies the volume the sound should be played at as a percentage
*Optional if +nocreate is used, required otherwise
*Syntax: '''Float'''

====+3D Sound:====
*Sets up table syntax for specifying 3D sound options
*If present the sound will be loaded as a 3D sound
*No argument should be specified
*Must be accompanied by '''+Attenuation Start:''' and '''+Attenuation End:'''

====+Attenuation Start:====
*Defines the distance from the origin of the 3D sound where it begins to attenuate
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

====+Attenuation End:====
*Defines the distance from the origin of the 3D sound where it is inaudible
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

====+Priority:====
*Optional, for use with [[Enhanced sound|enhanced sound]]
*Can be used with or without an accompanying +Limit:
*Specifies the priority of this sound when enhanced sound is used
*Should be based on how important this sound is and also how likely the player will notice if the sound drops out
*overrides the engine default value
*For valid values, see the table below. Values are not case-sensitive.
*See the [[Enhanced sound]] page for more information.
*Syntax: '''String'''

<pre>
Value Meaning
----- -------
Must Play Absolutely must play
High Very important
Medium-High Important
Medium Somewhat important
Medium-Low Only a little important
Low Not important
</pre>

====+Limit:====
*Optional, for use with [[Enhanced sound|enhanced sound]]
*Can be used with or without an accompanying +Priority:
*Specifies how many instances of the sound can play at the same time
*overrides the engine default value
*Must be in the range 1 - 15
*See the [[Enhanced sound]] page for more information,
*Syntax: '''Integer'''

'''Section ends with #Game Sounds End'''

===#Interface Sounds Start===
Notes
*Interface sounds are not 3D sounds. You may specify '''+3D Sound:''' properties, but they will be ignored.

Example Line
<pre>
$Name: CraneSound1
+Filename: Crane_1
+Preload: no
+Volume: 0.50
</pre>

====$Name:====
*Specifies the sound handle which FSO will use to identify the sound from other tables
*If +nocreate is to be used, it must come after '''$Name:''' and before the '''String'''
*Syntax: '''String'''
{{Warning|
The name may not contain any whitespace (space or tab characters) or the old parsing code will be used.}}

====+nocreate====
*Allows editing of the sound without creating a new sound handle
*Must be placed after '''$Name:''' and before the '''String'''
*Example
**<pre>$Name: +nocreate SoundName</pre>

====+Filename:====
*The name of the actual sound file to play
*Syntax: '''String'''

====+Preload:====
*Specifies whether FSO should always preload the sound before the mission or not
*Syntax: '''Boolean'''

====+Volume:====
*Specifies the volume the sound should be played at as a percentage
*Syntax: '''Float'''

'''Section ends with #Interface Sounds End'''

===#Flyby Sounds Start===
Notes
*Each species has two flyby sounds. One for the fighters and one for the bombers.
*Flyby sounds are all 3D sounds.
*Each flyby sound is defined on a line that begins with the species name ('''String''', species name, eg. '''$Terran:''').
*'''THE FLYBY SECTION CANNOT USE +nocreate'''
If you want to modify a flyby sound entry of a species in a modular table then you will need to have entries for both types.

Line starts with '''$SPECIES:''' in the place of '''$Name:'''

Example Terran Section
<pre>
$Terran: 0
+Filename: T_flyby1
+Preload: no
+Volume: 0.75
+3D Sound:
+Attenuation start: 200
+Attenuation end: 400

$Terran: 1
+Filename: T_flyby2
+Preload: no
+Volume: 0.75
+3D Sound:
+Attenuation start: 200
+Attenuation end: 400
</pre>

====$Name:====
*'''$Name''' must be replaced with '''$SPECIES''' as from the [[Species_defs.tbl]]
*Specifies the sound handle which FSO will use to identify the sound from other tables
*In this case it will usually be a '''1''' or a '''0'''
*Syntax: '''String'''
{{Warning|
The name may not contain any whitespace (space or tab characters) or the old parsing code will be used.}}

====+Filename:====
*The name of the actual sound file to play
*Syntax: '''String'''

====+Preload:====
*Specifies whether FSO should always preload the sound before the mission or not
*Syntax: '''Boolean'''

====+Volume:====
*Specifies the volume the sound should be played at as a percentage
*Syntax: '''Float'''

====+3D Sound:====
*Sets up table syntax for specifying 3D sound options
*If present the sound will be loaded as a 3D sound
*No argument should be specified
*Must be accompanied by '''+Attenuation Start:''' and '''+Attenuation End:'''

====+Attenuation Start:====
*Defines the distance from the origin of the 3D sound where it begins to attenuate
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

====+Attenuation End:====
*Defines the distance from the origin of the 3D sound where it is inaudible
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

'''Section ends with #Flyby Sounds End'''

==Retail Syntax==
{{Note|Many retail sound names are hardcoded to a specific type of sound, so removing entries is not recommended. However adding new ones or altering existing ones is possible. See the [[Hardcoded sounds|hardcoded sounds]] for a list of which sounds have hardcoded names.}}

In most entries, the name of the file ('''Second''' value) can be replaced with 'empty' if the particular sound index is not in use.

===#Game Sounds Start===
Notes
*Cockpit sounds are in general non-3D sounds that ought to be of type '0', however all the other in-flight sounds are in general 3D sounds and ought to of type '1' (or type '2').
*Type 0 sounds do not require the '''Sixth''' and '''Seventh''' entries.

Example Line
<pre>$Name: 6 breakup.wav, 0, 0.60, 1, 100, 800</pre>

Line starts with ''$Name:'' and has seven entries separated by commas except for the first and second entries.

**'''First''' value is the index number of the sound ('''Integer''')
**'''Second''' value is the name of actual sound file ('''String''', filename).
**'''Third''' value sets the file to always preloaded before the mission ('''Integer''', 0 or 1)
**'''Fourth''' value defines the playing volume of the sound in percentages ('''Float''', from 0 to 1)
**'''Fifth''' value sets the sound type to either standard sound (type '0'), 3D stereo sound (type '1'), or Aureal A3D (type '2'). This defaults to 3D stereo if it is not available ('''Integer''', 0, 1 or 2)
***'''Sixth''' value defines the distance from the origin of 3D sound where it begins to attenuate and is not used with normal non-3D sounds (type 0)('''Integer''')
***'''Seventh''' value sets the distance from the origin of the 3D sound where it is inaudible and is not used with normal non-3D sounds (type 0)('''Integer''')

'''Section ends with #Game Sounds End'''

===#Interface Sounds Start===
Notes
*Interface sounds are not 3D sounds. Use type '0' sounds. The '''Sixth''' and '''Seventh''' entries can be left out of sounds in this section.

Example Line
<pre>$Name: 26 Crane_1.wav, 0, 0.50, 0</pre>

Line starts with ''$Name:'' and has five entries separated by commas except for the first and second entries.

**'''First''' value is the index number of the sound ('''Integer''')
**'''Second''' value is the name of actual sound file ('''String''', filename).
**'''Third''' value sets the file to always preloaded before the mission ('''Integer''', 0 or 1)
**'''Fourth''' value defines the playing volume of the sound in percentages ('''Float''', from 0 to 1)
**'''Fifth''' value sets the sound type to either standard sound (type '0'), 3D stereo sound (type '1'), or Aureal A3D (type '2'). This defaults to 3D stereo if it is not available ('''Integer''', 0, 1 or 2)

'''Section ends with #Interface Sounds End'''

===#Flyby Sounds Start===
Notes
*Each species has two flyby sounds. One for the fighters and one for the bombers.
*Flyby sounds are all 3D sounds of type '1' for the '''Fifth''' value.
*Each flyby sound is defined on a single line that begins with the species name ('''String''', species name, eg. '''$Terran:''').

Retail flyby section
<pre>
#Flyby Sounds Start

$Terran: 0 T_flyby1.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)
$Terran: 1 T_flyby2.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)

$Vasudan: 0 V_flyby1.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)
$Vasudan: 1 V_flyby2.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)

$Shivan: 0 S_flyby1.wav, 0, 0.75, 1, 200, 400 ; * Shivan ship1 flyby player sound (3d sound)
$Shivan: 1 S_flyby2.wav, 0, 0.75, 1, 200, 400 ; * Shivan ship1 flyby player sound (3d sound)

#Flyby Sounds End
</pre>

Line starts with ''$SPECIES:'' and has seven entries separated by commas except for the first and second entries.

**'''First''' value is the label of the flyby sound, usually 0 for the first (small-ship) entry and 1 for the second (large-ship)entry. ('''Integer''')
**'''Second''' value is the name of actual sound file ('''String''', filename).
**'''Third''' value sets the file to always preloaded before the mission ('''Integer''', 0 or 1)
**'''Fourth''' value defines the playing volume of the sound in percentages ('''Float''', from 0 to 1)
**'''Fifth''' value sets the sound type and should be set to 3D stereo sound (type '1') ('''Integer''', 0, 1 or 2)
***'''Sixth''' value defines the distance from the origin of 3D sound where it begins to attenuate (type 0)('''Integer''')
***'''Seventh''' value sets the distance from the origin of the 3D sound where it is inaudible (type 0)('''Integer''')

'''Section ends with #Flyby Sounds End'''

==Sample==
*Retail FreeSpace 2 table

<pre>
;
; sounds.tbl *
;
; file to specify general game sounds
;
; I M P O R T A N T
; **********************************************************
; * *
; ====> DO NOT MODIFY THE ORDER OF THE LISTED SOUNDS <====*
; * *
; **********************************************************
; I M P O R T A N T
;
; If a sound entry appears in this file, there is a hook into the game to
; play the sound. This file can only be modified to change *existing* sounds.
; Talk to a programmer if you want to add brand new sounds. Adding a line to
; this file will not make your sound appear in the game, it will more than
; likely break something.
;
; If you don't want the sound to play, put none.wav as the sound to play.
;
; The fields for a sound entry are:
; 1) unqiue sound signature
; 2) filename of the sound
; 3) flag to indicate sound should always be pre-loaded before a mission
; 4) the default volume (from 0.0 -> 1.0)
; 5) 0 - not 3d 1 - stereo 3D 2 - Aureal A3D (if available), otherwise use stereo 3D
; 6) distance at which sound starts to attenuate (for 3d sounds only)
; 7) distance at which sound is inaudible (for 3d sounds only)
;
#Game Sounds Start
; Misc sounds section ** = Aureal 3d support | * = FS = 3D support
$Name: 0 trk-loop.wav, 0, 0.40, 0 ; Missle tracking to acquire a lock (looped)
$Name: 1 lock.wav, 0, 0.40, 0 ; Missle lock (non-looping)
$Name: 2 cycle.wav, 0, 0.60, 0 ; cycle primary weapon
$Name: 3 cycle.wav, 0, 0.60, 0 ; cycle secondary weapon
$Name: 4 ship_p.wav, 0, 0.30, 0 ; engine sound (as heard in cockpit)
$Name: 5 reveal.wav, 0, 0.40, 0 ; cargo revealed
$Name: 6 breakup.wav, 0, 0.60, 1, 100, 800 ; ship death roll (3d sound)
$Name: 7 boom_3.wav, 0, 0.90, 2, 600, 1200 ; * ship explosion 1 (3d sound)
$Name: 8 beep_2.wav, 0, 0.40, 0 ; target acquried
$Name: 9 switch_1.wav, 0, 0.50, 0 ; energy level change success
$Name: 10 beep_5.wav, 0, 0.50, 0 ; energy level change fail
$Name: 11 switch_2.wav, 0, 0.50, 0 ; energy transfer success
$Name: 12 beep_5.wav, 0, 0.50, 0 ; energy transfer faile
$Name: 13 thr_full.wav, 0, 0.40, 0 ; set full throttle
$Name: 14 thr_off.wav, 0, 0.40, 0 ; set zero throttle
$Name: 15 thr_up.wav, 0, 0.40, 0 ; set 1/3 or 2/3 throttle (up)
$Name: 16 thr_dwn.wav, 0, 0.40, 0 ; set 1/3 or 2/3 throttle (down)
$Name: 17 approach.wav, 0, 0.60, 1, 10, 800 ; dock approach retros (3d sound)
$Name: 18 attach.wav, 0, 0.60, 1, 10, 800 ; dock attach (3d sound)
$Name: 19 detach.wav, 0, 0.60, 1, 10, 800 ; dock detach (3d sound)
$Name: 20 depart.wav, 0, 0.60, 1, 10, 800 ; dock depart retros (3d sound)
$Name: 21 aburn_1.wav, 0, 0.70, 0 ; afterburner engage (3d sound)
$Name: 22 aburn_2.wav, 0, 0.90, 0 ; afterburner burn sound (looped)
$Name: 23 vaporize2.wav, 0, 0.90, 0 ; Destroyed by a beam (vaporized)
$Name: 24 aburn_1f.wav, 0, 0.50, 0 ; afterburner fail (no fuel when aburn pressed)
$Name: 25 alert_2.wav, 0, 0.40, 0 ; heat-seeker launch warning
$Name: 26 m_fail.wav, 0, 0.60, 0 ; tried to fire a missle when none are left
$Name: 27 l_fail.wav, 0, 0.60, 0 ; tried to fire lasers when not enough energy left
$Name: 28 fail.wav, 0, 0.50, 0 ; target fail sound (i.e. press targeting key, but nothing happens)
$Name: 29 beep_1.wav, 0, 0.50, 0 ; squadmate message menu appears
$Name: 30 beep_1.wav, 0, 0.50, 0 ; squadmate message menu disappears
$Name: 31 debris.wav, 0, 0.40, 2, 100, 300 ; ** debris sound (persistant, looping) (3d sound)
$Name: 32 subhit.wav, 0, 0.60, 0 ; subsystem gets destroyed on player ship
$Name: 33 m_load.wav, 0, 0.60, 1, 10, 50 ; missle start load (during rearm/repair) (3d sound)
$Name: 34 m_lock.wav, 0, 0.50, 1, 10, 50 ; missle load (during rearm/repair) (3d sound)
$Name: 35 repair.wav, 0, 0.50, 0 ; ship is being repaired (during rearm/repair) (looped)
$Name: 36 l_hit.wav, 0, 0.90, 0, 30, 100 ; * player ship is hit by laser fire (3d sound)
$Name: 37 m_hit.wav, 0, 0.90, 0, 30, 100 ; * player ship is hit by missile (3d sound)
$Name: 38 cycle.wav, 0, 0.80, 0 ; countermeasure cycle
$Name: 39 s_hit_4.wav, 0, 0.60, 1, 200, 600 ; * shield hit (3d sound)
$Name: 40 s_hit_2.wav, 0, 0.80, 1, 10, 100 ; * player shield is hit (3d sound)
$Name: 41 select.wav, 0, 0.60, 0 ; mouse click
$Name: 42 alert_3.wav, 0, 0.60, 0 ; aspect launch warning
$Name: 43 beep_4.wav, 0, 0.60, 0 ; shield quadrant transfer successful
$Name: 44 wash.wav, 0, 0.80, 1, 200, 400 ; Engine wash looping sound
$Name: 45 warp_1.wav, 0, 0.60, 2, 750, 1500 ; ** warp hole opening up for arriving (3d sound)
$Name: 46 warp_1.wav, 0, 0.60, 2, 750, 1500 ; ** warp hole opening up for departing (3d sound)
$Name: 47 aburn_1f.wav, 0, 0.50, 0 ; player warp has failed
$Name: 48 static.wav, 0, 0.60, 0 ; hud gauge static
$Name: 49 boom_1.wav, 0, 0.90, 1, 600, 1200 ; * ship explosion 2 (3d sound)
$Name: 50 rev1.wav, 0, 0.70, 0 ; ship is warping out in 3rd person
$Name: 51 s_hit_0.wav, 0, 0.70, 1, 100, 200 ; * heavy ship-ship collide sound (3d sound)
$Name: 52 collide.wav, 0, 0.70, 1, 100, 200 ; * light ship-ship collide sound (3d sound)
$Name: 53 s_hit_1.wav, 0, 0.70, 1, 100, 200 ; * shield ship-ship collide overlay sound (3d sound)
$Name: 54 alert_1.wav, 0, 0.50, 0 ; missile threat indicator flashes
$Name: 55 proximity1.wav, 0, 0.70, 0 ; proximity warning (heat seeker)
$Name: 56 proximity2.wav, 0, 0.70, 0 ; proximity warning (aspect)
$Name: 57 directive.wav, 0, 0.70, 0 ; directive complete
$Name: 58 subhit2.wav, 0, 0.90, 1, 250, 800 ; * other ship subsystem destroyed (3d sound)
$Name: 59 atomic.wav, 0, 0.90, 1, 2000, 4000 ; * captial ship explosion (3d sound)
$Name: 60 subhit2.wav, 0, 0.90, 1, 250, 1500 ; * captial ship subsystem destroyed (3d sound)
$Name: 61 warp2.wav, 0, 1.00, 1, 1500, 2000 ; [obsolete] large ship warps out (looping 3d sound)
$Name: 62 ast_lghit.wav, 0, 0.80, 1, 750, 1500 ; ** large asteroid blows up (3d sound)
$Name: 63 ast_smhit.wav, 0, 0.80, 1, 500, 1000 ; ** small asteroid blows up (3d sound)
$Name: 64 cue_voice.wav, 0, 0.90, 0 ; sound to indicate voice is about to start
$Name: 65 end_voice.wav, 0, 0.90, 0 ; sound to indicate voice has ended
$Name: 66 scan.wav, 0, 0.50, 0 ; cargo scanning (looping)
$Name: 67 l_flyby.wav, 0, 0.80, 1, 50, 250 ; * weapon flyby sound
$Name: 68 asteroid.wav, 0, 0.50, 1, 200, 700 ; [obsolete] asteroid sound (persistant, looping) (3d sound)
$Name: 69 warp_open.wav, 0, 1.00, 2, 2000, 4000 ; capital warp hole opening (3d sound)
$Name: 70 warp_close.wav, 0, 1.00, 2, 2000, 4000 ; capital warp hole closing (3d sound)
$Name: 71 rumble.wav, 0, 0.70, 1, 600, 1000 ; LARGE engine ambient
$Name: 72 subspace_left.wav, 0, 0.30, 0 ; subspace ambient sound (left channel) (looping)
$Name: 73 subspace_right.wav, 0, 0.30, 0 ; subspace ambient sound (right channel) (looping)
$Name: 74 Evaded.wav, 0, 0.70, 0 ; "evaded" HUD popup
$Name: 75 rumble.wav, 0, 0.70, 1, 600, 1000 ; HUGE engine ambient
;
; Weapons section
;
$Name: 76 L_Sidearm.wav, 0, 0.50, 1, 50, 400 ; SD-4 Sidearm laser fired
$Name: 77 L_Scalpel.wav, 0, 0.50, 1, 50, 400 ; DR-2 Scalpel fired
$Name: 78 L_Flail2.wav, 0, 0.50, 1, 50, 400 ; Flail II fired
$Name: 79 L_Prom_R.wav, 0, 0.50, 1, 50, 400 ; Prometheus R laser fired
$Name: 80 L_Prom_S.wav, 0, 0.50, 1, 50, 400 ; Prometheus S laser fired
$Name: 81 L_Newton.wav, 0, 0.50, 1, 50, 400 ; GTW-66 Newton Cannon fired
$Name: 82 L_Kayser.wav, 0, 0.55, 1, 50, 400 ; UD-8 Kayser Laser fired
$Name: 83 L_Circle.wav, 0, 0.50, 1, 50, 400 ; GTW-19 Circe laser fired
$Name: 84 L_Lich.wav, 0, 0.50, 1, 50, 400 ; GTW-83 Lich laser fired
$Name: 85 hit_1.wav, 0, 0.90, 1, 200, 800 ; Laser impact
$Name: 86 L_Vasmid.wav, 0, 0.50, 1, 50, 400 ; Subach-HLV Vasudan laser
$Name: 87 m_wasp.wav, 0, 0.80, 1, 50, 400 ; rockeye missile launch
$Name: 88 boom_2.wav, 0, 0.80, 1, 500, 1000 ; missile impact 1
$Name: 89 m_mag.wav, 0, 0.80, 1, 50, 400 ; mag pulse missile launch
$Name: 90 m_fury.wav, 0, 0.80, 1, 50, 400 ; fury missile launch
$Name: 91 m_shrike.wav, 0, 0.80, 1, 50, 400 ; shrike missile launch
$Name: 92 m_angel.wav, 0, 0.80, 1, 50, 400 ; angel fire missile launch
$Name: 93 m_cluster.wav, 0, 0.80, 1, 50, 400 ; cluster bomb launch
$Name: 94 m_clusterb.wav, 0, 0.80, 1, 50, 400 ; cluster baby bomb launch
$Name: 95 m_stiletto.wav, 0, 0.80, 1, 50, 400 ; stiletto bomb launch
$Name: 96 m_tsunami.wav, 0, 0.80, 1, 50, 400 ; tsunami bomb launch
$Name: 97 m_harbinger.wav, 0, 0.80, 1, 50, 400 ; harbinger bomb launch
$Name: 98 m_mega.wav, 0, 0.80, 1, 50, 400 ; mega wokka launch
$Name: 99 counter_1.wav, 0, 0.70, 1, 50, 200 ; countermeasure 1 launch
$Name: 100 l_alien1.wav, 0, 0.60, 1, 50, 400 ; Shivan light laser (3d sound)
$Name: 101 clusterboom.wav, 0, 0.80, 1, 750, 2000 ; shockwave ignition (3d sound)
$Name: 102 m_swarm.wav, 0, 0.70, 1, 50, 400 ; swarm missile sound (3d sound)
$Name: 103 l_alien2.wav, 0, 0.60, 1, 100, 400 ; Shivan heavy laser (3d sound)
$Name: 104 capital4.wav, 0, 0.70, 1, 500, 1500 ; Vasudan SuperCap engine (3d sound)
$Name: 105 capital5.wav, 0, 0.70, 1, 500, 1500 ; Shivan SuperCap engine (3d sound)
$Name: 106 capital6.wav, 0, 0.70, 1, 500, 1500 ; Terran SuperCap engine (3d sound)
$Name: 107 l_vaslight.wav, 0, 0.60, 1, 50, 400 ; Vasudan light laser fired (3d sound)
$Name: 108 l_alien3.wav, 0, 0.60, 1, 50, 400 ; Shivan heavy laser (3d sound)
$Name: 109 shockwave.wav, 0, 1.00, 1, 50, 800 ; ** shockwave impact (3d sound)
$Name: 110 Turret_T1.wav, 0, 0.50, 2, 200, 1000 ; TERRAN TURRET 1
$Name: 111 Turret_T2.wav, 0, 0.50, 2, 200, 1000 ; TERRAN TURRET 2
$Name: 112 Turret_V1.wav, 0, 0.50, 2, 200, 1000 ; VASUDAN TURRET 1
$Name: 113 Turret_V2.wav, 0, 0.50, 2, 200, 1000 ; VASUDAN TURRET 2
$Name: 114 Turret_S1.wav, 0, 0.50, 2, 200, 1000 ; SHIVAN TURRET 1
$Name: 115 paintloop.wav, 0, 0.60, 1, 50, 200 ; targeting laser loop sound
$Name: 116 FlakLaunch.wav, 0, 0.60, 1, 250, 1000 ; Flak Gun Launch
$Name: 117 boom_4.wav, 0, 0.80, 1, 400, 800 ; Flak Gun Impact
$Name: 118 m_emp.wav, 0, 0.60, 1, 50, 400 ; EMP Missle
$Name: 119 Escape.wav, 0, 0.60, 1, 200, 600 ; Escape Pod Drone
$Name: 120 Vaporize1.wav, 0, 0.70, 0 ; Beam Hit 1
$Name: 121 beam_loop.wav, 0, 0.70, 2, 1500, 3000 ; beam loop
$Name: 122 beam_up.wav, 0, 0.70, 2, 1500, 3000 ; beam power up
$Name: 123 beam_down.wav, 0, 0.70, 2, 1500, 3000 ; beam power down
$Name: 124 beam_shot1.wav, 0, 0.70, 2, 1500, 2500 ; Beam shot 1
$Name: 125 beam_shot2.wav, 0, 0.70, 2, 1500, 2500 ; Beam shot 2
;Ship Engine Sounds section
$Name: 126 ship_a1.wav, 0, 0.60, 1, 200, 400 ; Terran fighter engine (3d sound)
$Name: 127 ship_a2.wav, 0, 0.70, 1, 300, 600 ; Terran bomber engine (3d sound)
$Name: 128 ship_a3.wav, 0, 0.80, 1, 400, 800 ; Terran cruiser engine (3d sound)
$Name: 129 ship_b1.wav, 0, 0.70, 1, 200, 400 ; Vasudan fighter engine (3d sound)
$Name: 130 ship_b2.wav, 0, 0.80, 1, 300, 600 ; Vasudan bomber engine (3d sound)
$Name: 131 ship_b3.wav, 0, 0.80, 1, 400, 800 ; Vasudan cruiser engine (3d sound)
$Name: 132 ship_c1.wav, 0, 0.60, 1, 200, 400 ; Shivan fighter engine (3d sound)
$Name: 133 ship_c2.wav, 0, 0.70, 1, 300, 600 ; Shivan bomber engine (3d sound)
$Name: 134 ship_c3.wav, 0, 0.80, 1, 400, 800 ; Shivan cruiser engine (3d sound)
$Name: 135 beacon.wav, 0, 0.60, 1, 300, 600 ; Repair ship beacon/engine sound (3d sound)
$Name: 136 capital1.wav, 0, 0.70, 1, 500, 1500 ; Terran capital engine (3d sound)
$Name: 137 capital2.wav, 0, 0.70, 1, 500, 1500 ; Vasudan capital engine (3d sound)
$Name: 138 capital3.wav, 0, 0.70, 1, 500, 1500 ; Shivan capital engine (3d sound)
; Electrical arc sound fx on the debris pieces
$Name: 139 Arc_01.wav, 0, 0.30, 2, 200, 500 ; ** 0.10 second spark sound effect (3d sound)
$Name: 140 Arc_02.wav, 0, 0.30, 2, 200, 500 ; ** 0.25 second spark sound effect (3d sound)
$Name: 141 Arc_03.wav, 0, 0.30, 2, 200, 500 ; ** 0.50 second spark sound effect (3d sound)
$Name: 142 Arc_04.wav, 0, 0.30, 2, 200, 500 ; ** 0.75 second spark sound effect (3d sound)
$Name: 143 Arc_05.wav, 0, 0.30, 2, 200, 500 ; ** 1.00 second spark sound effect (3d sound)
; Beam Sounds
$Name: 144 BT_LTerSlash.wav, 0, 0.70, 2, 1500, 3000 ; LTerSlash beam loop
$Name: 145 BT_TerSlash.wav, 0, 0.70, 2, 1500, 3000 ; TerSlash beam loop
$Name: 146 BT_SGreen.wav, 0, 0.70, 2, 1500, 3000 ; SGreen beam loop
$Name: 147 BT_BGreen.wav, 0, 0.70, 2, 1500, 3000 ; BGreen beem loop
$Name: 148 BT_BFGreen.wav, 0, 0.70, 2, 1500, 3000 ; BFGreen been loop
$Name: 149 BT_AntiFtr.wav, 0, 0.70, 2, 1500, 3000 ; Antifighter beam loop
$Name: 150 BT_up_1.wav, 0, 0.60, 2, 1500, 3000 ; 1 sec warm up
$Name: 151 BT_up_1.5.wav, 0, 0.60, 2, 1500, 3000 ; 1.5 sec warm up
$Name: 152 BT_up_2.5.wav, 0, 0.60, 2, 1500, 3000 ; 2.5 sec warm up
$Name: 153 BT_up_3.wav, 0, 0.60, 2, 1500, 3000 ; 3 sec warm up
$Name: 154 BT_up_3.5.wav, 0, 0.60, 2, 1500, 3000 ; 3.5 sec warm up
$Name: 155 BT_up_5.wav, 0, 0.60, 2, 1500, 3000 ; 5 sec warm up
$Name: 156 BT_dwn_1.wav, 0, 0.70, 2, 2000, 3000 ; LTerSlash warm down
$Name: 157 BT_dwn_2.wav, 0, 0.70, 2, 2000, 3000 ; TerSlash warm down
$Name: 158 BT_dwn_3.wav, 0, 0.70, 2, 2000, 3000 ; SGreen warm down
$Name: 159 BT_dwn_4.wav, 0, 0.70, 2, 2000, 3000 ; BGreen warm down
$Name: 160 BT_dwn_5.wav, 0, 0.70, 2, 2000, 3000 ; BFGreen warm down
$Name: 161 BT_dwn_6.wav, 0, 0.70, 2, 2000, 3000 ; T_AntiFtr warm down
$Name: 162 Empty, 0, 0.50, 0
$Name: 163 Empty, 0, 0.50, 0
$Name: 164 Empty, 0, 0.50, 0
$Name: 165 Empty, 0, 0.50, 0
$Name: 166 Empty, 0, 0.50, 0
$Name: 167 Empty, 0, 0.50, 0
$Name: 168 Empty, 0, 0.50, 0
$Name: 169 Empty, 0, 0.50, 0
$Name: 170 Empty, 0, 0.50, 0
$Name: 171 Empty, 0, 0.50, 0
$Name: 172 Empty, 0, 0.50, 0
$Name: 173 SupNova1.wav, 0, 1.00, 0 ; SuperNova (distant)
$Name: 174 SupNova2.wav, 0, 1.00, 0 ; SuperNova (shockwave)
$Name: 175 ship_c4.wav, 0, 0.80, 1, 400, 800 ; Shivan large engine (3d sound)
$Name: 176 ship_c5.wav, 0, 0.80, 1, 400, 1000 ; Shivan large engine (3d sound)
$Name: 177 BS_SRed.wav, 0, 0.70, 2, 1500, 3000 ; SRed beam loop
$Name: 178 BS_LRed.wav, 0, 0.70, 2, 1500, 3000 ; LRed beam loop
$Name: 179 BS_AntiFtr.wav, 0, 0.70, 2, 1500, 3000 ; Antifighter beam loop
$Name: 180 Thunder_01.wav, 0, 0.70, 0 ; Thunder 1 sound in neblua
$Name: 181 Thunder_02.wav, 0, 0.70, 0 ; Thunder 2 sound in neblua
$Name: 182 BS_up_1.wav, 0, 0.60, 2, 1500, 3000 ; 1 sec warm up
$Name: 183 BS_up_1.5.wav, 0, 0.60, 2, 1500, 3000 ; 1.5 sec warm up
$Name: 184 BS_up_3.wav, 0, 0.60, 2, 1500, 3000 ; 3 sec warm up
$Name: 185 Commnode.wav, 0, 0.60, 1, 200, 500 ; Shivan Commnode
$Name: 186 Pirate.wav, 0, 0.60, 1, 400, 1000 ; Volition PirateShip
$Name: 187 BS_dwn_1.wav, 0, 0.70, 2, 2000, 3000 ; SRed warm down
$Name: 188 BS_dwn_2.wav, 0, 0.70, 2, 2000, 3000 ; LRed warm down
$Name: 189 BS_dwn_3.wav, 0, 0.70, 2, 2000, 3000 ; AntiFtr warm down
$Name: 190 Inst1.wav, 0, 0.80, 1, 500, 2000 ; Instellation 1
$Name: 191 Inst2.wav, 0, 0.80, 1, 500, 2000 ; Instellation 2

;SCP ADDED SOUNDS START HERE
$Name: 200 m_load.wav, 0, 0.60, 1, 10, 50 ; Ballistic Weapon Rearm Start
$Name: 201 m_lock.wav, 0, 0.50, 1, 10, 50 ; Ballistic Weapon Rearm
;
#Game Sounds End
;
#Interface Sounds Start
$Name: 0 user_c.wav, 0, 0.70, 0 ; mouse click
$Name: 1 empty, 0, 0.70, 0 ; pick up a ship icon (not used)
$Name: 2 load01.wav, 0, 0.60, 0 ; drop a ship icon on a wing slot
$Name: 3 unload01.wav, 0, 0.60, 0 ; drop a ship icon back to the list
$Name: 4 beep_4.wav, 0, 0.70, 0 ; press briefing, ship selection or weapons bar (top-left)
$Name: 5 user_c.wav, 0, 0.70, 0 ; Switching to a new screen, but not commit
$Name: 6 beep_4.wav, 0, 0.70, 0 ; help pressed
$Name: 7 commit.wav, 0, 0.60, 0 ; commit pressed
$Name: 8 user_c.wav, 0, 0.70, 0 ; prev/next pressed
$Name: 9 user_c.wav, 0, 0.70, 0 ; scroll pressed (and scroll)
$Name: 10 fail.wav, 0, 0.70, 0 ; general failure sound for any event
$Name: 11 shipview.wav, 0, 0.50, 0 ; ship animation starts (ie text and ship first appear)
$Name: 12 main_amb.wav, 0, 0.60, 0 ; ambient sound for the Terran main hall (looping)
$Name: 13 vas_amb.wav, 0, 0.60, 0 ; ambient sound for the Vasudan main hall (looping)
$Name: 14 user_a.wav, 0, 0.70, 0 ; brief stage change
$Name: 15 user_i.wav, 0, 0.70, 0 ; brief stage change fail
$Name: 16 beep_3.wav, 0, 0.70, 0 ; selet brief icon
$Name: 17 user_o.wav, 0, 0.50, 0 ; user_over (mouse over a control)
$Name: 18 user_c.wav, 0, 0.70, 0 ; user_click (mouse selects a control)
$Name: 19 reset.wav, 0, 0.70, 0 ; reset (or similar button) pressed
$Name: 20 textdraw.wav, 0, 0.60, 0 ; briefing text wipe
$Name: 21 Lift_Mix.wav, 0, 0.50, 0 ; main hall - elevator
$Name: 22 weapview.wav, 0, 0.60, 0 ; weapon animation starts
$Name: 23 dooropen.wav, 0, 0.50, 0 ; door in main hall opens
$Name: 24 doorclose.wav, 0, 0.50, 0 ; door in main hall closes
$Name: 25 itemdraw.wav, 0, 0.50, 0 ; glow in main hall opens
$Name: 26 Crane_1.wav, 0, 0.50, 0 ; main hall - crane 1
$Name: 27 sub_amb.wav, 0, 0.60, 0 ; ambient sound for menus off the main hall (looping)
$Name: 28 user_c.wav, 0, 0.70, 0 ; popup dialog box appeared
$Name: 29 user_c.wav, 0, 0.70, 0 ; popup dialog box goes away
$Name: 30 1_yes.wav, 0, 1.00, 0 ; voice clip played when volume slider changes
$Name: 31 Crane_2.wav, 0, 0.50, 0 ; main hall - crane 2
$Name: 32 Option1.wav, 0, 0.70, 0 ; main hall options - mouse on
$Name: 33 Option2.wav, 0, 0.70, 0 ; main hall options - mouse off
$Name: 34 Techroom1.wav, 0, 0.70, 0 ; main hall tech room - mouse on
$Name: 35 Techroom2.wav, 0, 0.70, 0 ; main hall tech room - mouse off
$Name: 36 Exitopen.wav, 0, 0.60, 0 ; main hall exit open
$Name: 37 Exitclose.wav, 0, 0.60, 0 ; main hall exit close
$Name: 38 pa_1.wav, 0, 0.50, 0 ; main hall random intercom 1
$Name: 39 pa_2.wav, 0, 0.50, 0 ; main hall random intercom 2
$Name: 40 pa_3.wav, 0, 0.50, 0 ; main hall random intercom 3
$Name: 41 highlight.wav, 0, 0.40, 0 ; spinning highlight in briefing
$Name: 42 noiz.wav, 0, 0.40, 0 ; static in a briefing stage cut
$Name: 43 Camp_on.wav, 0, 0.70, 0 ; main hall campaign - mouse on
$Name: 44 Camp_off.wav, 0, 0.70, 0 ; main hall campaign - mouse off
$Name: 45 V_Hatch_Open.wav, 0, 0.70, 0 ; vasudan hall - exit open
$Name: 46 V_Hatch_Close.wav, 0, 0.70, 0 ; vasudan hall - exit close
$Name: 47 V_Roll_Open.wav, 0, 0.80, 0 ; vasudan hall - hatch open
$Name: 48 V_Roll_Close.wav, 0, 0.80, 0 ; vasudan hall - hatch close
$Name: 49 V_Lift_Up.wav, 0, 0.70, 0 ; vasudan hall - lift up
$Name: 50 V_Lift_Down.wav, 0, 0.70, 0 ; vasudan hall - lift down
$Name: 51 V_Lite_On.wav, 0, 0.70, 0 ; vasudan hall - glow on
$Name: 52 V_Lite_Off.wav, 0, 0.70, 0 ; vasudan hall - glow off
$Name: 53 Skiff.wav, 0, 0.70, 0 ; vasudan hall - skiff loop
$Name: 54 V_Map_On.wav, 0, 0.70, 0 ; vasudan hall - screen on
$Name: 55 V_Map_Off.wav, 0, 0.70, 0 ; vasudan hall - screen off
$Name: 56 V_Head_1.wav, 0, 0.70, 0 ; vasudan hall - vasudan greeting
$Name: 57 V_Head_2.wav, 0, 0.70, 0 ; vasudan hall - vasudan bye
$Name: 58 V_Pa_01.wav, 0, 0.70, 0 ; vasudan hall - vasudan pa 1
$Name: 59 V_Pa_02.wav, 0, 0.70, 0 ; vasudan hall - vasudan pa 2
$Name: 60 V_Pa_03.wav, 0, 0.70, 0 ; vasudan hall - vasudan pa 3
$Name: 61 bup.wav, 0, 0.90, 0 ; bup bup bup-bup bup bup
$Name: 62 thankyou.wav, 0, 0.90, 0 ; thankyou
$Name: 63 V_Exit_Open.wav, 0, 0.70, 0 ; vasudan hall - exit open
$Name: 64 V_Exit_Close.wav, 0, 0.70, 0 ; vasudan hall - exit close
;
#Interface Sounds End
;
; Each species can have up to 4 different flyby sounds
; NOTE : the parse code expects to see exactly 2 sounds for terran, then 2 for vasudan, then 2 for shivan
; the first sound for each species is the fighter/small flyby sound. the second is the bomber/big flyby sound
#Flyby Sounds Start

$Terran: 0 T_flyby1.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)
$Terran: 1 T_flyby2.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)

$Vasudan: 0 V_flyby1.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)
$Vasudan: 1 V_flyby2.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)

$Shivan: 0 S_flyby1.wav, 0, 0.75, 1, 200, 400 ; * SHIVAN ship1 flyby player sound (3d sound)
$Shivan: 1 S_flyby2.wav, 0, 0.75, 1, 200, 400 ; * SHIVAN ship1 flyby player sound (3d sound)

#Flyby Sounds End
</pre>

[[Category:Tables]]

Sounds.tbl

2015-05-08T19:24:40Z

Jg18: clarification on SCp syntax for game sounds

{{TableVersion| 77ee6f1 (Git commit)}}

The '''sounds.tbl''' is a file for defining the various sounds played ingame.

This table is one of the [[Modular Tables]] and can be extended with xxx-snd.tbm

[[Tables|List of Tables]]

==Format==
*Table file consists of several sections
*First section defines the sound for the actual game play. It begins at '''#Game Sounds Start''' and ends at'''#Game Sounds End'''
*Second section defines the interface sounds. It starts at '''#Interface Sounds Start''' and ends at '''#Interface Sounds End'''
*Third section defines the flyby sounds for different species. It begins at '''#Flyby Sounds Start''' and ends at '''#Flyby Sounds End'''
*This table has two possible syntax's, the first being the SCP Syntax and the second being the Retail Syntax
**The SCP Syntax is newer, easier to read, and likely preferred for modular tables and extendability
**The Retail Syntax is the syntax used by the retail tables which was kept in place to keep retail compatibility
*Most of the sounds are hardcoded in the engine (that is, the engine expects sound 33 to be the missile rearm sound, as an example). Modders should follow the retail table layout, and not assign sound numbers smaller than 250 to their custom sounds. This avoids index collisions.

==SCP Syntax==
{{Note|Many retail sound names are hardcoded to a specific type of sound, so removing entries is not recommended. However adding new ones or altering existing ones is possible. See the [[Hardcoded sounds|hardcoded sounds]] for a list of which sounds have hardcoded names.}}

In most entries, the name of the file ('''Second''' value) can be replaced with 'empty' if the particular sound index is not in use.

===#Game Sounds Start===
Notes
*Cockpit sounds are in general non-3D sounds
*All the other in-flight sounds are, in general, 3D sounds
*Non-3D sounds do not require the '''+3D Sound''' entries

Example Line
<pre>
$Name: 6
+Filename: breakup
+Preload: no
+Volume: 0.60
+3D Sound:
+Attenuation start: 100
+Attenuation end: 800
</pre>

====$Name:====
*Specifies the sound handle which FSO will use to identify the sound from other tables
*If +nocreate is to be used, it must come after '''$Name:''' and before the '''String'''
*Syntax: '''String'''
{{Warning|
The name may not contain any whitespace (space or tab characters) or the old parsing code will be used.}}

====+nocreate====
*Allows editing of the sound without creating a new sound handle
*Must be placed after '''$Name:''' and before the '''String'''
*Example
**<pre>$Name: +nocreate SoundName</pre>

====+Filename:====
*The name of the actual sound file to play
*Always required, even if +nocreate is used.
*To specify no sound file, use "empty" (without the quotes)
*If +nocreate is used and you don't want to change the original filename, then use <same> (including the <>)
*Syntax: '''String'''

====+Preload:====
*Specifies whether FSO should always preload the sound before the mission or not
*Optional if +nocreate is used, required otherwise
*Syntax: '''Boolean'''

====+Volume:====
*Specifies the volume the sound should be played at as a percentage
*Optional if +nocreate is used, required otherwise
*Syntax: '''Float'''

====+3D Sound:====
*Sets up table syntax for specifying 3D sound options
*If present the sound will be loaded as a 3D sound
*No argument should be specified
*Must be accompanied by '''+Attenuation Start:''' and '''+Attenuation End:'''

====+Attenuation Start:====
*Defines the distance from the origin of the 3D sound where it begins to attenuate
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

====+Attenuation End:====
*Defines the distance from the origin of the 3D sound where it is inaudible
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

'''Section ends with #Game Sounds End'''

===#Interface Sounds Start===
Notes
*Interface sounds are not 3D sounds. You may specify '''+3D Sound:''' properties, but they will be ignored.

Example Line
<pre>
$Name: CraneSound1
+Filename: Crane_1
+Preload: no
+Volume: 0.50
</pre>

====$Name:====
*Specifies the sound handle which FSO will use to identify the sound from other tables
*If +nocreate is to be used, it must come after '''$Name:''' and before the '''String'''
*Syntax: '''String'''
{{Warning|
The name may not contain any whitespace (space or tab characters) or the old parsing code will be used.}}

====+nocreate====
*Allows editing of the sound without creating a new sound handle
*Must be placed after '''$Name:''' and before the '''String'''
*Example
**<pre>$Name: +nocreate SoundName</pre>

====+Filename:====
*The name of the actual sound file to play
*Syntax: '''String'''

====+Preload:====
*Specifies whether FSO should always preload the sound before the mission or not
*Syntax: '''Boolean'''

====+Volume:====
*Specifies the volume the sound should be played at as a percentage
*Syntax: '''Float'''

'''Section ends with #Interface Sounds End'''

===#Flyby Sounds Start===
Notes
*Each species has two flyby sounds. One for the fighters and one for the bombers.
*Flyby sounds are all 3D sounds.
*Each flyby sound is defined on a line that begins with the species name ('''String''', species name, eg. '''$Terran:''').
*'''THE FLYBY SECTION CANNOT USE +nocreate'''
If you want to modify a flyby sound entry of a species in a modular table then you will need to have entries for both types.

Line starts with '''$SPECIES:''' in the place of '''$Name:'''

Example Terran Section
<pre>
$Terran: 0
+Filename: T_flyby1
+Preload: no
+Volume: 0.75
+3D Sound:
+Attenuation start: 200
+Attenuation end: 400

$Terran: 1
+Filename: T_flyby2
+Preload: no
+Volume: 0.75
+3D Sound:
+Attenuation start: 200
+Attenuation end: 400
</pre>

====$Name:====
*'''$Name''' must be replaced with '''$SPECIES''' as from the [[Species_defs.tbl]]
*Specifies the sound handle which FSO will use to identify the sound from other tables
*In this case it will usually be a '''1''' or a '''0'''
*Syntax: '''String'''
{{Warning|
The name may not contain any whitespace (space or tab characters) or the old parsing code will be used.}}

====+Filename:====
*The name of the actual sound file to play
*Syntax: '''String'''

====+Preload:====
*Specifies whether FSO should always preload the sound before the mission or not
*Syntax: '''Boolean'''

====+Volume:====
*Specifies the volume the sound should be played at as a percentage
*Syntax: '''Float'''

====+3D Sound:====
*Sets up table syntax for specifying 3D sound options
*If present the sound will be loaded as a 3D sound
*No argument should be specified
*Must be accompanied by '''+Attenuation Start:''' and '''+Attenuation End:'''

====+Attenuation Start:====
*Defines the distance from the origin of the 3D sound where it begins to attenuate
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

====+Attenuation End:====
*Defines the distance from the origin of the 3D sound where it is inaudible
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

'''Section ends with #Flyby Sounds End'''

==Retail Syntax==
{{Note|Many retail sound names are hardcoded to a specific type of sound, so removing entries is not recommended. However adding new ones or altering existing ones is possible. See the [[Hardcoded sounds|hardcoded sounds]] for a list of which sounds have hardcoded names.}}

In most entries, the name of the file ('''Second''' value) can be replaced with 'empty' if the particular sound index is not in use.

===#Game Sounds Start===
Notes
*Cockpit sounds are in general non-3D sounds that ought to be of type '0', however all the other in-flight sounds are in general 3D sounds and ought to of type '1' (or type '2').
*Type 0 sounds do not require the '''Sixth''' and '''Seventh''' entries.

Example Line
<pre>$Name: 6 breakup.wav, 0, 0.60, 1, 100, 800</pre>

Line starts with ''$Name:'' and has seven entries separated by commas except for the first and second entries.

**'''First''' value is the index number of the sound ('''Integer''')
**'''Second''' value is the name of actual sound file ('''String''', filename).
**'''Third''' value sets the file to always preloaded before the mission ('''Integer''', 0 or 1)
**'''Fourth''' value defines the playing volume of the sound in percentages ('''Float''', from 0 to 1)
**'''Fifth''' value sets the sound type to either standard sound (type '0'), 3D stereo sound (type '1'), or Aureal A3D (type '2'). This defaults to 3D stereo if it is not available ('''Integer''', 0, 1 or 2)
***'''Sixth''' value defines the distance from the origin of 3D sound where it begins to attenuate and is not used with normal non-3D sounds (type 0)('''Integer''')
***'''Seventh''' value sets the distance from the origin of the 3D sound where it is inaudible and is not used with normal non-3D sounds (type 0)('''Integer''')

'''Section ends with #Game Sounds End'''

===#Interface Sounds Start===
Notes
*Interface sounds are not 3D sounds. Use type '0' sounds. The '''Sixth''' and '''Seventh''' entries can be left out of sounds in this section.

Example Line
<pre>$Name: 26 Crane_1.wav, 0, 0.50, 0</pre>

Line starts with ''$Name:'' and has five entries separated by commas except for the first and second entries.

**'''First''' value is the index number of the sound ('''Integer''')
**'''Second''' value is the name of actual sound file ('''String''', filename).
**'''Third''' value sets the file to always preloaded before the mission ('''Integer''', 0 or 1)
**'''Fourth''' value defines the playing volume of the sound in percentages ('''Float''', from 0 to 1)
**'''Fifth''' value sets the sound type to either standard sound (type '0'), 3D stereo sound (type '1'), or Aureal A3D (type '2'). This defaults to 3D stereo if it is not available ('''Integer''', 0, 1 or 2)

'''Section ends with #Interface Sounds End'''

===#Flyby Sounds Start===
Notes
*Each species has two flyby sounds. One for the fighters and one for the bombers.
*Flyby sounds are all 3D sounds of type '1' for the '''Fifth''' value.
*Each flyby sound is defined on a single line that begins with the species name ('''String''', species name, eg. '''$Terran:''').

Retail flyby section
<pre>
#Flyby Sounds Start

$Terran: 0 T_flyby1.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)
$Terran: 1 T_flyby2.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)

$Vasudan: 0 V_flyby1.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)
$Vasudan: 1 V_flyby2.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)

$Shivan: 0 S_flyby1.wav, 0, 0.75, 1, 200, 400 ; * Shivan ship1 flyby player sound (3d sound)
$Shivan: 1 S_flyby2.wav, 0, 0.75, 1, 200, 400 ; * Shivan ship1 flyby player sound (3d sound)

#Flyby Sounds End
</pre>

Line starts with ''$SPECIES:'' and has seven entries separated by commas except for the first and second entries.

**'''First''' value is the label of the flyby sound, usually 0 for the first (small-ship) entry and 1 for the second (large-ship)entry. ('''Integer''')
**'''Second''' value is the name of actual sound file ('''String''', filename).
**'''Third''' value sets the file to always preloaded before the mission ('''Integer''', 0 or 1)
**'''Fourth''' value defines the playing volume of the sound in percentages ('''Float''', from 0 to 1)
**'''Fifth''' value sets the sound type and should be set to 3D stereo sound (type '1') ('''Integer''', 0, 1 or 2)
***'''Sixth''' value defines the distance from the origin of 3D sound where it begins to attenuate (type 0)('''Integer''')
***'''Seventh''' value sets the distance from the origin of the 3D sound where it is inaudible (type 0)('''Integer''')

'''Section ends with #Flyby Sounds End'''

==Sample==
*Retail FreeSpace 2 table

<pre>
;
; sounds.tbl *
;
; file to specify general game sounds
;
; I M P O R T A N T
; **********************************************************
; * *
; ====> DO NOT MODIFY THE ORDER OF THE LISTED SOUNDS <====*
; * *
; **********************************************************
; I M P O R T A N T
;
; If a sound entry appears in this file, there is a hook into the game to
; play the sound. This file can only be modified to change *existing* sounds.
; Talk to a programmer if you want to add brand new sounds. Adding a line to
; this file will not make your sound appear in the game, it will more than
; likely break something.
;
; If you don't want the sound to play, put none.wav as the sound to play.
;
; The fields for a sound entry are:
; 1) unqiue sound signature
; 2) filename of the sound
; 3) flag to indicate sound should always be pre-loaded before a mission
; 4) the default volume (from 0.0 -> 1.0)
; 5) 0 - not 3d 1 - stereo 3D 2 - Aureal A3D (if available), otherwise use stereo 3D
; 6) distance at which sound starts to attenuate (for 3d sounds only)
; 7) distance at which sound is inaudible (for 3d sounds only)
;
#Game Sounds Start
; Misc sounds section ** = Aureal 3d support | * = FS = 3D support
$Name: 0 trk-loop.wav, 0, 0.40, 0 ; Missle tracking to acquire a lock (looped)
$Name: 1 lock.wav, 0, 0.40, 0 ; Missle lock (non-looping)
$Name: 2 cycle.wav, 0, 0.60, 0 ; cycle primary weapon
$Name: 3 cycle.wav, 0, 0.60, 0 ; cycle secondary weapon
$Name: 4 ship_p.wav, 0, 0.30, 0 ; engine sound (as heard in cockpit)
$Name: 5 reveal.wav, 0, 0.40, 0 ; cargo revealed
$Name: 6 breakup.wav, 0, 0.60, 1, 100, 800 ; ship death roll (3d sound)
$Name: 7 boom_3.wav, 0, 0.90, 2, 600, 1200 ; * ship explosion 1 (3d sound)
$Name: 8 beep_2.wav, 0, 0.40, 0 ; target acquried
$Name: 9 switch_1.wav, 0, 0.50, 0 ; energy level change success
$Name: 10 beep_5.wav, 0, 0.50, 0 ; energy level change fail
$Name: 11 switch_2.wav, 0, 0.50, 0 ; energy transfer success
$Name: 12 beep_5.wav, 0, 0.50, 0 ; energy transfer faile
$Name: 13 thr_full.wav, 0, 0.40, 0 ; set full throttle
$Name: 14 thr_off.wav, 0, 0.40, 0 ; set zero throttle
$Name: 15 thr_up.wav, 0, 0.40, 0 ; set 1/3 or 2/3 throttle (up)
$Name: 16 thr_dwn.wav, 0, 0.40, 0 ; set 1/3 or 2/3 throttle (down)
$Name: 17 approach.wav, 0, 0.60, 1, 10, 800 ; dock approach retros (3d sound)
$Name: 18 attach.wav, 0, 0.60, 1, 10, 800 ; dock attach (3d sound)
$Name: 19 detach.wav, 0, 0.60, 1, 10, 800 ; dock detach (3d sound)
$Name: 20 depart.wav, 0, 0.60, 1, 10, 800 ; dock depart retros (3d sound)
$Name: 21 aburn_1.wav, 0, 0.70, 0 ; afterburner engage (3d sound)
$Name: 22 aburn_2.wav, 0, 0.90, 0 ; afterburner burn sound (looped)
$Name: 23 vaporize2.wav, 0, 0.90, 0 ; Destroyed by a beam (vaporized)
$Name: 24 aburn_1f.wav, 0, 0.50, 0 ; afterburner fail (no fuel when aburn pressed)
$Name: 25 alert_2.wav, 0, 0.40, 0 ; heat-seeker launch warning
$Name: 26 m_fail.wav, 0, 0.60, 0 ; tried to fire a missle when none are left
$Name: 27 l_fail.wav, 0, 0.60, 0 ; tried to fire lasers when not enough energy left
$Name: 28 fail.wav, 0, 0.50, 0 ; target fail sound (i.e. press targeting key, but nothing happens)
$Name: 29 beep_1.wav, 0, 0.50, 0 ; squadmate message menu appears
$Name: 30 beep_1.wav, 0, 0.50, 0 ; squadmate message menu disappears
$Name: 31 debris.wav, 0, 0.40, 2, 100, 300 ; ** debris sound (persistant, looping) (3d sound)
$Name: 32 subhit.wav, 0, 0.60, 0 ; subsystem gets destroyed on player ship
$Name: 33 m_load.wav, 0, 0.60, 1, 10, 50 ; missle start load (during rearm/repair) (3d sound)
$Name: 34 m_lock.wav, 0, 0.50, 1, 10, 50 ; missle load (during rearm/repair) (3d sound)
$Name: 35 repair.wav, 0, 0.50, 0 ; ship is being repaired (during rearm/repair) (looped)
$Name: 36 l_hit.wav, 0, 0.90, 0, 30, 100 ; * player ship is hit by laser fire (3d sound)
$Name: 37 m_hit.wav, 0, 0.90, 0, 30, 100 ; * player ship is hit by missile (3d sound)
$Name: 38 cycle.wav, 0, 0.80, 0 ; countermeasure cycle
$Name: 39 s_hit_4.wav, 0, 0.60, 1, 200, 600 ; * shield hit (3d sound)
$Name: 40 s_hit_2.wav, 0, 0.80, 1, 10, 100 ; * player shield is hit (3d sound)
$Name: 41 select.wav, 0, 0.60, 0 ; mouse click
$Name: 42 alert_3.wav, 0, 0.60, 0 ; aspect launch warning
$Name: 43 beep_4.wav, 0, 0.60, 0 ; shield quadrant transfer successful
$Name: 44 wash.wav, 0, 0.80, 1, 200, 400 ; Engine wash looping sound
$Name: 45 warp_1.wav, 0, 0.60, 2, 750, 1500 ; ** warp hole opening up for arriving (3d sound)
$Name: 46 warp_1.wav, 0, 0.60, 2, 750, 1500 ; ** warp hole opening up for departing (3d sound)
$Name: 47 aburn_1f.wav, 0, 0.50, 0 ; player warp has failed
$Name: 48 static.wav, 0, 0.60, 0 ; hud gauge static
$Name: 49 boom_1.wav, 0, 0.90, 1, 600, 1200 ; * ship explosion 2 (3d sound)
$Name: 50 rev1.wav, 0, 0.70, 0 ; ship is warping out in 3rd person
$Name: 51 s_hit_0.wav, 0, 0.70, 1, 100, 200 ; * heavy ship-ship collide sound (3d sound)
$Name: 52 collide.wav, 0, 0.70, 1, 100, 200 ; * light ship-ship collide sound (3d sound)
$Name: 53 s_hit_1.wav, 0, 0.70, 1, 100, 200 ; * shield ship-ship collide overlay sound (3d sound)
$Name: 54 alert_1.wav, 0, 0.50, 0 ; missile threat indicator flashes
$Name: 55 proximity1.wav, 0, 0.70, 0 ; proximity warning (heat seeker)
$Name: 56 proximity2.wav, 0, 0.70, 0 ; proximity warning (aspect)
$Name: 57 directive.wav, 0, 0.70, 0 ; directive complete
$Name: 58 subhit2.wav, 0, 0.90, 1, 250, 800 ; * other ship subsystem destroyed (3d sound)
$Name: 59 atomic.wav, 0, 0.90, 1, 2000, 4000 ; * captial ship explosion (3d sound)
$Name: 60 subhit2.wav, 0, 0.90, 1, 250, 1500 ; * captial ship subsystem destroyed (3d sound)
$Name: 61 warp2.wav, 0, 1.00, 1, 1500, 2000 ; [obsolete] large ship warps out (looping 3d sound)
$Name: 62 ast_lghit.wav, 0, 0.80, 1, 750, 1500 ; ** large asteroid blows up (3d sound)
$Name: 63 ast_smhit.wav, 0, 0.80, 1, 500, 1000 ; ** small asteroid blows up (3d sound)
$Name: 64 cue_voice.wav, 0, 0.90, 0 ; sound to indicate voice is about to start
$Name: 65 end_voice.wav, 0, 0.90, 0 ; sound to indicate voice has ended
$Name: 66 scan.wav, 0, 0.50, 0 ; cargo scanning (looping)
$Name: 67 l_flyby.wav, 0, 0.80, 1, 50, 250 ; * weapon flyby sound
$Name: 68 asteroid.wav, 0, 0.50, 1, 200, 700 ; [obsolete] asteroid sound (persistant, looping) (3d sound)
$Name: 69 warp_open.wav, 0, 1.00, 2, 2000, 4000 ; capital warp hole opening (3d sound)
$Name: 70 warp_close.wav, 0, 1.00, 2, 2000, 4000 ; capital warp hole closing (3d sound)
$Name: 71 rumble.wav, 0, 0.70, 1, 600, 1000 ; LARGE engine ambient
$Name: 72 subspace_left.wav, 0, 0.30, 0 ; subspace ambient sound (left channel) (looping)
$Name: 73 subspace_right.wav, 0, 0.30, 0 ; subspace ambient sound (right channel) (looping)
$Name: 74 Evaded.wav, 0, 0.70, 0 ; "evaded" HUD popup
$Name: 75 rumble.wav, 0, 0.70, 1, 600, 1000 ; HUGE engine ambient
;
; Weapons section
;
$Name: 76 L_Sidearm.wav, 0, 0.50, 1, 50, 400 ; SD-4 Sidearm laser fired
$Name: 77 L_Scalpel.wav, 0, 0.50, 1, 50, 400 ; DR-2 Scalpel fired
$Name: 78 L_Flail2.wav, 0, 0.50, 1, 50, 400 ; Flail II fired
$Name: 79 L_Prom_R.wav, 0, 0.50, 1, 50, 400 ; Prometheus R laser fired
$Name: 80 L_Prom_S.wav, 0, 0.50, 1, 50, 400 ; Prometheus S laser fired
$Name: 81 L_Newton.wav, 0, 0.50, 1, 50, 400 ; GTW-66 Newton Cannon fired
$Name: 82 L_Kayser.wav, 0, 0.55, 1, 50, 400 ; UD-8 Kayser Laser fired
$Name: 83 L_Circle.wav, 0, 0.50, 1, 50, 400 ; GTW-19 Circe laser fired
$Name: 84 L_Lich.wav, 0, 0.50, 1, 50, 400 ; GTW-83 Lich laser fired
$Name: 85 hit_1.wav, 0, 0.90, 1, 200, 800 ; Laser impact
$Name: 86 L_Vasmid.wav, 0, 0.50, 1, 50, 400 ; Subach-HLV Vasudan laser
$Name: 87 m_wasp.wav, 0, 0.80, 1, 50, 400 ; rockeye missile launch
$Name: 88 boom_2.wav, 0, 0.80, 1, 500, 1000 ; missile impact 1
$Name: 89 m_mag.wav, 0, 0.80, 1, 50, 400 ; mag pulse missile launch
$Name: 90 m_fury.wav, 0, 0.80, 1, 50, 400 ; fury missile launch
$Name: 91 m_shrike.wav, 0, 0.80, 1, 50, 400 ; shrike missile launch
$Name: 92 m_angel.wav, 0, 0.80, 1, 50, 400 ; angel fire missile launch
$Name: 93 m_cluster.wav, 0, 0.80, 1, 50, 400 ; cluster bomb launch
$Name: 94 m_clusterb.wav, 0, 0.80, 1, 50, 400 ; cluster baby bomb launch
$Name: 95 m_stiletto.wav, 0, 0.80, 1, 50, 400 ; stiletto bomb launch
$Name: 96 m_tsunami.wav, 0, 0.80, 1, 50, 400 ; tsunami bomb launch
$Name: 97 m_harbinger.wav, 0, 0.80, 1, 50, 400 ; harbinger bomb launch
$Name: 98 m_mega.wav, 0, 0.80, 1, 50, 400 ; mega wokka launch
$Name: 99 counter_1.wav, 0, 0.70, 1, 50, 200 ; countermeasure 1 launch
$Name: 100 l_alien1.wav, 0, 0.60, 1, 50, 400 ; Shivan light laser (3d sound)
$Name: 101 clusterboom.wav, 0, 0.80, 1, 750, 2000 ; shockwave ignition (3d sound)
$Name: 102 m_swarm.wav, 0, 0.70, 1, 50, 400 ; swarm missile sound (3d sound)
$Name: 103 l_alien2.wav, 0, 0.60, 1, 100, 400 ; Shivan heavy laser (3d sound)
$Name: 104 capital4.wav, 0, 0.70, 1, 500, 1500 ; Vasudan SuperCap engine (3d sound)
$Name: 105 capital5.wav, 0, 0.70, 1, 500, 1500 ; Shivan SuperCap engine (3d sound)
$Name: 106 capital6.wav, 0, 0.70, 1, 500, 1500 ; Terran SuperCap engine (3d sound)
$Name: 107 l_vaslight.wav, 0, 0.60, 1, 50, 400 ; Vasudan light laser fired (3d sound)
$Name: 108 l_alien3.wav, 0, 0.60, 1, 50, 400 ; Shivan heavy laser (3d sound)
$Name: 109 shockwave.wav, 0, 1.00, 1, 50, 800 ; ** shockwave impact (3d sound)
$Name: 110 Turret_T1.wav, 0, 0.50, 2, 200, 1000 ; TERRAN TURRET 1
$Name: 111 Turret_T2.wav, 0, 0.50, 2, 200, 1000 ; TERRAN TURRET 2
$Name: 112 Turret_V1.wav, 0, 0.50, 2, 200, 1000 ; VASUDAN TURRET 1
$Name: 113 Turret_V2.wav, 0, 0.50, 2, 200, 1000 ; VASUDAN TURRET 2
$Name: 114 Turret_S1.wav, 0, 0.50, 2, 200, 1000 ; SHIVAN TURRET 1
$Name: 115 paintloop.wav, 0, 0.60, 1, 50, 200 ; targeting laser loop sound
$Name: 116 FlakLaunch.wav, 0, 0.60, 1, 250, 1000 ; Flak Gun Launch
$Name: 117 boom_4.wav, 0, 0.80, 1, 400, 800 ; Flak Gun Impact
$Name: 118 m_emp.wav, 0, 0.60, 1, 50, 400 ; EMP Missle
$Name: 119 Escape.wav, 0, 0.60, 1, 200, 600 ; Escape Pod Drone
$Name: 120 Vaporize1.wav, 0, 0.70, 0 ; Beam Hit 1
$Name: 121 beam_loop.wav, 0, 0.70, 2, 1500, 3000 ; beam loop
$Name: 122 beam_up.wav, 0, 0.70, 2, 1500, 3000 ; beam power up
$Name: 123 beam_down.wav, 0, 0.70, 2, 1500, 3000 ; beam power down
$Name: 124 beam_shot1.wav, 0, 0.70, 2, 1500, 2500 ; Beam shot 1
$Name: 125 beam_shot2.wav, 0, 0.70, 2, 1500, 2500 ; Beam shot 2
;Ship Engine Sounds section
$Name: 126 ship_a1.wav, 0, 0.60, 1, 200, 400 ; Terran fighter engine (3d sound)
$Name: 127 ship_a2.wav, 0, 0.70, 1, 300, 600 ; Terran bomber engine (3d sound)
$Name: 128 ship_a3.wav, 0, 0.80, 1, 400, 800 ; Terran cruiser engine (3d sound)
$Name: 129 ship_b1.wav, 0, 0.70, 1, 200, 400 ; Vasudan fighter engine (3d sound)
$Name: 130 ship_b2.wav, 0, 0.80, 1, 300, 600 ; Vasudan bomber engine (3d sound)
$Name: 131 ship_b3.wav, 0, 0.80, 1, 400, 800 ; Vasudan cruiser engine (3d sound)
$Name: 132 ship_c1.wav, 0, 0.60, 1, 200, 400 ; Shivan fighter engine (3d sound)
$Name: 133 ship_c2.wav, 0, 0.70, 1, 300, 600 ; Shivan bomber engine (3d sound)
$Name: 134 ship_c3.wav, 0, 0.80, 1, 400, 800 ; Shivan cruiser engine (3d sound)
$Name: 135 beacon.wav, 0, 0.60, 1, 300, 600 ; Repair ship beacon/engine sound (3d sound)
$Name: 136 capital1.wav, 0, 0.70, 1, 500, 1500 ; Terran capital engine (3d sound)
$Name: 137 capital2.wav, 0, 0.70, 1, 500, 1500 ; Vasudan capital engine (3d sound)
$Name: 138 capital3.wav, 0, 0.70, 1, 500, 1500 ; Shivan capital engine (3d sound)
; Electrical arc sound fx on the debris pieces
$Name: 139 Arc_01.wav, 0, 0.30, 2, 200, 500 ; ** 0.10 second spark sound effect (3d sound)
$Name: 140 Arc_02.wav, 0, 0.30, 2, 200, 500 ; ** 0.25 second spark sound effect (3d sound)
$Name: 141 Arc_03.wav, 0, 0.30, 2, 200, 500 ; ** 0.50 second spark sound effect (3d sound)
$Name: 142 Arc_04.wav, 0, 0.30, 2, 200, 500 ; ** 0.75 second spark sound effect (3d sound)
$Name: 143 Arc_05.wav, 0, 0.30, 2, 200, 500 ; ** 1.00 second spark sound effect (3d sound)
; Beam Sounds
$Name: 144 BT_LTerSlash.wav, 0, 0.70, 2, 1500, 3000 ; LTerSlash beam loop
$Name: 145 BT_TerSlash.wav, 0, 0.70, 2, 1500, 3000 ; TerSlash beam loop
$Name: 146 BT_SGreen.wav, 0, 0.70, 2, 1500, 3000 ; SGreen beam loop
$Name: 147 BT_BGreen.wav, 0, 0.70, 2, 1500, 3000 ; BGreen beem loop
$Name: 148 BT_BFGreen.wav, 0, 0.70, 2, 1500, 3000 ; BFGreen been loop
$Name: 149 BT_AntiFtr.wav, 0, 0.70, 2, 1500, 3000 ; Antifighter beam loop
$Name: 150 BT_up_1.wav, 0, 0.60, 2, 1500, 3000 ; 1 sec warm up
$Name: 151 BT_up_1.5.wav, 0, 0.60, 2, 1500, 3000 ; 1.5 sec warm up
$Name: 152 BT_up_2.5.wav, 0, 0.60, 2, 1500, 3000 ; 2.5 sec warm up
$Name: 153 BT_up_3.wav, 0, 0.60, 2, 1500, 3000 ; 3 sec warm up
$Name: 154 BT_up_3.5.wav, 0, 0.60, 2, 1500, 3000 ; 3.5 sec warm up
$Name: 155 BT_up_5.wav, 0, 0.60, 2, 1500, 3000 ; 5 sec warm up
$Name: 156 BT_dwn_1.wav, 0, 0.70, 2, 2000, 3000 ; LTerSlash warm down
$Name: 157 BT_dwn_2.wav, 0, 0.70, 2, 2000, 3000 ; TerSlash warm down
$Name: 158 BT_dwn_3.wav, 0, 0.70, 2, 2000, 3000 ; SGreen warm down
$Name: 159 BT_dwn_4.wav, 0, 0.70, 2, 2000, 3000 ; BGreen warm down
$Name: 160 BT_dwn_5.wav, 0, 0.70, 2, 2000, 3000 ; BFGreen warm down
$Name: 161 BT_dwn_6.wav, 0, 0.70, 2, 2000, 3000 ; T_AntiFtr warm down
$Name: 162 Empty, 0, 0.50, 0
$Name: 163 Empty, 0, 0.50, 0
$Name: 164 Empty, 0, 0.50, 0
$Name: 165 Empty, 0, 0.50, 0
$Name: 166 Empty, 0, 0.50, 0
$Name: 167 Empty, 0, 0.50, 0
$Name: 168 Empty, 0, 0.50, 0
$Name: 169 Empty, 0, 0.50, 0
$Name: 170 Empty, 0, 0.50, 0
$Name: 171 Empty, 0, 0.50, 0
$Name: 172 Empty, 0, 0.50, 0
$Name: 173 SupNova1.wav, 0, 1.00, 0 ; SuperNova (distant)
$Name: 174 SupNova2.wav, 0, 1.00, 0 ; SuperNova (shockwave)
$Name: 175 ship_c4.wav, 0, 0.80, 1, 400, 800 ; Shivan large engine (3d sound)
$Name: 176 ship_c5.wav, 0, 0.80, 1, 400, 1000 ; Shivan large engine (3d sound)
$Name: 177 BS_SRed.wav, 0, 0.70, 2, 1500, 3000 ; SRed beam loop
$Name: 178 BS_LRed.wav, 0, 0.70, 2, 1500, 3000 ; LRed beam loop
$Name: 179 BS_AntiFtr.wav, 0, 0.70, 2, 1500, 3000 ; Antifighter beam loop
$Name: 180 Thunder_01.wav, 0, 0.70, 0 ; Thunder 1 sound in neblua
$Name: 181 Thunder_02.wav, 0, 0.70, 0 ; Thunder 2 sound in neblua
$Name: 182 BS_up_1.wav, 0, 0.60, 2, 1500, 3000 ; 1 sec warm up
$Name: 183 BS_up_1.5.wav, 0, 0.60, 2, 1500, 3000 ; 1.5 sec warm up
$Name: 184 BS_up_3.wav, 0, 0.60, 2, 1500, 3000 ; 3 sec warm up
$Name: 185 Commnode.wav, 0, 0.60, 1, 200, 500 ; Shivan Commnode
$Name: 186 Pirate.wav, 0, 0.60, 1, 400, 1000 ; Volition PirateShip
$Name: 187 BS_dwn_1.wav, 0, 0.70, 2, 2000, 3000 ; SRed warm down
$Name: 188 BS_dwn_2.wav, 0, 0.70, 2, 2000, 3000 ; LRed warm down
$Name: 189 BS_dwn_3.wav, 0, 0.70, 2, 2000, 3000 ; AntiFtr warm down
$Name: 190 Inst1.wav, 0, 0.80, 1, 500, 2000 ; Instellation 1
$Name: 191 Inst2.wav, 0, 0.80, 1, 500, 2000 ; Instellation 2

;SCP ADDED SOUNDS START HERE
$Name: 200 m_load.wav, 0, 0.60, 1, 10, 50 ; Ballistic Weapon Rearm Start
$Name: 201 m_lock.wav, 0, 0.50, 1, 10, 50 ; Ballistic Weapon Rearm
;
#Game Sounds End
;
#Interface Sounds Start
$Name: 0 user_c.wav, 0, 0.70, 0 ; mouse click
$Name: 1 empty, 0, 0.70, 0 ; pick up a ship icon (not used)
$Name: 2 load01.wav, 0, 0.60, 0 ; drop a ship icon on a wing slot
$Name: 3 unload01.wav, 0, 0.60, 0 ; drop a ship icon back to the list
$Name: 4 beep_4.wav, 0, 0.70, 0 ; press briefing, ship selection or weapons bar (top-left)
$Name: 5 user_c.wav, 0, 0.70, 0 ; Switching to a new screen, but not commit
$Name: 6 beep_4.wav, 0, 0.70, 0 ; help pressed
$Name: 7 commit.wav, 0, 0.60, 0 ; commit pressed
$Name: 8 user_c.wav, 0, 0.70, 0 ; prev/next pressed
$Name: 9 user_c.wav, 0, 0.70, 0 ; scroll pressed (and scroll)
$Name: 10 fail.wav, 0, 0.70, 0 ; general failure sound for any event
$Name: 11 shipview.wav, 0, 0.50, 0 ; ship animation starts (ie text and ship first appear)
$Name: 12 main_amb.wav, 0, 0.60, 0 ; ambient sound for the Terran main hall (looping)
$Name: 13 vas_amb.wav, 0, 0.60, 0 ; ambient sound for the Vasudan main hall (looping)
$Name: 14 user_a.wav, 0, 0.70, 0 ; brief stage change
$Name: 15 user_i.wav, 0, 0.70, 0 ; brief stage change fail
$Name: 16 beep_3.wav, 0, 0.70, 0 ; selet brief icon
$Name: 17 user_o.wav, 0, 0.50, 0 ; user_over (mouse over a control)
$Name: 18 user_c.wav, 0, 0.70, 0 ; user_click (mouse selects a control)
$Name: 19 reset.wav, 0, 0.70, 0 ; reset (or similar button) pressed
$Name: 20 textdraw.wav, 0, 0.60, 0 ; briefing text wipe
$Name: 21 Lift_Mix.wav, 0, 0.50, 0 ; main hall - elevator
$Name: 22 weapview.wav, 0, 0.60, 0 ; weapon animation starts
$Name: 23 dooropen.wav, 0, 0.50, 0 ; door in main hall opens
$Name: 24 doorclose.wav, 0, 0.50, 0 ; door in main hall closes
$Name: 25 itemdraw.wav, 0, 0.50, 0 ; glow in main hall opens
$Name: 26 Crane_1.wav, 0, 0.50, 0 ; main hall - crane 1
$Name: 27 sub_amb.wav, 0, 0.60, 0 ; ambient sound for menus off the main hall (looping)
$Name: 28 user_c.wav, 0, 0.70, 0 ; popup dialog box appeared
$Name: 29 user_c.wav, 0, 0.70, 0 ; popup dialog box goes away
$Name: 30 1_yes.wav, 0, 1.00, 0 ; voice clip played when volume slider changes
$Name: 31 Crane_2.wav, 0, 0.50, 0 ; main hall - crane 2
$Name: 32 Option1.wav, 0, 0.70, 0 ; main hall options - mouse on
$Name: 33 Option2.wav, 0, 0.70, 0 ; main hall options - mouse off
$Name: 34 Techroom1.wav, 0, 0.70, 0 ; main hall tech room - mouse on
$Name: 35 Techroom2.wav, 0, 0.70, 0 ; main hall tech room - mouse off
$Name: 36 Exitopen.wav, 0, 0.60, 0 ; main hall exit open
$Name: 37 Exitclose.wav, 0, 0.60, 0 ; main hall exit close
$Name: 38 pa_1.wav, 0, 0.50, 0 ; main hall random intercom 1
$Name: 39 pa_2.wav, 0, 0.50, 0 ; main hall random intercom 2
$Name: 40 pa_3.wav, 0, 0.50, 0 ; main hall random intercom 3
$Name: 41 highlight.wav, 0, 0.40, 0 ; spinning highlight in briefing
$Name: 42 noiz.wav, 0, 0.40, 0 ; static in a briefing stage cut
$Name: 43 Camp_on.wav, 0, 0.70, 0 ; main hall campaign - mouse on
$Name: 44 Camp_off.wav, 0, 0.70, 0 ; main hall campaign - mouse off
$Name: 45 V_Hatch_Open.wav, 0, 0.70, 0 ; vasudan hall - exit open
$Name: 46 V_Hatch_Close.wav, 0, 0.70, 0 ; vasudan hall - exit close
$Name: 47 V_Roll_Open.wav, 0, 0.80, 0 ; vasudan hall - hatch open
$Name: 48 V_Roll_Close.wav, 0, 0.80, 0 ; vasudan hall - hatch close
$Name: 49 V_Lift_Up.wav, 0, 0.70, 0 ; vasudan hall - lift up
$Name: 50 V_Lift_Down.wav, 0, 0.70, 0 ; vasudan hall - lift down
$Name: 51 V_Lite_On.wav, 0, 0.70, 0 ; vasudan hall - glow on
$Name: 52 V_Lite_Off.wav, 0, 0.70, 0 ; vasudan hall - glow off
$Name: 53 Skiff.wav, 0, 0.70, 0 ; vasudan hall - skiff loop
$Name: 54 V_Map_On.wav, 0, 0.70, 0 ; vasudan hall - screen on
$Name: 55 V_Map_Off.wav, 0, 0.70, 0 ; vasudan hall - screen off
$Name: 56 V_Head_1.wav, 0, 0.70, 0 ; vasudan hall - vasudan greeting
$Name: 57 V_Head_2.wav, 0, 0.70, 0 ; vasudan hall - vasudan bye
$Name: 58 V_Pa_01.wav, 0, 0.70, 0 ; vasudan hall - vasudan pa 1
$Name: 59 V_Pa_02.wav, 0, 0.70, 0 ; vasudan hall - vasudan pa 2
$Name: 60 V_Pa_03.wav, 0, 0.70, 0 ; vasudan hall - vasudan pa 3
$Name: 61 bup.wav, 0, 0.90, 0 ; bup bup bup-bup bup bup
$Name: 62 thankyou.wav, 0, 0.90, 0 ; thankyou
$Name: 63 V_Exit_Open.wav, 0, 0.70, 0 ; vasudan hall - exit open
$Name: 64 V_Exit_Close.wav, 0, 0.70, 0 ; vasudan hall - exit close
;
#Interface Sounds End
;
; Each species can have up to 4 different flyby sounds
; NOTE : the parse code expects to see exactly 2 sounds for terran, then 2 for vasudan, then 2 for shivan
; the first sound for each species is the fighter/small flyby sound. the second is the bomber/big flyby sound
#Flyby Sounds Start

$Terran: 0 T_flyby1.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)
$Terran: 1 T_flyby2.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)

$Vasudan: 0 V_flyby1.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)
$Vasudan: 1 V_flyby2.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)

$Shivan: 0 S_flyby1.wav, 0, 0.75, 1, 200, 400 ; * SHIVAN ship1 flyby player sound (3d sound)
$Shivan: 1 S_flyby2.wav, 0, 0.75, 1, 200, 400 ; * SHIVAN ship1 flyby player sound (3d sound)

#Flyby Sounds End
</pre>

[[Category:Tables]]

Sounds.tbl

2015-05-08T17:14:45Z

Jg18: updated to reflect m!m's fix for SCP syntax gameplay sound parsing in commit 77ee6f1

{{TableVersion| 77ee6f1 (Git commit)}}

The '''sounds.tbl''' is a file for defining the various sounds played ingame.

This table is one of the [[Modular Tables]] and can be extended with xxx-snd.tbm

[[Tables|List of Tables]]

==Format==
*Table file consists of several sections
*First section defines the sound for the actual game play. It begins at '''#Game Sounds Start''' and ends at'''#Game Sounds End'''
*Second section defines the interface sounds. It starts at '''#Interface Sounds Start''' and ends at '''#Interface Sounds End'''
*Third section defines the flyby sounds for different species. It begins at '''#Flyby Sounds Start''' and ends at '''#Flyby Sounds End'''
*This table has two possible syntax's, the first being the SCP Syntax and the second being the Retail Syntax
**The SCP Syntax is newer, easier to read, and likely preferred for modular tables and extendability
**The Retail Syntax is the syntax used by the retail tables which was kept in place to keep retail compatibility
*Most of the sounds are hardcoded in the engine (that is, the engine expects sound 33 to be the missile rearm sound, as an example). Modders should follow the retail table layout, and not assign sound numbers smaller than 250 to their custom sounds. This avoids index collisions.

==SCP Syntax==
{{Note|Many retail sound names are hardcoded to a specific type of sound, so removing entries is not recommended. However adding new ones or altering existing ones is possible. See the [[Hardcoded sounds|hardcoded sounds]] for a list of which sounds have hardcoded names.}}

In most entries, the name of the file ('''Second''' value) can be replaced with 'empty' if the particular sound index is not in use.

===#Game Sounds Start===
Notes
*Cockpit sounds are in general non-3D sounds
*All the other in-flight sounds are, in general, 3D sounds
*Non-3D sounds do not require the '''+3D Sound''' entries

Example Line
<pre>
$Name: 6
+Filename: breakup
+Preload: no
+Volume: 0.60
+3D Sound:
+Attenuation start: 100
+Attenuation end: 800
</pre>

====$Name:====
*Specifies the sound handle which FSO will use to identify the sound from other tables
*If +nocreate is to be used, it must come after '''$Name:''' and before the '''String'''
*Syntax: '''String'''
{{Warning|
The name may not contain any whitespace (space or tab characters) or the old parsing code will be used.}}

====+nocreate====
*Allows editing of the sound without creating a new sound handle
*Must be placed after '''$Name:''' and before the '''String'''
*Example
**<pre>$Name: +nocreate SoundName</pre>

====+Filename:====
*The name of the actual sound file to play
*If +nocreate is used and you don't want to change the original filename, then use <same> (including the <>) for the filename.
*Syntax: '''String'''

====+Preload:====
*Specifies whether FSO should always preload the sound before the mission or not
*Optional if +nocreate is used
*Syntax: '''Boolean'''

====+Volume:====
*Specifies the volume the sound should be played at as a percentage
*Optional if +nocreate is used
*Syntax: '''Float'''

====+3D Sound:====
*Sets up table syntax for specifying 3D sound options
*If present the sound will be loaded as a 3D sound
*No argument should be specified
*Must be accompanied by '''+Attenuation Start:''' and '''+Attenuation End:'''

====+Attenuation Start:====
*Defines the distance from the origin of the 3D sound where it begins to attenuate
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

====+Attenuation End:====
*Defines the distance from the origin of the 3D sound where it is inaudible
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

'''Section ends with #Game Sounds End'''

===#Interface Sounds Start===
Notes
*Interface sounds are not 3D sounds. You may specify '''+3D Sound:''' properties, but they will be ignored.

Example Line
<pre>
$Name: CraneSound1
+Filename: Crane_1
+Preload: no
+Volume: 0.50
</pre>

====$Name:====
*Specifies the sound handle which FSO will use to identify the sound from other tables
*If +nocreate is to be used, it must come after '''$Name:''' and before the '''String'''
*Syntax: '''String'''
{{Warning|
The name may not contain any whitespace (space or tab characters) or the old parsing code will be used.}}

====+nocreate====
*Allows editing of the sound without creating a new sound handle
*Must be placed after '''$Name:''' and before the '''String'''
*Example
**<pre>$Name: +nocreate SoundName</pre>

====+Filename:====
*The name of the actual sound file to play
*Syntax: '''String'''

====+Preload:====
*Specifies whether FSO should always preload the sound before the mission or not
*Syntax: '''Boolean'''

====+Volume:====
*Specifies the volume the sound should be played at as a percentage
*Syntax: '''Float'''

'''Section ends with #Interface Sounds End'''

===#Flyby Sounds Start===
Notes
*Each species has two flyby sounds. One for the fighters and one for the bombers.
*Flyby sounds are all 3D sounds.
*Each flyby sound is defined on a line that begins with the species name ('''String''', species name, eg. '''$Terran:''').
*'''THE FLYBY SECTION CANNOT USE +nocreate'''
If you want to modify a flyby sound entry of a species in a modular table then you will need to have entries for both types.

Line starts with '''$SPECIES:''' in the place of '''$Name:'''

Example Terran Section
<pre>
$Terran: 0
+Filename: T_flyby1
+Preload: no
+Volume: 0.75
+3D Sound:
+Attenuation start: 200
+Attenuation end: 400

$Terran: 1
+Filename: T_flyby2
+Preload: no
+Volume: 0.75
+3D Sound:
+Attenuation start: 200
+Attenuation end: 400
</pre>

====$Name:====
*'''$Name''' must be replaced with '''$SPECIES''' as from the [[Species_defs.tbl]]
*Specifies the sound handle which FSO will use to identify the sound from other tables
*In this case it will usually be a '''1''' or a '''0'''
*Syntax: '''String'''
{{Warning|
The name may not contain any whitespace (space or tab characters) or the old parsing code will be used.}}

====+Filename:====
*The name of the actual sound file to play
*Syntax: '''String'''

====+Preload:====
*Specifies whether FSO should always preload the sound before the mission or not
*Syntax: '''Boolean'''

====+Volume:====
*Specifies the volume the sound should be played at as a percentage
*Syntax: '''Float'''

====+3D Sound:====
*Sets up table syntax for specifying 3D sound options
*If present the sound will be loaded as a 3D sound
*No argument should be specified
*Must be accompanied by '''+Attenuation Start:''' and '''+Attenuation End:'''

====+Attenuation Start:====
*Defines the distance from the origin of the 3D sound where it begins to attenuate
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

====+Attenuation End:====
*Defines the distance from the origin of the 3D sound where it is inaudible
*Must be preceded by '''+3D Sound:'''
*Syntax: '''Integer'''

'''Section ends with #Flyby Sounds End'''

==Retail Syntax==
{{Note|Many retail sound names are hardcoded to a specific type of sound, so removing entries is not recommended. However adding new ones or altering existing ones is possible. See the [[Hardcoded sounds|hardcoded sounds]] for a list of which sounds have hardcoded names.}}

In most entries, the name of the file ('''Second''' value) can be replaced with 'empty' if the particular sound index is not in use.

===#Game Sounds Start===
Notes
*Cockpit sounds are in general non-3D sounds that ought to be of type '0', however all the other in-flight sounds are in general 3D sounds and ought to of type '1' (or type '2').
*Type 0 sounds do not require the '''Sixth''' and '''Seventh''' entries.

Example Line
<pre>$Name: 6 breakup.wav, 0, 0.60, 1, 100, 800</pre>

Line starts with ''$Name:'' and has seven entries separated by commas except for the first and second entries.

**'''First''' value is the index number of the sound ('''Integer''')
**'''Second''' value is the name of actual sound file ('''String''', filename).
**'''Third''' value sets the file to always preloaded before the mission ('''Integer''', 0 or 1)
**'''Fourth''' value defines the playing volume of the sound in percentages ('''Float''', from 0 to 1)
**'''Fifth''' value sets the sound type to either standard sound (type '0'), 3D stereo sound (type '1'), or Aureal A3D (type '2'). This defaults to 3D stereo if it is not available ('''Integer''', 0, 1 or 2)
***'''Sixth''' value defines the distance from the origin of 3D sound where it begins to attenuate and is not used with normal non-3D sounds (type 0)('''Integer''')
***'''Seventh''' value sets the distance from the origin of the 3D sound where it is inaudible and is not used with normal non-3D sounds (type 0)('''Integer''')

'''Section ends with #Game Sounds End'''

===#Interface Sounds Start===
Notes
*Interface sounds are not 3D sounds. Use type '0' sounds. The '''Sixth''' and '''Seventh''' entries can be left out of sounds in this section.

Example Line
<pre>$Name: 26 Crane_1.wav, 0, 0.50, 0</pre>

Line starts with ''$Name:'' and has five entries separated by commas except for the first and second entries.

**'''First''' value is the index number of the sound ('''Integer''')
**'''Second''' value is the name of actual sound file ('''String''', filename).
**'''Third''' value sets the file to always preloaded before the mission ('''Integer''', 0 or 1)
**'''Fourth''' value defines the playing volume of the sound in percentages ('''Float''', from 0 to 1)
**'''Fifth''' value sets the sound type to either standard sound (type '0'), 3D stereo sound (type '1'), or Aureal A3D (type '2'). This defaults to 3D stereo if it is not available ('''Integer''', 0, 1 or 2)

'''Section ends with #Interface Sounds End'''

===#Flyby Sounds Start===
Notes
*Each species has two flyby sounds. One for the fighters and one for the bombers.
*Flyby sounds are all 3D sounds of type '1' for the '''Fifth''' value.
*Each flyby sound is defined on a single line that begins with the species name ('''String''', species name, eg. '''$Terran:''').

Retail flyby section
<pre>
#Flyby Sounds Start

$Terran: 0 T_flyby1.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)
$Terran: 1 T_flyby2.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)

$Vasudan: 0 V_flyby1.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)
$Vasudan: 1 V_flyby2.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)

$Shivan: 0 S_flyby1.wav, 0, 0.75, 1, 200, 400 ; * Shivan ship1 flyby player sound (3d sound)
$Shivan: 1 S_flyby2.wav, 0, 0.75, 1, 200, 400 ; * Shivan ship1 flyby player sound (3d sound)

#Flyby Sounds End
</pre>

Line starts with ''$SPECIES:'' and has seven entries separated by commas except for the first and second entries.

**'''First''' value is the label of the flyby sound, usually 0 for the first (small-ship) entry and 1 for the second (large-ship)entry. ('''Integer''')
**'''Second''' value is the name of actual sound file ('''String''', filename).
**'''Third''' value sets the file to always preloaded before the mission ('''Integer''', 0 or 1)
**'''Fourth''' value defines the playing volume of the sound in percentages ('''Float''', from 0 to 1)
**'''Fifth''' value sets the sound type and should be set to 3D stereo sound (type '1') ('''Integer''', 0, 1 or 2)
***'''Sixth''' value defines the distance from the origin of 3D sound where it begins to attenuate (type 0)('''Integer''')
***'''Seventh''' value sets the distance from the origin of the 3D sound where it is inaudible (type 0)('''Integer''')

'''Section ends with #Flyby Sounds End'''

==Sample==
*Retail FreeSpace 2 table

<pre>
;
; sounds.tbl *
;
; file to specify general game sounds
;
; I M P O R T A N T
; **********************************************************
; * *
; ====> DO NOT MODIFY THE ORDER OF THE LISTED SOUNDS <====*
; * *
; **********************************************************
; I M P O R T A N T
;
; If a sound entry appears in this file, there is a hook into the game to
; play the sound. This file can only be modified to change *existing* sounds.
; Talk to a programmer if you want to add brand new sounds. Adding a line to
; this file will not make your sound appear in the game, it will more than
; likely break something.
;
; If you don't want the sound to play, put none.wav as the sound to play.
;
; The fields for a sound entry are:
; 1) unqiue sound signature
; 2) filename of the sound
; 3) flag to indicate sound should always be pre-loaded before a mission
; 4) the default volume (from 0.0 -> 1.0)
; 5) 0 - not 3d 1 - stereo 3D 2 - Aureal A3D (if available), otherwise use stereo 3D
; 6) distance at which sound starts to attenuate (for 3d sounds only)
; 7) distance at which sound is inaudible (for 3d sounds only)
;
#Game Sounds Start
; Misc sounds section ** = Aureal 3d support | * = FS = 3D support
$Name: 0 trk-loop.wav, 0, 0.40, 0 ; Missle tracking to acquire a lock (looped)
$Name: 1 lock.wav, 0, 0.40, 0 ; Missle lock (non-looping)
$Name: 2 cycle.wav, 0, 0.60, 0 ; cycle primary weapon
$Name: 3 cycle.wav, 0, 0.60, 0 ; cycle secondary weapon
$Name: 4 ship_p.wav, 0, 0.30, 0 ; engine sound (as heard in cockpit)
$Name: 5 reveal.wav, 0, 0.40, 0 ; cargo revealed
$Name: 6 breakup.wav, 0, 0.60, 1, 100, 800 ; ship death roll (3d sound)
$Name: 7 boom_3.wav, 0, 0.90, 2, 600, 1200 ; * ship explosion 1 (3d sound)
$Name: 8 beep_2.wav, 0, 0.40, 0 ; target acquried
$Name: 9 switch_1.wav, 0, 0.50, 0 ; energy level change success
$Name: 10 beep_5.wav, 0, 0.50, 0 ; energy level change fail
$Name: 11 switch_2.wav, 0, 0.50, 0 ; energy transfer success
$Name: 12 beep_5.wav, 0, 0.50, 0 ; energy transfer faile
$Name: 13 thr_full.wav, 0, 0.40, 0 ; set full throttle
$Name: 14 thr_off.wav, 0, 0.40, 0 ; set zero throttle
$Name: 15 thr_up.wav, 0, 0.40, 0 ; set 1/3 or 2/3 throttle (up)
$Name: 16 thr_dwn.wav, 0, 0.40, 0 ; set 1/3 or 2/3 throttle (down)
$Name: 17 approach.wav, 0, 0.60, 1, 10, 800 ; dock approach retros (3d sound)
$Name: 18 attach.wav, 0, 0.60, 1, 10, 800 ; dock attach (3d sound)
$Name: 19 detach.wav, 0, 0.60, 1, 10, 800 ; dock detach (3d sound)
$Name: 20 depart.wav, 0, 0.60, 1, 10, 800 ; dock depart retros (3d sound)
$Name: 21 aburn_1.wav, 0, 0.70, 0 ; afterburner engage (3d sound)
$Name: 22 aburn_2.wav, 0, 0.90, 0 ; afterburner burn sound (looped)
$Name: 23 vaporize2.wav, 0, 0.90, 0 ; Destroyed by a beam (vaporized)
$Name: 24 aburn_1f.wav, 0, 0.50, 0 ; afterburner fail (no fuel when aburn pressed)
$Name: 25 alert_2.wav, 0, 0.40, 0 ; heat-seeker launch warning
$Name: 26 m_fail.wav, 0, 0.60, 0 ; tried to fire a missle when none are left
$Name: 27 l_fail.wav, 0, 0.60, 0 ; tried to fire lasers when not enough energy left
$Name: 28 fail.wav, 0, 0.50, 0 ; target fail sound (i.e. press targeting key, but nothing happens)
$Name: 29 beep_1.wav, 0, 0.50, 0 ; squadmate message menu appears
$Name: 30 beep_1.wav, 0, 0.50, 0 ; squadmate message menu disappears
$Name: 31 debris.wav, 0, 0.40, 2, 100, 300 ; ** debris sound (persistant, looping) (3d sound)
$Name: 32 subhit.wav, 0, 0.60, 0 ; subsystem gets destroyed on player ship
$Name: 33 m_load.wav, 0, 0.60, 1, 10, 50 ; missle start load (during rearm/repair) (3d sound)
$Name: 34 m_lock.wav, 0, 0.50, 1, 10, 50 ; missle load (during rearm/repair) (3d sound)
$Name: 35 repair.wav, 0, 0.50, 0 ; ship is being repaired (during rearm/repair) (looped)
$Name: 36 l_hit.wav, 0, 0.90, 0, 30, 100 ; * player ship is hit by laser fire (3d sound)
$Name: 37 m_hit.wav, 0, 0.90, 0, 30, 100 ; * player ship is hit by missile (3d sound)
$Name: 38 cycle.wav, 0, 0.80, 0 ; countermeasure cycle
$Name: 39 s_hit_4.wav, 0, 0.60, 1, 200, 600 ; * shield hit (3d sound)
$Name: 40 s_hit_2.wav, 0, 0.80, 1, 10, 100 ; * player shield is hit (3d sound)
$Name: 41 select.wav, 0, 0.60, 0 ; mouse click
$Name: 42 alert_3.wav, 0, 0.60, 0 ; aspect launch warning
$Name: 43 beep_4.wav, 0, 0.60, 0 ; shield quadrant transfer successful
$Name: 44 wash.wav, 0, 0.80, 1, 200, 400 ; Engine wash looping sound
$Name: 45 warp_1.wav, 0, 0.60, 2, 750, 1500 ; ** warp hole opening up for arriving (3d sound)
$Name: 46 warp_1.wav, 0, 0.60, 2, 750, 1500 ; ** warp hole opening up for departing (3d sound)
$Name: 47 aburn_1f.wav, 0, 0.50, 0 ; player warp has failed
$Name: 48 static.wav, 0, 0.60, 0 ; hud gauge static
$Name: 49 boom_1.wav, 0, 0.90, 1, 600, 1200 ; * ship explosion 2 (3d sound)
$Name: 50 rev1.wav, 0, 0.70, 0 ; ship is warping out in 3rd person
$Name: 51 s_hit_0.wav, 0, 0.70, 1, 100, 200 ; * heavy ship-ship collide sound (3d sound)
$Name: 52 collide.wav, 0, 0.70, 1, 100, 200 ; * light ship-ship collide sound (3d sound)
$Name: 53 s_hit_1.wav, 0, 0.70, 1, 100, 200 ; * shield ship-ship collide overlay sound (3d sound)
$Name: 54 alert_1.wav, 0, 0.50, 0 ; missile threat indicator flashes
$Name: 55 proximity1.wav, 0, 0.70, 0 ; proximity warning (heat seeker)
$Name: 56 proximity2.wav, 0, 0.70, 0 ; proximity warning (aspect)
$Name: 57 directive.wav, 0, 0.70, 0 ; directive complete
$Name: 58 subhit2.wav, 0, 0.90, 1, 250, 800 ; * other ship subsystem destroyed (3d sound)
$Name: 59 atomic.wav, 0, 0.90, 1, 2000, 4000 ; * captial ship explosion (3d sound)
$Name: 60 subhit2.wav, 0, 0.90, 1, 250, 1500 ; * captial ship subsystem destroyed (3d sound)
$Name: 61 warp2.wav, 0, 1.00, 1, 1500, 2000 ; [obsolete] large ship warps out (looping 3d sound)
$Name: 62 ast_lghit.wav, 0, 0.80, 1, 750, 1500 ; ** large asteroid blows up (3d sound)
$Name: 63 ast_smhit.wav, 0, 0.80, 1, 500, 1000 ; ** small asteroid blows up (3d sound)
$Name: 64 cue_voice.wav, 0, 0.90, 0 ; sound to indicate voice is about to start
$Name: 65 end_voice.wav, 0, 0.90, 0 ; sound to indicate voice has ended
$Name: 66 scan.wav, 0, 0.50, 0 ; cargo scanning (looping)
$Name: 67 l_flyby.wav, 0, 0.80, 1, 50, 250 ; * weapon flyby sound
$Name: 68 asteroid.wav, 0, 0.50, 1, 200, 700 ; [obsolete] asteroid sound (persistant, looping) (3d sound)
$Name: 69 warp_open.wav, 0, 1.00, 2, 2000, 4000 ; capital warp hole opening (3d sound)
$Name: 70 warp_close.wav, 0, 1.00, 2, 2000, 4000 ; capital warp hole closing (3d sound)
$Name: 71 rumble.wav, 0, 0.70, 1, 600, 1000 ; LARGE engine ambient
$Name: 72 subspace_left.wav, 0, 0.30, 0 ; subspace ambient sound (left channel) (looping)
$Name: 73 subspace_right.wav, 0, 0.30, 0 ; subspace ambient sound (right channel) (looping)
$Name: 74 Evaded.wav, 0, 0.70, 0 ; "evaded" HUD popup
$Name: 75 rumble.wav, 0, 0.70, 1, 600, 1000 ; HUGE engine ambient
;
; Weapons section
;
$Name: 76 L_Sidearm.wav, 0, 0.50, 1, 50, 400 ; SD-4 Sidearm laser fired
$Name: 77 L_Scalpel.wav, 0, 0.50, 1, 50, 400 ; DR-2 Scalpel fired
$Name: 78 L_Flail2.wav, 0, 0.50, 1, 50, 400 ; Flail II fired
$Name: 79 L_Prom_R.wav, 0, 0.50, 1, 50, 400 ; Prometheus R laser fired
$Name: 80 L_Prom_S.wav, 0, 0.50, 1, 50, 400 ; Prometheus S laser fired
$Name: 81 L_Newton.wav, 0, 0.50, 1, 50, 400 ; GTW-66 Newton Cannon fired
$Name: 82 L_Kayser.wav, 0, 0.55, 1, 50, 400 ; UD-8 Kayser Laser fired
$Name: 83 L_Circle.wav, 0, 0.50, 1, 50, 400 ; GTW-19 Circe laser fired
$Name: 84 L_Lich.wav, 0, 0.50, 1, 50, 400 ; GTW-83 Lich laser fired
$Name: 85 hit_1.wav, 0, 0.90, 1, 200, 800 ; Laser impact
$Name: 86 L_Vasmid.wav, 0, 0.50, 1, 50, 400 ; Subach-HLV Vasudan laser
$Name: 87 m_wasp.wav, 0, 0.80, 1, 50, 400 ; rockeye missile launch
$Name: 88 boom_2.wav, 0, 0.80, 1, 500, 1000 ; missile impact 1
$Name: 89 m_mag.wav, 0, 0.80, 1, 50, 400 ; mag pulse missile launch
$Name: 90 m_fury.wav, 0, 0.80, 1, 50, 400 ; fury missile launch
$Name: 91 m_shrike.wav, 0, 0.80, 1, 50, 400 ; shrike missile launch
$Name: 92 m_angel.wav, 0, 0.80, 1, 50, 400 ; angel fire missile launch
$Name: 93 m_cluster.wav, 0, 0.80, 1, 50, 400 ; cluster bomb launch
$Name: 94 m_clusterb.wav, 0, 0.80, 1, 50, 400 ; cluster baby bomb launch
$Name: 95 m_stiletto.wav, 0, 0.80, 1, 50, 400 ; stiletto bomb launch
$Name: 96 m_tsunami.wav, 0, 0.80, 1, 50, 400 ; tsunami bomb launch
$Name: 97 m_harbinger.wav, 0, 0.80, 1, 50, 400 ; harbinger bomb launch
$Name: 98 m_mega.wav, 0, 0.80, 1, 50, 400 ; mega wokka launch
$Name: 99 counter_1.wav, 0, 0.70, 1, 50, 200 ; countermeasure 1 launch
$Name: 100 l_alien1.wav, 0, 0.60, 1, 50, 400 ; Shivan light laser (3d sound)
$Name: 101 clusterboom.wav, 0, 0.80, 1, 750, 2000 ; shockwave ignition (3d sound)
$Name: 102 m_swarm.wav, 0, 0.70, 1, 50, 400 ; swarm missile sound (3d sound)
$Name: 103 l_alien2.wav, 0, 0.60, 1, 100, 400 ; Shivan heavy laser (3d sound)
$Name: 104 capital4.wav, 0, 0.70, 1, 500, 1500 ; Vasudan SuperCap engine (3d sound)
$Name: 105 capital5.wav, 0, 0.70, 1, 500, 1500 ; Shivan SuperCap engine (3d sound)
$Name: 106 capital6.wav, 0, 0.70, 1, 500, 1500 ; Terran SuperCap engine (3d sound)
$Name: 107 l_vaslight.wav, 0, 0.60, 1, 50, 400 ; Vasudan light laser fired (3d sound)
$Name: 108 l_alien3.wav, 0, 0.60, 1, 50, 400 ; Shivan heavy laser (3d sound)
$Name: 109 shockwave.wav, 0, 1.00, 1, 50, 800 ; ** shockwave impact (3d sound)
$Name: 110 Turret_T1.wav, 0, 0.50, 2, 200, 1000 ; TERRAN TURRET 1
$Name: 111 Turret_T2.wav, 0, 0.50, 2, 200, 1000 ; TERRAN TURRET 2
$Name: 112 Turret_V1.wav, 0, 0.50, 2, 200, 1000 ; VASUDAN TURRET 1
$Name: 113 Turret_V2.wav, 0, 0.50, 2, 200, 1000 ; VASUDAN TURRET 2
$Name: 114 Turret_S1.wav, 0, 0.50, 2, 200, 1000 ; SHIVAN TURRET 1
$Name: 115 paintloop.wav, 0, 0.60, 1, 50, 200 ; targeting laser loop sound
$Name: 116 FlakLaunch.wav, 0, 0.60, 1, 250, 1000 ; Flak Gun Launch
$Name: 117 boom_4.wav, 0, 0.80, 1, 400, 800 ; Flak Gun Impact
$Name: 118 m_emp.wav, 0, 0.60, 1, 50, 400 ; EMP Missle
$Name: 119 Escape.wav, 0, 0.60, 1, 200, 600 ; Escape Pod Drone
$Name: 120 Vaporize1.wav, 0, 0.70, 0 ; Beam Hit 1
$Name: 121 beam_loop.wav, 0, 0.70, 2, 1500, 3000 ; beam loop
$Name: 122 beam_up.wav, 0, 0.70, 2, 1500, 3000 ; beam power up
$Name: 123 beam_down.wav, 0, 0.70, 2, 1500, 3000 ; beam power down
$Name: 124 beam_shot1.wav, 0, 0.70, 2, 1500, 2500 ; Beam shot 1
$Name: 125 beam_shot2.wav, 0, 0.70, 2, 1500, 2500 ; Beam shot 2
;Ship Engine Sounds section
$Name: 126 ship_a1.wav, 0, 0.60, 1, 200, 400 ; Terran fighter engine (3d sound)
$Name: 127 ship_a2.wav, 0, 0.70, 1, 300, 600 ; Terran bomber engine (3d sound)
$Name: 128 ship_a3.wav, 0, 0.80, 1, 400, 800 ; Terran cruiser engine (3d sound)
$Name: 129 ship_b1.wav, 0, 0.70, 1, 200, 400 ; Vasudan fighter engine (3d sound)
$Name: 130 ship_b2.wav, 0, 0.80, 1, 300, 600 ; Vasudan bomber engine (3d sound)
$Name: 131 ship_b3.wav, 0, 0.80, 1, 400, 800 ; Vasudan cruiser engine (3d sound)
$Name: 132 ship_c1.wav, 0, 0.60, 1, 200, 400 ; Shivan fighter engine (3d sound)
$Name: 133 ship_c2.wav, 0, 0.70, 1, 300, 600 ; Shivan bomber engine (3d sound)
$Name: 134 ship_c3.wav, 0, 0.80, 1, 400, 800 ; Shivan cruiser engine (3d sound)
$Name: 135 beacon.wav, 0, 0.60, 1, 300, 600 ; Repair ship beacon/engine sound (3d sound)
$Name: 136 capital1.wav, 0, 0.70, 1, 500, 1500 ; Terran capital engine (3d sound)
$Name: 137 capital2.wav, 0, 0.70, 1, 500, 1500 ; Vasudan capital engine (3d sound)
$Name: 138 capital3.wav, 0, 0.70, 1, 500, 1500 ; Shivan capital engine (3d sound)
; Electrical arc sound fx on the debris pieces
$Name: 139 Arc_01.wav, 0, 0.30, 2, 200, 500 ; ** 0.10 second spark sound effect (3d sound)
$Name: 140 Arc_02.wav, 0, 0.30, 2, 200, 500 ; ** 0.25 second spark sound effect (3d sound)
$Name: 141 Arc_03.wav, 0, 0.30, 2, 200, 500 ; ** 0.50 second spark sound effect (3d sound)
$Name: 142 Arc_04.wav, 0, 0.30, 2, 200, 500 ; ** 0.75 second spark sound effect (3d sound)
$Name: 143 Arc_05.wav, 0, 0.30, 2, 200, 500 ; ** 1.00 second spark sound effect (3d sound)
; Beam Sounds
$Name: 144 BT_LTerSlash.wav, 0, 0.70, 2, 1500, 3000 ; LTerSlash beam loop
$Name: 145 BT_TerSlash.wav, 0, 0.70, 2, 1500, 3000 ; TerSlash beam loop
$Name: 146 BT_SGreen.wav, 0, 0.70, 2, 1500, 3000 ; SGreen beam loop
$Name: 147 BT_BGreen.wav, 0, 0.70, 2, 1500, 3000 ; BGreen beem loop
$Name: 148 BT_BFGreen.wav, 0, 0.70, 2, 1500, 3000 ; BFGreen been loop
$Name: 149 BT_AntiFtr.wav, 0, 0.70, 2, 1500, 3000 ; Antifighter beam loop
$Name: 150 BT_up_1.wav, 0, 0.60, 2, 1500, 3000 ; 1 sec warm up
$Name: 151 BT_up_1.5.wav, 0, 0.60, 2, 1500, 3000 ; 1.5 sec warm up
$Name: 152 BT_up_2.5.wav, 0, 0.60, 2, 1500, 3000 ; 2.5 sec warm up
$Name: 153 BT_up_3.wav, 0, 0.60, 2, 1500, 3000 ; 3 sec warm up
$Name: 154 BT_up_3.5.wav, 0, 0.60, 2, 1500, 3000 ; 3.5 sec warm up
$Name: 155 BT_up_5.wav, 0, 0.60, 2, 1500, 3000 ; 5 sec warm up
$Name: 156 BT_dwn_1.wav, 0, 0.70, 2, 2000, 3000 ; LTerSlash warm down
$Name: 157 BT_dwn_2.wav, 0, 0.70, 2, 2000, 3000 ; TerSlash warm down
$Name: 158 BT_dwn_3.wav, 0, 0.70, 2, 2000, 3000 ; SGreen warm down
$Name: 159 BT_dwn_4.wav, 0, 0.70, 2, 2000, 3000 ; BGreen warm down
$Name: 160 BT_dwn_5.wav, 0, 0.70, 2, 2000, 3000 ; BFGreen warm down
$Name: 161 BT_dwn_6.wav, 0, 0.70, 2, 2000, 3000 ; T_AntiFtr warm down
$Name: 162 Empty, 0, 0.50, 0
$Name: 163 Empty, 0, 0.50, 0
$Name: 164 Empty, 0, 0.50, 0
$Name: 165 Empty, 0, 0.50, 0
$Name: 166 Empty, 0, 0.50, 0
$Name: 167 Empty, 0, 0.50, 0
$Name: 168 Empty, 0, 0.50, 0
$Name: 169 Empty, 0, 0.50, 0
$Name: 170 Empty, 0, 0.50, 0
$Name: 171 Empty, 0, 0.50, 0
$Name: 172 Empty, 0, 0.50, 0
$Name: 173 SupNova1.wav, 0, 1.00, 0 ; SuperNova (distant)
$Name: 174 SupNova2.wav, 0, 1.00, 0 ; SuperNova (shockwave)
$Name: 175 ship_c4.wav, 0, 0.80, 1, 400, 800 ; Shivan large engine (3d sound)
$Name: 176 ship_c5.wav, 0, 0.80, 1, 400, 1000 ; Shivan large engine (3d sound)
$Name: 177 BS_SRed.wav, 0, 0.70, 2, 1500, 3000 ; SRed beam loop
$Name: 178 BS_LRed.wav, 0, 0.70, 2, 1500, 3000 ; LRed beam loop
$Name: 179 BS_AntiFtr.wav, 0, 0.70, 2, 1500, 3000 ; Antifighter beam loop
$Name: 180 Thunder_01.wav, 0, 0.70, 0 ; Thunder 1 sound in neblua
$Name: 181 Thunder_02.wav, 0, 0.70, 0 ; Thunder 2 sound in neblua
$Name: 182 BS_up_1.wav, 0, 0.60, 2, 1500, 3000 ; 1 sec warm up
$Name: 183 BS_up_1.5.wav, 0, 0.60, 2, 1500, 3000 ; 1.5 sec warm up
$Name: 184 BS_up_3.wav, 0, 0.60, 2, 1500, 3000 ; 3 sec warm up
$Name: 185 Commnode.wav, 0, 0.60, 1, 200, 500 ; Shivan Commnode
$Name: 186 Pirate.wav, 0, 0.60, 1, 400, 1000 ; Volition PirateShip
$Name: 187 BS_dwn_1.wav, 0, 0.70, 2, 2000, 3000 ; SRed warm down
$Name: 188 BS_dwn_2.wav, 0, 0.70, 2, 2000, 3000 ; LRed warm down
$Name: 189 BS_dwn_3.wav, 0, 0.70, 2, 2000, 3000 ; AntiFtr warm down
$Name: 190 Inst1.wav, 0, 0.80, 1, 500, 2000 ; Instellation 1
$Name: 191 Inst2.wav, 0, 0.80, 1, 500, 2000 ; Instellation 2

;SCP ADDED SOUNDS START HERE
$Name: 200 m_load.wav, 0, 0.60, 1, 10, 50 ; Ballistic Weapon Rearm Start
$Name: 201 m_lock.wav, 0, 0.50, 1, 10, 50 ; Ballistic Weapon Rearm
;
#Game Sounds End
;
#Interface Sounds Start
$Name: 0 user_c.wav, 0, 0.70, 0 ; mouse click
$Name: 1 empty, 0, 0.70, 0 ; pick up a ship icon (not used)
$Name: 2 load01.wav, 0, 0.60, 0 ; drop a ship icon on a wing slot
$Name: 3 unload01.wav, 0, 0.60, 0 ; drop a ship icon back to the list
$Name: 4 beep_4.wav, 0, 0.70, 0 ; press briefing, ship selection or weapons bar (top-left)
$Name: 5 user_c.wav, 0, 0.70, 0 ; Switching to a new screen, but not commit
$Name: 6 beep_4.wav, 0, 0.70, 0 ; help pressed
$Name: 7 commit.wav, 0, 0.60, 0 ; commit pressed
$Name: 8 user_c.wav, 0, 0.70, 0 ; prev/next pressed
$Name: 9 user_c.wav, 0, 0.70, 0 ; scroll pressed (and scroll)
$Name: 10 fail.wav, 0, 0.70, 0 ; general failure sound for any event
$Name: 11 shipview.wav, 0, 0.50, 0 ; ship animation starts (ie text and ship first appear)
$Name: 12 main_amb.wav, 0, 0.60, 0 ; ambient sound for the Terran main hall (looping)
$Name: 13 vas_amb.wav, 0, 0.60, 0 ; ambient sound for the Vasudan main hall (looping)
$Name: 14 user_a.wav, 0, 0.70, 0 ; brief stage change
$Name: 15 user_i.wav, 0, 0.70, 0 ; brief stage change fail
$Name: 16 beep_3.wav, 0, 0.70, 0 ; selet brief icon
$Name: 17 user_o.wav, 0, 0.50, 0 ; user_over (mouse over a control)
$Name: 18 user_c.wav, 0, 0.70, 0 ; user_click (mouse selects a control)
$Name: 19 reset.wav, 0, 0.70, 0 ; reset (or similar button) pressed
$Name: 20 textdraw.wav, 0, 0.60, 0 ; briefing text wipe
$Name: 21 Lift_Mix.wav, 0, 0.50, 0 ; main hall - elevator
$Name: 22 weapview.wav, 0, 0.60, 0 ; weapon animation starts
$Name: 23 dooropen.wav, 0, 0.50, 0 ; door in main hall opens
$Name: 24 doorclose.wav, 0, 0.50, 0 ; door in main hall closes
$Name: 25 itemdraw.wav, 0, 0.50, 0 ; glow in main hall opens
$Name: 26 Crane_1.wav, 0, 0.50, 0 ; main hall - crane 1
$Name: 27 sub_amb.wav, 0, 0.60, 0 ; ambient sound for menus off the main hall (looping)
$Name: 28 user_c.wav, 0, 0.70, 0 ; popup dialog box appeared
$Name: 29 user_c.wav, 0, 0.70, 0 ; popup dialog box goes away
$Name: 30 1_yes.wav, 0, 1.00, 0 ; voice clip played when volume slider changes
$Name: 31 Crane_2.wav, 0, 0.50, 0 ; main hall - crane 2
$Name: 32 Option1.wav, 0, 0.70, 0 ; main hall options - mouse on
$Name: 33 Option2.wav, 0, 0.70, 0 ; main hall options - mouse off
$Name: 34 Techroom1.wav, 0, 0.70, 0 ; main hall tech room - mouse on
$Name: 35 Techroom2.wav, 0, 0.70, 0 ; main hall tech room - mouse off
$Name: 36 Exitopen.wav, 0, 0.60, 0 ; main hall exit open
$Name: 37 Exitclose.wav, 0, 0.60, 0 ; main hall exit close
$Name: 38 pa_1.wav, 0, 0.50, 0 ; main hall random intercom 1
$Name: 39 pa_2.wav, 0, 0.50, 0 ; main hall random intercom 2
$Name: 40 pa_3.wav, 0, 0.50, 0 ; main hall random intercom 3
$Name: 41 highlight.wav, 0, 0.40, 0 ; spinning highlight in briefing
$Name: 42 noiz.wav, 0, 0.40, 0 ; static in a briefing stage cut
$Name: 43 Camp_on.wav, 0, 0.70, 0 ; main hall campaign - mouse on
$Name: 44 Camp_off.wav, 0, 0.70, 0 ; main hall campaign - mouse off
$Name: 45 V_Hatch_Open.wav, 0, 0.70, 0 ; vasudan hall - exit open
$Name: 46 V_Hatch_Close.wav, 0, 0.70, 0 ; vasudan hall - exit close
$Name: 47 V_Roll_Open.wav, 0, 0.80, 0 ; vasudan hall - hatch open
$Name: 48 V_Roll_Close.wav, 0, 0.80, 0 ; vasudan hall - hatch close
$Name: 49 V_Lift_Up.wav, 0, 0.70, 0 ; vasudan hall - lift up
$Name: 50 V_Lift_Down.wav, 0, 0.70, 0 ; vasudan hall - lift down
$Name: 51 V_Lite_On.wav, 0, 0.70, 0 ; vasudan hall - glow on
$Name: 52 V_Lite_Off.wav, 0, 0.70, 0 ; vasudan hall - glow off
$Name: 53 Skiff.wav, 0, 0.70, 0 ; vasudan hall - skiff loop
$Name: 54 V_Map_On.wav, 0, 0.70, 0 ; vasudan hall - screen on
$Name: 55 V_Map_Off.wav, 0, 0.70, 0 ; vasudan hall - screen off
$Name: 56 V_Head_1.wav, 0, 0.70, 0 ; vasudan hall - vasudan greeting
$Name: 57 V_Head_2.wav, 0, 0.70, 0 ; vasudan hall - vasudan bye
$Name: 58 V_Pa_01.wav, 0, 0.70, 0 ; vasudan hall - vasudan pa 1
$Name: 59 V_Pa_02.wav, 0, 0.70, 0 ; vasudan hall - vasudan pa 2
$Name: 60 V_Pa_03.wav, 0, 0.70, 0 ; vasudan hall - vasudan pa 3
$Name: 61 bup.wav, 0, 0.90, 0 ; bup bup bup-bup bup bup
$Name: 62 thankyou.wav, 0, 0.90, 0 ; thankyou
$Name: 63 V_Exit_Open.wav, 0, 0.70, 0 ; vasudan hall - exit open
$Name: 64 V_Exit_Close.wav, 0, 0.70, 0 ; vasudan hall - exit close
;
#Interface Sounds End
;
; Each species can have up to 4 different flyby sounds
; NOTE : the parse code expects to see exactly 2 sounds for terran, then 2 for vasudan, then 2 for shivan
; the first sound for each species is the fighter/small flyby sound. the second is the bomber/big flyby sound
#Flyby Sounds Start

$Terran: 0 T_flyby1.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)
$Terran: 1 T_flyby2.wav, 0, 0.75, 1, 200, 400 ; * Terran ship1 flyby player sound (3d sound)

$Vasudan: 0 V_flyby1.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)
$Vasudan: 1 V_flyby2.wav, 0, 0.85, 1, 200, 400 ; * Vasudan ship1 flyby player sound (3d sound)

$Shivan: 0 S_flyby1.wav, 0, 0.75, 1, 200, 400 ; * SHIVAN ship1 flyby player sound (3d sound)
$Shivan: 1 S_flyby2.wav, 0, 0.75, 1, 200, 400 ; * SHIVAN ship1 flyby player sound (3d sound)

#Flyby Sounds End
</pre>

[[Category:Tables]]

Soulstorm's OS X Launcher

2013-04-01T19:10:03Z

Jg18: updated note for Mountain Lion

== Setting up FreeSpace Open with Soulstorm's OS X launcher ==

After downloading [http://www.hard-light.net/forums/index.php?topic=51391.0 Soulstorm's launcher], open the .dmg and copy the .app to your FreeSpace2 folder.

To fix the "Flag file not found!" error message, click on the "..." button at the bottom of the launcher and then find the FSO build that you want to use. Choose a build that ''doesn't'' have the word "debug" in the name. [Debug builds are only for [http://www.hard-light.net/forums/index.php?topic=56279.msg1180359#msg1180359 generating debug logs]. You shouldn't use them if all you want to do is play.]

Click on the "Customize..." button to change the screen resolution.

If you want to use the checkboxes, [[Command-Line_Reference|this page]] describes what they mean.

If you decide to get the [[MediaVP|MediaVPs]], then to set up the launcher to use them, select the MediaVPs mod (either MediaVPs_3612 or mediavps, depending on which version you got) on the Gameplay + Speed tab.

To use the flags mentioned in the MediaVPs release thread, check these checkboxes (grouped by tab):

* '''Graphics''': -spec, -glow, -env, -missile_lighting, -normal, -3dshockwave (personal preference)
* '''Gameplay + Speed''': -3dwarp, -warp_flash (personal preference)
* '''HUD + Audio''': -snd_preload

You can type the lighting values for the Custom Flags into the white boxes on the Graphics tab.

Important: If you try one launcher and then the other one and then run into problems, see below.

== If you have problems when you use one launcher and then use the other one ==

'''Some necessary background''': The launchers store information about your selected mod and flags in a file called cmdline_fso.cfg. On Mac OS X, that file can be in either your home folder (Macintosh HD/Users/<YourUsername>/Library/FS2_Open/data/) or in your FreeSpace2 folder (by default, Macintosh HD/Applications/FreeSpace2/data/). If there's a cmdline_fso.cfg file in both places, they can conflict with each other and cause problems.

Soulstorm's launcher saves cmdline_fso.cfg in your home folder, and wxLauncher saves it in your FreeSpace2 folder. Therefore, depending on which launcher you want to use, either delete or rename the copy of cmdline_fso.cfg that's in the folder that your launcher of choice ''doesn't'' use.

'''Lion and Mountain Lion users''': The Library folder is hidden by default on Lion and Mountain Lion. To temporarily unhide it, open Finder (or click on the Desktop), and while holding down the Option key, click on the Go menu at the top of the screen, then click on the Library folder option on the dropdown menu.

Getting started

2012-06-27T05:14:40Z

Jg18: removed outdated reference to Turey's installer RIP

'''Getting Started: FreeSpace in a Nutshell'''

Hello and welcome! You've arrived at "FreeSpace in a Nutshell", an article for people new to FreeSpace. This article will provide information about the FreeSpace game series, FreeSpace Open and [[Hard Light Productions]]. There are also instructions for getting the games and installing FreeSpace Open.

==What is FreeSpace?==
FreeSpace is a series of space combat simulation games developed by Volition, Inc. and published by Interplay Entertainment. The games take place in the 24th century. Mankind, referred to as Terrans, has developed means for space traveling, further fueled by the discovery of subspace which makes interstellar travel not only possible but also fast and easy. As a result the Terrans have expanded their territory, eventually encountering another bipedal, sentient species; the Vasudans. However, due to cultural differences and difficulties in communicating with each other, the Galactic Terran Alliance (GTA) and the Parliamentary Vasudan Empire (PVE) end up fighting a war that lasts for 14 years.

===FreeSpace 1===
Descent: FreeSpace — The Great War (also known as Conflict: FreeSpace — The Great War) is the first part of the series, released in 1998. The player is a pilot for the Galactic Terran Alliance. The GTA and the PVN have waged a war for 14 years and there doesn't seem to be an end in sight. However, suddenly a third race appears. These aliens, designated Shivans, are technologically superior, do not respond to diplomacy, and stage attacks against both the Terrans and the Vasudans. As a result, the GTA and PVN forge a truce and join forces in order to stop these alien invaders.

FreeSpace 1 was well-received in its time by critics and players. Though it didn't offer much innovation in terms of gameplay and story, all aspects of the game worked well. The controls were easy to assume and the plot was quite compelling, as well as leaving a few questions in the air. Also crucial to the success of FS1 was the excellent mod support. Mod tools were released for the use of players and the game itself shipped with FreeSpace Editor (FRED) that allowed every player to design and create their own missions.

It is good to note that although in certain regions the full title of the game is ''Descent: FreeSpace – The Great War'', FS1 has very little to do with the Descent game series. The prefixes "Descent" and "Conflict" were used in some titles because there was already an archive tool called FreeSpace on the market.

===Silent Threat===
''Silent Threat'' is an expansion for ''FreeSpace 1'', also released in 1998. It offered a few new ships and weapons and a campaign regarding a rogue faction within the intelligence branch of the GTA. ''Silent Threat'' was considered as a decent expansion pack. The main campaign suffered from bugs, weird plot development and generic mission designs, but was compensated by the selected user-made mission that were also included.

===FreeSpace 2===
''FreeSpace 2'' was released in 1999 and continued the story 32 years after the events of FS1. The Terrans and Vasudans have increased their cooperation that started during the events of FS1, eventually culminating in the formation of the Galactic Terran-Vasudan Alliance (GTVA). However, not everyone appreciates the situation. A rebel group known as the Neo-Terran Front wages a war against the GTVA, because they do not see a future for the Terran race with the Vasudans.

In terms of gameplay and contents, FreeSpace 2 unsurprisingly improved upon what FreeSpace 1 had offered. The gameplay as such remained the same, but new features were added. Among these were beam weapons for capital ships and missions taking place in nebula environments. Storywise FreeSpace 2 was somewhat different from FS1. Sometimes compared to '' The Empire Strikes Back'', it didn't have a clear and happy ending, but instead left a number of questions floating in the air, puzzling and frustrating the fans.

Though critically appraised, ''FreeSpace 2'' was not a commercial success, largely because of the poor advertisement. Many fans of ''FreeSpace 1'' were actually surprised to hear that ''FreeSpace 2'' had been published because the only real source for this information was through game reviews.

===FreeSpace 3?===
There is no ''FreeSpace 3''. Volition was bought by THQ in 2000, with the licenses remaining with Interplay. Volition couldn't create a new game in the series and Interplay was not interested in publishing space simulation games because the genre was deemed dead. More information about FreeSpace 3 and related things can be read from [http://homepage.ntlworld.com/karajorma/FAQ/general.html#WhenFS3 Karajorma's FreeSpace FAQ].

===Where to get the games===
Though the FreeSpace games are old, they are far from lost. [http://www.gog.com/ Good Old Games] (GOG) sells numerous old classic games, including ''FreeSpace'', ''Silent Threat'', and ''FreeSpace 2''. People who do not yet own these games are recommended to buy them from Good Old Games, because GOG's games are cheap ($5.99 or $9.99), DRM-free and completely legal.

==The FreeSpace Source Code Project==
After Volition was bought by THQ, they no longer had any use for the game engine, since they couldn't develop new FreeSpace games. Volition released the source code of the FS2 game engine in 2002 so that FreeSpace fans could do what they wanted with it. A group of coders joined forces and formed the FreeSpace 2 Source Code Project (SCP) that began to, and still continues to, improve the game engine. The new open source game engine, known as FreeSpace Open (FSO), has several distingushing features that include:
*Linux and Mac OS X support
*OpenGL support
*OpenAL positional audio support
*Easy mod installation
*OGG support
*Hardware transform, clipping, and lighting

===The FreeSpace Upgrade Project===
While the SCP improve the code of the game engine to enable new and exciting features, the FreeSpace Upgrade Project (FSU) creates material that takes advantage of the improved game engine. The FSU improves the ships, effects and background elements of FreeSpace 2 continuously. Every now and then these improvements are released as a pack. Known as MediaVPs, these assorted improvements enhance the graphics of the game drastically. Though [[Screenshots|screenshots]] give some idea of what the MediaVPs can do, the best way is to experience them in-game.

===Games based on the FSO engine===
In addition to improving the original FS2, the FSO engine has also made it possible for people to create new space sim games. for a list of FSO-based games, see [[Total conversions]]. Note that all of these games are standalone, which means that they do not require the original FS2.

==Hard Light Productions==
Hard Light Productions (HLP) is the most active online FreeSpace community. HLP consists of hundreds of dedicated FreeSpace fans, with everyone contributing to the community in one or more ways. Members of HLP are
*Coders, who continuously improve the FSO game engine to include new and exciting features, as well as fix bugs in the game engine
*Modellers, who create new ship models and improve old ones
*Texture artists, who make textures for new and old ships
*Effect artists, who create effects such as weapons fire and afterburner trails
*FREDders, who use the FreeSpace Editor to create new missions and campaigns for people to play
*Support people, who help players with any problems regarding FreeSpace
*Players, who keep FreeSpace alive by playing the game year after year.

HLP has forums for the SCP, where new versions of the FSO game engine are released. People can also request new features, as well as post their contributions in the FSO code. HLP also has a board for the FSU project. This board has release threads for the latest MediaVPs, as well as other graphical updates.

In addition to these two important sections, HLP has boards for the following aspects:
*FreeSpace & FreeSpace Open Support - for any technical problems and questions related to FreeSpace
*FREDding - discussion about the FreeSpace Editor
*Modding - discussion about creating various modifications
*Multiplayer - discussion about FS2 multiplayer, accompanied by schedules
*Several mods and total conversions.

Registering to HLP is free and highly recommended. Though viewing the forums is possible as a guest, only registered members can post in the forums and ask any questions they might have. And HLP is notorious for responding to questions quickly, sometimes within minutes.

==Installing FreeSpace Open==
Installing FreeSpace Open is not rocket science as long as you follow the proper guidelines.

===Installer===
The installer that used to exist (Turey's) no longer works. A new installer is being worked on, but it isn't finished yet. So for now, manual installation is the only install option. Don't worry, though, since manual installation is pretty easy.

===Manual installation===
If you want to set things up yourself and possibly learn some things about the game in the process, you can install FSO manually. There are manual installation instructions for [http://www.hard-light.net/forums/index.php?topic=78710.0 Windows], [http://www.hard-light.net/forums/index.php?topic=79545.0 Linux], and [http://www.hard-light.net/forums/index.php?topic=79546.0 Mac OS X] among the stickied threads in the [http://www.hard-light.net/forums/index.php?board=7.0 General FreeSpace Discussion board], as well as a vast amount of [http://www.hard-light.net/forums/index.php?topic=56279.0 troubleshooting help] and some additional information on [[Installing FreeSpace 2 Open|this page]]. Don't think about manual installation as a 1337 h4x0r thing: there's more work involved, but none of it is hard.

==Post-installation instructions==
After you've installed FSO, there are some things you need to do in order to enjoy FSO to its fullest (these steps are also mentioned in the manual installation instructions mentioned earlier):

*Open the Launcher and click the "Browse" button at the top.
*Select fs2_open_3_6_12_INF_r.exe (do not use a -d or -debug build) and click OK.
*Open the Audio/Joystick tab and make sure that Generic Software is selected.
*Open the Video tab and make sure that OpenGL and 32-bit colors are selected.
*If you've installed the MediaVPs (the graphical updates):
**Open the MOD tab.
***Click "Select MOD" and select the "mediavps_3612" folder. Just select the folder, you do not need to select files inside it.
**Open the Features tab of the Launcher.
***Select "Graphics" as the list type.
***Tick at least "Enable specular", "Enable glowmaps", "Enable environment maps", and "Enable normal maps".
***Select "Gameplay" as the list type.
***Tick "Use models for ship selection" and "Use models for weapon selection".
*Save the changes by clicking "Apply" at the bottom of the Launcher.
*Start the game by clicking "Run" (it is easiest to always use the Launcher to start FSO, so you may want to create a shortcut of it to your desktop).
**If this is your very first time running the game, you'll be asked for a "callsign", that is, a name for your pilot/profile. Type it and press Enter. In subsequent runs, a list of pilots is shown here and you can select the one you like.
**When you get to the main hall, press F2, then select "Detail" from the top of the screen.
***Max all the settings in the "Detail" screen, unless you know what you're doing and have some compelling reason to do otherwise. These settings affect the quality of the graphics even when you are using everything the MediaVPs and the FSO engine provide.

==Related links==
Here are a few useful FreeSpace-related links.

*[http://www.gog.com/en/gamecard/freespace_2 FreeSpace 2 at Good Old Games] - The best place to buy FreeSpace 2 from.
*[http://www.hard-light.net/forums/index.php/topic,56279.0.html The FreeSpace Troubleshooting FAQ] - A FAQ that includes solutions to all the most common problems with FreeSpace, FreeSpace 2 and FreeSpace Open. If you have any problems with the games, start here.
*[http://www.freespacemods.net/ FreeSpaceMods.net] - A site that hosts a ton of FreeSpace-related things, including campaigns, mods and total conversions.
*[http://www.hard-light.net/ Hard-Light Productions.net] - The largest FreeSpace community on the web, where most modders and coders are available to provide help.

[[Category:Main]]
[[Category:The games|*]]

Sample Lighting Settings

2012-04-23T21:44:34Z

Jg18: normalized Woolie Wool's settings to have the same order as other sample settings (helpful for the launcher)

This page documents some sample lighting settings. These must be entered into the optional command line parameters to have any effect. Best results are always achieved using the MediaVPs and with glowmaps, shinemaps, normal maps and environment maps turned on. Please consult the [[Command-Line Reference#Lighting|Command Line Reference]] page for specific notes on these settings.

==FreeSpace Engine Default Settings==
These are the Engine defaults used when no settings are specified as shown [[Command-Line_Reference#Lighting|here]], for easy reference.
*-ambient_factor 128
*-spec_exp 16
*-spec_point 1.0
*-spec_static 1.0
*-spec_tube 1.0
*-ogl_spec 80
*-bloom_intensity 75

==Recommended "Baseline" Settings==
These are the recommended light settings as mentioned [[Command-Line_Reference#Lighting|here]], for easy reference.
* -ambient_factor 75
* -spec_exp 11
* -spec_point 0.6
* -spec_static 0.8
* -spec_tube 0.4
* -ogl_spec 60

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 75 -spec_exp 11 -spec_point 0.6 -spec_static 0.8 -spec_tube 0.4 -ogl_spec 60}}

==DaBrain's Settings==
[[Image:Lighting-db1.jpg|thumb|DaBrain's settings feature relatively even lighting with a low specular value.]]
*-ambient_factor 10
*-no_emissive_light
*-spec_exp 7.0
*-spec_point 8.6
*-spec_static 12.8
*-spec_tube 5.0

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 10 -no_emissive_light -spec_exp 7.0 -spec_point 8.6 -spec_static 12.8 -spec_tube 5.0}}

==Herra Tohtori's Settings==
[[Image:Lighting-herra.jpg|thumb|Herra Tohtori's settings feature high specularity and glossiness.]]
*-ambient_factor 35
*-no_emissive_light
*-spec_exp 15
*-spec_point 1.2
*-spec_static 1.5
*-spec_tube 1.5
*-ogl_spec 20

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 35 -no_emissive_light -spec_exp 15 -spec_point 1.2 -spec_static 1.5 -spec_tube 1.5 -ogl_spec 20}}

==CKid's Settings==
[[Image:Lighting-ckid.jpg|thumb|CKid's settings adds emphasis on glowmaps and normal maps.]]
*-ambient_factor 35
*-no_emissive_light
*-spec_exp 16.7
*-spec_point 0.6
*-spec_static 0.9
*-spec_tube 1

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 35 -no_emissive_light -spec_exp 16.7 -spec_point 0.6 -spec_static 0.9 -spec_tube 1}}

==ColeCampbell666's Settings==
[[Image:Lighting-cc666.jpg|thumb|ColeCampbell666's settings result in a very dark environment with most of the lighting coming from weapons fire.]]
*-ambient_factor 0
*-no_emissive_light
*-spec_exp 11
*-spec_point .6
*-spec_static .8
*-spec_tube .4
*-ogl_spec 80

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 0 -no_emissive_light -spec_exp 11 -spec_point .6 -spec_static .8 -spec_tube .4 -ogl_spec 80}}

==Castor's Settings==
[[Image:Lighting-castor.jpg|thumb|''"The thing with 'darker' settings is that the lower you go, the more dependent it will be on the quality/settings of the particular display you are viewing it on."'' -- Castor]]
*-ambient_factor 75
*-spec_exp 7.0
*-spec_point 8.6
*-spec_static 3.0
*-spec_tube 5.0

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 75 -spec_exp 7.0 -spec_point 8.6 -spec_static 3.0 -spec_tube 5.0}}

==Spidey's Settings==
[[Image:Lighting-spidey.jpg|thumb|Spidey's settings nicely balance emphasis on diffuse, specular, and normal maps.]]
*-ambient_factor 5
*-spec_exp 15
*-spec_point 1.2
*-spec_static 1.7
*-spec_tube 1.5
*-ogl_spec 50

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 5 -spec_exp 15 -spec_point 1.2 -spec_static 1.7 -spec_tube 1.5 -ogl_spec 50}}

==Woolie Wool's Settings==
[[Image:Lighting-woolie.png|thumb|Woolie Wool's settings use a very focused specular lighting to emphasize the normal maps and model contours, and a high ambient light setting to make lighting more dependent on the mission settings.]]
*-ambient_factor 105
*-no_emissive_light
*-spec_exp 9
*-spec_point 0.3
*-spec_static 0.8
*-spec_tube 0.7
*-ogl_spec 120

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 105 -no_emissive_light -spec_exp 9 -spec_point 0.3 -spec_static 0.8 -spec_tube 0.7 -ogl_spec 120}}

[[Category:Source Code Project]]

Portal:FRED

2012-04-18T03:03:42Z

Jg18: corrected FRED_Open, removed outdated link to FRED builds, explained where builds can be found

{| border=0 align=center cellpadding=4 cellspacing=0 width=95% style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! style="color: white; height: 30px; background: #512020; 70%;"|'''The FRED Portal'''
|}

{| border=0 align=right cellpadding=4 cellspacing=0 width=20% style="margin: 0 0 1em 1em; background: #302020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! style="color: white; height: 30px; background: #512020; 70%;"|'''''Learning FRED'''''
|-
! style="color: white; height: 30px; 70%;"|[[5 easy steps towards your FREDucation|5 Easy Steps]]
|-
! style="color: white; height: 30px; 70%;"|[[:Category:FRED Tips|FRED Hints and Tips]]
|-
! style="color: white; height: 30px; 70%;"|[[:Category:FRED Mistakes|Common FRED Mistakes]]
|-
! style="color: white; height: 30px; 70%;"|[[:Category:FRED Examples|FRED Examples]]
|-
! style="color: white; height: 30px; 70%;"|[http://fredzone.hard-light.net/freddocs/ Volition's FRED2 Tutorial]
|-
! style="color: white; height: 30px; background: #512020; 70%;"|'''''SEXPs'''''
|-
! style="color: white; height: 30px; 70%;"|[[Retail SEXPs]]
|-
! style="color: white; height: 30px; 70%;"|[[SCP SEXPs]]
|-
! style="color: white; height: 30px; background: #512020; 70%;"|'''''Highlighted FRED Features'''''
|-
! style="color: white; height: 30px; 70%;"|[[Skybox|Skybox]]
|-
! style="color: white; height: 30px; 70%;"|[[Fiction Viewer]]
|-
! style="color: white; height: 30px; 70%;"|[[FRED Command Line Reference|Command Line Options]]
|-
! style="color: white; height: 30px; 70%;"|[[Variables|Variables]]
|-
! style="color: white; height: 30px; 70%;"|[[Improved Team Loadout|Improved Team Loadout]]
|-
! style="color: white; height: 30px; 70%;"|[[Minor FRED Features|List of Minor Features]]
|-
! style="color: white; height: 30px; 70%;"|[[Tutorial - Autopilot missions|Tutorial - Autopilot missions]]
|-
! style="color: white; height: 30px; 70%;"|[[Counting with variables|Counting with Variables]]
|-
! style="color: white; height: 30px; 70%;"|[[Tutorial - In-Mission Jumps|Tutorial - In-Mission Jumps]]
|-
! style="color: white; height: 30px; background: #512020; 70%;"|'''''Mission Designer's Reference'''''
|-
! style="color: white; height: 30px; 70%;"|[[Nebula background|Nebula Backgrounds]]
|-
! style="color: white; height: 30px; 70%;"|[[Friendly wing names|Friendly Wing Names]]
|-
! style="color: white; height: 30px; 70%;"|[[Enemy wing names|Enemy Wing Names]]
|-
! style="color: white; height: 30px; 70%;"|[[FreeSpace 1 Ship Database]]
|-
! style="color: white; height: 30px; 70%;"|[[FreeSpace 2 Ship Database]]
|-
! style="color: white; height: 30px; 70%;"|[[Fighter squadrons]]
|-
! style="color: white; height: 30px; 70%;"|[[Stars and Planets|Stars and Planets]]
|-
! style="color: white; height: 30px; 70%;"|[[Official Volition Node Map|Nodemap]]
|-
! style="color: white; height: 30px; background: #512020; 70%;"|'''''FRED Troubleshooting'''''
|-
! style="color: white; height: 30px; 70%;"|[[Common FRED Issues|Common Issues FAQ]]
|-
|}

Welcome to the FRED portal. Here you will find tips, guides, links, reference material, and other information regarding the FreeSpace Editor and mission design. What you will ''not'' find here is information on modding FreeSpace. For that, please see the [[Portal:Modding|Modding Portal]]. 

For a list of FRED-related topics, [[List of FRED-related topics|click here]] or browse the [[:Category:FRED|FRED category]].

===The Editor===
[[Image:FRED_small.jpg|left|350px|thumb|FRED main window]]
FRED ''(main window pictured left)'' is the editor developed and used by [[Volition]] to make the missions and campaigns of both FreeSpace games. As such, FRED is very powerful, once the initial learning period is over. Unlike mission and level editors released for other games, no functionality was removed from FRED.

FRED is a fully 3D editor, allowing placement of objects on all axes (X, Y, and Z), has full symbolic expression (SEXP) scripting support, allows the inclusion of voice acting for briefings and mission messages, can create both subspace and nebula missions, contains a full-fledged campaign editor, including the ability to add cutscenes, and much more.

===Versions===
There are actually three versions of this editor: FRED, which was the original editor supplied with ''Descent: FreeSpace - The Great War'' and is largely obsolete now; FRED2, which was the updated editor supplied with ''FreeSpace 2'', and finally FRED2_Open, which is the [[Source Code Project|open source]] version of the editor and the only one to support the many additions and improvements made, since the source code of FreeSpace 2 was released.

The information found on these pages refers primarily to FRED2_Open, as it is the most recent version and the only one continually updated with support for new features, but some reference material is available for FRED2. The general continuity material in the "Mission Designer's Reference" section is valid for all versions of the editor. 

The best way to become familiar with FRED2, and by association FRED2_Open, is to complete the FRED walkthrough, provided with the retail version of FreeSpace 2. The walkthrough covers everything needed to design a working mission, but it may not be available to those who do not own the retail version of FreeSpace 2. To alleviate this problem, a link to the online version of the walkthrough, without the sample mission, is provided below. Additional resources for FRED users of all skill levels are available in this section, with material in the "Learning FRED" section being geared specifically toward beginners.

Also, keep in mind that FRED2_Open is under constant development. This can create difficulties in keeping this section up-to-date, but as new features are added to the editor, the information box below will be updated to reflect the most recent changes.

FRED2_Open builds are included with every released Windows build of FreeSpace Open (FSO), whether the release is an official (final) release, a release candidate, or a nightly build. Please see the [http://www.hard-light.net/forums/index.php?board=50.0 Source Code Project forum] and the [http://www.hard-light.net/forums/index.php?board=173.0 Nightly Builds forum] for builds. Note that during a release candidate process, new nightly builds are not released.

{{Recent FRED Additions}}
==See Also==
*[[The FRED Academy]]

==Related Links==
*[[Portal:Modding|The FreeSpace Modding Portal]]
*[[User-made Campaigns]]

==External Links==
*[http://www.hard-light.net/forums/index.php/board,89.0.html FRED Forum]
*[http://fredzone.hard-light.net/freddocs/ Volition's FRED2 Tutorial]
__NOTOC__
[[Category:FreeSpace Wiki Portals]]
[[Category:Modding]]
[[Category:FRED|*]]

Getting started

2012-01-09T00:57:32Z

Jg18: reduced prominence of link to wiki page, which at present is not as complete and as up-to-date as the forum tutorials

'''Getting Started: FreeSpace in a Nutshell'''

Hello and welcome! You've arrived at "FreeSpace in a Nutshell", an article for people new to FreeSpace. This article will provide information about the FreeSpace game series, FreeSpace Open and [[Hard Light Productions]]. There are also instructions for getting the games and installing FreeSpace Open.

==What is FreeSpace?==
FreeSpace is a series of space combat simulation games developed by Volition, Inc. and published by Interplay Entertainment. The games take place in the 24th century. Mankind, referred to as Terrans, has developed means for space traveling, further fueled by the discovery of subspace which makes interstellar travel not only possible but also fast and easy. As a result the Terrans have expanded their territory, eventually encountering another bipedal, sentient species; the Vasudans. However, due to cultural differences and difficulties in communicating with each other, the Galactic Terran Alliance (GTA) and the Parliamentary Vasudan Empire (PVE) end up fighting a war that lasts for 14 years.

===FreeSpace 1===
Descent: FreeSpace — The Great War (also known as Conflict: FreeSpace — The Great War) is the first part of the series, released in 1998. The player is a pilot for the Galactic Terran Alliance. The GTA and the PVN have waged a war for 14 years and there doesn't seem to be an end in sight. However, suddenly a third race appears. These aliens, designated Shivans, are technologically superior, do not respond to diplomacy, and stage attacks against both the Terrans and the Vasudans. As a result, the GTA and PVN forge a truce and join forces in order to stop these alien invaders.

FreeSpace 1 was well-received in its time by critics and players. Though it didn't offer much innovation in terms of gameplay and story, all aspects of the game worked well. The controls were easy to assume and the plot was quite compelling, as well as leaving a few questions in the air. Also crucial to the success of FS1 was the excellent mod support. Mod tools were released for the use of players and the game itself shipped with FreeSpace Editor (FRED) that allowed every player to design and create their own missions.

It is good to note that although in certain regions the full title of the game is ''Descent: FreeSpace – The Great War'', FS1 has very little to do with the Descent game series. The prefixes "Descent" and "Conflict" were used in some titles because there was already an archive tool called FreeSpace on the market.

===Silent Threat===
''Silent Threat'' is an expansion for ''FreeSpace 1'', also released in 1998. It offered a few new ships and weapons and a campaign regarding a rogue faction within the intelligence branch of the GTA. ''Silent Threat'' was considered as a decent expansion pack. The main campaign suffered from bugs, weird plot development and generic mission designs, but was compensated by the selected user-made mission that were also included.

===FreeSpace 2===
''FreeSpace 2'' was released in 1999 and continued the story 32 years after the events of FS1. The Terrans and Vasudans have increased their cooperation that started during the events of FS1, eventually culminating in the formation of the Galactic Terran-Vasudan Alliance (GTVA). However, not everyone appreciates the situation. A rebel group known as the Neo-Terran Front wages a war against the GTVA, because they do not see a future for the Terran race with the Vasudans.

In terms of gameplay and contents, FreeSpace 2 unsurprisingly improved upon what FreeSpace 1 had offered. The gameplay as such remained the same, but new features were added. Among these were beam weapons for capital ships and missions taking place in nebula environments. Storywise FreeSpace 2 was somewhat different from FS1. Sometimes compared to '' The Empire Strikes Back'', it didn't have a clear and happy ending, but instead left a number of questions floating in the air, puzzling and frustrating the fans.

Though critically appraised, ''FreeSpace 2'' was not a commercial success, largely because of the poor advertisement. Many fans of ''FreeSpace 1'' were actually surprised to hear that ''FreeSpace 2'' had been published because the only real source for this information was through game reviews.

===FreeSpace 3?===
There is no ''FreeSpace 3''. Volition was bought by THQ in 2000, with the licenses remaining with Interplay. Volition couldn't create a new game in the series and Interplay was not interested in publishing space simulation games because the genre was deemed dead. More information about FreeSpace 3 and related things can be read from [http://homepage.ntlworld.com/karajorma/FAQ/general.html#WhenFS3 Karajorma's FreeSpace FAQ].

===Where to get the games===
Though the FreeSpace games are old, they are far from lost. [http://www.gog.com/ Good Old Games] (GOG) sells numerous old classic games, including ''FreeSpace'', ''Silent Threat'', and ''FreeSpace 2''. People who do not yet own these games are recommended to buy them from Good Old Games, because GOG's games are cheap ($5.99 or $9.99), DRM-free and completely legal.

==The FreeSpace Source Code Project==
After Volition was bought by THQ, they no longer had any use for the game engine, since they couldn't develop new FreeSpace games. Volition released the source code of the FS2 game engine in 2002 so that FreeSpace fans could do what they wanted with it. A group of coders joined forces and formed the FreeSpace 2 Source Code Project (SCP) that began to, and still continues to, improve the game engine. The new open source game engine, known as FreeSpace Open (FSO), has several distingushing features that include:
*Linux and Mac OS X support
*OpenGL support
*OpenAL positional audio support
*Easy mod installation
*OGG support
*Hardware transform, clipping, and lighting

===The FreeSpace Upgrade Project===
While the SCP improve the code of the game engine to enable new and exciting features, the FreeSpace Upgrade Project (FSU) creates material that takes advantage of the improved game engine. The FSU improves the ships, effects and background elements of FreeSpace 2 continuously. Every now and then these improvements are released as a pack. Known as MediaVPs, these assorted improvements enhance the graphics of the game drastically. Though [[Screenshots|screenshots]] give some idea of what the MediaVPs can do, the best way is to experience them in-game.

===Games based on the FSO engine===
In addition to improving the original FS2, the FSO engine has also made it possible for people to create new space sim games. for a list of FSO-based games, see [[Total conversions]]. Note that all of these games are standalone, which means that they do not require the original FS2.

==Hard Light Productions==
Hard Light Productions (HLP) is the most active online FreeSpace community. HLP consists of hundreds of dedicated FreeSpace fans, with everyone contributing to the community in one or more ways. Members of HLP are
*Coders, who continuously improve the FSO game engine to include new and exciting features, as well as fix bugs in the game engine
*Modellers, who create new ship models and improve old ones
*Texture artists, who make textures for new and old ships
*Effect artists, who create effects such as weapons fire and afterburner trails
*FREDders, who use the FreeSpace Editor to create new missions and campaigns for people to play
*Support people, who help players with any problems regarding FreeSpace
*Players, who keep FreeSpace alive by playing the game year after year.

HLP has forums for the SCP, where new versions of the FSO game engine are released. People can also request new features, as well as post their contributions in the FSO code. HLP also has a board for the FSU project. This board has release threads for the latest MediaVPs, as well as other graphical updates.

In addition to these two important sections, HLP has boards for the following aspects:
*FreeSpace & FreeSpace Open Support - for any technical problems and questions related to FreeSpace
*FREDding - discussion about the FreeSpace Editor
*Modding - discussion about creating various modifications
*Multiplayer - discussion about FS2 multiplayer, accompanied by schedules
*Several mods and total conversions.

Registering to HLP is free and highly recommended. Though viewing the forums is possible as a guest, only registered members can post in the forums and ask any questions they might have. And HLP is notorious for responding to questions quickly, sometimes within minutes.

==Installing FreeSpace Open==
Installing FreeSpace Open is not rocket science as long as you follow the proper guidelines.

===Turey's FreeSpace Open Installer===
Turey's Installer is probably the most popular method for installing FSO. The idea of Turey's Installer is that it is a small program that downloads FSO-related files from the web. The user tells the Installer where his FreeSpace 2 installation is located, selects the components he wants to download and then starts up the Installer. It will then download the selected files from appropriate servers and place them to correct folders on the user's computer. Even though it has had its problems in the past, it is once again in working order and should provide working results. Instructions on how to use Turey's Installer can be found [http://www.hard-light.net/forums/index.php?topic=61606.0 here].

===Manual installation===
If you want to set things up yourself and possibly learn some things about the game in the process, you can install FSO manually. There are manual installation instructions for [http://www.hard-light.net/forums/index.php?topic=78710.0 Windows], [http://www.hard-light.net/forums/index.php?topic=79545.0 Linux], and [http://www.hard-light.net/forums/index.php?topic=79546.0 Mac OS X] among the stickied threads in the [http://www.hard-light.net/forums/index.php?board=7.0 General FreeSpace Discussion board], as well as a vast amount of [http://www.hard-light.net/forums/index.php?topic=56279.0 troubleshooting help] and some additional information on [[Installing FreeSpace 2 Open|this page]]. Don't think about manual installation as a 1337 h4x0r thing: there's more work involved, but none of it is hard.

==Post-installation instructions==
After you've installed FSO, there are some things you need to do in order to enjoy FSO to its fullest (these steps are also mentioned in the manual installation instructions mentioned earlier):

*Open the Launcher and click the "Browse" button at the top.
*Select fs2_open_3_6_12_INF_r.exe (do not use a -d or -debug build) and click OK.
*Open the Audio/Joystick tab and make sure that Generic Software is selected.
*Open the Video tab and make sure that OpenGL and 32-bit colors are selected.
*If you've installed the MediaVPs (the graphical updates):
**Open the MOD tab.
***Click "Select MOD" and select the "mediavps_3612" folder. Just select the folder, you do not need to select files inside it.
**Open the Features tab of the Launcher.
***Select "Graphics" as the list type.
***Tick at least "Enable specular", "Enable glowmaps", "Enable environment maps", and "Enable normal maps".
***Select "Gameplay" as the list type.
***Tick "Use models for ship selection" and "Use models for weapon selection".
*Save the changes by clicking "Apply" at the bottom of the Launcher.
*Start the game by clicking "Run" (it is easiest to always use the Launcher to start FSO, so you may want to create a shortcut of it to your desktop).
**If this is your very first time running the game, you'll be asked for a "callsign", that is, a name for your pilot/profile. Type it and press Enter. In subsequent runs, a list of pilots is shown here and you can select the one you like.
**When you get to the main hall, press F2, then select "Detail" from the top of the screen.
***Max all the settings in the "Detail" screen, unless you know what you're doing and have some compelling reason to do otherwise. These settings affect the quality of the graphics even when you are using everything the MediaVPs and the FSO engine provide.

==Related links==
Here are a few useful FreeSpace-related links.

*[http://www.gog.com/en/gamecard/freespace_2 FreeSpace 2 at Good Old Games] - The best place to buy FreeSpace 2 from.
*[http://www.hard-light.net/forums/index.php/topic,56279.0.html The FreeSpace Troubleshooting FAQ] - A FAQ that includes solutions to all the most common problems with FreeSpace, FreeSpace 2 and FreeSpace Open. If you have any problems with the games, start here.
*[http://www.freespacemods.net/ FreeSpaceMods.net] - A site that hosts a ton of FreeSpace-related things, including campaigns, mods and total conversions.
*[http://www.hard-light.net/ Hard-Light Productions.net] - The largest FreeSpace community on the web, where most modders and coders are available to provide help.

[[Category:Main]]
[[Category:The games|*]]

Getting started

2012-01-09T00:42:38Z

Jg18: updated links to Linux/OS X manual install instructions and other corrections/revisions

'''Getting Started: FreeSpace in a Nutshell'''

Hello and welcome! You've arrived at "FreeSpace in a Nutshell", an article for people new to FreeSpace. This article will provide information about the FreeSpace game series, FreeSpace Open and [[Hard Light Productions]]. There are also instructions for getting the games and installing FreeSpace Open.

==What is FreeSpace?==
FreeSpace is a series of space combat simulation games developed by Volition, Inc. and published by Interplay Entertainment. The games take place in the 24th century. Mankind, referred to as Terrans, has developed means for space traveling, further fueled by the discovery of subspace which makes interstellar travel not only possible but also fast and easy. As a result the Terrans have expanded their territory, eventually encountering another bipedal, sentient species; the Vasudans. However, due to cultural differences and difficulties in communicating with each other, the Galactic Terran Alliance (GTA) and the Parliamentary Vasudan Empire (PVE) end up fighting a war that lasts for 14 years.

===FreeSpace 1===
Descent: FreeSpace — The Great War (also known as Conflict: FreeSpace — The Great War) is the first part of the series, released in 1998. The player is a pilot for the Galactic Terran Alliance. The GTA and the PVN have waged a war for 14 years and there doesn't seem to be an end in sight. However, suddenly a third race appears. These aliens, designated Shivans, are technologically superior, do not respond to diplomacy, and stage attacks against both the Terrans and the Vasudans. As a result, the GTA and PVN forge a truce and join forces in order to stop these alien invaders.

FreeSpace 1 was well-received in its time by critics and players. Though it didn't offer much innovation in terms of gameplay and story, all aspects of the game worked well. The controls were easy to assume and the plot was quite compelling, as well as leaving a few questions in the air. Also crucial to the success of FS1 was the excellent mod support. Mod tools were released for the use of players and the game itself shipped with FreeSpace Editor (FRED) that allowed every player to design and create their own missions.

It is good to note that although in certain regions the full title of the game is ''Descent: FreeSpace – The Great War'', FS1 has very little to do with the Descent game series. The prefixes "Descent" and "Conflict" were used in some titles because there was already an archive tool called FreeSpace on the market.

===Silent Threat===
''Silent Threat'' is an expansion for ''FreeSpace 1'', also released in 1998. It offered a few new ships and weapons and a campaign regarding a rogue faction within the intelligence branch of the GTA. ''Silent Threat'' was considered as a decent expansion pack. The main campaign suffered from bugs, weird plot development and generic mission designs, but was compensated by the selected user-made mission that were also included.

===FreeSpace 2===
''FreeSpace 2'' was released in 1999 and continued the story 32 years after the events of FS1. The Terrans and Vasudans have increased their cooperation that started during the events of FS1, eventually culminating in the formation of the Galactic Terran-Vasudan Alliance (GTVA). However, not everyone appreciates the situation. A rebel group known as the Neo-Terran Front wages a war against the GTVA, because they do not see a future for the Terran race with the Vasudans.

In terms of gameplay and contents, FreeSpace 2 unsurprisingly improved upon what FreeSpace 1 had offered. The gameplay as such remained the same, but new features were added. Among these were beam weapons for capital ships and missions taking place in nebula environments. Storywise FreeSpace 2 was somewhat different from FS1. Sometimes compared to '' The Empire Strikes Back'', it didn't have a clear and happy ending, but instead left a number of questions floating in the air, puzzling and frustrating the fans.

Though critically appraised, ''FreeSpace 2'' was not a commercial success, largely because of the poor advertisement. Many fans of ''FreeSpace 1'' were actually surprised to hear that ''FreeSpace 2'' had been published because the only real source for this information was through game reviews.

===FreeSpace 3?===
There is no ''FreeSpace 3''. Volition was bought by THQ in 2000, with the licenses remaining with Interplay. Volition couldn't create a new game in the series and Interplay was not interested in publishing space simulation games because the genre was deemed dead. More information about FreeSpace 3 and related things can be read from [http://homepage.ntlworld.com/karajorma/FAQ/general.html#WhenFS3 Karajorma's FreeSpace FAQ].

===Where to get the games===
Though the FreeSpace games are old, they are far from lost. [http://www.gog.com/ Good Old Games] (GOG) sells numerous old classic games, including ''FreeSpace'', ''Silent Threat'', and ''FreeSpace 2''. People who do not yet own these games are recommended to buy them from Good Old Games, because GOG's games are cheap ($5.99 or $9.99), DRM-free and completely legal.

==The FreeSpace Source Code Project==
After Volition was bought by THQ, they no longer had any use for the game engine, since they couldn't develop new FreeSpace games. Volition released the source code of the FS2 game engine in 2002 so that FreeSpace fans could do what they wanted with it. A group of coders joined forces and formed the FreeSpace 2 Source Code Project (SCP) that began to, and still continues to, improve the game engine. The new open source game engine, known as FreeSpace Open (FSO), has several distingushing features that include:
*Linux and Mac OS X support
*OpenGL support
*OpenAL positional audio support
*Easy mod installation
*OGG support
*Hardware transform, clipping, and lighting

===The FreeSpace Upgrade Project===
While the SCP improve the code of the game engine to enable new and exciting features, the FreeSpace Upgrade Project (FSU) creates material that takes advantage of the improved game engine. The FSU improves the ships, effects and background elements of FreeSpace 2 continuously. Every now and then these improvements are released as a pack. Known as MediaVPs, these assorted improvements enhance the graphics of the game drastically. Though [[Screenshots|screenshots]] give some idea of what the MediaVPs can do, the best way is to experience them in-game.

===Games based on the FSO engine===
In addition to improving the original FS2, the FSO engine has also made it possible for people to create new space sim games. for a list of FSO-based games, see [[Total conversions]]. Note that all of these games are standalone, which means that they do not require the original FS2.

==Hard Light Productions==
Hard Light Productions (HLP) is the most active online FreeSpace community. HLP consists of hundreds of dedicated FreeSpace fans, with everyone contributing to the community in one or more ways. Members of HLP are
*Coders, who continuously improve the FSO game engine to include new and exciting features, as well as fix bugs in the game engine
*Modellers, who create new ship models and improve old ones
*Texture artists, who make textures for new and old ships
*Effect artists, who create effects such as weapons fire and afterburner trails
*FREDders, who use the FreeSpace Editor to create new missions and campaigns for people to play
*Support people, who help players with any problems regarding FreeSpace
*Players, who keep FreeSpace alive by playing the game year after year.

HLP has forums for the SCP, where new versions of the FSO game engine are released. People can also request new features, as well as post their contributions in the FSO code. HLP also has a board for the FSU project. This board has release threads for the latest MediaVPs, as well as other graphical updates.

In addition to these two important sections, HLP has boards for the following aspects:
*FreeSpace & FreeSpace Open Support - for any technical problems and questions related to FreeSpace
*FREDding - discussion about the FreeSpace Editor
*Modding - discussion about creating various modifications
*Multiplayer - discussion about FS2 multiplayer, accompanied by schedules
*Several mods and total conversions.

Registering to HLP is free and highly recommended. Though viewing the forums is possible as a guest, only registered members can post in the forums and ask any questions they might have. And HLP is notorious for responding to questions quickly, sometimes within minutes.

==Installing FreeSpace Open==
Installing FreeSpace Open is not rocket science as long as you follow the proper guidelines.

===Turey's FreeSpace Open Installer===
Turey's Installer is probably the most popular method for installing FSO. The idea of Turey's Installer is that it is a small program that downloads FSO-related files from the web. The user tells the Installer where his FreeSpace 2 installation is located, selects the components he wants to download and then starts up the Installer. It will then download the selected files from appropriate servers and place them to correct folders on the user's computer. Even though it has had its problems in the past, it is once again in working order and should provide working results. Instructions on how to use Turey's Installer can be found [http://www.hard-light.net/forums/index.php?topic=61606.0 here].

===Manual installation [[Installing fs2 open | (details)]]===
If you want to set things up yourself and possibly learn some things about the game in the process, you can install FSO manually. There are manual installation instructions for [http://www.hard-light.net/forums/index.php?topic=78710.0 Windows], [http://www.hard-light.net/forums/index.php?topic=79545.0 Linux], and [http://www.hard-light.net/forums/index.php?topic=79546.0 Mac OS X] among the stickied threads in the [http://www.hard-light.net/forums/index.php?board=7.0 General FreeSpace Discussion board], as well as a vast amount of [http://www.hard-light.net/forums/index.php?topic=56279.0 troubleshooting help]. Don't think about manual installation as a 1337 h4x0r thing: there's more work involved, but none of it is hard.

==Post-installation instructions==
After you've installed FSO, there are some things you need to do in order to enjoy FSO to its fullest (these steps are also mentioned in the manual installation instructions mentioned earlier):

*Open the Launcher and click the "Browse" button at the top.
*Select fs2_open_3_6_12_INF_r.exe (do not use a -d or -debug build) and click OK.
*Open the Audio/Joystick tab and make sure that Generic Software is selected.
*Open the Video tab and make sure that OpenGL and 32-bit colors are selected.
*If you've installed the MediaVPs (the graphical updates):
**Open the MOD tab.
***Click "Select MOD" and select the "mediavps_3612" folder. Just select the folder, you do not need to select files inside it.
**Open the Features tab of the Launcher.
***Select "Graphics" as the list type.
***Tick at least "Enable specular", "Enable glowmaps", "Enable environment maps", and "Enable normal maps".
***Select "Gameplay" as the list type.
***Tick "Use models for ship selection" and "Use models for weapon selection".
*Save the changes by clicking "Apply" at the bottom of the Launcher.
*Start the game by clicking "Run" (it is easiest to always use the Launcher to start FSO, so you may want to create a shortcut of it to your desktop).
**If this is your very first time running the game, you'll be asked for a "callsign", that is, a name for your pilot/profile. Type it and press Enter. In subsequent runs, a list of pilots is shown here and you can select the one you like.
**When you get to the main hall, press F2, then select "Detail" from the top of the screen.
***Max all the settings in the "Detail" screen, unless you know what you're doing and have some compelling reason to do otherwise. These settings affect the quality of the graphics even when you are using everything the MediaVPs and the FSO engine provide.

==Related links==
Here are a few useful FreeSpace-related links.

*[http://www.gog.com/en/gamecard/freespace_2 FreeSpace 2 at Good Old Games] - The best place to buy FreeSpace 2 from.
*[http://www.hard-light.net/forums/index.php/topic,56279.0.html The FreeSpace Troubleshooting FAQ] - A FAQ that includes solutions to all the most common problems with FreeSpace, FreeSpace 2 and FreeSpace Open. If you have any problems with the games, start here.
*[http://www.freespacemods.net/ FreeSpaceMods.net] - A site that hosts a ton of FreeSpace-related things, including campaigns, mods and total conversions.
*[http://www.hard-light.net/ Hard-Light Productions.net] - The largest FreeSpace community on the web, where most modders and coders are available to provide help.

[[Category:Main]]
[[Category:The games|*]]

Getting started

2012-01-09T00:34:17Z

Jg18: removed some instructions that are already included in the linked-to instructions

'''Getting Started: FreeSpace in a Nutshell'''

Hello and welcome! You've arrived at "FreeSpace in a Nutshell", an article for people new to FreeSpace. This article will provide information about the FreeSpace game series, FreeSpace Open and [[Hard Light Productions]]. There are also instructions for getting the games and installing FreeSpace Open.

==What is FreeSpace?==
FreeSpace is a series of space combat simulation games developed by Volition, Inc. and published by Interplay Entertainment. The games take place in the 24th century. Mankind, referred to as Terrans, has developed means for space traveling, further fueled by the discovery of subspace which makes interstellar travel not only possible but also fast and easy. As a result the Terrans have expanded their territory, eventually encountering another bipedal, sentient species; the Vasudans. However, due to cultural differences and difficulties in communicating with each other, the Galactic Terran Alliance (GTA) and the Parliamentary Vasudan Empire (PVE) end up fighting a war that lasts for 14 years.

===FreeSpace 1===
Descent: FreeSpace — The Great War (also known as Conflict: FreeSpace — The Great War) is the first part of the series, released in 1998. The player is a pilot for the Galactic Terran Alliance. The GTA and the PVN have waged a war for 14 years and there doesn't seem to be an end in sight. However, suddenly a third race appears. These aliens, designated Shivans, are technologically superior, do not respond to diplomacy, and stage attacks against both the Terrans and the Vasudans. As a result, the GTA and PVN forge a truce and join forces in order to stop these alien invaders.

FreeSpace 1 was well-received in its time by critics and players. Though it didn't offer much innovation in terms of gameplay and story, all aspects of the game worked well. The controls were easy to assume and the plot was quite compelling, as well as leaving a few questions in the air. Also crucial to the success of FS1 was the excellent mod support. Mod tools were released for the use of players and the game itself shipped with FreeSpace Editor (FRED) that allowed every player to design and create their own missions.

It is good to note that although in certain regions the full title of the game is ''Descent: FreeSpace – The Great War'', FS1 has very little to do with the Descent game series. The prefixes "Descent" and "Conflict" were used in some titles because there was already an archive tool called FreeSpace on the market.

===Silent Threat===
''Silent Threat'' is an expansion for ''FreeSpace 1'', also released in 1998. It offered a few new ships and weapons and a campaign regarding a rogue faction within the intelligence branch of the GTA. ''Silent Threat'' was considered as a decent expansion pack. The main campaign suffered from bugs, weird plot development and generic mission designs, but was compensated by the selected user-made mission that were also included.

===FreeSpace 2===
''FreeSpace 2'' was released in 1999 and continued the story 32 years after the events of FS1. The Terrans and Vasudans have increased their cooperation that started during the events of FS1, eventually culminating in the formation of the Galactic Terran-Vasudan Alliance (GTVA). However, not everyone appreciates the situation. A rebel group known as the Neo-Terran Front wages a war against the GTVA, because they do not see a future for the Terran race with the Vasudans.

In terms of gameplay and contents, FreeSpace 2 unsurprisingly improved upon what FreeSpace 1 had offered. The gameplay as such remained the same, but new features were added. Among these were beam weapons for capital ships and missions taking place in nebula environments. Storywise FreeSpace 2 was somewhat different from FS1. Sometimes compared to '' The Empire Strikes Back'', it didn't have a clear and happy ending, but instead left a number of questions floating in the air, puzzling and frustrating the fans.

Though critically appraised, ''FreeSpace 2'' was not a commercial success, largely because of the poor advertisement. Many fans of ''FreeSpace 1'' were actually surprised to hear that ''FreeSpace 2'' had been published because the only real source for this information was through game reviews.

===FreeSpace 3?===
There is no ''FreeSpace 3''. Volition was bought by THQ in 2000, with the licenses remaining with Interplay. Volition couldn't create a new game in the series and Interplay was not interested in publishing space simulation games because the genre was deemed dead. More information about FreeSpace 3 and related things can be read from [http://homepage.ntlworld.com/karajorma/FAQ/general.html#WhenFS3 Karajorma's FreeSpace FAQ].

===Where to get the games===
Though the FreeSpace games are old, they are far from lost. [http://www.gog.com/ Good Old Games] (GOG) sells numerous old classic games, including ''FreeSpace'', ''Silent Threat'', and ''FreeSpace 2''. People who do not yet own these games are recommended to buy them from Good Old Games, because GOG's games are cheap ($5.99 or $9.99), DRM-free and completely legal.

==The FreeSpace Source Code Project==
After Volition was bought by THQ, they no longer had any use for the game engine, since they couldn't develop new FreeSpace games. Volition released the source code of the FS2 game engine in 2002 so that FreeSpace fans could do what they wanted with it. A group of coders joined forces and formed the FreeSpace 2 Source Code Project (SCP) that began to, and still continues to, improve the game engine. The new open source game engine, known as FreeSpace Open (FSO), has several distingushing features that include:
*Linux and Mac OS X support
*OpenGL support
*OpenAL positional audio support
*Easy mod installation
*OGG support
*Hardware transform, clipping, and lighting

===The FreeSpace Upgrade Project===
While the SCP improve the code of the game engine to enable new and exciting features, the FreeSpace Upgrade Project (FSU) creates material that takes advantage of the improved game engine. The FSU improves the ships, effects and background elements of FreeSpace 2 continuously. Every now and then these improvements are released as a pack. Known as MediaVPs, these assorted improvements enhance the graphics of the game drastically. Though [[Screenshots|screenshots]] give some idea of what the MediaVPs can do, the best way is to experience them in-game.

===Games based on the FSO engine===
In addition to improving the original FS2, the FSO engine has also made it possible for people to create new space sim games. for a list of FSO-based games, see [[Total conversions]]. Note that all of these games are standalone, which means that they do not require the original FS2.

==Hard Light Productions==
Hard Light Productions (HLP) is the most active online FreeSpace community. HLP consists of hundreds of dedicated FreeSpace fans, with everyone contributing to the community in one or more ways. Members of HLP are
*Coders, who continuously improve the FSO game engine to include new and exciting features, as well as fix bugs in the game engine
*Modellers, who create new ship models and improve old ones
*Texture artists, who make textures for new and old ships
*Effect artists, who create effects such as weapons fire and afterburner trails
*FREDders, who use the FreeSpace Editor to create new missions and campaigns for people to play
*Support people, who help players with any problems regarding FreeSpace
*Players, who keep FreeSpace alive by playing the game year after year.

HLP has forums for the SCP, where new versions of the FSO game engine are released. People can also request new features, as well as post their contributions in the FSO code. HLP also has a board for the FSU project. This board has release threads for the latest MediaVPs, as well as other graphical updates.

In addition to these two important sections, HLP has boards for the following aspects:
*FreeSpace & FreeSpace Open Support - for any technical problems and questions related to FreeSpace
*FREDding - discussion about the FreeSpace Editor
*Modding - discussion about creating various modifications
*Multiplayer - discussion about FS2 multiplayer, accompanied by schedules
*Several mods and total conversions.

Registering to HLP is free and highly recommended. Though viewing the forums is possible as a guest, only registered members can post in the forums and ask any questions they might have. And HLP is notorious for responding to questions quickly, sometimes within minutes.

==Installing FreeSpace Open==
Installing FreeSpace Open is not rocket science as long as you follow the proper guidelines.

===Turey's FreeSpace Open Installer===
Turey's Installer is probably the most popular method for installing FSO. The idea of Turey's Installer is that it is a small program that downloads FSO-related files from the web. The user tells the Installer where his FreeSpace 2 installation is located, selects the components he wants to download and then starts up the Installer. It will then download the selected files from appropriate servers and place them to correct folders on the user's computer. Even though it has had its problems in the past, it is once again in working order and should provide working results. Instructions on how to use Turey's Installer can be found [http://www.hard-light.net/forums/index.php?topic=61606.0 here].

===Manual installation [[Installing fs2 open | (details)]]===
If you want to do things yourself and possibly learn some things about the game in the process, you can install FSO manually. There are instructions for manual installation for [http://www.hard-light.net/forums/index.php?topic=78710.0 Windows] and [http://www.hard-light.net/forums/index.php?topic=60842.0 Linux/OS X] in the stickies in the [http://www.hard-light.net/forums/index.php?board=151.0 Tech Support board], as well as a vast amount of [http://www.hard-light.net/forums/index.php?topic=56279.0 troubleshooting help]. The Windows instructions in particular contain links to the most reliable and up-to-date components, accompanied by short explanations on what does what. And don't think about manual installation as a 1337 h4x0r thing. There's more work involved, but it is all easy in the end, and you'll most likely gain more from manual installation. Also, by installing FSO manually you are free (to a degree) to choose just what you want to install in the first place. You won't have to download graphical enhancements and user-made campaigns unless you want to.

==Post-installation instructions==
After you've installed FSO, there are some things you need to do in order to enjoy FSO to its fullest (these steps are also mentioned in the manual installation instructions mentioned earlier):

*Open the Launcher and click the "Browse" button at the top.
*Select fs2_open_3_6_12_INF_r.exe (do not use a -d or -debug build) and click OK.
*Open the Audio/Joystick tab and make sure that Generic Software is selected.
*Open the Video tab and make sure that OpenGL and 32-bit colors are selected.
*If you've installed the MediaVPs (the graphical updates):
**Open the MOD tab.
***Click "Select MOD" and select the "mediavps_3612" folder. Just select the folder, you do not need to select files inside it.
**Open the Features tab of the Launcher.
***Select "Graphics" as the list type.
***Tick at least "Enable specular", "Enable glowmaps", "Enable environment maps", and "Enable normal maps".
***Select "Gameplay" as the list type.
***Tick "Use models for ship selection" and "Use models for weapon selection".
*Save the changes by clicking "Apply" at the bottom of the Launcher.
*Start the game by clicking "Run" (it is easiest to always use the Launcher to start FSO, so you may want to create a shortcut of it to your desktop).
**If this is your very first time running the game, you'll be asked for a "callsign", that is, a name for your pilot/profile. Type it and press Enter. In subsequent runs, a list of pilots is shown here and you can select the one you like.
**When you get to the main hall, press F2, then select "Detail" from the top of the screen.
***Max all the settings in the "Detail" screen, unless you know what you're doing and have some compelling reason to do otherwise. These settings affect the quality of the graphics even when you are using everything the MediaVPs and the FSO engine provide.

==Related links==
Here are a few useful FreeSpace-related links.

*[http://www.gog.com/en/gamecard/freespace_2 FreeSpace 2 at Good Old Games] - The best place to buy FreeSpace 2 from.
*[http://www.hard-light.net/forums/index.php/topic,56279.0.html The FreeSpace Troubleshooting FAQ] - A FAQ that includes solutions to all the most common problems with FreeSpace, FreeSpace 2 and FreeSpace Open. If you have any problems with the games, start here.
*[http://www.freespacemods.net/ FreeSpaceMods.net] - A site that hosts a ton of FreeSpace-related things, including campaigns, mods and total conversions.
*[http://www.hard-light.net/ Hard-Light Productions.net] - The largest FreeSpace community on the web, where most modders and coders are available to provide help.

[[Category:Main]]
[[Category:The games|*]]