FreeSpace Wiki - User contributions [en]

Journal.tbl

2026-03-26T12:25:45Z

-Joshua-:

{{SCPUI_table}}
{{Tables}}
Journal.tbl is used by the [[SCPUI]] script system to define the journal options and entries for a specific campaign.

The Journal is configured on a per-campaign basis where each campaign loads from a table matching the format <code>CAMPAIGN_FILE_NAME-journal.tbl</code>. Journal.tbl, by design, is NOT modular and cannot be extended.

==Journal.tbl==
*Defines the journal options, configuration, and available entries
*Begins with one of the configuration sections and ends with #End

==#Journal Options==
*The base configuration options
*Must end with #End

===$Title:===
*The title of the UI shown to the player.
*Optional. Defaults to "Journal".
*Syntax: '''''string'''''

==#Journal Sections==
*Defines what sections or entry categories are available.
*Can define up to 3 sections.
*Must end with #End

===$Name:===
*The name of the section.
*Does NOT support XSTR("", ##) parsing!
*Syntax: '''''string'''''

===$XSTR:===
*The XSTR ID for the section name
*Syntax: '''''integer'''''

==#Journal Entries==
*Defines all available journal entries
*Must end with #End

===$Name:===
*The name of the entry.
*Does NOT support XSTR("", ##) parsing!
*Syntax: '''''string'''''

===$XSTR:===
*The XSTR ID for the section name
*Syntax: '''''integer'''''

===$Group:===
*The Section or Category that this entry belongs to
*Syntax: '''''string'''''

===$Visible by Default:===
*Sets whether this entry is always visible or must be unlocked
*Optional, defaults to false.
*Syntax: '''''boolean'''''

===$Short Title:===
*A short title string for the entry
*Optional, defaults to an empty string
*Syntax: '''''string'''''

===$File:===
*The base name of the text file to use for the journal entry.
*Language support is handled by appending FSO's language shorthand to the filename before the extension <code>BASENAME-lang.txt</code>
*Must be a .txt file and the extension should be included here.
*Syntax: '''''string'''''

===$Image:===
*The image file to display (without extension)
*Optional, if not provided no image will be displayed.
*Syntax: '''''string'''''

===$Caption:===
*The caption for the image. Ignored if there is no image to display.
*Optional, if not provided no caption will be displayed.
*Syntax: '''''string'''''

===$Caption XSTR:===
*The XSTR id for the caption.
*Required if Caption is provided.
*Syntax: '''''integer'''''

===Example===
<pre>
#Journal Options
$Title: XSTR("Newsroom", 9284)
#End

#Journal Sections

$Name: Headlines
$XSTR: 193

$Name: Editorials
$XSTR: 194

#End

#Journal Entries ;;Languages can be done by creating files with the language shorthand appended. bta1_h01-gr.txt

$Name: Living In Antares
$XSTR: 195
$Group: Headlines
$Visible by Default: true
$Short Title: bta1_head01
$File: bta1_h01.txt

$Name: The Stinging of a Wasp
$XSTR: 196
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head02
$File: bta1_h02.txt

$Name: The Stinging of a Wasp Pt.2
$XSTR: 197
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head03
$File: bta1_h03.txt

$Name: Hammer of Light Activity Increases
$XSTR: 198
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head04
$File: bta1_h04.txt

$Name: Piracy and Smuggling on the Increase
$XSTR: 199
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head05
$File: bta1_h05.txt

$Name: Living in a Box
$XSTR: 200
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head06
$File: bta1_h06.txt

$Name: Criminal Activity Continues
$XSTR: 201
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head07
$File: bta1_h07.txt

$Name: Carnage at Detiula Station
$XSTR: 202
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head08
$File: bta1_h08.txt

$Name: Messenger of Death
$XSTR: 203
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head09
$File: bta1_h09.txt

$Name: War-Torn and Without Choice
$XSTR: 204
$Group: Editorials
$Visible by Default: true
$Short Title: bta1_edit01
$File: bta1_e01.txt
$Image: deadcity
$Caption: Volsinii city after PVN bombardment - year 2330
$Caption XSTR: 218

$Name: More Casualties, More Tragedies
$XSTR: 205
$Group: Editorials
$Visible by Default: true
$Short Title: bta1_edit02
$File: bta1_e02.txt
$Image: deathinspace
$Caption: Debris after GTA attack on civilian transport Retin - 2335/04/25
$Caption XSTR: 219

$Name: Antares, Or What's Left Of It
$XSTR: 206
$Group: Editorials
$Visible by Default: true
$Short Title: bta1_edit03
$File: bta1_e03.txt
$Image: gulnarasun
$Caption: Gulnara Research Station is often a target of local raiding parties.
$Caption XSTR: 220

$Name: The Hand Grasping The Suns
$XSTR: 207
$Group: Editorials
$Visible by Default: true
$Short Title: bta1_edit04
$File: bta1_e04.txt
$Image: militarysun
$Caption: Some GTA warships are already in Antares preceding the Intrepid's arrival.
$Caption XSTR: 221

$Name: Antares' Judgment Begins
$XSTR: 208
$Group: Editorials
$Visible by Default: false
$Short Title:bta1_edit05
$File: bta1_e05.txt
$Image: cargoplatform
$Caption: One of many cargo depots littered around Antares.
$Caption XSTR: 227

$Name: Blind Spot
$XSTR: 209
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit06
$File: bta1_e06.txt
$Image: krakenstation
$Caption: Kraken Station, the site of the attack on the Regulus Senators.
$Caption XSTR: 228

$Name: Facade of the Starscape
$XSTR: 210
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit07
$File: bta1_e07.txt
$Image: hillross
$Caption: Hillross Station is owned by Exxon-Beckham.
$Caption XSTR: 232

$Name: Abeyance
$XSTR: 211
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit08
$File: bta1_e08.txt
$Image: afvalk
$Caption: Antarian security forces have begun painting the emblem of the Antares Federation political party on their hulls.
$Caption XSTR: 233

$Name: Breadcrumbs and Superposition
$XSTR: 212
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit09
$File: bta1_e09.txt
$Image: afemblem
$Caption: The official emblem of the Antares Federation political party.
$Caption XSTR: 234

$Name: The Sleeping Dragon
$XSTR: 213
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit10
$File: bta1_e10.txt
$Image: cardinalpropo
$Caption: The HLD Cardinal as shown in an HoL propaganda release.
$Caption XSTR: 235

$Name: The Dragon Awakens
$XSTR: 214
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit11
$File: bta1_e11.txt
$Image: megalith
$Caption: Security firm Megalith is now operating directly out of Antares Station.
$Caption XSTR: 236

$Name: Phagocytosis
$XSTR: 215
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit12
$File: bta1_e12.txt
$Image: apoapsis
$Caption: The AFC Apoapsis is now standing by near Antares Station.
$Caption XSTR: 237

$Name: The Suns Are Released
$XSTR: 216
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit13
$File: bta1_e13.txt
$Image: antsuns
$Caption: Antares Major and Minor are our symbols for hope and unity in the future.
$Caption XSTR: 238

#End
</pre>
[[Category:Tables]]
[[Category:SCPUI]]

RCSS Decorators

2026-03-16T12:28:44Z

-Joshua-:

{{RCSS}}
Decorators are an extension to CSS for RCSS. A decorator can be declared and named in a style sheet like a property, and then configured with decorator-specific properties. Custom decorator types can be developed to suit the needs of the user, and in this manner any kind of decoration can be applied to an element.

Important: Note that decorators can only be declared and defined in style sheets, not in style defined inline to an element.

==Declaring decorators==
The declaration of a decorator is a property of the form:

<pre>
<name>-decorator: <type>;
</pre>
where <name> is the user-specified name of the decorator to declare, and <type> is the application-specific type of decorator. libRocket ships with the following decorator types:
*image
*tiled-box
*tiled-horizontal
*tiled-vertical
The decorator type none is a reserved name that represents no decorator. For example, in the following:
<pre>
button
{
icon-decorator: tiled-horizontal;
}
</pre>
the RCSS is attaching a decorator of type tiled-horizontal called ‘icon’ to all button elements. Note that the name ‘icon’ could be anything; it is only used to uniquely identify the decorator for applying properties to it.

Decorator types can be overridden like any other property. So, in the example:
<pre>
h1
{
icon-decorator: image;
}

h1:hover
{
icon-decorator: none;
}
</pre>
all h1 tags will have an image decorator attached, except when they are being hovered, when the decorator will not be rendered.

==Decorator properties==
Decorators have their own property specifications with properties and shorthands, and these can be defined for declared decorators just like any other property. Decorator properties are set in the form:

<pre>
<name>-<property>: <value>;
</pre>
where <name> is the name the decorator was declared under, <property> is the name of the decorator’s property to set, and <value> is the value of the property. For example:
<pre>
h1
{
icon-decorator: image;
icon-image-src: ../images/header_arrow.png;
icon-image-s-begin: 5px;
}
</pre>
an image decorator is declared, called ‘icon’. On this decorator, the properties <name>-image-src is set to ‘../images/header_arrow.png’ and <name>-image-s-begin is set to ‘5px’. The other properties in the image specification are left to their defaults.

The decorator properties behave like other properties, so are subject to precedence and the cascade. For example, if the following RCSS was loaded after the previous example:
<pre>
h1
{
icon-image-s-begin: 3px;
}

h1:first-child
{
icon-decorator: none;
}
</pre>
all h1 tags will have their ‘icon’ decorators defined with an <name>-s-begin property of ‘3px’ instead of ‘5px’, and an h1 that is a first child will have no decorator.

Be careful of name conflicts! For example, in the following sample:
<pre>
h1
{
icon-decorator: image;
}

.secondary
{
icon-decorator: tiled-horizontal;
}
</pre>
an element of type h1 with a class of ‘secondary’ will have a single decorator, ‘icon’, of type tiled-horizontal. If the decorators had different names then they both would be present.

Specifying render order
If an element has more than one decorator on it, you can use the ‘z-index’ decorator property to control the render order in a similar fashion to elements. For example, in this sample:
<pre>
button
{
background-decorator: tiled-horizontal;
background-z-index: 0;

icon-decorator: image;
icon-z-index: 1;
}
</pre>
the ‘icon’ decorator will appear on top of the ‘background’ decorator. If no z-index is specified on a decorator, it will have the default z-index of 0.

Decorators and pseudo-classes
Because of the way libRocket compiles pseudo-class rules within style sheets, overriding decorator properties within dynamic pseudo-classes (:active, :hover and :focus, not any of the structural classes) might not always work the way you think it should.

In a nutshell, each decorator will only process properties from their element’s base rules (ie, those not specifying dynamic pseudo-classes in their final simple selector) and one rule specifying a dynamic pseudo-class (or classes), that with the highest specificity. For example, in the following sample:
<pre>
button
{
background-decorator: tiled-horizontal;
background-image-src: ../button.png;
background-image-s-end: 128px;
}

button:hover
{
background-image-t-begin: 32px;
background-image-t-end: 64px;
}

button:active
{
background-image-s-begin: 128px;
background-image-s-end: 256px;
}
</pre>
if both the :hover and :active pseudo-classes are active on a button element, the <name>-image-s-begin and <name>-image-s-end properties from the :active rule will be set, but the <name>-image-t-begin and <name>-image-t-end properties from the :hover rule will be ignored. The :active rule is used as it has higher precedence that the :hover rule, appearing further down the file. If you wanted both the s and t properties set, you could create another rule:
<pre>
button:active:hover
{
background-image-t-begin: 32px;
background-image-t-end: 64px;
background-image-s-begin: 128px;
background-image-s-end: 256px;
}
</pre>

==image decorators==
Image decorators in Freespace Open's instance of librocket support a custom paramter, <code>image-fit</code>. Valid values are Stretch, Contain, Fill.
<pre>
.general_bg
{
background-decorator: image;
background-image: 2_preload.png;
background-image-fit: contain;
}
</pre>

==libRocket decorators==
libRocket comes with several built-in decorators for displaying images and tiled images behind elements.

*image decorator, for displaying a single stretched image.
*tiled-horizontal decorator, for tiling images horizontally.
*tiled-vertical decorator, for tiling images vertically.
*tiled-box decorator, for tiling images across a box.

Weapons.tbl

2025-12-30T17:39:28Z

-Joshua-: Small typo corrections.

{{TableVersionGit|2024-12-10|228fd17}}
{{Tables}}
The '''weapons.tbl''' defines all of the weapon classes used in FSO.

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

==Introduction==
The weapons.tbl is responsible for defining the behavior of the numerous weapon effects used in FSO, including the amount of damage dealt, the firing rate, and graphical effects.

This wiki page goes over all of the entries used exclusively in the weapons.tbl file. Hyperlinks to individual weapon creation/editing tutorials are provided when appropriate.

==Special Case Weapons==
===Beam Cannons===
'''REQUIRES:'''
*'''"beam"''' flag
*'''[[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''

See also: [http://www.hard-light.net/wiki/index.php/Tutorial_-_Beam_Weapons Tutorial - Beam Weapons]

===Flak Guns===
'''REQUIRES:'''
*'''"flak"''' flag
*'''"particle spew"''' flag
*Must have inner and outer radius defined to have any effect.
*A '''.pof''' model must be defined ( usually '''Hornet.pof''' )
**Note: the model is not actually used... Instead, it uses [[Weapons.tbl#$Pspew:|particle spew]]. Trails may also be added.

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primary weapons''', as well '''flak weapons'''. Traditionally, '''beam weapons''' are also defined in this section.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***Defines '''beam weapons'''. Traditionally they appear in the primary weapon section, but this is technically their proper place.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

NOTE: Beam weapons defined in the primary section will receive the WP_LASER subtype, and beam weapons defined in the beam section will receive the WP_BEAM subtype. They will behave identically in most respects, with the only in-game difference being a somewhat larger and asymmetrical impact explosion effect for WP_BEAM. In scripts, beams will return true for '''isLaser()''' if they have the WP_LASER subtype, and false if they have the WP_BEAM subtype. (They will always return true for '''isBeam()'''.)

==Core Table==

===$Name:===
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. Two special characters can be used in the name: '''#''' and '''@'''. Their usage details are the very same than inside the [[Ships.tbl#.24Name:_2|$Name field from Ships.tbl]].
*Syntax: '''''String'''''

====+nocreate====
{{Table3610|
*In [[Modular Tables]] a name can be followed by the line '''+nocreate''' to prevent the game from creating an incomplete entry with very few valid fields. If the entry does not already exist (either in weapons.tbl or in earlier parsed *-wep.tbm files), the modular entry is skipped.}}

===+remove===
{{Table210|
*In [[Modular Tables]] a name can be followed by the line '''+remove''' to completely remove a previously parsed entry.}}

===$Alt Name:===
{{Table3611|
*An alternative name that can be referenced instead of $Name:
*Syntax: '''''String'''''}}

===$Subtype:===
{{Table3610|
Specifies the weapon 's subtype. Overrides the default subtype as specified by the #-section it is in (#Primary, #Secondary, #Beam Weapon, etc.).

{{Note|
:Since the weapon subtype is already specified by the #-section it is in, this option is not particularly useful when the weapon is inside a #Primary or #Secondary section. However, it may be used to specify the weapon slot it uses on fighters/bombers for weapons that are normally capship only (such as beam cannons).}}

*Syntax: '''''String'''''
*Valid Entries:
:Primary
:Secondary}}

===+Title:===
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Syntax: XSTR('''''"String"''''', -1)

===+Description:===
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text
</pre>

===+Tech Title:===
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR('''''"String"''''', -1)

===+Tech Anim:===
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: '''''String''''', animation filename
**Example: ''Tech_Subach_HL-7''

===+Tech Description:===
*Descriptive text you see in the tech room. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text
</pre>

===$Turret Name:===
{{Table222|
*Renames a turret to this if this is the first weapon on a turret.
*Syntax: XSTR('''''"String"''''', -1)}}

===$Tech Model:===
{{Table3610|
*Defines model used in wing loadout screen for the weapon. 3D weapon models in the tech room have not yet been implemented.
*Syntax: '''''String.pof''''', model filename}}

====+Closeup_Pos:====
{{Table3613|
*How the model will show on the Loadout Screen. The position of the camera relative to the model center. Only valid if a tech model is defined
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively}}

====+Closeup_Zoom:====
{{Table3613|
*How the model will show on the Loadout Screen. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians}}

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: '''''String''''', either "FS1", or "Off". This defaults to the FS2 effect.
}}

===$HUD Image:===
{{Table3610|
*Defines the picture used to represent the weapon in HUD loadout list
*Syntax: '''''String''''', filename}}

===$Model File:===
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not needed if a model has been defined for the weapon.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: '''''String.pof''''' or ''none'', model filename
**Example: ''none''

===$POF target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of the model used in HUD targeting view
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
{{Table3613|
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Optional. If not defined the game uses the formula ((radius * 20.0 + 20.0) * LOD)
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''}}

===$External Model File:===
{{Table3610|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

===$Submodel Rotation Speed:===
{{Table3610|
*Defines the rotation speed of the subobject, with the $gun_rotation property defined, in the external weapon model.
*Syntax: '''''Float'''''
*Note: weapon fire will be delayed by the time it takes for the weapon to spin up to this speed (using $Submodel Rotation Acceleration or its default value), regardless of whether an external model is used or not.
}}
{{Table38|
*Note: It's no longer required that the ship actually have external models enabled (whether or not this weapon has one defined) for the spin up delay to occur.
}}

===$Submodel Rotation Acceleration:===
{{Table3610|
*Defines the rotation acceleration of the external weapon model.
*Syntax: '''''Float'''''
*Default value: 10}}

===@Laser===
In the event a 3D model is not defined for the weapon, FSO creates an object similar to a glowpoint. Essentially, it is a 2D plane that always faces the player's camera with an additive texture applied to it, and may or may not have an omnilight follow it.

As suggested by its name, this option group is normally used for lasers and similar primaries, but it may also be used for other weapon types as well.

Unless said otherwise, the graphic files used within this group may be of any compatible type (.DDS, .PCX, .TGA, etc.), however a .DDS is recommended.

====@Laser Bitmap:====
Defines the graphic file to be used as the weapon effect.

Blending type: additive

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Bitmap: my_laser_bitmap
</pre>

====@Laser Head-on Bitmap:====
{{Table220|
Defines another laser graphic file to be used and crossfaded into as the camera angles towards the front or bank of this weapon. See also @Laser Head-on Transition Angle and @Laser Head-on Transition Rate.

Syntax: '''''String''''', filename}}

====@Laser Glow:====
Defines the graphic file to be used for the glowmap of the weapon effect.

Blending type: additive

*This file is 'multiplied' by a value between Color and Color2.
*The physical dimensions of the glowmap in-game is 2x the size of the bitmap.

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Glow: my_laser_glowmap
</pre>

====@Laser Glow Head-on Bitmap:====
{{Table220|
Defines another graphic file to be used for the laser glow and crossfaded into as the camera angles towards the front or bank of this weapon. See also @Laser Head-on Transition Angle and @Laser Head-on Transition Rate.

Syntax: '''''String''''', filename}}

====@Laser Head-on Transition Angle:====
{{Table220|
Overrides the angle in degrees from the front (or back) that the head-on transition crossfade is at exactly a 50/50 blend.

Syntax: '''''Float''''', degrees
Default: Calculated from the ratio of the laser's length to its average radius}}

====@Laser Head-on Transition Rate:====
{{Table220|
Defines how quickly the head-on transition fades from one bitmap to the other. Greater than 20 is an instant switch with no blending.

Syntax: '''''Float'''''
Default: 2}}

====@Laser Color:====
The RGB color of the glow effect.

*The color is applied both to the glowmap and the omnilight that follows the effect.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Red glow effect at the start of the effect's lifetime
</pre>

====@Laser Color2:====
The RGB color of the glow effect at the end of the effect's lifetime (at its maximum range).

*The color is applied both to the glowmap and the omnilight that follows the effect.
*The actual color of the glow effect is somewhere in between the values defined by Color and Color2. Essentially, the actual color "fades" from Color to Color2 over its lifetime.
**If Color is not defined, then a default value of 255, 255, 255 is assumed for its initial color.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color2: 0, 0, 255 ; Blue glow effect at the end of the effect's lifetime.
</pre>

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Start with a Red glow effect, and fade into...
@Laser Color2: 0, 0, 255 ; a Blue glow effect over the lifetime of the effect.
</pre>

====@Laser Length:====
Defines the length of the weapon effect.
*This option stretches the 2D plane "away" from its origin.
Syntax: '''''Float''''', meters
{{Table240|
===@Laser Length Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's length over time.
*The life of the weapon (0-1) is X, the length multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

====@Laser Head Radius:====
Defines the radius of the leading edge, or "head," of the weapon effect.
*The edge of the 2D plane farthest away from its origin is the leading edge.
*The specified radius value is multiplied by 0.5 twice before being applied to the laser, so the laser head's radius will be one-quarter of what's tabled. Its ''diameter'' will be half of the tabled radius value.
Syntax: '''''Float''''', meters

====@Laser Tail Radius:====
Defines the radius of the trailing edge, or "tail" of the weapon effect.
*The edge of the 2D plane that is closest to its origin is the trailing edge.
*The specified radius value is multiplied by 0.5 twice before being applied to the laser, so the laser tail's radius will be one-quarter of what's tabled. Its ''diameter'' will be half of the tabled radius value.
Syntax: '''''Float''''', meters
{{Table240|
===@Laser Radius Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's radius values (both head and tail) over time.
*The life of the weapon (0-1) is X, the radius multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

====@Laser Glow Length Scale:====
Scaling factor for glow bitmap along the length axis, relative to the length of the main laser bitmap. Default is 2.0.

Syntax: '''''Float'''''

====@Laser Glow Head Scale:====
Scaling factor for the radius of the glow bitmap at its head, relative to the radius of the main laser bitmap's head. Default is 2.3.
*Note that laser length is calculated in an odd way: the head and tail are treated as ''spheres'', with the length being the distance between the centers of those spheres, so the actual length of a laser (or laser glow) is length + head radius + tail radius.
*This can result in unintuitive behavior if glow length scaling is set differently from head or tail scaling.
*However, as long as length, head, and tail glow scale are all set to the same value, the glow bitmap will be scaled up while maintaining the same aspect ratio as the laser.
Syntax: '''''Float'''''

====@Laser Glow Tail Scale:====
Scaling factor for the radius of the glow bitmap at its tail, relative to the radius of the main laser bitmap's tail. Default is 2.3.
*See note in head scale entry regarding unintuitive behavior.
Syntax: '''''Float'''''

====@Laser Position Offset:====
Moves the laser relative to its collision point by multiples of the laser length, along any of the three axes. For example, a value of -1.0 along the Z axis will move the laser backward so that the visible laser no longer extends forward from the collision point, but backward, with the collision point at the head rather than the tail. A value of 1.0 along the X axis will move the laser one laser-length to the right.
*Important note: the X and Y axes are relative to the orientation of the weapon, which normally seems to match the orientation of the firing ship, but which is not guaranteed to remain stable. If the weapon rotates, the orientation of the offset will rotate with it.
Syntax: '''''Vector'''''

====@Laser Min Pixel Size:====
If this is set to a non-zero value, the laser will always be at least the specified number of pixels wide, no matter how far away it is. Defaults to the $Minimum Pixel Size Lasers: value in Game settings.tbl, or to 0 if that is not set.

Syntax: '''''Integer'''''

{{Table240|
===@Laser Opacity Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the laser graphic's opacity over time.
*The life of the weapon (0-1) is X, the opacity is Y, with 0 being invisible and 1 being typical opacity.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===$Light color:===
{{Table222|
*Sets the color of light cast by the weapon.
*Syntax: '''''Color''''', red, green, blue respectively, from 0 to 255
*Default value: If not set, the color is white for weapons with models, or based on the laser colors otherwise }}

===$Light radius:===
{{Table222|
*Sets the maximum distance light cast by the weapon will reach. Increasing this will tend to make it appear brighter near it's center
*Syntax: '''''float''''', any positive value
*Default value: The defaults for different weapon types are set in [[Lighting_Profiles.tbl]]}}

===$Light intensity:===
{{Table222|
*Acts as a multiplier to the brightness of the light cast by the weapon. This changes the brightness without affecting the radius.
*Syntax: '''''float''''', any positive value
*Default value: 1}}

===$Collision Radius Override:===
{{Table202|
*Weapon - weapon collisions are treated as two spheres, where a laser's sphere's radius is equal to its Head Radius, and a missile's is the radius of its associated model (possibly doubled). Using this will override either of those values.
*If used on a beam it will override its collision radius as well, instead of using the widest section.
*NOTE: If the weapon is interceptable, such as a bomb or has been given hitpoints, this value will ''still'' be doubled, unless the "no radius doubling" flag is used.
*Syntax: '''''Float''''', meters}}

===$Mass:===
*Scales the kinetic effect this weapon has on its target. With higher mass imparting a stronger effect.
*The eventual kinetic effect is also multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. This is also true for the intesnity of the "shudder" effect, if flagged.
*Syntax: '''''Float''''', blast effect

===$Velocity:===
*How fast the weapon travels. Is also used to define the weapon range, '''''$Velocity x $Lifetime = range'''''.
*Beams travel instantly so this field has effect only on weapon range and AI beam targeting with certain beam types. $Velocity of beam also applies to its kinetic effect along with $Mass.
*Syntax: '''''Float''''', meters per second

===$Fire Wait:===
*Time in seconds between firings
*Note that Fire wait will be reset to 1 if it is set over 5 for non turreted primary weapons (doesn't apply to 3.6.14+)
*Syntax: '''''Float''''', seconds

====+Max Delay:====
{{Table373|
*Defines the maximum amount of time it takes to refire a weapon in a random fire delay range.
**This must be used with +Min Delay: to have any effect.
*Syntax: '''''Float''''', seconds}}

====+Min Delay:====
{{Table373|
*Defines the minimum amount of time it takes to refire a weapon in a random fire delay range.
**This must be used with +Max Delay: to have any effect.
*Syntax: '''''Float''''', seconds}}

===$Damage:===
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous damage, damage is approximately 5.88 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*The exact factor to multiply by is 100/17, or one 'pulse' of damage every 170 seconds. The generally used wisdom of 5.5 times may have been generally accurate before beam damage was made continuous and frame-rate independent, but is now out of date information.
*Syntax: '''''Float''''', damage
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)

===$Damage Time:===
{{Table373|
*This sets a time from the end of the weapons lifetime that damage will start to attenuate at. '''''Example: Weapon lifetime is 2.0 seconds and the desired effect is to attenuate after 0.5 seconds have passed, set this to 1.5 seconds.'''''
*Syntax: '''''Float''''', seconds. Defaults to 0.0.
**Note: If neither +Min Damage: nor +Max Damage: is set, the damage will always attenuate to zero at max range.
***If both +Min Damage: and +Max Damage: are set, both are defaulted to 0.0 and damage will be attenuated to zero.}}

====+Attenuation Damage:====
{{Table373|
*This sets the damage a weapon will attenuate to after reaching $Damage Time:.
*Syntax: '''''Float''''', damage.}}

====+Min Damage:====
{{Table373|
*This sets the lowest amount of damage possible assuming damage attenuation is taking place. '''''This has been deprecated, please use +Attenuation Damage: instead.'''''
*Syntax: '''''Float''''', damage. Defaults to 0.0.}}

====+Max Damage:====
{{Table373|
*This sets the highest amount of damage possible assuming damage attenuation is taking place. '''''This has been deprecated, please use +Attenuation Damage: instead.'''''
*Syntax: '''''Float''''', damage. Defaults to 0.0.}}

===$Angle of Incidence Damage Multiplier:===
{{Table212|
*Causes the weapon's damage to be multiplied by these factors depending on the angle of incidence.
*It is ''not'' linear, it is based on the sine of the angle to the surface. If the factors are 1x for minimum, and 2x for maximum, at an angle of 45° the multiplier is 1.707x, for instance.
====+Min:====
*The damage multiplier at a perfectly glancing hit, parallel to the surface (although not technically possible).
*Syntax: '''''Float'''''
====+Max:====
*The damage multiplier when hit straight on, perpendicular to the surface.
*Syntax: '''''Float'''''}}
{{Table240|
===$Damage Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the weapon's damage over time.
*The life of the weapon (0-1) is X, the damage multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===$Damage Type:===
{{Table3610|
Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage.

'''REQUIRES:''' [[armor.tbl]]

*Syntax: '''''String''''', name of the damage type ( as defined by [[armor.tbl#$Damage Type:|$Damage Type]] )}}

===$Arm time:===
{{Table3610|
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', seconds}}

===$Arm distance:===
{{Table3610|
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', meters}}
{{Table3615|
*This parameter is also applied to flak weapons. Previous behaviour was to arm weapons after 10 meters of travel.}}

===$Arm radius:===
{{Table3610|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

===$Detonation Range:===
{{Table3610|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

===$Detonation Radius:===
{{Table3610|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

===$Flak Detonation Accuracy:===
{{Table3615|
*Normally, flak weapons detonate at a range of 65 to 99 meters from their intended target, depending on the firing ships' weapon subsystem health. This parameter can be used to adjust this behaviour, as it defines the base range used to determine this detonation range. Standard value is 65.
*Syntax: '''''Float''''', range in meters}}

===$Flak Targeting Accuracy:===
{{Table3615|
*Turret-fired flak weapons are normally firing in a cone around the target's predicted position. This parameter can be used to adjust the size of this cones' base radius. Standard is 60 meters.
*Syntax: '''''Float''''', radius in meters}}

===$Untargeted Flak Range Penalty:===
{{Table3615|
*If a flak weapon is fired without a target selected, this parameter defines the range penalty applied to that weapon. Standard is 20 meters, meaning an untargeted flak weapon will detonate after traveling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in meters.}}

===$Shockwave damage:===
{{Table3610|
*Override for the damage caused by shockwaves (default is [[#$Damage:]])
*Syntax: '''''Float''''', damage
*Note: adding a shockwave to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x shockwave)
}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the weapon explosions
*Syntax: '''''String''''', name as defined in [[armor.tbl]]}}

===$Blast Force:===
*The intensity of the kinetic blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: '''''Float''''', blast effect

===$Inner Radius:===
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins. Damage is reduced by the square of the distance between the inner radius and outer radius. i.e. half way between inner and outer results in 1/4 damage
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*Syntax: '''''Float''''', meters

===$Outer Radius:===
*Maximum radius at which any damage is done. See $Inner Radius for the attenuation formula.
*Also defines the size of the shockwave (if shockwave speed is > 0)
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*Syntax: '''''Float''''', meters
{{Table240|
===$Shockwave Radius Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the shockwave's radius over time. This will ''ignore'' $Shockwave Speed for the purposes of determining the size of the shockwave over time, however $Outer radius / $Shockwave Speed will still be the total time that the shockwave lasts. Even if the multiplier goes beyond 1, the shockwave still cannot hit or damage targets beyond its $Outer radius.
*The life of the shockwave (0-1) is X, the outer radius multiplier is Y. This will entirely determine how the shockwave grows and shrinks over time.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===$Shockwave Speed:===
*Speed shockwave expands at. Zero means no shockwave and that any area-effect damage is applied immediately
*Syntax: '''''Float''''', meters per second

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated. Random, if left undefined.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

===$Shockwave model:===
{{Table3610|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave name:===
{{Table3610|
*Defines the name of the animation used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Shockwave Sound:===
{{Table202|
Optional sound to be used for the sound heard when for the shockwave (default is sound 109).
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Dinky shockwave:===
{{Table3610|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*It uses exactly same entries as the standard shockwaves
*'''''+Shockwave damage:'''''
*'''''+Shockwave damage type:'''''
*'''''+Blast Force:'''''
*'''''+Inner Radius:'''''
*'''''+Outer Radius:'''''
*'''''+Shockwave Speed:'''''
*'''''+Shockwave Rotation:'''''
*'''''+Shockwave Model:'''''
*'''''+Shockwave Name:'''''}}
{{Table202|
*'''''+Shockwave sound:'''''}}

===$Armor Factor:===
*Multiplier for the damage done to armor
*Syntax: '''''Float''''', damage multiplier

===$Shield Factor:===
*Multiplier for the damage done to shields
*Syntax: '''''Float''''', damage multiplier

===$Subsystem Factor:===
*Multiplier for the damage done to subsystems
*Syntax: '''''Float''''', damage multiplier

===$Lifetime Min:===
{{Table3610|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime Max:===
{{Table3610|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime:===
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targeting with certain beam types
*Syntax: '''''Float''''', seconds

{{Table250|
===$Launch Curve:===
*A set of [[modular curve]]s that controls the firing behavior of the weapon. These curves will have no effect on beams.
*Available inputs:
**'''Num Firepoints''': the number of barrels in the bank firing the weapon
**'''Distance to Target'''
**'''Target Radius'''
*Available outputs:
**'''Fire Wait Mult'''
**'''Shots Mult'''
**'''Burst Shots Mult'''
**'''Burst Delay Mult'''
**'''Velocity Mult'''
**'''Life Mult'''
**'''Failure Rate Mult'''
**'''FoF Mult'''

===$Lifetime Curve:===
*A set of [[modular curve]]s, dealing with changes to the weapon during its existence. These curves will have no effect on beams.
*Available inputs:
**'''Lifetime''': starts at 0.0 when the weapon is created, ends at 1.0 when it runs out of life
**'''Age''': how long the weapon has existed, in seconds
**'''Base Velocity''': the weapon's velocity. This accounts for launch curves, but does NOT account for other lifetime curves, so as to avoid a feedback loop.
**'''Base Damage''': the weapon's damage. This accounts for launch curves, but does NOT account for hit curves, so as to avoid a feedback loop.
**'''Max Hitpoints'''
**'''Current Hitpoints'''
**'''Hitpoints Fraction''': the weapon's current hitpoints divided by its maximum hitpoints
**'''Parent Radius''': radius of the ship ultimately responsible for firing the weapon
**'''Viewing Angle''': direction from which the player is looking at the weapon. -1.0 means directly head-on, 0.0 means directly from the side, and 1.0 means directly from the rear.
**'''Apparent Size''': the weapon's radius as a fraction of the screen height
*Available outputs:
**'''Laser Length Mult'''
**'''Laser Radius Mult'''
**'''Laser Head Radius Mult'''
**'''Laser Tail Radius Mult'''
**'''Laser Offset X Mult'''
**'''Laser Offset Y Mult'''
**'''Laser Offset Z Mult'''
**'''Laser Headon Transition Angle Mult'''
**'''Laser Headon Transition Rate Mult'''
**'''Laser Animation State''': sets the animation state of the laser, with 0.0 being the first frame of the animation, and 1.0 being the last. If this is used, all typical animation behavior (i.e. playing at a certain framerate over time) will be ignored.
**'''Laser Animation State Add''': adds a certain number of frames to the laser's animation state. Does not disable typical animation behavior on its own.
**'''Laser Alpha Mult'''
**'''Laser Bitmap R Mult'''
**'''Laser Bitmap G Mult'''
**'''Laser Bitmap B Mult'''
**'''Laser Glow R Mult'''
**'''Laser Glow G Mult'''
**'''Laser Glow B Mult'''
**'''Light Intensity Mult'''
**'''Light Radius Mult'''
**'''Light R Mult'''
**'''Light G Mult'''
**'''Light B Mult'''
**'''Detonation Radius Mult'''
**'''Turn Rate Mult'''
**'''Child Spawn Rate Mult'''
**'''Child Spawn Count Mult'''

===$Hit Curve:===
*A set of [[modular curve]]s, controlling how the weapon affects things it hits. These curves will have no effect on beams.
*Available inputs:
**'''All of the Lifetime Curve inputs, as well as...'''
**'''Target Hitpoints'''
**'''Target Radius'''
**'''Dot''': the angle at which the weapon has struck the target surface. 1.0 means a direct hit, perpendicular to the target surface. 0.0 would mean a hit exactly parallel to the surface.
*Available outputs:
**'''Damage Mult'''
**'''Hull Damage Mult'''
**'''Shield Damage Mult'''
**'''Subsystem Damage Mult'''
**'''Mass Mult'''

===$Beam Curve:===
*A set of [[modular curve]]s dealing with beam attributes. These curves only affect beams.
*Available inputs:
**'''Beam Lifetime''': the beam's lifetime, from 0.0 to 1.0, not including the warmup or warmdown phases
**'''Beam Age''': in seconds
**'''Beam Total Life''': how long the beam is capable of lasting, not including warmup or warmdown
**'''Warmup Lifetime''': lifetime of the warmup phase, starting at 0.0 and ending at 1.0 when the beam fires
**'''Warmdown Lifetime'''
**'''Warmdown Age''': time elapsed since warmdown started, in seconds
**'''Parent Radius'''
*Available outputs:
**'''Beam Width Mult''': does NOT disable tabled flickering or shrinking if set
**'''Beam Alpha Mult'''
**'''Beam Anim State''': behaves like laser anim state
**'''Muzzle Glow Radius Mult''': if this is set, the typical hardcoded muzzle glow size behaviors are disabled
**'''Muzzle Glow Alpha Mult''': if this is set, the typical hardcoded muzzle glow fading behaviors are disabled
**'''Muzzle Glow Anim State''': behaves like laser anim state
**'''Move End Position by Target Velocity''': if the beam is slashing at a target, the beam's end position will be offset by the target's velocity (at time of beam creation) times this output value

===$Beam Hit Curve:===
*A set of [[modular curve]]s dealing with beam attributes. These curves only affect beams.
*Available inputs:
**'''All of the Beam Curve inputs, as well as...'''
**'''Target Hitpoints'''
**'''Target Radius'''
*Available outputs:
**'''Damage Mult'''
**'''Hull Damage Mult'''
**'''Shield Damage Mult'''
**'''Subsystem Damage Mult'''
**'''Mass Mult'''
}}

===$Energy Consumed:===
*The amount of energy each bolt drains firing ship. Has no effect on turreted weapons.
*Syntax: '''''Float'''''

===$Cargo Size:===
*Cargo size, is not used with non-ballistic primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: '''''Float'''''

===$Autoaim FOV:===
{{Table224|
'''This option is exclusive to primaries.'''
*Defines if the weapon will have auto-aim and what the FOV of the auto-aim is.
*Syntax: '''''Float'''''}}

===$Homing:===
'''This option is exclusive to secondaries.'''
{{Table212|'''This option may now be applied to primaries'''. They may only use heat seeking. For optimal results the "no homing speed ramp" flag may be used.}}

Defines if the bolts/missiles in question is homing

If set to NO, then following fields are not required in the table.

*Syntax: '''''Boolean''''', yes or no

===='''+Type:'''====
Defines the homing method
*Syntax: '''''String''''', ''ASPECT'' or ''HEAT''
{{Table3610| An additional option, ''JAVELIN'', has been added. This behaves like an aspect missile but automatically only locks onto the engines of a target, and only if the engines are in sight.}}

===='''+Turn Time:'''====
Determines how quickly the missile can turn. Ostensibly the number of seconds it takes the missile to do a 360 degree circle at full turn speed, but for complicated reasons this is only true if [[Game_settings.tbl#.2BAI_respect_tabled_turn_time_and_rotdamp|AI respect tabled turn time and rotdamp]] is enabled.
**Syntax: '''''Float''''', seconds

===='''+Turning Acceleration Time:'''====
{{Table202|
Determines how quickly the missile reaches its maximum turn speed.
*Note: Requires [[Game_settings.tbl#.24AI_use_framerate_independent_turning:|$AI use framerate independent turning]] in game_settings.tbl
**Syntax: '''''Float''''', seconds}}
{{Table240|
===+Turn Rate Multiplier over Lifetime Curve:===
*Specifies the curve to use for changing the weapon's turn rate over time.
*The life of the weapon (0-1) is X, the turn rate multiplier is Y.
*Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

===='''+View Cone:'''====
'''Heat-seeking missiles only'''

This is the width of the weapon's viewing cone, given in degrees. Objects outside this cone are effectively invisible to the missile. The value / 2 gives the angle from the missile's centerline to the edge of the viewing cone.
*Syntax: '''''Float''''', degrees
{{Table3610| Has been enabled also to aspect seekers as an option. They will continue to home on targets outside their view cone, but will take a continuous lifetime penalty every second their target is outside this cone.}}

===='''+Min Lock Time:'''====
'''For aspect/javelin missiles only'''

The minimum number of seconds to gain a target lock.
*Syntax: '''''Float''''', seconds

===='''+Lock Pixels/Sec:'''====
'''For aspect/javelin missiles only'''
The number of pixels the aspect triangle moves per second while attempting lock-on.

*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Pixels/Sec:'''====
'''For aspect/javelin missiles only'''

The number of pixels moved per second while attempting to catch up to the target.
*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Penalty:'''====
'''For aspect/javelin missiles only'''

Extra pixels to move after catching up. (Needs verification )
**Syntax: '''''Integer''''', pixels

===='''+Seeker Strength:'''====
{{Table3610|
Defines the seeking ability of the homing system. Default of heat seekers is 3.0 and for aspect seekers 2.0. Spoofing chance is defined as '''[[#$Countermeasure:|cm type effectiveness]]'''/'''seeker strength''' (missile must be within the countermeasures '''[[#$Countermeasure:|+Effective Radius:]]'''
*Syntax: '''''Float''''', seeker strength}}

===='''+Lock FOV:'''====
{{Table234|
Defines the width of the cone within which the missile is capable of achieving a lock, in degrees. Only applies to aspect seekers.
*Syntax: '''''Float''''', default (approximately): 63.57666}}

===='''+Target Lead Scaler:'''====
{{Table3611|
Defines the type of pursuit course the missile tries to obtain.
*Values < 0 give lag pursuit, values ~ 0 give pure pursuit, values > 0 give lead pursuit.
*Syntax: '''''Float''''', default for heat seekers: 0, default for aspect or javelin seekers: 1.}}

===='''+Target Lock Restriction:'''====
{{Table202|
Defines if the missile can lock onto ships besides the current target
*Syntax: '''''String''''', name of the behavior, default is ''current target only'';.
*''Current target only'' As normal, can only acquire locks on the targeted ship
*''Any target'' Missile will lock on any valid target. Missile locking is still disabled in certain cases, such as when a friendly is the player's target
*''Current target, any subsystem'' Targeting is restricted to the current ship, but will pick turrets and subsystems on that ship. }}

===='''+Independent Seekers:'''====
{{Table202|
Defines the ability for a missile to target multiple objects at once.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Target Lock Objecttypes:'''====
{{Table220|
Defines what type of object can be locked on with this weapon
*Syntax: '''''String''''', name of the object type, default is ''ships''
*''ships'' Will target only ships
*''bombs'' Will target bombs and targetable missiles }}

===='''+Trigger Hold:'''====
{{Table202|
Defines the ability to hold the trigger to lock and release to fire.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Reset On Launch:'''====
{{Table202|
Defines the ability for locks to reset upon missiles being fired.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Max Seekers Per Target:'''====
{{Table202|
Defines the maximum number of seekers that can target a single object.
*Syntax: '''''Integer''''', number of seekers.}}

===='''+Max Active Seekers:'''====
{{Table202|
Defines the maximum number of total seekers for the weapon to have.
*Syntax: '''''Integer''''', number of seekers.}}

===='''+Ship Types:'''====
{{Table202|
Defines the ship types that this missile can target. In order for a ship to be targetable it must be able to match one of the listed types, if some of the below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', ship types.}}

===='''+Ship Classes:'''====
{{Table202|
Defines the ship classes that this missile can target. In order for a ship to be targetable it must be able to match one of the listed classes, if some of the above/below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', ship classes.}}

===='''+Species:'''====
{{Table202|
Defines the species whose ships this missile can target. In order for a ship to be targetable it must be able to match one of the listed Species, if some of the above/below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', species.}}

===='''+IFFs:'''====
{{Table202|
Defines the IFF's whose ships this missile can target. In order for a ship to be targetable it must be able to match one of the listed IFFs, if some of the above lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', IFFs.}}

===$Homing Auto-Target Method:===
{{Table214|
*If this weapon needs to acquire a target on its own, such as a heatseeker losing its target or having the "untargeted heatseeker" flag, this determines how it should do so. Options are:
*'''CLOSEST''', the weapon will acquire the nearest target that it is able.
*'''RANDOM''', the weapon will acquire a random target from those available.
}}

===$Swarm:===
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'. Does not work with player weapons.
*Is incompatible with "Corkscrew" option.
*Swarm will negatively affect the missile's ability to hit its target and will not lead its target even with [[Weapons.tbl#.2BTarget_Lead_Scaler:|Target Lead Scaler]] defined unless [[Game_settings.tbl#.24Swarmers_Lead_Targets:|$Swarmers Lead Targets]] is enabled.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table3610|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150)}}

===$Acceleration Time:===
{{Table371|
*Defines how long it takes for a secondary weapon to attain full speed. Takes precedence over $Free Flight Time (see below) in terms of the weapon's velocity, and affects both locked-on and dumbfired secondaries.
*Syntax: '''''Float''''', seconds
**Default: 0.0}}

===$Velocity Inherit:===
{{Table371|
*Defines how much of the parent ship's velocity to inherit, if [[Ai_profiles.tbl#.24use_additive_weapon_velocity:]] is used.
*Syntax: '''''Float''''', percents
**Default: 100.0}}

===$Free Flight Time:===
{{Table3610|
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: '''''Float''''', seconds
**Default: 0.25}}

'''Note:''' due to dumbfires never changing their speed, using this on a dumbfire missile will have it stuck at freeflight speed even after the end of the freeflight time.

===$Free Flight Speed:===
{{Table3613|
*Defines the speed that the weapon will be traveling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
{{Note| This feature was never implemented correctly and was removed in r8867. FSO parses but doesn't use the value, and prints a warning in the log. This feature has subsequently been reimplemented, see $Free Flight Speed Factor: below}}
}}

===$Free Flight Speed Factor:===
{{Table202|
*Defines the speed that the weapon will be traveling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
}}

===$Gravity Const:===
{{Table224|
*If the mission has gravity, this is the multiplier applied to acceleration from gravity on the weapon.
*AI will lead for ballistic trajectories, and this may affect their range as they will not fire unless they can successfully make a ballistic path to their target.
*'''Homing weapons are unaffected by gravity no matter what'''.
*Syntax: '''''Float'''''
**Default: 0}}

===$PreLaunchSnd:===
{{Table3613|
*Defines the one-shot sound effect to play at the beginning of a firing stream. Currently only has an effect on primary weapons.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
**Default: No Sound}}

===+PreLaunchSnd Min Interval:===
{{Table3613|
*Defines Minimum interval between when the player stops firing and the next time the pre-launch sound can play, as a limiter in case the player is pumping the trigger.
*Syntax: '''''Integer''''', Minimum delay in milliseconds between the end of the previous firing sequence and the next time the pre-launch sound effect will be played.
**Default: 0 (play pre-launch sound at the beginning of every firing sequence, if present)}}

===$LaunchSnd:===
*Corresponding sound effect when the weapon is launched.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$CockpitLaunchSnd:===
{{Table232|
*Corresponding sound effect when the weapon is launched from the player's ship, allowing use of 2d stereo sounds.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$ImpactSnd:===
*Sound the weapon makes when it hits a hull.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Disarmed ImpactSnd:===
{{Table3610|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$FlyBySnd:===
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

{{Table214|
===$AmbientSnd:===
*The sound this weapon passively emits in 3d space. The weapon version of [[Ships.tbl#.24EngineSnd:|EngineSnd]] for ships.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

{{Table240|
===$StartFiringSnd:===
*The sound that plays when the user presses the trigger down while this weapon is equipped.
*Does not work for turrets.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

{{Table240|
===$LoopFiringSnd:===
*The sound that plays while the user is firing the weapon and is holding the trigger down.
*Does not work for turrets.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

{{Table240|
===$EndFiringSnd:===
*The sound that plays when the user releases the trigger while this weapon is equipped.
*Does not work for turrets.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$TrackingSnd===
{{Table3615|
*The looping sound played when the player is tracking a target with this weapon.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$LockedSnd===
{{Table3615|
*The sound played when the player has locked onto their target with this weapon.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$InFlightSnd===
{{Table3615|
*The looping sound played while the player has this weapon currently flying.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Inflight sound type'''
**Specifies when the in flight sound is played.
**The value can be one of the following values which are matched case-insensitively:
***''''''TARGETED'''''': The sound is played when the missile tracks a target
***''''''UNTARGETED'''''': The sound is played when the missile is currently not tracking a target
***''''''ALWAYS'''''': The sound is played always}}

===$Model:===
{{Table3610|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

===$Rearm Rate:===
*Defines the frequency that weapons are loaded to the ship
*Syntax: '''''Float''''', How many times per second the weapons are loaded.
**Example: 2.0 will reload every half second. 0.1 will load every ten seconds.

===$Rearm Ammo Increment:===
{{Table38|
*Defines how many missiles or how much ballistic ammo is loaded per load sound.
*Syntax: '''''Integer''''', how many bullets or missiles are loaded. Default 4 for missiles, 100 for ballistic primaries.}}

===+Weapon Range:===
*If set, the AI will use this value or the result of weapon lifetime * velocity as the weapon's effective range, whichever is lower. This also affects the [[Hud_gauges.tbl#Lead_Indicator|Lead Indicator]]
*Syntax: '''''Float''''', meters

===+Weapon Min Range:===
{{Table3610|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', meters}}

===+Weapon Optimum Range:===
{{Table214|
*AI fightercraft will attempt to close the distance to their target while they are outside of this range and using this weapon as their currently equipped primary.
*Syntax: '''''Float''''', meters}}

===$Pierce Objects:===
{{Table212|
*Causes the weapon to penetrate the objects impacted and not be destroyed.
*Syntax: '''''Boolean'''''
====+Spawn Children On Pierce:====
*Will spawn the weapons children on each hit, not just when it eventually gets destroyed through lifetime
*Syntax: '''''Boolean'''''}}

===$Flags:===
*See [[Weapons.tbl#Weapons.tbl_Flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the weapon
**Example: ( "Player allowed" "in tech database" )

{{Table3610|
*Can be followed by '''+override''' option in order to reset the weapon flags before parsing in the new ones
*Using this option will erase all '''homing'''-related flags as well as '''swarm''', '''variable lead''', '''trail''', '''TAG''', and '''transparent''' settings in addition to the listed flags. All these should be set again - if they are required - when this option is used.

**Syntax: '''''+override'''''}}

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
{{Table212|
*'''+Alpha Decay Exponent:'''
**Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
**Larger numbers above 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Smaller numbers below 1 cause it to fade away quickly at first, and then slow down for most of its life.
**Syntax: '''''Float''''', positive}}
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
{{Table202|
*'''+Spread:'''
**Causes the trail points to diffuse and drift apart at this speed over time.
**Syntax: '''''Float''''', meters per second}}
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table212|
*'''+Bitmap Stretch:'''
**Multiplies how far the bitmap is stretched over each trail segment.
**Syntax: '''''Float'''''}}
{{Table3611|
*'''+Faded Out Sections:'''
**Defines the number of the trail sections (counting from the leading edge) which are gradually faded out.
**Syntax: '''''Integer''''', number of trail sections}}

===$Icon:===
*Loadout icon used in the weapons selection screen.
*Syntax: '''''String''''', filename

===$Anim:===
*Green grid animation used on the weapons screen.
*Syntax: '''''String''''', filename

===$Collide Ship:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Collide Weapon:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Impact Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for impacts of this weapon.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Impact Explosion'' and ''$Impact Explosion Radius'' are not valid options!
}}

===$Impact Explosion:===
*Impact explosion used. Must be defined in weapon_expl.tbl,
{{Table190|
*A weapon_expl.tbl entry is no longer required.}}
*Syntax: '''''String''''', filename or ''none''

===$Impact Explosion Radius:===
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters, default 1.0

===$Shield Impact Explosion Radius:===
{{Table373|
*Radius of the impact explosion if it hits the shield, see [[Ships.tbl#.24Shield_Impact_Explosion:]].
*Syntax: '''''Float''''', meters, defaults to value of $Impact Explosion Radius}}

===$Shield Impact Effect Radius:===
{{Table250|
*Radius of the visual effect displayed on the shield mesh when this weapon hits the shield, see also [[Ships.tbl#.2BMax Shield Impact Effect Radius:]].
*Syntax: '''''Float''''', meters.
*Default: Half of the target's length width or depth, whichever is smallest.}}

===$Dinky Impact Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for Dinky (not armed) explosions of this weapon.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Dinky Impact Explosion'' and ''$Dinky Impact Explosion Radius'' are not valid options!
}}

===$Dinky Impact Explosion:===
{{Table3610|
*Same as Impact Explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

===$Dinky Impact Explosion Radius:===
{{Table3610|
*Same as Impact Explosion Radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

===$Piercing Impact Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for piercing impacts.
*Syntax: '''String''', the particle effect name
*If this option is specified then piercing impact options below are not valid!
}}

===$Piercing Impact Explosion:===
{{Table3611|
*Defines the effect used for events when weapon pierces the target
*Syntax: '''''String''''', filename or ''none''}}

===$Piercing Impact Radius:===
{{Table3611|
*Defines the base radius of the effect used for piercing weapon impacts
*Syntax: '''''Float'''''}}

===$Piercing Impact Velocity:===
{{Table3611|
*Defines the base velocity for the particles piercing the target
*Syntax: '''''Float'''''}}

===$Piercing Impact Splash Velocity:===
{{Table3611|
*Defines the base velocity for the particles splashing from the target (secondary piercing effects
*Negative value causes the second batch or particles to splash to opposite direction
*Syntax: '''''Float'''''}}

===$Piercing Impact Variance:===
{{Table3611|
*Defines the variance added to the particles
*Values near 0 cause very little variance and values close to 1 cause extreme dispersal.
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the lifetime of the effect for single frame effects
*For multiple frame effects the lifetime is the lifetime of the animation used
*Syntax: '''''Float'''''}}

===$Piercing Impact Particles:===
{{Table3611|
*Defines the number of particles released per impact
*Syntax: '''''Integer'''''}}

===$Piercing Impact Draw Modifier:===
{{Table3611|
*Defines the multiplier applied to the ships piercing effect limit percentage
*Syntax: '''''Float'''''}}
*Option removed in 3.6.12. Use [[armor.tbl]] to finetune piercing effects.

===$Conditional Impact:===
{{Table242|
*Defines an impact effect that will play for this weapon only under certain conditions.
*May be defined any number of times.
*Currently only works for targets that are ships or weapons. Impacts against weapons are not considered to have a hit angle.
*All conditional impacts whose requirements are met will play.
*Non-conditional impact effects, the ones defined above, will only play if no conditional impacts' requirements are met.
*'''+Armor Type:'''
**Name of armor type the target must have in order for this impact to play. Shields can have their own armor types. (Subsystems can as well, but at present this system will not detect that.)
**Syntax: ''''''String'''''', name of armor type in [[armor.tbl]]
*'''+Min Health Threshold:'''
**Fraction of target health below which impact will not play. Health is calculated separately for individual shield quadrants and hull.
**Optional; defaults to 0.0.
**Syntax: ''''''Float'''''', fraction of health from 0.0 to 1.0
*'''+Max Health Threshold:'''
**Fraction of target health above which impact will not play. Health is calculated separately for individual shield quadrants and hull.
**Optional; defaults to 1.0.
**Syntax: ''''''Float'''''', fraction of health from 0.0 to 1.0
*'''+Min Angle Threshold:'''
**Hit angle -- that is, the angle measuring how 'straight on' you're hitting the target surface -- below which impact will not play.
**Optional; defaults to 0.0.
**Syntax: ''''''Float'''''', degrees
*'''+Max Angle Threshold:'''
**Hit angle above which impact will not play.
**Optional; defaults to 180.0.
**Syntax: ''''''Float'''''', degrees
*'''+Dinky:'''
**Whether to play if and only if the weapon is not armed. If false, the impact will not play if the weapon is not armed.
**Optional; defaults to false.
**Syntax: ''''''Boolean''''''
*'''+Effect Name:'''
**Name of [[Particle Effects|particle effect]] that will play when conditions are met.
**Syntax: ''''''String'''''', name of effect
}}

===$Inflight Effect:===
{{Table38|
*Sets the inflight [[Particle Effects|particle effect]] which is used when the laser is active. This is only used by laser weapons.
*Syntax: '''''String''''', the particle effect name
}}
===$Freeflight Effect:===
{{Table38|
*Sets the [[Particle Effects|particle effect]] which is used when the missile is in the free flight phase. See [[#$Free Flight Time:|$Free Flight Time]] for more information.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Ignition Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is transitioning from free flight to homed or unhomed flight.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Homed Flight Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is in homed flight mode.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Unhomed Flight Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is in unhomed flight mode.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}

===$Muzzleflash:===
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: '''''String''''', muzzleflash name, as defined in [[mflash.tbl]]

===$Muzzle Effect:===
*Defines the [[Particle Effects|particle effect]] used when the weapon fires. For muzzle effects, +Parent Velocity Factor uses the velocity of the firing ship, not the weapon.
*Syntax: '''''String''''', the particle effect name

===$EMP Intensity:===
*How deeply an EMP effect scrambles your electronics
**Needs the [[#EMP|EMP]] flag set to have any effect
*Basically a percentage, a value of 250 results in a 25% chance of something getting scrambled each frame.
*Maximum value of 500.0
**Syntax: '''''Float''''' (defaults to 300.0)

===$EMP Time:===
*Duration of the EMP effect
**Needs the [[#EMP|EMP]] flag set to have any effect
**Syntax: '''''Float''''', seconds (defaults to 10.0)

===$Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note| The "apply recoil" weapon flag must be set for this to be valid. If the flag is not set, FSO will throw a warning and automatically set it at runtime.}}
}}

===$Leech Weapon:===
**The amount of weapon energy to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Leech Afterburner:===
**The amount of afterburner fuel to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Vampiric Healing Factor:===
{{Table224|
*Multiplier for how much the shooter is healed after dealing hull damage (1.0 means healing done is equal to damage dealt)
**Needs the [[#Vampiric|Vampiric]] flag set to have any effect
*Must be a positive number higher than 0.0
**Syntax: '''''Float''''' (defaults to 1.0)
}}

===$Corkscrew:===
{{Table3610|
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

===$Electronics:===
{{Table3610|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent: FreeSpace.
}}
{{Table371|
*'''+Area Of Effect'''
**If specified, allows the electronics effect to apply to every ship hit by this weapon's blast or shockwave (the "Electronics" flag isn't necessary with this option).
}}
{{Table3610|
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. '''''Has been deprecated'''''.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsystems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.

}}

===$Spawn Angle:===
{{Table3610|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missile's centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Like all spawn options, Spawn Angle should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', degrees, default is 180}}

===$Spawn Minimum Angle:===
{{Table202|
*Defines an inner angle for the cone within which the spawned weapons appear. ''Value'' gives the angle from the missile's centerline.
*Like all spawn options, Spawn Minimum Angle should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', degrees, default is 0}}

===$Spawn Interval:===
{{Table202|
*Causes the associated spawn event to happen continuously at this time interval. Enabling this will prevent the spawn event from triggering on detonation.
*NOTE: Having very large numbers of total children (low interval and/or high count) can cause issues for multiplayer, and you will be warned in multiplayer if the total count is greater then 300.
*Like all spawn options, Spawn Interval (and its associated Delay) should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', seconds, minimum is 0.1, '''You will not be warned for a negative spawn interval. ''' The value will be ignored and the spawn will be treated as a regular detonate spawn if negative. This is on purpose so that continuous/detonate spawns can be set regardless of the order in which they are defined in the flags.}}

====+Delay:====
{{Table202|
*Continuous spawn will not begin until this has elapsed.
*Syntax: '''''Float''''', seconds, default is 0}}

===$Spawn Effect:===
{{Table202|
*Specifies the [[Particle Effects|particle effect]] which will be used for continuous spawns of this weapon. Will not be used for detonation.
*Like all spawn options, Spawn Effect should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''String''', the particle effect name}}

===$Local SSM:===
{{Table3610|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

===$Countermeasure:===

*Defines the countermeasure effectiveness, radius, etc
{{note|
*Spoofing chance is defined as '''cm type effectiveness'''/'''[[#+Seeker Strength:|seeker strength]]''' (missile must be within the countermeasures '''+Effective Radius:''').
*All countermeasures in the mission perform tests to spoof missiles for two frames after '''any countermeasure''' is created in the mission. No, this doesn't seem to make much sense.
{{Table382|The global frame counter can be bypassed by using '''[[#+Pulse Interval:|pulse interval]]'''.}}
*'''Provisional'''; Countermeasures are only given one chance to spoof any individual missile. This makes tuning seeker strength/effectiveness meaningful.
**Previously some record of which countermeasures had been seen by each missile was kept, but it broke when multiple countermeasures were involved. A good chance of breaking with two countermeasures, and a guaranteed chance of breaking with three or more. This reduced the impact of the seeker strength/effectiveness ratio, but was partly cancelled out by the 2 frames thing.
}}

{{Table3610|
===='''+Heat Effectiveness:'''====
*Defines the countermeasures effectiveness against heat seeking missiles
*Syntax: '''''Float''''', cm effectiveness
**Default: 1.0

===='''+Aspect Effectiveness:'''====
*Defines the countermeasures effectiveness against aspect seeking missiles
*Syntax: '''''Float''''', cm effectiveness
*Default: 1.0

===='''+Effective Radius:'''====
*Defines the countermeasures effective radius
*Syntax: '''''Float''''', meters
**Default: 300.0
}}

{{Table373|
====+Missile Detonation Radius:====
*Defines the radius within which a missile homing on this countermeasure will trigger a detonation (see '''+Single Missile Kill:''')
*Syntax: '''''Float''''', meters
**Default: 40.0
{{note| only affects missiles homing on countermeasures, i.e. heat or aspect with "pulls aspect seekers" flag}}

====+Single Missile Kill:====
*Defines if countermeasures will detonate only the missile homing on this countermeasure, or every missile within '''+Missile Detonation Radius:'''
*Syntax: '''''Boolean'''''
**Default: false
{{note| only affects missiles homing on countermeasures, i.e. heat or aspect with "pulls aspect seekers" flag}}
}}

{{Table382|
====+Pulse Interval:====
*Defines how much time passes between each pulse of this countermeasure.
*Syntax: '''''Float''''', milliseconds
**Default: 0
{{note| any value less than or equal to 0 means the countermeasure doesn't pulse, and uses the global 2-frame counter after any countermeasure is fired.}}
}}

{{Table212|
====+Use Fire Wait:====
*Makes the countermeasure fire wait use what is specified in the '''$Fire Wait:''' section of the weapon.
*Default countermeasure fire wait is 333 milliseconds, regardless of that value was set in '''$Fire Wait:'''.

====+Failure Launch Delay Multiplier for AI:====
*After a failed countermeasure launch the game waits a certain time interval before attempting another launch.
*Previously, the amount of time was calculated as ('fire wait' + 2000 * 'countermeasure firing chance').
*If set to a non negative number, this value will be multiplied to the fire wait value to determine the amount of time before another countermeasure can be attempted.
*Syntax: '''''Float'''''
**Default: -1
{{note| any value less than 0 means the default formula will be used.}}

====+Successful Launch Delay Multiplier for AI:====
*After a successful countermeasure launch the game waits a certain time interval before attempting another launch.
*This value is multiplied to the fire wait value to determine the amount of time before another countermeasure can be attempted.
*Syntax: '''''Float'''''
**Default: 2
{{note| any value less than 0 means the default value will be used.}}

}}

===$BeamInfo:===
*'''+Type:'''
*Defines the type of beam in question. This can be a number or, as of 21.4, a named type. Options are:
**''0'' or ''Direct fire'', a standard non-slashing type beam that fires directly at a random point on the target's hull
**''1'' or ''Slashing'', a slashing type beam, that slashes between opposing corners of the ship
**''2'' or ''Targeting'', a targeting beam that is used to trigger SSMs.
**''3'' or ''Antifighter'', a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles.
**''4'' or ''Normal Fire'', a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
{{Table214|
**''5'' or ''Omni'', a highly flexible kind of beam with many options for its exact behavior. See $Type 5 Beam Options below.}}
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
{{Table250|
*'''+Muzzle Particle Effect:
**Specifies the [[Particle Effects|particle effect]] which will be used for the muzzle warmup particles of this beam.
**Syntax: '''String''', the particle effect name
**If this option is specified then ''+PCount'', ''+PRadius'', ''+PAngle'' and ''+PAni'' are not valid options!
}}
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
{{Table3613|
*'''IFF specific miss factors'''
**Identical to the preceding entry but IFF specific. Replace the <IFF> with the name of the IFF from [[iff_defs.tbl]]
**Syntax: '''''+<IFF> Miss Factor:''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5}}
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', filename
{{Table372|
*'''+Directional Glow:'''
**Defines the length to stretch the muzzleglow along the beam.
**Syntax: '''''Float''''', length in meters, the muzzleglow is rendered along (in the same plane) as the beam instead of perpendicular to the camera.}}
{{Table240|
*'''+Opacity over Lifetime Curve:'''
**Specifies the curve to use for changing the beam's opacity over time.
**The life of the beam while firing (0-1) is X, the opacity is Y, where 0 is invisible and 1 is typical opacity.
**Syntax: ''String'', the name of the curve from [[Curves.tbl]]}}
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**ALSO AFFECTS FIGHTER BEAMS. If greater than 0, fires from up to that many fire points at a time before cycling. 1 mimics the behavior of weapons with the "cycle" flag, 0 fires from all available fire points like normal weapons.
**Syntax: '''''Integer''''', Default: 1
*'''+ShrinkFactor:'''
**How much of the beam's life is remaining before it starts to shrink in width. (0.1 means 10% life left)
**Syntax: '''''Float''''', value from 0 to 1
*'''+ShrinkPct:'''
**The beam's width factor is reduced by this amount every second. For example, a value of 0.25 means the beam is at 75% width after 1 second, 50% after 2, 25% after 3, and by 4 seconds it reaches the minimum size of 10%.
**Syntax: '''''Float''''', a positive value
{{Table202|
*'''+GrowFactor:'''
**How much of the beam's life is remaining before it starts to grow in width. (1.0 means as soon as the beam fires)
**Syntax: '''''Float''''', value from 0 to 1
*'''+GrowPct:'''
**The beam's width factor is increased by this amount every second. For example, a value of 0.25 means a beam starting at 0% is at 25% width after 1 second, 50% after 2, 75% after 3, and by 4 seconds it reaches the maximum size of 100%.
**Syntax: '''''Float''''', a positive value
*'''+Initial Width Factor:'''
**What factor of the beam's maximum width it starts with.
**Syntax: '''''Float''''', value from 0 to 1}}
{{Table3610|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', from 0 - firing point to 1 - no effect
***Default: 1}}
{{Table3611|
*'''+BeamWidth:'''
**Defines the width of the beam for collision test purposes instead of using widest beam section.
**Syntax: '''''Float''''
{{Table222|
*'''+Beam Light Flickers:'''
*Controls if the dynamic flickering of the beam width is applied to the light cast by the beam as well
*Syntax: '''''boolean'''''
*Default value: True
*'''+Beam Width Multiplies Light Radius:'''
*Controls if the light radius of a beam is multiplied by the beam width.
*Syntax: '''''boolean'''''
*Default value: True}}
{{Table38|
*'''+Beam Flash Particle Effect:'''
**Specifies the beam flash [[Particle Effects|particle effect]].
**Syntax: '''''String''''', particle effect name
**If this is specified then '''+Beam Flash Effect''' and '''+Beam Flash Radius''' are not valid options!
}}
*'''+Beam Flash Effect:'''
**Defines the additional impact flash effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Flash Radius:'''
**Defines the radius for the additional impact flash effect.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect:'''
**Defines the beam piercing (bursting flames) effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Piercing Radius:'''
**Defines the average radius used for the beam piercing effects.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Velocity:'''
**Defines the base velocity for the piercing effects
**Syntax: '''''Float'''''
*'''+Beam Piercing Splash Effect Velocity:'''
**Defines the base velocity for the secondary piercing effects
**Negative velocity causes the particles to move to opposite direction
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Variance:'''
**Defines the variances of the particles from the main path
**Values close to 0 cause minimum variance, higher values cause higher variances
**Syntax: '''''Float'''''}}

{{Table214|
*'''$Type 5 Beam Options:'''
**Species the unique attributes for type 5 beams. '''None of these properties will be used if the weapon is not a type 5 beam.'''
**Fundamentally, type 5 beams are slashing type beams, where the start and end positions refer to physical positions in space (and not angles from the point of view of the shooter) and have many parameters for choosing their positions, including having them be on top of each other, and thus forgoing standard slashing behavior, and also for having rotations, both during the beam firing and in between firings.
*'''+Start Position:'''
**Determines how the starting position should be chosen. Options are:
***'''RANDOM ON SHIP''', Like type 0 direct-fire beams, chooses a random spot on the target's geometry.
***'''RANDOM OFF SHIP''', Like type 1 slash beams, chooses a random spot just outside of the target's geometry.
***'''CENTER''', Chooses the center of the target.
*'''+Start Position Offset:'''
**Displaces the chosen start position in the specified direction and by the specified amount.
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, -0.2, -0.9"
*'''+Start Position Randomness:'''
**Further displaces the chosen start position but to a random degree in the specified axes from the number provided to its negative (i.e. a value of 1 will randomly choose between 1 and -1).
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, 0.2, 1"

*The following three fields can skipped, and the beam will not traditionally sweep like a slash beam (although it may still rotate).
*'''+End Position:'''
**Determines how the starting position should be chosen. Options are:
***'''RANDOM ON SHIP''', Like type 0 direct-fire beams, chooses a random spot on the target's geometry.
***'''RANDOM OFF SHIP''', Like type 1 slash beams, chooses a random spot just outside of the target's geometry.
***'''CENTER''', Chooses the center of the target.
***'''SAME RANDOM''', If the start position was randomly determined, this will cause the end position to inherit that position (it will not inherit offset or randomness, only the randomness from RANDOM ON/OFF SHIP).
*'''+End Position Offset:'''
**Displaces the chosen end position in the specified direction and by the specified amount.
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, -0.2, -0.9"
*'''+End Position Randomness:'''
**Further displaces the chosen end position but to a random degree in the specified axes from the number provided to its negative (i.e. a value of 1 will randomly choose between 1 and -1).
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, 0.2, 1"
{{Table242|
*'''+Slash position over beam lifetime curve:'''
**Curve defining the beam's slash position over its lifetime.
***X is the beam's lifetime, with 0 being the beginning and 1 the end. Y is slash position, with 0 being the start position and 1 the end position. Values outside of the 0-1 range will work.
***This is optional.
***Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

*'''+Orient Offsets to Target:'''
**This determines the orientation of the offsets and randomness.
**If this is set to ''TRUE'' then the x, y, and z, directions used refer to the target's x, y, and z coordinates. X being left/right, Y being up/down, Z being front/back. A start offset of 0, 0, 1, and an end offset of 0, 0, -1 would always cause the beam to fire at the target's bow and sweep to its aft, no matter which way the shooter is oriented.
**If this is set to ''FALSE'' then the x, y, and z, directions used refer to the shooter's x, y, and z coordinates. Using the z coordinate with this being false will have little effect. A start offset of 1, 0, 0, and an end offset of -1, 0, 0 would always cause the beam to fire towards the target, but to the shooter's right, and sweep in the direction of the shooter's left, regardless of how the target is oriented.
**Syntax: '''''Boolean''''', yes or no, Default: No
*'''+Scale Offsets to Target:'''
**This determines what a magnitude of 1 on the offsets and randomness mean.
**If this is set to ''TRUE'' then a value of 1 for a coordinate means a position in the chosen direction but at a distance equal to the target's radius. Values greater than 1, will drift further and further from the target entirely, while smaller than 1 will bring it closer to its originally chosen start position.
**If this is set to ''FALSE'' then it is as though it were firing at a target with a 300m radius at a 300m distance. A value of 1 corresponds to 45 degrees, which it will start at regardless of the distance of the target. Values greater than 1 will increase beyond 45 degrees but will never exceed 90 degrees
**Syntax: '''''Boolean''''', yes or no, Default: No

*'''+Continuous Rotation:'''
**This defines the degrees per second that the beam will rotate while it is firing.
**Syntax: '''''Float''''', degrees per second
*'''+Continuous Rotation Axis:'''
**This defines the axis about which the beam will continuously rotate. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will rotate about the start position before the offset or randomness were applied. A beam which does not slash (end position paramters omitted), but is offset and rotates about this axis will trace out circles, for instance.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will rotate about the final start position after offset and randomness have been applied. If this beam slashes (end position paramters specified) it will trace out a spiral.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will rotate about the center of the target.
{{Table242|
*'''+Rotation over beam lifetime curve:'''
**Curve defining the beam's rotational position over its lifetime.
***X is the beam's lifetime, with 0 being the beginning and 1 the end. Y is rotational position, with 0 being no rotation and 1 being a full 360-degree turn. Values outside of the 0-1 range will work.
***This is optional.
***If a rotation curve is defined, "+Continuous Rotation" will do nothing.
***Syntax: ''String'', the name of the curve from [[Curves.tbl]]
}}

*'''+Burst Rotation Pattern:'''
**Defines a list of rotations, for the final start and end positions to be performed right before firing for each specific shot in a burst (will not rotate the beam while firing). '''You will not be warned for failing to give this weapon burst capability''', because on spawned or subspace strike beams, providing a pattern has the additional effect of spawning multiple copies of this weapon all at once, each one corresponding to another entry in the pattern.
**For instance, a standard slash with a rotation pattern of (0, 180) will cause the beam weapon to slash back and forth, or in a scissor pattern if the burst is very short and the beams fire at similar times.
**(0,120,240) will have 3 slashes in a triangular pattern.
**If a RANDOM ON/OFF SHIP option has been chosen for the start or end positions, the "burst shares random target" flag may be used so all shots in the burst share the same random position.
**If any values are '''''negative''''' they will instead use a random amount of rotation for that entry.
**Syntax: '''''List of Floats''''', degrees. Example: (0, 90, 180, 270)
*'''+Burst Rotation Axis:'''
**The axis about which to rotate for the burst rotation pattern. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will be rotated about the start position before the offset or randomness are applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will be rotated about the final start position after offset and randomness have been applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will be rotated about the center of the target.
*'''+Per Burst Rotation:'''
**Will rotate the final start and end positions, possibly in addition to the burst rotation pattern, for each burst of the beam, or every shot if not a burst weapon.
**If this value is '''''negative''''' this will instead be treated as a random amount of rotation.
**Syntax: '''''Float''''', degrees.
*'''+Per Burst Rotation Axis:'''
**The axis about which to rotate for the per burst rotation. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will be rotated about the start position before the offset or randomness are applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will be rotated about the final start position after offset and randomness have been applied.
***'''END POSITION AFTER OFFSET''', as above but for the end position.
***'''CENTER''', the beam will be rotated about the center of the target.
}}
{{Table232|
*'''+Firing Length Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be created along the entire active length of the beam while it is firing and active.
*Note that the <tt>+Particle Count Per Spawn:</tt> (or <tt>+Number:</tt> for legacy particles) for the effect used will be ''per kilometer of length''.
*[[Particle Effects#+Parent Velocity Factor:|Parent Velocity Factor]] also works, inheriting the [[#$Velocity:|Velocity]] of this weapon.
*Syntax: '''String''', the particle effect name
}}
{{Table232|
*'''+Paused Length Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be created along the length of the beam while it is firing, but in between bursts of a type 4 anti-fighter beam.
*Note that the +Number for the effect used will be ''per kilometer of length''.
*[[Particle Effects#+Parent Velocity Factor:|Parent Velocity Factor]] also works, inheriting the [[#$Velocity:|Velocity]] of this weapon.
*Syntax: '''String''', the particle effect name
}}
{{Table212|
*'''+Beam Flags:'''
*Extra flags specific to beams
**'''burst shares random target''', all shots from this beam weapon in the same burst will target the same random point (or slash direction)
**'''track own texture tiling''', the 'U' position of the beam texture, whose speed is set by '''+Translation:''' below, is tracked independently, rather than being shared among all beams like normal.
}}
{{Table250|
**'''direct fire lead target''', if the beam is direct fire (type 0), makes the beam aim for the target's predicted position when the beam initially starts warming up, allowing the target to 'dodge' the beam.
}}

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
{{Table3610|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**Only valid when editing beam sections that already exist in other tables. Attempting to index new sections will generate warnings, adding new sections is the default behavior for un-indexed sections.
:**Syntax: '''''Integer''''', index number legal values are from 0 to 5
:*'''+remove'''
:**Removes the set beam section.
:*'''+nocreate'''
:**Does not create new section for the beam}}

:*'''+Width:'''
:**Width of the section
:**Syntax: '''''Float''''', meters
:*'''+Texture:'''
:**Texture for the section
:**Syntax: '''''String''''', filename
:*'''+RGBA Inner:'''
:**Defines the color and transparency of the center of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 255 255 255 255
:*'''+RGBA Outer:'''
:**Defines the color and transparency of the edges of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be. (Zadd can be safely ignored; it actually does nothing.)
:**Syntax: '''''Float'''''
{{Table3610|
:*'''+Tile Factor:'''
:**Defines the beam texture tiling factor. Second number defines the tiling type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

===$Pspew:===
{{Table3610|
*Defines a particle spew effect for the given weapon
}}{{Table3613|
*'''+Index:'''
**indicates which spewer to add/edit/delete. may be 0-3. used for xmt compatibility.
{{Table250|
**May be any positive number.
}}
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
{{Table250|
*'''+Effect:'''
**Specifies the [[Particle Effects|particle effect]] which will be used for this Pspew.
**Syntax: '''String''', the particle effect name
**If this option is specified then ''+Type'', ''+Count'', ''+Time'', ''+Vel'', ''+Radius'', ''+Life'', ''+Scale'', ''+Z Scale'', ''+Rotation Rate'', ''+Offset'', ''+Initial Velocity'' and ''+Bitmap'' are not valid options!
}}
*'''+Type:'''
**type of particle spew
**Syntax: '''''String'', Default, Helix, Sparkler, Ring, or Plume '''
}}{{Table3610|
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created (at each +Time: interval)
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**typically controls how big the effect is or how fast it moves away from the weapon path on a perpendicular (or sometimes arbitrary) axis.
**helical spews and rings use this value to control how fast the particle helix moves away from the central axis.
**sparklers use this to control how fast particles move away from the spawn point, in any direction
**plumes use this to set the diameter of the disk across which particles are spawned
**Syntax: '''''Float'''''
}}{{Table3613|
*'''+Z Scale:'''
**for sparklers, allows you to elongate the effect to surround other effects, like lasers. essentially a length multiplier
**for plume, it multiplies against +scale to set the plume to spread or converge, zero would be full convergence, 1 would be straight flight, and bigger numbers would cause particles to diverge from the disk.
**Syntax: '''''Float'''''
*'''+Rotation Rate:'''
**used only by helical spews, controls how many rotations per second the helix makes
**Syntax: '''''Float'', may be negative, useful for setting up 2 spews that spin in opposite directions'''
*'''+Offset:'''
**position of effect with regards to the weapon center
**Syntax: '''''Vector'''''
*'''+Initial Velocity:'''
**to indicate both direction and speed of particle effects regards to the weapon velocity and +scale:
**Syntax: '''''Vector'''''
}}{{Table3610|
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', filename}}

===$Tag:===
*Allowed for secondary weapons
{{Table3610|
*Allowed for primary weapons and secondary weapons}}

*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illuminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
{{Table3610|
*TAG Level 3 allows the weapon to trigger [[Weapon.tbl#$SSM:|SSMs]]}}

*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively
*'''Note''': TAG will not trigger unless the weapon in question has a non-zero damage value.

===$SSM:===
{{Table3610|
*Defines the weapons SSM index number.
*Requires [[Weapons.tbl#$Tag:|TAG level 3]] or a targeting beam.
*Syntax: '''''Integer'''''}}
{{Table373|
*Now also accepts SSM strike names.
*Syntax: '''''String'''''}}

===$FOF:===
{{Table3610|
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: '''''Float''''', degrees}}

====+FOF Spread Rate:====
{{Table37|
*Defines the spread rate of the field of fire. This is a percentage of the +Max FOF: defined below, and is applied each time the weapon is fired. For exaple, a value of 0.1 causes the field of fire to increase by 10% of the +Max FOF: per trigger pull. This is unaffected by the number of fire points.
*Syntax: ''''''Float'''''', rate}}

====+FOF Reset Rate:====
{{Table37|
*Rate at which the spread decreases if the weapon isn't firing. This is a percentage of the +Max FOF: defined below, and is applied once per second. For example, a value of 0.1 causes the field of fire to decrease by 10% of the +Max FOF: per second.
*(If you want to get technical, this is applied every frame, but scaled by the percentage of a second that frame represents. For almost all practical purposes, saying it's applied once per second is equivalent, and makes the calculation easier to think about.)
*Syntax: ''''''Float'''''', rate
*This is required if '''+FOF Spread Rate:''' is present}}

====+Max FOF:====
{{Table37|
*The maximum FOF. After the FOF reaches this value it will not increase any further.
*Syntax: ''''''Float'''''', degrees. Must be greater than or equal to zero.
*This is required if '''+FOF Spread Rate:''' is present}}
{{Table242|
As of 24.2, this can be specified without also specifying <tt>+FOF Spread Rate:</tt>.}}

===$Firing Pattern:===
{{Table250|
*Determines the order in which the weapon is fired from a bank's gunpoints. Does nothing for secondary weapons.
*This is optional. If a firing pattern is not set, the weapon will fire from all gunpoints simultaneously, as is standard retail behavior.
*If a firing pattern is set, the weapon's '''$Fire Wait''' will be divided by the number of gunpoints in the bank, so as to keep shots-per-second constant.
*Has five options:
**'''CYCLE FORWARD''': Fires '''$Shots''' shots from the first '''$Shots''' gunpoints (starting at gunpoint 0), then from the next '''$Shots''' gunpoints, and so on.
**'''CYCLE REVERSE''': Same behavior as CYCLE FORWARD, but begins at the highest-numbered gunpoint and works downward.
**'''RANDOM EXHAUSTIVE''': Fires '''$Shots''' shots at a time from randomly-selected gunpoints until each gunpoint has been fired once, and then starts over.
**'''RANDOM NONREPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time, but never fires the same gunpoint twice in a row (unless forced to because $Shots is equal to more than half the number of gunpoints).
**'''RANDOM REPEATING''': Fires '''$Shots''' randomly-selected gunpoints at a time. No restrictions.
*Syntax: ''''''String''''''}}

===$Shots:===
{{Table3610|
*Defines the number of shots created at each firepoint each time the weapon is fired. Produces shotgun-like behavior if used with '''$FOF'''.
*If the weapon has a non-standard firing pattern, instead determines the number of firepoints fired at a time.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$Cycle Multishot:===
{{Table250|
*If the weapon has a non-standard firing pattern, defines the number of shots created at each firepoint. Otherwise, does nothing.
*Syntax: ''''''Integer'''''', number of shots}}

===$decal:===
{{Table3610|
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}
{{Table3613|
*Feature removed - table parsing retained to maintain compatibility}}

===$Impact decal:===
{{Table190|
*Defines an impact decal (think bullet impact/scorch mark) using the new system introduced in FSO 19.0.0.
**Syntax: '''''String''''', this must match to one of the entries in a [[Decals|decal tbm]].
*'''+Radius:'''
**Syntax: '''''[[Parsed random range]]''''', Radius of the impact decal; default is 1.0
*'''+Lifetime:'''
**Syntax: Either '''''Eternal''''' or '''''[[Parsed random range]]''''', lifetime in seconds
}}
{{Table224|
*'''+Use Random Rotation:'''
**Syntax: '''''Boolean''''', Whether or not a random rotation is added to the decal; default is NO
}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strength of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

===$Weapon Hitpoints:===
{{Table3611|
*Defines the amount of hitpoints a weapon has.
*Weapons with '''"bomb"''' flag have 50 hitpoints by default
*Giving weapon hitpoints makes it possible for the weapon to be shot down or be destroyed by EMP.
**Syntax: '''''Integer'''''
}}

===$Armor Type:===
{{Table3613|
*REQUIRES ADDITIONAL TABLE. Defines the armor type for the weapon. This works exactly like ship armor types.
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]
}}

===$Burst Shots:===
{{Table3611|
*Defines the number of shots in a burst
*Shots in a burst use shorter ( '''$Burst Delay:''' ) delay than usually
*If this weapon is cycling each individual firing event counts as one burst shot, so bursts end sooner in time for large banks than small.
**Syntax: '''''Integer'''''}}

===$Burst Delay:===
{{Table3611|
*Defines the time in milliseconds between the shots in a burst
**Syntax: '''''Integer'''''}}

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}
{{Table202|'''"resets"''', as long as a full fire wait has passed since last fired, the burst is reset and can be fired in full again.}}
{{Table220|'''"num firepoints for burst shots"''', for turrets, makes the burst length equal to the number of firepoints on the turret.}}
{{Table240|'''"burst only loop sounds"''', StartFiringSnd, LoopFiringSnd, and EndFiringSnd, if used, additionally also trigger off of when bursts begin and end.}}

===$Thruster Flame Effect:===
{{Table3611|
*Defines the filename of the effect used on the modeled thruster of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Effect:===
{{Table3611|
*Defines the filename of the effect used on the glow type effect of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Radius Factor:===
{{Table3611|
*Defines the radius multiplier for the thruster's glow type effect
**Syntax: '''''Float'''''}}

===$Failure Rate:===
{{Table38|
*Defines the random chance that the weapon will fail to fire, or spawn the substitute below if specified.
**Syntax: '''''Float''''', 0 - 1

====+Failure Substitute:====
*Defines the weapon to substitute when the weapon 'fails'.
**Syntax: '''''String''''', Weapon
}}

===$On Create:===
{{Table212|
*Defines an [[Action System|action system]] program set to be executed when a weapon of this type is created. Only applicable to laser and missile style weapons.
}}

===$Animations:===
{{Table220|
*The new way of specifying triggered animations for weapons. Weapon needs to be a modelled weapon for animations.
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Driven Animations:===
{{Table242|
*See [[Animation_Drivers#Parsing (+Driver Set:)]]
*Driven animations '''are not''' compatible with $Animations! If you need animations without drivers, create a driver set that has no driver and list all animations in it's +Affected Animations:
}}

===$Substitute:===
{{Table3613|
Defines a pattern of ammo to substitute for primary or secondary weapons. '''$Substitute:''' can be repeated any number of times (so you could make something like a rainbow laser with several ammo substitutions, for example). If neither ''+period'' or ''+index'' is specified, it is assumed to be equivalent to ''+index: '''0'''''.

*Syntax: '''''Weapon Name'''''
*'''Swarm missiles act in a strange way when used with $Substitute, use at your own risk.'''}}

{{Table3615|
Turrets can use $Substitute as well.
}}
====+period:====
{{Table3613|
FSO will substitute '''Weapon Name''' every ''period'' shots.

*Syntax: '''''Positive Integer'''''
*'''You may not define both +period and +index for the same $Substitute entry'''}}
=====+offset:=====
{{Table3613|
A suboption of +period, offsets the substitute pattern according to the launched ammo. For example, an offset of 3 and a period of 4 will substitute on the 3rd ammo launched, and then every 4th ammo after that.

*Syntax: '''''Positive Integer'''''}}

====+index:====
{{Table3613|
FSO will substitute the '''Weapon Name''' at firepoint ''index'' in the shot pattern. Similar to carefully using both +period and +offset, but is not affected by ships with different firepoint numbers. i.e. Firepoint ''index'' will always have the substitution, while +period and +offset will cycle at different rates dependant on the number of firepoints.'''

*Syntax: '''''Positive Integer'''''

*'''You may not define both +period and +index for the same $Substitute entry'''

*'''Indexes start at 0 for the first weapon'''

*'''If the first index you specify is higher than 0, it will also be used for the indexes before it.'''

}}

===$Custom data:===
{{Table220|
Defines a set of custom data that for this weapon class, which can then be accessed through Lua scripts. There can be any amount of +Val: entries. It requires a $end_custom_data entry at the end.
Check the scripting documentation of Weapon Class to find the CustomData Lua Table.
====+Val:====
Specifies a custom data value and its name, in the format

+Val: Name Value

These values will always be strings of text. If you use them in Lua as other types of value, you might need to convert them in the script.

====$end_custom_data====
Mandatory entry to indicate that the Custom Data list has ended. }}

==Weapons.tbl Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship for a short period of time.

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.
*The flag will parse without a value, using a default of 10.
{{Table3610|
*Multiple spawn types can be defined for a single 'carrier' weapon up to maximum of 5 different weapons}}

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag. Also the AI will not try to hit fighters with it, but only if the weapon is in a turret or is a secondary. If the weapon is a primary in a fighter then there are no targeting restrictions. See [[Weapons.tbl#.22capital.2B.22|capital+]] instead.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" flag.

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon target-able with the B key and interceptable by AIs
** Has been long thought to make the AI prefer this weapon against large ships, but in fact has no effect on AI weapon selection.

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon.
{{Table3610|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table3610|
*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]}}

==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Vampiric"===
{{Table224|
*Heals shooter upon dealing hull damage to target
*Can be defined with [[Weapons.tbl#$Vampiric Healing Factor:|Vampiric Healing Factor]]}}

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak_Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.
{{Table3610|
*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]}}

==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
* Does nothing

==="puncture"===
*Reduces hull damage by 75%
The AI will prefer these weapons for anti-subsystem use

==="countermeasure"===
{{Table3610|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table3610|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table3610|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table3610|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table3610| }}

==="tagged only"===
{{Table3610|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table3610|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table3610|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table3610|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.) Only applies to the target selection of turrets, has no effect on the behavior of fighters picking primary and secondary bank weapons.}}

==="same turret cooldown"===
{{Table3610|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table3610|
*Prevents light from being applied to the weapon model.}}

==="training"===
{{Table3610|
*Sets weapon to be of training weapon type. ?}}

==="smart spawn"===
{{Table3611|
*Forces turret fired spawn weapon of this type to be fired like normal weapons.}}

==="inherit parent target"===
{{Table3611|
*Sets spawned 'child' weapons to use parent weapon's target.}}

==="no emp kill"===
{{Table3611|
*Defines the weapon (with hitpoints) to be immune to automatic EMP destruction.}}

==="untargeted heat seeker"===
{{Table3611|
*Defines the weapon as a heatseeker type missile which acquires its target by itself.}}

==="no radius doubling"===
{{Table3611|
*Prevents weapon radius from being doubled when doing collision test. Makes bombs harder to intercept.}}

==="no subsystem homing"===
{{Table3611|
*Prevents weapon from acquiring a subsystem as its target. Missile homing points are spread over the target ship.}}

==="no lifeleft penalty"===
{{Table3611|
*Prevents weapon lifetime from being penalized if the angle to the target is too big.}}

==="can be targeted"===
{{Table3611|
*Allows weapon to be targeted by player. Does not influence AI}}

==="show on radar"===
{{Table3611|
*Allows weapon to be visible on the radar}}

==="show friendly on radar"===
{{Table3611|
*Allows friendly, otherwise visible to radar weapon, to be visible on player radar}}

==="hide from radar"===
{{Table3614|
*Prevents weapon from being visible on the radar}}

==="capital+"===
{{Table3613|
*Tells AI fighters/bombers to use this weapon only on capital ships. Has no effect on turret AI.}}

==="chain external model fps"===
{{Table3613|
*Tells game to keep switching external model firingpoints when firing}}

==="external model launcher"===
{{Table3613|
*Tells game that the external model is a launcher so that it would be kept static without loading motion}}

==="takes blast damage"===
{{Table3613|
*Weapon takes damage from weapon blasts}}

==="takes shockwave damage"===
{{Table3613|
*Weapon takes damage from shockwaves}}

==="ciws"===
{{Table3615|
*Weapon can deal shockwave/blast damage to bombs, regardless of whether the target weapons have the "take blast/shockwave damage" flags.}}

==="render flak"===
{{Table3615|
*Normally, flak shells are not rendered. This flag switches rendering on for those weapons.}}

==="anti-subsystem beam"===
{{Table3615|
*Beam weapons with this flag can target subsystems on enemy ships, just like normal weapons.}}

==="no primary linking"===
{{Table3615|
*Primary weapons with this flag can not be linked with other weapons.}}

==="same emp time for capships"===
{{Table37|
*capships affected by this weapon will use the tabled EMP time rather than the fixed retail value (7.5 secs)}}

==="no primary linked penalty"===
{{Table371|
*Primary weapons with this flag do not incur the retail linked fire penalty}}

==="no homing speed ramp"===
{{Table371|
*Locked homing weapons will not perform the standard 1 second long acceleration when fired. Note that use of $Acceleration Time is '''not''' affected by this flag.}}

==="pulls aspect seekers"===
{{Table371|
*If an aspect seeker is grabbed by this countermeasure the missile will follow the countermeasure instead of going into dumbfire mode.
'''Only valid for countermeasures!'''}}

==="turret interceptable"===
==="fighter interceptable"===
==="interceptable"===
{{Table371|
*Allows turrets/fighters/both (respectively) to shoot at this weapon without requiring it to be a bomb. If this is the first time this weapon has been defined, it also gives it a default of 25 hitpoints so that it can be shot down.
'''If you use a TBM to give this flag to an existing weapon, you'll need to specify hitpoints manually (unless you want it to be unkillable but still draw defensive fire).'''}}

==="aoe electronics"===
{{Table372|
*Apply electronics effect across the weapon's entire area of effect instead of just on the impacted ship}}

==="apply recoil"===
{{Table373|
*A ship that fires a weapon with this flag will experience a recoil effect, slowing the ship down and, with lighter strikecraft, inducing some rotation if the firing points are offset from the center of mass.}}

==="don't spawn if shot"===
{{Table373|
*Prevents parent weapons from spawning children in the even of the parent weapon being shot down.}}

==="die on lost lock"===
{{Table373|
*Aspect seeking missiles (only, not heat seekers) will detonate upon losing their lock. Currently they only lose lock if decoyed by a countermeasure, AND "pulls aspect seekers" or similar is not set. The detonation will use their "dinky" explosion (i.e. same as if ran out of lifetime).}}

==="no doublefire"===
{{Table202|
*Prevents dual-firing of secondary weapons. If the ship tries to dual-fire a weapon with this flag they are set back to single fire.}}

==="no impact spew"===
{{Table202|
*Turns off the usual spew effects that occur on the impacted ship when a weapon hits it.}}

==="require exact los"===
{{Table202|
*Prevent AI form firing this weapon from a turret or as a secondary weapon if there is no clear line of sight from the weapons firing point to its targeted ship (center). Note that this may keep the weapon trained on a target out of sight while another target may be available to shoot.}}

==="can damage shooter"===
{{Table212|
*This weapon can collide with and directly damage the original shooter of this weapon (even if it was spawned), which is not normally possible.}}

==="heals"===
{{Table214|
*This weapon uses its $Damage value to heal its target(s) instead of damaging them.
*This works very similarly to damage, the armor/shield/subsystem factors apply to healing as well as do armor classes. However, there are some caveats. 
*Healing will ''always'' carry. Unlike damage, which first has to go through the shield, has damage subtracted, then damages subsystems, has damage subtracted, then finally damages the hull if any damage remains, healing will apply in full to hull, shield, and subsystems (factors or armor classes notwithstanding). A weapon with 100 'healing' will attempt to apply that healing to the hull, shield and nearby subsystems to the impact. Even if the weapon only heals hull, it will still do so even if it strikes the shield.
*This flag has '''''no effect''''' on AI. Fighters armed with a healing weapon will happily heal hostile targets they were ordered to attack.}}

==="secondary no ammo"===
{{Table220|
*If this is a secondary weapon, it does not need to consume any ammo, and will not display ammo in the weapon HUD gauge, etc.}}

==="no collide"===
{{Table220|
*This weapon will not collide with any other object.}}

==="multilock target dead subsys"===
{{Table220|
*If this is a multilock weapon, dead subsystems will be treated as just as valid targets as alive ones.}}

==="no evasion"===
{{Table220|
*AI will not attempt to evade this weapon when fired at them}}

==="no_fred"===
{{Table224|
*Weapon will not appear in any of the FRED dropdown lists for weapon classes.}}

==="detonate on expiration"===
{{Table232|
*Primary weapon will detonate as if hitting a target when it reaches the end of its lifetime - just like a secondary weapon does by default.}}

==="freespace 1 missile behavior"===
{{Table250|
*Enables a set of behaviors observed from missiles in the Freespace 1 release.
**Detonate when within 50 meters and not pointing at their target.
**Move slower than normal when not pointing at their target.
**Aspect seekers follow a -1x lag pursuit scalar for the last second before hitting their target.
*Note that the last point will make aspect seekers much less likely to hit moving targets.
*[[Ai_profiles.tbl#.24enable_freespace_1_style_missile_behavior:|Can be applied globally using an AI profile]]
*Syntax: '''''Boolean'''''}}

==Countermeasures==
*Usually not altered. Only one can exist
{{Table3610|
*More than one can exist}}

===$Name:===
*Name of the countermeasure
*Syntax: '''''String''''', name

===$Velocity:===
*Defines the speed of the countermeasure, relative to the ship.
*Syntax: '''''Float''''', meter per second

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: '''''Float''''', seconds

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: '''''Float''''', seconds
*'''$Lifetime Max:'''
**Syntax: '''''Float''''', seconds

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Model:===
*Defines the used model file (.pof)
*Syntax: '''''String.pof''''', model filename

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( '''''"String" "String"'''''), names of the weapons
*Example:

<pre>
$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )
</pre>

==Sample==

<pre>
#Primary Weapons

$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none

#End

#Secondary Weapons

$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0

#End

$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )
</pre>

[[Category:Tables]]

Command-Line Reference

2025-10-14T15:03:42Z

-Joshua-: /* -pilot */

{{TableVersionGit|2020-02-01|93f71ec20}}

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].

===Graphics===

====-nospec====
{{Table37|
'''"Disable Specular"'''

Disables support for specular mapping.
}}

====-noglow====
{{Table37|
'''"Disable glow maps"'''

Disables support for glowmapping.
}}

====-noenv====
{{Table37|
'''"Disable environment maps"'''

Disables support for environment mapping.
}}

====-nonormal====
{{Table37|
'''"Disable normal maps"'''

Disables support for normal mapping.
}}

====-emissive_light====
{{Table190|
'''"Enable emissive light from ships"'''

In retail FS2, ships had a pseudo light source applied to them to make them stand out against the background. Due to the changes in the render pipeline associated with HDR, this behaviour has been disabled by default; this cmdline option restores it.
}}
{{Table224|
This flag is now an alias for using -emissive 0.3
}}

====-noheight====
{{Table37|
'''"Disable height maps"'''

Disables support for height mapping.
}}

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2D and 3D shockwave effect are present, otherwise the only available effect is used (2D shockwave is defined by effects/shockwave01.eff or .ani, and 3D shockwave by models/shockwave.pof)

Note that 3D shockwaves are usually flat discs that FSO scales up. The animated 2D billboards used by 2D shockwaves with the addition of [[Command-Line Reference#-soft_particles|soft particles]], may look better when intersecting with models (which shockwaves often do). Use at your discretion.

====-no_post_process====
{{Table190|
'''"Disable Post Processing"'''

Disables the use of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting its value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table. Since post-processing is required for nebula effects post-3.8, it has been enabled by default as of Release 19.
}}

====-soft_particles====
'''"Enable soft particles"'''

Applies a blending factor to particles depending on their proximity to geometry

====-aa====
{{Table202|
'''"Enable post-processing antialiasing"'''
*'''-aa''' This flag enables the default antialiasing. Because FSO uses a deferred renderer, hardware-driven AA methods like MSAA cannot be used; the engine includes the well-established FXAA and SMAA post-processing shaders to get antialiasing instead. By default, the "Low" preset of the SMAA shader will be used.
*'''-aa_preset''' Sets a different antialiasing mode, in case the default is insufficient or is too taxing on the GPU. This parameter takes a numeric argument ranging from 0 to 6. 0-2 correspond to the Low, Medium and High FXAA presets, 3-6 to the Low, Medium, High and Ultra SMAA presets respectively. The impact of these presets, both in terms of performance and in terms of visuals, can be observed in the F3 lab: The number keys 0-6 can be used to switch through the various AA presets on the fly there.
}}

====-msaa====
{{Table232|
'''"Enable multisample antialiasing"'''
This parameter helps to reduce glinting and flickering of details on ships and other models when they are far away. Should be used together with -aa and not as a replacement for it!
Enables MSAA and sets the number of samples for it. This parameter takes a numeric argument ranging from 0 to 16, in powers of two (0, 4, 8, 16). 0 disables the feature, 4 is recommended for midrange systems, and 8 for high-end systems.
}}

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA anti-aliasing. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0
There is an associated parameter -fxaa_preset, which takes a number from 0 to 7; these can be used to set the effect's quality. Note that, while there are up to 7 possible values for this parameter, there are only 3 presets available: a value of 0-3 corresponds to the "Low" preset, 4-6 gets you the "medium" preset, and 7 and up switches to the "High" preset.

This antialiasing mode should only be used on very old (read: 2005-2010 era) hardware. For all other systems, the -smaa flag (detailed below) should be used.
{{Table202|
This parameter has been deprecated in favour of the -aa parameter, as seen above
}}

====-smaa====
'''"Enable SMAA anti-aliasing"'''

Enables the SMAA anti-aliasing method. Like FXAA, this is a post-processing effect that provides an AA stage; It is a more advanced and therefore more resource-intensive effect, but generally produces higher-quality images.
Like -fxaa, there is a configurable flag -smaa_preset, which takes a number from 0 to 3; these correspond directly to the Low, Medium, High and Ultra presets of the SMAA shader.

It is possible to compare the effectiveness of the different AA shaders by using the F3 lab: Load up any ship model and a background, then use the number keys 0 to x to switch through the various AA methods. 0-2 correspond to FXAA Low, Medium and High, 3-6 correspond to SMAA Low, Medium, High and Ultra.
{{Table202|
This parameter has been deprecated in favour of the -aa parameter, as seen above
}}

====-nolightshafts====
'''"Disable lightshafts"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission. This was previously documented as -flightshaftsoff but appears to have been changed to -nolightshafts for consistency before -flightshaftsoff was ever used in a released build.

====-fb_explosions====
'''"Enable Framebuffer Shockwaves"'''

Applies a framebuffer distortion effect to shockwaves

====-fb_thrusters====
'''"Enable Framebuffer Thrusters"'''

Applies a framebuffer distortion effect to Thrusters. NOTE: Only "point" thrusters are affected by this; modelled thrusters (as used on most retail models) are not affected by this.

====-no_deferred====
'''"Disable Deferred Lighting"'''

DESCRIPTION NEEDED

====-enable_shadows====
{{table373|
'''"Enable shadows"'''

Enables shadows where supported by the OpenGL version provided by the user's GPU. -shadow_quality can be used to control the quality level.
{{note|Currently doesn't support shadows for cockpits and show ship.}}
}}

===Game Speed===

====-no_vsync====
'''"Disable vertical sync"'''

===HUD===

====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''

Runs the game in a borderless window.

====-stretch_menu====
'''"Stretch interface to fill screen"'''

Scales the interface to fill the screen without preserving the aspect ratio. Omit this to keep the aspect ratio, adding black bars where appropriate.

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-nomotiondebris====
'''"Disable motion debris"'''

====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
If a mod does not supply the required interface art for a ship, this mode will be used instead.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
If a mod does not supply the required interface art for a weapon, this mode will be used instead.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

====-no_enhanced_sound====
'''"Disable enhanced sound"'''

Disables the enhanced sound rendering functions enabled by OpenAL Soft.

===Launcher===

====-override_data====
{{Table230|

'''"Enable override directory"'''

Inserts an '_override/' location into the load order after all mod directories, intended for user table overrides layered over top multiple mods without as many accidental pollution issues for other mods or load order confusion that older methods can cause.

}}

====-portable_mode====
'''"Store config in portable location"'''

Uses the root directory of FSO for storing pilot and config files. The current launcher does not have proper support for this yet so you need to manually copy the fs2_open.ini from the original config directory to your FreeSpace Root directory.

====-parse_cmdline_only====
'''"Parse Command Line Only"'''

Parse only the application command line settings, and ignore any that may have been set in the on-disk data/cmdline_fso.cfg or per-user cmdline_fso.cfg (on Linux/Mac)

====-get_flags====
{{Table38|'''"Output the launcher flags file"'''
Used by launchers to get certain information from FSO via binary file or stdout.
*Syntax: '''''String''''', either '''binary''' or '''json_v1'''

'''binary''' will output info to a binary file in the root directory (probably within AppData)
'''json_v1''' will output via stdout on the console a .json object as a string}}

===Multiplayer===

====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

Once you launch and choose a pilot within the game, you will immediately have begun to host a game. This can be used in conjunction with several options to customize the game you create: -closed, -restricted, -password, -gamename, -allowabove, and -allowbelow. -startgame has no effect when -standalone is used.

See related: [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]] [[Command-Line_Reference#-gamename|-gamename]] [[Command-Line_Reference#-allowabove|-allowabove]] [[Command-Line_Reference#-allowbelow|-allowbelow]]

====-closed====
'''"Start Hosted Server as Closed"'''

Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
'''"Host Confirms Join requests"'''

Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder—or with main data folder if no mod is active.

====-clientdamage====
{{Note| Removed as of 21.0}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

Disables return to the flight deck screen after a mission completes.

====-gateway_ip====
'''"Set gateway IP address"'''

===Troubleshooting===

====-no_ingame_options====
'''"Disables Use of In-game Options"'''
Disables a mod using the new in-game options (mods set using in-game options in the game_settings.tbl file). Recall, the new in-game options allow all settings to be set in-game rather than via flag (even items like resolution).

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables. The errors are there for a reason.

====-loadallweps====
'''"Load all weapons, even those not used"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

[http://scp.indiegames.us/mantis/view.php?id=1669 Mantis #1669] is what led to this flag's creation.

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-gl_finish====
'''"Fix input lag on AMD+Linux"'''
{{Table371|
This option adds a "glFinish()" call just prior to swapping buffers. It works around an issue with "recent" (HD 6000 & newer?) AMD cards using proprietary drivers on Linux. Be warned that enabling this may reduce framerate.
}}

Refer to [http://www.hard-light.net/forums/index.php?topic=88102.0 this thread] and [https://github.com/ValveSoftware/Source-1-Games/issues/765 Valve's bugtracker] for more details).

====-no_geo_effects====
'''"Disable geometry shader for effects"'''

Particle rendering uses geometry shaders for high performance, this flag disables that behaviour.

====-set_cpu_affinity====
'''"Sets processor affinity to config value"'''

Use this to force FSO to run on the specified core. CPU cores are numbered starting with 0 for the first core.

====-nograb====
Disables focus grabbing in a window.
{{Note| This feature is not available on Windows.}}

====-noshadercache====
'''"Disables the shader cache"'''

On GPUs with support for OpenGL 4 and higher, FSO caches the compiled shaders for increased performance.

====-fix_registry====
'''"Use a different registry path"''''

====-log_multi_packet====
'''"Dump packet type to the debug log. Helps with misaligned multi packets."''''

DESCRIPTION NEEDED

===Experimental===

====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

===Development Tools===

====-bmpmanusage====
'''"Show how many BMPMAN slots are in use"'''

Adds a BMPMAN slot usage display near where the FPS display is (or would be, if it's not enabled). Can be used by mod makers to see if they need to increase their [[Game_settings.tbl#$BMPMAN Slot Limit:|BMPMAN slot limit]].

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-pofspew====
Loads all POF files in the current mod and prints out information on their LODs and mesh faces. In previous version of FSO this command also generated IBX cache files for each object in the data/cache folder for that mod, but IBX cache files are no longer used. 
Nowadays, this command is most useful for quickly checking all models in a mod for any debug errors.

====-weaponspew====
{{table202|
Outputs information about player-allowed weapons (and child munitions) to the log file. This includes a CSV with comparative stats on all weapons, as well as MediaVP-style descriptions for the loadout screen. 
The command '-weaponspew all' will print all weapons, not just player-allowed weapons.}}

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-save_render_target====
'''"Save Render Targets to file"'''

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-noninteractive====
'''"Disables interactive dialogs"'''
Disables all dialogs and chooses the default option when one would be displayed. Very useful for a standalone server on a headless system.

====-no_unfocused_pause====
'''"Don't pause if the window isn't focused"'''

When the FSO window looses focus it will not pause the game, useful for doing non-interactive test runs.

====-benchmark_mode====
'''"Puts the game into benchmark mode"'''
See [[Benchmarking]] for more information.

====-profile_frame_time====
'''"Profile frame time"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

====-profile_write_file====
'''"Write profiling information to file"'''

This will write the frame times of each gameplay frame to the file 'profiling.csv' where each line is ''<time>;<frametime>''. Both times are measured in nanoseconds(1/1000000000th of a second). ''time'' is measured from an arbitrary time in the past. To get consistent results the first ''time'' value should be substracted from all ''time'' values. The first two frames are usually very long because the timer is set at engine startup so you might want to exclude those from your data.

====-json_profiling====
'''"Generate JSON profiling output"'''

Gathers information from the built-in profiling tools and writes them out to a .json file readable by the Google Chrome tracer or TraceCompass/SpaceCompass.
NOTE: This will create fairly massive data sets (several hundred megabytes per minute of gameplay). The files will be written to the subdirectory "tracing" in the FreeSpace data folder; FreeSpace will not create that folder automatically, however.

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-gr_debug====
'''"Output graphics debug information"'''

====-stdout_log====
'''"Output log file to stdout"'''

====-slow_frames_ok====
'''"Don't adjust timestamps for slow frames"'''

====-luadev====
{{Table230|

'''"Make lua errors non-fatal"'''

Intended for use with live-development scripts to allow iteration without engine restarts.

}}

==Other==

The following options are not available as checkboxes in the launcher and must be entered into the "Custom flags" field. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots. Largely sourced from [https://www.hard-light.net/forums/index.php?topic=94875.msg1870215#msg1870215 this thread].

{{Table224|
This method of configuring a mod's lighting has been replaced with the [[Lighting_Profiles.tbl]]. New lighting flags now mainly serve usability and accessibility reasons, with some legacy support for modifying ambient intensity.}}
====-light====
{{Table224|
This is a multiplier applied to all level lights. This includes a mission's ambient light setting, but does not include imaged-based lighting from a mission's background. Defaults to 1.

}}
====-ambient ====

{{Table224|
This is a multiplier applied to the intensity of level ambient lighting. It applies only to the simple ambient light value, not to image-based lighting from a mission's background. Defaults to 1.

Unlike the old -ambient_factor flag this is a true multiplier to light intensity and does not use special math, and is not clamped above 0. A value of 0 will effective disable ambient light.

}}
====-emissive====

{{Table224|
This sets an amount of white ambient light added to all models. This is in addition to any amount of ambient light already present in a level. This is a relative amount, 1.0 is equivalent to a mission set to 255,255,255, and it can be set higher than this. This light is added after the multiplier from -ambient or any mod ambient settings are applied, so will add light regardless of other settings. Defaults 0.

}}
====-ambient_factor====
This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. The way this works is a bit weird. (ambient factor * 2) - 255 is "added" to mission ambient, but since this will almost always be a negative value it's actually removed from mission ambient. Because of how light values are clamped it cannot go below 5.1, ambient_factor 70 will result in -115 to mission ambient which is 120 by default. 70 is essentially the lowest ambient for missions with default ambient settings which are all retail missions and the vast majority of mod missions. FS2's standard value is 120. 70 is basically no ambient, 80 is a bit of ambient, and 90 is quite a bit of ambient(ships will look bright from all sides). Anything above that will make ships look incredibly "flat". This is a relative value.

{{Table224|

*'''''This feature is now deprecated, it will have no effect on rendering. see -ambient for an alternative user setting and [[Lighting_Profiles.tbl]] for mod configuration'''''
}}
====-spec_point====
This is a multiplier that adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. If you want lasers to light up more set this to around 2. If you want less lighting, set it to around 0.5. Default is 1.0. This is a relative value.

{{Table224|
*'''''This feature is now deprecated, it will have no effect on rendering. see [[Lighting_Profiles.tbl]] for mod configuration alternatives'''''
}}
====-spec_static====
This is a multiplier that adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. For non-PBR models it will make their sun-lit side very shiny and reflective; for PBR models it will make the sun-lit side a lot brighter. There's no flag to control diffuse static lighting so non-PBR models will always have the same amount of light come from suns. Default is 1.0. This is a relative value.

{{Table224|
*'''''This feature is now deprecated, it will have no effect on rendering. see [[Lighting_Profiles.tbl]] for mod configuration alternatives'''''
}}
====-spec_tube====
This is a multiplier that adjusts how much beam weapons contribute to specular highlights. Higher numbers mean a greater contribution. If you want lasers to light up more set this to around 2. If you want less lighting, set it to around 0.5. Default is 1.0. This is a relative value.

{{Table224|
*'''''This feature is now deprecated, it will have no effect on rendering. see [[Lighting_Profiles.tbl]] for mod configuration alternatives'''''
}}
====-ogl_spec====
*'''''This feature is now deprecated, it will have no effect on rendering.'''''
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

====-spec_exp====
*'''''This feature is now deprecated, it will have no effect on rendering.'''''
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16. This is a relative value.

===Graphics===

====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 25. Range is 0-200.

====-shadow_quality====
{{table373|
'''"Set shadows quality"'''

This sets the resolution for the shadow maps the engine uses for real-time shadowing.
Note that higher resolutions require more processing power and VRAM; this feature is only recommended for users with a decently powerful dedicated GPU.
Valid ranges are 0 to 4 with 2 being the default.

* 0 disables shadows (so there's no point in setting it!)
* 1 uses 512x512 resolution (lower quality)
* 2 uses 1024x1024 resolution (medium quality)
* 3 uses 2048x2048 resolution (high quality)
* 4 uses 4096x4096 resolution (ultra quality)

Currently this requires -enable_shadows to be set, or it has no effect.
}}
{{table38|No longer requires -enable_shadows to be set.}}

====-anisotropic_filter====
{{table382|
'''"Set anisotropic filtering level"'''
Valid ranges are 1 to whatever maximum the GPU supports (which should be 16 for most currently available GPUs)
By default, the GPUs' max supported level is used; set this to 1 if you want the minimum level available.}}

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-center_res====
Specifies how much of the screen area should be utilized by menus, movies, the HUD, and various other 2D graphics. Intended for use with configurations with an extremely wide field of view, such as triple-monitor setups.

By default, if the screen resolution's aspect ratio is wider than 7:2, most 2D elements utilize only the center 3/10 of the screen area. This setting allows users to override this behavior to make better use of the center monitor. (The reason for using 3/10 rather than 1/3 is that many triple-monitor setups use bezel correction, which reduces the fraction of the screen area that the center monitor displays.)

For example, if the screen resolution is 6000x1080, then -center_res 1920x1080 will keep most 2D graphics in the center 1920x1080 area. This setting is automatically scaled to fit the screen resolution, so (assuming the resolution is still 6000x1080) -center_res 1280x720 is given, then that resolution is enlarged to 1920x1080.

====-aa_preset====
{{table202|
This parameter can be used to select the AA solution the engine is using. Valid values are 0 to 6 inclusive:
* 0: FXAA Low
* 1: FXAA Medium
* 2: FXAA High
* 3: SMAA Low
* 4: SMAA Medium
* 5: SMAA High
* 6: SMAA Ultra

The various AA presets can be tested in the F3 lab; the number keys from 0-6 switch between the various presets as described above.
}}

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.
{{table202|Has been superceded by the -aa_preset cmdline argument}}

====-smaa_preset====
Requires both -post_processing and -smaa. Can be used to adjust the SMAA quality and speed, 0 is low, 1 is medium, 2 is high, and 3 is ultra (highest quality). Default setting is 1.
{{table202|Has been superceded by the -aa_preset cmdline argument}}

===Game Speed===

====-no_fps_capping====
'''"Don't limit frames-per-second"'''

===Gameplay===

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

====-pilot====

Skips the barracks and automatically loads the pilot with the name specified.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-mod====
Specifies in which folders inside FreeSpace 2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behavior, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''.
If ''Freespace2/moddir/[[mod.ini]]'' exists it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#Files located inside vp archives. (These vp archives are "similar" to zip archives. They just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order with files loaded earlier taking priority over those loaded later. So aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter that this ''Mission.fs2'' is also inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.
# This flag is also used by [[Portal:FRED|FRED]]. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

====-deadzone====
This allows the player to set the deadzone value as a percentage of the joystick's range, allowing a more finely tuned setting than with the in-game options.
*Syntax: '''''integer''''' Percentage
*Valid Values: 0 to 100
*Default Value: 0

Setting this value to 100 will make the joystick axes completely unresponsive.
While this flag is set, the in-game deadzone options will be disabled.

===Launcher===

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

===Multiplayer===

====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame.

Takes one argument string, the name to be assigned to the game being created.

This argument does nothing when used with -standalone. To set the name for a standalone server, see [[Multiplayer(Main)#Standalone Servers|Standalone Servers]].

See related:   [[Command-Line_Reference#-startgame|-startgame]]   [[Multiplayer(Main)#Standalone Servers|Standalone Servers]]

====-password====
Specifies the password for a standalone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a standalone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to host a game or serve a standalone game.

Takes one argument integer, the port on which the host will listen for clients.

====-connect====
Automatically connect to multiplayer IP:PORT.

Takes one string value, such as 192.168.0.1:

====-timeout====
Multiplayer network timeout (secs).

Takes one integer argument, the timeout value in seconds. Default is 30.

====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===

====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

===Deprecated Options===
These options were present in the executable for some time, but have since been removed and deprecated. The engine will throw a non-fatal error when they are found in the commandline. Some of these functions have been removed entirely, others are now part of the standard operation of the engine.

====-clipdist====

====-spec====

====-env====

====-glow====

====-normal====

====-height====

====-missile_lighting====

====-img2dds====

====-snd_preload====

====-nohtl====

====-safeloading====

====-timerbar====

====-old_collision====

====-json_pilot====
'''"Dump pilot files in JSON format"'''

Writes the information stored in savefiles to JSON files.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

====-no_emissive_lighting====
See -emissive_lighting.

====-post_process====
See -no_post_process.

===Completely Removed Options===
Using one of these is the same as using a random string.

====-show_mem_usage====

[[Category:Lists]]
[[Category:Source Code Project]]

Command-Line Reference

2025-10-14T15:03:13Z

-Joshua-: /* Gameplay */

{{TableVersionGit|2020-02-01|93f71ec20}}

Command-Line Flags (also called Command-Line Parameters) are optional flags passed to the FSO executable, and generally enables one or more features added to the FS2 Open engine. These flags are accessed conveniently through an [[FSO Launcher]]. To have FSO list all available flags, use any one of the following: [[Command-Line_Reference#-help|-help]], [[Command-Line_Reference#-help|--help]], [[Command-Line_Reference#-help|-h]], or [[Command-Line_Reference#-help|-?]].

===Graphics===

====-nospec====
{{Table37|
'''"Disable Specular"'''

Disables support for specular mapping.
}}

====-noglow====
{{Table37|
'''"Disable glow maps"'''

Disables support for glowmapping.
}}

====-noenv====
{{Table37|
'''"Disable environment maps"'''

Disables support for environment mapping.
}}

====-nonormal====
{{Table37|
'''"Disable normal maps"'''

Disables support for normal mapping.
}}

====-emissive_light====
{{Table190|
'''"Enable emissive light from ships"'''

In retail FS2, ships had a pseudo light source applied to them to make them stand out against the background. Due to the changes in the render pipeline associated with HDR, this behaviour has been disabled by default; this cmdline option restores it.
}}
{{Table224|
This flag is now an alias for using -emissive 0.3
}}

====-noheight====
{{Table37|
'''"Disable height maps"'''

Disables support for height mapping.
}}

====-3dshockwave====
'''"Enable 3D Shockwaves"'''

This only has any effect when both a 2D and 3D shockwave effect are present, otherwise the only available effect is used (2D shockwave is defined by effects/shockwave01.eff or .ani, and 3D shockwave by models/shockwave.pof)

Note that 3D shockwaves are usually flat discs that FSO scales up. The animated 2D billboards used by 2D shockwaves with the addition of [[Command-Line Reference#-soft_particles|soft particles]], may look better when intersecting with models (which shockwaves often do). Use at your discretion.

====-no_post_process====
{{Table190|
'''"Disable Post Processing"'''

Disables the use of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting its value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table. Since post-processing is required for nebula effects post-3.8, it has been enabled by default as of Release 19.
}}

====-soft_particles====
'''"Enable soft particles"'''

Applies a blending factor to particles depending on their proximity to geometry

====-aa====
{{Table202|
'''"Enable post-processing antialiasing"'''
*'''-aa''' This flag enables the default antialiasing. Because FSO uses a deferred renderer, hardware-driven AA methods like MSAA cannot be used; the engine includes the well-established FXAA and SMAA post-processing shaders to get antialiasing instead. By default, the "Low" preset of the SMAA shader will be used.
*'''-aa_preset''' Sets a different antialiasing mode, in case the default is insufficient or is too taxing on the GPU. This parameter takes a numeric argument ranging from 0 to 6. 0-2 correspond to the Low, Medium and High FXAA presets, 3-6 to the Low, Medium, High and Ultra SMAA presets respectively. The impact of these presets, both in terms of performance and in terms of visuals, can be observed in the F3 lab: The number keys 0-6 can be used to switch through the various AA presets on the fly there.
}}

====-msaa====
{{Table232|
'''"Enable multisample antialiasing"'''
This parameter helps to reduce glinting and flickering of details on ships and other models when they are far away. Should be used together with -aa and not as a replacement for it!
Enables MSAA and sets the number of samples for it. This parameter takes a numeric argument ranging from 0 to 16, in powers of two (0, 4, 8, 16). 0 disables the feature, 4 is recommended for midrange systems, and 8 for high-end systems.
}}

====-fxaa====
'''"Enable FXAA antialiasing"'''

Enables the FXAA anti-aliasing. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0
There is an associated parameter -fxaa_preset, which takes a number from 0 to 7; these can be used to set the effect's quality. Note that, while there are up to 7 possible values for this parameter, there are only 3 presets available: a value of 0-3 corresponds to the "Low" preset, 4-6 gets you the "medium" preset, and 7 and up switches to the "High" preset.

This antialiasing mode should only be used on very old (read: 2005-2010 era) hardware. For all other systems, the -smaa flag (detailed below) should be used.
{{Table202|
This parameter has been deprecated in favour of the -aa parameter, as seen above
}}

====-smaa====
'''"Enable SMAA anti-aliasing"'''

Enables the SMAA anti-aliasing method. Like FXAA, this is a post-processing effect that provides an AA stage; It is a more advanced and therefore more resource-intensive effect, but generally produces higher-quality images.
Like -fxaa, there is a configurable flag -smaa_preset, which takes a number from 0 to 3; these correspond directly to the Low, Medium, High and Ultra presets of the SMAA shader.

It is possible to compare the effectiveness of the different AA shaders by using the F3 lab: Load up any ship model and a background, then use the number keys 0 to x to switch through the various AA methods. 0-2 correspond to FXAA Low, Medium and High, 3-6 correspond to SMAA Low, Medium, High and Ultra.
{{Table202|
This parameter has been deprecated in favour of the -aa parameter, as seen above
}}

====-nolightshafts====
'''"Disable lightshafts"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission. This was previously documented as -flightshaftsoff but appears to have been changed to -nolightshafts for consistency before -flightshaftsoff was ever used in a released build.

====-fb_explosions====
'''"Enable Framebuffer Shockwaves"'''

Applies a framebuffer distortion effect to shockwaves

====-fb_thrusters====
'''"Enable Framebuffer Thrusters"'''

Applies a framebuffer distortion effect to Thrusters. NOTE: Only "point" thrusters are affected by this; modelled thrusters (as used on most retail models) are not affected by this.

====-no_deferred====
'''"Disable Deferred Lighting"'''

DESCRIPTION NEEDED

====-enable_shadows====
{{table373|
'''"Enable shadows"'''

Enables shadows where supported by the OpenGL version provided by the user's GPU. -shadow_quality can be used to control the quality level.
{{note|Currently doesn't support shadows for cockpits and show ship.}}
}}

===Game Speed===

====-no_vsync====
'''"Disable vertical sync"'''

===HUD===

====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

====-dualscanlines====
'''"Another Pair of Scanning Lines"'''

Adds a second pair of scanning lines to the target window when scanning an object.

====-targetinfo====
'''"Enable Info next to Target"'''

Displays target info, such as name and class, beside the targeted object.

====-orbradar====
'''"Enables 3D radar"'''

An Orb style 3D radar will replace the standard 2D version.

====-rearm_timer====
'''"Enable Rearm/Repair Completion Timer"'''

Displays time remaining until rearm and repair from a support ship is complete.

====-ballistic_gauge====
'''"Enable the analog Ballistic Ammo gauge"'''

Adds an ammo gauge to the HUD when armed with a ballistic weapon.

===Gameplay===

====-window====
'''"Run in Window"'''

Runs the game in a window. No check to make sure that resolution is no higher than your desktop resolution, so be careful.

====-fullscreen_window====
'''"Run in Fullscreen Window"'''

Runs the game in a borderless window.

====-stretch_menu====
'''"Stretch interface to fill screen"'''

Scales the interface to fill the screen without preserving the aspect ratio. Omit this to keep the aspect ratio, adding black bars where appropriate.

====-noscalevid====
"Disable scale-to-window for Movies"

Disables fullscreen scaling of video clips.

====-nomotiondebris====
'''"Disable motion debris"'''

====-ship_choice_3d====
'''"Use Models for Ship Selection"'''

Uses ship models in ship selection window. It completely disables the standard ANI interface in this screen. 
If a mod does not supply the required interface art for a ship, this mode will be used instead.

====-weapon_choice_3d====
'''"Use Models for Weapon Selection"'''

Uses weapon models in weapon loadout window for secondary weapons (missiles and bombs). It completely disables the standard ANI interface in this screen. 
If a mod does not supply the required interface art for a weapon, this mode will be used instead.

====-3dwarp====
'''"Enable 3D Warp"'''

Use full geometry for the subspace warp effect.

====-warp_flash====
'''"Enable Flash upon Warp"'''

Enable a flash at warp in and warp out.

====-no_ap_interrupt====
'''"Disable Interrupting of AutoPilot"'''

Tells the game to not allow players to interrupt an autopilot already-in-progress.

===Audio===

====-nosound====
'''"Disable Sound and Music"'''

====-nomusic====
'''"Disables Music"'''

====-no_enhanced_sound====
'''"Disable enhanced sound"'''

Disables the enhanced sound rendering functions enabled by OpenAL Soft.

===Launcher===

====-override_data====
{{Table230|

'''"Enable override directory"'''

Inserts an '_override/' location into the load order after all mod directories, intended for user table overrides layered over top multiple mods without as many accidental pollution issues for other mods or load order confusion that older methods can cause.

}}

====-portable_mode====
'''"Store config in portable location"'''

Uses the root directory of FSO for storing pilot and config files. The current launcher does not have proper support for this yet so you need to manually copy the fs2_open.ini from the original config directory to your FreeSpace Root directory.

====-parse_cmdline_only====
'''"Parse Command Line Only"'''

Parse only the application command line settings, and ignore any that may have been set in the on-disk data/cmdline_fso.cfg or per-user cmdline_fso.cfg (on Linux/Mac)

====-get_flags====
{{Table38|'''"Output the launcher flags file"'''
Used by launchers to get certain information from FSO via binary file or stdout.
*Syntax: '''''String''''', either '''binary''' or '''json_v1'''

'''binary''' will output info to a binary file in the root directory (probably within AppData)
'''json_v1''' will output via stdout on the console a .json object as a string}}

===Multiplayer===

====-standalone====
'''"Run as Stand Alone Server"'''

Creates a standalone multi-player server.

====-startgame====
'''"Skip Mainhall and Start Hosting"'''

Once you launch and choose a pilot within the game, you will immediately have begun to host a game. This can be used in conjunction with several options to customize the game you create: -closed, -restricted, -password, -gamename, -allowabove, and -allowbelow. -startgame has no effect when -standalone is used.

See related: [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]] [[Command-Line_Reference#-gamename|-gamename]] [[Command-Line_Reference#-allowabove|-allowabove]] [[Command-Line_Reference#-allowbelow|-allowbelow]]

====-closed====
'''"Start Hosted Server as Closed"'''

Hosts a new game in a closed state, where no one can join until the in-game "Close" button is cleared. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -restricted or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-restricted|-restricted]] [[Command-Line_Reference#-password|-password]]

====-restricted====
'''"Host Confirms Join requests"'''

Hosts a new game in a restricted state. The host is presented with option to accept or deny each client's request to join the game. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -password.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-password|-password]]

====-multilog====
Creates a log file with a summary of packets sent and received in multiplayer games. The file is saved as \data\multi.log within the active mod folder—or with main data folder if no mod is active.

====-clientdamage====
{{Note| Removed as of 21.0}}

====-mpnoreturn====
'''"Disables Flight Deck option"'''

Disables return to the flight deck screen after a mission completes.

====-gateway_ip====
'''"Set gateway IP address"'''

===Troubleshooting===

====-no_ingame_options====
'''"Disables Use of In-game Options"'''
Disables a mod using the new in-game options (mods set using in-game options in the game_settings.tbl file). Recall, the new in-game options allow all settings to be set in-game rather than via flag (even items like resolution).

====-no_set_gamma====
'''"Disable Setting of Gamma"'''

Disables the gamma settings in the options screen.

====-nomovies====
'''"Disable Video Playback"'''

Disables all video playback.

====-noparseerrors====
'''"Disable Parsing Errors"'''

Disables some parsing warnings and makes other parse errors non-fatal. Do not rely on this when creating new tables. The errors are there for a reason.

====-loadallweps====
'''"Load all weapons, even those not used"'''

====-disable_fbo====
'''"Disable OpenGL RenderTargets"'''

====-disable_pbo====
'''"Disable OpenGL Pixel Buffer Objects"'''

Disables the use of Pixel Buffer Objects (PBO) which may cause certain OpenGL operations to perform slower. Note PBO's were only used at three places in FSO anyway so it's *probably* not going to have a noticeable effect.

May be required to workaround issues in certain versions of Linux's Mesa drivers for Intel integrated graphics cards where crashes occur in the mainhall (i.e. whenever a popup occurs). Distros that seem to have this problem presently include Ubuntu 13.10 and openSUSE 13.1.
{{Table371|
*This feature is present to work around a bug in Linux's Mesa drivers for Intel integrated graphics cards}}

====-ati_swap====
'''"Fix Color issues on some ATI cards"'''

[http://scp.indiegames.us/mantis/view.php?id=1669 Mantis #1669] is what led to this flag's creation.

====-no_3d_sound====
'''"Use only 2D/stereo for sound effects"'''

====-mipmap====
'''"Enable mipmapping"'''

Causes for non-mipmapped textures to have mipmaps generated within the GPU on certain kind of texture formats, (IIRC, DDS formatted textures with a power of 2 size in both width and height). 
Since the use of already mipmapped DDS textures has become common, it has become deprecated.
The quality of the generated mipmaps depends on each GPU and used driver. It is normally used with [[Command-Line_Reference#-img2dds|-img2dds]] flag.

====-use_gldrawelements====
'''"Use glDrawElements instead of glDrawRangeElements"'''

Introduced as a means of switching to the slower OpenGL call glDrawElements, instead of glDrawRangeElements.
{{Table3614|
*This feature may resolve certain rendering problems where parts of models are not drawn on Linux drivers}}

====-gl_finish====
'''"Fix input lag on AMD+Linux"'''
{{Table371|
This option adds a "glFinish()" call just prior to swapping buffers. It works around an issue with "recent" (HD 6000 & newer?) AMD cards using proprietary drivers on Linux. Be warned that enabling this may reduce framerate.
}}

Refer to [http://www.hard-light.net/forums/index.php?topic=88102.0 this thread] and [https://github.com/ValveSoftware/Source-1-Games/issues/765 Valve's bugtracker] for more details).

====-no_geo_effects====
'''"Disable geometry shader for effects"'''

Particle rendering uses geometry shaders for high performance, this flag disables that behaviour.

====-set_cpu_affinity====
'''"Sets processor affinity to config value"'''

Use this to force FSO to run on the specified core. CPU cores are numbered starting with 0 for the first core.

====-nograb====
Disables focus grabbing in a window.
{{Note| This feature is not available on Windows.}}

====-noshadercache====
'''"Disables the shader cache"'''

On GPUs with support for OpenGL 4 and higher, FSO caches the compiled shaders for increased performance.

====-fix_registry====
'''"Use a different registry path"''''

====-log_multi_packet====
'''"Dump packet type to the debug log. Helps with misaligned multi packets."''''

DESCRIPTION NEEDED

===Experimental===

====-ingame_join====
'''"Allows Ingame Joining"'''

Enables ingame joining in multiplayer. FIXME: Host option?

====-voicer====
'''"Voice Recognition"'''

Windows-only. Enables voice-recognition for wingmen commands. Must be specifically compiled into a build in order for it to be available; 3.6.10 final includes the feature. See [[Voice Recognition]] for more details.

===Development Tools===

====-bmpmanusage====
'''"Show how many BMPMAN slots are in use"'''

Adds a BMPMAN slot usage display near where the FPS display is (or would be, if it's not enabled). Can be used by mod makers to see if they need to increase their [[Game_settings.tbl#$BMPMAN Slot Limit:|BMPMAN slot limit]].

====-pos====
'''"Show Position of Camera"'''

Displays current position coordinates of camera.

====-stats====
'''"Show Statistics"'''

Shows total and free physical memory, virtual memory and system pagefile.

====-coords====
'''"Show Coordinates"'''

Shows coordinates of the mouse cursor.

====-pofspew====
Loads all POF files in the current mod and prints out information on their LODs and mesh faces. In previous version of FSO this command also generated IBX cache files for each object in the data/cache folder for that mod, but IBX cache files are no longer used. 
Nowadays, this command is most useful for quickly checking all models in a mod for any debug errors.

====-weaponspew====
{{table202|
Outputs information about player-allowed weapons (and child munitions) to the log file. This includes a CSV with comparative stats on all weapons, as well as MediaVP-style descriptions for the loadout screen. 
The command '-weaponspew all' will print all weapons, not just player-allowed weapons.}}

====-tablecrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-table_crcs MediaVPs" will create a table_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the tables used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-missioncrcs====
Is actually now (or should be) a typed reference rather than as a selection item. Takes 1 argument, usually a descriptive name.
Example usage: "-mission_crcs MediaVPs" will create a mission_crcs.csv file in the running mod (name can be separate of the mod selected) that allows for the validation of the missions used by that mod while on-line. The descriptive parameter given helps "allocate" that .csv file to the mod in question, and as such should closely or exactly match that mods name if possible.

====-dis_collisions====
'''"Disable Collisions"'''

Disables all collisions.

====-dis_weapons====
'''"Disable Weapon Rendering"'''

Disables weapons rendering.

====-output_sexps====
This will make the FSO build spit out an html file that documents the supported SEXP's.

Just double click on sexps.html and it should open in your default web browser.

====-output_scripting====
This will make the FSO build spit out an html file that documents the supported scripting hooks and LUA libraries.

Just double click on scripting.html and it should open in your default web browser.

====-save_render_target====
'''"Save Render Targets to file"'''

====-verify_vps====
'''"Spew VP crcs to vp_crcs.txt"'''

Exports the CRC values of the VP files being loaded into a vp_crcs.txt file.

====-reparse_mainhall====
'''"Reparse mainhall.tbl when loading halls"'''

Mainhall.tbl will be reparsed every time a mainhall is loaded, as opposed to just once at game startup.

====-noninteractive====
'''"Disables interactive dialogs"'''
Disables all dialogs and chooses the default option when one would be displayed. Very useful for a standalone server on a headless system.

====-no_unfocused_pause====
'''"Don't pause if the window isn't focused"'''

When the FSO window looses focus it will not pause the game, useful for doing non-interactive test runs.

====-benchmark_mode====
'''"Puts the game into benchmark mode"'''
See [[Benchmarking]] for more information.

====-profile_frame_time====
'''"Profile frame time"'''

Activates the frame profiling code. This presents a readout showing the current, minimum, maximum and average percentages of frametime a given section of code has taken up; this can be used to identify particular bottlenecks or measure the effectiveness of certain optimizations.

====-profile_write_file====
'''"Write profiling information to file"'''

This will write the frame times of each gameplay frame to the file 'profiling.csv' where each line is ''<time>;<frametime>''. Both times are measured in nanoseconds(1/1000000000th of a second). ''time'' is measured from an arbitrary time in the past. To get consistent results the first ''time'' value should be substracted from all ''time'' values. The first two frames are usually very long because the timer is set at engine startup so you might want to exclude those from your data.

====-json_profiling====
'''"Generate JSON profiling output"'''

Gathers information from the built-in profiling tools and writes them out to a .json file readable by the Google Chrome tracer or TraceCompass/SpaceCompass.
NOTE: This will create fairly massive data sets (several hundred megabytes per minute of gameplay). The files will be written to the subdirectory "tracing" in the FreeSpace data folder; FreeSpace will not create that folder automatically, however.

====-debug_window====
'''"Display Debug Window"'''

Lists the fs2_open.log in (nearly)real-time generation.

====-gr_debug====
'''"Output graphics debug information"'''

====-stdout_log====
'''"Output log file to stdout"'''

====-slow_frames_ok====
'''"Don't adjust timestamps for slow frames"'''

====-luadev====
{{Table230|

'''"Make lua errors non-fatal"'''

Intended for use with live-development scripts to allow iteration without engine restarts.

}}

==Other==

The following options are not available as checkboxes in the launcher and must be entered into the "Custom flags" field. Many require parameters, which follow the flag separated by a space. The prototype for use in this case is "-option argument"

===Lighting===
These factors can dramatically alter the atmosphere of the game. [[Sample Lighting Settings|This page]] has some sample lighting settings with screenshots. Largely sourced from [https://www.hard-light.net/forums/index.php?topic=94875.msg1870215#msg1870215 this thread].

{{Table224|
This method of configuring a mod's lighting has been replaced with the [[Lighting_Profiles.tbl]]. New lighting flags now mainly serve usability and accessibility reasons, with some legacy support for modifying ambient intensity.}}
====-light====
{{Table224|
This is a multiplier applied to all level lights. This includes a mission's ambient light setting, but does not include imaged-based lighting from a mission's background. Defaults to 1.

}}
====-ambient ====

{{Table224|
This is a multiplier applied to the intensity of level ambient lighting. It applies only to the simple ambient light value, not to image-based lighting from a mission's background. Defaults to 1.

Unlike the old -ambient_factor flag this is a true multiplier to light intensity and does not use special math, and is not clamped above 0. A value of 0 will effective disable ambient light.

}}
====-emissive====

{{Table224|
This sets an amount of white ambient light added to all models. This is in addition to any amount of ambient light already present in a level. This is a relative amount, 1.0 is equivalent to a mission set to 255,255,255, and it can be set higher than this. This light is added after the multiplier from -ambient or any mod ambient settings are applied, so will add light regardless of other settings. Defaults 0.

}}
====-ambient_factor====
This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. The way this works is a bit weird. (ambient factor * 2) - 255 is "added" to mission ambient, but since this will almost always be a negative value it's actually removed from mission ambient. Because of how light values are clamped it cannot go below 5.1, ambient_factor 70 will result in -115 to mission ambient which is 120 by default. 70 is essentially the lowest ambient for missions with default ambient settings which are all retail missions and the vast majority of mod missions. FS2's standard value is 120. 70 is basically no ambient, 80 is a bit of ambient, and 90 is quite a bit of ambient(ships will look bright from all sides). Anything above that will make ships look incredibly "flat". This is a relative value.

{{Table224|

*'''''This feature is now deprecated, it will have no effect on rendering. see -ambient for an alternative user setting and [[Lighting_Profiles.tbl]] for mod configuration'''''
}}
====-spec_point====
This is a multiplier that adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. If you want lasers to light up more set this to around 2. If you want less lighting, set it to around 0.5. Default is 1.0. This is a relative value.

{{Table224|
*'''''This feature is now deprecated, it will have no effect on rendering. see [[Lighting_Profiles.tbl]] for mod configuration alternatives'''''
}}
====-spec_static====
This is a multiplier that adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. For non-PBR models it will make their sun-lit side very shiny and reflective; for PBR models it will make the sun-lit side a lot brighter. There's no flag to control diffuse static lighting so non-PBR models will always have the same amount of light come from suns. Default is 1.0. This is a relative value.

{{Table224|
*'''''This feature is now deprecated, it will have no effect on rendering. see [[Lighting_Profiles.tbl]] for mod configuration alternatives'''''
}}
====-spec_tube====
This is a multiplier that adjusts how much beam weapons contribute to specular highlights. Higher numbers mean a greater contribution. If you want lasers to light up more set this to around 2. If you want less lighting, set it to around 0.5. Default is 1.0. This is a relative value.

{{Table224|
*'''''This feature is now deprecated, it will have no effect on rendering. see [[Lighting_Profiles.tbl]] for mod configuration alternatives'''''
}}
====-ogl_spec====
*'''''This feature is now deprecated, it will have no effect on rendering.'''''
Takes a numerical argument. This value changes the basic shininess of the specular light in OpenGL. A lower value reduces the overall intensity of the light making it broader and less powerful. A higher value makes it more focused and brighter. The default value is 80, and the usable range is 0 to 128 (clamped). The original default value was 60, but it was raised to behave more D3D like.

====-spec_exp====
*'''''This feature is now deprecated, it will have no effect on rendering.'''''
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts the size of the shiny spot on ships. Higher number mean smaller spots. Default is 16. This is a relative value.

===Graphics===

====-bloom_intensity====
Requires -post_processing ("Enable Post Processing") command.
Default value is 25. Range is 0-200.

====-shadow_quality====
{{table373|
'''"Set shadows quality"'''

This sets the resolution for the shadow maps the engine uses for real-time shadowing.
Note that higher resolutions require more processing power and VRAM; this feature is only recommended for users with a decently powerful dedicated GPU.
Valid ranges are 0 to 4 with 2 being the default.

* 0 disables shadows (so there's no point in setting it!)
* 1 uses 512x512 resolution (lower quality)
* 2 uses 1024x1024 resolution (medium quality)
* 3 uses 2048x2048 resolution (high quality)
* 4 uses 4096x4096 resolution (ultra quality)

Currently this requires -enable_shadows to be set, or it has no effect.
}}
{{table38|No longer requires -enable_shadows to be set.}}

====-anisotropic_filter====
{{table382|
'''"Set anisotropic filtering level"'''
Valid ranges are 1 to whatever maximum the GPU supports (which should be 16 for most currently available GPUs)
By default, the GPUs' max supported level is used; set this to 1 if you want the minimum level available.}}

====-res====
Allows you to specify a resolution if the desired one cannot be set in the Launcher.
For example, -res 1920x1080 would run the game in 1920 x 1080 resolution. Since it requires an argument, it needs to be entered as a custom flag when using the Launcher. The "Run at specified resolution" option the Launcher gives is essentially this, but without being able to actually specify a resolution, it doesn't work.

====-center_res====
Specifies how much of the screen area should be utilized by menus, movies, the HUD, and various other 2D graphics. Intended for use with configurations with an extremely wide field of view, such as triple-monitor setups.

By default, if the screen resolution's aspect ratio is wider than 7:2, most 2D elements utilize only the center 3/10 of the screen area. This setting allows users to override this behavior to make better use of the center monitor. (The reason for using 3/10 rather than 1/3 is that many triple-monitor setups use bezel correction, which reduces the fraction of the screen area that the center monitor displays.)

For example, if the screen resolution is 6000x1080, then -center_res 1920x1080 will keep most 2D graphics in the center 1920x1080 area. This setting is automatically scaled to fit the screen resolution, so (assuming the resolution is still 6000x1080) -center_res 1280x720 is given, then that resolution is enlarged to 1920x1080.

====-aa_preset====
{{table202|
This parameter can be used to select the AA solution the engine is using. Valid values are 0 to 6 inclusive:
* 0: FXAA Low
* 1: FXAA Medium
* 2: FXAA High
* 3: SMAA Low
* 4: SMAA Medium
* 5: SMAA High
* 6: SMAA Ultra

The various AA presets can be tested in the F3 lab; the number keys from 0-6 switch between the various presets as described above.
}}

====-fxaa_preset====
Requires both -post_processing and -fxaa. Can be used to adjust the FXAA quality and speed, 0 is fastest, 9 is highest quality. Default setting is 6.
{{table202|Has been superceded by the -aa_preset cmdline argument}}

====-smaa_preset====
Requires both -post_processing and -smaa. Can be used to adjust the SMAA quality and speed, 0 is low, 1 is medium, 2 is high, and 3 is ultra (highest quality). Default setting is 1.
{{table202|Has been superceded by the -aa_preset cmdline argument}}

===Game Speed===

====-no_fps_capping====
'''"Don't limit frames-per-second"'''

===Gameplay===

====-keyboard_layout====
'''"Manually sets a keyboard layout"'''

A commandline parameter to set the keyboard layout as a string parameter.
{{Table3614|
*Currently the only valid string is "qwertz" (German) but French azerty may be added in future.}}

====-pilot====
''''Automatically loads the pilot with the specified name''''
Skips the barracks and automatically loads the pilot with the name specified.

====-start_mission====
'''"Skip the mainhall in jump right into the specified mission"'''

Jump into the mission specified by the filename. Only in effect on the first run. This will skip load of the mainhall and its other related things altogether.

====-mod====
Specifies in which folders inside FreeSpace 2 directory, the game looks for all the game data (models, missions, textures, tables, ...). Retail version only looks inside ''Freespace2/data/'' structure and ''Freespace2/vp archives''.

This flag allows installing several different mods that modify retail behavior, and switching between them without needing to erase files or having undesired cross effects. Each mod should be installed in its own folder.

It takes one argument string: the chain of names of the used directories. Comma (''',''') must be used as separator. In this way, '''-mod dir1,dir2,dir3,...,dirx''' causes the game to use the following directory precedence:

#Freespace2/dir1/
#Freespace2/dir2/
#Freespace2/dir3/
# ... (the rest of the typed directories) ...
#Freespace2/dirx/
#Freespace2/

This flag can be indirectly set, (and it is normally set), through Launcher MOD tab and [[mod.ini]] file.

Within the Launcher's MOD tab you can select one directory, (let's call it ''moddir''), so the flag is at least set to '''-mod moddir'''.
If ''Freespace2/moddir/[[mod.ini]]'' exists it will be used to modify the -mod flag, too.

For further details, see '''[[mod.ini]]'''

'''Data precedence'''

As already said, within the different directories, the data precedence is set by the specified order in the -mod flag. The lowest priority goes to the Freespace2 installation directory.

Inside each directory, data precedence is the following:

#Individual files located in ''Current_dir/data/'' subdir structure. See [[FS2_Data_Structure|FS2 Data Structure topic]] for deeper info about the different folders and contents this structure has.
#Files located inside vp archives. (These vp archives are "similar" to zip archives. They just contain other files and folders. Moreover, files have to be stored using the same ''data/'' structure used outside it). Vp archives are read in alphabetical order with files loaded earlier taking priority over those loaded later. So aaa.vp files have higher priority than aab.vp files and so on.

The highest priority file overrides the rest of them. In this way, if you have a ''Mission.fs2'' inside ''Freespace2/Pri1/data/missions/'' it doesn't matter that this ''Mission.fs2'' is also inside ''Freespace2/Pri1/aaa.vp'', ''Freespace2/Pri1/aab.vp'', ... or ''Freespace2/data/missions/''. This data precedence allows the user to quickly replace old files by corrected or enhanced ones adding them in a higher priority place.

'''Additional notes'''
# As derived from the explanation, the exact names for directories or vp archives are actually irrelevant. It only matters the directory order inside -mod flag argument and the alphabetical order for vp archives inside each used directory.
# This flag is also used by [[Portal:FRED|FRED]]. So if there is special mod info, (like backgrounds maps, ship models or whatever), it must be typed, (''Fred2_Open_r.exe -MOD whatever''), or FRED won't be able to use it. A special build of wxLauncher is able to configure FRED so that the -mod doesn't have to be done manually see [http://www.hard-light.net/forums/index.php?topic=67950.msg1387911#msg1387911 the forum post] for more details.
{{Table3612|As of 3.6.12 FRED now loads cmdline_fso.cfg just like FS does so FRED will use the same settings as FS including the -mod settings}}
# Be careful while typing the directory names in the flag argument or inside mod.ini files. The program doesn't check if the typed directories exist. If they do not exist, they are just ignored. No warnings, no errors, no messages at all.

{{Warning| '''Priority and Texture Formats'''

''Obsolete behavior - Until FS2_open v3.6.9.:''

FS2_Open can use several file formats in textures: [http://en.wikipedia.org/wiki/PCX PCX], [http://en.wikipedia.org/wiki/DirectDraw_Surface DDS], [http://en.wikipedia.org/wiki/JPG JPG] and [http://en.wikipedia.org/wiki/TGA TGA]. Make sure you keep the format when you update your texture. For example if you update the old ''TextureOfMyFighter.tga'', do not save it as ''TextureOfMyFighter.dds'' in a higher priority place, because there is a chance of the game loading the old one despite of all.

The reason to do this is that, loading process (including priorities) is applied firstly for a kind of textures (TGAs), then for another kind (JPGs), and so on. This behavior can lead to situation where your new, updated and higher priority placed texture is not read because the format of the older one.

''New behavior - From FS2_open v3.6.10. (including previous beta testing releases):''

The former issue has been fixed. Now texture format priority is only applied within the same location. In this ''strange'' situation it goes DDS -> TGA -> JPG -> PCX. Examples:
* ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.dds'' is loaded instead of ''/Freespace2/MyVp.vp>>>data/maps/MyTexture.tga''.
* But your improved ''/Freespace2/data/maps/MyTexture.xxx'' will override them both despite of its format.
In this way, when you update any texture, you don't have to pay attention to its original format. Just place it in a higher priority place.

Nevertheless, global priority is kept between animated and static textures. Because of their management, animated textures (ANIs and EFFs) are looked for BEFORE static ones. In this way there's no way to update an animated texture with a static one (an obsolete ANI is always going to be loaded before the newer DDS version). The solution: use an updated EFF with just one frame.

}}

====-fov====
This flag allows the player to specify the ''vertical'' Field of View (FoV) angle, in radians, for the player eyepoint. The angle is measured across the full height of the viewing cone. The FoV angle is technically known as the Angle of View (AoV)

*Syntax: '''''float''''' Angle
*Valid Values: 0 to 2*Pi radians
*Default Value: 0.75 radians

{{Note|For peculiar reasons, the actual FoV/AoV used by the game will be the supplied value multiplied by 1.39626348.}}

The the FoV angle/AoV is what determines the relative zoom level of the main game camera. Smaller angles generally equal to higher zoom levels, while larger angles equal to lower zoom levels (down to the theoretical x0 magnification).

However, too small of an angle will have a squashed look on the edges of your screen, and too high of an angle will greatly stretch edges. It is recommended to change the AoV, as FS2's default AoV has some perspective distortion at the screen edges (the default AoV is too high).

A natural looking (as if you where physically in the cockpit) AoV depends on the distance the player's actual eyes are away from the screen: the further away from the screen, the smaller the AoV should be, and vice versa. "Ergonomic" distances generally yield a '''''diagonal''''' AoV of 0.523 radians (30 degrees), but you can easily find the natural AoV by the following formula:

AoV (radians) = 2 * atan( H / ( 2*D ))

where:

Height of screen = H

Distance between head/eye and the screen = D

Generally, gamers like to increase the AoV in order to increase their peripheral vision on the screen, so as to gain a better situational awareness around their craft. An AoV of 0.39 radians seems to be a good start, but feel free to experiment and use whatever AoV you are most comfortable with.

====-deadzone====
This allows the player to set the deadzone value as a percentage of the joystick's range, allowing a more finely tuned setting than with the in-game options.
*Syntax: '''''integer''''' Percentage
*Valid Values: 0 to 100
*Default Value: 0

Setting this value to 100 will make the joystick axes completely unresponsive.
While this flag is set, the in-game deadzone options will be disabled.

===Launcher===

====-query_speech====
'''"Does this build have Speech?"'''

Determines if the current build includes text-to-speech.

===Multiplayer===

====-gamename====
Specifies the name of the game to be created by the host. This only works when used in conjunction with -startgame.

Takes one argument string, the name to be assigned to the game being created.

This argument does nothing when used with -standalone. To set the name for a standalone server, see [[Multiplayer(Main)#Standalone Servers|Standalone Servers]].

See related:   [[Command-Line_Reference#-startgame|-startgame]]   [[Multiplayer(Main)#Standalone Servers|Standalone Servers]]

====-password====
Specifies the password for a standalone server. This only works when used in conjunction with -startgame. Cannot be used in conjunction with -closed or -restricted.

Takes one argument string, the required password for the game being created.

See related: [[Command-Line_Reference#-startgame|-startgame]] [[Command-Line_Reference#-closed|-closed]] [[Command-Line_Reference#-restricted|-restricted]]

====-allowabove====
Specifies a player's minimum rank for joining a game. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking above which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-allowbelow====
Specifies a player's maximum rank for joining a game on a standalone server. This only works when used in conjunction with -startgame.

Takes one argument integer, the points ranking below which a player must be to enter the game.

See related: [[Command-Line_Reference#-startgame|-startgame]]

====-port====
Specifies the port on which to host a game or serve a standalone game.

Takes one argument integer, the port on which the host will listen for clients.

====-connect====
Automatically connect to multiplayer IP:PORT.

Takes one string value, such as 192.168.0.1:

====-timeout====
Multiplayer network timeout (secs).

Takes one integer argument, the timeout value in seconds. Default is 30.

====-cap_object_update====
Caps the maximum object update the server will respond to regardless of what the client has set. If the client is set to request high object updates but the server is capped to low, then that's all the client will get.

Takes one argument integer (0 to 3) which corresponds to the object update cap (With 0 being low and 3 being LAN).

===Help===

====-help====
Instructs FSO to print out all supported parameters. Some launchers can use these options to automatically populate the available command line options, even if the version of FSO is far newer than the launcher itself. NOTE: This option only works in Linux builds...

====--help====
See [[Command-Line_Reference#-help|-help]]

====-h====
See [[Command-Line_Reference#-help|-help]]

====-?====
See [[Command-Line_Reference#-help|-help]]

===Deprecated Options===
These options were present in the executable for some time, but have since been removed and deprecated. The engine will throw a non-fatal error when they are found in the commandline. Some of these functions have been removed entirely, others are now part of the standard operation of the engine.

====-clipdist====

====-spec====

====-env====

====-glow====

====-normal====

====-height====

====-missile_lighting====

====-img2dds====

====-snd_preload====

====-nohtl====

====-safeloading====

====-timerbar====

====-old_collision====

====-json_pilot====
'''"Dump pilot files in JSON format"'''

Writes the information stored in savefiles to JSON files.

====-novbo====
'''"Disable OpenGL VBO"'''

====-noibx====
'''"Don't use cached index buffers (IBX)"'''

Disables IBX caching of model geometry data. This will dramatically increase load times, but will help troubleshoot a model if one is working incorrectly.

====-no_glsl====
'''"Disable GLSL (shader) Support"'''

Disables the use of GLSL rendering (OpenGL shaders). The game will revert to legacy fixed render pipeline. Please note that Normal and Height map effects will be unavailable.

====-disable_glsl_model====
'''"Don't use shaders for model rendering"'''

====-disable_di_mouse====
'''"Disables the DirectInput mouse code for FSO on windows."'''

'''Windows Only''' Can make mouse movement smoother on certain machines.

====-cache_bitmaps====
'''"Cache bitmaps between missions"'''

====-no_emissive_lighting====
See -emissive_lighting.

====-post_process====
See -no_post_process.

===Completely Removed Options===
Using one of these is the same as using a random string.

====-show_mem_usage====

[[Category:Lists]]
[[Category:Source Code Project]]

Lighting Profiles.tbl

2025-10-07T12:53:00Z

-Joshua-: /* $Exposure: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance, which gives a more vibrant look.

The best way to view the differences between all of these is to open the F3 lab.
}}

===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers is like a lens catching more light. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.

If you find this concept hard to grasp, consider how your eyes adapt to darkness or brightness. A high exposure is like an eye adapted to a dark room, a low exposure is an eye adapted to a bright room. So with high exposure, you'll see more details in dark scenes, but you're also more easily blinded by bright effects.
*Syntax: '''''Float'''''
*Default: 4.0
}}

===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you'll see a lot of bright white spots, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means you'll see less full white areas, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. It differs from shoulder length in that shoulder length 'selects' the areas in which the shoulder should be applied, and shoulder strength determines how strongly it should be applied.
This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laser light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Overall brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to all adjustable light.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cockpit light radius modifier:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==#PROFILES==
{{Table232|
Begins the standard, named profiles section. Named profiles can have all the same profile values set, but must be given a name. The name "Default Profile" can be used to define, or alter, the primary default profile. Other profiles can by assigned on a per-mission basis or viewed in the F3 lab.
}}

===$Profile:===
{{Table232|
The name of the profile being defined or modified. See the values above in the default profiles section for documentation on available settings.
}}

==#END PROFILES==
{{Table232|
Required to close the profiles section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+default: 20

$Laser Light Radius:
+default: 100

$Beam Light Radius:
+default: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>

== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Game settings.tbl

2025-08-28T16:20:47Z

-Joshua-: /* $Skybox internal depth consistency: */

{{SCP_table}}
{{TableVersionGit|2025-02-10|642111676012bc6696f4024c40296a6c20b3b958}}
{{Tables}}
The '''game_settings.tbl''', also known as mod.tbl, defines options that can be changed globally. All settings are optional.

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

If the version targeted in [[game_settings.tbl#$Target_Version:|target version]] is equal to or later than these listed, the following options are enabled by default:
{{Table220|
*[[game_settings.tbl#$Fixed_Turret_Collisions:|Fixed Turret Collisions]]
*[[game_settings.tbl#$Fixed_Missile_Detonation:|Fixed Missile Detonation]]
*[[game_settings.tbl#$Shockwaves_Damage_All_Object_Types_Once:|Shockwaves Damage All Object Types Once]]
*[[game_settings.tbl#$AI_use_framerate_independent_turning:|AI use framerate independent turning]]
*[[game_settings.tbl#$Use_host_orientation_for_set-camera-facing:|Use host orientation for set-camera-facing]]
}}
{{Table230|
*[[game_settings.tbl#$Shockwaves_Inherit_Parent_Weapon_Damage_Type:|Shockwaves Inherit Parent Weapon Damage Type]]
*[[game_settings.tbl#$Fixed_Chaining_To_Repeating_Events:|Fixed Chaining To Repeating Events]]
}}
{{Table240|
*[[game_settings.tbl#$Calculate_subsystem_hitpoints_after_parsing:|Calculate subsystem hitpoints after parsing]]}}

==#GAME SETTINGS==
Contains settings that affect how the engine works.

===$Target Version:===
{{Table373|
Specifies the minimum version of FreeSpace Open that this mod supports. If the version specified here is greater than the version of the current build, an error message is displayed.
}}
{{Table381|
The $Minimum version option has been renamed to $Target Version. The old name is kept with the same functionality for backwards-compatibility.

The target version specifies what version of the FSO engine this mod was created for. It will be used by the engine to enable or disable backwards-incompatible changes by default. The default value is 2.0 which specifies that the mod targets the retail engine version.
}}

====+Major:====
{{Table373|
Required. Sets the major component of the target version.
*Syntax: '''''Integer'''''
*Example: '''''3''''' (for a minimum version of 3.7.3.20151121)
}}

====+Minor:====
{{Table373|
Required. Sets the minor component of the target version.
*Syntax: '''''Integer'''''
*Example: '''''7''''' (for a minimum version of 3.7.3.20151121)
}}

====+Build:====
{{Table373|
Required. Sets the build component of the target version.
*Syntax: '''''Integer'''''
*Example: '''''3''''' (for a minimum version of 3.7.3.20151121)
}}

====+Revision:====
{{Table373|
Sets the revision component of the target version. If no revision is given then all builds of that release are supported (even nightly builds if there are any).
For nightly builds this is the date in YYYYMMDD format.
*Syntax: '''''Integer'''''
*Example: '''''20151121''''' (for a minimum version of 3.7.3.20151121)
}}

===$Window title:===
{{Table382|
Specifies the name of the FSO window when this mod is running. If blank or unspecified, the window will have the default title of "FreeSpace 2".
*Syntax: '''''String'''''
}}

===$Window icon:===
{{Table382|
Specifies the icon filename of the FSO window when this mod is running. If blank or unspecified, the window will have the default icon.
*Syntax: '''''String'''''
}}

===$Mod title:===
{{Table224|
Specifies the title of the mod and will be displayed at the mainhall near the FSO version.
*Syntax: '''''String'''''
}}
{{Table250|
It is now possible to display the mod title on its own. Previously, the mod version was also required.
}}

===$Mod version:===
{{Table224|
Specifies the version of the mod and will be displayed at the mainhall near the FSO version. Can be a string or it can be semantic versioning such as 2.0.0.
*Syntax: '''''String'''''
}}
{{Table250|
It is now possible to display the mod version on its own. Previously, the mod title was also required.
}}

===$Unicode mode:===
{{Table382|
Enabled the Unicode text mode for this mod. In Unicode mode all text is assumed to be UTF-8 encoded Unicode and certain features are disabled if they do not have full Unicode support. Most notably, if this is enabled then the engine will no longer support the old bitmap fonts that were used by Retail FreeSpace. Only the newer TrueType fonts will be supported.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Splash screens:===
{{Table232|
Defines a list of splash screens that FSO can display upon game startup. The actual image displayed is chosen at random from the applicable entries. Entries with exact aspect ratio matches will be prioritized first, followed by aspect ratio ranged matches, followed by entries without an aspect ratio specified.}}

====+Bitmap:====
{{table232|
The name of the bitmap to use as a splash screen. Extension will be removed if included.
*Syntax: '''''+Bitmap: String'''''}}

====+Aspect Ratio:====
{{table234|
Only consider this bitmap to be an applicable entry if the user's screen aspect ratio matches the specified number within +/- 0.01.
*Syntax: '''''+Aspect Ratio: Float'''''}}

====+Aspect Ratio Min:====
{{table234|
Only consider this bitmap to be an applicable entry if the user's screen aspect ratio is at least the specified number.
*Syntax: '''''+Aspect Ratio Min: Float'''''}}

====+Aspect Ratio Max:====
{{table234|
Only consider this bitmap to be an applicable entry if the user's screen aspect ratio is at most the specified number.
*Syntax: '''''+Aspect Ratio Max: Float'''''}}

===$Splash fade in time:===
{{Table232|
Sets the time in milliseconds it takes for a splash screen to fade in.
*Syntax: '''''Integer'''''
*Default Value: '''''0'''''}}

===$Splash fade out time:===
{{Table232|
Sets the time in milliseconds it takes for a splash screen to fade out.
*Syntax: '''''Integer'''''
*Default Value: '''''0'''''}}

===$Center splash logo:===
{{Table232|
Sets whether the splash logo will be displayed in the middle of the screen. If this is false (the default), it will be displayed at the top-left.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Disable FSO Internal Loadout Restoration System:===
{{Table234|
When the player configures the ships and weapons of the wings in the loadout screen, FSO will remember these settings and attempt to apply them again if the player quits the mission and comes back to it later. FSO will only remember the most recent mission's loadout, so it will not attempt to restore the loadout if the player loads a different mission. It will also not attempt this if the mission's ''$Modified:'' date has changed. This flag can be used to prevent FSO from attempting restoration even if it normally would.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

==#LOCALIZATION SETTINGS==
Contains various settings related to localization and language support.

===$Use tabled strings for the default language:===
{{Table202|
Causes the game to use the text in strings.tbl and tstrings.tbl even when the current language is English. By default, the game will use the literal text in the source code and the data files (tables and missions) and will not look up the entry when the language is English. For other languages, the translation is always used, if it exists, regardless of this setting.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$Don't pre-empt training message voice:===
{{Table214|
Prevents training messages from being interrupted by other training messages. If a training message has a voice file associated with it, or simulated speech is active, the next message will not be played until the current message has finished.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

==#CAMPAIGN SETTINGS==
This group contains various Campaign related settings and overrides.

===$Default Campaign File Name:===
Defines which campaign will be selected by default for new pilots. A file extension is not needed and, if present, is removed by the code.
*Syntax: '''''String'''''

===#Ignored Campaign File Names===
Defines which campaigns, if present, will not appear in the Campaign Room. In the original implementation, only single-player campaigns could be ignored and file extensions were required, but see below.
{{Table371|As of 3.7.1, file extensions are not required and, if present, are removed by the code.}}
{{Table382|As of 3.8.2, file name comparisons are not case sensitive and multiplayer campaigns can be ignored.}}
====$Campaign File Name:====
File name of the campaign to ignore. Multiple entries may exist.
*Syntax: '''''String'''''

===#Ignored Mission File Names===
{{Table382|Defines which standalone missions, if present, will not appear in the Tech Room or Multiplayer Lobby. Both single-player and multiplayer missions can be ignored, but missions which appear in a campaign cannot. File extensions are not required and, if present, are removed by the code. File name comparisons are not case sensitive.
====$Mission File Name:====
File name of the mission to ignore. Multiple entries may exist.
*Syntax: '''''String'''''
}}

===$Red-alert applies to delayed ships:===
{{Table372|Controls whether red-alert saved statistics (hitpoints, weapons, subsystem strengths) will be restored for ships that are not present at mission start.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

==#HUD SETTINGS==
This group contains various HUD behavior settings and overrides

===$Directive Wait Time:===
*Defines how long the game will wait before displaying a directive.
*Syntax: '''''Integer'''''
*Values: '''''Greater than or equal to 0 ms'''''

===$Cutscene camera displays HUD:===
Show the HUD when the cutscene camera is enabled.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Cutscene camera disables HUD: and had a default of YES.

===$Full color head animations:===
Enables full-color head ANIs. Normal head ANIs will appear in gray.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Color head animations with hud colors: and had a default of YES.

===$Don't automatically select a turret when targeting a ship:===
{{Table220|Uses FS1 behavior where targeting a new ship did not target any turrets. In FS2 a turret is automatically targeted.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Supernova hits at zero:===
{{Table222|
Adjusts the HUD timer so that the timer reaches zero when the supernova hits the player. The actual timing is not affected -- whether the flag is enabled or not, the supernova will always hit the player when 5 seconds remain in the time specified in the sexp.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$Always warn player about unbound keys used in Directives Gauge:===
{{Table222|
Ensures that the "Key Unbound" message will pop up for a directive with an unbound key in any single-player mission, not just a training mission. Note, that the default string (index 426) will still say "Warning\nYou have no control bound to the action \"%s\". You must do so before you can continue with training." Thus, it is advised to change the string at index 426 using the -lcl.tbm to "Warning\nYou have no control bound to the action \"%s\". You must do so before you can continue with this mission."
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$HUD drop shadows enabled by default:===
{{Table232|
If this flag is active, certain elements displayed on the HUD (all text, the main targeting reticle, and the background of the ETS gauges) will have a "drop shadow" effect. Note that whether or not the flag is active, the player can set this using the "Toggle HUD Drop Shadows" control.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$Unify scanning behavior:===
{{Table242|
*Unifies scanning behavior between subsystem, regular, and cargo allowing missions to use all scan types in all situations.
*Also allows changing the "Cargo:" text line in a mission by adding "$Cargo Title: STRING" after the "$Cargo 1:" or "$Cargo 2:" lines in the mission file. FRED UI support not yet added for $Cargo Title so you have to do it manually.
*When this flag is enabled, all ships, no matter the ship class, will react the same way to the cargo-related or scanning-related ship flags:
**They are not scannable by default
**Setting the "scannable" flag makes them scannable, and scanning the subsystem will reveal the cargo
**A new flag available with alter-ship-flag, "no-scanned-cargo", changes the behavior to scanned/unscanned instead of revealing the cargo
**The "toggle-subsystem-scanning" flag must be set to swap full-ship scanning mode into subsystem scanning mode and works for all ship types
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$Don't show callsigns in the escort list:===
{{Table242|
By default, callsigns are shown in the escort list using the same format as in the target box. If this flag is active, callsigns will not be displayed.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

==#SEXP SETTINGS==
This group contains SEXP settings and overrides.

===$Loop SEXPs Then Arguments:===
Flips how when-argument settings loop. See: [http://www.hard-light.net/forums/index.php?topic=79602.0 SEXP Argument changes via mod.tbl]
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Use Alternate Chaining Behavior:===
When set, this allows all events in a chain to repeat, instead of only the last one. It makes the event chaining behavior act as people expected it to be in [http://scp.indiegames.us/mantis/view.php?id=82 Mantis #82].
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Fixed Chaining To Repeating Events:===
{{Table230|When set, this makes event chaining to repeated events work as designed - that is, the chained event will only be evaluated after the chain delay. If the repeating event's interval is shorter than the chain delay, then the delay countdown will continually be restarted until all repetitions have completed. Without this flag, FSO will emulate retail behavior which, due to a bug, allowed chained events to be evaluated immediately after a repeating event is first evaluated.

NOTE: Although the name does not reflect it, the same issue affects repeating events that are evaluated by <tt>is-event-true-delay</tt> and <tt>is-event-false-delay</tt>. Without this flag, FSO will emulate retail behavior which causes these SEXP operators to ignore any delay when evaluating repeated events. With this flag, the delay will be measured from when the final repeat iteration occurs.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Use host orientation for set-camera-facing:===
{{Table220|When set, this will take into account the host orientation for cutscene cameras. This is a bugfix for [https://github.com/scp-fs2open/fs2open.github.com/issues/3889 GitHub issue #3889].
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Show-subtitle uses pixels:===
{{Table222|When set, SEXPs which display subtitles will read their arguments as pixels, not percentages. If <code>$Show-subtitle base resolution:</code> is set, these pixels will be scaled up or down as needed.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Show-subtitle base resolution:===
{{Table222|When set, subtitles are assumed to display at the appropriate size in the specified resolution, and will be scaled up or down if the current screen resolution is different. If this is not set, or is set to a resolution less than (640, 480), subtitles will not be scaled.
*Syntax: '''''(Integer, Integer)'''''
*Default Value: '''''(-1, -1)'''''}}

===$HUD-set-coords base resolution:===
{{Table232|The hud-set-coords SEXP has always used exact pixels, without regard for the current screen resolution. This setting enables a similar scaling mechanism as ''$Show-subtitle base resolution:''.
*Syntax: '''''(Integer, Integer)'''''
*Default Value: '''''(-1, -1)'''''}}

===$$Always Show Directive Value Count:===
{{Table250|
*If this setting is enabled, Directive-as-Value values in Directives will always show the number. By default this is disabled, and only values > 1 are shown.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

==#GRAPHICS SETTINGS==
This group contains settings related to graphics.

===$Enable External Shaders:===
Enables the use of external shader files. By default, the engine will use the built-in shaders.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Default Detail Level:===
{{Table3615|
Determines which graphics detail level preset (low, medium, high, very high) acts as the default for new pilots.
*Syntax: '''''Integer''''' (0-3)
*Default Value: '''''3''''' (very high)}}

===$Briefing Window FOV:===
{{Table371|
Determines the FOV in the briefing Icon window. Retail default for this is 0.29375; some previous versions of FSO used a value of 0.5.
*Syntax: '''''Float''''' (0.0 to 1.0)
*Default Value: '''''0.29375'''''}}

===$Generic Pain Flash Factor:===
{{Table373|
Determines the intensity of the pain red flash when the player is hit.
*Syntax: '''''Float'''''
*Default Value: '''''1.0'''''}}

===$Shield Pain Flash Factor:===
{{Table373|
Determines the intensity of a pain flash when the player's shields are hit. Color will match the current ships shield color defined in ships.tbl. A value of 0 will give retail behavior (no shield effect). Positive values will cause the effect to start at full intensity at full shields and go to next to no intensity at zero shields. Negative values will cause no effect at full shields and full effect at no shields. Values should be kept between -1.0 and 1.0 for good pilot visibility.
*Syntax: '''''Float'''''
*Default Value: '''''0.0'''''}}

===$EMP Pain Flash Factor:===
{{Table224|
Determines the intensity of the flash when the player is hit by an EMP blast or weapon.
*Syntax: '''''Float'''''
*Default Value: '''''1.0'''''}}

===$EMP Pain Flash Color:===
{{Table224|
Determines the RGB color value of the flash when the player is hit by an EMP blast or weapon.
*Syntax: Color, (red, green, blue) respectively, integer value from 0 to 255
*Default Value: '''''(255, 255, 127)'''''}}

===$BMPMAN Slot Limit:===
{{Table382|
Determines the maximum number of textures that can be loaded simultaneously. This includes every frame of an animation, unless that animation is streaming (e.g. command briefing animations, message talking heads, etc). Also includes dynamically-created textures (used internally for various functions).
*Syntax: '''''Int'''''
*Values: '''''Greater than or equal to 3500'''''
*Default Value: '''''4750'''''}}

===$EMP Arc Color:===
{{Table382|
Allows custom RGB color values to be set for the EMP lightning arc effect.
*'''+Primary Color Option 1:'''
**The RGB color of the first primary color for the EMP lightning arc effect.
**The actual lightning arc color shown in-game is randomly selected between the first and second primary color.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (64, 64, 5)
*'''+Primary Color Option 2:'''
**The RGB color of the second primary color for the EMP lightning arc effect.
**The actual lightning arc color shown in-game is randomly selected between the first and second primary color.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (128, 128, 10)
*'''+Secondary Color Option 1:'''
**The RGB color of the secondary color for the EMP lightning arc effect.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (255, 255, 10)
}}

===$EMP Arc Width:===
{{Table224|
Allows setting how the width is calculated for the EMP lightning arc effect.
*'''+Width Default:'''
**The default width of the arc. This value will be multiplied by `+Width Radius Multiplier:` if the radius of the ship is less than or equal to `+Do Not Use Width Multiplier Over Radius:`.
**Syntax: '''''Float'''''
**Default value: 0.9
*'''+Width Radius Multiplier:'''
**The value that the width is multiplied by if the radius of the ship is less than or equal to `+Do Not Use Width Multiplier Over Radius:`.
**Syntax: '''''Float'''''
**Default value: 0.01
*'''+Do Not Use Width Multiplier Over Radius:'''
**If the object is larger than this radius, the `+Width Default:` value is used.
**Syntax: '''''Float'''''
**Default value: 500
*'''+Width Radius Minimum:'''
**Minimum width that the arc can be. Any calculated widths lower than this value will be set to this value.
**Syntax: '''''Float'''''
**Default value: 0.2
}}

===$Damage Arc Color:===
{{Table382|
Allows custom RGB color values to be set for the damage lightning arc effect.
*'''+Primary Color Option 1:'''
**The RGB color of the first primary color for the damage lightning arc effect.
**The actual lightning arc color shown in-game is randomly selected between the first and second primary color.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (64, 64, 255)
*'''+Primary Color Option 2:'''
**The RGB color of the second primary color for the damage lightning arc effect.
**The actual lightning arc color shown in-game is randomly selected between the first and second primary color.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (128, 128, 255)
*'''+Secondary Color Option 1:'''
**The RGB color of the secondary color for the damage lightning arc effect.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (64, 64, 5)
}}

===$Damage Arc Width:===
{{Table224|
Allows setting how the width is calculated for the EMP lightning arc effect.
*'''+Width Default:'''
**The default width of the arc. This value will be multiplied by `+Width Radius Multiplier:` if the radius of the ship is less than or equal to `+Do Not Use Width Multiplier Over Radius:`.
**Syntax: '''''Float'''''
**Default value: 0.9
*'''+Width Radius Multiplier:'''
**The value that the width is multiplied by if the radius of the ship is less than or equal to `+Do Not Use Width Multiplier Over Radius:`.
**Syntax: '''''Float'''''
**Default value: 0.01
*'''+Do Not Use Width Multiplier Over Radius:'''
**If the object is larger than this radius, the `+Width Default:` value is used.
**Syntax: '''''Float'''''
**Default value: 500
*'''+Width Radius Minimum:'''
**Minimum width that the arc can be. Any calculated widths lower than this value will be set to this value.
**Syntax: '''''Float'''''
**Default value: 0.2
}}

===$Requires Rendering Feature:===
{{Table210|Needs description}}

===$Render player muzzle flashes in cockpit:===
{{Table212|
Determines whether muzzle flashes will be shown within the cockpit view.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Glowpoint nebula visibility factor:===
{{Table220|
*Specifies the degree to which glowpoints are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.2}}

===$Shield nebula visibility factor:===
{{Table220|
*Specifies the degree to which shield effects are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.2}}

===$Thruster nebula visibility factor:===
{{Table220|
*Specifies the degree to which thruster flares are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.5}}

===$Beams affected by nebula visibility:===
{{Table212|
Determines whether beam weapons will be faded by nebula fog.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

====+Constant visibility factor:====
{{Table220|
*Specifies the degree to which beam effects are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 4.0}}

====+Scaled visibility factor:====
{{Table220|
*Specifies the degree to which the ''size'' of a beam effect affects its visibility. This is multiplied by the radius of the beam and added to the above for the final value. This results in larger beams being visible from farther away.
*Syntax: '''''Float'''''
*Default Value: 0.1}}

===$Weapons affected by nebula visibility:===
{{Table212|
Determines whether lasers, missiles, countermeasures, etc will be faded by nebula fog.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

====+Weapon visibility factor:====
{{Table220|
*Specifies the degree to which laser-type weapons are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.3}}

====+$Trail visibility factor:====
{{Table220|
*Specifies the degree to which trails (weapon and ship contrails) are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.0}}

====+Shockwave visibility factor:====
{{Table220|
*Specifies the degree to which shockwave effects are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 2.5}}

===$Particles affected by nebula visibility:===
{{Table212|
Determines whether particle effects, including impact effects, will be faded by nebula fog.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

====+Constant visibility factor:====
{{Table220|
*Specifies the degree to which particle effects are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.0}}

====+Scaled visibility factor:====
{{Table220|
*Specifies the degree to which the ''size'' of a particle effect affects its visibility. This is multiplied by the radius of the particle and added to the above for the final value. This results in larger particles being visible from farther away.
*Syntax: '''''Float'''''
*Default Value: 0.08}}

===$Fireballs affected by nebula visibility:===
{{Table212|
Determines whether fireballs from ship explosions will be faded by nebula fog.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

====+Constant visibility factor:====
{{Table220|
*Specifies the degree to which fireballs are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.2}}

====+Scaled visibility factor:====
{{Table220|
*Specifies the degree to which the ''size'' of a fireball affects its visibility. This is multiplied by the radius of the fireball and added to the above for the final value. This results in larger fireballs being visible from farther away.
*Syntax: '''''Float'''''
*Default Value: 0.08}}

===$Shadow Quality Default:===
{{Table220|
Sets the default level for shadow quality if the 'enable_shadows' command line is used and 'shadow_quality' is not used. By default, the FSO will set the shadow detail level to 2. Valid values are 0 (shadows disabled), 1 (Low, 512x512 shadow map), 2 (Medium, 1024x1024 shadow map), 3 (High, 2048x2048 shadow map), or 4 (Ultra, 4096x4096). Note, the command line 'shadow_quality' will override any value set here.
*Syntax: '''''Integer'''''
*Default Value: '''''2'''''}}

===$Shadow Cascade Distances:===
{{Table214|
Sets the distances that the shadow map for the game scene uses. Float values must all be greater than 0 and successively larger than each consecutive value.
*Syntax: '''''List of floats'''''
*Default Value: '''''(200.0, 600.0, 2500.0, 8000.0)'''''}}

===$Shadow Cascade Distances Cockpit:===
{{Table214|
Sets the distances that the shadow map for the cockpit pass scene uses. Will only shadow the cockpit model, and does not interact with the external game scene shadow map. Float values must all be greater than 0 and successively larger than each consecutive value.
*Syntax: '''''List of floats'''''
*Default Value: '''''(0.25, 0.75, 1.5, 3.0)'''''}}

===$Shadow Disable Techroom:===
{{Table224|
Disables shadows on ships in the techroom.
*Syntax: '''''Boolean'''''
}}

===$Shadow Disable Cockpit:===
{{Table224|
Disables shadows on the player cockpit in mission.
*Syntax: '''''Boolean'''''
}}

===$Shadow Disable Mission Brief Weapons:===
{{Table224|
Disables shadows on weapons in the mission briefing.
*Syntax: '''''Boolean'''''
}}

===$Shadow Disable Mission Brief Ships:===
{{Table224|
Disables shadows on ships in the mission briefing.
*Syntax: '''''Boolean'''''
}}

===$Show Ship Casts Shadow:===
{{Table224|
When cockpit shadows are enabled, enabling this setting will cause the players ship model shown with "show ship" to cast shadow onto the cockpit.
*Syntax: '''''Boolean'''''
}}

===$Ship Model And Cockpit Share Coordinate Space:===
{{Table224|
When having the "show ship" flag enabled and cockpit models for a ship, this flag should be on if the cockpits can fit into the actual geometry of the ship model. Disable this flag if this is not the case and the cockpit needs to be rendered on top of the ship regardless of actual coordinates. If this can be enabled, the external show ship model can be rendered using deferred rendering.
*Syntax: '''''Boolean'''''
}}

===$Show Ship enabled only if Cockpits enabled:===
{{Table250|
Enabling this setting will only use the 'show-ship' flag if cockpits are enabled. Useful if your ship uses both 'show-ship' and cockpits that exist within the 'show-ship' space, and you want to allow players to toggle off cockpits. Note, 'show-ship' always only appears if in first-person view.
*Syntax: '''''Boolean'''''
}}

===$Minimum Pixel Size Thrusters:===
{{Table220|
*Specifies the smallest pixel size that thrusters will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Thrusters:===
{{Table220|
*Specifies the smallest pixel size that thrusters will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Beams:===
{{Table220|
*Specifies the smallest pixel size that beams will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Muzzle Flashes:===
{{Table220|
*Specifies the smallest pixel size that muzzle flashes will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Trails:===
{{Table220|
*Specifies the smallest pixel size that trails will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Lasers:===
{{Table220|
*Specifies the smallest pixel size that lasers will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Do Not Render Lasers Below Length:===
{{Table250|
*Specifies the smallest length that lasers will be rendered.
*Syntax: '''''Float'''''
*Default Value: 0.0001}}

===$Do Not Render Lasers Below Radius:===
{{Table250|
*Specifies the smallest radius that lasers will be rendered.
*Syntax: '''''Float'''''
*Default Value: 0.0001}}

===$Thruster Easing Value:===
{{Table220|
*Smooths out the behavior of maneuvering thruster flares the higher above 0 it is.
*This is the exponential time constant for the visual flare length to reach it's true length.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$SCPUI attempts to load hires animations:===
{{Table230|
*Prevents SCPUI from trying to load anims prefixed with "2_"
*Syntax: '''''Boolean'''''
*Default Value: true}}

{{Table230|
===$Max draw distance:===
===$Min draw distance:===
*These values do more than just cutoff the visuals at certain distances, and they must be adjusted carefully to ensure unintentional rendering artifacts are not introduced.
*The rendering engine has limited amount of 'depth resolution', the degree to which it can tell a certain polygon is closer or farther away than another. When two polygons are too close, they will Z-fight, picking arbitrarily which is closer. It is the span between the min and max draw distance that determines how well the engine can determine depth, if they are too far from one another, the Z-fighting will become more common as it has to spread its resolution over a wider range. If they are close, Z-fighting will be lessened at the cost of a smaller range of distance able to be rendered.
*Syntax: '''''Float''''', meters
*Default Values: 10,000,000,000 and 1, respectively
}}

{{Table232|
===$Randomize particle rotation:===
*Particle bitmaps are typically screen-aligned; the upper portion of the bitmap will always be mapped to the upper portion of the particle, from the point of view of the camera. Enabling this option makes ''all'' particles have a random 'tilt' in an arbitrary direction when created.
*Syntax: '''''Boolean'''''
*Default Value: false
}}

===$Disable shield effects:===
{{Table250|
*Specifies if FSO attempts to use the shield mesh impact effects. Enabling this flag will prevent the game from preforming any shield mesh effect code, which can be useful if a mod does not use those shield mesh effects.
*Syntax: '''''Boolean'''''
*Default Value: false}}

==#NETWORK SETTINGS==
This group contains network-related settings

===$FS2NetD port:===
*(description required)

===$Default object update level for multiplayer:===
{{Table220|
Sets the distances default object update rate for multiplayer matches. By default, the FSO will set the object update level to 2. Valid values are 0 (Low), 1 (Medium), 2 (High), 3 (LAN). FSO caps the bandwidth it uses based on these settings, but they were designed for connections from 1999. LAN has the least restrictive limits and does not require an actual LAN connection. Also, if a player's connection is within the dial-up speed range then game auto force the use of the lowest level during a match.
*Syntax: '''''Integer'''''
*Default Value: '''''2'''''}}

==#SOUND SETTINGS==
This group contains sound-related settings

===$Default Sound Volume:===
{{Table371|
*Defines the default sound fx volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0
*Default Value: '''''1.0'''''}}

===$Default Music Volume:===
{{Table371|
*Defines the default music volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0
*Default Value: '''''0.5'''''}}

===$Default Voice Volume:===
{{Table371|
*Defines the default voice volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0
*Default Value: '''''0.7'''''}}

===$Use weapon class impact sounds for hits to player:===
{{Table224|
Allows weapons that hit the player to play their specific impact sounds, not the hard-coded default sounds.
*Syntax: '''''Boolean'''''
}}

===$Play thruster sounds for the player:===
{{Table232|
If the player's ship has thruster sounds defined, this will ensure they are played like normal, since they are typically suppressed.
*Syntax: '''''Boolean'''''
}}

===$Unify minimum engine sound:===
{{Table250|
Allows $Minimum Engine Volume in ships.tbl to work for all ship classes. By default, that value only triggers for non-huge ships.
*Syntax: '''''Boolean'''''
}}

===$Disabled or disrupted engines are silent:===
{{Table250|
If set, engines will not play their engine noise if the ship is disabled or a disrupted (such as disruptions caused by an active EMP effect or a weapon with the "electronics" flag).
*Syntax: '''''Boolean'''''
}}

==#FRED SETTINGS==
This group contains settings for FRED.

===$Disable Hard Coded Message Head Ani Files:===
{{table371|
If set, FRED will not fill the head ani selection in the Event Editor with the retail head ani filenames.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Add Message Head Ani Files:===
{{table224|
FRED will append each +Head entry listed below to the head ani selection list in the Event Editor.}}

====+Head:====
{{table224|
The head ani filename to add. Extensions will be stripped if included.
NOTE: Pay attention to file names or anis with a,b, c variation not display in-game (unless called directly). Proper name seems to be Head-xxxNa, Head-xxxNb, with N being some number and XXX being whatever you want. Needs further testing and confirmation
*Syntax: '''''+Head: String'''''}}

===$Enable scripting in FRED:===
{{table382|
If set, scripting will be enabled in FRED. Use with extreme caution. The effects of scripts on FRED have not been fully tested. You can check if a script is running in FRED by using ba.inMissionEditor().
*Default Value: '''''NO'''''}}

===$FRED Briefing window resolution:===
{{table224|
The width and height of the briefing window in FRED. Defaults to 888x371. Note that changing this only affects FRED and can cause a mismatch to the ingame briefing view which defaults to 888x371 (or 555x232 for 640 base res).
*Syntax: '''''integer, integer'''''
*Default Value: '''''888,371'''''}}

===$Ignore Music Files In Music Player:===
{{table232|Music files in this section will not be added to FRED's built-in music player.}}
====+File:====
{{table232|Specifies a file
*Syntax: '''''string'''''}}

===$FRED spacemouse nonlinearities:===
{{table232|
Allows setting custom nonlinearities and scaling for controlling FRED with a spacemouse.
}}
====+Sideways exponent:====
{{table232|
The exponent for input for Sideways spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Sideways scale:====
{{table232|The multiplier for input for Sideways spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Forwards exponent:====
{{table232|The exponent for input for Forwards spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Forwards scale:====
{{table232|The multiplier for input for Forwards spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Upwards exponent:====
{{table232|The exponent for input for Upwards spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Upwards scale:====
{{table232|The multiplier for input for Upwards spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Pitch exponent:====
{{table232|The exponent for input for Pitch spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Pitch scale:====
{{table232|The multiplier for input for Pitch spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Bank exponent:====
{{table232|The exponent for input for Bank spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Bank scale:====
{{table232|The multiplier for input for Bank spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Heading exponent:====
{{table232|The exponent for input for Heading spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Heading scale:====
{{table232|The multiplier for input for Heading spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}

===$Skybox internal depth consistency:===
{{table250|If enabled, this will allow skyboxes that use submodels to render the submodels with proper Z-sorting if the 'No Z-Buffer' check box is set to on in FRED. In other words, parts of the skybox closer to the origin point will render in front of sections further away, as might be expected. This flag is enabled by default for FSO version 25.0 onwards
*Syntax: '''''Boolean'''''
*Default Value: '''''YES'''''}}

==#OTHER SETTINGS==
This group contains miscellaneous settings.

===$Fixed Turret Collisions:===
Makes all hits to a turret's barrels count as hits to the turret subsystem. By default, this does not happen unless the point of impact falls inside the model radius of the turret's base.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Fixed Missile Detonation:===
{{Table220|
*When this flag is set, missiles which reach the center of a submodel will not detonate immediately; they will delay detonation until they have traveled another radius of the submodel. This fixes missile impacts to submodels whose center lies outside the geometry of the submodel. In other words, without this flag, a missile might detonate in the middle of the "bowl" of a concave submodel; with this flag, the missile will travel to the other side of the submodel before it detonates.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Damage Impacted Subsystem First:===
If set, a hit to a physical subsystem will always deal damage to that subsystem first, even if another subsystem is closer to the point of impact. By default, the closest subsystem will always receive damage first.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Use 3d ship select:===
{{Table224|
*Whether or not to use 3D models for ship select instead of animations
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Default ship select effect:===
{{Table3615|
*This specifies which effect to use for ship select animations when no .ani can be found, or the 3d ship select effect is active. This will default to the FS2 effect.
*Syntax: '''''String'''''
*Possible options are "FS2", "FS1", and "off"}}

===$Use 3d ship icons:===
{{Table224|
*Whether or not to use 3D models for ships in ship/weapon select instead of icons
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Use 3d weapon select:===
{{Table224|
*Whether or not to use 3D models for weapon select instead of animations
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Default weapon select effect:===
{{Table3615|
*This specifies which effect to use for weapon select animations when no .ani can be found, or the 3d weapon select effect is active. This will default to the FS2 effect.
*Syntax: '''''String'''''
*Possible options are "FS2", "FS1", and "off"}}

===$Use 3d weapon icons:===
{{Table224|
*Whether or not to use 3D models for weapons in weapon select instead of icons
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Use 3d overhead ship:===
{{Table224|
*Whether or not to use 3D models for ship overhead view instead of a bitmap in weapon select
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Default overhead ship style:===
{{Table224|
*This specifies which style of overhead view to use if 3d overhead view is active
*Syntax: '''''String'''''
*Possible options are "ROTATE" or "TOPVIEW"}}

===$Always refresh selected weapon when viewing loadout:===
{{Table232|
*When set to true, this always refreshes the weapon shown in view box on the right side of the screen when opening the weapon loadout view. This ensures the viewed weapon is one that can actually be on the selected ship when first clicking on the weapon loadout screen.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Weapons inherit parent collision group:===
{{Table3615|
*When set to true, Weapons fired by a ship will inherit their parents' collision group setting.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Flight controls follow eyepoint orientation:===
{{Table371|
*Specifies that if the player ship's eyepoint happens to rotate into a non-standard orientation, pitch and yaw axes should stay relative to the eyepoint orientation, not the ship. Note that this does not affect the pitch/yaw turning speed, which always remains relative to the ship.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Beams Use Damage Factors:===
{{Table371|
*Specifies that beam weapons will use the tabled damage factors for Armour, Shields and Subsystems. Default is false (i.e. all factors are treated as 1.0)
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Default fiction viewer UI:===
{{Table373|
*Specifies which fiction viewer layout to use in missions that don't specify one. Possible values are as follows:
**"FS2": Standard layout. Requires (2_)fictionviewer and (2_)fictionviewer-m to be present in data\interface.
**"WCS": Moves the "Accept" button to the lower-left corner of the screen. Requires (2_)fictionviewerb and (2_)fictionviewer-mb to be present in data\interface.
**"auto": Selects "WCS" if the appropriate files are present; otherwise, selects "FS2". This is the default setting.}}

===$Movie subtitle font:===
{{Table382|
*Specifies which font should be used for displaying subtitles in the cutscene player. This should be the name given to this font in the fonts table. Since movie subtitles can contain Unicode text it is a good idea to enable Unicode mode when movie subtitles are used but this is not enforced by this option.
*Syntax: '''''String'''''}}

===$Disable built-in translations:===
{{Table382|
*Turns off hard-coded translations, e.g. Transport -> Transporter in German. All strings will either use their XSTR entry or else not be translated.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Weapon shockwave damage respects huge ship flags:===
{{Table382|
*Controls whether weapon shockwaves will respect the huge/supercap ship flags. In retail they do not.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Enable external default scripts:===
{{Table382|
*Enables the loading of external scripts with the same name as a built-in script. Otherwise, uses the version of the script included in the executable (currently, just cfile_require.lua).
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Player warpout speed:===
{{Table190|
*Defines the speed the player must reach to warp out.
*Syntax: '''''Float'''''
*Default Value: '''''40.0'''''}}

===$Target warpout match percent:===
{{Table190|
*Defines how close to the warpout speed the player needs to be to actually warp out.
*Syntax: '''''Float''''', between 0.0 and 1.0
*Default Value: '''''0.05''''' (5%)}}

===$Minimum player warpout time:===
{{Table190|
*The [[Ships.tbl#.24Warpout_Engage_Time:|default amount of time]], in seconds, warping out will take before actually starting to check whether the player is the right speed.
*Syntax: '''''Float'''''
*Default Value: '''''3.0'''''}}

===$Enable in-game options:===
{{Table190|
*Mode whereby various settings can be modified by FSO while it's still running, rather than being set by the launcher before execution. By default is now ON, and can be accessed by going to the Options menu and pressing F3.
*Syntax: '''''Boolean'''''
*Default Value: '''''YES'''''}}

===$Dinky Shockwave Default Multiplier:===
{{Table190|
*Amount of damage, as a multiple of normal shockwave damage, assigned to a weapon's [[Weapons.tbl#.24Dinky shockwave:|dinky shockwave]] by default. To get the same behavior FSO had from 2005-2019, set this to 0.25.
*Syntax: '''''Float'''''
*Default Value: '''''1.0'''''}}

===$Shockwaves Always Damage Bombs:===
{{Table202|
*Enables all bombs being damaged by shockwaves. Previously only those marked with flags could be damaged.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Shockwaves Damage All Object Types Once:===
{{Table202|
*Keeps any object from being damaged more than once by a shockwave. The default behavior is for asteroids and flagged missiles to be damaged every frame by the shockwave.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Shockwaves Inherit Parent Weapon Damage Type:===
{{Table224|
*When enabled, the shockwaves of weapons that have a defined damage type automatically inherit that damage type, rather than dealing "typeless" damage. As this behavior is more intuitive than when this flag is disabled, mods targeting 22.4 or newer versions of FSO will have it enabled by default.
*Syntax: '''''Boolean'''''
*Default Value: '''''True''''' for mods targeting 22.4 or newer versions of FSO, otherwise '''''False'''''}}

===$Inherited Shockwave Damage Type Added Suffix:===
{{Table224|
*When combined with "$Shockwaves Inherit Parent Weapon Damage Type:", this string is added to the inherited damage type to define the shockwave's damage type. For example, if a weapon has the damage type "heavy" and the provided suffix is "-shock", then that weapon's shockwave's damage type would default to "heavy-shock".
*Note: When defined, this also implicitly sets the equivalent value for dinky shockwaves, below.
*Syntax: '''''String'''''}}

===$Inherited Dinky Shockwave Damage Type Added Suffix:===
{{Table224|
*The same as "$Inherited Shockwave Damage Type Added Suffix:", except specifically for "dinky" shockwaves.
*Syntax: '''''String'''''}}

===$Default Shockwave Damage Type:===
{{Table224|
*If a weapon's shockwave doesn't have a damage type set, it will have this damage type instead (when "$Shockwaves Inherit Parent Weapon Damage Type:" is enabled, this will only be used if the weapon itself also doesn't have a damage type set).
*Note: When defined, this also implicitly sets the equivalent value for dinky shockwaves, below.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Default Dinky Shockwave Damage Type:===
{{Table224|
*The same as "$Default Shockwave Damage Type:", except specifically for "dinky" shockwaves.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Use Engine Wash Intensity:===
{{Table190|
*Allows the game to use the [[ships.tbl#.24Intensity::|Intensity]] value when calculating Engine Wash effects.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Apply HUD shudder to chase view:===
{{Table232|
*Applies hud shudder (afterburner and engine wash) also to chase view. Does not override the command line toggle.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Swarmers Lead Targets:===
{{Table202|
*Causes swarm missiles to lead their targets by default, and will make use of [[Weapons.tbl#.2BTarget_Lead_Scaler:|Target Lead Scaler]] if specified, like normal aspect seekers.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Damage Threshold for Weapons Subsystems to Trigger Turret Inaccuracy:===
{{Table202|
*Specifies the damage threshold for when turrets become less accurate due to weapon subsystem damage. In other words, how damaged do a ship's aggregated weapons systems have to be before the turrets become inaccurate? Value must be between 0.0-1.0 (includes 0.0 and 1.0).
*Syntax: '''''Float'''''
*Default Value: '''''0.7'''''}}

===$AI use framerate independent turning:===
{{Table202|
*Without this flag, missiles turn rate is directly dependent on the current framerate. When enabled their turn rate will be consistent, with the "true" turning taken to be observed turning at 60fps. This flag also affects ships, but the instability is only apparent at extremely low framerates, and so the change will not be apparent.
*Syntax: '''''Boolean'''''
*Default Value: '''''True'''''}}

====+AI respect tabled turn time and rotdamp:====
{{Table202|
*Due to complicated physics issues caused by retail not using the above method, tabled turn times on ships and missiles are not representative of actual observed turn times. The above flag makes it consistent, but this flag will make it accurate to what is actually listed in the table.
*Additionally, rotdamp is now used properly by the AI in a similar manner to players. More rotdamp will result in slower rotational acceleration, and less results in faster acceleration.
*NOTE: BEWARE OF ADDING THIS FLAG TO AN EXISTING MODPACK. NEARLY EVERY SINGLE TURN TIME WILL NEED TO BE CHANGED.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Player starts in third person/chase view by default:===
{{Table212|
*When this flag is set, a player will start the mission in the chase view, not in the cockpit view.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Custom briefing icons always override standard icons:===
{{Table214|
*Custom ship briefing icons will always be shown when the briefing icon is a ship, but not when it is a non-ship icon such as a planet. Set this flag to use custom briefing icons in all cases.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Lead indicator behavior:===
{{Table224|
Changes how Lead Indicators behave when multiple weapon banks are linked and in range.
When set to default, if you have linked weapons, only the indicator for the one with the farthest range will be drawn.
When set to multiple, a lead indicator is drawn for all primary weapons in range when you have them linked.
When set to average, a single lead indicator is drawn in the average of the position where each of them would usually be drawn.
*Syntax: '''''String'''''
** Valid options are '''''default''''', '''''multiple''''' and '''''average'''''
*Default Value: '''''default'''''
}}

===$Use distant firepoint for all turrets:===
{{Table224|
*Causes the game to use firepoint-based target leading calculations for all turrets. This is useful if all or most turrets in a given mod has firepoints that are distant from their center-point.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Enable discord rich presence:===
{{Table224|
*Enables or disables the built-in Discord game-status reporting.
*Syntax: '''''Boolean'''''
*Default Value: '''''True'''''}}

===$Always hide hidden ships in hotkey list:===
{{Table224|
*Whether or not to always hide ships with HIDDEN hotkey (set in FRED), even in the in-mission hotkey menu.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Allow automatically assigning personas:===
{{Table232|
*Whether or not the game will automatically assign personas to ships that have no persona set.
*Syntax: '''''Boolean'''''
*Default Value: '''''True'''''}}

===$Countermeasures use capacity:===
{{Table232|
*Whether or not Countermeasures use tabled capacity.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Calculate subsystem hitpoints after parsing:===
{{Table234|
*Causes subsystem hitpoints to be calculated after all ships.tbl and -shp.tbm files have been parsed. This allows subsystem percentages to correctly reflect the final hull value rather than the first hull value encountered.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Fix scripted velocity:===
{{Table242|
*If this setting is enabled, object velocity set via script will wholly determine the change in position for that frame, ignoring ''all'' other in-engine concerns. Otherwise, the game engine will likely overwrite/ignore any changes, depending on when the changes were made in the frame.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Preload briefing icon models:===
{{Table250|
*If set, this forces preloading of models used for briefing icons. This only loads models used for icons that haven't already been loaded for the mission. This is useful for SCPUI's where hovering over an icon shows the model without having to click on it and the stutter when it loads models not used in mission.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Behavior for pressing Escape key in options menu:===
{{Table250|
*If set to 'save', the escape key for the HUD and Options screen saves options when leaving those screens (ie it does the same thing as pressing Ctrl-Enter/Accept). By default (or if set to 'default') the Escape key will not save any changed values when exiting those screens.
*Syntax: '''''String'''''
*Default Value: '''''default'''''}}

===$Disable intro cutscene:===
{{Table250|
*If set, this disables loading of any cutscenes as the game starts that might play before the player reaches the pilot select screen.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Show locked status for scramble missions:===
{{Table250|
*If set, scramble mission will show a text line right below the words 'Weapons Loadout' that states "Ships/Weapons Locked" (XSTR 749), thus the player can easily see their loadouts are locked and they do not have to check the loaoout buttons on every mission.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Disable expensive turret target check:===
{{Table250|
*If set, this value speeds up turret target checking. By default, turret target acquisition was spending a lot of time doing a raycast, the result of which was barely used at all. If we don't need the target normal, all it does is get a target point slightly more accurate, but in practice it really isn't noticeable at all whether the target point of the turret is actually on the surface of the ship, or maybe on the other side of the ship.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Threshold below which shield skips damage:===
{{Table250|
*By default, FSO logic dictates that shields collisions and any related sound or visuals related to shields are skipped if the shields are under 10%. This value allows modders to customize the value, though the value must be between 0.0 and 1.0.
*Syntax: '''''Float'''''
*Default Value: '''''0.1'''''}}

==#END==
Required. The last line of the table must be #END

==Sample Entry==

#CAMPAIGN SETTINGS
$Default Campaign File Name: NewCampaignFile

#Ignored Campaign File Names
$Campaign File Name: FreeSpace2.fc2

#HUD SETTINGS
$Directive Wait Time: 5000

#SEXP SETTINGS
$Loop SEXPs Then Arguments: True

#OTHER SETTINGS
$Fix Turret Collisions: True

#END

[[Category:Tables]]

Game settings.tbl

2025-08-28T16:20:41Z

-Joshua-: /* $Skybox internal depth consistency: */

{{SCP_table}}
{{TableVersionGit|2025-02-10|642111676012bc6696f4024c40296a6c20b3b958}}
{{Tables}}
The '''game_settings.tbl''', also known as mod.tbl, defines options that can be changed globally. All settings are optional.

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

If the version targeted in [[game_settings.tbl#$Target_Version:|target version]] is equal to or later than these listed, the following options are enabled by default:
{{Table220|
*[[game_settings.tbl#$Fixed_Turret_Collisions:|Fixed Turret Collisions]]
*[[game_settings.tbl#$Fixed_Missile_Detonation:|Fixed Missile Detonation]]
*[[game_settings.tbl#$Shockwaves_Damage_All_Object_Types_Once:|Shockwaves Damage All Object Types Once]]
*[[game_settings.tbl#$AI_use_framerate_independent_turning:|AI use framerate independent turning]]
*[[game_settings.tbl#$Use_host_orientation_for_set-camera-facing:|Use host orientation for set-camera-facing]]
}}
{{Table230|
*[[game_settings.tbl#$Shockwaves_Inherit_Parent_Weapon_Damage_Type:|Shockwaves Inherit Parent Weapon Damage Type]]
*[[game_settings.tbl#$Fixed_Chaining_To_Repeating_Events:|Fixed Chaining To Repeating Events]]
}}
{{Table240|
*[[game_settings.tbl#$Calculate_subsystem_hitpoints_after_parsing:|Calculate subsystem hitpoints after parsing]]}}

==#GAME SETTINGS==
Contains settings that affect how the engine works.

===$Target Version:===
{{Table373|
Specifies the minimum version of FreeSpace Open that this mod supports. If the version specified here is greater than the version of the current build, an error message is displayed.
}}
{{Table381|
The $Minimum version option has been renamed to $Target Version. The old name is kept with the same functionality for backwards-compatibility.

The target version specifies what version of the FSO engine this mod was created for. It will be used by the engine to enable or disable backwards-incompatible changes by default. The default value is 2.0 which specifies that the mod targets the retail engine version.
}}

====+Major:====
{{Table373|
Required. Sets the major component of the target version.
*Syntax: '''''Integer'''''
*Example: '''''3''''' (for a minimum version of 3.7.3.20151121)
}}

====+Minor:====
{{Table373|
Required. Sets the minor component of the target version.
*Syntax: '''''Integer'''''
*Example: '''''7''''' (for a minimum version of 3.7.3.20151121)
}}

====+Build:====
{{Table373|
Required. Sets the build component of the target version.
*Syntax: '''''Integer'''''
*Example: '''''3''''' (for a minimum version of 3.7.3.20151121)
}}

====+Revision:====
{{Table373|
Sets the revision component of the target version. If no revision is given then all builds of that release are supported (even nightly builds if there are any).
For nightly builds this is the date in YYYYMMDD format.
*Syntax: '''''Integer'''''
*Example: '''''20151121''''' (for a minimum version of 3.7.3.20151121)
}}

===$Window title:===
{{Table382|
Specifies the name of the FSO window when this mod is running. If blank or unspecified, the window will have the default title of "FreeSpace 2".
*Syntax: '''''String'''''
}}

===$Window icon:===
{{Table382|
Specifies the icon filename of the FSO window when this mod is running. If blank or unspecified, the window will have the default icon.
*Syntax: '''''String'''''
}}

===$Mod title:===
{{Table224|
Specifies the title of the mod and will be displayed at the mainhall near the FSO version.
*Syntax: '''''String'''''
}}
{{Table250|
It is now possible to display the mod title on its own. Previously, the mod version was also required.
}}

===$Mod version:===
{{Table224|
Specifies the version of the mod and will be displayed at the mainhall near the FSO version. Can be a string or it can be semantic versioning such as 2.0.0.
*Syntax: '''''String'''''
}}
{{Table250|
It is now possible to display the mod version on its own. Previously, the mod title was also required.
}}

===$Unicode mode:===
{{Table382|
Enabled the Unicode text mode for this mod. In Unicode mode all text is assumed to be UTF-8 encoded Unicode and certain features are disabled if they do not have full Unicode support. Most notably, if this is enabled then the engine will no longer support the old bitmap fonts that were used by Retail FreeSpace. Only the newer TrueType fonts will be supported.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Splash screens:===
{{Table232|
Defines a list of splash screens that FSO can display upon game startup. The actual image displayed is chosen at random from the applicable entries. Entries with exact aspect ratio matches will be prioritized first, followed by aspect ratio ranged matches, followed by entries without an aspect ratio specified.}}

====+Bitmap:====
{{table232|
The name of the bitmap to use as a splash screen. Extension will be removed if included.
*Syntax: '''''+Bitmap: String'''''}}

====+Aspect Ratio:====
{{table234|
Only consider this bitmap to be an applicable entry if the user's screen aspect ratio matches the specified number within +/- 0.01.
*Syntax: '''''+Aspect Ratio: Float'''''}}

====+Aspect Ratio Min:====
{{table234|
Only consider this bitmap to be an applicable entry if the user's screen aspect ratio is at least the specified number.
*Syntax: '''''+Aspect Ratio Min: Float'''''}}

====+Aspect Ratio Max:====
{{table234|
Only consider this bitmap to be an applicable entry if the user's screen aspect ratio is at most the specified number.
*Syntax: '''''+Aspect Ratio Max: Float'''''}}

===$Splash fade in time:===
{{Table232|
Sets the time in milliseconds it takes for a splash screen to fade in.
*Syntax: '''''Integer'''''
*Default Value: '''''0'''''}}

===$Splash fade out time:===
{{Table232|
Sets the time in milliseconds it takes for a splash screen to fade out.
*Syntax: '''''Integer'''''
*Default Value: '''''0'''''}}

===$Center splash logo:===
{{Table232|
Sets whether the splash logo will be displayed in the middle of the screen. If this is false (the default), it will be displayed at the top-left.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Disable FSO Internal Loadout Restoration System:===
{{Table234|
When the player configures the ships and weapons of the wings in the loadout screen, FSO will remember these settings and attempt to apply them again if the player quits the mission and comes back to it later. FSO will only remember the most recent mission's loadout, so it will not attempt to restore the loadout if the player loads a different mission. It will also not attempt this if the mission's ''$Modified:'' date has changed. This flag can be used to prevent FSO from attempting restoration even if it normally would.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

==#LOCALIZATION SETTINGS==
Contains various settings related to localization and language support.

===$Use tabled strings for the default language:===
{{Table202|
Causes the game to use the text in strings.tbl and tstrings.tbl even when the current language is English. By default, the game will use the literal text in the source code and the data files (tables and missions) and will not look up the entry when the language is English. For other languages, the translation is always used, if it exists, regardless of this setting.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$Don't pre-empt training message voice:===
{{Table214|
Prevents training messages from being interrupted by other training messages. If a training message has a voice file associated with it, or simulated speech is active, the next message will not be played until the current message has finished.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

==#CAMPAIGN SETTINGS==
This group contains various Campaign related settings and overrides.

===$Default Campaign File Name:===
Defines which campaign will be selected by default for new pilots. A file extension is not needed and, if present, is removed by the code.
*Syntax: '''''String'''''

===#Ignored Campaign File Names===
Defines which campaigns, if present, will not appear in the Campaign Room. In the original implementation, only single-player campaigns could be ignored and file extensions were required, but see below.
{{Table371|As of 3.7.1, file extensions are not required and, if present, are removed by the code.}}
{{Table382|As of 3.8.2, file name comparisons are not case sensitive and multiplayer campaigns can be ignored.}}
====$Campaign File Name:====
File name of the campaign to ignore. Multiple entries may exist.
*Syntax: '''''String'''''

===#Ignored Mission File Names===
{{Table382|Defines which standalone missions, if present, will not appear in the Tech Room or Multiplayer Lobby. Both single-player and multiplayer missions can be ignored, but missions which appear in a campaign cannot. File extensions are not required and, if present, are removed by the code. File name comparisons are not case sensitive.
====$Mission File Name:====
File name of the mission to ignore. Multiple entries may exist.
*Syntax: '''''String'''''
}}

===$Red-alert applies to delayed ships:===
{{Table372|Controls whether red-alert saved statistics (hitpoints, weapons, subsystem strengths) will be restored for ships that are not present at mission start.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

==#HUD SETTINGS==
This group contains various HUD behavior settings and overrides

===$Directive Wait Time:===
*Defines how long the game will wait before displaying a directive.
*Syntax: '''''Integer'''''
*Values: '''''Greater than or equal to 0 ms'''''

===$Cutscene camera displays HUD:===
Show the HUD when the cutscene camera is enabled.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Cutscene camera disables HUD: and had a default of YES.

===$Full color head animations:===
Enables full-color head ANIs. Normal head ANIs will appear in gray.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Color head animations with hud colors: and had a default of YES.

===$Don't automatically select a turret when targeting a ship:===
{{Table220|Uses FS1 behavior where targeting a new ship did not target any turrets. In FS2 a turret is automatically targeted.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Supernova hits at zero:===
{{Table222|
Adjusts the HUD timer so that the timer reaches zero when the supernova hits the player. The actual timing is not affected -- whether the flag is enabled or not, the supernova will always hit the player when 5 seconds remain in the time specified in the sexp.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$Always warn player about unbound keys used in Directives Gauge:===
{{Table222|
Ensures that the "Key Unbound" message will pop up for a directive with an unbound key in any single-player mission, not just a training mission. Note, that the default string (index 426) will still say "Warning\nYou have no control bound to the action \"%s\". You must do so before you can continue with training." Thus, it is advised to change the string at index 426 using the -lcl.tbm to "Warning\nYou have no control bound to the action \"%s\". You must do so before you can continue with this mission."
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$HUD drop shadows enabled by default:===
{{Table232|
If this flag is active, certain elements displayed on the HUD (all text, the main targeting reticle, and the background of the ETS gauges) will have a "drop shadow" effect. Note that whether or not the flag is active, the player can set this using the "Toggle HUD Drop Shadows" control.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$Unify scanning behavior:===
{{Table242|
*Unifies scanning behavior between subsystem, regular, and cargo allowing missions to use all scan types in all situations.
*Also allows changing the "Cargo:" text line in a mission by adding "$Cargo Title: STRING" after the "$Cargo 1:" or "$Cargo 2:" lines in the mission file. FRED UI support not yet added for $Cargo Title so you have to do it manually.
*When this flag is enabled, all ships, no matter the ship class, will react the same way to the cargo-related or scanning-related ship flags:
**They are not scannable by default
**Setting the "scannable" flag makes them scannable, and scanning the subsystem will reveal the cargo
**A new flag available with alter-ship-flag, "no-scanned-cargo", changes the behavior to scanned/unscanned instead of revealing the cargo
**The "toggle-subsystem-scanning" flag must be set to swap full-ship scanning mode into subsystem scanning mode and works for all ship types
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

===$Don't show callsigns in the escort list:===
{{Table242|
By default, callsigns are shown in the escort list using the same format as in the target box. If this flag is active, callsigns will not be displayed.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''
}}

==#SEXP SETTINGS==
This group contains SEXP settings and overrides.

===$Loop SEXPs Then Arguments:===
Flips how when-argument settings loop. See: [http://www.hard-light.net/forums/index.php?topic=79602.0 SEXP Argument changes via mod.tbl]
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Use Alternate Chaining Behavior:===
When set, this allows all events in a chain to repeat, instead of only the last one. It makes the event chaining behavior act as people expected it to be in [http://scp.indiegames.us/mantis/view.php?id=82 Mantis #82].
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Fixed Chaining To Repeating Events:===
{{Table230|When set, this makes event chaining to repeated events work as designed - that is, the chained event will only be evaluated after the chain delay. If the repeating event's interval is shorter than the chain delay, then the delay countdown will continually be restarted until all repetitions have completed. Without this flag, FSO will emulate retail behavior which, due to a bug, allowed chained events to be evaluated immediately after a repeating event is first evaluated.

NOTE: Although the name does not reflect it, the same issue affects repeating events that are evaluated by <tt>is-event-true-delay</tt> and <tt>is-event-false-delay</tt>. Without this flag, FSO will emulate retail behavior which causes these SEXP operators to ignore any delay when evaluating repeated events. With this flag, the delay will be measured from when the final repeat iteration occurs.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Use host orientation for set-camera-facing:===
{{Table220|When set, this will take into account the host orientation for cutscene cameras. This is a bugfix for [https://github.com/scp-fs2open/fs2open.github.com/issues/3889 GitHub issue #3889].
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Show-subtitle uses pixels:===
{{Table222|When set, SEXPs which display subtitles will read their arguments as pixels, not percentages. If <code>$Show-subtitle base resolution:</code> is set, these pixels will be scaled up or down as needed.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Show-subtitle base resolution:===
{{Table222|When set, subtitles are assumed to display at the appropriate size in the specified resolution, and will be scaled up or down if the current screen resolution is different. If this is not set, or is set to a resolution less than (640, 480), subtitles will not be scaled.
*Syntax: '''''(Integer, Integer)'''''
*Default Value: '''''(-1, -1)'''''}}

===$HUD-set-coords base resolution:===
{{Table232|The hud-set-coords SEXP has always used exact pixels, without regard for the current screen resolution. This setting enables a similar scaling mechanism as ''$Show-subtitle base resolution:''.
*Syntax: '''''(Integer, Integer)'''''
*Default Value: '''''(-1, -1)'''''}}

===$$Always Show Directive Value Count:===
{{Table250|
*If this setting is enabled, Directive-as-Value values in Directives will always show the number. By default this is disabled, and only values > 1 are shown.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

==#GRAPHICS SETTINGS==
This group contains settings related to graphics.

===$Enable External Shaders:===
Enables the use of external shader files. By default, the engine will use the built-in shaders.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Default Detail Level:===
{{Table3615|
Determines which graphics detail level preset (low, medium, high, very high) acts as the default for new pilots.
*Syntax: '''''Integer''''' (0-3)
*Default Value: '''''3''''' (very high)}}

===$Briefing Window FOV:===
{{Table371|
Determines the FOV in the briefing Icon window. Retail default for this is 0.29375; some previous versions of FSO used a value of 0.5.
*Syntax: '''''Float''''' (0.0 to 1.0)
*Default Value: '''''0.29375'''''}}

===$Generic Pain Flash Factor:===
{{Table373|
Determines the intensity of the pain red flash when the player is hit.
*Syntax: '''''Float'''''
*Default Value: '''''1.0'''''}}

===$Shield Pain Flash Factor:===
{{Table373|
Determines the intensity of a pain flash when the player's shields are hit. Color will match the current ships shield color defined in ships.tbl. A value of 0 will give retail behavior (no shield effect). Positive values will cause the effect to start at full intensity at full shields and go to next to no intensity at zero shields. Negative values will cause no effect at full shields and full effect at no shields. Values should be kept between -1.0 and 1.0 for good pilot visibility.
*Syntax: '''''Float'''''
*Default Value: '''''0.0'''''}}

===$EMP Pain Flash Factor:===
{{Table224|
Determines the intensity of the flash when the player is hit by an EMP blast or weapon.
*Syntax: '''''Float'''''
*Default Value: '''''1.0'''''}}

===$EMP Pain Flash Color:===
{{Table224|
Determines the RGB color value of the flash when the player is hit by an EMP blast or weapon.
*Syntax: Color, (red, green, blue) respectively, integer value from 0 to 255
*Default Value: '''''(255, 255, 127)'''''}}

===$BMPMAN Slot Limit:===
{{Table382|
Determines the maximum number of textures that can be loaded simultaneously. This includes every frame of an animation, unless that animation is streaming (e.g. command briefing animations, message talking heads, etc). Also includes dynamically-created textures (used internally for various functions).
*Syntax: '''''Int'''''
*Values: '''''Greater than or equal to 3500'''''
*Default Value: '''''4750'''''}}

===$EMP Arc Color:===
{{Table382|
Allows custom RGB color values to be set for the EMP lightning arc effect.
*'''+Primary Color Option 1:'''
**The RGB color of the first primary color for the EMP lightning arc effect.
**The actual lightning arc color shown in-game is randomly selected between the first and second primary color.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (64, 64, 5)
*'''+Primary Color Option 2:'''
**The RGB color of the second primary color for the EMP lightning arc effect.
**The actual lightning arc color shown in-game is randomly selected between the first and second primary color.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (128, 128, 10)
*'''+Secondary Color Option 1:'''
**The RGB color of the secondary color for the EMP lightning arc effect.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (255, 255, 10)
}}

===$EMP Arc Width:===
{{Table224|
Allows setting how the width is calculated for the EMP lightning arc effect.
*'''+Width Default:'''
**The default width of the arc. This value will be multiplied by `+Width Radius Multiplier:` if the radius of the ship is less than or equal to `+Do Not Use Width Multiplier Over Radius:`.
**Syntax: '''''Float'''''
**Default value: 0.9
*'''+Width Radius Multiplier:'''
**The value that the width is multiplied by if the radius of the ship is less than or equal to `+Do Not Use Width Multiplier Over Radius:`.
**Syntax: '''''Float'''''
**Default value: 0.01
*'''+Do Not Use Width Multiplier Over Radius:'''
**If the object is larger than this radius, the `+Width Default:` value is used.
**Syntax: '''''Float'''''
**Default value: 500
*'''+Width Radius Minimum:'''
**Minimum width that the arc can be. Any calculated widths lower than this value will be set to this value.
**Syntax: '''''Float'''''
**Default value: 0.2
}}

===$Damage Arc Color:===
{{Table382|
Allows custom RGB color values to be set for the damage lightning arc effect.
*'''+Primary Color Option 1:'''
**The RGB color of the first primary color for the damage lightning arc effect.
**The actual lightning arc color shown in-game is randomly selected between the first and second primary color.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (64, 64, 255)
*'''+Primary Color Option 2:'''
**The RGB color of the second primary color for the damage lightning arc effect.
**The actual lightning arc color shown in-game is randomly selected between the first and second primary color.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (128, 128, 255)
*'''+Secondary Color Option 1:'''
**The RGB color of the secondary color for the damage lightning arc effect.
**Syntax: '''''Color''''', (red, green, blue) respectively, integer value from 0 to 255
**Default value: (64, 64, 5)
}}

===$Damage Arc Width:===
{{Table224|
Allows setting how the width is calculated for the EMP lightning arc effect.
*'''+Width Default:'''
**The default width of the arc. This value will be multiplied by `+Width Radius Multiplier:` if the radius of the ship is less than or equal to `+Do Not Use Width Multiplier Over Radius:`.
**Syntax: '''''Float'''''
**Default value: 0.9
*'''+Width Radius Multiplier:'''
**The value that the width is multiplied by if the radius of the ship is less than or equal to `+Do Not Use Width Multiplier Over Radius:`.
**Syntax: '''''Float'''''
**Default value: 0.01
*'''+Do Not Use Width Multiplier Over Radius:'''
**If the object is larger than this radius, the `+Width Default:` value is used.
**Syntax: '''''Float'''''
**Default value: 500
*'''+Width Radius Minimum:'''
**Minimum width that the arc can be. Any calculated widths lower than this value will be set to this value.
**Syntax: '''''Float'''''
**Default value: 0.2
}}

===$Requires Rendering Feature:===
{{Table210|Needs description}}

===$Render player muzzle flashes in cockpit:===
{{Table212|
Determines whether muzzle flashes will be shown within the cockpit view.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Glowpoint nebula visibility factor:===
{{Table220|
*Specifies the degree to which glowpoints are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.2}}

===$Shield nebula visibility factor:===
{{Table220|
*Specifies the degree to which shield effects are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.2}}

===$Thruster nebula visibility factor:===
{{Table220|
*Specifies the degree to which thruster flares are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.5}}

===$Beams affected by nebula visibility:===
{{Table212|
Determines whether beam weapons will be faded by nebula fog.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

====+Constant visibility factor:====
{{Table220|
*Specifies the degree to which beam effects are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 4.0}}

====+Scaled visibility factor:====
{{Table220|
*Specifies the degree to which the ''size'' of a beam effect affects its visibility. This is multiplied by the radius of the beam and added to the above for the final value. This results in larger beams being visible from farther away.
*Syntax: '''''Float'''''
*Default Value: 0.1}}

===$Weapons affected by nebula visibility:===
{{Table212|
Determines whether lasers, missiles, countermeasures, etc will be faded by nebula fog.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

====+Weapon visibility factor:====
{{Table220|
*Specifies the degree to which laser-type weapons are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.3}}

====+$Trail visibility factor:====
{{Table220|
*Specifies the degree to which trails (weapon and ship contrails) are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.0}}

====+Shockwave visibility factor:====
{{Table220|
*Specifies the degree to which shockwave effects are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 2.5}}

===$Particles affected by nebula visibility:===
{{Table212|
Determines whether particle effects, including impact effects, will be faded by nebula fog.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

====+Constant visibility factor:====
{{Table220|
*Specifies the degree to which particle effects are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.0}}

====+Scaled visibility factor:====
{{Table220|
*Specifies the degree to which the ''size'' of a particle effect affects its visibility. This is multiplied by the radius of the particle and added to the above for the final value. This results in larger particles being visible from farther away.
*Syntax: '''''Float'''''
*Default Value: 0.08}}

===$Fireballs affected by nebula visibility:===
{{Table212|
Determines whether fireballs from ship explosions will be faded by nebula fog.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

====+Constant visibility factor:====
{{Table220|
*Specifies the degree to which fireballs are affected by nebula fog. 1.0 is exactly the same as regular ship hull obscurity, higher means they stay visible for longer.
*Syntax: '''''Float'''''
*Default Value: 1.2}}

====+Scaled visibility factor:====
{{Table220|
*Specifies the degree to which the ''size'' of a fireball affects its visibility. This is multiplied by the radius of the fireball and added to the above for the final value. This results in larger fireballs being visible from farther away.
*Syntax: '''''Float'''''
*Default Value: 0.08}}

===$Shadow Quality Default:===
{{Table220|
Sets the default level for shadow quality if the 'enable_shadows' command line is used and 'shadow_quality' is not used. By default, the FSO will set the shadow detail level to 2. Valid values are 0 (shadows disabled), 1 (Low, 512x512 shadow map), 2 (Medium, 1024x1024 shadow map), 3 (High, 2048x2048 shadow map), or 4 (Ultra, 4096x4096). Note, the command line 'shadow_quality' will override any value set here.
*Syntax: '''''Integer'''''
*Default Value: '''''2'''''}}

===$Shadow Cascade Distances:===
{{Table214|
Sets the distances that the shadow map for the game scene uses. Float values must all be greater than 0 and successively larger than each consecutive value.
*Syntax: '''''List of floats'''''
*Default Value: '''''(200.0, 600.0, 2500.0, 8000.0)'''''}}

===$Shadow Cascade Distances Cockpit:===
{{Table214|
Sets the distances that the shadow map for the cockpit pass scene uses. Will only shadow the cockpit model, and does not interact with the external game scene shadow map. Float values must all be greater than 0 and successively larger than each consecutive value.
*Syntax: '''''List of floats'''''
*Default Value: '''''(0.25, 0.75, 1.5, 3.0)'''''}}

===$Shadow Disable Techroom:===
{{Table224|
Disables shadows on ships in the techroom.
*Syntax: '''''Boolean'''''
}}

===$Shadow Disable Cockpit:===
{{Table224|
Disables shadows on the player cockpit in mission.
*Syntax: '''''Boolean'''''
}}

===$Shadow Disable Mission Brief Weapons:===
{{Table224|
Disables shadows on weapons in the mission briefing.
*Syntax: '''''Boolean'''''
}}

===$Shadow Disable Mission Brief Ships:===
{{Table224|
Disables shadows on ships in the mission briefing.
*Syntax: '''''Boolean'''''
}}

===$Show Ship Casts Shadow:===
{{Table224|
When cockpit shadows are enabled, enabling this setting will cause the players ship model shown with "show ship" to cast shadow onto the cockpit.
*Syntax: '''''Boolean'''''
}}

===$Ship Model And Cockpit Share Coordinate Space:===
{{Table224|
When having the "show ship" flag enabled and cockpit models for a ship, this flag should be on if the cockpits can fit into the actual geometry of the ship model. Disable this flag if this is not the case and the cockpit needs to be rendered on top of the ship regardless of actual coordinates. If this can be enabled, the external show ship model can be rendered using deferred rendering.
*Syntax: '''''Boolean'''''
}}

===$Show Ship enabled only if Cockpits enabled:===
{{Table250|
Enabling this setting will only use the 'show-ship' flag if cockpits are enabled. Useful if your ship uses both 'show-ship' and cockpits that exist within the 'show-ship' space, and you want to allow players to toggle off cockpits. Note, 'show-ship' always only appears if in first-person view.
*Syntax: '''''Boolean'''''
}}

===$Minimum Pixel Size Thrusters:===
{{Table220|
*Specifies the smallest pixel size that thrusters will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Thrusters:===
{{Table220|
*Specifies the smallest pixel size that thrusters will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Beams:===
{{Table220|
*Specifies the smallest pixel size that beams will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Muzzle Flashes:===
{{Table220|
*Specifies the smallest pixel size that muzzle flashes will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Trails:===
{{Table220|
*Specifies the smallest pixel size that trails will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Minimum Pixel Size Lasers:===
{{Table220|
*Specifies the smallest pixel size that lasers will be rendered. Setting this > 0 can be expensive in larger missions.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$Do Not Render Lasers Below Length:===
{{Table250|
*Specifies the smallest length that lasers will be rendered.
*Syntax: '''''Float'''''
*Default Value: 0.0001}}

===$Do Not Render Lasers Below Radius:===
{{Table250|
*Specifies the smallest radius that lasers will be rendered.
*Syntax: '''''Float'''''
*Default Value: 0.0001}}

===$Thruster Easing Value:===
{{Table220|
*Smooths out the behavior of maneuvering thruster flares the higher above 0 it is.
*This is the exponential time constant for the visual flare length to reach it's true length.
*Syntax: '''''Float'''''
*Default Value: 0.0}}

===$SCPUI attempts to load hires animations:===
{{Table230|
*Prevents SCPUI from trying to load anims prefixed with "2_"
*Syntax: '''''Boolean'''''
*Default Value: true}}

{{Table230|
===$Max draw distance:===
===$Min draw distance:===
*These values do more than just cutoff the visuals at certain distances, and they must be adjusted carefully to ensure unintentional rendering artifacts are not introduced.
*The rendering engine has limited amount of 'depth resolution', the degree to which it can tell a certain polygon is closer or farther away than another. When two polygons are too close, they will Z-fight, picking arbitrarily which is closer. It is the span between the min and max draw distance that determines how well the engine can determine depth, if they are too far from one another, the Z-fighting will become more common as it has to spread its resolution over a wider range. If they are close, Z-fighting will be lessened at the cost of a smaller range of distance able to be rendered.
*Syntax: '''''Float''''', meters
*Default Values: 10,000,000,000 and 1, respectively
}}

{{Table232|
===$Randomize particle rotation:===
*Particle bitmaps are typically screen-aligned; the upper portion of the bitmap will always be mapped to the upper portion of the particle, from the point of view of the camera. Enabling this option makes ''all'' particles have a random 'tilt' in an arbitrary direction when created.
*Syntax: '''''Boolean'''''
*Default Value: false
}}

===$Disable shield effects:===
{{Table250|
*Specifies if FSO attempts to use the shield mesh impact effects. Enabling this flag will prevent the game from preforming any shield mesh effect code, which can be useful if a mod does not use those shield mesh effects.
*Syntax: '''''Boolean'''''
*Default Value: false}}

==#NETWORK SETTINGS==
This group contains network-related settings

===$FS2NetD port:===
*(description required)

===$Default object update level for multiplayer:===
{{Table220|
Sets the distances default object update rate for multiplayer matches. By default, the FSO will set the object update level to 2. Valid values are 0 (Low), 1 (Medium), 2 (High), 3 (LAN). FSO caps the bandwidth it uses based on these settings, but they were designed for connections from 1999. LAN has the least restrictive limits and does not require an actual LAN connection. Also, if a player's connection is within the dial-up speed range then game auto force the use of the lowest level during a match.
*Syntax: '''''Integer'''''
*Default Value: '''''2'''''}}

==#SOUND SETTINGS==
This group contains sound-related settings

===$Default Sound Volume:===
{{Table371|
*Defines the default sound fx volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0
*Default Value: '''''1.0'''''}}

===$Default Music Volume:===
{{Table371|
*Defines the default music volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0
*Default Value: '''''0.5'''''}}

===$Default Voice Volume:===
{{Table371|
*Defines the default voice volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0
*Default Value: '''''0.7'''''}}

===$Use weapon class impact sounds for hits to player:===
{{Table224|
Allows weapons that hit the player to play their specific impact sounds, not the hard-coded default sounds.
*Syntax: '''''Boolean'''''
}}

===$Play thruster sounds for the player:===
{{Table232|
If the player's ship has thruster sounds defined, this will ensure they are played like normal, since they are typically suppressed.
*Syntax: '''''Boolean'''''
}}

===$Unify minimum engine sound:===
{{Table250|
Allows $Minimum Engine Volume in ships.tbl to work for all ship classes. By default, that value only triggers for non-huge ships.
*Syntax: '''''Boolean'''''
}}

===$Disabled or disrupted engines are silent:===
{{Table250|
If set, engines will not play their engine noise if the ship is disabled or a disrupted (such as disruptions caused by an active EMP effect or a weapon with the "electronics" flag).
*Syntax: '''''Boolean'''''
}}

==#FRED SETTINGS==
This group contains settings for FRED.

===$Disable Hard Coded Message Head Ani Files:===
{{table371|
If set, FRED will not fill the head ani selection in the Event Editor with the retail head ani filenames.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Add Message Head Ani Files:===
{{table224|
FRED will append each +Head entry listed below to the head ani selection list in the Event Editor.}}

====+Head:====
{{table224|
The head ani filename to add. Extensions will be stripped if included.
NOTE: Pay attention to file names or anis with a,b, c variation not display in-game (unless called directly). Proper name seems to be Head-xxxNa, Head-xxxNb, with N being some number and XXX being whatever you want. Needs further testing and confirmation
*Syntax: '''''+Head: String'''''}}

===$Enable scripting in FRED:===
{{table382|
If set, scripting will be enabled in FRED. Use with extreme caution. The effects of scripts on FRED have not been fully tested. You can check if a script is running in FRED by using ba.inMissionEditor().
*Default Value: '''''NO'''''}}

===$FRED Briefing window resolution:===
{{table224|
The width and height of the briefing window in FRED. Defaults to 888x371. Note that changing this only affects FRED and can cause a mismatch to the ingame briefing view which defaults to 888x371 (or 555x232 for 640 base res).
*Syntax: '''''integer, integer'''''
*Default Value: '''''888,371'''''}}

===$Ignore Music Files In Music Player:===
{{table232|Music files in this section will not be added to FRED's built-in music player.}}
====+File:====
{{table232|Specifies a file
*Syntax: '''''string'''''}}

===$FRED spacemouse nonlinearities:===
{{table232|
Allows setting custom nonlinearities and scaling for controlling FRED with a spacemouse.
}}
====+Sideways exponent:====
{{table232|
The exponent for input for Sideways spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Sideways scale:====
{{table232|The multiplier for input for Sideways spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Forwards exponent:====
{{table232|The exponent for input for Forwards spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Forwards scale:====
{{table232|The multiplier for input for Forwards spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Upwards exponent:====
{{table232|The exponent for input for Upwards spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Upwards scale:====
{{table232|The multiplier for input for Upwards spacemouse motion.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Pitch exponent:====
{{table232|The exponent for input for Pitch spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Pitch scale:====
{{table232|The multiplier for input for Pitch spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Bank exponent:====
{{table232|The exponent for input for Bank spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Bank scale:====
{{table232|The multiplier for input for Bank spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Heading exponent:====
{{table232|The exponent for input for Heading spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}
====+Heading scale:====
{{table232|The multiplier for input for Heading spacemouse rotation.
*Syntax: '''''float'''''
*Default Value: '''''1'''''}}

===$Skybox internal depth consistency:===
{{table250|If enabled, this will allow skyboxes that use submodels to render the submodels with proper Z-sorting if the 'No Z-Buffer' check box is set to on in FRED. In other words, parts of the skybox closer to the origin point will render in front of sections further away, as might be expected. This flag is enabled by default for FSO version 25.0 onwards}}
*Syntax: '''''Boolean'''''
*Default Value: '''''YES'''''}}

==#OTHER SETTINGS==
This group contains miscellaneous settings.

===$Fixed Turret Collisions:===
Makes all hits to a turret's barrels count as hits to the turret subsystem. By default, this does not happen unless the point of impact falls inside the model radius of the turret's base.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Fixed Missile Detonation:===
{{Table220|
*When this flag is set, missiles which reach the center of a submodel will not detonate immediately; they will delay detonation until they have traveled another radius of the submodel. This fixes missile impacts to submodels whose center lies outside the geometry of the submodel. In other words, without this flag, a missile might detonate in the middle of the "bowl" of a concave submodel; with this flag, the missile will travel to the other side of the submodel before it detonates.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Damage Impacted Subsystem First:===
If set, a hit to a physical subsystem will always deal damage to that subsystem first, even if another subsystem is closer to the point of impact. By default, the closest subsystem will always receive damage first.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''

===$Use 3d ship select:===
{{Table224|
*Whether or not to use 3D models for ship select instead of animations
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Default ship select effect:===
{{Table3615|
*This specifies which effect to use for ship select animations when no .ani can be found, or the 3d ship select effect is active. This will default to the FS2 effect.
*Syntax: '''''String'''''
*Possible options are "FS2", "FS1", and "off"}}

===$Use 3d ship icons:===
{{Table224|
*Whether or not to use 3D models for ships in ship/weapon select instead of icons
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Use 3d weapon select:===
{{Table224|
*Whether or not to use 3D models for weapon select instead of animations
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Default weapon select effect:===
{{Table3615|
*This specifies which effect to use for weapon select animations when no .ani can be found, or the 3d weapon select effect is active. This will default to the FS2 effect.
*Syntax: '''''String'''''
*Possible options are "FS2", "FS1", and "off"}}

===$Use 3d weapon icons:===
{{Table224|
*Whether or not to use 3D models for weapons in weapon select instead of icons
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Use 3d overhead ship:===
{{Table224|
*Whether or not to use 3D models for ship overhead view instead of a bitmap in weapon select
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Default overhead ship style:===
{{Table224|
*This specifies which style of overhead view to use if 3d overhead view is active
*Syntax: '''''String'''''
*Possible options are "ROTATE" or "TOPVIEW"}}

===$Always refresh selected weapon when viewing loadout:===
{{Table232|
*When set to true, this always refreshes the weapon shown in view box on the right side of the screen when opening the weapon loadout view. This ensures the viewed weapon is one that can actually be on the selected ship when first clicking on the weapon loadout screen.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Weapons inherit parent collision group:===
{{Table3615|
*When set to true, Weapons fired by a ship will inherit their parents' collision group setting.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Flight controls follow eyepoint orientation:===
{{Table371|
*Specifies that if the player ship's eyepoint happens to rotate into a non-standard orientation, pitch and yaw axes should stay relative to the eyepoint orientation, not the ship. Note that this does not affect the pitch/yaw turning speed, which always remains relative to the ship.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Beams Use Damage Factors:===
{{Table371|
*Specifies that beam weapons will use the tabled damage factors for Armour, Shields and Subsystems. Default is false (i.e. all factors are treated as 1.0)
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Default fiction viewer UI:===
{{Table373|
*Specifies which fiction viewer layout to use in missions that don't specify one. Possible values are as follows:
**"FS2": Standard layout. Requires (2_)fictionviewer and (2_)fictionviewer-m to be present in data\interface.
**"WCS": Moves the "Accept" button to the lower-left corner of the screen. Requires (2_)fictionviewerb and (2_)fictionviewer-mb to be present in data\interface.
**"auto": Selects "WCS" if the appropriate files are present; otherwise, selects "FS2". This is the default setting.}}

===$Movie subtitle font:===
{{Table382|
*Specifies which font should be used for displaying subtitles in the cutscene player. This should be the name given to this font in the fonts table. Since movie subtitles can contain Unicode text it is a good idea to enable Unicode mode when movie subtitles are used but this is not enforced by this option.
*Syntax: '''''String'''''}}

===$Disable built-in translations:===
{{Table382|
*Turns off hard-coded translations, e.g. Transport -> Transporter in German. All strings will either use their XSTR entry or else not be translated.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Weapon shockwave damage respects huge ship flags:===
{{Table382|
*Controls whether weapon shockwaves will respect the huge/supercap ship flags. In retail they do not.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Enable external default scripts:===
{{Table382|
*Enables the loading of external scripts with the same name as a built-in script. Otherwise, uses the version of the script included in the executable (currently, just cfile_require.lua).
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Player warpout speed:===
{{Table190|
*Defines the speed the player must reach to warp out.
*Syntax: '''''Float'''''
*Default Value: '''''40.0'''''}}

===$Target warpout match percent:===
{{Table190|
*Defines how close to the warpout speed the player needs to be to actually warp out.
*Syntax: '''''Float''''', between 0.0 and 1.0
*Default Value: '''''0.05''''' (5%)}}

===$Minimum player warpout time:===
{{Table190|
*The [[Ships.tbl#.24Warpout_Engage_Time:|default amount of time]], in seconds, warping out will take before actually starting to check whether the player is the right speed.
*Syntax: '''''Float'''''
*Default Value: '''''3.0'''''}}

===$Enable in-game options:===
{{Table190|
*Mode whereby various settings can be modified by FSO while it's still running, rather than being set by the launcher before execution. By default is now ON, and can be accessed by going to the Options menu and pressing F3.
*Syntax: '''''Boolean'''''
*Default Value: '''''YES'''''}}

===$Dinky Shockwave Default Multiplier:===
{{Table190|
*Amount of damage, as a multiple of normal shockwave damage, assigned to a weapon's [[Weapons.tbl#.24Dinky shockwave:|dinky shockwave]] by default. To get the same behavior FSO had from 2005-2019, set this to 0.25.
*Syntax: '''''Float'''''
*Default Value: '''''1.0'''''}}

===$Shockwaves Always Damage Bombs:===
{{Table202|
*Enables all bombs being damaged by shockwaves. Previously only those marked with flags could be damaged.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Shockwaves Damage All Object Types Once:===
{{Table202|
*Keeps any object from being damaged more than once by a shockwave. The default behavior is for asteroids and flagged missiles to be damaged every frame by the shockwave.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Shockwaves Inherit Parent Weapon Damage Type:===
{{Table224|
*When enabled, the shockwaves of weapons that have a defined damage type automatically inherit that damage type, rather than dealing "typeless" damage. As this behavior is more intuitive than when this flag is disabled, mods targeting 22.4 or newer versions of FSO will have it enabled by default.
*Syntax: '''''Boolean'''''
*Default Value: '''''True''''' for mods targeting 22.4 or newer versions of FSO, otherwise '''''False'''''}}

===$Inherited Shockwave Damage Type Added Suffix:===
{{Table224|
*When combined with "$Shockwaves Inherit Parent Weapon Damage Type:", this string is added to the inherited damage type to define the shockwave's damage type. For example, if a weapon has the damage type "heavy" and the provided suffix is "-shock", then that weapon's shockwave's damage type would default to "heavy-shock".
*Note: When defined, this also implicitly sets the equivalent value for dinky shockwaves, below.
*Syntax: '''''String'''''}}

===$Inherited Dinky Shockwave Damage Type Added Suffix:===
{{Table224|
*The same as "$Inherited Shockwave Damage Type Added Suffix:", except specifically for "dinky" shockwaves.
*Syntax: '''''String'''''}}

===$Default Shockwave Damage Type:===
{{Table224|
*If a weapon's shockwave doesn't have a damage type set, it will have this damage type instead (when "$Shockwaves Inherit Parent Weapon Damage Type:" is enabled, this will only be used if the weapon itself also doesn't have a damage type set).
*Note: When defined, this also implicitly sets the equivalent value for dinky shockwaves, below.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Default Dinky Shockwave Damage Type:===
{{Table224|
*The same as "$Default Shockwave Damage Type:", except specifically for "dinky" shockwaves.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Use Engine Wash Intensity:===
{{Table190|
*Allows the game to use the [[ships.tbl#.24Intensity::|Intensity]] value when calculating Engine Wash effects.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Apply HUD shudder to chase view:===
{{Table232|
*Applies hud shudder (afterburner and engine wash) also to chase view. Does not override the command line toggle.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Swarmers Lead Targets:===
{{Table202|
*Causes swarm missiles to lead their targets by default, and will make use of [[Weapons.tbl#.2BTarget_Lead_Scaler:|Target Lead Scaler]] if specified, like normal aspect seekers.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO'''''}}

===$Damage Threshold for Weapons Subsystems to Trigger Turret Inaccuracy:===
{{Table202|
*Specifies the damage threshold for when turrets become less accurate due to weapon subsystem damage. In other words, how damaged do a ship's aggregated weapons systems have to be before the turrets become inaccurate? Value must be between 0.0-1.0 (includes 0.0 and 1.0).
*Syntax: '''''Float'''''
*Default Value: '''''0.7'''''}}

===$AI use framerate independent turning:===
{{Table202|
*Without this flag, missiles turn rate is directly dependent on the current framerate. When enabled their turn rate will be consistent, with the "true" turning taken to be observed turning at 60fps. This flag also affects ships, but the instability is only apparent at extremely low framerates, and so the change will not be apparent.
*Syntax: '''''Boolean'''''
*Default Value: '''''True'''''}}

====+AI respect tabled turn time and rotdamp:====
{{Table202|
*Due to complicated physics issues caused by retail not using the above method, tabled turn times on ships and missiles are not representative of actual observed turn times. The above flag makes it consistent, but this flag will make it accurate to what is actually listed in the table.
*Additionally, rotdamp is now used properly by the AI in a similar manner to players. More rotdamp will result in slower rotational acceleration, and less results in faster acceleration.
*NOTE: BEWARE OF ADDING THIS FLAG TO AN EXISTING MODPACK. NEARLY EVERY SINGLE TURN TIME WILL NEED TO BE CHANGED.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Player starts in third person/chase view by default:===
{{Table212|
*When this flag is set, a player will start the mission in the chase view, not in the cockpit view.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Custom briefing icons always override standard icons:===
{{Table214|
*Custom ship briefing icons will always be shown when the briefing icon is a ship, but not when it is a non-ship icon such as a planet. Set this flag to use custom briefing icons in all cases.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Lead indicator behavior:===
{{Table224|
Changes how Lead Indicators behave when multiple weapon banks are linked and in range.
When set to default, if you have linked weapons, only the indicator for the one with the farthest range will be drawn.
When set to multiple, a lead indicator is drawn for all primary weapons in range when you have them linked.
When set to average, a single lead indicator is drawn in the average of the position where each of them would usually be drawn.
*Syntax: '''''String'''''
** Valid options are '''''default''''', '''''multiple''''' and '''''average'''''
*Default Value: '''''default'''''
}}

===$Use distant firepoint for all turrets:===
{{Table224|
*Causes the game to use firepoint-based target leading calculations for all turrets. This is useful if all or most turrets in a given mod has firepoints that are distant from their center-point.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Enable discord rich presence:===
{{Table224|
*Enables or disables the built-in Discord game-status reporting.
*Syntax: '''''Boolean'''''
*Default Value: '''''True'''''}}

===$Always hide hidden ships in hotkey list:===
{{Table224|
*Whether or not to always hide ships with HIDDEN hotkey (set in FRED), even in the in-mission hotkey menu.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Allow automatically assigning personas:===
{{Table232|
*Whether or not the game will automatically assign personas to ships that have no persona set.
*Syntax: '''''Boolean'''''
*Default Value: '''''True'''''}}

===$Countermeasures use capacity:===
{{Table232|
*Whether or not Countermeasures use tabled capacity.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Calculate subsystem hitpoints after parsing:===
{{Table234|
*Causes subsystem hitpoints to be calculated after all ships.tbl and -shp.tbm files have been parsed. This allows subsystem percentages to correctly reflect the final hull value rather than the first hull value encountered.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Fix scripted velocity:===
{{Table242|
*If this setting is enabled, object velocity set via script will wholly determine the change in position for that frame, ignoring ''all'' other in-engine concerns. Otherwise, the game engine will likely overwrite/ignore any changes, depending on when the changes were made in the frame.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Preload briefing icon models:===
{{Table250|
*If set, this forces preloading of models used for briefing icons. This only loads models used for icons that haven't already been loaded for the mission. This is useful for SCPUI's where hovering over an icon shows the model without having to click on it and the stutter when it loads models not used in mission.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Behavior for pressing Escape key in options menu:===
{{Table250|
*If set to 'save', the escape key for the HUD and Options screen saves options when leaving those screens (ie it does the same thing as pressing Ctrl-Enter/Accept). By default (or if set to 'default') the Escape key will not save any changed values when exiting those screens.
*Syntax: '''''String'''''
*Default Value: '''''default'''''}}

===$Disable intro cutscene:===
{{Table250|
*If set, this disables loading of any cutscenes as the game starts that might play before the player reaches the pilot select screen.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Show locked status for scramble missions:===
{{Table250|
*If set, scramble mission will show a text line right below the words 'Weapons Loadout' that states "Ships/Weapons Locked" (XSTR 749), thus the player can easily see their loadouts are locked and they do not have to check the loaoout buttons on every mission.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Disable expensive turret target check:===
{{Table250|
*If set, this value speeds up turret target checking. By default, turret target acquisition was spending a lot of time doing a raycast, the result of which was barely used at all. If we don't need the target normal, all it does is get a target point slightly more accurate, but in practice it really isn't noticeable at all whether the target point of the turret is actually on the surface of the ship, or maybe on the other side of the ship.
*Syntax: '''''Boolean'''''
*Default Value: '''''False'''''}}

===$Threshold below which shield skips damage:===
{{Table250|
*By default, FSO logic dictates that shields collisions and any related sound or visuals related to shields are skipped if the shields are under 10%. This value allows modders to customize the value, though the value must be between 0.0 and 1.0.
*Syntax: '''''Float'''''
*Default Value: '''''0.1'''''}}

==#END==
Required. The last line of the table must be #END

==Sample Entry==

#CAMPAIGN SETTINGS
$Default Campaign File Name: NewCampaignFile

#Ignored Campaign File Names
$Campaign File Name: FreeSpace2.fc2

#HUD SETTINGS
$Directive Wait Time: 5000

#SEXP SETTINGS
$Loop SEXPs Then Arguments: True

#OTHER SETTINGS
$Fix Turret Collisions: True

#END

[[Category:Tables]]

Fonts.tbl

2025-08-22T17:30:43Z

-Joshua-: /* +Can Scale: */

{{SCP_table}}
{{TableVersionGit|2016-08-02|b4db345}}
{{Tables}}
The '''fonts.tbl''' is a recent addition to the SCP allowing the definition of non-standard fonts. The number of possible fonts is unlimited. The HUD gauges, show-subtitle-text sexp and the [[Fiction Viewer|fiction viewer]] can be manually set to any font in fonts.tbl. The rest of the fonts used in FSO (e.g. techroom text) are hardcoded to one of the first three fonts that are parsed.

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

==General Info==
*Begins with #Fonts
*Consists of at least 3 entries
*Ends with #End

Currently, there are two different types of supported fonts. The old "VFNT" type (which probably means '''V'''olition '''F'''o'''nt''') and the new TrueType fonts. The old font use the usual ''$Font:'' option while the new fonts use ''$TrueType:''. TrueType fonts can be TTF or OTF.

===$Font:===
*Lists a font file to use.
*This font type is not supported if the engine is in [[Game_settings.tbl#$Unicode mode:|Unicode text mode]]!
*Syntax: '''String'''

====+Name:====
{{Table38|
*Sets the name of this font. Defaults to the specified filename if not provided. Be aware that using a number as the name makes referring to the font by name impossible, as numbers are parsed as the font index not the font name.
*Syntax: '''String'''
}}

====+Default Special Character Index:====
{{Table372|
*Specifies the index of the first special character (e.g., infinity symbol, "match speed" icon) in the font. Must be within the range of 0-249. Does not apply to language entries below that use [[Fonts.tbl#+Special Character Index:|+Special Character Index:]].
*Syntax: '''Integer'''
{{Note|If this parameter is used with the first font, it will override all uses of +Special Character Index: in [[strings.tbl]].}}
}}

====+Language:====
{{Table372|
*Specifies the name of a language.
*Currently used for overriding the value of [[Fonts.tbl#+Default Special Character Index:|+Default Special Character Index:]].
*Syntax: '''String'''

=====+Special Character Index:=====
*Overrides the value of [[Fonts.tbl#+Default Special Character Index:|+Default Special Character Index:]] for this language.
*Syntax: '''Integer'''
}}

=====+Auto Size:=====
{{Table250|
*Tells FSO to try to automatically scale this font to match the screen resolution.
*Syntax: '''Boolean'''
}}

=====+Can Scale:=====
{{Table250|
*Tells FSO that this font can scale with the Font Size option available to the player in In-Game Options.
*Syntax: '''Boolean'''
}}

====+Top offset:====
{{Table38|
*Specifies the top offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Bottom offset:====
{{Table38|
*Specifies the bottom offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

===$TrueType:===
{{Table38|
*Lists a font file to use.
*Syntax: '''String'''
}}
{{Table210|
As of 21.0, this can be OTF in addition to the previously supported TTF.}}

====+Name:====
{{Table38|
*Specifies the name of this font, defaults to '''<fontFilename>-<fontSize>'''. Be aware that using a number as the name makes referring to the font by name impossible, as numbers are parsed as the font index not the font name.
*Syntax: '''String'''
}}

====+Size:====
{{Table38|
*Specifies the size of the font, defaults to 8.
*Syntax: '''float''', must be greater than 0
}}

=====+Auto Size:=====
{{Table250|
*Tells FSO to try to automatically scale this font to match the screen resolution.
*Syntax: '''Boolean'''
}}

=====+Can Scale:=====
{{Table250|
*Tells FSO that this font can scale with the Font Size option available to the player in In-Game Options.
*Syntax: '''Boolean'''
}}

====+Top offset:====
{{Table38|
*Specifies the top offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Bottom offset:====
{{Table38|
*Specifies the bottom offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Letter spacing:====
{{Table38|
*Specifies the letter spacing. Defaults to 0.
*Syntax: '''float''', must be greater or equal to 0.
}}

====+Special Character Font:====
{{Table38|
*Specifies the VFNT file to use for the special characters. FSO uses a few special characters for a few things that are not present in standard TrueType fonts. To fix this you can specify a VFNT file from which these characters are loaded. This defaults to '''font01.vf''' which is a default font file from FS2 retail.
*This option not needed and not supported if the engine is in [[Game_settings.tbl#$Unicode mode:|Unicode text mode]]!
*Note! Pointing this to the fifth font entry or later can cause crashes, especially on standalones. See Cyborg for questions until this limit is removed.
*Syntax: '''String'''
}}

==Top and Bottom offsets==
The top and bottom offsets can be used to influence the line spacing for a specific font. Before rendering '''top offset''' vertical pixels are skipped. Then the text is rendered and then another '''bottom offset''' pixels are skipped.

==Sample Entry==
<pre>
#Fonts

$Font: font01.vf
$Font: font02.vf
$Font: font03.vf

$TrueType: arial.ttf
+Name: Arial
+Size: 12

#End
</pre>
==Sample Entry (Fiction Viewer)==
<pre>
#Fiction Viewer

$File: [text file]
$Font: [font file]
</pre>

== References ==
# "[http://www.hard-light.net/forums/index.php?topic=66942.msg1327152#msg1327152 Re: Feature Request: 4th font (especially for fiction viewer)]", ''Hard Light Productions Forums'', Hard Light Productions, 24-12-2009. Retrieved on January 28, 2011.

[[Category:Tables]]

Fonts.tbl

2025-08-22T17:30:37Z

-Joshua-: /* +Can Scale: */

{{SCP_table}}
{{TableVersionGit|2016-08-02|b4db345}}
{{Tables}}
The '''fonts.tbl''' is a recent addition to the SCP allowing the definition of non-standard fonts. The number of possible fonts is unlimited. The HUD gauges, show-subtitle-text sexp and the [[Fiction Viewer|fiction viewer]] can be manually set to any font in fonts.tbl. The rest of the fonts used in FSO (e.g. techroom text) are hardcoded to one of the first three fonts that are parsed.

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

==General Info==
*Begins with #Fonts
*Consists of at least 3 entries
*Ends with #End

Currently, there are two different types of supported fonts. The old "VFNT" type (which probably means '''V'''olition '''F'''o'''nt''') and the new TrueType fonts. The old font use the usual ''$Font:'' option while the new fonts use ''$TrueType:''. TrueType fonts can be TTF or OTF.

===$Font:===
*Lists a font file to use.
*This font type is not supported if the engine is in [[Game_settings.tbl#$Unicode mode:|Unicode text mode]]!
*Syntax: '''String'''

====+Name:====
{{Table38|
*Sets the name of this font. Defaults to the specified filename if not provided. Be aware that using a number as the name makes referring to the font by name impossible, as numbers are parsed as the font index not the font name.
*Syntax: '''String'''
}}

====+Default Special Character Index:====
{{Table372|
*Specifies the index of the first special character (e.g., infinity symbol, "match speed" icon) in the font. Must be within the range of 0-249. Does not apply to language entries below that use [[Fonts.tbl#+Special Character Index:|+Special Character Index:]].
*Syntax: '''Integer'''
{{Note|If this parameter is used with the first font, it will override all uses of +Special Character Index: in [[strings.tbl]].}}
}}

====+Language:====
{{Table372|
*Specifies the name of a language.
*Currently used for overriding the value of [[Fonts.tbl#+Default Special Character Index:|+Default Special Character Index:]].
*Syntax: '''String'''

=====+Special Character Index:=====
*Overrides the value of [[Fonts.tbl#+Default Special Character Index:|+Default Special Character Index:]] for this language.
*Syntax: '''Integer'''
}}

=====+Auto Size:=====
{{Table250|
*Tells FSO to try to automatically scale this font to match the screen resolution.
*Syntax: '''Boolean'''
}}

=====+Can Scale:=====
{{Table242|
*Tells FSO that this font can scale with the Font Size option available to the player in In-Game Options.
*Syntax: '''Boolean'''
}}

====+Top offset:====
{{Table38|
*Specifies the top offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Bottom offset:====
{{Table38|
*Specifies the bottom offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

===$TrueType:===
{{Table38|
*Lists a font file to use.
*Syntax: '''String'''
}}
{{Table210|
As of 21.0, this can be OTF in addition to the previously supported TTF.}}

====+Name:====
{{Table38|
*Specifies the name of this font, defaults to '''<fontFilename>-<fontSize>'''. Be aware that using a number as the name makes referring to the font by name impossible, as numbers are parsed as the font index not the font name.
*Syntax: '''String'''
}}

====+Size:====
{{Table38|
*Specifies the size of the font, defaults to 8.
*Syntax: '''float''', must be greater than 0
}}

=====+Auto Size:=====
{{Table250|
*Tells FSO to try to automatically scale this font to match the screen resolution.
*Syntax: '''Boolean'''
}}

=====+Can Scale:=====
{{Table250|
*Tells FSO that this font can scale with the Font Size option available to the player in In-Game Options.
*Syntax: '''Boolean'''
}}

====+Top offset:====
{{Table38|
*Specifies the top offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Bottom offset:====
{{Table38|
*Specifies the bottom offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Letter spacing:====
{{Table38|
*Specifies the letter spacing. Defaults to 0.
*Syntax: '''float''', must be greater or equal to 0.
}}

====+Special Character Font:====
{{Table38|
*Specifies the VFNT file to use for the special characters. FSO uses a few special characters for a few things that are not present in standard TrueType fonts. To fix this you can specify a VFNT file from which these characters are loaded. This defaults to '''font01.vf''' which is a default font file from FS2 retail.
*This option not needed and not supported if the engine is in [[Game_settings.tbl#$Unicode mode:|Unicode text mode]]!
*Note! Pointing this to the fifth font entry or later can cause crashes, especially on standalones. See Cyborg for questions until this limit is removed.
*Syntax: '''String'''
}}

==Top and Bottom offsets==
The top and bottom offsets can be used to influence the line spacing for a specific font. Before rendering '''top offset''' vertical pixels are skipped. Then the text is rendered and then another '''bottom offset''' pixels are skipped.

==Sample Entry==
<pre>
#Fonts

$Font: font01.vf
$Font: font02.vf
$Font: font03.vf

$TrueType: arial.ttf
+Name: Arial
+Size: 12

#End
</pre>
==Sample Entry (Fiction Viewer)==
<pre>
#Fiction Viewer

$File: [text file]
$Font: [font file]
</pre>

== References ==
# "[http://www.hard-light.net/forums/index.php?topic=66942.msg1327152#msg1327152 Re: Feature Request: 4th font (especially for fiction viewer)]", ''Hard Light Productions Forums'', Hard Light Productions, 24-12-2009. Retrieved on January 28, 2011.

[[Category:Tables]]

Fonts.tbl

2025-08-22T17:30:31Z

-Joshua-: /* +Auto Size: */

{{SCP_table}}
{{TableVersionGit|2016-08-02|b4db345}}
{{Tables}}
The '''fonts.tbl''' is a recent addition to the SCP allowing the definition of non-standard fonts. The number of possible fonts is unlimited. The HUD gauges, show-subtitle-text sexp and the [[Fiction Viewer|fiction viewer]] can be manually set to any font in fonts.tbl. The rest of the fonts used in FSO (e.g. techroom text) are hardcoded to one of the first three fonts that are parsed.

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

==General Info==
*Begins with #Fonts
*Consists of at least 3 entries
*Ends with #End

Currently, there are two different types of supported fonts. The old "VFNT" type (which probably means '''V'''olition '''F'''o'''nt''') and the new TrueType fonts. The old font use the usual ''$Font:'' option while the new fonts use ''$TrueType:''. TrueType fonts can be TTF or OTF.

===$Font:===
*Lists a font file to use.
*This font type is not supported if the engine is in [[Game_settings.tbl#$Unicode mode:|Unicode text mode]]!
*Syntax: '''String'''

====+Name:====
{{Table38|
*Sets the name of this font. Defaults to the specified filename if not provided. Be aware that using a number as the name makes referring to the font by name impossible, as numbers are parsed as the font index not the font name.
*Syntax: '''String'''
}}

====+Default Special Character Index:====
{{Table372|
*Specifies the index of the first special character (e.g., infinity symbol, "match speed" icon) in the font. Must be within the range of 0-249. Does not apply to language entries below that use [[Fonts.tbl#+Special Character Index:|+Special Character Index:]].
*Syntax: '''Integer'''
{{Note|If this parameter is used with the first font, it will override all uses of +Special Character Index: in [[strings.tbl]].}}
}}

====+Language:====
{{Table372|
*Specifies the name of a language.
*Currently used for overriding the value of [[Fonts.tbl#+Default Special Character Index:|+Default Special Character Index:]].
*Syntax: '''String'''

=====+Special Character Index:=====
*Overrides the value of [[Fonts.tbl#+Default Special Character Index:|+Default Special Character Index:]] for this language.
*Syntax: '''Integer'''
}}

=====+Auto Size:=====
{{Table250|
*Tells FSO to try to automatically scale this font to match the screen resolution.
*Syntax: '''Boolean'''
}}

=====+Can Scale:=====
{{Table242|
*Tells FSO that this font can scale with the Font Size option available to the player in In-Game Options.
*Syntax: '''Boolean'''
}}

====+Top offset:====
{{Table38|
*Specifies the top offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Bottom offset:====
{{Table38|
*Specifies the bottom offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

===$TrueType:===
{{Table38|
*Lists a font file to use.
*Syntax: '''String'''
}}
{{Table210|
As of 21.0, this can be OTF in addition to the previously supported TTF.}}

====+Name:====
{{Table38|
*Specifies the name of this font, defaults to '''<fontFilename>-<fontSize>'''. Be aware that using a number as the name makes referring to the font by name impossible, as numbers are parsed as the font index not the font name.
*Syntax: '''String'''
}}

====+Size:====
{{Table38|
*Specifies the size of the font, defaults to 8.
*Syntax: '''float''', must be greater than 0
}}

=====+Auto Size:=====
{{Table250|
*Tells FSO to try to automatically scale this font to match the screen resolution.
*Syntax: '''Boolean'''
}}

=====+Can Scale:=====
{{Table242|
*Tells FSO that this font can scale with the Font Size option available to the player in In-Game Options.
*Syntax: '''Boolean'''
}}

====+Top offset:====
{{Table38|
*Specifies the top offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Bottom offset:====
{{Table38|
*Specifies the bottom offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Letter spacing:====
{{Table38|
*Specifies the letter spacing. Defaults to 0.
*Syntax: '''float''', must be greater or equal to 0.
}}

====+Special Character Font:====
{{Table38|
*Specifies the VFNT file to use for the special characters. FSO uses a few special characters for a few things that are not present in standard TrueType fonts. To fix this you can specify a VFNT file from which these characters are loaded. This defaults to '''font01.vf''' which is a default font file from FS2 retail.
*This option not needed and not supported if the engine is in [[Game_settings.tbl#$Unicode mode:|Unicode text mode]]!
*Note! Pointing this to the fifth font entry or later can cause crashes, especially on standalones. See Cyborg for questions until this limit is removed.
*Syntax: '''String'''
}}

==Top and Bottom offsets==
The top and bottom offsets can be used to influence the line spacing for a specific font. Before rendering '''top offset''' vertical pixels are skipped. Then the text is rendered and then another '''bottom offset''' pixels are skipped.

==Sample Entry==
<pre>
#Fonts

$Font: font01.vf
$Font: font02.vf
$Font: font03.vf

$TrueType: arial.ttf
+Name: Arial
+Size: 12

#End
</pre>
==Sample Entry (Fiction Viewer)==
<pre>
#Fiction Viewer

$File: [text file]
$Font: [font file]
</pre>

== References ==
# "[http://www.hard-light.net/forums/index.php?topic=66942.msg1327152#msg1327152 Re: Feature Request: 4th font (especially for fiction viewer)]", ''Hard Light Productions Forums'', Hard Light Productions, 24-12-2009. Retrieved on January 28, 2011.

[[Category:Tables]]

Fonts.tbl

2025-08-22T17:30:23Z

-Joshua-: /* +Auto Size: */

{{SCP_table}}
{{TableVersionGit|2016-08-02|b4db345}}
{{Tables}}
The '''fonts.tbl''' is a recent addition to the SCP allowing the definition of non-standard fonts. The number of possible fonts is unlimited. The HUD gauges, show-subtitle-text sexp and the [[Fiction Viewer|fiction viewer]] can be manually set to any font in fonts.tbl. The rest of the fonts used in FSO (e.g. techroom text) are hardcoded to one of the first three fonts that are parsed.

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

==General Info==
*Begins with #Fonts
*Consists of at least 3 entries
*Ends with #End

Currently, there are two different types of supported fonts. The old "VFNT" type (which probably means '''V'''olition '''F'''o'''nt''') and the new TrueType fonts. The old font use the usual ''$Font:'' option while the new fonts use ''$TrueType:''. TrueType fonts can be TTF or OTF.

===$Font:===
*Lists a font file to use.
*This font type is not supported if the engine is in [[Game_settings.tbl#$Unicode mode:|Unicode text mode]]!
*Syntax: '''String'''

====+Name:====
{{Table38|
*Sets the name of this font. Defaults to the specified filename if not provided. Be aware that using a number as the name makes referring to the font by name impossible, as numbers are parsed as the font index not the font name.
*Syntax: '''String'''
}}

====+Default Special Character Index:====
{{Table372|
*Specifies the index of the first special character (e.g., infinity symbol, "match speed" icon) in the font. Must be within the range of 0-249. Does not apply to language entries below that use [[Fonts.tbl#+Special Character Index:|+Special Character Index:]].
*Syntax: '''Integer'''
{{Note|If this parameter is used with the first font, it will override all uses of +Special Character Index: in [[strings.tbl]].}}
}}

====+Language:====
{{Table372|
*Specifies the name of a language.
*Currently used for overriding the value of [[Fonts.tbl#+Default Special Character Index:|+Default Special Character Index:]].
*Syntax: '''String'''

=====+Special Character Index:=====
*Overrides the value of [[Fonts.tbl#+Default Special Character Index:|+Default Special Character Index:]] for this language.
*Syntax: '''Integer'''
}}

=====+Auto Size:=====
{{Table250|
*Tells FSO to try to automatically scale this font to match the screen resolution.
*Syntax: '''Boolean'''
}}

=====+Can Scale:=====
{{Table242|
*Tells FSO that this font can scale with the Font Size option available to the player in In-Game Options.
*Syntax: '''Boolean'''
}}

====+Top offset:====
{{Table38|
*Specifies the top offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Bottom offset:====
{{Table38|
*Specifies the bottom offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

===$TrueType:===
{{Table38|
*Lists a font file to use.
*Syntax: '''String'''
}}
{{Table210|
As of 21.0, this can be OTF in addition to the previously supported TTF.}}

====+Name:====
{{Table38|
*Specifies the name of this font, defaults to '''<fontFilename>-<fontSize>'''. Be aware that using a number as the name makes referring to the font by name impossible, as numbers are parsed as the font index not the font name.
*Syntax: '''String'''
}}

====+Size:====
{{Table38|
*Specifies the size of the font, defaults to 8.
*Syntax: '''float''', must be greater than 0
}}

=====+Auto Size:=====
{{Table242|
*Tells FSO to try to automatically scale this font to match the screen resolution.
*Syntax: '''Boolean'''
}}

=====+Can Scale:=====
{{Table242|
*Tells FSO that this font can scale with the Font Size option available to the player in In-Game Options.
*Syntax: '''Boolean'''
}}

====+Top offset:====
{{Table38|
*Specifies the top offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Bottom offset:====
{{Table38|
*Specifies the bottom offset for this font. See [[Fonts.tbl|Top and Bottom offsets]] for more information.
*Syntax: '''float'''
}}

====+Letter spacing:====
{{Table38|
*Specifies the letter spacing. Defaults to 0.
*Syntax: '''float''', must be greater or equal to 0.
}}

====+Special Character Font:====
{{Table38|
*Specifies the VFNT file to use for the special characters. FSO uses a few special characters for a few things that are not present in standard TrueType fonts. To fix this you can specify a VFNT file from which these characters are loaded. This defaults to '''font01.vf''' which is a default font file from FS2 retail.
*This option not needed and not supported if the engine is in [[Game_settings.tbl#$Unicode mode:|Unicode text mode]]!
*Note! Pointing this to the fifth font entry or later can cause crashes, especially on standalones. See Cyborg for questions until this limit is removed.
*Syntax: '''String'''
}}

==Top and Bottom offsets==
The top and bottom offsets can be used to influence the line spacing for a specific font. Before rendering '''top offset''' vertical pixels are skipped. Then the text is rendered and then another '''bottom offset''' pixels are skipped.

==Sample Entry==
<pre>
#Fonts

$Font: font01.vf
$Font: font02.vf
$Font: font03.vf

$TrueType: arial.ttf
+Name: Arial
+Size: 12

#End
</pre>
==Sample Entry (Fiction Viewer)==
<pre>
#Fiction Viewer

$File: [text file]
$Font: [font file]
</pre>

== References ==
# "[http://www.hard-light.net/forums/index.php?topic=66942.msg1327152#msg1327152 Re: Feature Request: 4th font (especially for fiction viewer)]", ''Hard Light Productions Forums'', Hard Light Productions, 24-12-2009. Retrieved on January 28, 2011.

[[Category:Tables]]

Sounds.tbl

2024-01-07T14:15:38Z

-Joshua-: /* #Sound Environments Start */

{{TableVersion| 344502c (Git commit)}}
{{Tables}}
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

==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 three possible syntaxes. The "Sound set" syntax allows to use multiple sounds. The "SCP Syntax" was introduced as a general improvement over the retail Syntax and is very similar to the sound set syntax.
**The Sound set syntax allows to specify multiple sound files for one sound entry and also has a wider variety of options for specifying how the sound should be played. This syntax is based on the SCP syntax and it should be easy to adapt sound entries that use the SCP syntax to the new sound set syntax. This is only required if the new features of the sound set changes are to be used. Otherwise the SCP syntax can be used.
**The SCP Syntax is an improvement of the retail syntax whis is 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.

==Sound set 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.}}

{{Table381|
}}

If this syntax is in use then the new sound set features can be used. These include the ability to use multiple sound files for one entry and with this feature it is possible to randomize the volume and pitch values when a sound is played. Compared to the SCP syntax there are only a few changes: Instead of ''+Filename'' this now uses ''+Entry'' and allows using that option as often as needed. The ''+Volume'' option accepts a random range for possible values and the ''+Pitch'' option is new.

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
+Entry: breakup
+Cycle type: sequential
+Preload: no
+Volume: (0.60)
+3D Sound:
+Attenuation start: 100
+Attenuation end: 800
+Priority: High
+Limit: 3
+Pitch: (1.0)
</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>
{{Warning|
Unlike most other tables, existing entries cannot be overwritten/modified without the presence of '''+nocreate'''.}}

====+Entry:====
*The name of the actual sound file. This option may appear more than once if multiple sound files should be used for this sound entry.
*Always required once, even if +nocreate is used.
*To specify no sound file, use "empty" (without the quotes)
*If +nocreate is used then sound files can only be added to the sound but no other modification is available.
*Syntax: '''String'''

====+Cycle type:====
*Specifies how the next sound entry should be chosen from the ''+Entry'' list
*Required, optional if +nocreate is used
*May use one of the following modes:
**'''sequential''': The entry will be chosen sequentially from the list. '''Note:''' The sequence of played sounds is determined globally so if there are two sound sources using the same entry then the sounds may appear as missing parts for either source since the other source used that entry before.
**'''random''': An entry is chosen uniformly at random from the entries list
*Syntax: '''sequential''' or '''random'''

====+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 random range between 0 and 1. The actual volume will be picked within that range whenever a sound is played
*Optional if +nocreate is used, required otherwise
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.5 1.0)''. It is also valid to only specify one value if there should be no randomization.

====+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
{{Table222|
*Limit can now be set as high as 255
}}
*See the [[Enhanced sound]] page for more information,
*Syntax: '''Integer'''

====+Pitch:====
*Specifies which pitch values the sound may be assigned
*Optional, defaults to 1.0
*This is a random range which specifies the possible pitch values the sound may be assigned
*The actual effect of these values is very complicated to describe so you should simply test to check which values sound well. A value of 1.0 plays the sound without any changes.
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.9 1.1)''. It is also valid to only specify one value if there should be no randomization.

'''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
+Entry: Crane_1
+Cycle type: sequential
+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>

====+Entry:====
*The name of the actual sound file. This option may appear more than once if multiple sound files should be used for this sound entry.
*Always required once, even if +nocreate is used.
*To specify no sound file, use "empty" (without the quotes)
*If +nocreate is used then sound files can only be added to the sound but no other modification is available.
*Syntax: '''String'''

====+Cycle type:====
*Specifies how the next sound entry should be chosen from the ''+Entry'' list
*Required, optional if +nocreate is used
*May use one of the following modes:
**'''sequential''': The entry will be chosen sequentially from the list. '''Note:''' The sequence of played sounds is determined globally so if there are two sound sources using the same entry then the sounds may appear as missing parts for either source since the other source used that entry before.
**'''random''': An entry is chosen uniformly at random from the entries list
*Syntax: '''sequential''' or '''random'''

====+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 random range between 0 and 1. The actual volume will be picked within that range whenever a sound is played
*Optional if +nocreate is used, required otherwise
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.5 1.0)''. It is also valid to only specify one value if there should be no randomization.

====+Pitch:====
*Specifies which pitch values the sound may be assigned
*Optional, defaults to 1.0
*This is a random range which specifies the possible pitch values the sound may be assigned
*The actual effect of these values is very complicated to describe so you should simply test to check which values sound well. A value of 1.0 plays the sound without any changes.
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.9 1.1)''. It is also valid to only specify one value if there should be no randomization.

'''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
+Entry: T_flyby1
+Cycle type: sequential
+Preload: no
+Volume: (0.75)
+3D Sound:
+Attenuation start: 200
+Attenuation end: 400

$Terran: 1
+Entry: T_flyby2
+Cycle type: sequential
+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.}}

====+Entry:====
*The name of the actual sound file. This option may appear more than once if multiple sound files should be used for this sound entry.
*Always required once, even if +nocreate is used.
*To specify no sound file, use "empty" (without the quotes)
*If +nocreate is used then sound files can only be added to the sound but no other modification is available.
*Syntax: '''String'''

====+Cycle type:====
*Specifies how the next sound entry should be chosen from the ''+Entry'' list
*Required, optional if +nocreate is used
*May use one of the following modes:
**'''sequential''': The entry will be chosen sequentially from the list. '''Note:''' The sequence of played sounds is determined globally so if there are two sound sources using the same entry then the sounds may appear as missing parts for either source since the other source used that entry before.
**'''random''': An entry is chosen uniformly at random from the entries list
*Syntax: '''sequential''' or '''random'''

====+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 random range between 0 and 1. The actual volume will be picked within that range whenever a sound is played
*Optional if +nocreate is used, required otherwise
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.5 1.0)''. It is also valid to only specify one value if there should be no randomization.

====+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'''

====+Pitch:====
*Specifies which pitch values the sound may be assigned
*Optional, defaults to 1.0
*This is a random range which specifies the possible pitch values the sound may be assigned
*The actual effect of these values is very complicated to describe so you should simply test to check which values sound well. A value of 1.0 plays the sound without any changes.
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.9 1.1)''. It is also valid to only specify one value if there should be no randomization.

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

==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 or '''Empty''').
**'''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'''

{{Table372|
==Sound Environments==
*Allows defining custom EFX sound effects (reverb) as well as changing the default. You can then select these in FRED2, under Mission Specs - Sound Environment. Fred2 already has a bunch of default ones coded in.
}}
===#Sound Environments Start===
====$Name:====
*Lets you define a name for this preset.
*If it's "Default", it'll be applied in all missions that don't define their own.
====$Template:====
*Lets you set the EAX template which will act as a default for all subsequent settings.
*The default setting in FSO is "Hangar".
*[https://github.com/kcat/openal-soft/blob/master/include/AL/efx-presets.h The default presets available in OpenAL-Soft can be found here.] Please note that not all of them are implemented (anything not listed below the default section).
*For easy editing, simply set a template and +gain.
*[https://usermanual.wiki/Pdf/Effects20Extension20Guide.90272296/view#95 The EAX Reverb manual contains detailed explenations of what all of these do if you want to fine tune them]
{{Note|
*All Subsequent settings are optional.
*Their defaults are defined by $Template:}}
=====+Density=====
*range: 0.0 - 1.0
=====+Diffusion:=====
*linear multiplier
*range: 0.0 - 1.0
=====+Gain:=====
*gain/volume
*linear gain
*range: 0.0 - 1.0
=====+Gain HF:=====
*high frequency gain
*linear gain
*range: 0.0 - 1.0
=====+Gain LF:=====
*low frequency gain
*linear gain
*range: 0.0 - 1.0
=====+Decay time:=====
*deacy
*seconds
*range: 0.1 - 20
=====+Decay HF Ratio=====
*high frequency decay multiplier (damping)
*linear multiplier
*range: 0.1 - 20
=====+Decay LF Ratio=====
*low frequency decay multiplier
*linear multiplier
*range: 0.1 - 20
=====+reflections gain=====
*linear gain
*range: 0.0 - 3.16
=====+Reflections Delay:=====
*seconds
*range: 0.0 - 0.3
=====+Reflactions Pan:=====
*vector (0.0, 0.0, 0.0)
*magnitude
*range(s): 0.0 - 1.0
=====+Late Reverb Gain:=====
*linear gain
*range: 0.0 - 10.0
=====+Late Reverb Delay:=====
*seconds
*range: 0.0 - 0.1
=====+Late Reverb Pan:=====
*vector
*magnitude
*range(s): 0.0 - 1.0
=====+Echo Time:=====
*seconds
*range: 0.075 - 0.25
=====+Echo Depth:=====
*linear multiplier
*range: 0.0 - 1.0
=====+Modulation Time:=====
*seconds
*range: 0.004 - 4.0
=====+Modulation Depth:=====
*linear multiplier
*range: 0.0 - 1.0
=====+HF Reference:=====
*Hz
*range: 1000.0 - 20000.0
=====+LF Reference:=====
*Hz
*range: 20.0 - 1000.0 (should be 1/10th or less of HF Reference value)
=====+Room Rolloff Factor:=====
*linear multiplier
*range: 0.0 - 10.0
=====+Air Absorption Gain HF:=====
*linear gain per meter
*range: 0.892 - 1.0
=====+Decay HF Limit:=====
*boolean

===#Sound Environments 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>

*Sound Environments section
<pre>
#Sound Environments Start

; All options with default values and ranges
$Name: EFX Defaults
+Density: 1.0 ; range: 0.0 - 1.0
+Diffusion: 1.0 ; linear multiplier, range: 0.0 - 1.0
+Gain: 0.32 ; gain/volume, linear gain, range: 0.0 - 1.0
+Gain HF: 0.89 ; high frequency gain, linear gain, range: 0.0 - 1.0
+Gain LF: 0.0 ; low frequency gain, linear gain, range: 0.0 - 1.0
+Decay Time: 1.49 ; decay, seconds, range: 0.1 - 20.0
+Decay HF Ratio: 0.83 ; high frequency decay multiplier (damping), linear multiplier, range: 0.1 - 20.0
+Decay LF Ratio: 1.0 ; low frequency decay multiplier, linear multiplier, range: 0.1 - 20.0
+Reflections Gain: 0.05 ; linear gain, range: 0.0 - 3.16
+Reflections Delay: 0.007 ; seconds, range: 0.0 - 0.3
+Reflections Pan: 0.0, 0.0, 0.0 ; vector, magnitude, range(s): 0.0 - 1.0
+Late Reverb Gain: 1.26 ; linear gain, range: 0.0 - 10.0
+Late Reverb Delay: 0.011 ; seconds, range: 0.0 - 0.1
+Late Reverb Pan: 0.0, 0.0, 0.0 ; vector, magnitude, range(s): 0.0 - 1.0
+Echo Time: 0.25 ; seconds, range: 0.075 - 0.25
+Echo Depth: 0.0 ; linear multiplier, range: 0.0 - 1.0
+Modulation Time: 0.25 ; seconds, range: 0.004 - 4.0
+Modulation Depth: 0.0 ; linear multiplier, range: 0.0 - 1.0
+HF Reference: 5000.0 ; Hz, range: 1000.0 - 20000.0
+LF Reference: 250.0 ; Hz, range: 20.0 - 1000.0 (should be 1/10th or less of HF Reference value)
+Room Rolloff Factor: 0.0 ; linear multiplier, range: 0.0 - 10.0
+Air Absorption Gain HF: 0.994 ; linear gain per meter, range: 0.892 - 1.0
+Decay HF Limit: true ; boolean

; Set up an environment for subspace missions based on the EAX 'Drugged' effect
$Name: Subspace
$Template: Drugged
+Gain: 0.8
+Decay HF Ratio: 1.188
+Decay Time: 6.392

; Set the default environment to the EAX 'Hangar' effect
$Name: Default
$Template: None

#Sound Environments End
</pre>

[[Category:Tables]]

Sounds.tbl

2024-01-07T14:14:48Z

-Joshua-:

{{TableVersion| 344502c (Git commit)}}
{{Tables}}
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

==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 three possible syntaxes. The "Sound set" syntax allows to use multiple sounds. The "SCP Syntax" was introduced as a general improvement over the retail Syntax and is very similar to the sound set syntax.
**The Sound set syntax allows to specify multiple sound files for one sound entry and also has a wider variety of options for specifying how the sound should be played. This syntax is based on the SCP syntax and it should be easy to adapt sound entries that use the SCP syntax to the new sound set syntax. This is only required if the new features of the sound set changes are to be used. Otherwise the SCP syntax can be used.
**The SCP Syntax is an improvement of the retail syntax whis is 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.

==Sound set 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.}}

{{Table381|
}}

If this syntax is in use then the new sound set features can be used. These include the ability to use multiple sound files for one entry and with this feature it is possible to randomize the volume and pitch values when a sound is played. Compared to the SCP syntax there are only a few changes: Instead of ''+Filename'' this now uses ''+Entry'' and allows using that option as often as needed. The ''+Volume'' option accepts a random range for possible values and the ''+Pitch'' option is new.

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
+Entry: breakup
+Cycle type: sequential
+Preload: no
+Volume: (0.60)
+3D Sound:
+Attenuation start: 100
+Attenuation end: 800
+Priority: High
+Limit: 3
+Pitch: (1.0)
</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>
{{Warning|
Unlike most other tables, existing entries cannot be overwritten/modified without the presence of '''+nocreate'''.}}

====+Entry:====
*The name of the actual sound file. This option may appear more than once if multiple sound files should be used for this sound entry.
*Always required once, even if +nocreate is used.
*To specify no sound file, use "empty" (without the quotes)
*If +nocreate is used then sound files can only be added to the sound but no other modification is available.
*Syntax: '''String'''

====+Cycle type:====
*Specifies how the next sound entry should be chosen from the ''+Entry'' list
*Required, optional if +nocreate is used
*May use one of the following modes:
**'''sequential''': The entry will be chosen sequentially from the list. '''Note:''' The sequence of played sounds is determined globally so if there are two sound sources using the same entry then the sounds may appear as missing parts for either source since the other source used that entry before.
**'''random''': An entry is chosen uniformly at random from the entries list
*Syntax: '''sequential''' or '''random'''

====+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 random range between 0 and 1. The actual volume will be picked within that range whenever a sound is played
*Optional if +nocreate is used, required otherwise
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.5 1.0)''. It is also valid to only specify one value if there should be no randomization.

====+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
{{Table222|
*Limit can now be set as high as 255
}}
*See the [[Enhanced sound]] page for more information,
*Syntax: '''Integer'''

====+Pitch:====
*Specifies which pitch values the sound may be assigned
*Optional, defaults to 1.0
*This is a random range which specifies the possible pitch values the sound may be assigned
*The actual effect of these values is very complicated to describe so you should simply test to check which values sound well. A value of 1.0 plays the sound without any changes.
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.9 1.1)''. It is also valid to only specify one value if there should be no randomization.

'''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
+Entry: Crane_1
+Cycle type: sequential
+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>

====+Entry:====
*The name of the actual sound file. This option may appear more than once if multiple sound files should be used for this sound entry.
*Always required once, even if +nocreate is used.
*To specify no sound file, use "empty" (without the quotes)
*If +nocreate is used then sound files can only be added to the sound but no other modification is available.
*Syntax: '''String'''

====+Cycle type:====
*Specifies how the next sound entry should be chosen from the ''+Entry'' list
*Required, optional if +nocreate is used
*May use one of the following modes:
**'''sequential''': The entry will be chosen sequentially from the list. '''Note:''' The sequence of played sounds is determined globally so if there are two sound sources using the same entry then the sounds may appear as missing parts for either source since the other source used that entry before.
**'''random''': An entry is chosen uniformly at random from the entries list
*Syntax: '''sequential''' or '''random'''

====+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 random range between 0 and 1. The actual volume will be picked within that range whenever a sound is played
*Optional if +nocreate is used, required otherwise
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.5 1.0)''. It is also valid to only specify one value if there should be no randomization.

====+Pitch:====
*Specifies which pitch values the sound may be assigned
*Optional, defaults to 1.0
*This is a random range which specifies the possible pitch values the sound may be assigned
*The actual effect of these values is very complicated to describe so you should simply test to check which values sound well. A value of 1.0 plays the sound without any changes.
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.9 1.1)''. It is also valid to only specify one value if there should be no randomization.

'''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
+Entry: T_flyby1
+Cycle type: sequential
+Preload: no
+Volume: (0.75)
+3D Sound:
+Attenuation start: 200
+Attenuation end: 400

$Terran: 1
+Entry: T_flyby2
+Cycle type: sequential
+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.}}

====+Entry:====
*The name of the actual sound file. This option may appear more than once if multiple sound files should be used for this sound entry.
*Always required once, even if +nocreate is used.
*To specify no sound file, use "empty" (without the quotes)
*If +nocreate is used then sound files can only be added to the sound but no other modification is available.
*Syntax: '''String'''

====+Cycle type:====
*Specifies how the next sound entry should be chosen from the ''+Entry'' list
*Required, optional if +nocreate is used
*May use one of the following modes:
**'''sequential''': The entry will be chosen sequentially from the list. '''Note:''' The sequence of played sounds is determined globally so if there are two sound sources using the same entry then the sounds may appear as missing parts for either source since the other source used that entry before.
**'''random''': An entry is chosen uniformly at random from the entries list
*Syntax: '''sequential''' or '''random'''

====+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 random range between 0 and 1. The actual volume will be picked within that range whenever a sound is played
*Optional if +nocreate is used, required otherwise
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.5 1.0)''. It is also valid to only specify one value if there should be no randomization.

====+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'''

====+Pitch:====
*Specifies which pitch values the sound may be assigned
*Optional, defaults to 1.0
*This is a random range which specifies the possible pitch values the sound may be assigned
*The actual effect of these values is very complicated to describe so you should simply test to check which values sound well. A value of 1.0 plays the sound without any changes.
*Syntax: '''(Float)''' or '''(Float Float)''', example: ''(0.9 1.1)''. It is also valid to only specify one value if there should be no randomization.

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

==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 or '''Empty''').
**'''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'''

{{Table372|
==Sound Environments==
*Allows defining custom EFX sound effects (reverb) as well as changing the default. You can then select these in FRED2, under Mission Specs - Sound Environment. Fred2 already has a bunch of default ones coded in.
}}
===#Sound Environments Start===
====$Name:====
*Lets you define a name for this preset.
*If it's "Default", it'll be applied in all missions that don't define their own.
====$Template:====
*Lets you set the EAX template which will act as a default for all subsequent settings.
*The default setting in FSO is "Hangar".
*[https://github.com/kcat/openal-soft/blob/master/include/AL/efx-presets.h The default presets available in OpenAL-Soft can be found here.] Please note that not all of them are implemented (anything not listed below the default section).
*For easy editing, simply set a template and +gain.
{{Note|
*All Subsequent settings are optional. Their default is defined by $Template:
*[https://usermanual.wiki/Pdf/Effects20Extension20Guide.90272296/view#95 The EAX Reverb manual contains detailed explenations of what all of these do if you want to fine tune them]}}
=====+Density=====
*range: 0.0 - 1.0
=====+Diffusion:=====
*linear multiplier
*range: 0.0 - 1.0
=====+Gain:=====
*gain/volume
*linear gain
*range: 0.0 - 1.0
=====+Gain HF:=====
*high frequency gain
*linear gain
*range: 0.0 - 1.0
=====+Gain LF:=====
*low frequency gain
*linear gain
*range: 0.0 - 1.0
=====+Decay time:=====
*deacy
*seconds
*range: 0.1 - 20
=====+Decay HF Ratio=====
*high frequency decay multiplier (damping)
*linear multiplier
*range: 0.1 - 20
=====+Decay LF Ratio=====
*low frequency decay multiplier
*linear multiplier
*range: 0.1 - 20
=====+reflections gain=====
*linear gain
*range: 0.0 - 3.16
=====+Reflections Delay:=====
*seconds
*range: 0.0 - 0.3
=====+Reflactions Pan:=====
*vector (0.0, 0.0, 0.0)
*magnitude
*range(s): 0.0 - 1.0
=====+Late Reverb Gain:=====
*linear gain
*range: 0.0 - 10.0
=====+Late Reverb Delay:=====
*seconds
*range: 0.0 - 0.1
=====+Late Reverb Pan:=====
*vector
*magnitude
*range(s): 0.0 - 1.0
=====+Echo Time:=====
*seconds
*range: 0.075 - 0.25
=====+Echo Depth:=====
*linear multiplier
*range: 0.0 - 1.0
=====+Modulation Time:=====
*seconds
*range: 0.004 - 4.0
=====+Modulation Depth:=====
*linear multiplier
*range: 0.0 - 1.0
=====+HF Reference:=====
*Hz
*range: 1000.0 - 20000.0
=====+LF Reference:=====
*Hz
*range: 20.0 - 1000.0 (should be 1/10th or less of HF Reference value)
=====+Room Rolloff Factor:=====
*linear multiplier
*range: 0.0 - 10.0
=====+Air Absorption Gain HF:=====
*linear gain per meter
*range: 0.892 - 1.0
=====+Decay HF Limit:=====
*boolean
===#Sound Environments 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>

*Sound Environments section
<pre>
#Sound Environments Start

; All options with default values and ranges
$Name: EFX Defaults
+Density: 1.0 ; range: 0.0 - 1.0
+Diffusion: 1.0 ; linear multiplier, range: 0.0 - 1.0
+Gain: 0.32 ; gain/volume, linear gain, range: 0.0 - 1.0
+Gain HF: 0.89 ; high frequency gain, linear gain, range: 0.0 - 1.0
+Gain LF: 0.0 ; low frequency gain, linear gain, range: 0.0 - 1.0
+Decay Time: 1.49 ; decay, seconds, range: 0.1 - 20.0
+Decay HF Ratio: 0.83 ; high frequency decay multiplier (damping), linear multiplier, range: 0.1 - 20.0
+Decay LF Ratio: 1.0 ; low frequency decay multiplier, linear multiplier, range: 0.1 - 20.0
+Reflections Gain: 0.05 ; linear gain, range: 0.0 - 3.16
+Reflections Delay: 0.007 ; seconds, range: 0.0 - 0.3
+Reflections Pan: 0.0, 0.0, 0.0 ; vector, magnitude, range(s): 0.0 - 1.0
+Late Reverb Gain: 1.26 ; linear gain, range: 0.0 - 10.0
+Late Reverb Delay: 0.011 ; seconds, range: 0.0 - 0.1
+Late Reverb Pan: 0.0, 0.0, 0.0 ; vector, magnitude, range(s): 0.0 - 1.0
+Echo Time: 0.25 ; seconds, range: 0.075 - 0.25
+Echo Depth: 0.0 ; linear multiplier, range: 0.0 - 1.0
+Modulation Time: 0.25 ; seconds, range: 0.004 - 4.0
+Modulation Depth: 0.0 ; linear multiplier, range: 0.0 - 1.0
+HF Reference: 5000.0 ; Hz, range: 1000.0 - 20000.0
+LF Reference: 250.0 ; Hz, range: 20.0 - 1000.0 (should be 1/10th or less of HF Reference value)
+Room Rolloff Factor: 0.0 ; linear multiplier, range: 0.0 - 10.0
+Air Absorption Gain HF: 0.994 ; linear gain per meter, range: 0.892 - 1.0
+Decay HF Limit: true ; boolean

; Set up an environment for subspace missions based on the EAX 'Drugged' effect
$Name: Subspace
$Template: Drugged
+Gain: 0.8
+Decay HF Ratio: 1.188
+Decay Time: 6.392

; Set the default environment to the EAX 'Hangar' effect
$Name: Default
$Template: None

#Sound Environments End
</pre>

[[Category:Tables]]

Messages.tbl

2023-10-27T17:48:17Z

-Joshua-: /* Filters */

{{TableVersion|10943}}
{{Tables}}
The '''messages.tbl''' is used to link actions, animations, and sounds of the messages received during the mission. Personas are used to group messages by the same talker, for example, all the Wingman 1 (Male Terran Pilot) messages go with a Wingman 1 persona.

Each message is composed of a text macro, and optionally a head .ani and/or an audio macro.

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

==#Message Settings==
{{Table232|
Optional settings for messages behavior}} 

===$Allow Any Ship To Send Backup Messages:===
{{Table232|
*By default, Backup messages won't play unless they have at least one filter. Enabling this option will enable backup messages globally
*Syntax: '''''boolean'''''}}

==#Message Frequencies==
{{Table3615|
Optional Group. Defines how often and how many times during the campaign the messages should be shown.}} 

===$Name:===
{{Table3615|
Required. Defines the message to augment.
*Syntax: '''String'''
*Available Values: See [[Messages.tbl#.24Name:_2|$Name in Messages.tbl]]}} 

===+Occurrence Chance:===
{{Table3615|
Optional. Defines the % chance this message will be played when the associated event occurs. For example, if you score a kill, and the '''+Occurrence Chance:''' is 10 for a Praise message, then there is a 10% chance that you a Praise message will play.
*Syntax: '''Integer'''
*Available Values: '''Between 0 and 100'''}} 

===+Maximum Count:===
{{Table3615|
Optional. Defines the maximum number of times this message will be played during a given mission.
*Syntax: '''Integer'''}} 

===+Minimum Delay:===
{{Table3615|
Optional. Defines the minimum delay time between being queue by the game and the time the message actually plays. (This helps simulate "organic" AI's)
*Syntax: '''Integer''' in milliseconds}} 

==#Moods==
{{Table3615|
Optional. You can change the mission mood using the new set-mission-mood SEXP, and those moods can be used to filter what built-in messages are played by defining a mood within a message. This section lists all available moods for use in the table and in the SEXP.}} 

===$Mood:===
{{Table3615|
Optional. The name of a mood to be attached to a message and set as a mission mood. Example: Happy, Vengeful, etc.
*Syntax: '''String'''}} 

==#End==
{{Table3615|
The moods section, if it exists, must end with #End.}}

==#Personas==
Required. The #Personas group is used to define the all of the personas used for the messages. 

===$Persona:===
Required. Defines the name of the persona
*Syntax: '''String''' 

===$Type:===
Required. Defines the type of the persona
*Syntax: '''String'''
*Available types:
::'''wingman'''
::'''support'''
::'''large'''
::'''command''' 

===+<Species>===
Optional. The +<Species> (such as '''+Vasudan''') can be used to assign personas to other species. If omitted, the Persona is assigned to the '''default''' species.
*Syntax: +'''String''' 
{{Table232|This line can now appear multiple times, allowing a persona to be used by multiple species.}}

===$Allow substitution of missing messages:===
{{Table373|Optional. This is set to true by default, meaning that in cases where a Persona does not have defined messages for all built-in message types, the engine will try to find a matching message from other personas of the same type and species.
*Syntax: '''Boolean''' }}

===$No automatic assignment:===
{{Table232|Optional. This excludes a persona from being assigned to a ship that needs to send a message but does not have a specific persona assigned.
*Syntax: '''Boolean''' }}

==#Messages==
Required. The #Messages group contains all available messages. 

===$Name:===
Required. Defines the type of the message
*Syntax: '''String'''
*Available types (types marked with '''*''' do not have code support) :
**'''All Alone'''
**'''All Clear''' *
**'''Arrive Enemy'''
**'''Attack Target'''
**'''AWACS at 25'''
**'''AWACS at 75'''
**'''Backup'''
**'''Check 6'''
**'''Death'''
**'''Depart'''
**'''Disable Target'''
**'''Disarm Target'''
**'''Docking Start''' *
**'''Engage'''
**'''Help'''
**'''Ignore Target'''
**'''Instructor Attack'''
**'''Instructor Hit'''
**'''No Target'''
**'''No'''
**'''On way'''
**'''Oops 1''' * (Only Command has code support in Retail)
**'''Permission''' *
**'''Player Dead'''
**'''Praise'''
**'''Rearm on Way'''
**'''Rearm warping in'''
**'''Rearm'''
**'''Repair Aborted'''
**'''Repair Done'''
**'''Repair'''
**'''Stray Warning Final'''
**'''Stray Warning'''
**'''Stray''' *
**'''Support Killed'''
**'''Traitor'''
**'''yes'''
{{Table3611|
**'''High Praise'''
**'''Praise Self'''
**'''Primaries Low'''}}
{{Table232|
**'''Attack Subsystem'''
**'''Cover me'''
**'''Form on my wing'''
**'''Protect Target'''}} 
{{Table232|
**The following have been deprecated. Use '''Backup''' with a '''+Wing Name:''' [[Messages.tbl#Filters|Filter]] instead.
***'''Beta Arrived'''
***'''Gamma Arrived'''
***'''Delta Arrived'''
***'''Epsilon Arrived'''}}

===$Message: and $MessageNew:===
Defines the message shown in game screen when the message is triggered. Value is a reference to [[tstrings.tbl]]. 
'''$Message:''' is used for single-line messages, while '''$MessageNew:''' is used for multi-line messages (but can also be used for single-line messages)
*'''$MessageNew:''' is preferred over '''$Message:'''
*Syntax: XSTR("'''string'''", '''integer''') 

===+Persona:===
Optional. Defines the persona associated with the message
*Syntax:
'''String''' 

===+AVI Name:===
Optional. Determines the ANI file to be played when the message is triggered.

In FSO 3.7.4 and later, the game initially attempts to use the file ''<string>''.ani with a persona message. In earlier versions, or if ''<string>''.ani does not exist, the game picks one of ''<string>''a.ani, ''<string>''b.ani and ''<string>''c.ani each time. So if you have defined ''+Avi Name: Head-Joe'', and ''Head-Joe.ani'' does not exist, the game will attempt to use the files ''Head-Joea.ani'', ''Head-Joeb.ani'' and ''Head-Joec.ani''. For wingmen personas, the ''c'' variant is assumed to be a death animation.
*Syntax: '''String''' 

===+Wave Name:===
Optional. Sets the sounds file that is played when the message is triggered
*Syntax: '''String''' 

===$Mood:===
{{Table3615|
The mood where this message should ideally be played. It may be played on other moods as long as it is not excluded for them below, if no better matching message is found.
*Syntax: '''String'''}} 

===$Exclude Mood:===
{{Table3615|
A list of moods not to play this message, ever. The list goes in parentheses. See Terran 'Attack Target' example below for usage.
*Syntax: '''String List'''}} 

===$Filter by sender:===
{{Table232|
*Applies the filters to the ship sending the message.
*Any number of filters can be used, including multiple of any type of filters.
*All filters must match for a message to be sent.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

===$Filter by subject:===
{{Table232|
*Applies the filters to the ship the message is "about". For order confirmations, the subject is the target of the order. For Praise/High Praise/Praise Self messages, it's the ship that died. For Help and Check 6, it's the attacker. For arrival messages, it's the wing leader of the arriving wing.
*Any number of filters can be used, including multiple of any type of filters.
*All filters must match for a message to be sent.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

==#End==
{{Table3615|
The very last entry must be #End. No exceptions.}} 

==#Simulated Speech Overrides==
{{Table3613|
Optional. Used to add file names to the generic message list, which defaults to 'none', 'cuevoice', 'cue_voice', 'emptymsg', 'generic', and 'msgstart'. Filenames listed below will be overridden by Text to Speech (TTS) when it is enabled, in addition to those in the default list.}} 

===$File Name:===
{{Table3613|
Optional. File name to add to the overrides list. Filenames provided here, however, must include an extension or a warning will be issues, for example msg_1.wav.
*Syntax: '''String'''}} 

==#End==
{{Table3613|
Must also end the optional Simulated Speech Overrides section with #End.}} 

==Filters==
{{Table232|
*Messages can be filtered with [[Messages.tbl#$Filter by sender:|$Filter by sender:]] or [[Messages.tbl#$Filter by subject:|$Filter by subject:]].
*These can be applied multiple times for each filer. So the following example would match Vasudan or Shivan Bombers and nothing else.
<pre>
+Species: Vasudan
+Species: Shivan
+Type: Bomber
</pre>}}

===+Ship name:===
*Matches the name of the ship
*Syntax: '''''String'''''

===+Callsign:===
*Matches the callsign of the ship
*Syntax: '''''String'''''

===+Class name:===
*Matches the class of the ship
*Respects alt-names as defined in FRED
*Syntax: '''''String'''''

===+Wing name:===
*Matches the wing that the ship is in
*Syntax: '''''String'''''

===+Species:===
*Matches the species of the ship
*Syntax: '''''String'''''

===+Type:===
*Matches the type of the ship as defined in [[objecttypes.tbl]]
*Syntax: '''''String'''''

==Sample==
This is a snippet of the retail FreeSpace 2 table, highlighting two major examples between a default (Terran) persona and a species (Vasudan) persona. Command, Support, and Large ship message examples are also included. Newer features have been added for extra clarification of their usage.
<pre>;; This is a list of moods that the game will use for builtin
;; messages. Any message without a mood is treated as General

#Moods

$Mood: Happy
$Mood: Angry
$Mood: Vengeful

#End

#Personas

$Persona: Wingman 1
$Type: wingman

$Persona: Wingman 6
$Type: wingman
+Vasudan

$Persona: Support Ship
$Type: support

$Persona: Support Ship Vasudan
$Type: support
+Vasudan

$Persona: Large Ship
$Type: large

$Persona: Large Ship Vasudan
$Type: large
+Vasudan

$Persona: Terran Command
$Type: Command

#Messages

;; ALL CLEAR ..................................................................................

$Name: All Clear
$Message: XSTR("Command, we have secured the area.", 2725)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_allclear.wav

$Name: All Clear
$Message: XSTR("All enemy forces negated.", 2730)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_allclear.wav

;; ARRIVAL (Enemy) ...................................................................

$Name: Arrive Enemy
$Message: XSTR("Bandits incoming!", 1079)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Reading hostile indicators.", 2734)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Incoming jump signature! Hostile configuration!", 2736)
+Persona: Terran Command
+Avi Name: Head-CM2
+Wave Name: TC_arrival.wav

;; ATTACK MY TARGET ...........................................................................

$Name: Attack Target
$Message: XSTR("Roger that, sir. Engaging your target.", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav

$Name: Attack Target
$Message: XSTR("Yes sir, I'll make the bastards pay for Capella!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav
$Mood: Vengeful
$Exclude Mood: ( "Happy" )

$Name: Attack Target
$Message: XSTR("Yes sir. I just love killing Shivans!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav
$Mood: Angry
$Exclude Mood: ( "Angry" "Vengeful" )

$Name: Attack Target
$Message: XSTR("Affirmative. We will destroy your target.", 2742)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_attack.wav

;; BACKUP ARRIVAL (previously named "REINFORCEMENTS") .........................................

$Name: Backup
$Message: XSTR("Reinforcements on station. Request status brief.", 2744)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_backup.wav

$Name: Backup
$Message: XSTR("We are here to assist. What is your status?", 2749)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_backup.wav

;; BETA WING ARRIVAL ..........................................................................

$Name: Beta Arrived
$Message: XSTR("Beta wing here. Standing by.", 2751)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_beta.wav

$Name: Beta Arrived
$Message: XSTR("Beta wing is on station.", 2756)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_beta.wav

;; CHECK YOUR SIX .............................................................................

$Name: Check 6
$Message: XSTR("Check your six!", 2758)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Check6.wav

$Name: Check 6
$Message: XSTR("Take evasive action, pilot!", 2763)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Check6.wav

;; DEATH (previously wingman scream)...................................................

$Name: Death
$Message: XSTR("Noooooooo!!!", 2765)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Death.wav

$Name: Death
$Message: XSTR("Avenge me!", 2770)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Death.wav

;; DELTA WING ARRIVAL .........................................................................

$Name: Delta Arrived
$Message: XSTR("This is Delta wing. What's your status?", 2772)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Delta.wav

$Name: Delta Arrived
$Message: XSTR("Delta wing is ready to assist, pilot.", 2777)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Delta.wav

;; DEPART (previously named "WARPOUT") ........................................................

$Name: Depart
$Message: XSTR("Yes, sir! I'm outta here!", 2779)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2784)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

$Name: Depart
$Message: XSTR("I copy. Engaging jump drive now.", 2786)
+Persona: Support Ship
+Avi Name: Head-TP3
+Wave Name: S_depart.wav

$Name: Depart
$Message: XSTR("Departing field of engagement.", 2787)
+Persona: Support Ship Vasudan
+Avi Name: Head-VP2
+Wave Name: VS_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2788)
+Persona: Large Ship Vasudan
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

;; DISABLE TARGET .............................................................................

$Name: Disable Target
$Message: XSTR("Roger that, sir. Disabling your target.", 2789)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disable.wav

$Name: Disable Target
$Message: XSTR("Affirmative. Disabling your target.", 2794)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disable.wav

;; DISARM TARGET ..............................................................................

$Name: Disarm Target
$Message: XSTR("Yes, sir! Targeting weapons now!", 2796)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disarm.wav

$Name: Disarm Target
$Message: XSTR("Acknowledged. Weapon subsystem targeted. ", 2801)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disarm.wav

#End

#Simulated Speech Overrides

$File Name: msg_1.wav
$File Name: msg_2.wav
$File Name: msg_3.wav
$File Name: msg_4.wav
$File Name: msg_5.wav
$File Name: msg_6.wav

#End</pre>
[[Category:Tables]]

Messages.tbl

2023-10-27T17:47:37Z

-Joshua-: /* Filters */

{{TableVersion|10943}}
{{Tables}}
The '''messages.tbl''' is used to link actions, animations, and sounds of the messages received during the mission. Personas are used to group messages by the same talker, for example, all the Wingman 1 (Male Terran Pilot) messages go with a Wingman 1 persona.

Each message is composed of a text macro, and optionally a head .ani and/or an audio macro.

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

==#Message Settings==
{{Table232|
Optional settings for messages behavior}} 

===$Allow Any Ship To Send Backup Messages:===
{{Table232|
*By default, Backup messages won't play unless they have at least one filter. Enabling this option will enable backup messages globally
*Syntax: '''''boolean'''''}}

==#Message Frequencies==
{{Table3615|
Optional Group. Defines how often and how many times during the campaign the messages should be shown.}} 

===$Name:===
{{Table3615|
Required. Defines the message to augment.
*Syntax: '''String'''
*Available Values: See [[Messages.tbl#.24Name:_2|$Name in Messages.tbl]]}} 

===+Occurrence Chance:===
{{Table3615|
Optional. Defines the % chance this message will be played when the associated event occurs. For example, if you score a kill, and the '''+Occurrence Chance:''' is 10 for a Praise message, then there is a 10% chance that you a Praise message will play.
*Syntax: '''Integer'''
*Available Values: '''Between 0 and 100'''}} 

===+Maximum Count:===
{{Table3615|
Optional. Defines the maximum number of times this message will be played during a given mission.
*Syntax: '''Integer'''}} 

===+Minimum Delay:===
{{Table3615|
Optional. Defines the minimum delay time between being queue by the game and the time the message actually plays. (This helps simulate "organic" AI's)
*Syntax: '''Integer''' in milliseconds}} 

==#Moods==
{{Table3615|
Optional. You can change the mission mood using the new set-mission-mood SEXP, and those moods can be used to filter what built-in messages are played by defining a mood within a message. This section lists all available moods for use in the table and in the SEXP.}} 

===$Mood:===
{{Table3615|
Optional. The name of a mood to be attached to a message and set as a mission mood. Example: Happy, Vengeful, etc.
*Syntax: '''String'''}} 

==#End==
{{Table3615|
The moods section, if it exists, must end with #End.}}

==#Personas==
Required. The #Personas group is used to define the all of the personas used for the messages. 

===$Persona:===
Required. Defines the name of the persona
*Syntax: '''String''' 

===$Type:===
Required. Defines the type of the persona
*Syntax: '''String'''
*Available types:
::'''wingman'''
::'''support'''
::'''large'''
::'''command''' 

===+<Species>===
Optional. The +<Species> (such as '''+Vasudan''') can be used to assign personas to other species. If omitted, the Persona is assigned to the '''default''' species.
*Syntax: +'''String''' 
{{Table232|This line can now appear multiple times, allowing a persona to be used by multiple species.}}

===$Allow substitution of missing messages:===
{{Table373|Optional. This is set to true by default, meaning that in cases where a Persona does not have defined messages for all built-in message types, the engine will try to find a matching message from other personas of the same type and species.
*Syntax: '''Boolean''' }}

===$No automatic assignment:===
{{Table232|Optional. This excludes a persona from being assigned to a ship that needs to send a message but does not have a specific persona assigned.
*Syntax: '''Boolean''' }}

==#Messages==
Required. The #Messages group contains all available messages. 

===$Name:===
Required. Defines the type of the message
*Syntax: '''String'''
*Available types (types marked with '''*''' do not have code support) :
**'''All Alone'''
**'''All Clear''' *
**'''Arrive Enemy'''
**'''Attack Target'''
**'''AWACS at 25'''
**'''AWACS at 75'''
**'''Backup'''
**'''Check 6'''
**'''Death'''
**'''Depart'''
**'''Disable Target'''
**'''Disarm Target'''
**'''Docking Start''' *
**'''Engage'''
**'''Help'''
**'''Ignore Target'''
**'''Instructor Attack'''
**'''Instructor Hit'''
**'''No Target'''
**'''No'''
**'''On way'''
**'''Oops 1''' * (Only Command has code support in Retail)
**'''Permission''' *
**'''Player Dead'''
**'''Praise'''
**'''Rearm on Way'''
**'''Rearm warping in'''
**'''Rearm'''
**'''Repair Aborted'''
**'''Repair Done'''
**'''Repair'''
**'''Stray Warning Final'''
**'''Stray Warning'''
**'''Stray''' *
**'''Support Killed'''
**'''Traitor'''
**'''yes'''
{{Table3611|
**'''High Praise'''
**'''Praise Self'''
**'''Primaries Low'''}}
{{Table232|
**'''Attack Subsystem'''
**'''Cover me'''
**'''Form on my wing'''
**'''Protect Target'''}} 
{{Table232|
**The following have been deprecated. Use '''Backup''' with a '''+Wing Name:''' [[Messages.tbl#Filters|Filter]] instead.
***'''Beta Arrived'''
***'''Gamma Arrived'''
***'''Delta Arrived'''
***'''Epsilon Arrived'''}}

===$Message: and $MessageNew:===
Defines the message shown in game screen when the message is triggered. Value is a reference to [[tstrings.tbl]]. 
'''$Message:''' is used for single-line messages, while '''$MessageNew:''' is used for multi-line messages (but can also be used for single-line messages)
*'''$MessageNew:''' is preferred over '''$Message:'''
*Syntax: XSTR("'''string'''", '''integer''') 

===+Persona:===
Optional. Defines the persona associated with the message
*Syntax:
'''String''' 

===+AVI Name:===
Optional. Determines the ANI file to be played when the message is triggered.

In FSO 3.7.4 and later, the game initially attempts to use the file ''<string>''.ani with a persona message. In earlier versions, or if ''<string>''.ani does not exist, the game picks one of ''<string>''a.ani, ''<string>''b.ani and ''<string>''c.ani each time. So if you have defined ''+Avi Name: Head-Joe'', and ''Head-Joe.ani'' does not exist, the game will attempt to use the files ''Head-Joea.ani'', ''Head-Joeb.ani'' and ''Head-Joec.ani''. For wingmen personas, the ''c'' variant is assumed to be a death animation.
*Syntax: '''String''' 

===+Wave Name:===
Optional. Sets the sounds file that is played when the message is triggered
*Syntax: '''String''' 

===$Mood:===
{{Table3615|
The mood where this message should ideally be played. It may be played on other moods as long as it is not excluded for them below, if no better matching message is found.
*Syntax: '''String'''}} 

===$Exclude Mood:===
{{Table3615|
A list of moods not to play this message, ever. The list goes in parentheses. See Terran 'Attack Target' example below for usage.
*Syntax: '''String List'''}} 

===$Filter by sender:===
{{Table232|
*Applies the filters to the ship sending the message.
*Any number of filters can be used, including multiple of any type of filters.
*All filters must match for a message to be sent.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

===$Filter by subject:===
{{Table232|
*Applies the filters to the ship the message is "about". For order confirmations, the subject is the target of the order. For Praise/High Praise/Praise Self messages, it's the ship that died. For Help and Check 6, it's the attacker. For arrival messages, it's the wing leader of the arriving wing.
*Any number of filters can be used, including multiple of any type of filters.
*All filters must match for a message to be sent.
*Syntax: See [[Messages.tbl#Filters|Filters]]}}

==#End==
{{Table3615|
The very last entry must be #End. No exceptions.}} 

==#Simulated Speech Overrides==
{{Table3613|
Optional. Used to add file names to the generic message list, which defaults to 'none', 'cuevoice', 'cue_voice', 'emptymsg', 'generic', and 'msgstart'. Filenames listed below will be overridden by Text to Speech (TTS) when it is enabled, in addition to those in the default list.}} 

===$File Name:===
{{Table3613|
Optional. File name to add to the overrides list. Filenames provided here, however, must include an extension or a warning will be issues, for example msg_1.wav.
*Syntax: '''String'''}} 

==#End==
{{Table3613|
Must also end the optional Simulated Speech Overrides section with #End.}} 

==Filters==
{{Table232|
*Messages can be filtered with [[Messages.tbl#$Filter by subject:|$Filter by sender:]] or [[Messages.tbl#$Filter by subject:|$Filter by subject:]].
*These can be applied multiple times for each filer. So the following example would match Vasudan or Shivan Bombers and nothing else.
<pre>
+Species: Vasudan
+Species: Shivan
+Type: Bomber
</pre>}}

===+Ship name:===
*Matches the name of the ship
*Syntax: '''''String'''''

===+Callsign:===
*Matches the callsign of the ship
*Syntax: '''''String'''''

===+Class name:===
*Matches the class of the ship
*Respects alt-names as defined in FRED
*Syntax: '''''String'''''

===+Wing name:===
*Matches the wing that the ship is in
*Syntax: '''''String'''''

===+Species:===
*Matches the species of the ship
*Syntax: '''''String'''''

===+Type:===
*Matches the type of the ship as defined in [[objecttypes.tbl]]
*Syntax: '''''String'''''

==Sample==
This is a snippet of the retail FreeSpace 2 table, highlighting two major examples between a default (Terran) persona and a species (Vasudan) persona. Command, Support, and Large ship message examples are also included. Newer features have been added for extra clarification of their usage.
<pre>;; This is a list of moods that the game will use for builtin
;; messages. Any message without a mood is treated as General

#Moods

$Mood: Happy
$Mood: Angry
$Mood: Vengeful

#End

#Personas

$Persona: Wingman 1
$Type: wingman

$Persona: Wingman 6
$Type: wingman
+Vasudan

$Persona: Support Ship
$Type: support

$Persona: Support Ship Vasudan
$Type: support
+Vasudan

$Persona: Large Ship
$Type: large

$Persona: Large Ship Vasudan
$Type: large
+Vasudan

$Persona: Terran Command
$Type: Command

#Messages

;; ALL CLEAR ..................................................................................

$Name: All Clear
$Message: XSTR("Command, we have secured the area.", 2725)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_allclear.wav

$Name: All Clear
$Message: XSTR("All enemy forces negated.", 2730)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_allclear.wav

;; ARRIVAL (Enemy) ...................................................................

$Name: Arrive Enemy
$Message: XSTR("Bandits incoming!", 1079)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Reading hostile indicators.", 2734)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Incoming jump signature! Hostile configuration!", 2736)
+Persona: Terran Command
+Avi Name: Head-CM2
+Wave Name: TC_arrival.wav

;; ATTACK MY TARGET ...........................................................................

$Name: Attack Target
$Message: XSTR("Roger that, sir. Engaging your target.", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav

$Name: Attack Target
$Message: XSTR("Yes sir, I'll make the bastards pay for Capella!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav
$Mood: Vengeful
$Exclude Mood: ( "Happy" )

$Name: Attack Target
$Message: XSTR("Yes sir. I just love killing Shivans!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav
$Mood: Angry
$Exclude Mood: ( "Angry" "Vengeful" )

$Name: Attack Target
$Message: XSTR("Affirmative. We will destroy your target.", 2742)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_attack.wav

;; BACKUP ARRIVAL (previously named "REINFORCEMENTS") .........................................

$Name: Backup
$Message: XSTR("Reinforcements on station. Request status brief.", 2744)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_backup.wav

$Name: Backup
$Message: XSTR("We are here to assist. What is your status?", 2749)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_backup.wav

;; BETA WING ARRIVAL ..........................................................................

$Name: Beta Arrived
$Message: XSTR("Beta wing here. Standing by.", 2751)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_beta.wav

$Name: Beta Arrived
$Message: XSTR("Beta wing is on station.", 2756)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_beta.wav

;; CHECK YOUR SIX .............................................................................

$Name: Check 6
$Message: XSTR("Check your six!", 2758)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Check6.wav

$Name: Check 6
$Message: XSTR("Take evasive action, pilot!", 2763)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Check6.wav

;; DEATH (previously wingman scream)...................................................

$Name: Death
$Message: XSTR("Noooooooo!!!", 2765)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Death.wav

$Name: Death
$Message: XSTR("Avenge me!", 2770)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Death.wav

;; DELTA WING ARRIVAL .........................................................................

$Name: Delta Arrived
$Message: XSTR("This is Delta wing. What's your status?", 2772)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Delta.wav

$Name: Delta Arrived
$Message: XSTR("Delta wing is ready to assist, pilot.", 2777)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Delta.wav

;; DEPART (previously named "WARPOUT") ........................................................

$Name: Depart
$Message: XSTR("Yes, sir! I'm outta here!", 2779)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2784)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

$Name: Depart
$Message: XSTR("I copy. Engaging jump drive now.", 2786)
+Persona: Support Ship
+Avi Name: Head-TP3
+Wave Name: S_depart.wav

$Name: Depart
$Message: XSTR("Departing field of engagement.", 2787)
+Persona: Support Ship Vasudan
+Avi Name: Head-VP2
+Wave Name: VS_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2788)
+Persona: Large Ship Vasudan
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

;; DISABLE TARGET .............................................................................

$Name: Disable Target
$Message: XSTR("Roger that, sir. Disabling your target.", 2789)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disable.wav

$Name: Disable Target
$Message: XSTR("Affirmative. Disabling your target.", 2794)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disable.wav

;; DISARM TARGET ..............................................................................

$Name: Disarm Target
$Message: XSTR("Yes, sir! Targeting weapons now!", 2796)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disarm.wav

$Name: Disarm Target
$Message: XSTR("Acknowledged. Weapon subsystem targeted. ", 2801)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disarm.wav

#End

#Simulated Speech Overrides

$File Name: msg_1.wav
$File Name: msg_2.wav
$File Name: msg_3.wav
$File Name: msg_4.wav
$File Name: msg_5.wav
$File Name: msg_6.wav

#End</pre>
[[Category:Tables]]

Ships.tbl

2023-10-18T22:20:15Z

-Joshua-: /* $Alt Name: */

{{TableVersionGit|2022-10-07 UTC|0dfed6de4be6747fcbcf9c35f8c35996d9d7259b}}
{{Tables}}
The '''ships.tbl''' defines all the ship classes used in FSO.

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

See the article [[Subsystem]] for ship table information that is specific to subsystems.

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
{{Table202|
:*<nowiki>#</nowiki>'''Wing Formations'''
:**Includes the list of custom wingmate formations}}
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] a name can be followed by the line '''+nocreate''' to prevent the game from creating an incomplete entry with very few valid fields. If the entry does not already exist (either in ships.tbl or in earlier parsed *-shp.tbm files), the modular entry is skipped.}}

===+remove===
{{Table210|
*In [[Modular Tables]] a name can be followed by the line '''+remove''' to completely remove a previously parsed entry.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*This setting does nothing
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature, when originally introduced, caused crashes and memory issues. Between 2014/07/24 and 2015/8/20, it was removed from the codebase. In short: do not use in versions prior to 3.7.4.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===+Use Ship as Template:===
{{Table232|
*Creates a copy of the specified ship to use as a base for this ship.
*'''''Caution!''''' This is highly dependent on the order the tables are loaded. If the ship used as a template is modified using <tt>+nocreate</tt>, the tabled changes will only be applied to the newly created ship if they are loaded ''before'' <tt>+Use Ship as Template</tt>. Any <tt>+nocreate</tt> changes ''after'' <tt>+Use Ship as Template</tt> will not have any effect on the newly created ship class. Thus, proper templates should be preferred if possible.
*Cannot be used in conjunction with <tt>+Use Template</tt>.
*Syntax: '''''String''''', name of the ship class to use as a template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship. Used to rename ships without breaking missions.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -ship_choice_3d commandline flag is enabled or no ani can be found for the selected ship.
*Syntax: String, either "FS1", or "Off". This defaults to the FS2 effect.}}

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===$Cockpit Animations:===
{{Table230|
*Allows specifying animations that only run on the cockpit model of a ship
*See [[#$Animations:|$Animations]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Cockpit Moveables:===
{{Table230|
*Allows specifying moveables that only run on the cockpit model of a ship
*See [[#$Moveables:|$Moveables]]
*Syntax: '''''( "String" "String" )''''', names of the moveable animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$POF file Techroom:===
*Filename of the model file (.pof) at data/models folder; used only in the weapon loadout screen
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

===$POF Target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of target model used in the HUD targetbox
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$Collision LOD:===
{{Table373|
*Defines an alternative LOD (Level-Of-Detail) to use for collision detection. Using this can increase performance without visible drawbacks if the LOD chosen has much simpler geometry but the shape still closely matches the base model.
*This works as follows: collision detection proceeds normally through the various model/submodel radius and bounding box checks based on LOD0, but when the game decides to perform a mesh-based collision check of a given submodel, it will use the submodel's LOD mesh instead. However, all submodels do not need to have a counterpart in the given LOD; if one is not found, the closest alternative will automatically be used instead.
*For example, if ''$Collision LOD: 3'' is used and the submodel engine01a is checked for a hit, the game will attempt to use the mesh of engine01d instead. However, if there is no engine01d submodel, the game will find the closest alternative: it'll look for engine01c, then engine01b, and finally fall back to engine01a. Note the implications of for example the root LOD submodel (detaild, detail3, etc) including the geometry of subsystem submodels; if detail0 is checked for a collision before engine01a, and detail3 includes the engine geometry (as opposed to having it in engine01d), then the subsystem engine01a cannot be hit.
**Syntax: '''''Integer'''''}}

===$ND:===
NOTE: this option has done nothing since before 2008

*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}
{{Table202|
====+Collision Sound Light:====
Sound when this ship collides normally.
====+Collision Sound Heavy:====
Sound when this ship collides at high speed.
====+Collision Sound Shielded:====
Sound when this ship collides with shields active.
}}

===$Gravity Const:===
{{Table224|
**If the mission has gravity, this is the multiplier applied to acceleration from gravity on the ship.
**Note that due to the exponential damping from $Damp, the acceleration from gravity will eventually even out with $Damp and result in a constant velocity in the direction of gravity.
**Syntax: '''''Float'''''}}

===$Dying Gravity Const:===
{{Table224|
**Same as above, but while ths ship is dying/in death roll.
**The aforementioned exponential damp is still in effect during this time, but it is weaker.
**Syntax: '''''Float'''''
**Default: The same as $Gravity Const:}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}
{{Table224|
*'''+Debris Gravity Const:'''
**If the mission has gravity, this is the multiplier applied to acceleration from gravity on the ship's debris.
**Syntax: '''''Float'''''
**Default: The same as $Dying Gravity Const}}
{{Table202|
*'''+Ambient Sound:'''
**The sound played in the vicinity of debris.}}
{{Table212|
*'''+Generic Debris POF file:'''
**The filename of the ship's generic debris, by default debris01.pof.
**Big or huge ships do not normally have generic debris, but if this is specified for them, they will generate generic debris on explosion.
**Syntax: '''''String'''
*'''+Generic Debris Spew Num:'''
**How many generic debris fragments to generate when the ship explodes.
**If this is a big or huge ship, this is the number of generic debris fragments to generate for every individual propagating explosion.
**Syntax: '''''Integer'''
**Default: ''20''}}

===$Density:===
*Multiplies the mass and moment of inertia of the relevant ship.
*Ships with a high mass and moment of inertia will be moved/rotated by collisions and impacts less strongly.
*Syntax: '''''Float''''', usually 1. Must not be 0.

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

*Syntax: '''''Float'''''

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Player Minimum Velocity:===
{{Table38|
*Defines minimum velocities on x (left/right), y (up/down), and z (forward) -axis (respectively). This affects the player only, the AI ignores the value.
*The x and y velocities are considered slide velocities, the minimums for them are '''not currently implemented'''.
*When gliding, if the absolute speed vector of the players ship falls below the minimum then the ships engines will re-engage and cannot be switched off again until the ships absolute vector exceeds the z-minimum.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 40.0''
}}

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go.
*If negative, there is no glide cap (allowing practically infinite maximum gliding speed), but only for the player, the AI will act as though it is still 0.
*Syntax: '''''Float'''''
*Defaults to 0.}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode.
**If > 0, sets a fixed acceleration rate in glide mode: ships will accelerate at their tabled maximum velocity along the given axis, interpreted in m/s^2, multiplied by ''+Glide Accel Mult:''.
**If set to 0, impossible to accelerate while in glide mode.
**If negative, enables glide speed ramping: acceleration in glide mode ramps using the same constants as in normal flight. Note, however, that glide acceleration ignores the ship's ''$Damp:'' value, so glide acceleration will always be faster than in normal flight; and if the damping constant is significantly larger than the acceleration constant along a given axis, this difference will become very pronounced.
*Syntax: '''''Float'''''
*Default: ''0''}}
{{Table3610|
*Entry exists as a dummy entry which doesn't do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===+Primary Bank Autoaim FOV:===
{{Table232|
*Defines the autoaim for the primary bank.
*Can be listed once for each existing bank on the ship.
*Syntax: '''''Float'''''}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence
{{Note|If none of the following optional strings are added, the weapon will not converge. Don't forget to use them.}}
}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
:*''Fireballl Unique ID'' - Uses the default mechanics but replaces the portal effect with the identified fireball.
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
:*''Fireballl Unique ID'' - Uses the default mechanics but replaces the portal effect with the identified fireball.
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, [[Game_settings.tbl#.24Minimum player warpout time:|defaults to]] 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship has many smaller explosions while in its death-roll. Also determines whether the ship splits in two or not unless explicitly set below.
*Syntax: '''''Boolean''''', yes or no

===$Expl Splits Ship:===
{{Table202|
*Whether the ship splits in two and slowly explodes outward towards its front and back, or just immediately explodes into debris.
*Syntax: '''''Boolean''''', yes or no, defaults to the value of '$Expl Propagates:' above}}

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Death Roll Rotation Multiplier:===
{{Table202|
*Multiplies the strength of the rotation imparted by death-rolling.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Death Roll X rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on X-axis (pitch) rotation during the ships deathroll. The value is radians per second. The current hard-coded minimum is 0.8. Note the code generally won't use this value for ships with radius > 150 (hard-coded).
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Y rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Y-axis (yaw) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Z rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Z-axis (roll) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used the final explosion of this ship type,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Ship Death Particles'' is not a valid option!
}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization, 0 to 100}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the ship explosions
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave Name:===
{{Table3610|
*Defines the name of the animation to used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Shockwave Sound:===
{{Table202|
Optional sound to be used for the sound heard when for the ship explosion shockwave (default is sound 109).
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''
*Note: This requires the [[Weapons.tbl#.24External_Model_File:|$External_Model_File entry to be defined in weapons.tbl]]. Weapons without external models will revert to the standard behaviour.
*Behavior is as follows:
**If your bank carries fewer or as many missiles as the number of gunpoints on your bank, you will have exactly as many external model shown as you have missiles left in your bank (going in the order of gunpoints defined in the POF). External models will disappear when missiles are fired.
**If your bank carries more missiles than you have gunpoints in your bank, then external models will "recoil" (to simulate a reloading animation) every time you fire, and will disappear based on the % of missile left in the bank. Example: you have 2 gunpoints and 4 missiles, the first external model will disappear after you fire the second missile.
**If your weapon uses the [[Weapons.tbl#.22external_model_launcher.22|"external_model_launcher" flag]], then the model will be displayed on all gunpoints and will not recoil nor disappear when fired.}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Minimum Weapon Span:====
{{Table373|
*Determines the minimum distance weapons must have traveled before impacting the shield (for example if fired close to or inside the shield). Does not affect whether the weapon bypasses shields, unless +Allow Bypass (see below) is set to ''YES''. Only valid with auto spread shields.
*Syntax: '''''Float''''', defaults to the shield thickness.}}

====+Allow Bypass:====
{{Table371|
*Determines whether weapons which impact on the ship's hull (see +Minimum Weapon Span above) will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean'''''
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Shield Impact Explosion:===
{{Table373|
*Impact explosion animation to trigger when this ship's shields are hit. Works identically for all shield types.
*Note: The size of the explosion is defined by the weapon, see [[Weapons.tbl#.24Shield_Impact_Explosion_Radius:]].
*Syntax: '''''String''''', filename or ''none''
}}

===$Max Shield Recharge:===
{{Table373|
*Determines a maximum recharge limit of shields. When used, the combined maximum shield energy is lowered, meaning that shield energy can be moved between quadrants even with shields fully charged.
*Syntax: '''''Float''''', multiplier ranging from 0.0 to 1.0, defaults to 1.0
**Example: ''$Max Shield Recharge: 0.5'' caps the combined shield energy to 50%, meaning that a ship with 4 shield quadrants will by default have 12.5% strength on all quadrants (instead of normal 25%), allowing it to for example augment one quadrant to 50% while dropping other quadrants to 0%.
}}

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014-12-29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''
*Affected by ETS Shields value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Shield Recharge Scale:}}

===+Shield Regen Hit Delay:===
{{Table214|
*Specifies a time delay after being hit by a weapon before the shield may begin regenerating again.
*Syntax: '''''Float''''', seconds}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''
*Affected by ETS Guns value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Weapon Recharge Scale:}}

===$Shield to Weapon Transfer Quantity:===
{{Table202|
*The fraction of ''maximum'' shield capacity to use when making direct shield -> weapon energy transfers.
*Syntax: '''''Float'''''
**Default: ''0.2''
*'''Note:''' default direct transfers have a large and poorly-appreciated impact on ETS balancing. If you care about balancing your ship's weapon and shield recharge rates you are advised to set this to 0.}}

===$Shield to Weapon Transfer Efficiency:===
{{Table202|*The fraction of the transferred shield energy that will actually end up in the weapon capacitor.
*Syntax: '''''Float'''''
**Default: ''1.0''
*Note that the amount deposited will be absolute, not relative. For instance, for a ship with 100 weapon energy and 200 shields and default quantity and efficiency, a shield->weapon transfer will deduct 40 shield energy and add 40 weapon energy. It is entirely possible for efficiency to be more than 1.0.
*Unless transfer efficiency is tuned to account for the different charge rates for weapons and shields, direct transfers will tend to make the ETS unbalanced in the hands of an experienced player, as in retail.}}

===$Shield to Weapon Transfer Speed:===
{{Table202|*The rate at which transferred energy will move into the weapon capacitor,
*Syntax: '''''Float'''''
**Default:''0.04''
*When energy is transferred it is instantly deducted from shields, but it must 'trickle' into the weapon capacitor at a fixed fraction per second. This acts as a second bonus recharge on top of whatever the ETS produces.}}

===$Weapon to Shield Transfer Quantity:===

===$Weapon to Shield Transfer Efficiency:===

===$Weapon to Shield Transfer Speed:===

{{Table202|As above, but with the transfer direction reversed.}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', percentage of hitpoints repaired per second}}

===$Hull Self Repair Maximum:===
{{Table220|
*Maximum percentage of total hull strength that the hull will self-repair to.
*Syntax: '''''Float''''', percentage of hull hitpoints}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', percentage of total subsystem hitpoints repaired per second}}

===$Subsystem Self Repair Maximum:===
{{Table220|
*Maximum percentage of total subsystem strength that subsystems will self-repair to.
*Syntax: '''''Float''''', percentage of subsystems hitpoints}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds
====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}
====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Exact fuel recharged per second is given by the ETS value (as a percentage of total power output) multiplied by twice the tabled recharge rate, and then multiplied by the difficulty setting.
*Syntax: '''''Float''''', fuel units per second
====+Aburn Minimum Start Fuel:====
{{Table202|
*Minimum afterburner fuel the ship must have before allowed to afterburn.
*Syntax: '''''Float''''', fuel}}
====+Aburn Minimum Fuel to Burn:====
{{Table202|
*Forces the ship to afterburn until at least this much fuel is used, or it runs out of fuel.
*Syntax: '''''Float''''', fuel}}
====+Aburn Cooldown Time:====
{{Table202|
*How much time must have elapsed since the last afterburn finished to allow afterburning again.
*Syntax: '''''Float''''', seconds}}
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
{{Table212|
=====+Bitmap Stretch:=====
*Multiplies how far the bitmap is stretched over each trail segment.
*Syntax: '''''Float'''''
**Default:''1''}}
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
{{Table212|
=====+Alpha Decay Exponent:=====
*Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
*Smaller numbers below 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Larger numbers above 1 cause it to fade away quickly at first, and then slow down for most of its life.
*Syntax: '''''Float''''', positive
**Default:''1''}}
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table202|
=====+Spread:=====
*Causes the trail points to diffuse and drift apart at this speed over time.
*Syntax: '''''Float''''', meters per second}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$Scan range Normal:===
{{Table381|
*Distance at which the ship can scan other small ships or large ship subsystems
*Syntax: '''''Float''''', distance
}}

===$Scan range Capital:===
{{Table381|
*Distance at which the ship can scan capital (& similar size) ships
*Syntax: '''''Float''''', distance
}}

===$Scanning time multiplier:===
{{Table220|
*A factor to apply to scan time when this ship is doing the scanning
*Syntax: '''''Float'''''
}}

===$Scanning range multiplier:===
{{Table220|
*A factor to apply to scan distance when this ship is doing the scanning
*Syntax: '''''Float'''''
}}

===$Ask Help Shield Percent:===
{{Table381|
*Percentage of shield damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$Ask Help Hull Percent:===
{{Table381|
*Percentage of hull damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Flyby Sound===
{{Table382|
*Optional sound to be used for the fly-by sound
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$DeathRollSnd===
{{Table202|
*Optional sound to be used for the sound heard when the ship enters its death roll
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ExplosionSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the ship explodes
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SubsysExplosionSnd===
{{Table202|
*Optional sound to be used for the sound heard when a subsystem on this ship explodes
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_pos:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). The position of the camera relative to the model in the tech room and the target box view. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_zoom:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). How far the camera's zoomed in, defines camera's FOV. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Float''''', radians

{{Table381|
===$Closeup_pos_targetbox:===
*Optional value to set for the position of the camera relative to the model in the HUD target box view. If not set then the value for $Closeup_pos: will be used.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_zoom_targetbox:===
*Optional value to set how the model will show in the HUD target box view. How far the camera's zoomed in, defines camera's FOV. If not set then the value for $Closeup_zoom: will be used.
*Syntax: '''''Float''''', radians
}}

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Chase View Offset:===
{{Table214|
*Specifies a custom camera position when the ship is being viewed in the chase camera.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively in meters}}

===$Chase View Rigidity:===
{{Table214|
*Specifies how 'rigidly' the camera adheres to the 'rest' position of the chase view camera when doing maneuvers or changing speed.
*Syntax: '''''Float'''''
** Defaults to 5.0.}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table214|
===$Wingmen Gauge Dot Override:===
*(Optional) Defines an animation to use for the dots in the wingmen status gauge. Overrides 'Dot Filename:' under the '+Wingman Status:' entry in [[Hud_gauges.tbl#.2BWingman_Status:|Hud_gauges.tbl]]
*Must be an animation with two frames.
*Syntax: '''''String''''', filename
}}

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
{{Table212|
====+Alpha Decay Exponent:====
*Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
*Smaller numbers below 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Larger numbers above 1 cause it to fade away quickly at first, and then slow down for most of its life.
*Syntax: '''''Float''''', positive
**Default:''1''}}
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
{{Table202|
=====+Spread:=====
*Causes the trail points to diffuse and drift apart at this speed over time.
*Syntax: '''''Float''''', meters per second}}
====+Spew Time:====
*Time in milliseconds to create new trail points, lower means less 'jagged' trails.
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table212|
====+Bitmap Stretch:====
*Multiplies how far the bitmap is stretched over each trail segment.
*Syntax: '''''Float'''''
**Default:''1''}}
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
{{Table230|
**This field may be omitted, and the activation of the thruster will be calculated automatically based on its position and direction.
}}
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
***THESE NAMES MAY BE MISLEADING FOR YOU.
***'Roll left' and 'Roll right' are actually yaw, activated when the ship rotates around its top-bottom axis.
***'Bank left' and 'Bank right' are actually roll, activated when the ship rotates around its front-back axis.
{{Table232|
***'Yaw left' and 'Yaw right' are now valid strings for this field. 'Roll left' and 'Roll right' are still recognized for compatibility.
}}
**Syntax: '''''("String" "String")'''''
**Allows one or more strings, does not have a set limit.
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
{{Table220|
====+arrival rvec:====
*When using this path to arrive via fighterbay, the arriving ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to arrive via fighterbay.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}
====+departure rvec:====
*When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Passive Lightning Arcs:===
{{Table220|
*Creates a 'lightning arc' between two points on the ship's hull, like when the ship is EMP'd or damaged, but naturally and fixed to two points on the ship.
*This section can be repeated.
*'''All subfields are required'''
====+Submodel 1:====
*The name of the name of the submodel the first end is connected to.
*Note that the arc will ''not'' move along with a submodel while it is animating (but it will be initially created in the correct position). In the case of an animating submodel, it is recommended to use very short durations/frequencies.
**Syntax: '''''String'''''
====+Position 1:====
*The position on the ship this end is attached to, relative to the origin of the entire ship.
**Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively
====+Submodel 2:====
====+Position 2:====
*The same as the above for the other end of the arc.
====+Duration:====
*How long the arc persists while active.
**Syntax: '''''Float''''', seconds
====+Frequency:====
*How long after creating an arc it should wait before creating another.
**Syntax: '''''Float''''', seconds}}
{{Table224|
====+Primary color 1:====
*The first primary color of the arc, chosen randomly between color 1 and 2.
**Syntax: three '''''Integers''''', 0-255
====+Primary color 2:====
*The second primary color of the arc, chosen randomly between color 1 and 2.
**Syntax: three '''''Integers''''', 0-255
====+Secondary color:====
*The secondary color of the arc. This is the inner color, usually close to white.
**Syntax: three '''''Integers''''', 0-255}}

===$Animations:===
{{Table220|
*The new way of specifying triggered animations, replacing the subsystem-based definitions
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Animation Moveables:===
{{Table220|
*Like $Animations: but for specific in-mission adjustable moveable animations.
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the moveable animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Custom data:===
{{Table220|
Defines a set of custom data that for this ship class, which can then be accessed through Lua scripts. There can be any amount of +Val: entries. It requires a $end_custom_data entry at the end.
Check the scripting documentation of Ship Class to find the CustomData Lua Table.
====+Val:====

Specifies a custom data value and its name, in the format

+Val: Name Value

These values will always be strings of text. If you use them in Lua as other types of value, you might need to convert them in the script.
====$end_custom_data====

Mandatory entry to indicate that the Custom Data list has ended. }}

===$Subsystem<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour
*By default, the ship's subsystems are scannable (this can be overridden by mission designers)
*The ship will warp out without ramping up to warpout speed
*When using the "Knossos" warpout, this ship will aim for the center of the portal

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour
*The following things are true for all ships with this flag:
**When hit by debris, damage dealt by the collision is capped to between 10 and 20% of the ship's health maximum (determined randomly for each collision)
**All damage dealt by weapons without the corresponding supercap flag from weapons.tbl will be reduced by 75%
**In addition, once the ship is at or below 75% health, damage from non-supercap weapons is completely negated
**Do note that shockwave damage, regardless of origin, is not subject to these rules unless the "$Weapon shockwave damage respects huge ship flags:" setting in game_settings.tbl is set to true
**Ship subsystems are scannable by default (can be overridden by mission designers)
**The ship does not need to ramp up to warpout speed before entering subspace
**When using the "Knossos" warpout, the ship will aim for a departure point at the center of the Knossos portal

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another ship. For ships which have this flag and are a hash-variant of another ship (like '''SF Dragon''' and '''SF Dragon#2 (Weakened)'''), the ship copy will be listed on the scoreboard as the original ship. This only affects the listing, not the score.

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in any of the FRED dropdown lists for ship classes.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD shield icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|$Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==="repair disabled subsystems"===
{{Table371|
Destroyed subsystems will auto-repair, provided [[Ships.tbl#.24Subsystem_Repair_Rate:|$Subsystem Repair Rate:]] is greater than 0. }}

==="large ship deathroll"===
{{Table210|
Causes the ship to deathroll like a fighter, even if it is big or huge (which is disabled by default). Note that their deathroll intensity is scaled down by being larger size. }}

==Wing Formations==
===$Name:===
{{Table202|
*Provides a unique name for the formation, followed by the list of positions occupied by each member of the wing relative to their leader. The leader is always at 0,0,0 and is omitted, so the first position is the second in the wing, and second is the third in the wing, etc. Each formation must contain all 5 positions.
*NOTE: FSO automatically scales these these positions by the ship's size, so the table values will be very small. You can see the retail formation's values below for reference.
*Syntax: (a list of 5 '''''Vectors'''''), each has three '''floats''', x-axis, y-axis, z-axis, respectively}}

===Example===

<pre>
#Wing Formations

$Name: Default
((-0.39, 0.20, -0.59)
( 0.39, 0.20, -0.59)
(-0.78, 0.39, -1.18)
( 0.00, 0.39, -1.18)
( 0.78, 0.39, -1.18))

#End
</pre>

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Weapons.tbl

2023-09-28T10:34:11Z

-Joshua-: /* Weapons.tbl Flags */

{{TableVersionGit|2022-22-11|cfdeeb7109248248d5437e635e509ca0ae65247e}}
{{Tables}}
The '''weapons.tbl''' defines all of the weapon classes used in FSO.

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

==Introduction==
The weapons.tbl is responsible for defining the behavior of the numerous weapon effects used in FSO, including the amount of damage dealt, the firing rate, and graphical effects.

This wiki page goes over all of the entries used exclusively in the weapons.tbl file. Hyperlinks to individual weapon creation/editing tutorials are provided when appropriate.

==Special Case Weapons==
===Beam Cannons===
'''REQUIRES:'''
*'''"beam"''' flag
*'''[[weapons.tbl#$BeamInfo:|$BeamInfo:]]'''

See also: [http://www.hard-light.net/wiki/index.php/Tutorial_-_Beam_Weapons Tutorial - Beam Weapons]

===Flak Guns===
'''REQUIRES:'''
*'''"flak"''' flag
*'''"particle spew"''' flag
*Must have inner and outer radius defined to have any effect.
*A '''.pof''' model must be defined ( usually '''Hornet.pof''' )
**Note: the model is not actually used... Instead, it uses [[Weapons.tbl#$Pspew:|particle spew]]. Trails may also be added.

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

==Core Table==

===$Name:===
*This is the name of the weapon. If it's going to be used by the player, keep it under 12 characters so it doesn't spill over the HUD box. Two special characters can be used in the name: '''#''' and '''@'''. Their usage details are the very same than inside the [[Ships.tbl#.24Name:_2|$Name field from Ships.tbl]].
*Syntax: '''''String'''''

====+nocreate====
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in Weapons.tbl or in earlier parsed *-wep.tbm files) by the time the *-wep.tbm is read.}}

===$Alt Name:===
{{Table3611|
*An alternative name that can be referenced instead of $Name:
*Syntax: '''''String'''''}}

===$Subtype:===
{{Table3610|
Specifies the weapon 's subtype. Overrides the default subtype as specified by the #-section it is in (#Primary, #Secondary, #Beam Weapon, etc.).

{{Note|
:Since the weapon subtype is already specified by the #-section it is in, this option is not particularly useful when the weapon is inside a #Primary or #Secondary section. However, it may be used to specify the weapon slot it uses on fighters/bombers for weapons that are normally capship only (such as beam cannons).}}

*Syntax: '''''String'''''
*Valid Entries:
:Primary
:Secondary}}

===+Title:===
*This is the title of the weapon in the Weapons loadout screen. Only needed for player allowed weapons. Title may be anything. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Syntax: XSTR('''''"String"''''', -1)

===+Description:===
*This is the description you see in the weapons loadout screen. Again, these aren't based on any hard numbers, just approximations. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''Standard Issue
''Level 3 Hull Damage
''Level 2 Shield Damage''", -1)
$end_multi_text
</pre>

===+Tech Title:===
*Title of the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: XSTR('''''"String"''''', -1)

===+Tech Anim:===
*Animation used for the weapon in the Tech room. Only needed for player allowed weapons.
*Syntax: '''''String''''', animation filename
**Example: ''Tech_Subach_HL-7''

===+Tech Description:===
*Descriptive text you see in the tech room. Only needed for player allowed weapons. Numerical value is a reference to translations in [[Tstrings.tbl]]
*Must be followed by '''$end_multi_text'''

'''Example'''

<pre>
XSTR(
"''The Subach-Innes HL-7...''", 3245)
$end_multi_text
</pre>

===$Turret Name:===
{{Table222|
*Renames a turret to this if this is the first weapon on a turret.
*Syntax: XSTR('''''"String"''''', -1)}}

===$Tech Model:===
{{Table3610|
*Defines model used in wing loadout screen for the weapon. 3D weapon models in the tech room have not yet been implemented.
*Syntax: '''''String.pof''''', model filename}}

====+Closeup_Pos:====
{{Table3613|
*How the model will show on the Loadout Screen. The position of the camera relative to the model center. Only valid if a tech model is defined
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively}}

====+Closeup_Zoom:====
{{Table3613|
*How the model will show on the Loadout Screen. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians}}

===$Selection Effect:===
{{Table3613|
*Defines which selection effect to use when the -weapon_choice_3d commandline flag is enabled or no ani can be found for the selected weapon.
*Syntax: '''''String''''', either "FS1", or "Off". This defaults to the FS2 effect.
}}

===$HUD Image:===
{{Table3610|
*Defines the picture used to represent the weapon in HUD loadout list
*Syntax: '''''String''''', filename}}

===$Model File:===
*Filename of the model file (.pof) at data/models folder. Additional fields beginning from '''''@Laser Bitmap:''''' and ending to '''''@Laser Tail Radius:''''' are not needed if a model has been defined for the weapon.
*Standard primaries and beam cannons do not use specific models so for those the name is 'none'.
*Flak weapons and secondaries use models, though the exact model is not important with the flak weapons.
*Syntax: '''''String.pof''''' or ''none'', model filename
**Example: ''none''

===$POF target LOD:===
{{Table3610|
*Defines the LOD (Level-Of-Detail) of the model used in HUD targeting view
*Syntax: '''''Integer'''''}}

===$Detail Distance:===
{{Table3613|
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers are (from left to right): 1/8, 1/4, 1, 4, 8
*Optional. If not defined the game uses the formula ((radius * 20.0 + 20.0) * LOD)
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''}}

===$External Model File:===
{{Table3610|
*Defines the models shown on the gunpoint, used with Bobb's external-visible-weapon code.
*Syntax: '''''String.pof''''', model filename}}

===$Submodel Rotation Speed:===
{{Table3610|
*Defines the rotation speed of the subobject, with the $gun_rotation property defined, in the external weapon model.
*Syntax: '''''Float'''''
*Note: weapon fire will be delayed by the time it takes for the weapon to spin up to this speed (using $Submodel Rotation Acceleration or its default value), regardless of whether an external model is used or not.
}}
{{Table38|
*Note: It's no longer required that the ship actually have external models enabled (whether or not this weapon has one defined) for the spin up delay to occur.
}}

===$Submodel Rotation Acceleration:===
{{Table3610|
*Defines the rotation acceleration of the external weapon model.
*Syntax: '''''Float'''''
*Default value: 10}}

===@Laser===
In the event a 3D model is not defined for the weapon, FSO creates an object similar to a glowpoint. Essentially, it is a 2D plane that always faces the player's camera with an additive texture applied to it, and may or may not have an omnilight follow it.

As suggested by its name, this option group is normally used for lasers and similar primaries, but it may also be used for other weapon types as well.

Unless said otherwise, the graphic files used within this group may be of any compatible type (.DDS, .PCX, .TGA, etc.), however a .DDS is recommended.

====@Laser Bitmap:====
Defines the graphic file to be used as the weapon effect.

Blending type: additive

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Bitmap: my_laser_bitmap
</pre>

====@Laser Head-on Bitmap:====
{{Table220|
Defines another laser graphic file to be used and crossfaded into as the camera angles towards the front or bank of this weapon. See also @Laser Head-on Transition Angle and @Laser Head-on Transition Rate.

Syntax: '''''String''''', filename}}

====@Laser Glow:====
Defines the graphic file to be used for the glowmap of the weapon effect.

Blending type: additive

*This file is 'multiplied' by a value between Color and Color2.
*The physical dimensions of the glowmap in-game is 2x the size of the bitmap.

Syntax: '''''String''''', filename

'''Example:'''
<pre>
@Laser Glow: my_laser_glowmap
</pre>

====@Laser Glow Head-on Bitmap:====
{{Table220|
Defines another graphic file to be used for the laser glow and crossfaded into as the camera angles towards the front or bank of this weapon. See also @Laser Head-on Transition Angle and @Laser Head-on Transition Rate.

Syntax: '''''String''''', filename}}

====@Laser Head-on Transition Angle:====
{{Table220|
Overrides the angle in degrees from the front (or back) that the head-on transition crossfade is at exactly a 50/50 blend.

Syntax: '''''Float''''', degrees
Default: Calculated from the ratio of the laser's length to its average radius}}

====@Laser Head-on Transition Rate:====
{{Table220|
Defines how quickly the head-on transition fades from one bitmap to the other. Greater than 20 is an instant switch with no blending.

Syntax: '''''Float'''''
Default: 2}}

====@Laser Color:====
The RGB color of the glow effect.

*The color is applied both to the glowmap and the omnilight that follows the effect.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Red glow effect at the start of the effect's lifetime
</pre>

====@Laser Color2:====
The RGB color of the glow effect at the end of the effect's lifetime (at its maximum range).

*The color is applied both to the glowmap and the omnilight that follows the effect.
*The actual color of the glow effect is somewhere in between the values defined by Color and Color2. Essentially, the actual color "fades" from Color to Color2 over its lifetime.
**If Color is not defined, then a default value of 255, 255, 255 is assumed for its initial color.

Syntax: '''''Color''''', red, green, blue respectively, 8-bit value from 0 to 255

'''Example:'''
<pre>
@Laser Color2: 0, 0, 255 ; Blue glow effect at the end of the effect's lifetime.
</pre>

'''Example:'''
<pre>
@Laser Color: 255, 0, 0 ; Start with a Red glow effect, and fade into...
@Laser Color2: 0, 0, 255 ; a Blue glow effect over the lifetime of the effect.
</pre>

====@Laser Length:====
Defines the length of the weapon effect.
*This option stretches the 2D plane "away" from its origin.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Length: 1.0
</pre>

====@Laser Head Radius:====
Defines the width of the leading edge, or "head," of the weapon effect.
*The edge of the 2D plane farthest away from its origin is the leading edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Head Radius: 0.75
</pre>

====@Laser Tail Radius:====
Defines the width of the trailing edge, or "tail" of the weapon effect.
*The edge of the 2D plane that is closest to its origin is the trailing edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Tail Radius: 0.75
</pre>

===$Light color:===
{{Table222|
*Sets the color of light cast by the weapon.
*Syntax: '''''Color''''', red, green, blue respectively, from 0 to 255
*Default value: If not set, the color is white for weapons with models, or based on the laser colors otherwise }}

===$Light radius:===
{{Table222|
*Sets the maximum distance light cast by the weapon will reach. Increasing this will tend to make it appear brighter near it's center
*Syntax: '''''float''''', any positive value
*Default value: The defaults for different weapon types are set in [[Lighting_Profiles.tbl]]}}

===$Light intensity:===
{{Table222|
*Acts as a multiplier to the brightness of the light cast by the weapon. This changes the brightness without affecting the radius.
*Syntax: '''''float''''', any positive value
*Default value: 1}}

===$Collision Radius Override:===
{{Table202|
*Weapon - weapon collisions are treated as two spheres, where a laser's sphere's radius is equal to its Head Radius, and a missile's is the radius of its associated model (possibly doubled). Using this will override either of those values.
*If used on a beam it will override its collision radius as well, instead of using the widest section.
*NOTE: If the weapon is interceptable, such as a bomb or has been given hitpoints, this value will ''still'' be doubled, unless the "no radius doubling" flag is used.
*Syntax: '''''Float''''', meters}}

===$Mass:===
*Scales the kinetic effect this weapon has on its target. With higher mass imparting a stronger effect.
*The eventual kinetic effect is also multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. This is also true for the intesnity of the "shudder" effect, if flagged.
*Syntax: '''''Float''''', blast effect

===$Velocity:===
*How fast the weapon travels. Is also used to define the weapon range, '''''$Velocity x $Lifetime = range'''''.
*Beams travel instantly so this field has effect only on weapon range and AI beam targeting with certain beam types. $Velocity of beam also applies to its kinetic effect along with $Mass.
*Syntax: '''''Float''''', meters per second

===$Fire Wait:===
*Time in seconds between firings
*Note that Fire wait will be reset to 1 if it is set over 5 for non turreted primary weapons (doesn't apply to 3.6.14+)
*Syntax: '''''Float''''', seconds

====+Max Delay:====
{{Table373|
*Defines the maximum amount of time it takes to refire a weapon in a random fire delay range.
**This must be used with +Min Delay: to have any effect.
*Syntax: '''''Float''''', seconds}}

====+Min Delay:====
{{Table373|
*Defines the minimum amount of time it takes to refire a weapon in a random fire delay range.
**This must be used with +Max Delay: to have any effect.
*Syntax: '''''Float''''', seconds}}

===$Damage:===
*Base damage this weapon does. The actual damage is this number multiplied by the factors below.
*Base damage this beam does is continuous damage, damage is approximately 5.88 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*The exact factor to multiply by is 100/17, or one 'pulse' of damage every 170 seconds. The generally used wisdom of 5.5 times may have been generally accurate before beam damage was made continuous and frame-rate independent, but is now out of date information.
*Syntax: '''''Float''''', damage
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)

===$Damage Time:===
{{Table373|
*This sets a time from the end of the weapons lifetime that damage will start to attenuate at. '''''Example: Weapon lifetime is 2.0 seconds and the desired effect is to attenuate after 0.5 seconds have passed, set this to 1.5 seconds.'''''
*Syntax: '''''Float''''', seconds. Defaults to 0.0.
**Note: If neither +Min Damage: nor +Max Damage: is set, the damage will always attenuate to zero at max range.
***If both +Min Damage: and +Max Damage: are set, both are defaulted to 0.0 and damage will be attenuated to zero.}}

====+Attenuation Damage:====
{{Table373|
*This sets the damage a weapon will attenuate to after reaching $Damage Time:.
*Syntax: '''''Float''''', damage.}}

====+Min Damage:====
{{Table373|
*This sets the lowest amount of damage possible assuming damage attenuation is taking place. '''''This has been deprecated, please use +Attenuation Damage: instead.'''''
*Syntax: '''''Float''''', damage. Defaults to 0.0.}}

====+Max Damage:====
{{Table373|
*This sets the highest amount of damage possible assuming damage attenuation is taking place. '''''This has been deprecated, please use +Attenuation Damage: instead.'''''
*Syntax: '''''Float''''', damage. Defaults to 0.0.}}

===$Angle of Incidence Damage Multiplier:===
{{Table212|
*Causes the weapon's damage to be multiplied by these factors depending on the angle of incidence.
*It is ''not'' linear, it is based on the sine of the angle to the surface. If the factors are 1x for minimum, and 2x for maximum, at an angle of 45° the multiplier is 1.707x, for instance.
====+Min:====
*The damage multiplier at a perfectly glancing hit, parallel to the surface (although not technically possible).
*Syntax: '''''Float'''''
====+Max:====
*The damage multiplier when hit straight on, perpendicular to the surface.
*Syntax: '''''Float'''''}}

===$Damage Type:===
{{Table3610|
Defines the damage type that this weapon uses. All armor effects are applied after shield and have no function against shockwave or subsystem damage.

'''REQUIRES:''' [[armor.tbl]]

*Syntax: '''''String''''', name of the damage type ( as defined by [[armor.tbl#$Damage Type:|$Damage Type]] )}}

===$Arm time:===
{{Table3610|
*Defines the time after the launch that is required before the weapon comes hot
*If the time has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', seconds}}

===$Arm distance:===
{{Table3610|
*Defines the distance from the firing ships that is required before the weapon comes hot
*If the distance has not been reached when the weapon detonates the Dinky explosion is used
*Syntax: '''''Float''''', meters}}
{{Table3615|
*This parameter is also applied to flak weapons. Previous behaviour was to arm weapons after 10 meters of travel.}}

===$Arm radius:===
{{Table3610|
*Defines the distance from the target where the weapon will arm itself
*Syntax: '''''Float''''', meters}}

===$Detonation Range:===
{{Table3610|
*Defines the distance from the point in space that the weapon was launched where the weapon will detonate
*Syntax: '''''Float''''', meters}}

===$Detonation Radius:===
{{Table3610|
*Defines the distance between the target center point point and the weapon which detonates the weapon.
*Syntax: '''''Float''''', meters}}

===$Flak Detonation Accuracy:===
{{Table3615|
*Normally, flak weapons detonate at a range of 65 to 99 meters from their intended target, depending on the firing ships' weapon subsystem health. This parameter can be used to adjust this behaviour, as it defines the base range used to determine this detonation range. Standard value is 65.
*Syntax: '''''Float''''', range in meters}}

===$Flak Targeting Accuracy:===
{{Table3615|
*Turret-fired flak weapons are normally firing in a cone around the target's predicted position. This parameter can be used to adjust the size of this cones' base radius. Standard is 60 meters.
*Syntax: '''''Float''''', radius in meters}}

===$Untargeted Flak Range Penalty:===
{{Table3615|
*If a flak weapon is fired without a target selected, this parameter defines the range penalty applied to that weapon. Standard is 20 meters, meaning an untargeted flak weapon will detonate after traveling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in meters.}}

===$Shockwave damage:===
{{Table3610|
*Override for the damage caused by shockwaves (default is [[#$Damage:]])
*Syntax: '''''Float''''', damage
*Note: adding a shockwave to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x shockwave)
}}

===$Shockwave Damage Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the damage type used for the weapon explosions
*Syntax: '''''String''''', name as defined in [[armor.tbl]]}}

===$Blast Force:===
*The intensity of the kinetic blast effect when ship is within the outer radius of the explosion. Comes in effect only if inner and outer radius are defined.
*Syntax: '''''Float''''', blast effect

===$Inner Radius:===
*Radius at which the full explosion damage is done. Marks the line where damage attenuation begins. Damage is reduced by the square of the distance between the inner radius and outer radius. i.e. half way between inner and outer results in 1/4 damage
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*Syntax: '''''Float''''', meters

===$Outer Radius:===
*Maximum radius at which any damage is done. See $Inner Radius for the attenuation formula.
*Also defines the size of the shockwave (if shockwave speed is > 0)
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*Syntax: '''''Float''''', meters

===$Shockwave Speed:===
*Speed shockwave expands at. Zero means no shockwave and that any area-effect damage is applied immediately
*Syntax: '''''Float''''', meters per second

===$Shockwave rotation:===
{{Table3610|
*Defines how the 3D shockwave is rotated. Random, if left undefined.
*Syntax: '''''Angle''''', three values, pitch, bank, heading respectively, in degrees}}

===$Shockwave model:===
{{Table3610|
*Defines the model file (.pof) used as a shockwave for the 3D shockwaves.
*Syntax: '''''String.pof''''', model filename}}

===$Shockwave name:===
{{Table3610|
*Defines the name of the animation used for the 2D shockwave
*Syntax: '''''String''''', filename}}

===$Shockwave Sound:===
{{Table202|
Optional sound to be used for the sound heard when for the shockwave (default is sound 109).
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Dinky shockwave:===
{{Table3610|
*Dinky shockwave are used if the weapon is shot down before arming or if the conditions marked at '''Arm time''' and '''Arm distance''' are not reached before impact
*It uses exactly same entries as the standard shockwaves
*'''''+Shockwave damage:'''''
*'''''+Shockwave damage type:'''''
*'''''+Blast Force:'''''
*'''''+Inner Radius:'''''
*'''''+Outer Radius:'''''
*'''''+Shockwave Speed:'''''
*'''''+Shockwave Rotation:'''''
*'''''+Shockwave Model:'''''
*'''''+Shockwave Name:'''''}}
{{Table202|
*'''''+Shockwave sound:'''''}}

===$Armor Factor:===
*Multiplier for the damage done to armor
*Syntax: '''''Float''''', damage multiplier

===$Shield Factor:===
*Multiplier for the damage done to shields
*Syntax: '''''Float''''', damage multiplier

===$Subsystem Factor:===
*Multiplier for the damage done to subsystems
*Syntax: '''''Float''''', damage multiplier

===$Lifetime Min:===
{{Table3610|
*Defines the minimum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime Max:===
{{Table3610|
*Defines the maximum lifetime of the weapon
*Syntax: '''''Float''''', seconds}}

===$Lifetime:===
*Time before the standard primaries fizzle out and secondaries self destruct. Multiply this by the speed to get the range. If values are too low (below framerate) then the collision detection and graphic effects may suffer.
*This field has no effect for the beams apart from weapon range and AI beam targeting with certain beam types
*Syntax: '''''Float''''', seconds

===$Energy Consumed:===
*The amount of energy each bolt drains firing ship. Has no effect on turreted weapons.
*Syntax: '''''Float'''''

===$Cargo Size:===
*Cargo size, is not used with non-ballistic primaries.
*Amount of missiles available = Bank capacity / Cargo Size.
*Syntax: '''''Float'''''

===$Autoaim FOV:===
{{Table224|
'''This option is exclusive to primaries.'''
*Defines if the weapon will have auto-aim and what the FOV of the auto-aim is.
*Syntax: '''''Float'''''}}

===$Homing:===
'''This option is exclusive to secondaries.'''
{{Table212|'''This option may now be applied to primaries'''. They may only use heat seeking. For optimal results the "no homing speed ramp" flag may be used.}}

Defines if the bolts/missiles in question is homing

If set to NO, then following fields are not required in the table.

*Syntax: '''''Boolean''''', yes or no

===='''+Type:'''====
Defines the homing method
*Syntax: '''''String''''', ''ASPECT'' or ''HEAT''
{{Table3610| An additional option, ''JAVELIN'', has been added. This behaves like an aspect missile but automatically only locks onto the engines of a target, and only if the engines are in sight.}}

===='''+Turn Time:'''====
Determines how quickly the missile can turn. Ostensibly the number of seconds it takes the missile to do a 360 degree circle at full turn speed, but for complicated reasons this is only true if [[Game_settings.tbl#.2BAI_respect_tabled_turn_time_and_rotdamp|AI respect tabled turn time and rotdamp]] is enabled.
**Syntax: '''''Float''''', seconds

===='''+Turning Acceleration Time:'''====
{{Table202|
Determines how quickly the missile reaches its maximum turn speed.
*Note: Requires [[Game_settings.tbl#.24AI_use_framerate_independent_turning:|$AI use framerate independent turning]] in game_settings.tbl
**Syntax: '''''Float''''', seconds}}

===='''+View Cone:'''====
'''Heat-seeking missiles only'''

This is the width of the weapon's viewing cone, given in degrees. Objects outside this cone are effectively invisible to the missile. The value / 2 gives the angle from the missile's centerline to the edge of the viewing cone.
*Syntax: '''''Float''''', degrees
{{Table3610| Has been enabled also to aspect seekers as an option. They will continue to home on targets outside their view cone, but will take a continuous lifetime penalty every second their target is outside this cone.}}

===='''+Min Lock Time:'''====
'''For aspect/javelin missiles only'''

The minimum number of seconds to gain a target lock.
*Syntax: '''''Float''''', seconds

===='''+Lock Pixels/Sec:'''====
'''For aspect/javelin missiles only'''
The number of pixels the aspect triangle moves per second while attempting lock-on.

*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Pixels/Sec:'''====
'''For aspect/javelin missiles only'''

The number of pixels moved per second while attempting to catch up to the target.
*Syntax: '''''Integer''''', pixels per second

===='''+Catch-up Penalty:'''====
'''For aspect/javelin missiles only'''

Extra pixels to move after catching up. (Needs verification )
**Syntax: '''''Integer''''', pixels

===='''+Seeker Strength:'''====
{{Table3610|
Defines the seeking ability of the homing system. Default of heat seekers is 3.0 and for aspect seekers 2.0. Spoofing chance is defined as '''[[#$Countermeasure:|cm type effectiveness]]'''/'''seeker strength''' (missile must be within the countermeasures '''[[#$Countermeasure:|+Effective Radius:]]'''
*Syntax: '''''Float''''', seeker strength}}

===='''+Target Lead Scaler:'''====
{{Table3611|
Defines the type of pursuit course the missile tries to obtain.
*Values < 0 give lag pursuit, values ~ 0 give pure pursuit, values > 0 give lead pursuit.
*Syntax: '''''Float''''', default for heat seekers: 0, default for aspect or javelin seekers: 1.}}

===='''+Target Lock Restriction:'''====
{{Table202|
Defines if the missile can lock onto ships besides the current target
*Syntax: '''''String''''', name of the behavior, default is ''current target only'';.
*''Current target only'' As normal, can only acquire locks on the targeted ship
*''Any target'' Missile will lock on any valid target. Missile locking is still disabled in certain cases, such as when a friendly is the player's target
*''Current target, any subsystem'' Targeting is restricted to the current ship, but will pick turrets and subsystems on that ship. }}

===='''+Independent Seekers:'''====
{{Table202|
Defines the ability for a missile to target multiple objects at once.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Target Lock Objecttypes:'''====
{{Table220|
Defines what type of object can be locked on with this weapon
*Syntax: '''''String''''', name of the object type, default is ''ships''
*''ships'' Will target only ships
*''bombs'' Will target bombs and targetable missiles }}

===='''+Trigger Hold:'''====
{{Table202|
Defines the ability to hold the trigger to lock and release to fire.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Reset On Launch:'''====
{{Table202|
Defines the ability for locks to reset upon missiles being fired.
*Syntax: '''''Boolean''''', yes or no, default is no.}}

===='''+Max Seekers Per Target:'''====
{{Table202|
Defines the maximum number of seekers that can target a single object.
*Syntax: '''''Integer''''', number of seekers.}}

===='''+Max Active Seekers:'''====
{{Table202|
Defines the maximum number of total seekers for the weapon to have.
*Syntax: '''''Integer''''', number of seekers.}}

===='''+Ship Types:'''====
{{Table202|
Defines the ship types that this missile can target. In order for a ship to be targetable it must be able to match one of the listed types, if some of the below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', ship types.}}

===='''+Ship Classes:'''====
{{Table202|
Defines the ship classes that this missile can target. In order for a ship to be targetable it must be able to match one of the listed classes, if some of the above/below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', ship classes.}}

===='''+Species:'''====
{{Table202|
Defines the species whose ships this missile can target. In order for a ship to be targetable it must be able to match one of the listed Species, if some of the above/below lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', species.}}

===='''+IFFs:'''====
{{Table202|
Defines the IFF's whose ships this missile can target. In order for a ship to be targetable it must be able to match one of the listed IFFs, if some of the above lists are also specified, it must match into those as well.
*Syntax: '''("String" "String")''', IFFs.}}

===$Homing Auto-Target Method:===
{{Table214|
*If this weapon needs to acquire a target on its own, such as a heatseeker losing its target or having the "untargeted heatseeker" flag, this determines how it should do so. Options are:
*'''CLOSEST''', the weapon will acquire the nearest target that it is able.
*'''RANDOM''', the weapon will acquire a random target from those available.
}}

===$Swarm:===
*The number of missiles to fire per volley if it's a swarm missile
*Can be issued to Standard primaries also. Causes single part turrets to malfunction but causes multi part turrets to fire only on their barrel line. Can be used for 'burst fire weapons'. Does not work with player weapons.
*Is incompatible with "Corkscrew" option.
*Swarm will negatively affect the missile's ability to hit its target and will not lead its target even with [[Weapons.tbl#.2BTarget_Lead_Scaler:|Target Lead Scaler]] defined unless [[Game_settings.tbl#.24Swarmers_Lead_Targets:|$Swarmers Lead Targets]] is enabled.
*Syntax: '''''Integer''''', number of shots in a swarm
{{Table3610|
*'''+SwarmWait:'''
**Defines the time between weapons fired in a swarm
**Syntax: '''''Float''''', seconds
***Default: 0.150)}}

===$Acceleration Time:===
{{Table371|
*Defines how long it takes for a secondary weapon to attain full speed. Takes precedence over $Free Flight Time (see below) in terms of the weapon's velocity, and affects both locked-on and dumbfired secondaries.
*Syntax: '''''Float''''', seconds
**Default: 0.0}}

===$Velocity Inherit:===
{{Table371|
*Defines how much of the parent ship's velocity to inherit, if [[Ai_profiles.tbl#.24use_additive_weapon_velocity:]] is used.
*Syntax: '''''Float''''', percents
**Default: 100.0}}

===$Free Flight Time:===
{{Table3610|
*Defines the free flight time of homing weapons. During this time weapon flies at 1/4 of its velocity + firing ships velocity in a straight line.
*Syntax: '''''Float''''', seconds
**Default: 0.25}}

'''Note:''' due to dumbfires never changing their speed, using this on a dumbfire missile will have it stuck at freeflight speed even after the end of the freeflight time.

===$Free Flight Speed:===
{{Table3613|
*Defines the speed that the weapon will be traveling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
{{Note| This feature was never implemented correctly and was removed in r8867. FSO parses but doesn't use the value, and prints a warning in the log. This feature has subsequently been reimplemented, see $Free Flight Speed Factor: below}}
}}

===$Free Flight Speed Factor:===
{{Table202|
*Defines the speed that the weapon will be traveling at during the free flight segment (see above).
*Syntax: '''''Float''''', Multiplier for the actual speed, minimum 0.01.
**Default: 0.25
}}

===$Gravity Const:===
{{Table224|
*If the mission has gravity, this is the multiplier applied to acceleration from gravity on the weapon.
*AI will lead for ballistic trajectories, and this may affect their range as they will not fire unless they can successfully make a ballistic path to their target.
*'''Homing weapons are unaffected by gravity no matter what'''.
*Syntax: '''''Float'''''
**Default: 0}}

===$PreLaunchSnd:===
{{Table3613|
*Defines the one-shot sound effect to play at the beginning of a firing stream. Currently only has an effect on primary weapons.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
**Default: No Sound}}

===+PreLaunchSnd Min Interval:===
{{Table3613|
*Defines Minimum interval between when the player stops firing and the next time the pre-launch sound can play, as a limiter in case the player is pumping the trigger.
*Syntax: '''''Integer''''', Minimum delay in milliseconds between the end of the previous firing sequence and the next time the pre-launch sound effect will be played.
**Default: 0 (play pre-launch sound at the beginning of every firing sequence, if present)}}

===$LaunchSnd:===
*Corresponding sound effect when the weapon is launched.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$CockpitLaunchSnd:===
{{Table232|
*Corresponding sound effect when the weapon is launched from the player's ship, allowing use of 2d stereo sounds.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$ImpactSnd:===
*Sound the weapon makes when it hits a hull.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Disarmed ImpactSnd:===
{{Table3610|
*Sound the weapon makes when it hits a hull before being armed.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$FlyBySnd:===
*The sound this weapon makes if it narrowly misses you. -1 is no sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]], usually -1

{{Table214|
===$AmbientSnd:===
*The sound this weapon passively emits in 3d space. The weapon version of [[Ships.tbl#.24EngineSnd:|EngineSnd]] for ships.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$TrackingSnd===
{{Table3615|
*The looping sound played when the player is tracking a target with this weapon.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$LockedSnd===
{{Table3615|
*The sound played when the player has locked onto their target with this weapon.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$InFlightSnd===
{{Table3615|
*The looping sound played while the player has this weapon currently flying.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Inflight sound type'''
**Specifies when the in flight sound is played.
**The value can be one of the following values which are matched case-insensitively:
***''''''TARGETED'''''': The sound is played when the missile tracks a target
***''''''UNTARGETED'''''': The sound is played when the missile is currently not tracking a target
***''''''ALWAYS'''''': The sound is played always}}

===$Model:===
{{Table3610|
*Defines used model file. Included for compatibility with countermeasures as they have been merged with weapons in the code.
*Syntax: '''''String.pof''''', model filename}}

===$Rearm Rate:===
*Defines the frequency that weapons are loaded to the ship
*Syntax: '''''Float''''', How many times per second the weapons are loaded.
**Example: 2.0 will reload every half second. 0.1 will load every ten seconds.

===$Rearm Ammo Increment:===
{{Table38|
*Defines how many missiles or how much ballistic ammo is loaded per load sound.
*Syntax: '''''Integer''''', how many bullets or missiles are loaded.}}

===+Weapon Range:===
*If set, the AI will use this value or the result of weapon lifetime * velocity as the weapon's effective range, whichever is lower. This also affects the [[Hud_gauges.tbl#Lead_Indicator|Lead Indicator]]
*Syntax: '''''Float''''', meters

===+Weapon Min Range:===
{{Table3610|
*Defines the minimum range to the target where the weapons under AI will still fire.
*Implemented before FS_Open 3.6.5
*Syntax: '''''Float''''', meters}}

===+Weapon Optimum Range:===
{{Table214|
*AI fightercraft will attempt to close the distance to their target while they are outside of this range and using this weapon as their currently equipped primary.
*Syntax: '''''Float''''', meters}}

===$Pierce Objects:===
{{Table212|
*Causes the weapon to penetrate the objects impacted and not be destroyed.
*Syntax: '''''Boolean'''''
====+Spawn Children On Pierce:====
*Will spawn the weapons children on each hit, not just when it eventually gets destroyed through lifetime
*Syntax: '''''Boolean'''''}}

===$Flags:===
*See [[Weapons.tbl#Weapons.tbl_Flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the weapon
**Example: ( "Player allowed" "in tech database" )

{{Table3610|
*Can be followed by '''+override''' option in order to reset the weapon flags before parsing in the new ones
*Using this option will erase all '''homing'''-related flags as well as '''swarm''', '''variable lead''', '''trail''', '''TAG''', and '''transparent''' settings in addition to the listed flags. All these should be set again - if they are required - when this option is used.

**Syntax: '''''+override'''''}}

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
{{Table212|
*'''+Alpha Decay Exponent:'''
**Causes the trail to fade away non-linearly. The 0 -> 1 progress through the trail's life is taken to the power of the provided number when being used for trail alpha purposes
**Larger numbers above 1 cause the trail to fade away very slowly at first, and then suddenly at the end. Smaller numbers below 1 cause it to fade away quickly at first, and then slow down for most of its life.
**Syntax: '''''Float''''', positive}}
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
{{Table202|
*'''+Spread:'''
**Causes the trail points to diffuse and drift apart at this speed over time.
**Syntax: '''''Float''''', meters per second}}
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{Table212|
*'''+Bitmap Stretch:'''
**Multiplies how far the bitmap is stretched over each trail segment.
**Syntax: '''''Float'''''}}
{{Table3611|
*'''+Faded Out Sections:'''
**Defines the number of the trail sections (counting from the leading edge) which are gradually faded out.
**Syntax: '''''Integer''''', number of trail sections}}

===$Icon:===
*Loadout icon used in the weapons selection screen.
*Syntax: '''''String''''', filename

===$Anim:===
*Green grid animation used on the weapons screen.
*Syntax: '''''String''''', filename

===$Collide Ship:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Collide Weapon:===
{{Table3610|
*Has been replaced with '''#Conditional Hooks''', see [[Scripting.tbl]]}}

===$Impact Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for impacts of this weapon.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Impact Explosion'' and ''$Impact Explosion Radius'' are not valid options!
}}

===$Impact Explosion:===
*Impact explosion used. Must be defined in weapon_expl.tbl,
*Syntax: '''''String''''', filename or ''none''

===$Impact Explosion Radius:===
*Radius of the defined impact explosion.
*Syntax: '''''Float''''', meters, default 1.0

===$Shield Impact Explosion Radius:===
{{Table373|
*Radius of the shield impact explosion, see [[Ships.tbl#.24Shield_Impact_Explosion:]].
*Syntax: '''''Float''''', meters, defaults to value of $Impact Explosion Radius}}

===$Dinky Impact Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for Dinky (not armed) explosions of this weapon.
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Dinky Impact Explosion'' and ''$Dinky Impact Explosion Radius'' are not valid options!
}}

===$Dinky Impact Explosion:===
{{Table3610|
*Same as Impact Explosion but for Dinky (not armed) explosions
*Syntax: '''''String''''', filename or ''none''}}

===$Dinky Impact Explosion Radius:===
{{Table3610|
*Same as Impact Explosion Radius but for Dinky explosions
*Syntax: '''''Float''''', meters}}

===$Piercing Impact Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used for piercing impacts.
*Syntax: '''String''', the particle effect name
*If this option is specified then piercing impact options below are not valid!
}}

===$Piercing Impact Explosion:===
{{Table3611|
*Defines the effect used for events when weapon pierces the target
*Syntax: '''''String''''', filename or ''none''}}

===$Piercing Impact Radius:===
{{Table3611|
*Defines the base radius of the effect used for piercing weapon impacts
*Syntax: '''''Float'''''}}

===$Piercing Impact Velocity:===
{{Table3611|
*Defines the base velocity for the particles piercing the target
*Syntax: '''''Float'''''}}

===$Piercing Impact Splash Velocity:===
{{Table3611|
*Defines the base velocity for the particles splashing from the target (secondary piercing effects
*Negative value causes the second batch or particles to splash to opposite direction
*Syntax: '''''Float'''''}}

===$Piercing Impact Variance:===
{{Table3611|
*Defines the variance added to the particles
*Values near 0 cause very little variance and values close to 1 cause extreme dispersal.
*Syntax: '''''Float'''''}}

===$Piercing Impact Life:===
{{Table3611|
*Defines the lifetime of the effect for single frame effects
*For multiple frame effects the lifetime is the lifetime of the animation used
*Syntax: '''''Float'''''}}

===$Piercing Impact Particles:===
{{Table3611|
*Defines the number of particles released per impact
*Syntax: '''''Integer'''''}}

===$Piercing Impact Draw Modifier:===
{{Table3611|
*Defines the multiplier applied to the ships piercing effect limit percentage
*Syntax: '''''Float'''''}}
*Option removed in 3.6.12. Use [[armor.tbl]] to finetune piercing effects.

===$Inflight Effect:===
{{Table38|
*Sets the inflight [[Particle Effects|particle effect]] which is used when the laser is active. This is only used by laser weapons.
*Syntax: '''''String''''', the particle effect name
}}
===$Freeflight Effect:===
{{Table38|
*Sets the [[Particle Effects|particle effect]] which is used when the missile is in the free flight phase. See [[#$Free Flight Time:|$Free Flight Time]] for more information.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Ignition Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is transitioning from free flight to homed or unhomed flight.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Homed Flight Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is in homed flight mode.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}
===$Unhomed Flight Effect:===
{{Table38|
*Sets the ignition [[Particle Effects|particle effect]] which is used when the missile is in unhomed flight mode.
*Syntax: '''''String''''', the particle effect name
*This option is only valid for missile weapons
}}

===$Muzzleflash:===
*Normally only with flak cannons.
*Defines the muzzle flash the weapon uses
*Syntax: '''''String''''', muzzleflash name, as defined in [[mflash.tbl]]

===$EMP Intensity:===
*How deeply an EMP effect scrambles your electronics
**Needs the [[#EMP|EMP]] flag set to have any effect
*Basically a percentage, a value of 250 results in a 25% chance of something getting scrambled each frame.
*Maximum value of 500.0
**Syntax: '''''Float''''' (defaults to 300.0)

===$EMP Time:===
*Duration of the EMP effect
**Needs the [[#EMP|EMP]] flag set to have any effect
**Syntax: '''''Float''''', seconds (defaults to 10.0)

===$Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note| The "apply recoil" weapon flag must be set for this to be valid. If the flag is not set, FSO will throw a warning and automatically set it at runtime.}}
}}

===$Leech Weapon:===
**The amount of weapon energy to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Leech Afterburner:===
**The amount of afterburner fuel to drain with each hit (a flat value, not a percentage)
**Needs the [[#Esuck|Esuck]] flag set to have any effect
**Syntax: '''''Float''''' (defaults to 10.0)

===$Vampiric Healing Factor:===
{{Table224|
*Multiplier for how much the shooter is healed after dealing hull damage (1.0 means healing done is equal to damage dealt)
**Needs the [[#Vampiric|Vampiric]] flag set to have any effect
*Must be a positive number higher than 0.0
**Syntax: '''''Float''''' (defaults to 1.0)
}}

===$Corkscrew:===
{{Table3610|
*Allow corkscrew parameters to be defined
*'''+Num Fired:'''
**Defines the number of weapons fired in sequence. Same as the standard swarm entry but for corkscrew missiles
**Syntax: '''''Integer''''', number of missiles
*'''+Radius:'''
**Defines the radius used in the corkscrew motion
**Syntax: '''''Float''''', meters
*'''+Fire Delay:'''
**Defines the delay between missile firings
**Syntax: '''''Integer''''', milliseconds
*'''+Counter rotate:'''
**Defines if every other missile rotates to a different direction (clockwise / anticlockwise)
**Syntax: '''''Boolean''''', ''0'' or ''1'', no or yes
*'''+Twist:'''
**Defines the speed of rotation movement on the radius of corkscrew motion.
**Syntax: '''''Float''''', radians per second}}

===$Electronics:===
{{Table3610|
*Defines the weapons effect against electronics. Requires [[weapons.tbl#"Electronics"|"electronics"]] flag. '''+New Style:''' and '''+Old Style:''' options are mutually exclusive.
*'''+New Style:'''
**Defines that the electronics use the new style which enables more options.
*'''+Old Style:'''
**Defines that the electronics use the old style. The old style was the way the D-Missile worked in Descent: FreeSpace.
}}
{{Table371|
*'''+Area Of Effect'''
**If specified, allows the electronics effect to apply to every ship hit by this weapon's blast or shockwave (the "Electronics" flag isn't necessary with this option).
}}
{{Table3610|
*'''+Intensity:'''
**May only be used with '''+New Style:''' electronics. '''''Has been deprecated'''''.
**Syntax: '''''Float'''''
*'''+Lifetime:'''
**Syntax: '''''Integer''''', milliseconds
*'''+Engine Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for engine subsystems.
**Syntax: '''''Float'''''
*'''+Weapon Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for non-beam turrets.
**Syntax: '''''Float'''''
*'''+Beam Turret Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for beam turrets.
**Syntax: '''''Float'''''
*'''+Sensors Multiplier:'''
**May only be used with '''+New Style:''' electronics. Defines how much longer the disruption effect lasts for sensor subsystems.
**Syntax: '''''Float'''''
*'''+Randomness Time:'''
**Defines the randomness of duration target suffers from the electronics hit. A random number between 0 and this time will be added or subtracted from the disruption time.
**Syntax: '''''Integer''''', milliseconds

* Without any electronics parameters, a weapon with the "electronics" flag will default to the ''Old Style'' mode with a lifetime of 6000 milliseconds and a randomness of 4000 milliseconds. Thus any ship that gets hit can get disrupted for anywhere between 2 to 10 seconds.

}}

===$Spawn Angle:===
{{Table3610|
*Defines the cone (with an angle) where the spawned weapons appear. ''Value'' gives the angle from the missile's centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Like all spawn options, Spawn Angle should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', degrees, default is 180}}

===$Spawn Minimum Angle:===
{{Table202|
*Defines an inner angle for the cone within which the spawned weapons appear. ''Value'' gives the angle from the missile's centerline.
*Like all spawn options, Spawn Minimum Angle should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', degrees, default is 0}}

===$Spawn Interval:===
{{Table202|
*Causes the associated spawn event to happen continuously at this time interval. Enabling this will prevent the spawn event from triggering on detonation.
*NOTE: Having very large numbers of total children (low interval and/or high count) can cause issues for multiplayer, and you will be warned in multiplayer if the total count is greater then 300.
*Like all spawn options, Spawn Interval (and its associated Delay) should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''''Float''''', seconds, minimum is 0.1, '''You will not be warned for a negative spawn interval. ''' The value will be ignored and the spawn will be treated as a regular detonate spawn if negative. This is on purpose so that continuous/detonate spawns can be set regardless of the order in which they are defined in the flags.}}

====+Delay:====
{{Table202|
*Continuous spawn will not begin until this has elapsed.
*Syntax: '''''Float''''', seconds, default is 0}}

===$Spawn Effect:===
{{Table202|
*Specifies the [[Particle Effects|particle effect]] which will be used for continuous spawns of this weapon. Will not be used for detonation.
*Like all spawn options, Spawn Effect should be defined as many times as the carrier weapon has child weapons defined for it (up to 5), before moving to the next option.
*Syntax: '''String''', the particle effect name}}

===$Local SSM:===
{{Table3610|
*Defines the local SSM (Subspace Missile). In effect missile moves via subspace to a position close to the target and starts homing.
*Weapon must be '''''aspect seeking missile''''' and must have '''''[[Weapons.tbl#"local ssm"|local ssm]]''''' flag.
*'''+Warpout Delay:'''
**Defines the time between the missile launch and the subspace jump.
**Syntax: '''''Integer''''', milliseconds
*'''+Warpin Delay:'''
**Defines the time missile stays in subspace before exiting.
**Syntax: '''''Integer''''', milliseconds
*'''+Stage 5 Velocity:'''
**Defines the velocity of the missile after the subspace jump.
**Syntax: '''''Float''''', meters per second
*'''+Warpin Radius:'''
**Defines how far from the SSM will appear from the outer radius of the target.
**Syntax: '''''Float''''', meters
*'''+Lock Range:'''
**Defines the maximum range where SSM can achieve target lock
**Syntax: '''''Float''''', meters}}

===$Countermeasure:===

*Defines the countermeasure effectiveness, radius, etc
{{note|
*Spoofing chance is defined as '''cm type effectiveness'''/'''[[#+Seeker Strength:|seeker strength]]''' (missile must be within the countermeasures '''+Effective Radius:''').
*All countermeasures in the mission perform tests to spoof missiles for two frames after '''any countermeasure''' is created in the mission. No, this doesn't seem to make much sense.
{{Table382|The global frame counter can be bypassed by using '''[[#+Pulse Interval:|pulse interval]]'''.}}
*'''Provisional'''; Countermeasures are only given one chance to spoof any individual missile. This makes tuning seeker strength/effectiveness meaningful.
**Previously some record of which countermeasures had been seen by each missile was kept, but it broke when multiple countermeasures were involved. A good chance of breaking with two countermeasures, and a guaranteed chance of breaking with three or more. This reduced the impact of the seeker strength/effectiveness ratio, but was partly cancelled out by the 2 frames thing.
}}

{{Table3610|
===='''+Heat Effectiveness:'''====
*Defines the countermeasures effectiveness against heat seeking missiles
*Syntax: '''''Float''''', cm effectiveness
**Default: 1.0

===='''+Aspect Effectiveness:'''====
*Defines the countermeasures effectiveness against aspect seeking missiles
*Syntax: '''''Float''''', cm effectiveness
*Default: 1.0

===='''+Effective Radius:'''====
*Defines the countermeasures effective radius
*Syntax: '''''Float''''', meters
**Default: 300.0
}}

{{Table373|
====+Missile Detonation Radius:====
*Defines the radius within which a missile homing on this countermeasure will trigger a detonation (see '''+Single Missile Kill:''')
*Syntax: '''''Float''''', meters
**Default: 40.0
{{note| only affects missiles homing on countermeasures, i.e. heat or aspect with "pulls aspect seekers" flag}}

====+Single Missile Kill:====
*Defines if countermeasures will detonate only the missile homing on this countermeasure, or every missile within '''+Missile Detonation Radius:'''
*Syntax: '''''Boolean'''''
**Default: false
{{note| only affects missiles homing on countermeasures, i.e. heat or aspect with "pulls aspect seekers" flag}}
}}

{{Table382|
====+Pulse Interval:====
*Defines how much time passes between each pulse of this countermeasure.
*Syntax: '''''Float''''', milliseconds
**Default: 0
{{note| any value less than or equal to 0 means the countermeasure doesn't pulse, and uses the global 2-frame counter after any countermeasure is fired.}}
}}

{{Table212|
====+Use Fire Wait:====
*Makes the countermeasure fire wait use what is specified in the '''$Fire Wait:''' section of the weapon.
*Default countermeasure fire wait is 333 milliseconds, regardless of that value was set in '''$Fire Wait:'''.

====+Failure Launch Delay Multiplier for AI:====
*After a failed countermeasure launch the game waits a certain time interval before attempting another launch.
*Previously, the amount of time was calculated as ('fire wait' + 2000 * 'countermeasure firing chance').
*If set to a non negative number, this value will be multiplied to the fire wait value to determine the amount of time before another countermeasure can be attempted.
*Syntax: '''''Float'''''
**Default: -1
{{note| any value less than 0 means the default formula will be used.}}

====+Successful Launch Delay Multiplier for AI:====
*After a successful countermeasure launch the game waits a certain time interval before attempting another launch.
*This value is multiplied to the fire wait value to determine the amount of time before another countermeasure can be attempted.
*Syntax: '''''Float'''''
**Default: 2
{{note| any value less than 0 means the default value will be used.}}

}}

===$BeamInfo:===
*'''+Type:'''
*Defines the type of beam in question. Options are:
**''0'' or ''Direct fire'', a standard non-slashing type beam that fires directly at a random point on the target's hull
**''1'' or ''Slashing'', a slashing type beam, that slashes between opposing corners of the ship
**''2'' or ''Targeting'', a targeting beam that is used to trigger SSMs.
**''3'' or ''Antifighter'', a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles.
**''4'' or ''Normal Fire'', a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
{{Table214|
**''5'' or ''Omni'', a highly flexible kind of beam with many options for its exact behavior. See $Type 5 Beam Options below.}}
*'''+Life:'''
**How long it lasts once the beam is actually firing.
**Syntax: '''''Float''''', seconds
*'''+Warmup:'''
**Warmup time
**Syntax: '''''Integer''''', milliseconds
*'''+Warmdown:'''
**Warmdown time
**Syntax: '''''Integer''''', milliseconds
*'''+Radius:'''
**Muzzle glow radius
**Syntax: '''''Float''''', meters
*'''+PCount:'''
**Particles spewed every interval. ??
**Syntax: '''''Integer'''''
*'''+PRadius:'''
**Particle radius
**Syntax: '''''Float''''', meters
*'''+PAngle:'''
**Defines the random "cone" where the particles are generated
**Syntax: '''''Float''''', angle of the cone
*'''+PAni:'''
**Animation used to represent the particles
**Syntax: '''''String''''', filename
*'''+Miss Factor:'''
**The higher the numbers, the more likely that this beam will miss. One value for every difficulty level
**Syntax: '''''Miss Factor''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5
{{Table3613|
*'''IFF specific miss factors'''
**Identical to the preceding entry but IFF specific. Replace the <IFF> with the name of the IFF from [[iff_defs.tbl]]
**Syntax: '''''+<IFF> Miss Factor:''''', five '''floats''', very easy, easy, moderate, hard, insane, respectively.
***Example: 0.5 0.975 1.35 1.875 2.5}}
*'''+BeamSound:'''
**Corresponding looping sound effect when the beam is firing.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmupSound:'''
**Corresponding sound effect when the beam is beam warmed up.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+WarmdownSound:'''
**Corresponding sound effect when the beam is warming down.
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+Muzzleglow:'''
**Defines the bitmap used to create the muzzle glow
**Syntax: '''''String''''', filename
{{Table372|
*'''+Directional Glow:'''
**Defines the length to stretch the muzzleglow along the beam.
**Syntax: '''''Float''''', length in meters, the muzzleglow is rendered along (in the same plane) as the beam instead of perpendicular to the camera.}}
*'''+Shots:'''
**Defines into how may invidual shots the type 3 (AAA) beams are divided. Note total firing is the same as the +Life:
**ALSO AFFECTS FIGHTER BEAMS. If greater than 0, fires from up to that many fire points at a time before cycling. 1 mimics the behavior of weapons with the "cycle" flag, 0 fires from all available fire points like normal weapons.
**Syntax: '''''Integer''''', Default: 1
*'''+ShrinkFactor:'''
**How much of the beam's life is remaining before it starts to shrink in width. (0.1 means 10% life left)
**Syntax: '''''Float''''', value from 0 to 1
*'''+ShrinkPct:'''
**The beam's width factor is reduced by this amount every second. For example, a value of 0.25 means the beam is at 75% width after 1 second, 50% after 2, 25% after 3, and by 4 seconds it reaches the minimum size of 10%.
**Syntax: '''''Float''''', a positive value
{{Table202|
*'''+GrowFactor:'''
**How much of the beam's life is remaining before it starts to grow in width. (1.0 means as soon as the beam fires)
**Syntax: '''''Float''''', value from 0 to 1
*'''+GrowPct:'''
**The beam's width factor is increased by this amount every second. For example, a value of 0.25 means a beam starting at 0% is at 25% width after 1 second, 50% after 2, 75% after 3, and by 4 seconds it reaches the maximum size of 100%.
**Syntax: '''''Float''''', a positive value
*'''+Initial Width Factor:'''
**What factor of the beam's maximum width it starts with.
**Syntax: '''''Float''''', value from 0 to 1}}
{{Table3610|
*'''+Range:'''
**Defines the maximum range where the beam still has any effect.
**Syntax: '''''Float''''', meters
*'''+Attenuation:'''
**Defines the point where the damage caused by the beam starts to attenuate. At maximum range damage is zero.
**Syntax: '''''Float''''', from 0 - firing point to 1 - no effect
***Default: 1}}
{{Table3611|
*'''+BeamWidth:'''
**Defines the width of the beam for collision test purposes instead of using widest beam section.
**Syntax: '''''Float''''
{{Table222|
*'''+Beam Light Flickers:'''
*Controls if the dynamic flickering of the beam width is applied to the light cast by the beam as well
*Syntax: '''''boolean'''''
*Default value: True
*'''+Beam Width Multiplies Light Radius:'''
*Controls if the light radius of a beam is multiplied by the beam width.
*Syntax: '''''boolean'''''
*Default value: True}}
{{Table38|
*'''+Beam Flash Particle Effect:'''
**Specifies the beam flash [[Particle Effects|particle effect]].
**Syntax: '''''String''''', particle effect name
**If this is specified then '''+Beam Flash Effect''' and '''+Beam Flash Radius''' are not valid options!
}}
*'''+Beam Flash Effect:'''
**Defines the additional impact flash effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Flash Radius:'''
**Defines the radius for the additional impact flash effect.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect:'''
**Defines the beam piercing (bursting flames) effect for the beam.
**Syntax: '''''String''''', filename
*'''+Beam Piercing Radius:'''
**Defines the average radius used for the beam piercing effects.
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Velocity:'''
**Defines the base velocity for the piercing effects
**Syntax: '''''Float'''''
*'''+Beam Piercing Splash Effect Velocity:'''
**Defines the base velocity for the secondary piercing effects
**Negative velocity causes the particles to move to opposite direction
**Syntax: '''''Float'''''
*'''+Beam Piercing Effect Variance:'''
**Defines the variances of the particles from the main path
**Values close to 0 cause minimum variance, higher values cause higher variances
**Syntax: '''''Float'''''}}

{{Table214|
*'''$Type 5 Beam Options:'''
**Species the unique attributes for type 5 beams. '''None of these properties will be used if the weapon is not a type 5 beam.'''
**Fundamentally, type 5 beams are slashing type beams, where the start and end positions refer to physical positions in space (and not angles from the point of view of the shooter) and have many parameters for choosing their positions, including having them be on top of each other, and thus forgoing standard slashing behavior, and also for having rotations, both during the beam firing and in between firings.
*'''+Start Position:'''
**Determines how the starting position should be chosen. Options are:
***'''RANDOM ON SHIP''', Like type 0 direct-fire beams, chooses a random spot on the target's geometry.
***'''RANDOM OFF SHIP''', Like type 1 slash beams, chooses a random spot just outside of the target's geometry.
***'''CENTER''', Chooses the center of the target.
*'''+Start Position Offset:'''
**Displaces the chosen start position in the specified direction and by the specified amount.
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, -0.2, -0.9"
*'''+Start Position Randomness:'''
**Further displaces the chosen start position but to a random degree in the specified axes from the number provided to its negative (i.e. a value of 1 will randomly choose between 1 and -1).
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, 0.2, 1"

*The following three fields can skipped, and the beam will not traditionally sweep like a slash beam (although it may still rotate).
*'''+End Position:'''
**Determines how the starting position should be chosen. Options are:
***'''RANDOM ON SHIP''', Like type 0 direct-fire beams, chooses a random spot on the target's geometry.
***'''RANDOM OFF SHIP''', Like type 1 slash beams, chooses a random spot just outside of the target's geometry.
***'''CENTER''', Chooses the center of the target.
***'''SAME RANDOM''', If the start position was randomly determined, this will cause the end position to inherit that position (it will not inherit offset or randomness, only the randomness from RANDOM ON/OFF SHIP).
*'''+End Position Offset:'''
**Displaces the chosen end position in the specified direction and by the specified amount.
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, -0.2, -0.9"
*'''+End Position Randomness:'''
**Further displaces the chosen end position but to a random degree in the specified axes from the number provided to its negative (i.e. a value of 1 will randomly choose between 1 and -1).
***Whether the x, y, and z directions refer to the shooter's point-of-view, or the target's point-of-view is determined by '''Orient Offsets to Target''' below.
***Whether a value of 1 for any coordinate means the target's radius, or a fixed span from the point-of-view of the shooter is determined by '''Scale Offsets to Target''' below.
***Syntax: '''''Vector''''', x, y, and z coordinate. Example: "1, 0.2, 1"

*'''+Orient Offsets to Target:'''
**This determines the orientation of the offsets and randomness.
**If this is set to ''TRUE'' then the x, y, and z, directions used refer to the target's x, y, and z coordinates. X being left/right, Y being up/down, Z being front/back. A start offset of 0, 0, 1, and an end offset of 0, 0, -1 would always cause the beam to fire at the target's bow and sweep to its aft, no matter which way the shooter is oriented.
**If this is set to ''FALSE'' then the x, y, and z, directions used refer to the shooter's x, y, and z coordinates. Using the z coordinate with this being false will have little effect. A start offset of 1, 0, 0, and an end offset of -1, 0, 0 would always cause the beam to fire towards the target, but to the shooter's right, and sweep in the direction of the shooter's left, regardless of how the target is oriented.
**Syntax: '''''Boolean''''', yes or no, Default: No
*'''+Scale Offsets to Target:'''
**This determines what a magnitude of 1 on the offsets and randomness mean.
**If this is set to ''TRUE'' then a value of 1 for a coordinate means a position in the chosen direction but at a distance equal to the target's radius. Values greater than 1, will drift further and further from the target entirely, while smaller than 1 will bring it closer to its originally chosen start position.
**If this is set to ''FALSE'' then it is as though it were firing at a target with a 300m radius at a 300m distance. A value of 1 corresponds to 45 degrees, which it will start at regardless of the distance of the target. Values greater than 1 will increase beyond 45 degrees but will never exceed 90 degrees
**Syntax: '''''Boolean''''', yes or no, Default: No

*'''+Continuous Rotation:'''
**This defines the degrees per second that the beam will rotate while it is firing.
**Syntax: '''''Float''''', degrees per second
*'''+Continuous Rotation Axis:'''
**This defines the axis about which the beam will continuously rotate. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will rotate about the start position before the offset or randomness were applied. A beam which does not slash (end position paramters omitted), but is offset and rotates about this axis will trace out circles, for instance.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will rotate about the final start position after offset and randomness have been applied. If this beam slashes (end position paramters specified) it will trace out a spiral.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will rotate about the center of the target.

*'''+Burst Rotation Pattern:'''
**Defines a list of rotations, for the final start and end positions to be performed right before firing for each specific shot in a burst (will not rotate the beam while firing). '''You will not be warned for failing to give this weapon burst capability''', because on spawned or subspace strike beams, providing a pattern has the additional effect of spawning multiple copies of this weapon all at once, each one corresponding to another entry in the pattern.
**For instance, a standard slash with a rotation pattern of (0, 180) will cause the beam weapon to slash back and forth, or in a scissor pattern if the burst is very short and the beams fire at similar times.
**(0,120,240) will have 3 slashes in a triangular pattern.
**If a RANDOM ON/OFF SHIP option has been chosen for the start or end positions, the "burst shares random target" flag may be used so all shots in the burst share the same random position.
**Syntax: '''''List of Floats''''', degrees. Example: (0, 90, 180, 270)
*'''+Burst Rotation Axis:'''
**The axis about which to rotate for the burst rotation pattern. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will be rotated about the start position before the offset or randomness are applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will be rotated about the final start position after offset and randomness have been applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will be rotated about the center of the target.
*'''Per Burst Rotation:'''
**Will rotate the final start and end positions, possibly in addition to the burst rotation pattern, for each burst of the beam, or every shot if not a burst weapon.
**Syntax: '''''Float''''', degrees.
*'''+Per Burst Rotation Axis:'''
**The axis about which to rotate for the per burst rotation. Options are:
***'''START POSITION BEFORE OFFSET''', the beam will be rotated about the start position before the offset or randomness are applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''START POSITION AFTER OFFSET''', the beam will be rotated about the final start position after offset and randomness have been applied.
***'''END POSITION BEFORE OFFSET''', as above but for the end position.
***'''CENTER''', the beam will be rotated about the center of the target.
}}
{{Table232|
*'''+Firing Length Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be created along the entire active length of the beam while it is firing and active.
*Note that the +Number for the effect used will be ''per kilometer of length''.
*Syntax: '''String''', the particle effect name
}}
{{Table232|
*'''+Paused Length Effect:'''
*Specifies the [[Particle Effects|particle effect]] which will be created along the length of the beam while it is firing, but in between bursts of a type 4 anti-fighter beam.
*Note that the +Number for the effect used will be ''per kilometer of length''.
*Syntax: '''String''', the particle effect name
}}
{{Table212|
*'''+Beam Flags:'''
*Extra flags specific to beams
**'''burst shares random target''', all shots from this beam weapon in the same burst will target the same random point (or slash direction)
**'''track own texture tiling''', the 'U' position of the beam texture, whose speed is set by '''+Translation:''' below, is tracked independently, rather than being shared among all beams like normal.
}}

*'''$Section:'''
**Beams are made up of up to five sections layered atop one another to create the effect. Each section has its own parameters.
{{Table3610|
:*'''+Index:'''
:**Field used to define with [[Modular Tables]] the beam section which is edited.
:**Only valid when editing beam sections that already exist in other tables. Attempting to index new sections will generate warnings, adding new sections is the default behavior for un-indexed sections.
:**Syntax: '''''Integer''''', index number legal values are from 0 to 5
:*'''+remove'''
:**Removes the set beam section.
:*'''+nocreate'''
:**Does not create new section for the beam}}

:*'''+Width:'''
:**Width of the section
:**Syntax: '''''Float''''', meters
:*'''+Texture:'''
:**Texture for the section
:**Syntax: '''''String''''', filename
:*'''+RGBA Inner:'''
:**Defines the color and transparency of the center of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 255 255 255 255
:*'''+RGBA Outer:'''
:**Defines the color and transparency of the edges of the section
{{Table3613|:**Not used in current builds. Settings entered here will have no effect.}}
:**Syntax: '''''Color''''', red, green, blue, alpha, respectively, value from 0 to 255
:***Example: 150 150 150 10
:*'''+Flicker:'''
:**Defines how much the section flickers
:**Syntax: '''''Float''''', value from 0 to 1
:*'''+Zadd:'''
:**Defines the 'thickness' of the section. The higher the Zadd, the closer the section appears to be. (Zadd can be safely ignored; it actually does nothing.)
:**Syntax: '''''Float'''''
{{Table3610|
:*'''+Tile Factor:'''
:**Defines the beam texture tiling factor. Second number defines the tiling type. Type 0 tiles the graphic in the beam as many times as defined by the 1st number. Type 1 uses the 1st value as the lenght of the tile.
:**Syntax: '''''Float''''', '''''Integer'''''
:*'''+Translation:'''
:**Defines the speed of translation of the beam, a positive value moves from the impact point to the firing point, while a negative value moves away from the firing point towards the impact point. Measured in tiles per second, where the tile count is defined in the "+Tile Factor:" field above.
:**Syntax: '''''Float'''''}}

===$Pspew:===
{{Table3610|
*Defines a particle spew effect for the given weapon
}}{{Table3613|
*'''+Index:'''
**indicates which spewer to add/edit/delete. may be 0-3. used for xmt compatibility.
**Syntax: '''''Integer'''''
*'''+Remove'''
**removes spewer at +Index: (requires +index:)
*'''+Type:'''
**type of particle spew
**Syntax: '''''String'', Default, Helix, Sparkler, Ring, or Plume '''
}}{{Table3610|
*'''+Count:'''
**Defines how many particles are spawn when they are ready to be created (at each +Time: interval)
**Syntax: '''''Integer'''''
*'''+Time:'''
**Defines the time in milliseconds between next particle(s) spewed
**Syntax: '''''Integer''''', milliseconds
*'''+Vel:'''
**Defines the created particles velocity as percentage of the weapons velocity
**Syntax: '''''Float'''''
*'''+Radius:'''
**Defines the size of the created particles
**Syntax: '''''Float''''', meters
*'''+Life:'''
**Defines how long the particles last.
**Syntax: '''''Float''''', seconds
*'''+Scale:'''
**Defines the particle spread. Small value will make particles group together
**typically controls how big the effect is or how fast it moves away from the weapon path on a perpendicular (or sometimes arbitrary) axis.
**helical spews and rings use this value to control how fast the particle helix moves away from the central axis.
**sparklers use this to control how fast particles move away from the spawn point, in any direction
**plumes use this to set the diameter of the disk across which particles are spawned
**Syntax: '''''Float'''''
}}{{Table3613|
*'''+Z Scale:'''
**for sparklers, allows you to elongate the effect to surround other effects, like lasers. essentially a length multiplier
**for plume, it multiplies against +scale to set the plume to spread or converge, zero would be full convergence, 1 would be straight flight, and bigger numbers would cause particles to diverge from the disk.
**Syntax: '''''Float'''''
*'''+Rotation Rate:'''
**used only by helical spews, controls how many rotations per second the helix makes
**Syntax: '''''Float'', may be negative, useful for setting up 2 spews that spin in opposite directions'''
*'''+Offset:'''
**position of effect with regards to the weapon center
**Syntax: '''''Vector'''''
*'''+Initial Velocity:'''
**to indicate both direction and speed of particle effects regards to the weapon velocity and +scale:
**Syntax: '''''Vector'''''
}}{{Table3610|
*'''+Bitmap:
**Defines the animation used to create the particle spew effect
**Syntax: '''''String''''', filename}}

===$Tag:===
*Allowed for secondary weapons
{{Table3610|
*Allowed for primary weapons and secondary weapons}}

*Sets this weapon as a TAG missile, level 1, 2, or 3. The second number is the duration in seconds.
*TAG Level 1 will illuminate hidden targets such as stealth fighters or ships normally obscured by nebula conditions.
*TAG Level 2 illuminates targets much like TAG Level 1, but turrets will prefer to shoot at them over other ships.
*TAG Level 3 has no effect in retail.
{{Table3610|
*TAG Level 3 allows the weapon to trigger [[Weapon.tbl#$SSM:|SSMs]]}}

*Syntax: '''''Integer''''' '''''Float''''', TAG level and seconds respectively
*'''Note''': TAG will not trigger unless the weapon in question has a non-zero damage value.

===$SSM:===
{{Table3610|
*Defines the weapons SSM index number.
*Requires [[Weapons.tbl#$Tag:|TAG level 3]] or a targeting beam.
*Syntax: '''''Integer'''''}}
{{Table373|
*Now also accepts SSM strike names.
*Syntax: '''''String'''''}}

===$FOF:===
{{Table3610|
*Defines the field of fire for the weapon. Causes weapon to fire into a firing cone instead of direct firing line thus causing light inaccuracy
*Syntax: '''''Float''''', degrees}}

====+FOF Spread Rate:====
{{Table37|
*Defines the spread rate of the field of fire. This controls how the FOF increases over time while the weapon is firing.
*Syntax: ''''''Float'''''', rate}}

====+FOF Reset Rate:====
{{Table37|
*Rate at which the spread decreases if the weapon isn't firing.
*Syntax: ''''''Float'''''', rate
*This is required if '''+FOF Spread Rate:''' is present}}

====+Max FOF:====
{{Table37|
*The maximum FOF. After the FOF reaches this value it will not increase any further.
*Syntax: ''''''Float'''''', degrees. Must be greater than or equal to zero.
*This is required if '''+FOF Spread Rate:''' is present}}

===$Shots:===
{{Table3610|
*Defines the number of shots every time the weapon is fired.
*Works only for primary weapons
*Syntax: '''''Integer''''', number of shots}}

===$decal:===
{{Table3610|
*Defines impact decals if they are in use
*'''+texture:'''
**Defines the texture used for impact decals (can use '''''-burn''''' and '''''-glow''''' textures)
**Syntax: '''''String''''', filename
*'''+backface texture:'''
**Defines ???
**Syntax: '''''String''''', filename
*'''+radius:'''
**Defines the size of the impact decals on target
**Syntax: '''''Float''''', meters
*'''+burn time:'''
**Defines the time the '''''-burn''''' texture appears on the target
**Syntax: '''''Integer''''', milliseconds}}
{{Table3613|
*Feature removed - table parsing retained to maintain compatibility}}

===$Impact decal:===
{{Table190|
*Defines an impact decal (think bullet impact/scorch mark) using the new system introduced in FSO 19.0.0.
**Syntax: '''''String''''', this must match to one of the entries in a [[Decals|decal tbm]].
*'''+Radius:'''
**Syntax: '''''Float''''', Radius of the impact decal; default is 1.0
*'''+Lifetime:'''
**Syntax: Either '''''Eternal''''' or '''''Float''''', lifetime in seconds
}}
{{Table224|
*'''+Use Random Rotation:'''
**Syntax: '''''Boolean''''', Whether or not a random rotation is added to the decal; default is NO
}}

===$Transparent:===
{{Table3610|
*Defines weapon effect as transparent. Enables optional fields for 'alpha animations'
*'''+Alpha:'''
**Defines the strength of the alpha (transparency). And also the maximum value for the alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Min:'''
**Defines the minimum alpha value for alpha cycle option
**Syntax: '''''Float''''', from 0 to 1
*'''+Alpha Cycle:'''
**Defines the change in alpha per frame, between '''Alpha''' and '''Alpha Min''' values
**Syntax: '''''Float'''''}}

===$Weapon Hitpoints:===
{{Table3611|
*Defines the amount of hitpoints a weapon has.
*Weapons with '''"bomb"''' flag have 50 hitpoints by default
*Giving weapon hitpoints makes it possible for the weapon to be shot down or be destroyed by EMP.
**Syntax: '''''Integer'''''
}}

===$Armor Type:===
{{Table3613|
*REQUIRES ADDITIONAL TABLE. Defines the armor type for the weapon. This works exactly like ship armor types.
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]
}}

===$Burst Shots:===
{{Table3611|
*Defines the number of shots in a burst
*Shots in a burst use shorter ( '''$Burst Delay:''' ) delay than usually
*If this weapon is cycling each individual firing event counts as one burst shot, so bursts end sooner in time for large banks than small.
**Syntax: '''''Integer'''''}}

===$Burst Delay:===
{{Table3611|
*Defines the time in milliseconds between the shots in a burst
**Syntax: '''''Integer'''''}}

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}
{{Table202|'''"resets"''', as long as a full fire wait has passed since last fired, the burst is reset and can be fired in full again.}}

===$Thruster Flame Effect:===
{{Table3611|
*Defines the filename of the effect used on the modeled thruster of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Effect:===
{{Table3611|
*Defines the filename of the effect used on the glow type effect of the missile
**Syntax: '''''String''''', filename}}

===$Thruster Glow Radius Factor:===
{{Table3611|
*Defines the radius multiplier for the thruster's glow type effect
**Syntax: '''''Float'''''}}

===$Failure Rate:===
{{Table38|
*Defines the random chance that the weapon will fail to fire, or spawn the substitute below if specified.
**Syntax: '''''Float''''', 0 - 1

====+Failure Substitute:====
*Defines the weapon to substitute when the weapon 'fails'.
**Syntax: '''''String''''', Weapon
}}

===$On Create:===
{{Table212|
*Defines an [[Action System|action system]] program set to be executed when a weapon of this type is created. Only applicable to laser and missile style weapons.
}}

===$Animations:===
{{Table220|
*The new way of specifying triggered animations for weapons. Weapon needs to be a modelled weapon for animations.
*See [[Animation.tbl]]
*Syntax: '''''( "String" "String" )''''', names of the animations for this ship, as defined in the Animation.tbl
**Example: ( "wingflap" "docksequence" )
}}

===$Substitute:===
{{Table3613|
Defines a pattern of ammo to substitute for primary or secondary weapons. '''$Substitute:''' can be repeated any number of times (so you could make something like a rainbow laser with several ammo substitutions, for example). If neither ''+period'' or ''+index'' is specified, it is assumed to be equivalent to ''+index: '''0'''''.

*Syntax: '''''Weapon Name'''''
*'''Swarm missiles act in a strange way when used with $Substitute, use at your own risk.'''}}

{{Table3615|
Turrets can use $Substitute as well.
}}
====+period:====
{{Table3613|
FSO will substitute '''Weapon Name''' every ''period'' shots.

*Syntax: '''''Positive Integer'''''
*'''You may not define both +period and +index for the same $Substitute entry'''}}
=====+offset:=====
{{Table3613|
A suboption of +period, offsets the substitute pattern according to the launched ammo. For example, an offset of 3 and a period of 4 will substitute on the 3rd ammo launched, and then every 4th ammo after that.

*Syntax: '''''Positive Integer'''''}}

====+index:====
{{Table3613|
FSO will substitute the '''Weapon Name''' at firepoint ''index'' in the shot pattern. Similar to carefully using both +period and +offset, but is not affected by ships with different firepoint numbers. i.e. Firepoint ''index'' will always have the substitution, while +period and +offset will cycle at different rates dependant on the number of firepoints.'''

*Syntax: '''''Positive Integer'''''

*'''You may not define both +period and +index for the same $Substitute entry'''

*'''Indexes start at 0 for the first weapon'''

*'''If the first index you specify is higher than 0, it will also be used for the indexes before it.'''

}}

===$Custom data:===
{{Table220|
Defines a set of custom data that for this weapon class, which can then be accessed through Lua scripts. There can be any amount of +Val: entries. It requires a $end_custom_data entry at the end.
Check the scripting documentation of Weapon Class to find the CustomData Lua Table.
====+Val:====
Specifies a custom data value and its name, in the format

+Val: Name Value

These values will always be strings of text. If you use them in Lua as other types of value, you might need to convert them in the script.

====$end_custom_data====
Mandatory entry to indicate that the Custom Data list has ended. }}

==Weapons.tbl Flags==

==="Electronics"===
*Will seize up the weapons and engines systems of any ship for a short period of time.

==="Spawn ''Name'',''Value''"===
*Will spawn the specified number of defined missiles upon detonation.
*The flag will parse without a value, using a default of 10.
{{Table3610|
*Multiple spawn types can be defined for a single 'carrier' weapon up to maximum of 5 different weapons}}

==="Remote Detonate"===
*Can be triggered remotely via a second press on the trigger

==="Big Ship"===
*These weapons cannot be mounted on small ships like fighters, bombers, sentry guns etc.

==="Huge"===
*Allows this weapon to do the final 10% damage to a ship with the "Big Damage" flag. Also the AI will not try to hit fighters with it, but only if the weapon is in a turret or is a secondary. If the weapon is a primary in a fighter then there are no targeting restrictions. See [[Weapons.tbl#.22capital.2B.22|capital+]] instead.

==="Supercap"===
*Allows this weapon to do the final 75% damage to a ship with the "supercap" flag.

==="Bomber+"===
*The AI will prefer to use this weapon against bombers

==="child"===
*Cannot be set as a weapon on any ship, but is instead a child of a weapon. Usually defined with "Spawn ''Name'',''Value''"

==="Bomb"===
*Makes this weapon target-able with the B key and interceptable by AIs
** Has been long thought to make the AI prefer this weapon against large ships, but in fact has no effect on AI weapon selection.

==="No Dumbfire"===
*Missile will not fire without a lock

==="in tech database"===
*Has the weapon in the tech database at the start of the campaign

==="Player allowed"===
*Allows this weapon as a player weapon.
{{Table3610|
*'''EXTREMELY IMPORTANT NOTE:'''
**Whenever you plan to use a weapon as a player one in your campaign or missions, '''USE THIS FLAG'''.
**Not using it can cause problems within fs_open and it's a BAD MOD DESIGN.
**In the future, fs_open will maybe be able to avoid these problems but, nevertheless, it's still a BAD DESIGN.
**As another possible example: be careful to update "retail" tables if you plan to use Shivan weapons in player fighters.}}

==="Particle Spew"===
*Makes the weapon projectile spew out particles
{{Table3610|
*Can be defined with [[Weapons.tbl#$Pspew:|Particle Spew parameters]]}}

==="EMP"===
*This weapon will have an EMP effect on any ship within the blast radius
*Can be defined with [[Weapons.tbl#$EMP_Intensity:|EMP Intensity]] and [[Weapons.tbl#$EMP_Time:|EMP Time]]

==="Esuck"===
*Drains the target's energy banks
*Can be defined with [[Weapons.tbl#$Leech_Weapon:|Leech Weapon]] and [[Weapons.tbl#$Leech_Afterburner:|Leech Afterburner]]

==="Vampiric"===
{{Table224|
*Heals shooter upon dealing hull damage to target
*Can be defined with [[Weapons.tbl#$Vampiric Healing Factor:|Vampiric Healing Factor]]}}

==="Flak"===
*Makes this weapon a [[weapons.tbl#Flak_Guns|flak gun]]

==="Corkscrew"===
*Makes this weapon spiral AND swarm 4.
{{Table3610|
*Can be defined with [[Weapons.tbl#$Corkscrew:|Corkscrew parameters]]}}

==="Shudder"===
*Makes your ship shudder while you're firing the weapon

==="lockarm"===
*Requires a target lock in order to arm its warhead. In other words weapon causes less damage if it hits the target without target lock.

==="beam"===
*Makes this weapon a [[weapons.tbl#Beam Cannons|beam cannon]]

==="stream"===
* Does nothing

==="puncture"===
*Reduces hull damage by 75%
The AI will prefer these weapons for anti-subsystem use

==="countermeasure"===
{{Table3610|
*Defines the weapon as a countermeasure}}

==="Ballistic"===
{{Table3610|
*Defines the weapon as a ballistic weapon that needs ammunition.
*Make sure you define the size and reload rate for ballistic weapons}}

==="pierce shields"===
{{Table3610|
*Causes weapons to penetrate shield without causing damage to it.}}

==="no pierce shields"===
{{Table3610|
*Prevents weapons (beams) from piercing shields causing shields to be damaged by weapons first.}}

==="local ssm"===
{{Table3610| }}

==="tagged only"===
{{Table3610|
*Weapon can only be fired at tagged targets}}

==="beam no whack"===
{{Table3610|
*Disables beam whacking (push). Practically same as setting beam mass to zero.}}

==="cycle"===
{{Table3610|
*Causes weapon to alternate between firing points}}

==="small only"===
{{Table3610|
*Causes AI to use the weapon only on small targets (fighters, bombers etc.) Only applies to the target selection of turrets, has no effect on the behavior of fighters picking primary and secondary bank weapons.}}

==="same turret cooldown"===
{{Table3610|
*Forces the turrets to fire on the designated rate of fire on all difficulty levels and all AI levels}}

==="apply no light"===
{{Table3610|
*Prevents light from being applied to the weapon model.}}

==="training"===
{{Table3610|
*Sets weapon to be of training weapon type. ?}}

==="smart spawn"===
{{Table3611|
*Forces turret fired spawn weapon of this type to be fired like normal weapons.}}

==="inherit parent target"===
{{Table3611|
*Sets spawned 'child' weapons to use parent weapon's target.}}

==="no emp kill"===
{{Table3611|
*Defines the weapon (with hitpoints) to be immune to automatic EMP destruction.}}

==="untargeted heat seeker"===
{{Table3611|
*Defines the weapon as a heatseeker type missile which acquires its target by itself.}}

==="no radius doubling"===
{{Table3611|
*Prevents weapon radius from being doubled when doing collision test. Makes bombs harder to intercept.}}

==="no subsystem homing"===
{{Table3611|
*Prevents weapon from acquiring a subsystem as its target. Missile homing points are spread over the target ship.}}

==="no lifeleft penalty"===
{{Table3611|
*Prevents weapon lifetime from being penalized if the angle to the target is too big.}}

==="can be targeted"===
{{Table3611|
*Allows weapon to be targeted by player. Does not influence AI}}

==="show on radar"===
{{Table3611|
*Allows weapon to be visible on the radar}}

==="show friendly on radar"===
{{Table3611|
*Allows friendly, otherwise visible to radar weapon, to be visible on player radar}}

==="hide from radar"===
{{Table3614|
*Prevents weapon from being visible on the radar}}

==="capital+"===
{{Table3613|
*Tells AI fighters/bombers to use this weapon only on capital ships. Has no effect on turret AI.}}

==="chain external model fps"===
{{Table3613|
*Tells game to keep switching external model firingpoints when firing}}

==="external model launcher"===
{{Table3613|
*Tells game that the external model is a launcher so that it would be kept static without loading motion}}

==="takes blast damage"===
{{Table3613|
*Weapon takes damage from weapon blasts}}

==="takes shockwave damage"===
{{Table3613|
*Weapon takes damage from shockwaves}}

==="ciws"===
{{Table3615|
*Weapon can deal shockwave/blast damage to bombs, regardless of whether the target weapons have the "take blast/shockwave damage" flags.}}

==="render flak"===
{{Table3615|
*Normally, flak shells are not rendered. This flag switches rendering on for those weapons.}}

==="anti-subsystem beam"===
{{Table3615|
*Beam weapons with this flag can target subsystems on enemy ships, just like normal weapons.}}

==="no primary linking"===
{{Table3615|
*Primary weapons with this flag can not be linked with other weapons.}}

==="same emp time for capships"===
{{Table37|
*capships affected by this weapon will use the tabled EMP time rather than the fixed retail value (7.5 secs)}}

==="no primary linked penalty"===
{{Table371|
*Primary weapons with this flag do not incur the retail linked fire penalty}}

==="no homing speed ramp"===
{{Table371|
*Locked homing weapons will not perform the standard 1 second long acceleration when fired. Note that use of $Acceleration Time is '''not''' affected by this flag.}}

==="pulls aspect seekers"===
{{Table371|
*If an aspect seeker is grabbed by this countermeasure the missile will follow the countermeasure instead of going into dumbfire mode.
'''Only valid for countermeasures!'''}}

==="turret interceptable"===
==="fighter interceptable"===
==="interceptable"===
{{Table371|
*Allows turrets/fighters/both (respectively) to shoot at this weapon without requiring it to be a bomb. If this is the first time this weapon has been defined, it also gives it a default of 25 hitpoints so that it can be shot down.
'''If you use a TBM to give this flag to an existing weapon, you'll need to specify hitpoints manually (unless you want it to be unkillable but still draw defensive fire).'''}}

==="aoe electronics"===
{{Table372|
*Apply electronics effect across the weapon's entire area of effect instead of just on the impacted ship}}

==="apply recoil"===
{{Table373|
*A ship that fires a weapon with this flag will experience a recoil effect, slowing the ship down and, with lighter strikecraft, inducing some rotation if the firing points are offset from the center of mass.}}

==="don't spawn if shot"===
{{Table373|
*Prevents parent weapons from spawning children in the even of the parent weapon being shot down.}}

==="die on lost lock"===
{{Table373|
*Aspect seeking missiles (only, not heat seekers) will detonate upon losing their lock. Currently they only lose lock if decoyed by a countermeasure, AND "pulls aspect seekers" or similar is not set. The detonation will use their "dinky" explosion (i.e. same as if ran out of lifetime).}}

==="no doublefire"===
{{Table202|
*Prevents dual-firing of secondary weapons. If the ship tries to dual-fire a weapon with this flag they are set back to single fire.}}

==="no impact spew"===
{{Table202|
*Turns off the usual spew effects that occur on the impacted ship when a weapon hits it.}}

==="require exact los"===
{{Table202|
*Prevent AI form firing this weapon from a turret or as a secondary weapon if there is no clear line of sight from the weapons firing point to its targeted ship (center). Note that this may keep the weapon trained on a target out of sight while another target may be available to shoot.}}

==="can damage shooter"===
{{Table212|
*This weapon can collide with and directly damage the original shooter of this weapon (even if it was spawned), which is not normally possible.}}

==="heals"===
{{Table214|
*This weapon uses its $Damage value to heal its target(s) instead of damaging them.
*This works very similarly to damage, the armor/shield/subsystem factors apply to healing as well as do armor classes. However, there are some caveats. 
*Healing will ''always'' carry. Unlike damage, which first has to go through the shield, has damage subtracted, then damages subsystems, has damage subtracted, then finally damages the hull if any damage remains, healing will apply in full to hull, shield, and subsystems (factors or armor classes notwithstanding). A weapon with 100 'healing' will attempt to apply that healing to the hull, shield and nearby subsystems to the impact. Even if the weapon only heals hull, it will still do so even if it strikes the shield.}}

==="secondary no ammo"===
{{Table220|
*If this is a secondary weapon, it does not need to consume any ammo, and will not display ammo in the weapon HUD gauge, etc.}}

==="no collide"===
{{Table220|
*This weapon will not collide with any other object.}}

==="multilock target dead subsys"===
{{Table220|
*If this is a multilock weapon, dead subsystems will be treated as just as valid targets as alive ones.}}

==="no evasion"===
{{Table220|
*AI will not attempt to evade this weapon when fired at them}}

==="no_fred"===
{{Table224|
*Weapon will not appear in any of the FRED dropdown lists for weapon classes.}}

==="detonate on expiration"===
{{Table232|
*Primary weapon will detonate as if hitting a target when it reaches the end of its lifetime - just like a secondary weapon does by default.}}

==Countermeasures==
*Usually not altered. Only one can exist
{{Table3610|
*More than one can exist}}

===$Name:===
*Name of the countermeasure
*Syntax: '''''String''''', name

===$Velocity:===
*Defines the speed of the countermeasure, relative to the ship.
*Syntax: '''''Float''''', meter per second

===$Fire Wait:===
*Definies the minumum time between the countermeasure launches
*Syntax: '''''Float''''', seconds

===Lifetime===
*Countermeasure's life time is defined between with minimum and maximum lifetime
*'''$Lifetime Min:'''
**Syntax: '''''Float''''', seconds
*'''$Lifetime Max:'''
**Syntax: '''''Float''''', seconds

===$LaunchSnd:===
*Defines the sound for the countermeasure launch
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Model:===
*Defines the used model file (.pof)
*Syntax: '''''String.pof''''', model filename

==Player Weapon Precedence==
*First the primary weapons are defined, from most powerful to least powerful, and then the same for secondaries
*Syntax: ( '''''"String" "String"'''''), names of the weapons
*Example:

<pre>
$Player Weapon Precedence: (
"UD-8 Kayser"
"Prometheus R"
"Subach HL-7"
"Harpoon"
"Tempest"
"Rockeye" )
</pre>

==Sample==

<pre>
#Primary Weapons

$Name: @Subach HL-7
+Title: XSTR("GTW Subach HL-7", 3243)
+Description:
XSTR( "Standard Issue
Level 3 Hull Damage
Level 2 Shield Damage", 3244)
$end_multi_text
+Tech Title: XSTR("Subach HL-7", 146)
+Tech Anim: Tech_Subach_HL-7
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: none
@Laser Bitmap: newglo9
@Laser Glow: 2_laserglow03
@Laser Color: 250, 0, 0
@Laser Color2: 0, 0, 250
@Laser Length: 10.0
@Laser Head Radius: 0.90
@Laser Tail Radius: 0.90
$Mass: 0.2
$Velocity: 450.0
$Fire Wait: 0.2
$Damage: 15
$Armor Factor: 0.9
$Shield Factor: 0.7
$Subsystem Factor: 0.3
$Lifetime: 2.0
$Energy Consumed: 0.20
$Cargo Size: 0.0
$Homing: NO
$LaunchSnd: 76
$ImpactSnd: 85
$Flags: ( "in tech database"
"player allowed"
"stream")
$Icon: iconSD4
$Anim: SD4
$Impact Explosion: none

#End

#Secondary Weapons

$Name: EMP Adv.
+Title: XSTR("GTM-14 EMP Adv.", 3396)
+Description:
XSTR( "Advanced Missile
Electromagnetic Pulse Weapon
General Purpose Suppression", 3397)
$end_multi_text
+Tech Title: XSTR("GTM-14 EM Pulse Adv.", 3398)
+Tech Anim: Tech_EMP
+Tech Description:
XSTR(
"Descriptive text...", -1)
$end_multi_text
$Model File: EMPulse2.pof
$Mass: 15.0
$Velocity: 275.0
$Fire Wait: 2.0
$Damage: 45
$Blast Force: 20.0
$Inner Radius: 80.0
$Outer Radius: 300.0
$Shockwave Speed: 120.0
$Armor Factor: 1.0
$Shield Factor: 0.8
$Subsystem Factor: 0.5
$Lifetime: 5.0
$Energy Consumed: 0.0
$Cargo Size: 4.0
$Homing: YES
+Type: ASPECT
+Turn Time: 1.0
+Min Lock Time: 2.0
+Lock Pixels/Sec: 70
+Catch-up Pixels/Sec: 100
+Catch-up Penalty: 30
$LaunchSnd: 118
$ImpactSnd: 88
$FlyBySnd: -1
$Rearm Rate: 2.0
$Flags: ( "player allowed"
"EMP")
$Trail:
+Start Width: 0.25
+End Width: 0.75
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.5
+Bitmap: MissileTrail04
$Icon: iconEMPulse
$Anim: ecm
$Impact Explosion: ExpMissileHit1
$Impact Explosion Radius: 10.0
$EMP Intensity: 375.0
$EMP Time: 20.0

#End

$Player Weapon Precedence: (
"Subach HL-7"
"EMP Adv." )
</pre>

[[Category:Tables]]

Lighting Profiles.tbl

2023-02-02T00:57:36Z

-Joshua-:

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance, which gives a more vibrant look.

The best way to view the differences between all of these is to open the F3 lab.
}}

===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you'll see a lot of bright white spots, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means you'll see less full white areas, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. It differs from shoulder length in that shoulder length 'selects' the areas in which the shoulder should be applied, and shoulder strength determines how strongly it should be applied.
This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laser light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Overall brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to all adjustable light.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cockpit light radius modifier:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+default: 20

$Laser Light Radius:
+default: 100

$Beam Light Radius:
+default: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>

== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-12-28T09:47:41Z

-Joshua-: /* $PPC Shoulder Strength: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance, which gives a more filmic look. Compared to PPC, darker parts of the image will have more saturated colours, whilst brighter parts of the image will be more desaturated.

The best way to view the differences between all of these is to open the F3 lab.
}}

===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you'll see a lot of bright white spots, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means you'll see less full white areas, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. It differs from shoulder length in that shoulder length 'selects' the areas in which the shoulder should be applied, and shoulder strength determines how strongly it should be applied.
This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laser light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cockpit light radius modifier:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+default: 20

$Laser Light Radius:
+default: 100

$Beam Light Radius:
+default: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>

== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-12-28T09:46:25Z

-Joshua-: /* $PPC Shoulder Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance, which gives a more filmic look. Compared to PPC, darker parts of the image will have more saturated colours, whilst brighter parts of the image will be more desaturated.

The best way to view the differences between all of these is to open the F3 lab.
}}

===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you'll see a lot of bright white spots, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means you'll see less full white areas, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laser light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cockpit light radius modifier:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+default: 20

$Laser Light Radius:
+default: 100

$Beam Light Radius:
+default: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>

== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-12-28T09:44:04Z

-Joshua-: /* $PPC Toe Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance, which gives a more filmic look. Compared to PPC, darker parts of the image will have more saturated colours, whilst brighter parts of the image will be more desaturated.

The best way to view the differences between all of these is to open the F3 lab.
}}

===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you get a naturally occuring bloom effect, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means that that bloom effect is diminished, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laser light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cockpit light radius modifier:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+default: 20

$Laser Light Radius:
+default: 100

$Beam Light Radius:
+default: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>

== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-12-28T09:42:57Z

-Joshua-: /* $Tonemapper: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance, which gives a more filmic look. Compared to PPC, darker parts of the image will have more saturated colours, whilst brighter parts of the image will be more desaturated.

The best way to view the differences between all of these is to open the F3 lab.
}}

===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas. You probably want this to be quite low given the darkness of the void.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you get a naturally occuring bloom effect, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means that that bloom effect is diminished, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laser light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cockpit light radius modifier:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+default: 20

$Laser Light Radius:
+default: 100

$Beam Light Radius:
+default: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>

== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-12-28T09:41:50Z

-Joshua-: /* $Tonemapper: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance, which gives a more filmic look. Compared to PPC, darker parts of the image will have more saturated colours, whilst brighter parts of the image will be more desaturated.
}}

===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas. You probably want this to be quite low given the darkness of the void.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you get a naturally occuring bloom effect, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means that that bloom effect is diminished, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laser light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cockpit light radius modifier:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+default: 20

$Laser Light Radius:
+default: 100

$Beam Light Radius:
+default: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>

== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-12-28T09:38:51Z

-Joshua-: /* $Tonemapper: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance. Compared to PPC, darker parts of the image will have more saturated colours, whilst brighter parts of the image will have its colours turn into white.
}}

===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas. You probably want this to be quite low given the darkness of the void.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you get a naturally occuring bloom effect, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means that that bloom effect is diminished, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laser light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cockpit light radius modifier:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+default: 20

$Laser Light Radius:
+default: 100

$Beam Light Radius:
+default: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>

== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-12-28T09:37:58Z

-Joshua-: /* $Tonemapper: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance. Compared to regular PPC, darker parts of the image will have more saturated colours, whilst brighter parts of the image will have its colours turn into white.
}}

===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas. You probably want this to be quite low given the darkness of the void.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you get a naturally occuring bloom effect, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means that that bloom effect is diminished, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laser light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cockpit light radius modifier:===
{{Table224|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all lights, only applied when rendering the player ships cockpit and "show ship" model
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+default: 20

$Laser Light Radius:
+default: 100

$Beam Light Radius:
+default: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>

== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Ai profiles.tbl

2022-12-25T23:09:33Z

-Joshua-: /* $any ship with no shields can manage ETS: */

{{SCP_table}}
{{TableVersionGit|2020-10-09|465af93dc}}
{{Tables}}
The '''ai_profiles.tbl''' allows the creation and management of different patterns of AI behavior, called profiles. Profiles consist of various statistics and flags that provide some control over AI behavior. All options within a profile are optional; if an option is not specified it will follow the original FreeSpace 2 retail behavior. Different missions can specify different profiles.

The default ai_profiles.tbl is hardcoded into the FSO executable, and defines the "FS2 RETAIL" AI profile. It's usually recommended not to modify this profile, but to create a new AI profile in a modular table instead, which will then inherit its defaults from the FS2 RETAIL profile.

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

If the version targeted in [[game_settings.tbl]] is equal to or later than these listed, the following options are enabled by default:
{{Table3610|
*'''reset last_hit_target_time for player hits'''}}
{{Table372|
*'''fix ramming stationary targets bug'''}}
{{Table202|
*'''huge turret weapons ignore bombs'''
*'''fix linked primary weapon decision bug'''
*'''prevent turrets targeting too distant bombs'''
*'''fix heat seekers homing on stealth ships bug'''
*'''allow vertical dodge'''
*'''fix ai class bug'''
*'''ai guards specific ship in wing'''
*'''fix ai path order bug'''
*'''aspect bomb invulnerability fix'''
*'''use actual primary range'''
*'''any ship with no shields can manage ETS'''}}
{{Table214|
*'''fixed ship-weapon collisions'''}}
{{Table220|
*'''fighterbay arrivals use carrier orientation'''
*'''prevent negative turret ammo'''
*'''fix keep-safe-distance'''}}
{{Table224|
*'''fix good-rearm-time bug'''
*'''no continuous turn on attack'''
*'''remove-goal properly removes play-dead order'''}}

==General Format==
'''#AI Profiles'''

'''$Default Profile:''' ''a profile name''

''Up to 9 different AI profiles''

'''#End'''

==#AI Profiles==
*Indicates to the parser that this is an ai_profiles table file.

===$Default Profile:===
*Defines the profile that each mission will use if no profile is specified in FRED. In addition, this profile will be selected automatically in FRED when you create a new mission. If this line is not specified, the default profile will be the FreeSpace 2 retail behavior.

===$Profile Name:===
*The name of the profile, naturally.

----

The following entries accept '''float list''' of five comma-separated values. One value for each of the difficulty levels (Very Easy, Easy, Medium, Hard, Insane).

===$Player Afterburner Recharge Scale:===
{{Table3610|
*Sets the speed of afterburner recharge
*Syntax: '''Float list'''
**Default: 5, 3, 2, 1.5, 1}}

===$Max Beam Friendly Fire Damage:===
{{Table3610|
*Defines the maximum damage inflicted by friendly beam fire
*Syntax: '''Float list'''
**Default: 0, 5, 10, 20, 30}}

===$Player Countermeasure Life Scale:===
{{Table3610|
*Sets the factor applied to player launched countermeasure lifetime
*Syntax: '''Float list'''
**Default: 3, 2, 1.5, 1.25, 1}}

===$AI Countermeasure Firing Chance:===
{{Table3610|
*Defines the chance a countermeasure will be fired by an AI-controlled ship (this is scaled by ai_class)
*Syntax: '''Float list'''
**Default: 0.2, 0.3, 0.5, 0.9, 1.1}}

===$AI In Range Time:===
{{Table3610|
*The delay (in seconds) for the AI to fire its weapons after getting in range.
*Syntax: '''Float list'''
**Default: 2, 1.4, 0.75, 0, -1}}

===$AI Always Links Ammo Weapons:===
{{Table3610|
*AI ships will link ballistic primaries if ammo levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 95, 80, 60, 40, 20}}

===$AI Maybe Links Ammo Weapons:===
{{Table3610|
*Defines the same as '''$AI Always Links Ammo Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$Primary Ammo Burst Multiplier:===
{{Table3611|
*Allows the AI to fire primary weapons in bursts. How long the bursts are (and how much time between them) is a function of ammo remaining, distance to target, angle to target, and this multiplier. A value of 0 turns this feature off (AI fires normally, without bursts). A value < 1 will make for shorter bursts with larger gaps, and a value > 1 will give longer bursts with shorter gaps.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$AI Always Links Energy Weapons:===
{{Table3610|
*AI ships will link energy primaries if energy levels are greater than these percents.
*Syntax: '''Float list'''
**Default: 100, 80, 60, 40, 20}}

===$AI Maybe Links Energy Weapons:===
{{Table3610|
*Defines the same as '''$AI Always Links Energy Weapons:''' but in situations when its hull is below 33 % of maximum hitpoints.
*Syntax: '''Float list'''
**Default: 90, 60, 40, 20, 10}}

===$Max Missiles Locked on Player:===
{{Table3610|
*Defines the maximum number of missiles allowed to be homing in on a player at any given time
*Note: Single-player only, no restriction in multiplayer
*Note: The alternative spelling "Missles" is also accepted for backwards compatibility reasons.
*Syntax: '''Float list'''
**Default: 2, 3, 4, 7, 99}}

===$Max Player Attackers:===
{{Table3610|
*Sets the maximum number of ships allowed to be attacking the player at any given time
*This number is also checked when a ship checks for a new target, such as using the goal attack-any.
*Syntax: '''Float list'''
**Default: 2, 3, 4, 5, 99}}

===$Max Incoming Asteroids:===
{{Table3610|
*Sets the maximum number of active (i.e. "thrown") asteroids that can be heading toward a friendly ship at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 5, 7, 10}}

===$Player Damage Factor: or $AI Damage Reduction to Player Hull:===
{{Table3610|
*Defines the factor applied to damage suffered by the player
*Syntax: '''Float list'''
**Default: 0.25, 0.5, 0.65, 0.85, 1}}

===$Player Subsys Damage Factor: or $AI Damage Reduction to Player Subsys:===
{{Table3610|
*Sets the factor applied to subsystem damage suffered by the player. This is in addition to the '''$Player Damage Factor:'''
*Syntax: '''Float list'''
**Default: 0.2, 0.4, 0.6, 0.8, 1}}

===$Predict Position Delay:===
{{Table3610|
*Sets the time after which the AI will recalculate the position of its target.
*It does not apply to the AI's aim, it only applies to things like avoiding collisions and maneuvering at close range. Generally, anything other than a 0 just allows the AI to do monumentally stupid things like try to turn to avoid ramming where it thought you were 2 seconds ago.
*Syntax: '''Float list''', seconds
**Default: 2, 1.5, 1.333, 0.5, 0}}

===$AI Shield Manage Delay:===
{{Table3610|
*Also '''$AI Shield Manage Delays:'''
*Sets the time in seconds between each instance of an AI ship managing its shields
*Syntax: '''Float list'''
**Default: 5, 4, 2.5, 1.2, 0.1}}

===$Friendly AI Fire Delay Scale:===
{{Table3610|
*Sets the factor applied to "fire wait" for friendly ships
*Syntax: '''Float list'''
**Default: 2, 1.4, 1.25, 1.1, 1}}

===$Hostile AI Fire Delay Scale:===
{{Table3610|
*Sets the factor applied to "fire wait" for hostile ships
*Syntax: '''Float list'''
**Default: 4, 2.5, 1.75, 1.25, 1}}

===$Friendly AI Secondary Fire Delay Scale:===
{{Table3614|
*Sets the factor applied to "fire wait" for friendly ships
*Syntax: '''Float list'''
**Default: 0.4, 0.6, 0.8, 1.0, 1.2}}

===$Hostile AI Secondary Fire Delay Scale:===
{{Table3614|
*Sets the factor applied to "fire wait" for hostile ships
*Syntax: '''Float list'''
**Default: 1.4, 1.2, 1.0, 0.8, 0.6}}

===$AI Turn Time Scale:===
{{Table3610|
*Defines the factor applied to time it takes for enemy ships to turn. A value of 1.0 means the ship turns at normal speed, 2.0 means half speed (takes twice as long), etc. Note that this value ONLY affects ships hostile to the player (always 1.0 for friendly ships).
*Syntax: '''Float list'''
**Default: 3, 2.2, 1.6, 1.3, 1}}

===$Glide Attack Percent:===
{{Table3611|
*How often the AI will use the "glide attack" move when it has the opportunity. Glide attack means using glide to maintain course while aiming and firing at the current target. Only affects ships capable of glide.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Circle Strafe Percent:===
{{Table3611|
*How often the AI will use the "circle strafe" move when it has the opportunity. Circle strafe means that the ship will attempt "Descent-like" combat, trying to maintain distance while circling around the target using sidethrusters. Ships will only attempt this when sidethrust top speed is at least 2/3 of target's current velocity.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Glide Strafe Percent:===
{{Table3611|
*How often the AI will use the "glide strafe" move when it has the opportunity. Glide strafe means using glide to attack capships by flying past and shooting at them. Only affects ships capable of glide.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Random Sidethrust Percent:===
{{Table3611|
*Percentage of the time where AI ships will randomly sidethrust in a dogfight.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Stalemate Time Threshold:===
{{Table3611|
*The minimum amount of time required for the AI to detect a "stalemate" situation. If a ship and its target have been within a certain distance of each other (defined by ''$Stalemate Distance Threshold'') for this amount of time without either of them scoring a hit on the other, the AI will do something to break the stalemate. Only applies to small ships. If this value is 0 or less, no stalemate detection is performed.
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Stalemate Distance Threshold:===
{{Table3611|
*The maximum distance that an AI ship must remain from its target for a "stalemate" to occur (see ''$Stalemate Time Threshold'').
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Player Shield Recharge Scale:===
{{Table3610|
*Defines the factor applied to the speed at which the player's shields recharge
*Syntax: '''Float list'''
**Default: 4, 2, 1.5, 1.25, 1}}

===$Player Weapon Recharge Scale:===
{{Table3610|
*Defines the factor applied to the speed at which the player's weapons recharge
*Syntax: '''Float list'''
**Default: 10, 4, 2.5, 2, 1.5}}

===$Max Turret Target Ownage:===
{{Table3610|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the same target at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

===$Max Turret Player Ownage:===
{{Table3610|
*Sets the maximum number of turrets on a particular ship allowed to be attacking the player at any given time
*Syntax: '''Float list'''
**Default: 3, 4, 7, 12, 19}}

===$Percentage Required For Kill Scale:===
{{Table3610|
*Sets the minimum percentage of the total assessed damage a player must inflict in order to be awarded a kill (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.30, 0.30, 0.30, 0.30, 0.30}}

===$Percentage Required For Assist Scale:===
{{Table3610|
*Sets the minimum percentage of the total assessed damage a player must inflict in order to be awarded an assist (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.15, 0.15, 0.15, 0.15, 0.15}}

===$Percentage Awarded For Capship Assist:===
{{Table3610|
*In TvT and Coop missions all teammates will be granted this percentage of the capships score when someone scores a kill (3.6.10 and on)
*Syntax: '''Float list'''
**Default: 0.5, 0.5, 0.5, 0.5, 0.5}}

===$Repair Penalty:===
{{Table3611|
*The amount to subtract from the player's score if they are repaired by a support ship
*Syntax: '''Integer list'''
**Default: 10, 20, 35, 50, 60}}

===$Delay Before Allowing Bombs to Be Shot Down:===
{{Table3611|
*Time after bombs are fired during which the bombs are invulnerable to weapon hits
*Syntax: '''Float list'''
**Default: 1.5, 1.5, 1.5, 1.5, 1.5}}

===$Chance AI Has to Fire Missiles at Player:===
{{Table3611|
*Chance - expressed in ('''value''' + 1) / 7 - of each AI turret within current 10 second segment to be allowed to shoot missiles at player ship.
*Syntax: '''Float list'''
**Default: 0, 1, 2, 3, 4}}

===$Max Aim Update Delay:===
{{Table3611|
*Maximum amount of delay allowed before the AI will update its aim. Until the next update, the AI will project the target forward based on last checked position and velocity. Applies to small ships vs small ships (dogfights). The actual delay is randomly selected between 0 and the maximum (so setting a value of 2 will result in an average of 1 second delay).
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Turret Max Aim Update Delay:===
{{Table3611|
*As $Max Aim Update Delay, but affecting turrets instead
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Player Autoaim FOV:===
{{Table3613|
*Gives the player autoaim within the specified number of degrees from the target (FOV).
*Unlike the ships.tbl settings for autoaim, this only affects the player (and, of course, only if there is a nonzero value for the difficulty level.)
*Syntax: '''Float list'''
**Default: 0, 0, 0, 0, 0}}

===$Detail Distance Multiplier:===
{{Table3613|
*Affects how the "model detail level" setting in Options switches between LOD levels.
*This number acts as a multiplier on the LOD distances specified in ships.tbl.
*NOTE THAT THIS IS PER DETAIL LEVEL, NOT PER DIFFICULTY LEVEL.
*Syntax: '''Float list'''
**Default: 0.125, 0.25, 1.0, 4.0, 8.0}}
----

The following entries are boolean flags. They can be set to ''YES'' or ''NO'', ''TRUE'' or ''FALSE'', ''OUI'' or ''NON'', ''HIja′'' or ''ghobe′'', etc. The default is ''NO''.

===$big ships can attack beam turrets on untargeted ships:===
{{Table3610|
*If set, big ships can attack a beam turret that's firing on them from a ship that they don't currently have targeted.}}

===$smart primary weapon selection:===
{{Table3610|
*If set, enables the new primary weapon selection method}}

===$smart secondary weapon selection:===
{{Table3610|
*If set, enables the new secondary weapon selection method (including proper use of bomber+ missiles)}}

===$smart shield management:===
{{Table3610|
*If set, shields will devote all their charging energy to the weakest quadrant(s) and not waste energy on fully-charged quadrants (previously was -smart_shields on the command line)}}

===$smart afterburner management:===
{{Table3610|
*If set, the AI will properly use brief pulses of afterburner power instead of afterburning until fuel is exhausted}}

===$free afterburner use:===
{{Table382|
*If set, the AI will use afterburners in more situations.}}

===$allow rapid secondary dumbfire:===
{{Table3610|
*If set, allows an AI ship to switch to rapid fire for dumbfire missiles}}

===$huge turret weapons ignore bombs:===
{{Table3610|
*If set, causes huge turret weapons (including anti-capship beams) to not target bombs}}

===$don't insert random turret fire delay:===
{{Table3610|
*If set, removes the random turret fire delay (from .1 to .9 seconds) inserted in addition to AI Fire Delay Scale}}

===$hack improve non-homing swarm turret fire accuracy:===
{{Table3610|
*If set, triggers a hack to improves the accuracy of non-homing swarm missiles by firing them along the turret's last fire direction rather than the direction it currently faces
*Also disables swarm weapons ability to fire only on the 'turrets barrel line'.}}

===$shockwaves damage small ship subsystems:===
{{Table3610|
*If set, shockwaves will cause damage to small ship subsystems (like in FS1)}}

===$navigation subsystem governs warpout capability:===
{{Table3610|
*If set, ships will not be able to warp out if their navigation subsystem is destroyed or low in strength}}

===$check communications for non-player ships:===
{{Table202|
*When set, every ship will have the same communications subsystem restrictions as the player, including minimum strength to send messages and EMP scramble status.
*Off by default.
*Syntax: '''''Boolean'''''}}

===$ignore lower bound for minimum speed of docked ship:===
{{Table3610|
*If set, there will be no lower bound for the speed at which docked ships move (like in FS1).
*When a ship is towing another ship or ships, the towing ship will be slowed down to a degree depending on the total mass of all docked ships. In FS1, the ships could slow down to an arbitrarily slow speed, even a fraction of a m/s above zero. In FS2, there is a lower bound on this behavior so that all ships are guaranteed to move at a minimum docked speed. When set, this flag removes the lower bound and restores FS1 behavior.}}

===$disable linked fire penalty:===
{{Table3610|
*If set, there will be no penalty for linking primaries. Normally, the rate of fire is *1 for a single bank, *0.66 for two banks and *0.5 for three banks (the fire delay is increased according to the formula 1+([nb of banks]-1)*0.5 ).}}

===$disable player secondary doublefire:===
{{Table202|
*If set, players are not allowed to dual-fire their secondaries.}}

===$disable ai secondary doublefire:===
{{Table202|
*If set, AIs are not allowed to dual-fire their secondaries.}}

===$disable weapon damage scaling:===
{{Table3610|
*If set, weapons will do the same damage to a ship regardless of "big damage", "supercap", etc. ship types.}}

===$use additive weapon velocity:===
{{Table3610|
*If set, weapons will inherit their firing ship's velocity. A ship traveling quickly will fire weapons faster than a ship traveling slowly. This also improves the accuracy of weapons fired while gliding.}}

===$use newtonian dampening:===
{{Table3610|
*Newtonian Dampening changes turning and acceleration behavior. By default, there's quite a bit of slide when you turn, and when combined with high damp values (such as in BtRL), you can actually push your speed up beyond the max. Newtonian Dampening is the more realistic turns, where too much turning will lower your speed. Forward momentum is also affected. Backslash can explain it in more detail. [http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741] }}

===$include beams for kills and assists:===
{{Table3610|
*If set, beam damage is counted when calculating kills and assists.}}

===$score kills based on damage caused:===
{{Table3610|
*If set, kills gain score based on the percentage damage the killer inflicted on the dead ship.}}

===$score assists based on damage caused:===
{{Table3610|
*If set, kills gain score based on the percentage damage the player gaining the assist inflicted on the dead ship.}}

===$allow event and goal scoring in multiplayer:===
{{Table3610|
*If set, players (rather than just their team) can gain score from events in multiplayer.}}

===$fix linked primary weapon decision bug:===
{{Table3610|
*If set, the AI will properly link primaries according to specified percentages of energy levels instead of retail behavior where it mistakenly linked according to absolute energy levels.}}

===$fix ramming stationary targets bug:===
{{Table202|
*When set, AI ships will try not to crash into stationary targets. See [http://scp.indiegames.us/mantis/view.php?id=3147 Mantis #3147].
*Off by default.
*Syntax: '''''Boolean'''''}}

===$prevent turrets targeting too distant bombs:===
{{Table3610|
*If set, prevents turrets from targeting bombs beyond maximum range of the weapons of the turret.}}

===$smart subsystem targeting for turrets:===
{{Table3610|
*If set, prevents turrets from trying to target subsystems beyond their fov limits, also keeps the turret subsystem targeting preference order intact regardless of the angle to the target.}}

===$fix heat seekers homing on stealth ships bug:===
{{Table3610|
*If set, heat-seeking missiles will not home in on stealth ships (this mirrors the established behavior where heat-seeking missiles do not home in on ships that are hidden from sensors).}}

===$multi allow empty primaries:===
{{Table3610|
*If set, allows a player to commit into a multiplayer game without primaries.}}

===$multi allow empty secondaries:===
{{Table3610|
*If set, allows a player to commit into a multiplayer game without secondaries.}}

===$allow turrets target weapons freely:===
{{Table3611|
*If set, allows turrets to target any weapons instead of just targeting bombs, to be used in conjunction with target priorities setup.}}

===$use only single fov for turrets:===
{{Table3611|
*If set, allows turrets to fire outside some hardcoded FOV set for certain missile types limits, and rely only on the user defined FOV.}}

===$allow vertical dodge:===
{{Table3611|
*If set, allows ships to dodge weapons fire vertically as well as horizontally.}}

===$force beam turrets to use normal fov:===
{{Table3611|
*If set makes beam turrets use same FOV rules as other weapons do. Prevents beam from a turret from following the target beyond the turret's FOV}}

===$fix AI class bug:===
{{Table3611|
*Fixes a bug where AI class attributes are not set properly on ships if the AI class is set in the mission to something other than the default for the ship type. Set this to YES if you want attributes in [[Ai.tbl]] to mean anything at all.}}

===$turrets ignore targets radius in range checks:===
{{Table3611|
*TBD.}}

===$no extra collision avoidance vs player:===
{{Table3611|
*Disables the extra collision avoidance that AI normally uses against the player. Makes the AI more aggressive vs the player at close range (same treatment as vs other AI), although ship-ship collisions are slightly more likely.}}

===$perform fewer checks for death screams:===
{{Table3614|
*If set, the game will check if the dying ship is a player's wingman, before making it give a death scream.
Prior to revision 9119, this was "$perform less checks for death screams:", but the old version will still parse correctly.}}

===$advanced turret fov edge checks:===
{{Table3614|
*Forces all turrets to use [[Subsystem#.22fov_edge_checks.22|"fov edge checks"]].}}

===$require turrets to have target in fov:===
{{Table3614|
*Forces all turrets to use [[Subsystem#.22target_requires_fov.22|"target requires fov"]].}}

===$all ships manage shields:===
{{Table3613|
*Allows AI to manage shields on big ships}}

===$ai aims from ship center:===
{{Table3613|
*AI aims weapons using the center of the ship instead of the first gunpoint. If a convergence offset is specified for this ship in ships.tbl, AI aims using that as a reference point.}}

===$allow primary link at mission start:===
{{Table37|
*Normally, no ships will link primaries for the first 30 seconds of a mission. In addition, ships will randomly not link for the first two minutes of a mission. Set this flag to YES to get rid of this often-problematic retail behavior. (Prior to revision 9119, this was called $allow primary link delay and defaulted to YES; to get rid of retail behavior you would specify NO. The old method is still supported for compatibility.)}}

===$allow beams to damage bombs:===
{{Table3613|
* Default: NO.
* When no, when any secondary encounters any beam it is instantly destroyed regardless of if it is marked as interceptable, has a health value, or any other circumstance that would normally apply to interception by other weapons.
* When true, damage and health values are respected in these circumstances. Secondaries without hitpoints are still destroyed, however.
}}

===$disable weapon damage scaling for player:===
{{Table3613|
*When set, Player weapon damage will no longer be scaled down when firing a non-huge primary against a ship with the "big damage" flag. Use with caution, as this may severely impact mission balance.}}

===$countermeasures affect aspect seekers:===
{{Table3613|
*By default, an aspect seeker that's been decoyed by a CM just flies straight forward, while a heatseeker in the same position will actively home in on the CM. This flag makes aspect seekers match heatseeker behavior in this regard.}}

===$ai guards specific ship in wing:===
{{Table3615|
*If ordered to guard a ship in a wing (of which it is not a member), the AI will guard that specific ship instead of the entire wing (resulting in guarding the wing leader).}}

===$support don't add primaries:===
{{Table382|
*When set, the support ship will not equip a new primary weapon into an empty bank.
*Off by default.
*Syntax: '''''Boolean'''''}}

===$fighterbay arrivals use carrier orientation:===
{{Table220|
*Causes all ships arriving via a ship's fighterbay to attempt to align their right vector with their carrier's right vector as they exit.
*Syntax: '''''Boolean'''''}}

===$fighterbay departures use carrier orientation:===
{{Table220|
*Causes all ships departing via a ship's fighterbay to attempt to align their right vector with their carrier's right vector as they enter.
*Syntax: '''''Boolean'''''}}

===$ai path mode:===
{{Table3613|
*Possible options are "normal" and "alt1". The alt1 mode differs from the normal behaviour in the following ways:
**1. No path shortcutting. Normal pathing AI will skip forward along a path to the furthest point it can reach. This is sometimes desirable, but makes it a lot harder to predict how the AI is going to behave at various points along a path. Turning this off also allows us to force the AI to straighten out, by giving it several waypoints in a more-or-less straight line. This is useful for such things as lining up a landing.
**2. No sliding when following paths. Docking still works, but there is some code that causes the AI to go full retard if it just misses a point: it turns towards the point in big, looping circles. This is apparently caused by passing a slide_vec value into ai_turn_towards_vector, which doesn't even seem to do what you'd expect it to do. Passing a null value instead turns off the stupid. (The behavior is fixed in alt1).
**3. Momentum taken into account when following paths. Path points will trigger sooner, proportional to the ship's speed and momentum. This prevents the AI from massively overshooting a waypoint, especially with high-damp ships.
**4. AI tries to follow the line between waypoints. Instead of just pointing at the next waypoint, the AI will fly a bit towards the line. This helps keep the AI actually on the path it claims to be following. See picture:[[Image:Altpaths.png]]
Blue is what happens with regular pathing. Red is the modified pathing: as you can see, it actively moves back towards the line.
**5. AI will respect "cap-waypoint-speed" when following paths (such as when docking or departing via bay).}}

===$default weapon select effect:===
{{Table3613|
*This specifies which effect to use for weapon select animations when no .ani can be found, or the -weapon_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}
{{Table3615|
*This flag has been moved to [[Game_settings.tbl]]}}

===$default ship select effect:===
{{Table3613|
*This specifies which effect to use for ship select animations when no .ani can be found, or the -ship_choice_3d commandline flag is active. This will default to the FS2 effect.
*Possible options are "FS1" and "off"}}
{{Table3615|
*This flag has been moved to [[Game_settings.tbl]]}}

===$no warp camera:===
{{Table3615|
*When set, prevents the view from switching to the external camera when the player warps out.
*Note: this flag is deprecated and may get moved to another table without further notice.}}

===$fix ai path order bug:===
{{Table3615|
*When set, ship will follow its own waypoint path unless the wingleader has the same waypoint path and order.
*Off by default.
*Syntax: '''''Boolean'''''}}

===$strict turret-tagged-only targeting:===
{{Table372|
*When set, newer turret-tagged-only behavior will be enabled. See [http://scp.indiegames.us/mantis/view.php?id=3114 Mantis #3114].
*Off by default.
*Syntax: '''''Boolean'''''}}

===$aspect bomb invulnerability fix:===
{{Table373|
*When set, the code that makes bombs invulnerable for the first 1.5 seconds of life will use the correct lifetime calculation for aspect bombs. Without this fix, the invulnerability time will be extended by 20% of the total lifetime of the bomb.
*Off by default.
*Syntax: '''''Boolean'''''}}

===$glide decay requires thrust:===
{{Table373|
*When set, gliding ships will maintain their current speed without decay as long as they aren't actively thrusting.
*Off by default.
*Syntax: '''''Boolean'''''}}

===$ai can slow down when attacking big ships:===
{{Table38|
*When set, fighters attacking big ships will slow down depending on how long they've been attacking (80% speed after 5 seconds, 60% after 8 seconds, 40% after 10 seconds, and 20% after 15 seconds), how long it's been since they were last shot (full throttle if it was within the past 6 seconds), and how close they are (full throttle if the target is more than 1200 meters away).
*Off by default.
*Syntax: '''''Boolean'''''}}

===$use actual primary range:===
{{Table382|
*When set, fighters will no longer fire primary weapons at targets outside their range just because weapon travel time would be sufficiently short.
*Off by default.
*Syntax: '''''Boolean'''''}}

===$override radius for subsystem path points:===
{{Table202|
*When set, this value overrides the default distance for determining if a ship had reached a point in a model subsystem path. Useful to allow ships with high damp values to navigate subsystem paths when attacking a subsystem. Must be greater than or equal to 1. If '''''$use POF radius for subsystem path points:''''' is set than this override value will only be used if the point in the subsystem path is less than 1 or invalid.
*5 by default.
*Syntax: '''''Integer'''''}}

===$use POF radius for subsystem path points:===
{{Table202|
*When set, the distance for determining if a ship had reached a point in a model subsystem path will be the radius of that path point, not the default distance of 5.
*Off by default. If this is set to YES and ''''''$override radius for subsystem path points:''''' is set to greater than or equal to 1, then the path point radius will be used. If the path point radius cannot be found or is less than 1 then override radius will be used if it is set to greater than or equal to 1.
*Syntax: '''''Boolean'''''}}

===$bay arrive speed multiplier:===
{{Table373|
*Causes all AI ships arriving from fighterbays (following a fighterbay path) to gradually accelerate, instead of immediately attempting to attain maximum speed. This can be used to prevent fighters from overshooting the fighterbay paths. The initial target speed is the maximum speed multiplied by the given value, with the multiplier gradually approaching 1.0 as the distance to the end of the path decreases.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|Will be overridden by path-specific multipliers, see [[Ships.tbl#.2Barrive_speed_multiplier:]].}}
}}

===$bay depart speed multiplier:===
{{Table373|
*Same as above, except for departures into fighterbays. The initial target speed is the maximum speed, with the target speed gradually approaching maximum speed multiplied by the given value as the distance to the fighterbay decreases.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|Will be overridden by path-specific multipliers, see [[Ships.tbl#.2Bdepart_speed_multiplier:]].}}
}}

===$lead indicator second-order prediction factor:===
{{Table202|
*This is a 0 to 1 multiplier of a factor to adjust the lead indicator to take into account a ship's rotational velocity as well as its velocity. This will directly affect autoaim, making it more accurate for turning enemies.
*This ''will'' make the lead indicator slightly jitterier in general, and does not properly take into account gliding. It is recommended to adjust the value to fit your situation.
**Syntax: '''''Float''''' (defaults to 0.0)}}

===$no directional bias for missile and ship turning:===
{{Table202|
*When enabled, this will cause ships and missiles to take direct turning paths to point at their target. This does not directly affect their turning time, but in many situations will result in more efficient paths and a better time-to-target.
*Syntax: '''''Boolean'''''}}

===$respect ship axial turnrate differences:===
{{Table202|
*Normally AI ships will use the average of their pitch and heading turn times for their turn time on all axes. If this is enabled the ship will actually use the tabled values for each axis.
*'''''NOTE''''':The AI will '''''NOT''''' take this into account when turning, it will always turn directly towards its target, even if it could bank and use a faster axis instead. Use this flag carefully, and make sure that their your ships have exactly the turn times you want for each axis.
*Syntax: '''''Boolean'''''}}

===$any ship with no shields can manage ETS:===
{{Table202|
*Normally AI ships will not manage ETS if they do not have shields set to be on. When enabled, this flag allows the AI on any ship to manage ETS for weapons and engines even if they do not have shields set to on. Do note that in Vanilla FS2, some capital ships can go much faster with this enabled.
*Syntax: '''''Boolean'''''}}

===$fighters/bombers with no shields can manage ETS:===
{{Table202|
*Normally AI ships will not manage ETS if they do not have shields set to be on. When enabled, this flag allows the AI on fighters and bombers to manage ETS for weapons and engines even if they do have shields set to on.
*Syntax: '''''Boolean'''''}}

===$better combat collision avoidance for fightercraft:===
{{Table202|
*If set will cause small ships to be much better at avoiding colliding with large ships while fighting, and will not spend as long recovering from a collision if one does occur.
*Syntax: '''''Boolean'''''}}

===$firing requires exact los:===
{{Table202|
*If set will cause turrets and AI weapons to only fire if they have a clear line of sight from their firing point to their target's ship's center.
*Syntax: '''''Boolean'''''}}

===$improved missile avoidance for fightercraft:===
{{Table212|
*Fighters/bombers will be much more effective at dodging missiles in general. Of note is that AI do not normally care about countermeasure effect range before dropping them (only distance less than 200m), with this flag, they will only drop them if within countermeasure range.
*Syntax: '''''Boolean'''''}}

===$friendly ships use AI profile countermeasure chance:===
{{Table212|
*Specifies Friendly ships to use their specific AI class profile countermeasure firing chance. By default Friendly ships always use the second value in '''$AI Countermeasure Firing Chance:''' from default AI profile.
*Syntax: '''''Boolean'''''}}

===$improved subsystem attack pathing:===
{{Table212|
*Fightercraft will use a somewhat more efficient and faster subsystem attack pathing method.
*Notably, this method ''does not'' use the path system. Using this flag, aside from docking and fighter bay paths, ''all other'' paths will be ignored and are no longer necessary.
*Syntax: '''''Boolean'''''}}

===$fixed ship-weapon collisions:===
{{Table214|
*Fixes an error in ship-weapon collisions which would occasionally cause them to not trigger when they should.
*Most obvious when projectiles would erroneously bypass a full shield quadrant and damage the hull.
*Syntax: '''''Boolean'''''}}

===$AI secondary range awareness:===
{{Table214|
*Controls if the AI considers weapon range at all when selecting a secondary weapon to attempt to use. Currently available options are:
*'RETAIL': The default. After performing filtering logic based on the target types and weapon flags, the AI will select the first valid secondary bank as its active one, regardless of range.
*'AWARE': As retail, except that if a weapon is out of range it the AI will keep looking down the list to see if it has a weapon that is in range, and use that instead if it does. All other weapon selection and restriction logic still applies.}}

===$no shield damage from ship collisions:===
{{Table214|
*Normally, the heavier ship in a collision will receive shield damage from the collision if it has one.
*This disables that, and causes all involved ships to only take hull damage.
*Syntax: '''''Boolean'''''}}

===$turret target recheck time:===
{{Table220|
*Defines the amount of time between target recalculation for turrets.
*Affects turret reaction time in all scenarios, acquiring a target from idle, re-affirming the current target, switching to a new target or even a new subsystem on the same target.
*Be aware setting this value too low can have an extreme performance impact. It is recommended to not set this below 30 ms.
*Syntax: '''''Float''''', milliseconds
*Default: 2000}}

===$prevent negative turret ammo:===
{{Table220|
*By default, turrets with ammo would end up firing one extra shot, resulting in a -1 ammo. This flag corrects that behavior, so the ammo count is properly used.
*Syntax: '''''Boolean'''''}}

===$fix keep-safe-distance:===
{{Table220|
*Allows any ship flying the keep-safe-distance behavior to turn toward its goal point. Without this flag, ships will fly into the distance in a straight line.
*Syntax: '''''Boolean'''''}}

===$AI ignores aspect lock for leading:===
{{Table222|
*When off, AI fighters follows retail behavior of aiming directly at a target when using aspect lock missiles. When on AIs ignore this consideration and always lead their targets when attempting to aim at them.
*Syntax: '''''Boolean'''''
*Default: on}}

===$fix good-rearm-time bug:===
{{Table224|
*Causes the "good rearm time" SEXP to correctly expire (revert to being a "bad rearm time") at the end of the specified time.
*Syntax: '''''Boolean'''''}}

===$no continuous turn on attack:===
{{Table224|
*Prevents fighters from spinning around for a fraction of a second when they arrive.
*Syntax: '''''Boolean'''''}}

===$remove-goal properly removes play-dead order:===
{{Table224|
*Causes remove-goal to take the ship out of the play-dead AI mode when removing the play-dead goal.
*Syntax: '''''Boolean'''''}}

===$bay arrivals not time limited:===
{{Table224|
*Causes AI to always complete a bay arrival path, even if it takes longer than 10 seconds.
*Syntax: '''''Boolean'''''}}

===$use adjusted AI class autoscale:===
{{Table224|
*Causes autoscaled AI classes to scale only based on the collection of autoscaled AI classes, not all AI classes. This prevents autoscaled calculations from being skewed by the presence of non-autoscaled classes in the list.
*Syntax: '''''Boolean'''''}}

==Sample Entry==
*Retail FS2 behaviour

<pre>
#AI Profiles

$Default Profile: FS2 RETAIL

$Profile Name: FS2 RETAIL

$Player Afterburner Recharge Scale: 5, 3, 2, 1.5, 1
$Max Beam Friendly Fire Damage: 0, 5, 10, 20, 30
$Player Countermeasure Life Scale: 3, 2, 1.5, 1.25, 1
$AI Countermeasure Firing Chance: 0.2, 0.3, 0.5, 0.9, 1.1
$AI In Range Time: 2, 1.4, 0.75, 0, -1
$AI Always Links Ammo Weapons: 95, 80, 60, 40, 20
$AI Maybe Links Ammo Weapons: 90, 60, 40, 20, 10
$Primary Ammo Burst Multiplier: 0, 0, 0, 0, 0
$AI Always Links Energy Weapons: 100, 80, 60, 40, 20
$AI Maybe Links Energy Weapons: 90, 60, 40, 20, 10
$Max Missiles Locked on Player: 2, 3, 4, 7, 99
$Max Player Attackers: 2, 3, 4, 5, 99
$Max Incoming Asteroids: 3, 4, 5, 7, 10
$Player Damage Factor: 0.25, 0.5, 0.65, 0.85, 1
$Player Subsys Damage Factor: 0.2, 0.4, 0.6, 0.8, 1
$Predict Position Delay: 2, 1.5, 1.333,0.5, 0
$AI Shield Manage Delay: 5, 4, 2.5, 1.2, 0.1
$Friendly AI Fire Delay Scale: 2, 1.4, 1.25, 1.1, 1
$Hostile AI Fire Delay Scale: 4, 2.5, 1.75, 1.25, 1
$Friendly AI Secondary Fire Delay Scale: 0.4, 0.6, 0.8, 1.0, 1.2
$Hostile AI Secondary Fire Delay Scale: 1.4, 1.2, 1.0, 0.8, 0.6
$AI Turn Time Scale: 3, 2.2, 1.6, 1.3, 1
$Glide Attack Percent: 0, 0, 0, 0, 0
$Circle Strafe Percent: 0, 0, 0, 0, 0
$Glide Strafe Percent: 0, 0, 0, 0, 0
$Random Sidethrust Percent: 0, 0, 0, 0, 0
$Stalemate Time Threshold: 0, 0, 0, 0, 0
$Stalemate Distance Threshold: 0, 0, 0, 0, 0
$Player Shield Recharge Scale: 4, 2, 1.5, 1.25, 1
$Player Weapon Recharge Scale: 10, 4, 2.5, 2, 1.5
$Max Turret Target Ownage: 3, 4, 7, 12, 19
$Max Turret Player Ownage: 3, 4, 7, 12, 19
$Percentage Required For Kill Scale: 0.30, 0.30, 0.30, 0.30, 0.30
$Percentage Required For Assist Scale: 0.15, 0.15, 0.15, 0.15, 0.15
$Percentage Awarded For Capship Assist: 0.1, 0.2, 0.35, 0.5, 0.6
$Repair Penalty: 10, 20, 35, 50, 60
$Delay Before Allowing Bombs to Be Shot Down: 1.5, 1.5, 1.5, 1.5, 1.5
$Chance AI Has to Fire Missiles at Player: 0, 1, 2, 3, 4
$Max Aim Update Delay: 0, 0, 0, 0, 0
$Turret Max Aim Update Delay: 0, 0, 0, 0, 0
$Player Autoaim FOV: 0, 0, 0, 0, 0
$Detail Distance Multiplier: 0.125,0.25, 1.0, 4.0, 8.0

$big ships can attack beam turrets on untargeted ships: NO
$smart primary weapon selection: NO
$smart secondary weapon selection: NO
$smart shield management: NO
$smart afterburner management: NO
$allow rapid secondary dumbfire: NO
$huge turret weapons ignore bombs: NO
$don't insert random turret fire delay: NO
$hack improve non-homing swarm turret fire accuracy: NO
$shockwaves damage small ship subsystems: NO
$navigation subsystem governs warpout capability: NO
$ignore lower bound for minimum speed of docked ship: NO
$disable linked fire penalty: NO
$disable weapon damage scaling: NO
$use additive weapon velocity: NO
$use newtonian dampening: NO
$include beams for kills and assists: NO
$score kills based on damage caused: NO
$score assists based on damage caused: NO
$allow event and goal scoring in multiplayer: NO
$fix linked primary weapon decision bug: NO
$prevent turrets targeting too distant bombs: NO
$smart subsystem targeting for turrets: NO
$fix heat seekers homing on stealth ships bug: NO
$multi allow empty primaries: NO
$multi allow empty secondaries: NO
$allow turrets target weapons freely: NO
$use only single fov for turrets: NO
$allow vertical dodge: NO
$force beam turrets to use normal fov: NO
$fix AI class bug: NO
$turrets ignore targets radius in range checks: NO
$no extra collision avoidance vs player: NO
$perform fewer checks for death screams: NO
$advanced turret fov edge checks: NO
$require turrets to have target in fov: NO
$all ships manage shields: NO
$ai aims from ship center: NO
$allow primary link at mission start: NO
$allow beams to damage bombs: NO
$disable weapon damage scaling for player: NO
$countermeasures affect aspect seekers: NO
$ai path mode: normal
$no warp camera: NO

#End
</pre>

== References ==
# "[http://www.hard-light.net/forums/index.php/topic,50870.msg1029741.html#msg1029741 Re: New difficulty? - Feature request!]", ''Hard Light Productions Forums'', Hard Light Productions, 2007-12-15. Retrieved on [[December_27]], [[2007]].

[[Category:Tables]]

Enhanced sound

2022-12-15T22:29:47Z

-Joshua-:

{{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 [https://openal-soft.org/ 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 have low priority.

"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.'']"

[[Category:Modding]]

Icons.tbl

2022-11-14T16:25:57Z

-Joshua-: /* xxx-ico.tbm Format */

{{TableVersion|5230}}
{{Tables}}
The '''icons.tbl''' defines icons used in mission briefings.

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

==[[Species_defs.tbl#.24Borrows_Briefing_Icons_from:|$Borrows Briefing Icons from:]]==
{{Table212|
While this is not part of the icons table, it is an important aspect of briefing icon assignment. This field in [[species_defs.tbl]] can used to simply and easily define a whole species' briefing icons as simply a copy of another species'. Doing this does not require any other icons.tbl/.tbm modifications. Note that briefing icons assigned in this way cannot be modified by modular tables.}}

==icons.tbl Format==
*Table begins with '''$Start'''
*Table ends with '''#End'''
*Briefing icons are grouped first per icon type. There is a separate 'entry' for each of the species for every icon type (listed below), in order.
**The order matches the order of the species listed.
{{Table3610|
*Any species added or replaced will have to correspond to the order you have your species listed in [[species_defs.tbl]].}}
{{Table212|
*If any species uses [[Species_defs.tbl#.24Borrows_Briefing_Icons_from:|$Borrows Briefing Icons from:]] they must be omitted and skipped over.}}

*Each icons.tbl entry consists of three separate animations, '''regular''', '''fade''', and '''highlight''' animations.
===$Name:===
*Defines the name of the animation used for the particular effect
**Syntax: '''filename'''

==xxx-ico.tbm Format==
{{Table212|
*This format may also be used with icons.tbl.
*A sample of the retail icons.tbl done in this format is below.
*Table begins with '''#Start'''
*Table ends with '''#End'''
===$Species===
*Specifies the Species whose icons is being modified.
*Syntax: '''String''', Species
====$Icon Type:====
*Specifies the particular Icon type that is being modified
*Syntax: '''String''', Icon type (must match exactly with one of those listed below)
=====$Name:=====
*Defines the names of the animations used for the particular effect
**Like above, must be listed three times for the '''regular''', '''fade''', and '''highlight''' animations. They cannot be modified individually.
**Syntax: '''filename'''
}}

==Allowed Icon types:==
*Fighter
*Fighter Wing
*Cargo
*Cargo Wing
*Largeship
*Largeship Wing
*Capital
*Planet
*Asteroid Field
*Waypoint
*Support Ship
*Freighter(no cargo)
*Freighter(has cargo)
*Freighter Wing(no cargo)
*Freighter Wing(has cargo)
*Installation
*Bomber
*Bomber Wing
*Cruiser
*Cruiser Wing
*Unknown
*Unknown Wing
*Player Fighter
*Player Fighter Wing
*Player Bomber
*Player Bomber Wing
*Knossos Device
*Transport Wing
*Corvette
*Gas Miner
*Awacs
*Supercap
*Sentry Gun
*Jump Node
*Transport

==.tbl Format Sample==

<pre>
#Start

; ICON_FIGHTER
$Name: iconT-fighter ; regular
$Name: FadeiconT-fighter ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconV-fighter ; regular
$Name: FadeiconV-fighter ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconS-fighter ; regular
$Name: FadeiconV-fighter ; fade anim
$Name: iconhighlight04 ; highlight anim

; ICON_FIGHTER_WING
$Name: icont-fightW ; regular
$Name: FadeiconT-FighterW ; fade anim
$Name: iconhighlight02 ; highlight anim

$Name: iconv-fightW ; regular
$Name: Fadeiconv-FighterW ; fade anim
$Name: iconhighlight02 ; highlight anim

$Name: icons-fighterW ; regular
$Name: Fadeicons-FighterW ; fade anim
$Name: iconhighlight02 ; highlight anim

; ICON_CARGO
$Name: icont-cargo ; regular
$Name: FadeiconT-Cargo ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconv-cargo ; regular
$Name: Fadeiconv-Cargo ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: icons-cargo ; regular
$Name: Fadeicons-Cargo ; fade anim
$Name: iconhighlight04 ; highlight anim

; ICON_CARGO_WING
$Name: icont-cargoW ; regular
$Name: FadeiconT-CargoW ; fade anim
$Name: iconhighlight02 ; highlight anim

$Name: iconv-cargoW ; regular
$Name: Fadeiconv-CargoW ; fade anim
$Name: iconhighlight02 ; highlight anim

$Name: icons-cargoW ; regular
$Name: Fadeicons-CargoW ; fade anim
$Name: iconhighlight02 ; highlight anim

; ICON_LARGESHIP
$Name: icont-cruiser ; regular
$Name: FadeiconT-cruiser ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: iconv-cruiser ; regular
$Name: Fadeiconv-cruiser ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: icons-cruiser ; regular
$Name: Fadeicons-cruiser ; fade anim
$Name: iconhighlight07 ; highlight anim

; ICON_LARGESHIP_WING
$Name: icont-cruiserW ; regular
$Name: FadeiconT-cruiser ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconv-cruiserW ; regular
$Name: Fadeiconv-cruiserW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: icons-cruiserW ; regular
$Name: Fadeicons-cruiserW ; fade anim
$Name: iconhighlight05 ; highlight anim

; ICON_CAPITAL
$Name: icont-cap ; regular
$Name: Fadeicont-Cap ; fade anim
$Name: iconhighlight06 ; highlight anim

$Name: iconv-cap ; regular
$Name: Fadeiconv-Cap ; fade anim
$Name: iconhighlight06 ; highlight anim

$Name: icons-cap ; regular
$Name: Fadeicons-Cap ; fade anim
$Name: iconhighlight06 ; highlight anim

; ICON_PLANET
$Name: iconplanet ; regular
$Name: FadeiconPlanet ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconplanet ; regular
$Name: FadeiconPlanet ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconplanet ; regular
$Name: FadeiconPlanet ; fade anim
$Name: iconhighlight03 ; highlight anim

; ICON_ASTEROID_FIELD
$Name: iconasteroid ; regular
$Name: FadeiconAsteroid ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconasteroid ; regular
$Name: FadeiconAsteroid ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconasteroid ; regular
$Name: FadeiconAsteroid ; fade anim
$Name: iconhighlight03 ; highlight anim

; ICON_WAYPOINT
$Name: iconnavbuoy ; regular
$Name: Fadeiconnavbuoy ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconnavbuoy ; regular
$Name: Fadeiconnavbuoy ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconnavbuoy ; regular
$Name: Fadeiconnavbuoy ; fade anim
$Name: iconhighlight04 ; highlight anim

; ICON_SUPPORT_SHIP
$Name: iconT-support ; regular
$Name: FadeT-Support ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconV-support ; regular
$Name: FadeV-Support ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconT-support ; regular
$Name: FadeT-Support ; fade anim
$Name: iconhighlight04 ; highlight anim

; ICON_FREIGHTER_NO_CARGO
$Name: icont-freight ; regular
$Name: Fadeicont-Freighter ; fade anim
$Name: iconhighlight01 ; highlight anim

$Name: iconv-freight ; regular
$Name: Fadeiconv-Freighter ; fade anim
$Name: iconhighlight01 ; highlight anim

$Name: icons-freight ; regular
$Name: Fadeicons-Freighter ; fade anim
$Name: iconhighlight01 ; highlight anim

; ICON_FREIGHTER_WITH_CARGO
$Name: icont-freightc ; regular
$Name: Fadeicont-FreighterC ; fade anim
$Name: iconhighlight01 ; highlight anim

$Name: iconv-freightc ; regular
$Name: Fadeiconv-FreighterC ; fade anim
$Name: iconhighlight01 ; highlight anim

$Name: icons-freightc ; regular
$Name: Fadeicons-FreighterC ; fade anim
$Name: iconhighlight01 ; highlight anim

; ICON_FREIGHTER_WING_NO_CARGO
$Name: icont-freighterw ; regular
$Name: Fadeicont-FreighterW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconv-freighterw ; regular
$Name: Fadeiconv-FreighterW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: icons-freighterw ; regular
$Name: Fadeicons-FreighterW ; fade anim
$Name: iconhighlight05 ; highlight anim

; ICON_FREIGHTER_WING_WITH_CARGO
$Name: icont-freightercw ; regular
$Name: Fadeicont-FreighterCW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconv-freightercw ; regular
$Name: Fadeiconv-FreighterCW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: icons-freighterwc ; regular
$Name: Fadeicons-FreighterCW ; fade anim
$Name: iconhighlight05 ; highlight anim

; ICON_INSTALLATION
$Name: iconInstall ; regular
$Name: FadeiconInstall ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconInstall ; regular
$Name: FadeiconInstall ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconInstall ; regular
$Name: FadeiconInstall ; fade anim
$Name: iconhighlight03 ; highlight anim

; ICON_BOMBER
$Name: icont-bomber ; regular
$Name: Fadeicont-Bomber ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: iconv-bomber ; regular
$Name: Fadeiconv-Bomber ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: icons-bomber ; regular
$Name: Fadeicons-Bomber ; fade anim
$Name: iconhighlight07 ; highlight anim

; ICON_BOMBER_WING
$Name: icont-bomberW ; regular
$Name: Fadeicont-BomberW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconv-bomberW ; regular
$Name: Fadeiconv-BomberW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: icons-bomberW ; regular
$Name: Fadeicons-BomberW ; fade anim
$Name: iconhighlight05 ; highlight anim

; ICON_CRUISER
$Name: icont-cruiser ; regular
$Name: FadeiconT-cruiser ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: iconv-cruiser ; regular
$Name: Fadeiconv-cruiser ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: icons-cruiser ; regular
$Name: Fadeicons-cruiser ; fade anim
$Name: iconhighlight07 ; highlight anim

; ICON_CRUISER_WING
$Name: icont-cruiserW ; regular
$Name: FadeiconT-cruiser ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconv-cruiserW ; regular
$Name: Fadeiconv-cruiserW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: icons-cruiserW ; regular
$Name: Fadeicons-cruiserW ; fade anim
$Name: iconhighlight05 ; highlight anim

; ICON_UNKNOWN
$Name: iconunknown ; regular
$Name: FadeUnknown ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconunknown ; regular
$Name: FadeUnknown ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconunknown ; regular
$Name: FadeUnknown ; fade anim
$Name: iconhighlight03 ; highlight anim

; ICON_UNKNOWN_WING
$Name: iconunknown ; regular
$Name: FadeUnknown ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconunknown ; regular
$Name: FadeUnknown ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconunknown ; regular
$Name: FadeUnknown ; fade anim
$Name: iconhighlight03 ; highlight anim

; ICON_FIGHTER_PLAYER
$Name: iconT-fighter ; regular
$Name: FadeiconT-fighter ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconV-fighter ; regular
$Name: FadeiconV-fighter ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconS-fighter ; regular
$Name: FadeiconV-fighter ; fade anim
$Name: iconhighlight04 ; highlight anim

; ICON_FIGHTERW_PLAYER
$Name: icont-fightW ; regular
$Name: FadeiconT-FighterW ; fade anim
$Name: iconhighlight02 ; highlight anim

$Name: iconv-fightW ; regular
$Name: Fadeiconv-FighterW ; fade anim
$Name: iconhighlight02 ; highlight anim

$Name: icons-fighterW ; regular
$Name: Fadeicons-FighterW ; fade anim
$Name: iconhighlight02 ; highlight anim

; ICON_BOMBER_PLAYER
$Name: icont-bomber ; regular
$Name: Fadeicont-Bomber ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: iconv-bomber ; regular
$Name: Fadeiconv-Bomber ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: icons-bomber ; regular
$Name: Fadeicons-Bomber ; fade anim
$Name: iconhighlight07 ; highlight anim

; ICON_BOMBERW_PLAYER
$Name: icont-bomberW ; regular
$Name: Fadeicont-BomberW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconv-bomberW ; regular
$Name: Fadeiconv-BomberW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: icons-bomberW ; regular
$Name: Fadeicons-BomberW ; fade anim
$Name: iconhighlight05 ; highlight anim

; ICON_KNOSSOS_DEVICE
$Name: icont-node ; regular
$Name: Fadeicont-node ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: icont-node ; regular
$Name: Fadeicont-node ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: icont-node ; regular
$Name: Fadeicont-node ; fade anim
$Name: iconhighlight04 ; highlight anim

; ICON_TRANSPORT_WING
$Name: iconT-transportW ; regular
$Name: fadeicont-transportW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconT-transportW ; regular
$Name: fadeiconT-transportW ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconS-transportW ; regular
$Name: fadeiconS-transportW ; fade anim
$Name: iconhighlight05 ; highlight anim

; ICON_CORVETTE
$Name: iconT-vette ; regular
$Name: fadeiconT-vette ; fade anim
$Name: iconhighlight06 ; highlight anim

$Name: iconV-vette ; regular
$Name: fadeiconV-vette ; fade anim
$Name: iconhighlight06 ; highlight anim

$Name: iconS-vette ; regular
$Name: fadeiconS-vette ; fade anim
$Name: iconhighlight06 ; highlight anim

; ICON_GAS_MINER
$Name: iconT-gas ; regular
$Name: fadeiconT-gas ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconV-gas ; regular
$Name: fadeiconV-gas ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconS-gas ; regular
$Name: fadeiconS-gas ; fade anim
$Name: iconhighlight05 ; highlight anim

; ICON_AWACS
$Name: iconT-AWAC ; regular
$Name: fadeiconT-AWAC ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconV-AWAC ; regular
$Name: fadeiconV-AWAC ; fade anim
$Name: iconhighlight05 ; highlight anim

$Name: iconT-AWAC ; regular
$Name: fadeiconT-AWAC ; fade anim
$Name: iconhighlight05 ; highlight anim

; ICON_SUPERCAP
$Name: iconT-super ; regular
$Name: fadeiconT-super ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconT-super ; regular
$Name: fadeiconT-super ; fade anim
$Name: iconhighlight03 ; highlight anim

$Name: iconS-super ; regular
$Name: fadeiconS-super ; fade anim
$Name: iconhighlight03 ; highlight anim

; ICON_SENTRYGUN
$Name: iconT-gun ; regular
$Name: fadeiconT-gun ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconV-gun ; regular
$Name: fadeiconV-gun ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconS-gun ; regular
$Name: fadeiconS-gun ; fade anim
$Name: iconhighlight04 ; highlight anim

; ICON_JUMP_NODE
$Name: iconnode ; regular
$Name: Fadeiconnode ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconnode ; regular
$Name: Fadeiconnode ; fade anim
$Name: iconhighlight04 ; highlight anim

$Name: iconnode ; regular
$Name: Fadeiconnode ; fade anim
$Name: iconhighlight04 ; highlight anim

; ICON_TRANSPORT
$Name: iconT-transport ; regular
$Name: fadeIconT-transport ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: iconT-transport ; regular
$Name: fadeIconT-transport ; fade anim
$Name: iconhighlight07 ; highlight anim

$Name: iconS-transport ; regular
$Name: fadeIconS-transport ; fade anim
$Name: iconhighlight07 ; highlight anim

#End
</pre>

==.tbm Format Sample==

<pre>
#Start

$Species: Terran

$Icon Type: Fighter
$Name: iconT-fighter
$Name: FadeiconT-fighter
$Name: iconhighlight04

$Icon Type: Fighter Wing
$Name: icont-fightW
$Name: FadeiconT-FighterW
$Name: iconhighlight02

$Icon Type: Cargo
$Name: icont-cargo
$Name: FadeiconT-Cargo
$Name: iconhighlight04

$Icon Type: Cargo Wing
$Name: icont-cargoW
$Name: FadeiconT-CargoW
$Name: iconhighlight02

$Icon Type: Largeship
$Name: icont-cruiser
$Name: FadeiconT-cruiser
$Name: iconhighlight07

$Icon Type: Largeship Wing
$Name: icont-cruiserW
$Name: FadeiconT-cruiser
$Name: iconhighlight05

$Icon Type: Capital
$Name: icont-cap
$Name: Fadeicont-Cap
$Name: iconhighlight06

$Icon Type: Planet
$Name: iconplanet
$Name: FadeiconPlanet
$Name: iconhighlight03

$Icon Type: Asteroid Field
$Name: iconasteroid
$Name: FadeiconAsteroid
$Name: iconhighlight03

$Icon Type: Waypoint
$Name: iconnavbuoy
$Name: Fadeiconnavbuoy
$Name: iconhighlight04

$Icon Type: Support Ship
$Name: iconT-support
$Name: FadeT-Support
$Name: iconhighlight04

$Icon Type: Freighter(no cargo)
$Name: icont-freight
$Name: Fadeicont-Freighter
$Name: iconhighlight01

$Icon Type: Freighter(has cargo)
$Name: icont-freightc
$Name: Fadeicont-FreighterC
$Name: iconhighlight01

$Icon Type: Freighter Wing(no cargo)
$Name: icont-freighterw
$Name: Fadeicont-FreighterW
$Name: iconhighlight05

$Icon Type: Freighter Wing(has cargo)
$Name: icont-freightercw
$Name: Fadeicont-FreighterCW
$Name: iconhighlight05

$Icon Type: Installation
$Name: iconInstall
$Name: FadeiconInstall
$Name: iconhighlight03

$Icon Type: Bomber
$Name: icont-bomber
$Name: Fadeicont-Bomber
$Name: iconhighlight07

$Icon Type: Bomber Wing
$Name: icont-bomberW
$Name: Fadeicont-BomberW
$Name: iconhighlight05

$Icon Type: Cruiser
$Name: icont-cruiser
$Name: FadeiconT-cruiser
$Name: iconhighlight07

$Icon Type: Cruiser Wing
$Name: icont-cruiserW
$Name: FadeiconT-cruiser
$Name: iconhighlight05

$Icon Type: Unknown
$Name: iconunknown
$Name: FadeUnknown
$Name: iconhighlight03

$Icon Type: Unknown Wing
$Name: iconunknown
$Name: FadeUnknown
$Name: iconhighlight03

$Icon Type: Player Fighter
$Name: iconT-fighter
$Name: FadeiconT-fighter
$Name: iconhighlight04

$Icon Type: Player Fighter Wing
$Name: icont-fightW
$Name: FadeiconT-FighterW
$Name: iconhighlight02

$Icon Type: Player Bomber
$Name: icont-bomber
$Name: Fadeicont-Bomber
$Name: iconhighlight07

$Icon Type: Player Bomber Wing
$Name: icont-bomberW
$Name: Fadeicont-BomberW
$Name: iconhighlight05

$Icon Type: Knossos Device
$Name: icont-node
$Name: Fadeicont-node
$Name: iconhighlight04

$Icon Type: Transport Wing
$Name: iconT-transportW
$Name: fadeicont-transportW
$Name: iconhighlight05

$Icon Type: Corvette
$Name: iconT-vette
$Name: fadeiconT-vette
$Name: iconhighlight06

$Icon Type: Gas Miner
$Name: iconT-gas
$Name: fadeiconT-gas
$Name: iconhighlight05

$Icon Type: Awacs
$Name: iconT-AWAC
$Name: fadeiconT-AWAC
$Name: iconhighlight05

$Icon Type: Supercap
$Name: iconT-super
$Name: fadeiconT-super
$Name: iconhighlight03

$Icon Type: Sentry Gun
$Name: iconT-gun
$Name: fadeiconT-gun
$Name: iconhighlight04

$Icon Type: Jump Node
$Name: iconnode
$Name: Fadeiconnode
$Name: iconhighlight04

$Icon Type: Transport
$Name: iconT-transport
$Name: fadeIconT-transport
$Name: iconhighlight07

$Species: Vasudan

$Icon Type: Fighter
$Name: iconV-fighter
$Name: FadeiconV-fighter
$Name: iconhighlight04

$Icon Type: Fighter Wing
$Name: iconv-fightW
$Name: Fadeiconv-FighterW
$Name: iconhighlight02

$Icon Type: Cargo
$Name: iconv-cargo
$Name: Fadeiconv-Cargo
$Name: iconhighlight04

$Icon Type: Cargo Wing
$Name: iconv-cargoW
$Name: Fadeiconv-CargoW
$Name: iconhighlight02

$Icon Type: Largeship
$Name: iconv-cruiser
$Name: Fadeiconv-cruiser
$Name: iconhighlight07

$Icon Type: Largeship Wing
$Name: iconv-cruiserW
$Name: Fadeiconv-cruiserW
$Name: iconhighlight05

$Icon Type: Capital
$Name: iconv-cap
$Name: Fadeiconv-Cap
$Name: iconhighlight06

$Icon Type: Planet
$Name: iconplanet
$Name: FadeiconPlanet
$Name: iconhighlight03

$Icon Type: Asteroid Field
$Name: iconasteroid
$Name: FadeiconAsteroid
$Name: iconhighlight03

$Icon Type: Waypoint
$Name: iconnavbuoy
$Name: Fadeiconnavbuoy
$Name: iconhighlight04

$Icon Type: Support Ship
$Name: iconV-support
$Name: FadeV-Support
$Name: iconhighlight04

$Icon Type: Freighter(no cargo)
$Name: iconv-freight
$Name: Fadeiconv-Freighter
$Name: iconhighlight01

$Icon Type: Freighter(has cargo)
$Name: iconv-freightc
$Name: Fadeiconv-FreighterC
$Name: iconhighlight01

$Icon Type: Freighter Wing(no cargo)
$Name: iconv-freighterw
$Name: Fadeiconv-FreighterW
$Name: iconhighlight05

$Icon Type: Freighter Wing(has cargo)
$Name: iconv-freightercw
$Name: Fadeiconv-FreighterCW
$Name: iconhighlight05

$Icon Type: Installation
$Name: iconInstall
$Name: FadeiconInstall
$Name: iconhighlight03

$Icon Type: Bomber
$Name: iconv-bomber
$Name: Fadeiconv-Bomber
$Name: iconhighlight07

$Icon Type: Bomber Wing
$Name: iconv-bomberW
$Name: Fadeiconv-BomberW
$Name: iconhighlight05

$Icon Type: Cruiser
$Name: iconv-cruiser
$Name: Fadeiconv-cruiser
$Name: iconhighlight07

$Icon Type: Cruiser Wing
$Name: iconv-cruiserW
$Name: Fadeiconv-cruiserW
$Name: iconhighlight05

$Icon Type: Unknown
$Name: iconunknown
$Name: FadeUnknown
$Name: iconhighlight03

$Icon Type: Unknown Wing
$Name: iconunknown
$Name: FadeUnknown
$Name: iconhighlight03

$Icon Type: Player Fighter
$Name: iconV-fighter
$Name: FadeiconV-fighter
$Name: iconhighlight04

$Icon Type: Player Fighter Wing
$Name: iconv-fightW
$Name: Fadeiconv-FighterW
$Name: iconhighlight02

$Icon Type: Player Bomber
$Name: iconv-bomber
$Name: Fadeiconv-Bomber
$Name: iconhighlight07

$Icon Type: Player Bomber Wing
$Name: iconv-bomberW
$Name: Fadeiconv-BomberW
$Name: iconhighlight05

$Icon Type: Knossos Device
$Name: icont-node
$Name: Fadeicont-node
$Name: iconhighlight04

$Icon Type: Transport Wing
$Name: iconT-transportW
$Name: fadeiconT-transportW
$Name: iconhighlight05

$Icon Type: Corvette
$Name: iconV-vette
$Name: fadeiconV-vette
$Name: iconhighlight06

$Icon Type: Gas Miner
$Name: iconV-gas
$Name: fadeiconV-gas
$Name: iconhighlight05

$Icon Type: Awacs
$Name: iconV-AWAC
$Name: fadeiconV-AWAC
$Name: iconhighlight05

$Icon Type: Supercap
$Name: iconT-super
$Name: fadeiconT-super
$Name: iconhighlight03

$Icon Type: Sentry Gun
$Name: iconV-gun
$Name: fadeiconV-gun
$Name: iconhighlight04

$Icon Type: Jump Node
$Name: iconnode
$Name: Fadeiconnode
$Name: iconhighlight04

$Icon Type: Transport
$Name: iconT-transport
$Name: fadeIconT-transport
$Name: iconhighlight07

$Species: Shivan

$Icon Type: Fighter
$Name: iconS-fighter
$Name: FadeiconV-fighter
$Name: iconhighlight04

$Icon Type: Fighter Wing
$Name: icons-fighterW
$Name: Fadeicons-FighterW
$Name: iconhighlight02

$Icon Type: Cargo
$Name: icons-cargo
$Name: Fadeicons-Cargo
$Name: iconhighlight04

$Icon Type: Cargo Wing
$Name: icons-cargoW
$Name: Fadeicons-CargoW
$Name: iconhighlight02

$Icon Type: Largeship
$Name: icons-cruiser
$Name: Fadeicons-cruiser
$Name: iconhighlight07

$Icon Type: Largeship Wing
$Name: icons-cruiserW
$Name: Fadeicons-cruiserW
$Name: iconhighlight05

$Icon Type: Capital
$Name: icons-cap
$Name: Fadeicons-Cap
$Name: iconhighlight06

$Icon Type: Planet
$Name: iconplanet
$Name: FadeiconPlanet
$Name: iconhighlight03

$Icon Type: Asteroid Field
$Name: iconasteroid
$Name: FadeiconAsteroid
$Name: iconhighlight03

$Icon Type: Waypoint
$Name: iconnavbuoy
$Name: Fadeiconnavbuoy
$Name: iconhighlight04

$Icon Type: Support Ship
$Name: iconT-support
$Name: FadeT-Support
$Name: iconhighlight04

$Icon Type: Freighter(no cargo)
$Name: icons-freight
$Name: Fadeicons-Freighter
$Name: iconhighlight01

$Icon Type: Freighter(has cargo)
$Name: icons-freightc
$Name: Fadeicons-FreighterC
$Name: iconhighlight01

$Icon Type: Freighter Wing(no cargo)
$Name: icons-freighterw
$Name: Fadeicons-FreighterW
$Name: iconhighlight05

$Icon Type: Freighter Wing(has cargo)
$Name: icons-freighterwc
$Name: Fadeicons-FreighterCW
$Name: iconhighlight05

$Icon Type: Installation
$Name: iconInstall
$Name: FadeiconInstall
$Name: iconhighlight03

$Icon Type: Bomber
$Name: icons-bomber
$Name: Fadeicons-Bomber
$Name: iconhighlight07

$Icon Type: Bomber Wing
$Name: icons-bomberW
$Name: Fadeicons-BomberW
$Name: iconhighlight05

$Icon Type: Cruiser
$Name: icons-cruiser
$Name: Fadeicons-cruiser
$Name: iconhighlight07

$Icon Type: Cruiser Wing
$Name: icons-cruiserW
$Name: Fadeicons-cruiserW
$Name: iconhighlight05

$Icon Type: Unknown
$Name: iconunknown
$Name: FadeUnknown
$Name: iconhighlight03

$Icon Type: Unknown Wing
$Name: iconunknown
$Name: FadeUnknown
$Name: iconhighlight03

$Icon Type: Player Fighter
$Name: iconS-fighter
$Name: FadeiconV-fighter
$Name: iconhighlight04

$Icon Type: Player Fighter Wing
$Name: icons-fighterW
$Name: Fadeicons-FighterW
$Name: iconhighlight02

$Icon Type: Player Bomber
$Name: icons-bomber
$Name: Fadeicons-Bomber
$Name: iconhighlight07

$Icon Type: Player Bomber Wing
$Name: icons-bomberW
$Name: Fadeicons-BomberW
$Name: iconhighlight05

$Icon Type: Knossos Device
$Name: icont-node
$Name: Fadeicont-node
$Name: iconhighlight04

$Icon Type: Transport Wing
$Name: iconS-transportW
$Name: fadeiconS-transportW
$Name: iconhighlight05

$Icon Type: Corvette
$Name: iconS-vette
$Name: fadeiconS-vette
$Name: iconhighlight06

$Icon Type: Gas Miner
$Name: iconS-gas
$Name: fadeiconS-gas
$Name: iconhighlight05

$Icon Type: Awacs
$Name: iconT-AWAC
$Name: fadeiconT-AWAC
$Name: iconhighlight05

$Icon Type: Supercap
$Name: iconS-super
$Name: fadeiconS-super
$Name: iconhighlight03

$Icon Type: Sentry Gun
$Name: iconS-gun
$Name: fadeiconS-gun
$Name: iconhighlight04

$Icon Type: Jump Node
$Name: iconnode
$Name: Fadeiconnode
$Name: iconhighlight04

$Icon Type: Transport
$Name: iconS-transport
$Name: fadeIconS-transport
$Name: iconhighlight07

#End
</pre>

[[Category:Tables]]

Enhanced sound

2022-08-02T10:16:10Z

-Joshua-: /* Tips on selecting priorities/limits */

{{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 have low priority.

"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.'']"

[[Category:Modding]]

Lighting Profiles.tbl

2022-07-29T11:16:46Z

-Joshua-: /* $PPC Shoulder Angle: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas. You probably want this to be quite low given the darkness of the void.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you get a naturally occuring bloom effect, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means that that bloom effect is diminished, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Raising shoulder angle means that less bright in the shoulder are adjusted less, whilst very bright areas are compressed into a smaller range. In FS2 this is very noticable in backgrounds, which become more saturated (and eventually oversaturated) as shoulder angle increases.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*Currently this value is parsed but not used. It will most likely be used in 22.4 but this change has not yet been submitted. When it is the information below will apply.
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*Currently this value is parsed but not used. It will most likely be used in 22.4 but this change has not yet been submitted. When it is the information below will apply.
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-29T11:13:23Z

-Joshua-: /* $PPC Shoulder Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas. You probably want this to be quite low given the darkness of the void.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
There's no such thing as finite brightness in space, but there is on your monitor. Shoulder length determines at which point the tonemapper stops adjusting for overexposure and simply lets it happen. If you set this to a low value you get a naturally occuring bloom effect, as the amount of lights that the tonemapper considers 'too bright to handle' increases. Settings this high means that that bloom effect is diminished, at the risk of making highlights look a bit dull as they're being compressed in order to fit within the displayable range.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting will desaturate bright areas.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*Currently this value is parsed but not used. It will most likely be used in 22.4 but this change has not yet been submitted. When it is the information below will apply.
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*Currently this value is parsed but not used. It will most likely be used in 22.4 but this change has not yet been submitted. When it is the information below will apply.
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-29T11:07:35Z

-Joshua-: /* $PPC Toe Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length determines the mid-point where the toe stops and the shoulder begins. In layman's terms, this determines what the renderer considers "dark" areas and what it considers "bright" areas. You probably want this to be quite low given the darkness of the void.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making said transition more dull.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting will desaturate bright areas.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table224|
*Currently this value is parsed but not used. It will most likely be used in 22.4 but this change has not yet been submitted. When it is the information below will apply.
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table224|
*Currently this value is parsed but not used. It will most likely be used in 22.4 but this change has not yet been submitted. When it is the information below will apply.
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T19:00:12Z

-Joshua-: /* $PPC Shoulder Angle: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making said transition more dull.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting will desaturate bright areas.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T10:31:19Z

-Joshua-: /* PPC Adjustments */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting your desired exposure
** Set toe and shoulder strength to 0, then increase them slowly to see their effects in action.
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making said transition more dull.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting allows for a "bloom" effect.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T10:26:47Z

-Joshua-:

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===PPC Adjustments===
If you want to adjust the look of the PPC tonemapper, you can easily see what these settings do by using the F3 main lab.
* When in the main menu, press F3
* Select a ship class
* Select a background from a mission of your choice.
* Tweak settings and the desired tonemapper from the "Render Options" menu.
** Start by setting Exposure to 1 and toe and shoulder strength to 0
** Adjust Exposure, Toe and Shoulder strength as desired.
*** Use the length and angle settings for fine-tuning after you've honed down your desired look.
** Note the settings used and type them into this table.

===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making said transition more dull.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting allows for a "bloom" effect.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:53:12Z

-Joshua-: /* $PPC Shoulder Strength: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making said transition more dull.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene. This setting gradually has more effect as exposure increases.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting allows for a "bloom" effect.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:52:12Z

-Joshua-: /* $PPC Shoulder Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making said transition more dull.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting allows for a "bloom" effect.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:51:46Z

-Joshua-: /* $PPC Shoulder Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making the image less detailed.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting allows for a "bloom" effect.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:50:56Z

-Joshua-: /* $PPC Toe Strength: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish from black, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from full black and eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making the image less vivid.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting allows for a "bloom" effect.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:49:42Z

-Joshua-: /* $PPC Shoulder Angle: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making the image less vivid.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Shoulder angle adjusts the compensation for overshoot: When the image becomes too bright for the tonemapper to handle, a higher setting here will try to bring the detail in those overly bright areas back, whilst a lower setting allows for a "bloom" effect.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:46:29Z

-Joshua-: /* $PPC Shoulder Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a smoother transition from "visibly bright" to "blindingly bright", at the cost of making the image less vivid.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:44:12Z

-Joshua-: /* $PPC Shoulder Strength: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a less linear transition from "reasonably bright" to "blindingly white", but it also means that that "blindingly white" point comes later. In eyeball terms, this controls how much your virtual pupils are allowed to close.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Shoulder strength adjusts how strongly the tonemapper compensates for bright areas. A high value means that brighter areas will be made less bright. A low value means that there's more "blindingly bright" areas in the scene.
*Syntax: '''''Float'''''
*Default: 0.0
}}

===$PPC Shoulder Angle:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:41:05Z

-Joshua-: /* $PPC Shoulder Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a less linear transition from "reasonably bright" to "blindingly white", but it also means that that "blindingly white" point comes later. In eyeball terms, this controls how much your virtual pupils are allowed to close.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.0
}}
===$PPC Shoulder Angle:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:39:28Z

-Joshua-: /* $PPC Shoulder Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Shoulder length adjusts how gradual the overexposure compensation works. A higher setting means a less linear transition from "reasonably bright" to "blindingly white", but it also means that that "blindingly white" point comes later.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Strength:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.0
}}
===$PPC Shoulder Angle:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:37:50Z

-Joshua-: /* $PPC Toe Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does it's thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.5
}}
===$PPC Shoulder Strength:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.0
}}
===$PPC Shoulder Angle:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:37:36Z

-Joshua-: /* $PPC Toe Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does its thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting and vice-versa.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.5
}}
===$PPC Shoulder Strength:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.0
}}
===$PPC Shoulder Angle:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:36:52Z

-Joshua-: /* $PPC Toe Length: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Toe length adjusts the area in which Toe Strength does its thing. A very low setting will mean that only the darkest areas of the image are affected by the toe strength setting. A very high setting can basically be used to make the entire scene look a lot darker.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Shoulder Length:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.5
}}
===$PPC Shoulder Strength:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.0
}}
===$PPC Shoulder Angle:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

Lighting Profiles.tbl

2022-07-25T05:35:08Z

-Joshua-: /* $PPC Toe Strength: */

{{SCP_table}}
{{Tables}}
The '''lighting_profiles.tbl''' provides controls for the game's lighting and rendering pipeline. The current version only allows fixed settings, but expansion to allow runtime adjustment and swapping between different profiles is planned.

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

==#DEFAULT PROFILE==
{{Table220|
This section defines the settings used by default. Entries may be included in any order, and the section must by closed by a #END DEFAULT PROFILE line.
}}

===$Tonemapper:===
{{Table220|
Sets the algorithm used for the tonemapping stage of rendering. See [[Tonemapping]] for more information on what this means in detail and comparisons of the options.
*Syntax: '''''Str'''''
*Options:
**Linear: Simple clamping and gamma correction. Not recommended in most cases.
**Uncharted 2: FSO's default tonemapper, a filmic look created by John Hable for the game of the same name. This option can also be selected with simply "uncharted"
**ACES: A filmic tonemapper that is the default for Unreal Engine 4, based on film industry standards. Good for high contrasts, has the quirk that it quite visibly desaturates bright colored lights towards white. This is especially visible in Freespace with red Shivan glows, which are bright enough to turn orange.
**ACES Approximate: A simplification of ACES featuring more saturated bright colors and faster rendering. Does not desaturate bright colors.
**Cineon: Another filmic option, similar to ACES it provides high contrast and vibrant colors, it preserves deep blacks but isn't quite as aggressive as ACES on dimly lit scenes.
**Reinhard Extended: A version of a common tonemapper that acts on luminance
**Reinhard Jodie: Another version of Reinhard that makes bright colors less saturated than Reinhard Extended
**PPC: Piecewise power curve, a configurable curve meant to give artists flexible and simple control over the look. Applies to pixel luminance. Configuration options are also available in this table. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/] for detailed breakdown of what this is doing.
**PPC RGB: As with PPC, except applying to each color channel individually rather than combined luminance.
}}
===$Exposure:===
{{Table220|
The rendered scene is multiplied by this value before being tonemapped. Conceptually similar to the exposure time on a camera, higher numbers mean a brighter scene. By using lower exposure and higher values for static lights you could create a otherwise similar scene with more muted lights from ship glows, level backgrounds and weapons fire, or conversely using dim lights and high exposure would emphasize those other light sources.
*Syntax: '''''Float'''''
*Default: 4.0
}}
===$PPC Toe Strength:===
{{Table220|
Toe Strength adjusts how dark the shadows of a scene are. The higher the toe strength, the darker, and harder to distinguish, dark areas in the scene become. Conversely, a low value means that lowly lit objects are easier to distinguish from eachother, but setting it too low can make areas that should be black look greyish.
This setting is very sensitive to exposure. If you lower exposure, you will want to lower toe strength to get some visibility back.
*Syntax: '''''Float'''''
*Default: 0.5
}}

===$PPC Toe Length:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.5
}}
===$PPC Shoulder Length:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.5
}}
===$PPC Shoulder Strength:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.0
}}
===$PPC Shoulder Angle:===
{{Table220|
Used for configuring the piecewise power curve tonemappers. See [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Worlds] for detailed breakdown of the specifics.
*Syntax: '''''Float'''''
*Default: 0.1
}}

===$Missile light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Missile light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for missile weapons (any weapon using a model rather than a laser bitmap or beam). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 20'''
}}

===$Laser light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for laser weapons(weapons using a laser bitmap).
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Laser light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for laser weapons (weapons using a laser bitmap). +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 100'''
}}

===$Beam light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of dynamic lights for beam weapons.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Beam light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the light radius dynamic lights for beam weapons. Unless set otherwise on the specific weapon this is multiplied by the beam's width. +Default: is used for any such weapons not given specific sizes in the weapon tables.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+default: 37.5'''
}}

===$Tube light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Tube light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all tube lights, such as light cast by beam weapons. It is applied after any more specific adjustments such as $Beam light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all point lights, such as light cast by non-beam weapons. It is applied after any more specific adjustments such as $laser light brightness:
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Point light radius:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the radius of all point lights, such as light cast by non-beam weapon. It is applied after any more specific adjustments such as $laesr light radius:.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Cone light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all cone lights. It is applied after any more specific adjustments that might exist.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
*Default values: '''+multiplier: 1.25'''
}}

===$Directional light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of all directional lights, such as level suns.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

===$Ambient light brightness:===
{{Table222|
*An [[Lighting_Profiles.tbl#Adjustable values|Adjustable value]] applied to the brightness of ambient level lighting.
*Syntax: See [[Lighting_Profiles.tbl#Adjustable values|Adjustable values]]
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}

==Adjustable values==
Many profile values allow for a flexible set of configurable adjustments to existing values. These are applied to their inputs in a specific order and will be listed here in that order they, but can be defined in the tables in any order.

===+default:===
{{Table222|
*For values that can be configured more specifically elsewhere, such as the sizes of dynamic weapon lights. Defaults are only meaningful for those proprties that list one in their default settings.
*Syntax: '''''Float'''''
}}

===+Multiplier:===
{{Table222|
*The input value will be multiplied by this amount
*Syntax: '''''Float'''''
}}

===+Adjustment:===
{{Table222|
*This amount will be added to the input value. Negative values allow for downward adjustments.
*Syntax: '''''Float'''''
}}

===+Minimum:===
{{Table222|
*Inputs below this amount will be set to it.
*Syntax: '''''Float'''''
}}

===+Maximum:===
{{Table222|
*Inputs above this amount will be set to it.
*Syntax: '''''Float'''''
}}

==Sample Entry==
<pre>
#DEFAULT PROFILE

$Tonemapper: Uncharted 2
$Exposure: 4.0

$Missile Light Radius:
+Base: 20

$Laser Light Radius:
+Base: 100

$Beam Light Radius:
+Base: 37.5

$Point Light Radius:
+Multiplier: 1.25

$Cone Light Radius:
+Multiplier: 1.25

#END DEFAULT PROFILE
</pre>
== References ==
# [http://filmicworlds.com/blog/filmic-tonemapping-with-piecewise-power-curves/ Filmic Tonemapping with Piecewise Power Curves], John Hable
# [https://64.github.io/tonemapping/ Tone Mapping], 64
# [http://filmicworlds.com/blog/filmic-tonemapping-operators/ Filmic Tonemapping Operators], John Hable

[[Category:Tables]]

GTB Artemis D.H.

2008-06-04T09:05:01Z

-Joshua-:

{{FS12_Ships}}
{{shipimage|image=[[Image:Artemis_dh320x240.jpg]]|caption=The GTB Artemis D.H.}}

==Description:==

The Artemis D.H. is a simple reskinning of the [[GTB Artemis|GTB ''Artemis'']]. It is unknown what D.H. stands for, but HLP members have suggested "Dark Hull" and "Death Head."

Despite the tech description, the Artemis D.H. is statistically no different than the regular Artemis.

===FS2 Tech Room Description===
The GTB Artemis D.H. is an experimental variant of the standard Artemis class. The most notable change is that the Artemis's factory-issued Han-Ronald engines have been replaced by the same Nankam NA-27f powerplant now found in the GTF Ares fightercraft. The D.H. variant is faster and more maneuverable than the standard Artemis bomber, at no cost to armor or armament. During the OpEval period, Artemis D.H. bombers are being deployed in only select squadrons in different theatres of the war. If the evaluation trials go well, wider deployment of the Artemis D.H. class is expected.

===Developer Notes===
None

==Performance:==
===Statistics===
{{Ship Stats|Medium Bomber|Han-Ronald Corp.|Average|65.0 - 65.0|110.0|Medium|275|700|36}}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#351515;"| '''Freespace 2'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
| 1st
| 4
| [[GTW Subach HL-7|Subach HL-7]]
|- align="center"
| colspan=3| Compatible Primaries
|-
| colspan=3| [[GTW Subach HL-7|Subach HL-7]], [[GTW Prometheus R|Prometheus R]], [[GTW Prometheus S|Prometheus S]], [[GTW Lamprey|Lamprey]], [[GTW Circe|Circe]], [[GTW Maxim|Maxim]]
|}
*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#351515;"| '''Freespace 2'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard Loadout
|- align="center"
| 1st
| 40
| [[GTM Hornet|Hornet]]
|- align="center"
| 2nd
| 60
| [[GTM Cyclops|Cyclops]]
|- align="center"
| 3rd
| 60
| [[GTM Cyclops|Cyclops]]
|- align="center"
| colspan=3| Compatible Secondaries
|-
| colspan=3| [[GTM MX-64|MX-64]], [[GTM EMP. Adv|Emp. Adv]], [[GTM Stiletto II|Stiletto II]], [[GTM Piranha|Piranha]], [[GTM Hornet|Hornet]], [[GTM Tornado|Tornado]], [[GTM Trebuchet|Trebuchet]], [[GTM Infyrno|Infyrno]], [[GTM Cyclops|Cyclops]]
|}

==Veteran Comments==
{{Comment|
''While many pilots, myself included, swear up and down that the Artemis D.H. is superior to the Artemis, this is, as Setekh has termed it, the "placebomber" effect. The only functional difference between the Artemis and Artemis D.H. is their texturing, as examination of the table files shows.''

''Besides multiplayer weapons compatibility, there is one minuscule difference in the model. The DH Artemis has only three tail fins. The standard has four.''

''You can "win" the GTB Artemis D.H. by completing the first SOC Mission loop (Second one grants you the Ares). This bomber, unfortanly, suffers from a small problem. They copied the [[GTB Artemis]] table entry and then forgot to change the manouvrability table entries. It was SUPPOSED to be more manouvrable (as seen in the tech entries) but they forgot to DO it. Which is a pity for a bonus fighter.''
}}

[[Category:Ship]]