FreeSpace Wiki - User contributions [en]

Sample Lighting Settings

2025-02-23T22:35:19Z

EatThePath:

{{Table224|
This method of configuring a mod's lighting has been replaced with the [[Lighting_Profiles.tbl]], and these settings do not apply to 22.4 or later. New lighting flags listed in [[Command-Line Reference#Lighting|Command Line Reference]] now mainly serve usability and accessibility reasons, with some legacy support for modifying ambient intensity.}}

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

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

==FSO 3.8.0 - 22.2 lighting presets==
{{note|These settings are obsolete as of FSO 22.4.0}}

===[https://imgur.com/gallery/MshrBKk FrikgFeek's Settings]===

[[Image:Ff lighting 00.png|thumb|A compromise between space darkness and playability.]]
Focusing on star-based lighting with relatively high bloom to help glowpoints illuminate ships. This setting provides a highly contrasting light-darkness look that puts a lot of emphasis on star position. Light and shadow are emphasized and very distinct.
*-ambient_factor 55
*-spec_point 0.7
*-spec_static 2.12
*-spec_tube 1.2
*-bloom_intensity 45
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 55 -spec_point 0.7 -spec_static 2.12 -spec_tube 1.2 -bloom_intensity 45 -no_emissive_light}}

[[Image:Ff lighting 01.png|thumb|Similar idea to the previous setting, adding more ambient to reduce the contrast. Still somewhat dark but never fully black.]]
Omnidirectional ambient lighting is more emphasized while still darker than static lighting. Bloom is reduced to de-emphasize glowpoints. Compared to the previous setting there's a lot less light-dark contrast but overall visibility is improved.
*-ambient_factor 91
*-spec_point 1.2
*-spec_static 0.55
*-spec_tube 1.3
*-bloom_intensity 19
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 91 -spec_point 1.2 -spec_static 0.55 -spec_tube 1.3 -bloom_intensity 19 -no_emissive_light }}

[[Image:Ff lighting 02.png|thumb|Extremely dark setting exclusively focused on glowpoints and dynamic lighting from weapons and beams.]]
This setting contains more screenshots since its look rapidly changes as action happens. Ships switch from very dark to very bright when engaged in combat. The beams also light up nearby fighters. The very high bloom(at least compared to other settings, still reduced from the default setting of 75) provides extremely bright and bleeding flashes of light during explosions, further emphasizing the dynamic nature of this preset.
*-ambient_factor 45
*-spec_point 1.5
*-spec_static 0.7
*-spec_tube 1.8
*-bloom_intensity 56
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 45 -spec_point 1.5 -spec_static 0.7 -spec_tube 1.8 -bloom_intensity 56 -no_emissive_light }}

===Rhymes' Settings===
Generally dark but not pitch-black environments, with a heavy emphasis on lighting from weapons fire and the in-mission sun.
*-ambient_factor 80
*-spec_point 0.3
*-spec_static 2
*-spec_tube 0.7
*-bloom_intensity 10
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 80 -spec_point 0.3 -spec_static 2 -spec_tube 0.7 -bloom_intensity 10 }}

==Recommended Diaspora Settings==
These are the recommended light settings for Diaspora. For now, you'll only see them available in Diaspora's version of the launcher.
* -ambient_factor 90
* -spec_exp 0.7
* -spec_point 0.7
* -spec_static 1.0
* -spec_tube 1.0
* -ogl_spec 15
* -bloom_intensity 20

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 90 -spec_exp 0.7 -spec_tube 1.0 -spec_point 0.7 -spec_static 1.0 -ogl_spec 15 -bloom_intensity 20}}

==Pre-3.8.0 lighting presets==

{{note|These settings are obsolete as of FSO 3.8.0}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[[Category:Source Code Project]]

Sample Lighting Settings

2025-02-23T22:33:19Z

EatThePath:

{{Table224|
This method of configuring a mod's lighting has been replaced with the [[Lighting_Profiles.tbl]], and these settings do not apply to 22.4 or later. New lighting flags listed in [[Command-Line Reference#Lighting|Command Line Reference]] now mainly serve usability and accessibility reasons, with some legacy support for modifying ambient intensity.}}

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

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

==FSO 3.8.0 - 22.2 lighting presets==
{{note|These settings are obsolete as of FSO 22.4.0}}

===[https://imgur.com/gallery/MshrBKk FrikgFeek's Settings]===

[[Image:Ff lighting 00.png|thumb|A compromise between space darkness and playability.]]
Focusing on star-based lighting with relatively high bloom to help glowpoints illuminate ships. This setting provides a highly contrasting light-darkness look that puts a lot of emphasis on star position. Light and shadow are emphasized and very distinct.
*-ambient_factor 55
*-spec_point 0.7
*-spec_static 2.12
*-spec_tube 1.2
*-bloom_intensity 45
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 55 -spec_point 0.7 -spec_static 2.12 -spec_tube 1.2 -bloom_intensity 45 -no_emissive_light}}

[[Image:Ff lighting 01.png|thumb|Similar idea to the previous setting, adding more ambient to reduce the contrast. Still somewhat dark but never fully black.]]
Omnidirectional ambient lighting is more emphasized while still darker than static lighting. Bloom is reduced to de-emphasize glowpoints. Compared to the previous setting there's a lot less light-dark contrast but overall visibility is improved.
*-ambient_factor 91
*-spec_point 1.2
*-spec_static 0.55
*-spec_tube 1.3
*-bloom_intensity 19
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 91 -spec_point 1.2 -spec_static 0.55 -spec_tube 1.3 -bloom_intensity 19 -no_emissive_light }}

[[Image:Ff lighting 02.png|thumb|Extremely dark setting exclusively focused on glowpoints and dynamic lighting from weapons and beams.]]
This setting contains more screenshots since its look rapidly changes as action happens. Ships switch from very dark to very bright when engaged in combat. The beams also light up nearby fighters. The very high bloom(at least compared to other settings, still reduced from the default setting of 75) provides extremely bright and bleeding flashes of light during explosions, further emphasizing the dynamic nature of this preset.
*-ambient_factor 45
*-spec_point 1.5
*-spec_static 0.7
*-spec_tube 1.8
*-bloom_intensity 56
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 45 -spec_point 1.5 -spec_static 0.7 -spec_tube 1.8 -bloom_intensity 56 -no_emissive_light }}

===Rhymes' Settings===
Generally dark but not pitch-black environments, with a heavy emphasis on lighting from weapons fire and the in-mission sun.
*-ambient_factor 80
*-spec_point 0.3
*-spec_static 2
*-spec_tube 0.7
*-bloom_intensity 10
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 80 -spec_point 0.3 -spec_static 2 -spec_tube 0.7 -bloom_intensity 10 }}

==Recommended Diaspora Settings==
These are the recommended light settings for Diaspora. For now, you'll only see them available in Diaspora's version of the launcher.
* -ambient_factor 90
* -spec_exp 0.7
* -spec_point 0.7
* -spec_static 1.0
* -spec_tube 1.0
* -ogl_spec 15
* -bloom_intensity 20

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 90 -spec_exp 0.7 -spec_tube 1.0 -spec_point 0.7 -spec_static 1.0 -ogl_spec 15 -bloom_intensity 20}}

==Deprecated lighting presets==

{{note|These settings are obsolete as of FSO 3.8.0}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[[Category:Source Code Project]]

Messages.tbl

2023-05-29T04:22:45Z

EatThePath: /* $Name: */ sorted the message names alphabetically, damnit

{{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 subject:]] 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]]

Lighting Profiles.tbl

2023-05-21T00:58:00Z

EatThePath: /* #END DEFAULT PROFILE */

{{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.
}}

==#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]]

Lighting Profiles.tbl

2023-05-21T00:57:40Z

EatThePath: /* #PROFILES */

{{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.
}}

==#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 DEFAULT PROFILE==
{{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]]

Ai profiles.tbl

2023-03-18T05:07:41Z

EatThePath: /* $Chance AI Has to Fire Missiles at Player: */

{{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.

{{Table232| This table can also be called '''mission_profiles.tbl'''}}

This table is one of the [[Modular Tables]] and can be extended with xxx-aip.tbm
{{Table232| Can also be extended with '''xxx-msp.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'''}}
{{Table232|
*'''ships playing dead don't manage ETS'''}}

==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 for an AI to hesitate about firing a secondary or homing turret weapon at the player. Values range from 0-6, at 0 they will frequently hesitate, at 6 they will never hesitate.
*Syntax: '''Float list'''
**Default: 0, 1, 2, 3, 4
* Mechanic details: AIs are only allowed to fire homing secondaries or turrets with homing weapons at the player in a limited window of time. The window starts every ten seconds, and lasts ('''value''' + 1) 7ths of that ten second cycle. Each ship has it's own cycle, so their windows are not all synchronized.
* Example: a value of 1 becomes 2/7ths, so ships can fire homing weapons at the player for roughly 2.85 seconds at a time, then are unable to fire them for 7.15 seconds.
}}

===$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'''''}}

===$ships playing dead don't manage ETS:===
{{Table232|
*Prevents ships from managing their ETS is they are currently playing dead. Managing ETS could lead to unexpected speed changes in ship-maneuver.
*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 an AI behavior where fighters/bombers will spin around for a second or two when they acquire a target.
*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]]

Ai profiles.tbl

2023-03-18T05:07:04Z

EatThePath: /* $Chance AI Has to Fire Missiles at Player: */

{{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.

{{Table232| This table can also be called '''mission_profiles.tbl'''}}

This table is one of the [[Modular Tables]] and can be extended with xxx-aip.tbm
{{Table232| Can also be extended with '''xxx-msp.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'''}}
{{Table232|
*'''ships playing dead don't manage ETS'''}}

==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 for an AI to hesitate about firing a missile at the player. Values range from 0-6, at 0 they will frequently hesitate, at 6 they will never hesitate.
*Syntax: '''Float list'''
**Default: 0, 1, 2, 3, 4
* Mechanic details: AIs are only allowed to fire homing secondaries or turrets with homing weapons at the player in a limited window of time. The window starts every ten seconds, and lasts ('''value''' + 1) 7ths of that ten second cycle. Each ship has it's own cycle, so their windows are not all synchronized.
* Example: a value of 1 becomes 2/7ths, so ships can fire homing weapons at the player for roughly 2.85 seconds at a time, then are unable to fire them for 7.15 seconds.
}}

===$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'''''}}

===$ships playing dead don't manage ETS:===
{{Table232|
*Prevents ships from managing their ETS is they are currently playing dead. Managing ETS could lead to unexpected speed changes in ship-maneuver.
*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 an AI behavior where fighters/bombers will spin around for a second or two when they acquire a target.
*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]]

Command-Line Reference

2023-01-17T19:17:33Z

EatThePath: /* -override_data */

{{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.
}}

====-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_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.}}

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

====-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.}}

====-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.

====-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

2023-01-17T19:07:21Z

EatThePath: /* Development Tools */

{{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.
}}

====-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 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_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.}}

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

====-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.}}

====-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.

====-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

2023-01-17T19:02:07Z

EatThePath: /* Launcher */

{{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.
}}

====-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 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_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"'''

==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.}}

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

====-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.}}

====-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.

====-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]]

Hud gauges.tbl

2022-11-29T16:46:26Z

EatThePath: Fixed mis-spellings of gauges in links.

{{SCP table}}
{{TableVersionGit|2016-09-14|f9bc01c}}
{{Tables}}
The '''hud_gauges.tbl''' is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).

HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.

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

==HUD Configurations==
The following entries are used on the HUD system, but have not been grouped with any particular gauge.

===$Load Retail Configuration:===
Optional. If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.

If no, any missing (default) gauge will prompt an error.

*Syntax: '''Boolean'''

===$Color:===
Optional. Sets the default HUD color for all gauges.

*Syntax: ('''Integer''' Red, '''Integer''' Green, '''Integer''' Blue)
*Valid Values: all values from 0 to 255

===$Font:===
Optional. Sets the font type to use for the HUD. This can either be a string or a number. A string references a font with a specific name while a number references a font with a specific index in the fonts table. The number option is deprecated and is only there for backwards-compatibility. Use the name if possible.

*Syntax: '''String''' or '''Integer''' font index number
*Valid Values: Any name or font index as defined in [[Fonts.tbl]]

===$Chase View Only:===
{{Table381|
Optional. Sets gauges to be displayed only in Chase View.

*Syntax: '''Boolean'''
*Default Value: '''False'''
}}

===$Max Directives:===
Optional. Sets the default maximum number of directives displayed simultaneously.

*Syntax: '''Integer''' maximum number of directives
*Valid Values: Any positive number
*Default Value: '''5'''

===$Max Escort Ships:===
Optional. Sets the default maximum number of escort ships to be shown in the escort list.

*Syntax: '''Integer'''
*Valid Values: Any positive number
{{Warning|
Entries more than 16 will cause the list to overflow into the weapons list for resolutions lower than 1024x768.}}

===$Length Unit Multiplier:===
Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.

*Syntax: '''Float'''
*Valid Values: Any positive number

===$Speed Unit Multiplier:===
Optional. Analogous to [[Hud_gauges.tbl#$Length Unit Multiplier:|$Length Unit Multiplier]], this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.

*Syntax: '''Float'''
*Valid Values: Any positive number
*Default Values:
:'''The value used in $Length Unit Multiplier''', or
:'''1''', if $Length Unit Multiplier is undefined

===$Wireframe Targetbox:===
Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).

*Syntax: '''Integer''' Draw method ID
*Valid Values:
::'''0''' - Standard with full, bright lighting
::'''1''' - Wireframe
::'''2''' - Standard with proper lighting (i.e. lit the same as the actual target)
{{Table3615|
::'''3''' - Untextured with full bright lighting (i.e. drawn with a single flat color)}}

{{Table224|
===$Wireframe Color Override:===
Optional. Allows using a static color for the target monitor wireframe instead of one based on the target's IFF.
*Syntax: ( Color ), three integers, values from 0 to 255; red, green and blue respectively
*Example: ( 0, 255, 0 )}}

===$Targetbox Shader Effect:===
{{Table3615|
Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in [[Post_processing.tbl##Ship_Effects|#Ship_Effects]], but a table entry for the effect is not needed.

*Syntax: '''Integer'''
*Valid Values: Any positive number
}}

===$Lock Wireframe Mode:===
Optional. If set, prevents targetbox draw method from being changed during the gaming session.
*Syntax: '''Boolean'''

===$Scale Gauges:===
{{Table371|
Optional. If set, all gauges will use this value as the default for scaling individual gauge sizes (i.e. doesn't affect gauges that use Position:, and doesn't affect the values of Offset:. In addition, if "$Load Retail Configuration:" is true then all unspecified retail gauges will use this value.

If not set, defaults to yes.

*Syntax: '''Boolean'''
}}

===$Force Scaling Above:===
{{Table373|
Optional. If gauge scaling is disabled, then gauges will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.

Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.

To disable this feature, use '''(-1, -1)'''.

*Syntax: ('''Integer''' width, '''Integer''' height)
}}

===$Reticle Style:===
Optional. Defines which aiming reticle to use.
*Syntax: '''String'''
*Valid Values:
:'''FS1''' - uses '''''reticle1_fs1.ani'''''
:'''FS2''' - uses '''''reticle1.ani'''''

==#Gauge Config==
The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.

===$Ship:===
Deprecated and superceded by $Ships in FSO revision 9208. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*Syntax: '''String''', ship class name

===$Ships:===
Optional. Can be used to define a list of ships the hud definition that follows will be applied to. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*`Syntax: '''( "Class name 1" "Class name 2" )''', ship class names formatted like a flag list.

====$Load Retail Configuration:====
Optional. Overrides the [[Hud_gauges.tbl#$Load Retail Configuration: 1|$Load Retail Configuration]] global option for this ship class.

*Syntax: '''Boolean'''

====$Color:====
Optional. Overrides the [[Hud_gauges.tbl#$Color: 1|$Color]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color]]

====$Font:====
Optional. Overrides the [[Hud_gauges.tbl#$Font: 1|$Font]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font]]

====$Chase View Only:====
{{Table381|
Optional. Overrides the [[Hud_gauges.tbl#$Chase View Only: 1|$Chase View Only]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Chase View Only: 1|$Chase View Only]]
}}

===$Base:===
Required. Defines the base resolution for this HUD configuration, upon which other gauge options (such as [[Hud_gauges.tbl#Position:|Position:]] / [[Hud_gauges.tbl#Origin:|Origin:]] / [[Hud_gauges.tbl#Offset:|Offset:]]) will use as its coordinate system.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Scale Gauges:===
{{Table371|
Optional. If set, will configure gauges Scaling behaviour for gauges in this #Gauge Config section. i.e. overriding the default, or the value specified at the top of the file. Individual gauges can override this setting.

*Syntax: '''Boolean'''
}}

===$Force Scaling Above:===
{{Table373|
Optional. If gauge scaling is disabled, then gauges will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.

Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.

To disable this feature, use '''(-1, -1)'''.

*Syntax: ('''Integer''' width, '''Integer''' height)
}}

===$Required Aspect:===
Optional. If set, this configuration will only be loaded for the specified aspect ratios.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: '''String'''
*Valid Values:
:"Full Screen" (4:3, aspect ratio < 1.5)
:"Wide Screen" (16:9, 16:10, or similar, aspect ratio >= 1.5)

===$Min:===
Optional. Minimum resolution for this config. Any resolution lower than specified will not use this configuration.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Max:===
Optional. Maximum resolution for this config. Any resolution higher than specified will not use this configuration.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Gauges:===
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.

Since many gauges have the same configuration options, each gauge entry has a list of valid sub-entries. Unless stated otherwise, these options must be defined in the same order as they are shown, starting from the top and ending at the bottom.

====+Custom:====
Adds a custom gauge type.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Name:|Name:]]
:[[Hud_gauges.tbl#Text:|Text:]]
:[[Hud_gauges.tbl#X Offset:|X Offset:]] (Optional)
:[[Hud_gauges.tbl#Y Offset:|Y Offset:]] (Optional)
:[[Hud_gauges.tbl#Gauge Type:|Gauge Type:]]
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Active by default:|Active by default:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

{{table381|
====+Scripted Gauge:====
Adds a scripted gauge type.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Name:|Name:]]
}}

====+Messages:====
Adds a gauge that display mission messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Max Lines:|Max Lines:]] (Optional)
:[[Hud_gauges.tbl#Max Width:|Max Width:]] (Optional)
:[[Hud_gauges.tbl#Line Height:|Line Height]] (Optional)
:[[Hud_gauges.tbl#Total Lifetime:|Total Lifetime:]] (Optional)
:[[Hud_gauges.tbl#Scroll Time:|Scroll Time]] (Optional)
:[[Hud_gauges.tbl#Step Size:|Step Size:]] (Optional)
:[[Hud_gauges.tbl#Hidden By Comms Menu:|Hidden By Comms Menu:]] (Optional)

====+Training Messages:====
Adds a text box, like the ones seen in the FS1 and FS2 training missions.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Support:====
Adds a text box that shows the Support ship's status and ETA

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Text Y-offset:|Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Status X-offset:|Dock Status X-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Time X-offset:|Dock Time X-offset:]] (Optional)
{{table224|
:[[Hud_gauges.tbl#Enable Rearm Timer:|Enable Rearm Timer:]] (Optional boolean. Enables the countdown timer for rearm and repair. Overrides the commandline setting.)}}

====+Damage:====
Adds a gauge that shows how much damage a target (or the player?) has.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Offsets:|Hull Integrity Offsets]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Value X-offset:|Hull Integrity Value X-offset]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Height:|Subsystem Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem List Start Offsets:|Subsystem List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Value X-offset:|Subsystem Entry Value X-offset:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)

====+Wingman Status:====
Adds a gauge that monitors the status of your wing and squadron.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]] (Optional) (needs an animation with one frame)
{{table3615|
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional) (needs an animation with one frame)}}
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional) (needs an animation with one frame)
:[[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]] (Optional) (needs an animation with one frame)
{{table3615|
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional) (needs an animation with one frame)}}
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional) (needs an animation with two frames, 1st is for alive wingmen, 2nd is for dead or missing wingmen)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
{{table373|
[[Hud_gauges.tbl#Fixed Header Position:|Fixed Header Position:]] (Optional)}}
:[[Hud_gauges.tbl#Left Background Width:|Left Background Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#First Background Size:|First Background Size:]] (Optional)}}
:[[Hud_gauges.tbl#Entry Width:|Entry Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Entry Size:|Entry Size:]] (Optional)
:[[Hud_gauges.tbl#Right Background Offset:|Right Background Offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Offset:|Last Background Offset:]] (Optional)}}
:[[Hud_gauges.tbl#Single Wing Offsets:|Single Wing Offsets:]] (Optional)
:[[Hud_gauges.tbl#Multiple Wing Start Offsets:|Multiple Wing Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Wing Name Offsets:|Wing Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dot Offsets:|Dot Offsets:]] (Optional)
:[[Hud_gauges.tbl#Expansion Mode:|Expansion Mode:]] (Optional)
{{Table214|
:[[Hud_gauges.tbl#Use Full Wing Names:|Use Full Wing Names:]] (Optional)
:[[Hud_gauges.tbl#Use Expanded Colors:|Use Expanded Colors:]] (Optional)
}}

====+Auto Speed:====
Adds the Auto-Speed mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (needs animation with 4 frames, 3rd is without auto-match-speed enabled, 4th is with... and frames 0 & 1 are not used, done this way because retail fs2 uses the same animation file for the auto speed & auto targeting gauges)
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#On Text Color:|On Text Color:]] (Optional)
:[[Hud_gauges.tbl#On Text Color:|Off Text Color:]] (Optional)}}

====+Auto Target:====
Adds the Auto-target mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (needs animation with 2 frames, 1st is without auto-targeting enabled, 2nd is with)
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Offsets:|Target Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#On Text Color:|On Text Color:]] (Optional)
:[[Hud_gauges.tbl#On Text Color:|Off Text Color:]] (Optional)}}

====+Countermeasures:====
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (needs an animation with a single frame)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Talking Head:====
Adds a video window to display pilot message videos (a.k.a talking heads).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Offsets:|Animation Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Background Size:|Animation Background Size:]] (Deprecated)
{{table373|
:[[Hud_gauges.tbl#Animation Size:|Animation Size:]] (Optional)
}}

====+Directives:====
Adds a gauge that displays all currently active directives (includes current , completed, and failed)

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional) (needs animation with one frame)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional) (needs animation with one frame)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional) (needs animation with one frame)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)
:[[Hud_gauges.tbl#Max Line Width:|Max Line Width:]] (Optional)
}}

====+Weapons:====
Adds a weapon status and ammunition gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Primary List Top Background Filename:|Primary List Top Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Primary List Middle Background Filename:|Primary List Middle Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Primary List Bottom Background Filename:|Primary List Bottom Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Secondary List Top Background Filename:|Secondary List Top Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Secondary List Entry Background Filename:|Secondary List Entry Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Secondary List Bottom Background Filename:|Secondary List Bottom Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
::[[Hud_gauges.tbl#Alt Ballistic Offsets:|Alt Ballistic Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Primary Background X-offset:|Top Primary BackgroundX-offset:]] (Optional)
::[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]] (Optional)
:[[Hud_gauges.tbl#Text X-offset:|Text X-offset:]] (Optional)
::[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]] (Optional)
:[[Hud_gauges.tbl#Top Primary Frame Height:|Top Primary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Top Secondary Frame Height:|Top Secondary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Primary List Start Y-offset:|Primary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Start Y-offset:|Secondary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Ammo X-offset:|Primary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Link X-offset:|Primary Weapon Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Name X-offset:|Primary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Ammo X-offset:|Secondary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Linked X-offset:|Secondary Weapon Linked X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Name X-offset:|Secondary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Reload X-offset:|Secondary Weapon Reload X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Entry Height:|Primary Weapon Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Entry Height:|Secondary Weapon Entry Height:]] (Optional)

====+Objective notify:====
Adds a Objective notifier gauge. This gauge alerts the player when receiving a new objective, or when an objective has been completed or failed. Additionally, this gauge alerts the player when entering subspace, and when a Red Alert mission orders are being received (prior to a forced subspace jump).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Objective Text Y-offset:|Objective Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Objective Value Y-offset:|Objective Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Text Y-offset:|Subspace Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Value Y-offset:|Subspace Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Text Y-offset:|Red Alert Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Value Y-offset:|Red Alert Value Y-offset:]] (Optional)

====+Squad Message====
Adds the squad message gauge. In FS1 and FS2, this gauge is used to send commands to your squad. (?)

*Valid sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset|Bottom Background Offset]] (Optional)}}
:[[Hud_gauges.tbl#Command X-offset:|Command X-offset:]] (Optional)
:[[Hud_gauges.tbl#Page Up Offsets:|Page Up Offsets:]] (Optional)
:[[Hud_gauges.tbl#Page Down Offsets:|Page Down Offsets:]] (Optional)

====+Lag:====
Adds a Lag gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

====+Mini Target Shields:====
Adds a mini Target shields gauge. In FS1 and FS2, the Mini Target Shield gauge is the one right below the center reticle, and shows the hull damage in %

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (animation needs 8 frames; 0->3 are the top, right, bottom & left shield quads; 4->7 are the same except brighter for when the quad is flashing from being hit)
:[[Hud_gauges.tbl#3 Digit Hull Offsets:|3 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#2 Digit Hull Offsets:|2 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#1 Digit Hull Offsets:|1 Digit Hull Offsets:]] (Optional)

====+Player Shields:====
Adds a gauge that shows the shield and hull status icon of the player's craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Target Shields:====
Adds a gauge that shows the shield and hull status icon of the targeted craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Escort View:====
Adds an escort monitor/view gauge. This gauge monitors the status of all ships assigned to the player to escort.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height]] (Optional)
:[[Hud_gauges.tbl#Entry Stagger Width:|Entry Stagger Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)}}
:[[Hud_gauges.tbl#Header Text:|Header Text]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull X-offset:|Hull X-offset]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset]] (Optional)
:[[Hud_gauges.tbl#Status X-offset:|Status X-offset]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Ship Name Max Width:|Ship Name Max Width:]] (Optional)}}
{{table373|
:[[Hud_gauges.tbl#Right-Align Ship Names:|Right-Align Ship Names:]] (Optional)}}

====+Mission Time:====
Adds a gauge that displays the current mission time.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+ETS Retail:====
{{Table3613|
Draws the three other ETS gauges as a single gauge. Will automatically rearrange itself (like retail) if shields or other systems are missing.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
{{Table3613|
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)
:[[Hud_gauges.tbl#Gauge Offset:|Gauge Offset:]] (Optional)

}}

====+ETS Weapons:====
Adds a gauge that displays the energy transfer rate for the energy weapons.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Engines:====
Adds a gauge that displays the energy transfer rate for the afterburner/engines.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Shields:====
Adds a gauge that displays the energy transfer rate for the shields.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+Target Monitor:====
Adds a target monitor gauge that shows the targeted ship's relative orientation and hull strength, among other things.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Monitor Filename:|Monitor Filename:]] (Optional) (needs animation with 2 frames, 1st is the background for the target, 2nd is the border; rendered last)
{{table3615|
:[[Hud_gauges.tbl#Monitor Alpha Mask Filename:|Monitor Alpha Mask Filename:]] (Optional) (needs animation with a single frame)}}
:[[Hud_gauges.tbl#Integrity Bar Filename:|Integrity Bar Filename:]] (Optional) (needs animation with 2 frames, 1st is a zero/dark filled bar, 2nd is a max/bright filled bar)
:[[Hud_gauges.tbl#Viewport Offsets:|Viewport Offsets:]] (Optional)
:[[Hud_gauges.tbl#Viewport Size:|Viewport Size:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Offsets:|Integrity Bar Offsets:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Foreground Clip Height:|Integrity Bar Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Status Offsets:|Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Class Offsets:|Class Offsets:]] (Optional)
:[[Hud_gauges.tbl#Distance Offsets:|Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Offsets:|Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Contents Offsets:|Cargo Contents Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Start Offsets:|Cargo Scan Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Size:|Cargo Scan Size:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Subsystem Name Offsets:|Subsystem Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Integrity Offsets:|Subsystem Integrity Offsets:]] (Optional)
:[[Hud_gauges.tbl#Disabled Status Offsets:|Disabled Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Desaturate:|Desaturate:]] (Optional)
}}
{{table224|
:[[Hud_gauges.tbl#Wireframe:|Wireframe:]] (Optional. Valid values match $Wireframe Targetbox: and will override the global setting)
:[[Hud_gauges.tbl#Wireframe Color:|Wireframe Color:]] (Optional. Color. Takes three ints 0-255, R,G,B; will override the global setting)
}}

====+Extra Target Data:====
Adds a gauge that displays "extra" target data, such as its current orders and docking status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs an animation with 1 frame)
:[[Hud_gauges.tbl#Bracket Offsets:|Bracket Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dock Offsets:|Dock Offsets:]] (Optional)
{{table373|
:[[Hud_gauges.tbl#Dock Max Width:|Dock Max Width:]] (Optional)}}
:[[Hud_gauges.tbl#Order Offsets:|Order Offsets:]] (Optional)
{{table373|
:[[Hud_gauges.tbl#Order Max Width:|Order Max Width:]] (Optional)}}
:[[Hud_gauges.tbl#Time Offsets:|Time Offsets:]] (Optional)

====+Radar:====
Adds a standard radar gauge

*Valid Sub-entries:
{{table190|
:[[Hud_gauges.tbl#Ngon Sides:|Ngon Sides:]] (Optional)
:[[Hud_gauges.tbl#Ngon Sides:|Ngon Offset:]] (Optional)
}}
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs animation with 2 frames, only the 2nd frame is used)
{{table373|
:[[Hud_gauges.tbl#Radar Center Offsets:|Radar Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Radar Size:|Radar Size:]] (Optional)
}}
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar Orb:====
Adds a 3D orb radar gauge

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs animation with 2 frames, only the 2nd frame is used)
{{table373|
:[[Hud_gauges.tbl#Radar Center Offsets:|Radar Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Radar Size:|Radar Size:]] (Optional)
}}
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar BSG:====
Adds a BSG style radar (a.k.a DRADIS).

:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#XY Disc Filename:|XY Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#XZ YZ Disc Filename:|XZ YZ Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Sweep Disc Filename:|Sweep Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Default Contact Filename:|Default Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Unknown Contact Filename:|Unknown Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]]
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]]
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Loop Volume:|Loop Volume:]] (Optional)
:[[Hud_gauges.tbl#Minimum Beep Delay:|Minimum Beep Delay]] (Optional)

====+Afterburner Energy:====
Adds a gauge that shows the remaining afterburner energy. Note that it only supports a vertical fill.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs animation with 2 frames, the 1st is the bar lit for zero energy, the 2nd is the bar lit for max energy)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)

====+Weapon Energy:====
Adds a gauge that shows the remaining weapon energy. Note that it only supports a vertical fill.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs an animation with 4 frames, the 3rd is the bar lit for zero energy, the 2nd is the bar lit for max energy, frames 1 & 2 are not used)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Text Alignment:|Text Alignment:]] (Optional)
:[[Hud_gauges.tbl#Always Show Text:|Always Show Text:]] (Optional)
:[[Hud_gauges.tbl#Text Follows:|Text Follows:]] (Optional)
:[[Hud_gauges.tbl#Show Ballistic Ammo:|Show Ballistic Ammo:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Offsets:|Armed Guns List Offsets:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Alignment:|Armed Guns List Alignment:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Entry Height:|Armed Guns List Entry Height:]] (Optional)
}}

====+Text Warnings:====
Adds a gauge that warns the player (current warnings are EMP, Launch, Evaded, Collision, Blast & Engine Wash).

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Center Reticle:====
Adds a "custom" center reticle.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Firepoint display:|Firepoint display:]] (Optional)
:[[Hud_gauges.tbl#Firepoint size:|Firepoint size:]] (Optional)
:[[Hud_gauges.tbl#Firepoint X coordinate multiplier:|Firepoint X coordinate multiplier:]] (Optional)
:[[Hud_gauges.tbl#Firepoint Y coordinate multiplier:|Firepoint Y coordinate multiplier:]] (Optional)

====+Throttle:====
Adds a gauge that shows the current throttle position.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Bottom Y-offset:|Foreground Clip Bottom Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Width:|Foreground Clip Width:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Afterburner Clip Height:|Afterburner Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Show Background:|Show Background:]] (Optional)
:[[Hud_gauges.tbl#Max Speed Label Offsets:|Max Speed Label Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Show Max Speed Label:|Show Max Speed Label:]] (Optional)}}
:[[Hud_gauges.tbl#Min Speed Label Offsets:|Min Speed Label Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Show Min Speed Label:|Show Min Speed Label:]] (Optional)}}
:[[Hud_gauges.tbl#Orbit Center Offsets:|Orbit Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Orbit Radius:|Orbit Radius:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Current Speed Offsets:|Current Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Speed Offsets:|Target Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Show Percentage:|Show Percentage:]] (Optional)
:[[Hud_gauges.tbl#Glide Status Offsets:|Glide Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Match Speed Status Offsets:|Match Speed Status Offsets:]] (Optional)
}}

====+Threat Indicator:====
Adds a gauge that indicates when a lock-on has been achieved by an attacker, and if the player is being shot at.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Filename:|Dumbfire Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Offsets:|Dumbfire Offsets:]] (Optional)
:[[Hud_gauges.tbl#Lock Offsets:|Lock Offsets:]] (Optional)

====+Multiplayer Messages:====
Adds a gauge that displays the multiplayer messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Voice Status:====
Adds a gauge that displays the voice status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Ping:====
Adds a gauge that the ping time to the multiplayer server.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Supernova:====
Adds a gauge that warns the player of an impending supernova shock wave.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Lock Indicator:====
Adds a Lock Indicator gauge.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Locked Filename:|Locked Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Center Offsets:|Lock Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Locked Center Offsets:|Locked Center Offsets:]] (Optional)
{{table224|
:[[Hud_gauges.tbl#Loop Locked Animation:|Loop Locked Animation:]] (Optional)
:[[Hud_gauges.tbl#Blink Locked Animation:|Blink Locked Animation:]] (Optional)}}

====+Offscreen Indicator:====
Adds an Offscreen Indicator.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Target Brackets:====
Adds a Target Bracket gauge. This is drawn around current target(s) and talkers.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)
{{table224|
:[[Hud_gauges.tbl#Enable Target Info:|Enable Target Info:]] (Optional boolean. Adds the target name and class to the brackets. Overrides the commandline setting.)}}

====+Hostile Triangle:====
Adds a gauge that points to the nearest attacker, if it is off-screen and is not currently targeted.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Target Triangle:====
Adds a gauge that points to the targeted craft, if it is currently off-screen.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Missile Triangles:====
Adds a gauge that is used during attempting to lock onto a target when using an aspect seeking missile.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Lead Indicator:====
Adds a gauge that leads (is in front) of the target. Aim your crosshairs at this indicator to increase probability of hitting the target.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
::Frame #0: Secondaries lead indicator (Dumbfire)
::Frame #1: Secondaries lead indicator (Homing)
::Frame #2: Primaries lead indicator
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)

====+Orientation Tee:====
Adds a gauge that indicates the targeted craft's orientation in relation to the player's craft.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)

====+Lead Sight:====
Adds a gauge that lags (is behind) the target. Indicates where your shots will end up relative to the target's position. To score a hit, this gauge should be over the target. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
::Frame #0 is used for secondaries
::* If only one frame is found in the file, then it is used for primaries instead
::Frame #1 is used for primaries

====+Kills:====
Adds a gauge that keeps track of how many kills the player has scored during a mission.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Weapon Linking:====
Adds a gauge that indicates the selected weapons and their firing rates.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Filename:|Single Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Filename:|Double Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Filename:|Single Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Filename:|Double Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Filename:|Triple Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Offsets:|Single Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Offsets:|Double Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Offsets:|Single Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Offsets:|Double Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Offsets:|Triple Secondary Offsets:]] (Optional)

====+Fixed Messages:====

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
{{table375|
:[[Hud_gauges.tbl#Center Text On Gauge X-Position:|Center Text On Gauge X-Position:]] (Optional)
}}

====+Flight Path Marker:====
{{table3615|
Adds a gauge that indicates the direction where your ship is traveling. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)}}

====+Warhead Count:====
{{table3615|
Displays the name of the current secondary weapon. Tallies the ammo left. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs an animation with a single frame)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Count Offsets:|Count Offsets:]] (Optional)
:[[Hud_gauges.tbl#Icon Width:|Icon Width:]] (Optional)
:[[Hud_gauges.tbl#Icon Height:|Icon Height:]] (Optional)
:[[Hud_gauges.tbl#Max Icons:|Max Icons:]] (Optional)
:[[Hud_gauges.tbl#Max Columns:|Max Columns:]] (Optional)
:[[Hud_gauges.tbl#Name Alignment:|Name Alignment:]] (Optional)
}}

====+Hardpoints:====
{{table3615|
Draws a silhouette of the player's ship and mounted weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#Line Width:|Line Width:]] (Optional)
:[[Hud_gauges.tbl#View Direction:|View Direction:]] (Optional)
:[[Hud_gauges.tbl#Show Primary Weapons:|Show Primary Weapons:]] (Optional)
:[[Hud_gauges.tbl#Show Secondary Weapons:|Show Secondary Weapons:]] (Optional)
}}

====+Primary Weapons:====
{{table3615|
Like the Weapons gauge but simpler. Only displays primary weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text:]] (Optional)
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#First Background Height:|First Background Height:]] (Optional)
:[[Hud_gauges.tbl#First Background X-offset:|First Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Entry Background Height:|Entry Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Background X-offset:|Entry Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Last Background X-offset:|Last Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Y-offset:|Last Background Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Y-offset:|List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Ammo X-offset:|Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Link X-offset:|Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset:]] (Optional)
}}

====+Secondary Weapons:====
{{table3615|
Like the Weapons gauge but simpler. Only displays secondary weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text:]] (Optional)
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional)
:[[Hud_gauges.tbl#First Background Height:|First Background Height:]] (Optional)
:[[Hud_gauges.tbl#First Background X-offset:|First Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Height:|Entry Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Background X-offset:|Entry Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Last Background X-offset:|Last Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Y-offset:|Last Background Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Y-offset:|List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Ammo X-offset:|Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Link X-offset:|Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Unlink X-offset:|Unlink X-offset:]] (Optional)
:[[Hud_gauges.tbl#Reload X-offset:|Reload X-offset:]] (Optional)
}}

===$End Gauges===
The Gauges section must end with $End Gauges. No Exceptions.

==#End==
The very last entry in the Hud_gauges.tbl must be #End. No Exceptions.

----
----

==Gauge Configuration Options==
Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.

====Position:====
Defines the screen coordinates for the upper left corner of this gauge.

*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]] (and many others)

====Scale Gauge:====

{{table371|
Define if a gauge size will scale or not.

If false then gauge bitmaps will always show at their original size which may result in gauges being very small at high resolutions.

If true then gauge bitmaps will scale in proportion to the current resolution vs the base HUD resolution in use. This may result in gauges becoming blurry at non-base resolutions.

Defaults to yes/true.

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Boolean''' scale_this_gauge

Used by: most gauges
}}

====Force Scaling Above:====

{{Table373|
Optional. If scaling is disabled for this gauge, then it will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.

Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.

To disable this feature, use '''(-1, -1)'''.

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: ('''Integer''' width, '''Integer''' height)

Used by: most gauges
}}

====Origin:====

{{table371|
Define gauge position as a ratio of the screen size (base or current, it doesn't matter).

Requires [[Hud_gauges.tbl#Offset:|Offset:]]

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Float''' horizontal ratio 0.0 - 1.0, '''Float''' vertical ratio 0.0 - 1.0

Used by: most gauges
}}

====Offset:====

{{table371|
Define gauge offset from [[Hud_gauges.tbl#Origin:|Origin:]] in base resolution pixels

Requires [[Hud_gauges.tbl#Origin:|Origin:]]

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Integer''' horizontal pixel offset from Origin:, '''Integer''' vertical pixel offset from Origin:

Used by: most gauges
}}

====Cockpit Target:====
The cockpit display that this gauge will be rendered to. Refers to the +Display Name: defined in [[ships.tbl#$Cockpit Display:|$Cockpit Display:]].

*Syntax: '''String''' String defined in +Display Name: in [[ships.tbl#$Cockpit Display:|$Cockpit Display:]]

=====Canvas Size:=====
The off-screen canvas this gauge will be rendered to before being interpolated into the actual cockpit display. The smaller this number is, the larger the gauge will appear on the cockpit display.

*Syntax: '''Integer''' width, '''Integer''' height

=====Display Offset:=====
The position of the canvas on the cockpit display texture

*Syntax: '''Integer''' width, '''Integer''' height

=====Display Size:=====
The interpolated size on the cockpit display texture that the canvas will be rendered to.

*Syntax: '''Integer''' width, '''Integer''' height

====Color:====
Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Color]] HUD option and [[Hud_gauges#$Color: 2|$Color]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Font:====
Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Name:====
Defines the name of this custom gauge.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Text:====
Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====X Offset:====
Optional. Defines the horizontal pixel offset (from the gauge's origin as defined by [[Hud_gauges.tbl#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Y Offset:====
Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges.tbl#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Gauge Type:====
Defines the type of gauge this is.

*Syntax: '''String'''
*Valid Values: Any one of the possible [[gauge types]].

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Slew:====
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. If set to "true", the gauge will not follow the player's head movements when using TrackIR/padlock. i.e. should be used for gauges like the gunsight/leadsight.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Max Lines:====
Optional. Specifies the maximum number of message lines that are displayed.

*Syntax: '''Integer'''
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Max Width:====
Optional. Determines how long each message line may be.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Line Height:====
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 9

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Total Lifetime:====
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 14000 (14 seconds)

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Scroll Time:====
Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:|Step Size:]] )

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 30

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Step Size:====
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:|Line Height:]])

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Active by default:====
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Filename:====
Designates the [[Multimedia_Files#ANI|.ANI]] or [[Multimedia_Files#EFF|.EFF]] used for this gauge's background graphic.
{{Note| All HUD .ANI's must have the same color palette as the retail .ANI's in order to render properly. (.EFF's do not have this restriction)}}

*Syntax: '''Filename'''
**No filename extension is needed.

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Top Background Filename:====
Optional. Designates which file to use for the top background. (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Bottom Background Filename:====
Optional. Designates which file to use for the Bottom background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Left Background Filename:====
Optional. Designates which file to use for the Left side of gauge.

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====First Background Filename:====
Optional. Alias for [[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]]

====Right Background Filename:====
Optional. Designates which file to use for the Right side of the gauge.

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Last Background Filename:====
Optional. Alias for [[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]]

====Entry Background Filename:====
Optional. Designates which file to use for the (Wing) Entry section of the gauge (aka the middle sections).

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]], [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Primary List Top Background Filename:====
Optional. Designates which file to use for the Primary List Top Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Middle Background Filename:====
Optional. Designates which file to use for the Primary List Middle Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Bottom Background Filename:====
Optional. Designates which file to use for the Primary List Bottom Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Top Background Filename:====
Optional. Designates which file to use for the Secondary List Top Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Entry Background Filename:====
Optional. Designates which file to use for the Secondary List Entry Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Bottom Background Filename:====
Optional. Designates which file to use for the Secondary List Bottom Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Alt Ballistic Filename:====
Optional. Designates an alternate file to be used for ballistic weapons.

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#Primary List Top Background Filename:|Primary List Top Background Filename]], [[Hud_gauges.tbl#Primary List Middle Background Filename:|Primary List Middle Background Filename]], [[Hud_gauges.tbl#Primary List Bottom Background Filename:|Primary List Bottom Background Filename]], [[Hud_gauges.tbl#Secondary List Top Background Filename:|Secondary List Top Background Filename]], [[Hud_gauges.tbl#Secondary List Entry Background Filename:|Secondary List Entry Background Filename]], [[Hud_gauges.tbl#Secondary List Bottom Background Filename:|Secondary List Bottom Background Filename]]

====Dot Filename:====
Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Header Offsets:====
Optional. Designates the offset from the gauge's upper left corner for headers of various gauges

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels
*Valid Sub-entries:
:Weapons:
::[[Hud_gauges.tbl#Alt Ballistic Offsets:|Alt Ballistic Offsets:]]

Used by: [[Hud_gauges.tbl#+Support:|+Support:]], [[Hud_gauges.tbl#+Damage|+Damage:]], [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Fixed Header Position:====
Optional. If set, the header text will not change position when the gauge changes size.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Text Y-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Text Offsets:====
Optional. Defines the screen position offsets for the text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Value Offsets:====
Optional. Defines the screen position offsets for the value label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Dock Status X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Dock Time X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Hull Integrity Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Hull Integrity Value X-offset:====
Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)

*Syntax: '''Integer''' horizontal offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Top Background Height:====
Optional. Designates the height of the Top background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Left Background Width:====
Optional. Defines the width of the Left Background.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Entry Width:====
Optional. Defines the width of the Entry Background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Subsystem Entry Height:====
Optional. Designates the height of the Subsystem entry (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem List Start Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem Entry Value X-offset:====
Optional. Designates the horizontal offset from the Subsystem List's position (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Single Wing Offsets:====
Optional. Designates the offset from the gauge's upper left corner for a single wing (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Multiple Wing Start Offsets:====
Optional. Designates the offset from the gauge's upper left corner for multiple wings (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Wing Name Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Dot Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the All wingman status icons.
*Syntax:
:'''Integer''' x, '''Integer''' y ;; Wingman 1
:'''Integer''' x, '''Integer''' y ;; Wingman 2
:'''Integer''' x, '''Integer''' y ;; Wingman 3
:'''Integer''' x, '''Integer''' y ;; Wingman 4
:'''Integer''' x, '''Integer''' y ;; Wingman 5
:'''Integer''' x, '''Integer''' y ;; Wingman 6
*Units: Pixels

{{Warning|
All 6 wingman positions must be defined}}

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Expansion Mode:====
Optional. Denotes which direction (in relation to the player's wing) that the other wings should be appended to the gauge. If not present the gauge will expand to the left.

*Syntax: '''String'''
*Valid Values:
**Right
**Down

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Use Full Wing Names:====
{{Table214|
Optional. If enabled the wingmen gauge draws the full wing name and does not alter the capitalization. Default behavior is to draw the first three letters of the wing in all lower-case.

*Syntax: '''Boolean'''
*Default Value: '''False'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]
}}

====Use Expanded Colors:====
{{Table214|
Optional. If enabled the wingmen gauge status dots use red, yellow, or green color to designate wingmen health (green full to greater thon two-thirds, yellow two-thirds to greater than one-third, and red less than or equal to one-third). Default is to use red for less than half health and gauge color otherwise.

*Syntax: '''Boolean'''
*Default Value: '''False'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]
}}

====Auto Offsets:====
Optional. Defines the screen coordinates for the "Auto" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Auto Speed:|+Auto Speed:]], [[Hud_gauges.tbl#+Auto Target:|+Auto Target:]]

====Speed Offsets:====
Optional. Defines the screen coordinates for the "Speed" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Auto Speed:|+Auto Speed:]]

====Target Offsets:====
Optional. Defines the screen coordinates for the "Target" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Auto Target:|+Auto Target:]]

====Animation Offsets:====
Optional. Defines the offsets for the animation graphics.

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====Animation Background Size:====
Deprecated. Originally, this set the size of the black box that's drawn behind the animation. Since Git revision 556e9a4 (2015-11-01), it has the same effect as [[Hud_gauges.tbl#Animation Size:|Animation Size:]].

*Syntax: '''Integer''' horizontal size, '''Integer''' vertical size
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====Animation Size:====
{{table373|
Optional. Defines the size of the animation. All animations will be scaled to match this size.

*Syntax: '''Integer''' horizontal size, '''Integer''' vertical size
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]
}}

====List Start Offsets:====
Optional. Defines the screen coordinate offsets for the start of the Directives list.

*Syntax: '''Integer''' x, '''Integer''' y
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Entry Height:====
Optional. Defines the height of each Directive

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Alt Ballistic Offsets:====
Opetional. Defines the screen coordinate offsets for headers of ballistic weapons

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Header Offset:|+Header Offset:]]

====Top Primary Background X-offset:====
Optional. Defines the screen coordinate offset for the Top Primary Background

*Syntax: '''Integer'''
*Units: Pixels
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Text X-offset:====
(Optional) Defines the screen coordinate X-offset for weapon labels

*Syntax: '''Integer'''
*Units: Pixels
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Alt Ballistic X-offset:====
Optional. Defines the screen coordinate X-offset for ballistic weapons

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#Top Primary Background X-offset:|Top Primary Background X-offset:]], [[Hud_gauges.tbl#Text X-offset:|Text X-offset:]]

====Top Primary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Top Secondary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Link X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Linked X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Reload X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====3 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 3 digit range (i.e. >= 100%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====2 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 2 digit range (i.e. 100% > hull damage% >= 10%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====1 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 1 digit range (i.e. 10% > hull damage% >= 0%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====Objective Text Y-offset:====
Designates the screen position offset for the Objective label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Objective Value Y-offset====
Designates the screen position offset for the Objective value

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Text Y-offset:====
Designates the screen position offset for the Subspace label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Value Y-offset====
Designates the screen position offset for the Subspace value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Text Y-offset====
Designates the screen position offset for the Red Alert label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Value Y-offset====
Designates the screen position offset for the Red Alert value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Command X-offset:====
*Syntax: '''Integer''' x offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Up Offsets:====
*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Down Offsets:====
*Syntax: '''Integer''' x offset, ''' Integer y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Entry Height:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Entry Stagger Width:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Text:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====List Start Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Hull X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Name X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Status X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Ship Name Max Width:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Right-Align Ship Names:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Foreground Clip Height:====

* Sets the height, in pixels, of the gauge.
** For the [[Hud_gauges.tbl#+Throttle|Throttle]], sets the height of the gauge that represents 0% to 100% throttle. The total height of the gauge is the sum of this value and the [[Hud_gauges.tbl#Afterburner Clip Height:|Afterburner Clip Height]] value.
* Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]], [[Hud_gauges.tbl#+ETS Weapons:|+ETS Weapons]], [[Hud_gauges.tbl#+ETS Engines:|+ETS Engines]], [[Hud_gauges.tbl#+ETS Shields:|+ETS Shields]], [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor]], [[Hud_gauges.tbl#+Afterburner Energy|+Afterburner Energy]], [[Hud_gauges.tbl#+Weapon Energy|+Weapon Energy]], [[Hud_gauges.tbl#+Throttle:|+Throttle]]

====Letter Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Top Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Bottom Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Gauge Offset:====
*Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Monitor Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Status Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Name Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Class Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Speed Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Hull Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Contents Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Start Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Bracket Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Dock Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Dock Max Width:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Order Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Order Max Width:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Time Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Radar Center Offsets:====
Defines the radar's plot origin as an offset, in pixels, from this gauge's [[Hud_gauges.tbl#Position|Position]] coordinates
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Radar Size:====
Size, in pixels, of the radar plot area.

Syntax: '''Integer''' horizontal size, '''Integer''' vertical size

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Infinity Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the infinity radar range symbol.

====Long Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the long range radar text (i.e. 10k).

====Short Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the short range radar text (i.e. 2k).

====Size:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XY Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XZ YZ Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Sweep Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Default Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Unknown Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Loop Volume:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Minimum Beep Delay:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Firepoint display:====
Displays the positions of the gun firepoints on your ship
*Syntax: '''Boolean''', YES or NO

NOTE: The position of the firepoints is calculated from the Eye Point position in the POF. You may encounter weird results if you have no Eye Point defined, but no debug warnings will be raised.

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint size:====
Diameter of the gunpoint circles. '''Must be 4 or greater''' in order to work properly.
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint X coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint Y coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Foreground Clip Bottom Y-offset:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Foreground Clip Width:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Afterburner Clip Height:====
* Sets the area of the throttle gauge that represents the Afterburner segment (which is on top of the 0% to 100% area). The total height of the gauge is determined by the sum of this value and [[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]]

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Show Background:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Max Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Min Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Center Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Radius:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Arc Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Needs to be an [[Multimedia_Files#ANI|ani]] with a least 2 frames (but only the 2nd frame is used ?!?!? for threat & weapon linking so far)

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Needs to be an [[Multimedia_Files#ANI|ani]] with a least 2 frames. The 1st frame is "no warning", the rest of the frames are cycled through when a warning is active.

Internally FSO also refers to this as the "laser threat warning".

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Needs to be an [[Multimedia_Files#ANI|ani]] with a least 2 frames. The 1st frame is "no warning", the rest of the frames are cycled through when a warning is active. Frames cycle twice as fast when a lock has been acquired, compared to when a lock is being acquired.

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Lock Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Loop Locked Animation:====

Controls whether the animation should loop after locking on, like in FS1.

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Blink Locked Animation:====

Controls whether the animation should blink after locking on, like in FS2.

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Radius:====
Defines the distance from the center of the screen to the base of the Hostile Triangle gauge.

*Syntax: '''Integer'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Base:====
Defines the width of the Hostile Triangle's base.

*Syntax: '''Float'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Height:====
Defines the height of the Hostile Triangle.

*Syntax: '''Float'''
Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lead Indicator:|+Lead Indicator:]]

====Single Primary Filename:====
Designates the file to use for primary linking for ships with a single primary bank.

Needs to be an [[Multimedia_Files#ANI|ani]] with 2 frames; 1st is bank 1 not selected (not that this should ever be able to happen), 2nd is bank 1 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Filename:====

Designates the file to use for primary linking for ships with two primary banks.

Needs to be an [[Multimedia_Files#ANI|ani]] with 4 frames:
* Frame 0 is no banks selected
* Frame 1 is 1st bank selected
* Frame 2 is 2nd bank selected
* Frame 3 is both banks selected/linked

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Filename:====

Designates the file to use for selected secondary bank for ships with a single secondary bank.

Needs to be an [[Multimedia_Files#ANI|ani]] with 2 frames; 1st is bank 1 not selected, 2nd is bank 1 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Filename:====

Designates the file to use for selected secondary bank for ships with two secondary banks.

Needs to be an [[Multimedia_Files#ANI|ani]] with 3 frames; 1st is no banks selected, 2nd is bank 1 selected, 3rd is bank 2 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Filename:====

Designates the file to use for selected secondary bank for ships with two secondary banks.

Needs to be an [[Multimedia_Files#ANI|ani]] with 4 frames; 1st is no banks selected, 2nd is bank 1 selected, 3rd is bank 2 selected, 4th is bank 3 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Hidden By Comms Menu:====
{{Table3615|
Defines whether the messages gauge may be drawn at the same time as the wingman comms menu.
*Syntax: '''Boolean'''
*Default Value: '''false''' (messages are not visible while the comms menu is open)
Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]}}

====Bottom Background Offset:====
{{Table3615|
Defines the vertical pixel offset added to the position of the bottom background frame.
*Syntax: '''Integer''' vertical offset
*Units: Pixels
Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]}}

====Center Text On Gauge X-Position:====
{{Table375|
Sets whether to position the center of the text to the gauge's X-position.
*Syntax '''Boolean'''
*Default Value: '''false''' if the gauge is explicitly given a position, '''true''' otherwise
Used by: [[Hud_gauges.tbl#+Fixed Messages:|+Fixed Messages:]]}}

====Ngon Sides:====
{{Table190|
Defines the number of sides a regular polygon (N-gon) radar has. If defined, the standard radar's edge is drawn as an N-gon, instead of the standard ellipsoid. Blips that are projected outside of the N-gon are snapped to the edge: the blip's angle stays the same but the blip's radius to the center of the plot area is reduced.
*Syntax '''Integer'''
*Default Value: '''0''' A value of 0 means to use the standard ellipsoid radar
*Minimum value: '''3''' (which is a triangle)
Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]}}

====Ngon Offset:====
{{Table190|
Defines the angular offset to apply to the N-gon perimeter. The first vertex is at the 3 o'clock position, positive offsets spin this vertex counter-clockwise, negative offsets spin this clockwise.
*Syntax '''Float''' (radians)
*Default Value: '''0'''
Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]}}

[[Category:Tables]]

Hud gauges.tbl

2022-11-29T16:40:52Z

EatThePath: /* Expansion Mode: */

{{SCP table}}
{{TableVersionGit|2016-09-14|f9bc01c}}
{{Tables}}
The '''hud_gauges.tbl''' is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).

HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.

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

==HUD Configurations==
The following entries are used on the HUD system, but have not been grouped with any particular gauge.

===$Load Retail Configuration:===
Optional. If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.

If no, any missing (default) gauge will prompt an error.

*Syntax: '''Boolean'''

===$Color:===
Optional. Sets the default HUD color for all gauges.

*Syntax: ('''Integer''' Red, '''Integer''' Green, '''Integer''' Blue)
*Valid Values: all values from 0 to 255

===$Font:===
Optional. Sets the font type to use for the HUD. This can either be a string or a number. A string references a font with a specific name while a number references a font with a specific index in the fonts table. The number option is deprecated and is only there for backwards-compatibility. Use the name if possible.

*Syntax: '''String''' or '''Integer''' font index number
*Valid Values: Any name or font index as defined in [[Fonts.tbl]]

===$Chase View Only:===
{{Table381|
Optional. Sets gauges to be displayed only in Chase View.

*Syntax: '''Boolean'''
*Default Value: '''False'''
}}

===$Max Directives:===
Optional. Sets the default maximum number of directives displayed simultaneously.

*Syntax: '''Integer''' maximum number of directives
*Valid Values: Any positive number
*Default Value: '''5'''

===$Max Escort Ships:===
Optional. Sets the default maximum number of escort ships to be shown in the escort list.

*Syntax: '''Integer'''
*Valid Values: Any positive number
{{Warning|
Entries more than 16 will cause the list to overflow into the weapons list for resolutions lower than 1024x768.}}

===$Length Unit Multiplier:===
Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.

*Syntax: '''Float'''
*Valid Values: Any positive number

===$Speed Unit Multiplier:===
Optional. Analogous to [[Hud_gauges.tbl#$Length Unit Multiplier:|$Length Unit Multiplier]], this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.

*Syntax: '''Float'''
*Valid Values: Any positive number
*Default Values:
:'''The value used in $Length Unit Multiplier''', or
:'''1''', if $Length Unit Multiplier is undefined

===$Wireframe Targetbox:===
Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).

*Syntax: '''Integer''' Draw method ID
*Valid Values:
::'''0''' - Standard with full, bright lighting
::'''1''' - Wireframe
::'''2''' - Standard with proper lighting (i.e. lit the same as the actual target)
{{Table3615|
::'''3''' - Untextured with full bright lighting (i.e. drawn with a single flat color)}}

{{Table224|
===$Wireframe Color Override:===
Optional. Allows using a static color for the target monitor wireframe instead of one based on the target's IFF.
*Syntax: ( Color ), three integers, values from 0 to 255; red, green and blue respectively
*Example: ( 0, 255, 0 )}}

===$Targetbox Shader Effect:===
{{Table3615|
Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in [[Post_processing.tbl##Ship_Effects|#Ship_Effects]], but a table entry for the effect is not needed.

*Syntax: '''Integer'''
*Valid Values: Any positive number
}}

===$Lock Wireframe Mode:===
Optional. If set, prevents targetbox draw method from being changed during the gaming session.
*Syntax: '''Boolean'''

===$Scale Gauges:===
{{Table371|
Optional. If set, all gauges will use this value as the default for scaling individual gauge sizes (i.e. doesn't affect gauges that use Position:, and doesn't affect the values of Offset:. In addition, if "$Load Retail Configuration:" is true then all unspecified retail gauges will use this value.

If not set, defaults to yes.

*Syntax: '''Boolean'''
}}

===$Force Scaling Above:===
{{Table373|
Optional. If gauge scaling is disabled, then gauges will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.

Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.

To disable this feature, use '''(-1, -1)'''.

*Syntax: ('''Integer''' width, '''Integer''' height)
}}

===$Reticle Style:===
Optional. Defines which aiming reticle to use.
*Syntax: '''String'''
*Valid Values:
:'''FS1''' - uses '''''reticle1_fs1.ani'''''
:'''FS2''' - uses '''''reticle1.ani'''''

==#Gauge Config==
The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.

===$Ship:===
Deprecated and superceded by $Ships in FSO revision 9208. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*Syntax: '''String''', ship class name

===$Ships:===
Optional. Can be used to define a list of ships the hud definition that follows will be applied to. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*`Syntax: '''( "Class name 1" "Class name 2" )''', ship class names formatted like a flag list.

====$Load Retail Configuration:====
Optional. Overrides the [[Hud_gauges.tbl#$Load Retail Configuration: 1|$Load Retail Configuration]] global option for this ship class.

*Syntax: '''Boolean'''

====$Color:====
Optional. Overrides the [[Hud_gauges.tbl#$Color: 1|$Color]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color]]

====$Font:====
Optional. Overrides the [[Hud_gauges.tbl#$Font: 1|$Font]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font]]

====$Chase View Only:====
{{Table381|
Optional. Overrides the [[Hud_gauges.tbl#$Chase View Only: 1|$Chase View Only]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Chase View Only: 1|$Chase View Only]]
}}

===$Base:===
Required. Defines the base resolution for this HUD configuration, upon which other gauge options (such as [[Hud_gauges.tbl#Position:|Position:]] / [[Hud_gauges.tbl#Origin:|Origin:]] / [[Hud_gauges.tbl#Offset:|Offset:]]) will use as its coordinate system.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Scale Gauges:===
{{Table371|
Optional. If set, will configure gauges Scaling behaviour for gauges in this #Gauge Config section. i.e. overriding the default, or the value specified at the top of the file. Individual gauges can override this setting.

*Syntax: '''Boolean'''
}}

===$Force Scaling Above:===
{{Table373|
Optional. If gauge scaling is disabled, then gauges will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.

Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.

To disable this feature, use '''(-1, -1)'''.

*Syntax: ('''Integer''' width, '''Integer''' height)
}}

===$Required Aspect:===
Optional. If set, this configuration will only be loaded for the specified aspect ratios.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: '''String'''
*Valid Values:
:"Full Screen" (4:3, aspect ratio < 1.5)
:"Wide Screen" (16:9, 16:10, or similar, aspect ratio >= 1.5)

===$Min:===
Optional. Minimum resolution for this config. Any resolution lower than specified will not use this configuration.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Max:===
Optional. Maximum resolution for this config. Any resolution higher than specified will not use this configuration.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Gauges:===
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.

Since many gauges have the same configuration options, each gauge entry has a list of valid sub-entries. Unless stated otherwise, these options must be defined in the same order as they are shown, starting from the top and ending at the bottom.

====+Custom:====
Adds a custom gauge type.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Name:|Name:]]
:[[Hud_gauges.tbl#Text:|Text:]]
:[[Hud_gauges.tbl#X Offset:|X Offset:]] (Optional)
:[[Hud_gauges.tbl#Y Offset:|Y Offset:]] (Optional)
:[[Hud_gauges.tbl#Gauge Type:|Gauge Type:]]
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Active by default:|Active by default:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

{{table381|
====+Scripted Gauge:====
Adds a scripted gauge type.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Name:|Name:]]
}}

====+Messages:====
Adds a gauge that display mission messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Max Lines:|Max Lines:]] (Optional)
:[[Hud_gauges.tbl#Max Width:|Max Width:]] (Optional)
:[[Hud_gauges.tbl#Line Height:|Line Height]] (Optional)
:[[Hud_gauges.tbl#Total Lifetime:|Total Lifetime:]] (Optional)
:[[Hud_gauges.tbl#Scroll Time:|Scroll Time]] (Optional)
:[[Hud_gauges.tbl#Step Size:|Step Size:]] (Optional)
:[[Hud_gauges.tbl#Hidden By Comms Menu:|Hidden By Comms Menu:]] (Optional)

====+Training Messages:====
Adds a text box, like the ones seen in the FS1 and FS2 training missions.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Support:====
Adds a text box that shows the Support ship's status and ETA

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Text Y-offset:|Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Status X-offset:|Dock Status X-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Time X-offset:|Dock Time X-offset:]] (Optional)
{{table224|
:[[Hud_gauges.tbl#Enable Rearm Timer:|Enable Rearm Timer:]] (Optional boolean. Enables the countdown timer for rearm and repair. Overrides the commandline setting.)}}

====+Damage:====
Adds a gauge that shows how much damage a target (or the player?) has.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Offsets:|Hull Integrity Offsets]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Value X-offset:|Hull Integrity Value X-offset]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Height:|Subsystem Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem List Start Offsets:|Subsystem List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Value X-offset:|Subsystem Entry Value X-offset:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)

====+Wingman Status:====
Adds a gauge that monitors the status of your wing and squadron.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]] (Optional) (needs an animation with one frame)
{{table3615|
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional) (needs an animation with one frame)}}
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional) (needs an animation with one frame)
:[[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]] (Optional) (needs an animation with one frame)
{{table3615|
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional) (needs an animation with one frame)}}
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional) (needs an animation with two frames, 1st is for alive wingmen, 2nd is for dead or missing wingmen)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
{{table373|
[[Hud_gauges.tbl#Fixed Header Position:|Fixed Header Position:]] (Optional)}}
:[[Hud_gauges.tbl#Left Background Width:|Left Background Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#First Background Size:|First Background Size:]] (Optional)}}
:[[Hud_gauges.tbl#Entry Width:|Entry Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Entry Size:|Entry Size:]] (Optional)
:[[Hud_gauges.tbl#Right Background Offset:|Right Background Offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Offset:|Last Background Offset:]] (Optional)}}
:[[Hud_gauges.tbl#Single Wing Offsets:|Single Wing Offsets:]] (Optional)
:[[Hud_gauges.tbl#Multiple Wing Start Offsets:|Multiple Wing Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Wing Name Offsets:|Wing Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dot Offsets:|Dot Offsets:]] (Optional)
:[[Hud_gauges.tbl#Expansion Mode:|Expansion Mode:]] (Optional)
{{Table214|
:[[Hud_gauges.tbl#Use Full Wing Names:|Use Full Wing Names:]] (Optional)
:[[Hud_gauges.tbl#Use Expanded Colors:|Use Expanded Colors:]] (Optional)
}}

====+Auto Speed:====
Adds the Auto-Speed mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (needs animation with 4 frames, 3rd is without auto-match-speed enabled, 4th is with... and frames 0 & 1 are not used, done this way because retail fs2 uses the same animation file for the auto speed & auto targeting gauges)
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#On Text Color:|On Text Color:]] (Optional)
:[[Hud_gauges.tbl#On Text Color:|Off Text Color:]] (Optional)}}

====+Auto Target:====
Adds the Auto-target mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (needs animation with 2 frames, 1st is without auto-targeting enabled, 2nd is with)
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Offsets:|Target Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#On Text Color:|On Text Color:]] (Optional)
:[[Hud_gauges.tbl#On Text Color:|Off Text Color:]] (Optional)}}

====+Countermeasures:====
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (needs an animation with a single frame)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Talking Head:====
Adds a video window to display pilot message videos (a.k.a talking heads).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Offsets:|Animation Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Background Size:|Animation Background Size:]] (Deprecated)
{{table373|
:[[Hud_gauges.tbl#Animation Size:|Animation Size:]] (Optional)
}}

====+Directives:====
Adds a gauge that displays all currently active directives (includes current , completed, and failed)

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional) (needs animation with one frame)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional) (needs animation with one frame)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional) (needs animation with one frame)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)
:[[Hud_gauges.tbl#Max Line Width:|Max Line Width:]] (Optional)
}}

====+Weapons:====
Adds a weapon status and ammunition gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Primary List Top Background Filename:|Primary List Top Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Primary List Middle Background Filename:|Primary List Middle Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Primary List Bottom Background Filename:|Primary List Bottom Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Secondary List Top Background Filename:|Secondary List Top Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Secondary List Entry Background Filename:|Secondary List Entry Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Secondary List Bottom Background Filename:|Secondary List Bottom Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
::[[Hud_gauges.tbl#Alt Ballistic Offsets:|Alt Ballistic Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Primary Background X-offset:|Top Primary BackgroundX-offset:]] (Optional)
::[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]] (Optional)
:[[Hud_gauges.tbl#Text X-offset:|Text X-offset:]] (Optional)
::[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]] (Optional)
:[[Hud_gauges.tbl#Top Primary Frame Height:|Top Primary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Top Secondary Frame Height:|Top Secondary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Primary List Start Y-offset:|Primary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Start Y-offset:|Secondary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Ammo X-offset:|Primary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Link X-offset:|Primary Weapon Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Name X-offset:|Primary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Ammo X-offset:|Secondary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Linked X-offset:|Secondary Weapon Linked X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Name X-offset:|Secondary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Reload X-offset:|Secondary Weapon Reload X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Entry Height:|Primary Weapon Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Entry Height:|Secondary Weapon Entry Height:]] (Optional)

====+Objective notify:====
Adds a Objective notifier gauge. This gauge alerts the player when receiving a new objective, or when an objective has been completed or failed. Additionally, this gauge alerts the player when entering subspace, and when a Red Alert mission orders are being received (prior to a forced subspace jump).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Objective Text Y-offset:|Objective Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Objective Value Y-offset:|Objective Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Text Y-offset:|Subspace Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Value Y-offset:|Subspace Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Text Y-offset:|Red Alert Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Value Y-offset:|Red Alert Value Y-offset:]] (Optional)

====+Squad Message====
Adds the squad message gauge. In FS1 and FS2, this gauge is used to send commands to your squad. (?)

*Valid sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset|Bottom Background Offset]] (Optional)}}
:[[Hud_gauges.tbl#Command X-offset:|Command X-offset:]] (Optional)
:[[Hud_gauges.tbl#Page Up Offsets:|Page Up Offsets:]] (Optional)
:[[Hud_gauges.tbl#Page Down Offsets:|Page Down Offsets:]] (Optional)

====+Lag:====
Adds a Lag gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

====+Mini Target Shields:====
Adds a mini Target shields gauge. In FS1 and FS2, the Mini Target Shield gauge is the one right below the center reticle, and shows the hull damage in %

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (animation needs 8 frames; 0->3 are the top, right, bottom & left shield quads; 4->7 are the same except brighter for when the quad is flashing from being hit)
:[[Hud_gauges.tbl#3 Digit Hull Offsets:|3 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#2 Digit Hull Offsets:|2 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#1 Digit Hull Offsets:|1 Digit Hull Offsets:]] (Optional)

====+Player Shields:====
Adds a gauge that shows the shield and hull status icon of the player's craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Target Shields:====
Adds a gauge that shows the shield and hull status icon of the targeted craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Escort View:====
Adds an escort monitor/view gauge. This gauge monitors the status of all ships assigned to the player to escort.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height]] (Optional)
:[[Hud_gauges.tbl#Entry Stagger Width:|Entry Stagger Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)}}
:[[Hud_gauges.tbl#Header Text:|Header Text]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull X-offset:|Hull X-offset]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset]] (Optional)
:[[Hud_gauges.tbl#Status X-offset:|Status X-offset]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Ship Name Max Width:|Ship Name Max Width:]] (Optional)}}
{{table373|
:[[Hud_gauges.tbl#Right-Align Ship Names:|Right-Align Ship Names:]] (Optional)}}

====+Mission Time:====
Adds a gauge that displays the current mission time.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+ETS Retail:====
{{Table3613|
Draws the three other ETS gauges as a single gauge. Will automatically rearrange itself (like retail) if shields or other systems are missing.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
{{Table3613|
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)
:[[Hud_gauges.tbl#Gauge Offset:|Gauge Offset:]] (Optional)

}}

====+ETS Weapons:====
Adds a gauge that displays the energy transfer rate for the energy weapons.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Engines:====
Adds a gauge that displays the energy transfer rate for the afterburner/engines.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Shields:====
Adds a gauge that displays the energy transfer rate for the shields.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+Target Monitor:====
Adds a target monitor gauge that shows the targeted ship's relative orientation and hull strength, among other things.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Monitor Filename:|Monitor Filename:]] (Optional) (needs animation with 2 frames, 1st is the background for the target, 2nd is the border; rendered last)
{{table3615|
:[[Hud_gauges.tbl#Monitor Alpha Mask Filename:|Monitor Alpha Mask Filename:]] (Optional) (needs animation with a single frame)}}
:[[Hud_gauges.tbl#Integrity Bar Filename:|Integrity Bar Filename:]] (Optional) (needs animation with 2 frames, 1st is a zero/dark filled bar, 2nd is a max/bright filled bar)
:[[Hud_gauges.tbl#Viewport Offsets:|Viewport Offsets:]] (Optional)
:[[Hud_gauges.tbl#Viewport Size:|Viewport Size:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Offsets:|Integrity Bar Offsets:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Foreground Clip Height:|Integrity Bar Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Status Offsets:|Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Class Offsets:|Class Offsets:]] (Optional)
:[[Hud_gauges.tbl#Distance Offsets:|Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Offsets:|Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Contents Offsets:|Cargo Contents Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Start Offsets:|Cargo Scan Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Size:|Cargo Scan Size:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Subsystem Name Offsets:|Subsystem Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Integrity Offsets:|Subsystem Integrity Offsets:]] (Optional)
:[[Hud_gauges.tbl#Disabled Status Offsets:|Disabled Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Desaturate:|Desaturate:]] (Optional)
}}
{{table224|
:[[Hud_gauges.tbl#Wireframe:|Wireframe:]] (Optional. Valid values match $Wireframe Targetbox: and will override the global setting)
:[[Hud_gauges.tbl#Wireframe Color:|Wireframe Color:]] (Optional. Color. Takes three ints 0-255, R,G,B; will override the global setting)
}}

====+Extra Target Data:====
Adds a gauge that displays "extra" target data, such as its current orders and docking status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs an animation with 1 frame)
:[[Hud_gauges.tbl#Bracket Offsets:|Bracket Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dock Offsets:|Dock Offsets:]] (Optional)
{{table373|
:[[Hud_gauges.tbl#Dock Max Width:|Dock Max Width:]] (Optional)}}
:[[Hud_gauges.tbl#Order Offsets:|Order Offsets:]] (Optional)
{{table373|
:[[Hud_gauges.tbl#Order Max Width:|Order Max Width:]] (Optional)}}
:[[Hud_gauges.tbl#Time Offsets:|Time Offsets:]] (Optional)

====+Radar:====
Adds a standard radar gauge

*Valid Sub-entries:
{{table190|
:[[Hud_gauges.tbl#Ngon Sides:|Ngon Sides:]] (Optional)
:[[Hud_gauges.tbl#Ngon Sides:|Ngon Offset:]] (Optional)
}}
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs animation with 2 frames, only the 2nd frame is used)
{{table373|
:[[Hud_gauges.tbl#Radar Center Offsets:|Radar Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Radar Size:|Radar Size:]] (Optional)
}}
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar Orb:====
Adds a 3D orb radar gauge

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs animation with 2 frames, only the 2nd frame is used)
{{table373|
:[[Hud_gauges.tbl#Radar Center Offsets:|Radar Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Radar Size:|Radar Size:]] (Optional)
}}
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar BSG:====
Adds a BSG style radar (a.k.a DRADIS).

:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#XY Disc Filename:|XY Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#XZ YZ Disc Filename:|XZ YZ Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Sweep Disc Filename:|Sweep Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Default Contact Filename:|Default Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Unknown Contact Filename:|Unknown Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]]
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]]
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Loop Volume:|Loop Volume:]] (Optional)
:[[Hud_gauges.tbl#Minimum Beep Delay:|Minimum Beep Delay]] (Optional)

====+Afterburner Energy:====
Adds a gauge that shows the remaining afterburner energy. Note that it only supports a vertical fill.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs animation with 2 frames, the 1st is the bar lit for zero energy, the 2nd is the bar lit for max energy)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)

====+Weapon Energy:====
Adds a gauge that shows the remaining weapon energy. Note that it only supports a vertical fill.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs an animation with 4 frames, the 3rd is the bar lit for zero energy, the 2nd is the bar lit for max energy, frames 1 & 2 are not used)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Text Alignment:|Text Alignment:]] (Optional)
:[[Hud_gauges.tbl#Always Show Text:|Always Show Text:]] (Optional)
:[[Hud_gauges.tbl#Text Follows:|Text Follows:]] (Optional)
:[[Hud_gauges.tbl#Show Ballistic Ammo:|Show Ballistic Ammo:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Offsets:|Armed Guns List Offsets:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Alignment:|Armed Guns List Alignment:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Entry Height:|Armed Guns List Entry Height:]] (Optional)
}}

====+Text Warnings:====
Adds a gauge that warns the player (current warnings are EMP, Launch, Evaded, Collision, Blast & Engine Wash).

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Center Reticle:====
Adds a "custom" center reticle.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Firepoint display:|Firepoint display:]] (Optional)
:[[Hud_gauges.tbl#Firepoint size:|Firepoint size:]] (Optional)
:[[Hud_gauges.tbl#Firepoint X coordinate multiplier:|Firepoint X coordinate multiplier:]] (Optional)
:[[Hud_gauges.tbl#Firepoint Y coordinate multiplier:|Firepoint Y coordinate multiplier:]] (Optional)

====+Throttle:====
Adds a gauge that shows the current throttle position.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Bottom Y-offset:|Foreground Clip Bottom Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Width:|Foreground Clip Width:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Afterburner Clip Height:|Afterburner Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Show Background:|Show Background:]] (Optional)
:[[Hud_gauges.tbl#Max Speed Label Offsets:|Max Speed Label Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Show Max Speed Label:|Show Max Speed Label:]] (Optional)}}
:[[Hud_gauges.tbl#Min Speed Label Offsets:|Min Speed Label Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Show Min Speed Label:|Show Min Speed Label:]] (Optional)}}
:[[Hud_gauges.tbl#Orbit Center Offsets:|Orbit Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Orbit Radius:|Orbit Radius:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Current Speed Offsets:|Current Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Speed Offsets:|Target Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Show Percentage:|Show Percentage:]] (Optional)
:[[Hud_gauges.tbl#Glide Status Offsets:|Glide Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Match Speed Status Offsets:|Match Speed Status Offsets:]] (Optional)
}}

====+Threat Indicator:====
Adds a gauge that indicates when a lock-on has been achieved by an attacker, and if the player is being shot at.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Filename:|Dumbfire Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Offsets:|Dumbfire Offsets:]] (Optional)
:[[Hud_gauges.tbl#Lock Offsets:|Lock Offsets:]] (Optional)

====+Multiplayer Messages:====
Adds a gauge that displays the multiplayer messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Voice Status:====
Adds a gauge that displays the voice status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Ping:====
Adds a gauge that the ping time to the multiplayer server.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Supernova:====
Adds a gauge that warns the player of an impending supernova shock wave.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Lock Indicator:====
Adds a Lock Indicator gauge.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Locked Filename:|Locked Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Center Offsets:|Lock Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Locked Center Offsets:|Locked Center Offsets:]] (Optional)
{{table224|
:[[Hud_gauges.tbl#Loop Locked Animation:|Loop Locked Animation:]] (Optional)
:[[Hud_gauges.tbl#Blink Locked Animation:|Blink Locked Animation:]] (Optional)}}

====+Offscreen Indicator:====
Adds an Offscreen Indicator.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Target Brackets:====
Adds a Target Bracket gauge. This is drawn around current target(s) and talkers.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)
{{table224|
:[[Hud_gauges.tbl#Enable Target Info:|Enable Target Info:]] (Optional boolean. Adds the target name and class to the brackets. Overrides the commandline setting.)}}

====+Hostile Triangle:====
Adds a gauge that points to the nearest attacker, if it is off-screen and is not currently targeted.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Target Triangle:====
Adds a gauge that points to the targeted craft, if it is currently off-screen.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Missile Triangles:====
Adds a gauge that is used during attempting to lock onto a target when using an aspect seeking missile.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Lead Indicator:====
Adds a gauge that leads (is in front) of the target. Aim your crosshairs at this indicator to increase probability of hitting the target.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
::Frame #0: Secondaries lead indicator (Dumbfire)
::Frame #1: Secondaries lead indicator (Homing)
::Frame #2: Primaries lead indicator
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)

====+Orientation Tee:====
Adds a gauge that indicates the targeted craft's orientation in relation to the player's craft.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)

====+Lead Sight:====
Adds a gauge that lags (is behind) the target. Indicates where your shots will end up relative to the target's position. To score a hit, this gauge should be over the target. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
::Frame #0 is used for secondaries
::* If only one frame is found in the file, then it is used for primaries instead
::Frame #1 is used for primaries

====+Kills:====
Adds a gauge that keeps track of how many kills the player has scored during a mission.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Weapon Linking:====
Adds a gauge that indicates the selected weapons and their firing rates.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Filename:|Single Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Filename:|Double Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Filename:|Single Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Filename:|Double Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Filename:|Triple Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Offsets:|Single Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Offsets:|Double Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Offsets:|Single Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Offsets:|Double Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Offsets:|Triple Secondary Offsets:]] (Optional)

====+Fixed Messages:====

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
{{table375|
:[[Hud_gauges.tbl#Center Text On Gauge X-Position:|Center Text On Gauge X-Position:]] (Optional)
}}

====+Flight Path Marker:====
{{table3615|
Adds a gauge that indicates the direction where your ship is traveling. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)}}

====+Warhead Count:====
{{table3615|
Displays the name of the current secondary weapon. Tallies the ammo left. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs an animation with a single frame)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Count Offsets:|Count Offsets:]] (Optional)
:[[Hud_gauges.tbl#Icon Width:|Icon Width:]] (Optional)
:[[Hud_gauges.tbl#Icon Height:|Icon Height:]] (Optional)
:[[Hud_gauges.tbl#Max Icons:|Max Icons:]] (Optional)
:[[Hud_gauges.tbl#Max Columns:|Max Columns:]] (Optional)
:[[Hud_gauges.tbl#Name Alignment:|Name Alignment:]] (Optional)
}}

====+Hardpoints:====
{{table3615|
Draws a silhouette of the player's ship and mounted weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#Line Width:|Line Width:]] (Optional)
:[[Hud_gauges.tbl#View Direction:|View Direction:]] (Optional)
:[[Hud_gauges.tbl#Show Primary Weapons:|Show Primary Weapons:]] (Optional)
:[[Hud_gauges.tbl#Show Secondary Weapons:|Show Secondary Weapons:]] (Optional)
}}

====+Primary Weapons:====
{{table3615|
Like the Weapons gauge but simpler. Only displays primary weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text:]] (Optional)
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#First Background Height:|First Background Height:]] (Optional)
:[[Hud_gauges.tbl#First Background X-offset:|First Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Entry Background Height:|Entry Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Background X-offset:|Entry Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Last Background X-offset:|Last Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Y-offset:|Last Background Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Y-offset:|List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Ammo X-offset:|Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Link X-offset:|Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset:]] (Optional)
}}

====+Secondary Weapons:====
{{table3615|
Like the Weapons gauge but simpler. Only displays secondary weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text:]] (Optional)
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional)
:[[Hud_gauges.tbl#First Background Height:|First Background Height:]] (Optional)
:[[Hud_gauges.tbl#First Background X-offset:|First Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Height:|Entry Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Background X-offset:|Entry Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Last Background X-offset:|Last Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Y-offset:|Last Background Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Y-offset:|List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Ammo X-offset:|Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Link X-offset:|Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Unlink X-offset:|Unlink X-offset:]] (Optional)
:[[Hud_gauges.tbl#Reload X-offset:|Reload X-offset:]] (Optional)
}}

===$End Gauges===
The Gauges section must end with $End Gauges. No Exceptions.

==#End==
The very last entry in the Hud_gauges.tbl must be #End. No Exceptions.

----
----

==Gauge Configuration Options==
Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.

====Position:====
Defines the screen coordinates for the upper left corner of this gauge.

*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]] (and many others)

====Scale Gauge:====

{{table371|
Define if a gauge size will scale or not.

If false then gauge bitmaps will always show at their original size which may result in gauges being very small at high resolutions.

If true then gauge bitmaps will scale in proportion to the current resolution vs the base HUD resolution in use. This may result in gauges becoming blurry at non-base resolutions.

Defaults to yes/true.

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Boolean''' scale_this_gauge

Used by: most gauges
}}

====Force Scaling Above:====

{{Table373|
Optional. If scaling is disabled for this gauge, then it will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.

Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.

To disable this feature, use '''(-1, -1)'''.

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: ('''Integer''' width, '''Integer''' height)

Used by: most gauges
}}

====Origin:====

{{table371|
Define gauge position as a ratio of the screen size (base or current, it doesn't matter).

Requires [[Hud_gauges.tbl#Offset:|Offset:]]

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Float''' horizontal ratio 0.0 - 1.0, '''Float''' vertical ratio 0.0 - 1.0

Used by: most gauges
}}

====Offset:====

{{table371|
Define gauge offset from [[Hud_gauges.tbl#Origin:|Origin:]] in base resolution pixels

Requires [[Hud_gauges.tbl#Origin:|Origin:]]

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Integer''' horizontal pixel offset from Origin:, '''Integer''' vertical pixel offset from Origin:

Used by: most gauges
}}

====Cockpit Target:====
The cockpit display that this gauge will be rendered to. Refers to the +Display Name: defined in [[ships.tbl#$Cockpit Display:|$Cockpit Display:]].

*Syntax: '''String''' String defined in +Display Name: in [[ships.tbl#$Cockpit Display:|$Cockpit Display:]]

=====Canvas Size:=====
The off-screen canvas this gauge will be rendered to before being interpolated into the actual cockpit display. The smaller this number is, the larger the gauge will appear on the cockpit display.

*Syntax: '''Integer''' width, '''Integer''' height

=====Display Offset:=====
The position of the canvas on the cockpit display texture

*Syntax: '''Integer''' width, '''Integer''' height

=====Display Size:=====
The interpolated size on the cockpit display texture that the canvas will be rendered to.

*Syntax: '''Integer''' width, '''Integer''' height

====Color:====
Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Color]] HUD option and [[Hud_gauges#$Color: 2|$Color]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Font:====
Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Name:====
Defines the name of this custom gauge.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Text:====
Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====X Offset:====
Optional. Defines the horizontal pixel offset (from the gauge's origin as defined by [[Hud_gauges.tbl#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Y Offset:====
Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges.tbl#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Gauge Type:====
Defines the type of gauge this is.

*Syntax: '''String'''
*Valid Values: Any one of the possible [[gauge types]].

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Slew:====
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. If set to "true", the gauge will not follow the player's head movements when using TrackIR/padlock. i.e. should be used for gauges like the gunsight/leadsight.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Max Lines:====
Optional. Specifies the maximum number of message lines that are displayed.

*Syntax: '''Integer'''
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Max Width:====
Optional. Determines how long each message line may be.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Line Height:====
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 9

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Total Lifetime:====
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 14000 (14 seconds)

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Scroll Time:====
Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:|Step Size:]] )

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 30

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Step Size:====
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:|Line Height:]])

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Active by default:====
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Filename:====
Designates the [[Multimedia_Files#ANI|.ANI]] or [[Multimedia_Files#EFF|.EFF]] used for this gauge's background graphic.
{{Note| All HUD .ANI's must have the same color palette as the retail .ANI's in order to render properly. (.EFF's do not have this restriction)}}

*Syntax: '''Filename'''
**No filename extension is needed.

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Top Background Filename:====
Optional. Designates which file to use for the top background. (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Bottom Background Filename:====
Optional. Designates which file to use for the Bottom background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Left Background Filename:====
Optional. Designates which file to use for the Left side of gauge.

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====First Background Filename:====
Optional. Alias for [[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]]

====Right Background Filename:====
Optional. Designates which file to use for the Right side of the gauge.

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Last Background Filename:====
Optional. Alias for [[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]]

====Entry Background Filename:====
Optional. Designates which file to use for the (Wing) Entry section of the gauge (aka the middle sections).

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]], [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Primary List Top Background Filename:====
Optional. Designates which file to use for the Primary List Top Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Middle Background Filename:====
Optional. Designates which file to use for the Primary List Middle Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Bottom Background Filename:====
Optional. Designates which file to use for the Primary List Bottom Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Top Background Filename:====
Optional. Designates which file to use for the Secondary List Top Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Entry Background Filename:====
Optional. Designates which file to use for the Secondary List Entry Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Bottom Background Filename:====
Optional. Designates which file to use for the Secondary List Bottom Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Alt Ballistic Filename:====
Optional. Designates an alternate file to be used for ballistic weapons.

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#Primary List Top Background Filename:|Primary List Top Background Filename]], [[Hud_gauges.tbl#Primary List Middle Background Filename:|Primary List Middle Background Filename]], [[Hud_gauges.tbl#Primary List Bottom Background Filename:|Primary List Bottom Background Filename]], [[Hud_gauges.tbl#Secondary List Top Background Filename:|Secondary List Top Background Filename]], [[Hud_gauges.tbl#Secondary List Entry Background Filename:|Secondary List Entry Background Filename]], [[Hud_gauges.tbl#Secondary List Bottom Background Filename:|Secondary List Bottom Background Filename]]

====Dot Filename:====
Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Header Offsets:====
Optional. Designates the offset from the gauge's upper left corner for headers of various gauges

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels
*Valid Sub-entries:
:Weapons:
::[[Hud_gauges.tbl#Alt Ballistic Offsets:|Alt Ballistic Offsets:]]

Used by: [[Hud_gauges.tbl#+Support:|+Support:]], [[Hud_gauges.tbl#+Damage|+Damage:]], [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Fixed Header Position:====
Optional. If set, the header text will not change position when the gauge changes size.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Text Y-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Text Offsets:====
Optional. Defines the screen position offsets for the text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Value Offsets:====
Optional. Defines the screen position offsets for the value label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Dock Status X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Dock Time X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Hull Integrity Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Hull Integrity Value X-offset:====
Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)

*Syntax: '''Integer''' horizontal offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Top Background Height:====
Optional. Designates the height of the Top background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Left Background Width:====
Optional. Defines the width of the Left Background.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Entry Width:====
Optional. Defines the width of the Entry Background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Subsystem Entry Height:====
Optional. Designates the height of the Subsystem entry (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem List Start Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem Entry Value X-offset:====
Optional. Designates the horizontal offset from the Subsystem List's position (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Single Wing Offsets:====
Optional. Designates the offset from the gauge's upper left corner for a single wing (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Multiple Wing Start Offsets:====
Optional. Designates the offset from the gauge's upper left corner for multiple wings (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Wing Name Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Dot Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the All wingman status icons.
*Syntax:
:'''Integer''' x, '''Integer''' y ;; Wingman 1
:'''Integer''' x, '''Integer''' y ;; Wingman 2
:'''Integer''' x, '''Integer''' y ;; Wingman 3
:'''Integer''' x, '''Integer''' y ;; Wingman 4
:'''Integer''' x, '''Integer''' y ;; Wingman 5
:'''Integer''' x, '''Integer''' y ;; Wingman 6
*Units: Pixels

{{Warning|
All 6 wingman positions must be defined}}

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Expansion Mode:====
Optional. Denotes which direction (in relation to the player's wing) that the other wings should be appended to the gauge. If not present the gauge will expand to the left.

*Syntax: '''String'''
*Valid Values:
**Right
**Down

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Use Full Wing Names:====
{{Table214|
Optional. If enabled the wingmen gauge draws the full wing name and does not alter the capitalization. Default behavior is to draw the first three letters of the wing in all lower-case.

*Syntax: '''Boolean'''
*Default Value: '''False'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]
}}

====Use Expanded Colors:====
{{Table214|
Optional. If enabled the wingmen gauge status dots use red, yellow, or green color to designate wingmen health (green full to greater thon two-thirds, yellow two-thirds to greater than one-third, and red less than or equal to one-third). Default is to use red for less than half health and gauge color otherwise.

*Syntax: '''Boolean'''
*Default Value: '''False'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]
}}

====Auto Offsets:====
Optional. Defines the screen coordinates for the "Auto" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]], [[Hud_gagues.tbl#+Auto Target:|+Auto Target:]]

====Speed Offsets:====
Optional. Defines the screen coordinates for the "Speed" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]]

====Target Offsets:====
Optional. Defines the screen coordinates for the "Target" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Auto Target:|+Auto Target:]]

====Animation Offsets:====
Optional. Defines the offsets for the animation graphics.

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====Animation Background Size:====
Deprecated. Originally, this set the size of the black box that's drawn behind the animation. Since Git revision 556e9a4 (2015-11-01), it has the same effect as [[Hud_gauges.tbl#Animation Size:|Animation Size:]].

*Syntax: '''Integer''' horizontal size, '''Integer''' vertical size
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====Animation Size:====
{{table373|
Optional. Defines the size of the animation. All animations will be scaled to match this size.

*Syntax: '''Integer''' horizontal size, '''Integer''' vertical size
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]
}}

====List Start Offsets:====
Optional. Defines the screen coordinate offsets for the start of the Directives list.

*Syntax: '''Integer''' x, '''Integer''' y
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Entry Height:====
Optional. Defines the height of each Directive

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Alt Ballistic Offsets:====
Opetional. Defines the screen coordinate offsets for headers of ballistic weapons

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Header Offset:|+Header Offset:]]

====Top Primary Background X-offset:====
Optional. Defines the screen coordinate offset for the Top Primary Background

*Syntax: '''Integer'''
*Units: Pixels
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Text X-offset:====
(Optional) Defines the screen coordinate X-offset for weapon labels

*Syntax: '''Integer'''
*Units: Pixels
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Alt Ballistic X-offset:====
Optional. Defines the screen coordinate X-offset for ballistic weapons

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#Top Primary Background X-offset:|Top Primary Background X-offset:]], [[Hud_gauges.tbl#Text X-offset:|Text X-offset:]]

====Top Primary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Top Secondary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Link X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Linked X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Reload X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====3 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 3 digit range (i.e. >= 100%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====2 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 2 digit range (i.e. 100% > hull damage% >= 10%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====1 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 1 digit range (i.e. 10% > hull damage% >= 0%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====Objective Text Y-offset:====
Designates the screen position offset for the Objective label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Objective Value Y-offset====
Designates the screen position offset for the Objective value

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Text Y-offset:====
Designates the screen position offset for the Subspace label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Value Y-offset====
Designates the screen position offset for the Subspace value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Text Y-offset====
Designates the screen position offset for the Red Alert label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Value Y-offset====
Designates the screen position offset for the Red Alert value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Command X-offset:====
*Syntax: '''Integer''' x offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Up Offsets:====
*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Down Offsets:====
*Syntax: '''Integer''' x offset, ''' Integer y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Entry Height:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Entry Stagger Width:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Text:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====List Start Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Hull X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Name X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Status X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Ship Name Max Width:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Right-Align Ship Names:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Foreground Clip Height:====

* Sets the height, in pixels, of the gauge.
** For the [[Hud_gauges.tbl#+Throttle|Throttle]], sets the height of the gauge that represents 0% to 100% throttle. The total height of the gauge is the sum of this value and the [[Hud_gauges.tbl#Afterburner Clip Height:|Afterburner Clip Height]] value.
* Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]], [[Hud_gauges.tbl#+ETS Weapons:|+ETS Weapons]], [[Hud_gauges.tbl#+ETS Engines:|+ETS Engines]], [[Hud_gauges.tbl#+ETS Shields:|+ETS Shields]], [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor]], [[Hud_gauges.tbl#+Afterburner Energy|+Afterburner Energy]], [[Hud_gauges.tbl#+Weapon Energy|+Weapon Energy]], [[Hud_gauges.tbl#+Throttle:|+Throttle]]

====Letter Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Top Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Bottom Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Gauge Offset:====
*Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Monitor Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Status Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Name Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Class Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Speed Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Hull Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Contents Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Start Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Bracket Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Dock Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Dock Max Width:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Order Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Order Max Width:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Time Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Radar Center Offsets:====
Defines the radar's plot origin as an offset, in pixels, from this gauge's [[Hud_gauges.tbl#Position|Position]] coordinates
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Radar Size:====
Size, in pixels, of the radar plot area.

Syntax: '''Integer''' horizontal size, '''Integer''' vertical size

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Infinity Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the infinity radar range symbol.

====Long Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the long range radar text (i.e. 10k).

====Short Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the short range radar text (i.e. 2k).

====Size:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XY Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XZ YZ Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Sweep Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Default Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Unknown Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Loop Volume:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Minimum Beep Delay:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Firepoint display:====
Displays the positions of the gun firepoints on your ship
*Syntax: '''Boolean''', YES or NO

NOTE: The position of the firepoints is calculated from the Eye Point position in the POF. You may encounter weird results if you have no Eye Point defined, but no debug warnings will be raised.

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint size:====
Diameter of the gunpoint circles. '''Must be 4 or greater''' in order to work properly.
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint X coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint Y coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Foreground Clip Bottom Y-offset:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Foreground Clip Width:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Afterburner Clip Height:====
* Sets the area of the throttle gauge that represents the Afterburner segment (which is on top of the 0% to 100% area). The total height of the gauge is determined by the sum of this value and [[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]]

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Show Background:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Max Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Min Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Center Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Radius:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Arc Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Needs to be an [[Multimedia_Files#ANI|ani]] with a least 2 frames (but only the 2nd frame is used ?!?!? for threat & weapon linking so far)

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Needs to be an [[Multimedia_Files#ANI|ani]] with a least 2 frames. The 1st frame is "no warning", the rest of the frames are cycled through when a warning is active.

Internally FSO also refers to this as the "laser threat warning".

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Needs to be an [[Multimedia_Files#ANI|ani]] with a least 2 frames. The 1st frame is "no warning", the rest of the frames are cycled through when a warning is active. Frames cycle twice as fast when a lock has been acquired, compared to when a lock is being acquired.

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Lock Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Loop Locked Animation:====

Controls whether the animation should loop after locking on, like in FS1.

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Blink Locked Animation:====

Controls whether the animation should blink after locking on, like in FS2.

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Radius:====
Defines the distance from the center of the screen to the base of the Hostile Triangle gauge.

*Syntax: '''Integer'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Base:====
Defines the width of the Hostile Triangle's base.

*Syntax: '''Float'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Height:====
Defines the height of the Hostile Triangle.

*Syntax: '''Float'''
Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lead Indicator:|+Lead Indicator:]]

====Single Primary Filename:====
Designates the file to use for primary linking for ships with a single primary bank.

Needs to be an [[Multimedia_Files#ANI|ani]] with 2 frames; 1st is bank 1 not selected (not that this should ever be able to happen), 2nd is bank 1 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Filename:====

Designates the file to use for primary linking for ships with two primary banks.

Needs to be an [[Multimedia_Files#ANI|ani]] with 4 frames:
* Frame 0 is no banks selected
* Frame 1 is 1st bank selected
* Frame 2 is 2nd bank selected
* Frame 3 is both banks selected/linked

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Filename:====

Designates the file to use for selected secondary bank for ships with a single secondary bank.

Needs to be an [[Multimedia_Files#ANI|ani]] with 2 frames; 1st is bank 1 not selected, 2nd is bank 1 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Filename:====

Designates the file to use for selected secondary bank for ships with two secondary banks.

Needs to be an [[Multimedia_Files#ANI|ani]] with 3 frames; 1st is no banks selected, 2nd is bank 1 selected, 3rd is bank 2 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Filename:====

Designates the file to use for selected secondary bank for ships with two secondary banks.

Needs to be an [[Multimedia_Files#ANI|ani]] with 4 frames; 1st is no banks selected, 2nd is bank 1 selected, 3rd is bank 2 selected, 4th is bank 3 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Hidden By Comms Menu:====
{{Table3615|
Defines whether the messages gauge may be drawn at the same time as the wingman comms menu.
*Syntax: '''Boolean'''
*Default Value: '''false''' (messages are not visible while the comms menu is open)
Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]}}

====Bottom Background Offset:====
{{Table3615|
Defines the vertical pixel offset added to the position of the bottom background frame.
*Syntax: '''Integer''' vertical offset
*Units: Pixels
Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]}}

====Center Text On Gauge X-Position:====
{{Table375|
Sets whether to position the center of the text to the gauge's X-position.
*Syntax '''Boolean'''
*Default Value: '''false''' if the gauge is explicitly given a position, '''true''' otherwise
Used by: [[Hud_gauges.tbl#+Fixed Messages:|+Fixed Messages:]]}}

====Ngon Sides:====
{{Table190|
Defines the number of sides a regular polygon (N-gon) radar has. If defined, the standard radar's edge is drawn as an N-gon, instead of the standard ellipsoid. Blips that are projected outside of the N-gon are snapped to the edge: the blip's angle stays the same but the blip's radius to the center of the plot area is reduced.
*Syntax '''Integer'''
*Default Value: '''0''' A value of 0 means to use the standard ellipsoid radar
*Minimum value: '''3''' (which is a triangle)
Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]}}

====Ngon Offset:====
{{Table190|
Defines the angular offset to apply to the N-gon perimeter. The first vertex is at the 3 o'clock position, positive offsets spin this vertex counter-clockwise, negative offsets spin this clockwise.
*Syntax '''Float''' (radians)
*Default Value: '''0'''
Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]}}

[[Category:Tables]]

Hud gauges.tbl

2022-11-29T16:39:08Z

EatThePath: /* Expansion Mode: */ restoring damaged entry

{{SCP table}}
{{TableVersionGit|2016-09-14|f9bc01c}}
{{Tables}}
The '''hud_gauges.tbl''' is used for modifying the elements of the HUD. Not all gauges can be modified. However, custom gauges may be added to mimic their behavior (such as the wingman status display).

HUD Elements in FS2 are called Gauges, and each gauge has various options to customize appearance and, in some cases, their behavior as well.

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

==HUD Configurations==
The following entries are used on the HUD system, but have not been grouped with any particular gauge.

===$Load Retail Configuration:===
Optional. If yes, any gauge missing from the HUD gauge definitions below will be loaded using the retail defaults.

If no, any missing (default) gauge will prompt an error.

*Syntax: '''Boolean'''

===$Color:===
Optional. Sets the default HUD color for all gauges.

*Syntax: ('''Integer''' Red, '''Integer''' Green, '''Integer''' Blue)
*Valid Values: all values from 0 to 255

===$Font:===
Optional. Sets the font type to use for the HUD. This can either be a string or a number. A string references a font with a specific name while a number references a font with a specific index in the fonts table. The number option is deprecated and is only there for backwards-compatibility. Use the name if possible.

*Syntax: '''String''' or '''Integer''' font index number
*Valid Values: Any name or font index as defined in [[Fonts.tbl]]

===$Chase View Only:===
{{Table381|
Optional. Sets gauges to be displayed only in Chase View.

*Syntax: '''Boolean'''
*Default Value: '''False'''
}}

===$Max Directives:===
Optional. Sets the default maximum number of directives displayed simultaneously.

*Syntax: '''Integer''' maximum number of directives
*Valid Values: Any positive number
*Default Value: '''5'''

===$Max Escort Ships:===
Optional. Sets the default maximum number of escort ships to be shown in the escort list.

*Syntax: '''Integer'''
*Valid Values: Any positive number
{{Warning|
Entries more than 16 will cause the list to overflow into the weapons list for resolutions lower than 1024x768.}}

===$Length Unit Multiplier:===
Optional. Sets the multiplier to applied to the reported distances. For example, if the multiplier is 0.5, then the distance reported to the player will (or at least should) be 0.5 x actual distance.

*Syntax: '''Float'''
*Valid Values: Any positive number

===$Speed Unit Multiplier:===
Optional. Analogous to [[Hud_gauges.tbl#$Length Unit Multiplier:|$Length Unit Multiplier]], this sets the multiplier to be applied to all speeds reported to the player. For example, if the multiplier is 0.5, the the speed reported to the player will (or at least should) be 0.5 x actual speed.

*Syntax: '''Float'''
*Valid Values: Any positive number
*Default Values:
:'''The value used in $Length Unit Multiplier''', or
:'''1''', if $Length Unit Multiplier is undefined

===$Wireframe Targetbox:===
Optional. Defines the default draw method for the target viewer (a.k.a. targetbox).

*Syntax: '''Integer''' Draw method ID
*Valid Values:
::'''0''' - Standard with full, bright lighting
::'''1''' - Wireframe
::'''2''' - Standard with proper lighting (i.e. lit the same as the actual target)
{{Table3615|
::'''3''' - Untextured with full bright lighting (i.e. drawn with a single flat color)}}

{{Table224|
===$Wireframe Color Override:===
Optional. Allows using a static color for the target monitor wireframe instead of one based on the target's IFF.
*Syntax: ( Color ), three integers, values from 0 to 255; red, green and blue respectively
*Example: ( 0, 255, 0 )}}

===$Targetbox Shader Effect:===
{{Table3615|
Optional. If set, defines a unique ID for a shader effect to be used when rendering a ship for the targeting box. The ID will be passed to the main shader as in [[Post_processing.tbl##Ship_Effects|#Ship_Effects]], but a table entry for the effect is not needed.

*Syntax: '''Integer'''
*Valid Values: Any positive number
}}

===$Lock Wireframe Mode:===
Optional. If set, prevents targetbox draw method from being changed during the gaming session.
*Syntax: '''Boolean'''

===$Scale Gauges:===
{{Table371|
Optional. If set, all gauges will use this value as the default for scaling individual gauge sizes (i.e. doesn't affect gauges that use Position:, and doesn't affect the values of Offset:. In addition, if "$Load Retail Configuration:" is true then all unspecified retail gauges will use this value.

If not set, defaults to yes.

*Syntax: '''Boolean'''
}}

===$Force Scaling Above:===
{{Table373|
Optional. If gauge scaling is disabled, then gauges will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.

Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.

To disable this feature, use '''(-1, -1)'''.

*Syntax: ('''Integer''' width, '''Integer''' height)
}}

===$Reticle Style:===
Optional. Defines which aiming reticle to use.
*Syntax: '''String'''
*Valid Values:
:'''FS1''' - uses '''''reticle1_fs1.ani'''''
:'''FS2''' - uses '''''reticle1.ani'''''

==#Gauge Config==
The following entries define default gauge appearance and behavior. Each gauge has the option of overriding these options.

===$Ship:===
Deprecated and superceded by $Ships in FSO revision 9208. If defined, the following config data will only be used if the player ship is of the supplied ship class. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*Syntax: '''String''', ship class name

===$Ships:===
Optional. Can be used to define a list of ships the hud definition that follows will be applied to. Can be defined multiple times within a #Gauge config group to allow unique HUD configurations per ship class.

If not defined, all following config data will be applied to all ships.

*`Syntax: '''( "Class name 1" "Class name 2" )''', ship class names formatted like a flag list.

====$Load Retail Configuration:====
Optional. Overrides the [[Hud_gauges.tbl#$Load Retail Configuration: 1|$Load Retail Configuration]] global option for this ship class.

*Syntax: '''Boolean'''

====$Color:====
Optional. Overrides the [[Hud_gauges.tbl#$Color: 1|$Color]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color]]

====$Font:====
Optional. Overrides the [[Hud_gauges.tbl#$Font: 1|$Font]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font]]

====$Chase View Only:====
{{Table381|
Optional. Overrides the [[Hud_gauges.tbl#$Chase View Only: 1|$Chase View Only]] global option for this ship class.

*Syntax: See [[Hud_gauges.tbl#$Chase View Only: 1|$Chase View Only]]
}}

===$Base:===
Required. Defines the base resolution for this HUD configuration, upon which other gauge options (such as [[Hud_gauges.tbl#Position:|Position:]] / [[Hud_gauges.tbl#Origin:|Origin:]] / [[Hud_gauges.tbl#Offset:|Offset:]]) will use as its coordinate system.

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Scale Gauges:===
{{Table371|
Optional. If set, will configure gauges Scaling behaviour for gauges in this #Gauge Config section. i.e. overriding the default, or the value specified at the top of the file. Individual gauges can override this setting.

*Syntax: '''Boolean'''
}}

===$Force Scaling Above:===
{{Table373|
Optional. If gauge scaling is disabled, then gauges will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.

Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.

To disable this feature, use '''(-1, -1)'''.

*Syntax: ('''Integer''' width, '''Integer''' height)
}}

===$Required Aspect:===
Optional. If set, this configuration will only be loaded for the specified aspect ratios.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: '''String'''
*Valid Values:
:"Full Screen" (4:3, aspect ratio < 1.5)
:"Wide Screen" (16:9, 16:10, or similar, aspect ratio >= 1.5)

===$Min:===
Optional. Minimum resolution for this config. Any resolution lower than specified will not use this configuration.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Max:===
Optional. Maximum resolution for this config. Any resolution higher than specified will not use this configuration.

Used as a filter when there are multiple $Base: resolutions in the table

*Syntax: ('''Integer''' width, '''Integer''' height)
*Valid Values: All supported resolutions (?)

===$Gauges:===
Following entries define gauge-specific behavior. For the most part, each gauge has its own overrides that, if not defined, would otherwise use the global values.

Since many gauges have the same configuration options, each gauge entry has a list of valid sub-entries. Unless stated otherwise, these options must be defined in the same order as they are shown, starting from the top and ending at the bottom.

====+Custom:====
Adds a custom gauge type.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Name:|Name:]]
:[[Hud_gauges.tbl#Text:|Text:]]
:[[Hud_gauges.tbl#X Offset:|X Offset:]] (Optional)
:[[Hud_gauges.tbl#Y Offset:|Y Offset:]] (Optional)
:[[Hud_gauges.tbl#Gauge Type:|Gauge Type:]]
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Active by default:|Active by default:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

{{table381|
====+Scripted Gauge:====
Adds a scripted gauge type.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Name:|Name:]]
}}

====+Messages:====
Adds a gauge that display mission messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Max Lines:|Max Lines:]] (Optional)
:[[Hud_gauges.tbl#Max Width:|Max Width:]] (Optional)
:[[Hud_gauges.tbl#Line Height:|Line Height]] (Optional)
:[[Hud_gauges.tbl#Total Lifetime:|Total Lifetime:]] (Optional)
:[[Hud_gauges.tbl#Scroll Time:|Scroll Time]] (Optional)
:[[Hud_gauges.tbl#Step Size:|Step Size:]] (Optional)
:[[Hud_gauges.tbl#Hidden By Comms Menu:|Hidden By Comms Menu:]] (Optional)

====+Training Messages:====
Adds a text box, like the ones seen in the FS1 and FS2 training missions.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Support:====
Adds a text box that shows the Support ship's status and ETA

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Text Y-offset:|Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Status X-offset:|Dock Status X-offset:]] (Optional)
:[[Hud_gauges.tbl#Dock Time X-offset:|Dock Time X-offset:]] (Optional)
{{table224|
:[[Hud_gauges.tbl#Enable Rearm Timer:|Enable Rearm Timer:]] (Optional boolean. Enables the countdown timer for rearm and repair. Overrides the commandline setting.)}}

====+Damage:====
Adds a gauge that shows how much damage a target (or the player?) has.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Offsets:|Hull Integrity Offsets]] (Optional)
:[[Hud_gauges.tbl#Hull Integrity Value X-offset:|Hull Integrity Value X-offset]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Height:|Subsystem Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Subsystem List Start Offsets:|Subsystem List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Entry Value X-offset:|Subsystem Entry Value X-offset:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)

====+Wingman Status:====
Adds a gauge that monitors the status of your wing and squadron.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]] (Optional) (needs an animation with one frame)
{{table3615|
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional) (needs an animation with one frame)}}
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional) (needs an animation with one frame)
:[[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]] (Optional) (needs an animation with one frame)
{{table3615|
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional) (needs an animation with one frame)}}
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional) (needs an animation with two frames, 1st is for alive wingmen, 2nd is for dead or missing wingmen)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
{{table373|
[[Hud_gauges.tbl#Fixed Header Position:|Fixed Header Position:]] (Optional)}}
:[[Hud_gauges.tbl#Left Background Width:|Left Background Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#First Background Size:|First Background Size:]] (Optional)}}
:[[Hud_gauges.tbl#Entry Width:|Entry Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Entry Size:|Entry Size:]] (Optional)
:[[Hud_gauges.tbl#Right Background Offset:|Right Background Offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Offset:|Last Background Offset:]] (Optional)}}
:[[Hud_gauges.tbl#Single Wing Offsets:|Single Wing Offsets:]] (Optional)
:[[Hud_gauges.tbl#Multiple Wing Start Offsets:|Multiple Wing Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Wing Name Offsets:|Wing Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dot Offsets:|Dot Offsets:]] (Optional)
:[[Hud_gauges.tbl#Expansion Mode:|Expansion Mode:]] (Optional)
{{Table214|
:[[Hud_gauges.tbl#Use Full Wing Names:|Use Full Wing Names:]] (Optional)
:[[Hud_gauges.tbl#Use Expanded Colors:|Use Expanded Colors:]] (Optional)
}}

====+Auto Speed:====
Adds the Auto-Speed mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (needs animation with 4 frames, 3rd is without auto-match-speed enabled, 4th is with... and frames 0 & 1 are not used, done this way because retail fs2 uses the same animation file for the auto speed & auto targeting gauges)
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#On Text Color:|On Text Color:]] (Optional)
:[[Hud_gauges.tbl#On Text Color:|Off Text Color:]] (Optional)}}

====+Auto Target:====
Adds the Auto-target mode gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (needs animation with 2 frames, 1st is without auto-targeting enabled, 2nd is with)
:[[Hud_gauges.tbl#Auto Offsets:|Auto Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Offsets:|Target Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#On Text Color:|On Text Color:]] (Optional)
:[[Hud_gauges.tbl#On Text Color:|Off Text Color:]] (Optional)}}

====+Countermeasures:====
Adds a gauge that monitors the amount of remaining countermeasures the player's ship currently has.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (needs an animation with a single frame)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Talking Head:====
Adds a video window to display pilot message videos (a.k.a talking heads).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Offsets:|Animation Offsets:]] (Optional)
:[[Hud_gauges.tbl#Animation Background Size:|Animation Background Size:]] (Deprecated)
{{table373|
:[[Hud_gauges.tbl#Animation Size:|Animation Size:]] (Optional)
}}

====+Directives:====
Adds a gauge that displays all currently active directives (includes current , completed, and failed)

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional) (needs animation with one frame)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional) (needs animation with one frame)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional) (needs animation with one frame)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)
:[[Hud_gauges.tbl#Max Line Width:|Max Line Width:]] (Optional)
}}

====+Weapons:====
Adds a weapon status and ammunition gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Primary List Top Background Filename:|Primary List Top Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Primary List Middle Background Filename:|Primary List Middle Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Primary List Bottom Background Filename:|Primary List Bottom Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Secondary List Top Background Filename:|Secondary List Top Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Secondary List Entry Background Filename:|Secondary List Entry Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Secondary List Bottom Background Filename:|Secondary List Bottom Background Filename:]] (Optional) (needs animation with a single frame)
::[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
::[[Hud_gauges.tbl#Alt Ballistic Offsets:|Alt Ballistic Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Primary Background X-offset:|Top Primary BackgroundX-offset:]] (Optional)
::[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]] (Optional)
:[[Hud_gauges.tbl#Text X-offset:|Text X-offset:]] (Optional)
::[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]] (Optional)
:[[Hud_gauges.tbl#Top Primary Frame Height:|Top Primary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Top Secondary Frame Height:|Top Secondary Frame Height:]] (Optional)
:[[Hud_gauges.tbl#Primary List Start Y-offset:|Primary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary List Start Y-offset:|Secondary List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Ammo X-offset:|Primary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Link X-offset:|Primary Weapon Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Name X-offset:|Primary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Ammo X-offset:|Secondary Weapon Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Linked X-offset:|Secondary Weapon Linked X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Name X-offset:|Secondary Weapon Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Reload X-offset:|Secondary Weapon Reload X-offset:]] (Optional)
:[[Hud_gauges.tbl#Primary Weapon Entry Height:|Primary Weapon Entry Height:]] (Optional)
:[[Hud_gauges.tbl#Secondary Weapon Entry Height:|Secondary Weapon Entry Height:]] (Optional)

====+Objective notify:====
Adds a Objective notifier gauge. This gauge alerts the player when receiving a new objective, or when an objective has been completed or failed. Additionally, this gauge alerts the player when entering subspace, and when a Red Alert mission orders are being received (prior to a forced subspace jump).

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]
:[[Hud_gauges.tbl#Objective Text Y-offset:|Objective Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Objective Value Y-offset:|Objective Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Text Y-offset:|Subspace Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Subspace Value Y-offset:|Subspace Value Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Text Y-offset:|Red Alert Text Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Red Alert Value Y-offset:|Red Alert Value Y-offset:]] (Optional)

====+Squad Message====
Adds the squad message gauge. In FS1 and FS2, this gauge is used to send commands to your squad. (?)

*Valid sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Background Height:|Top Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset|Bottom Background Offset]] (Optional)}}
:[[Hud_gauges.tbl#Command X-offset:|Command X-offset:]] (Optional)
:[[Hud_gauges.tbl#Page Up Offsets:|Page Up Offsets:]] (Optional)
:[[Hud_gauges.tbl#Page Down Offsets:|Page Down Offsets:]] (Optional)

====+Lag:====
Adds a Lag gauge.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]]

====+Mini Target Shields:====
Adds a mini Target shields gauge. In FS1 and FS2, the Mini Target Shield gauge is the one right below the center reticle, and shows the hull damage in %

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]]
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (animation needs 8 frames; 0->3 are the top, right, bottom & left shield quads; 4->7 are the same except brighter for when the quad is flashing from being hit)
:[[Hud_gauges.tbl#3 Digit Hull Offsets:|3 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#2 Digit Hull Offsets:|2 Digit Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#1 Digit Hull Offsets:|1 Digit Hull Offsets:]] (Optional)

====+Player Shields:====
Adds a gauge that shows the shield and hull status icon of the player's craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Target Shields:====
Adds a gauge that shows the shield and hull status icon of the targeted craft or ship.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Escort View:====
Adds an escort monitor/view gauge. This gauge monitors the status of all ships assigned to the player to escort.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Top Background Filename:|Top Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Bottom Background Filename:|Bottom Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height]] (Optional)
:[[Hud_gauges.tbl#Entry Stagger Width:|Entry Stagger Width:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Bottom Background Offset:|Bottom Background Offset:]] (Optional)}}
:[[Hud_gauges.tbl#Header Text:|Header Text]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#List Start Offsets:|List Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull X-offset:|Hull X-offset]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset]] (Optional)
:[[Hud_gauges.tbl#Status X-offset:|Status X-offset]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Ship Name Max Width:|Ship Name Max Width:]] (Optional)}}
{{table373|
:[[Hud_gauges.tbl#Right-Align Ship Names:|Right-Align Ship Names:]] (Optional)}}

====+Mission Time:====
Adds a gauge that displays the current mission time.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+ETS Retail:====
{{Table3613|
Draws the three other ETS gauges as a single gauge. Will automatically rearrange itself (like retail) if shields or other systems are missing.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
{{Table3613|
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)
:[[Hud_gauges.tbl#Gauge Offset:|Gauge Offset:]] (Optional)

}}

====+ETS Weapons:====
Adds a gauge that displays the energy transfer rate for the energy weapons.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Engines:====
Adds a gauge that displays the energy transfer rate for the afterburner/engines.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+ETS Shields:====
Adds a gauge that displays the energy transfer rate for the shields.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Letter Offsets:|Letter Offsets:]] (Optional)
:[[Hud_gauges.tbl#Top Offsets:|Top Offsets:]] (Optional)
:[[Hud_gauges.tbl#Bottom Offsets:|Bottom Offsets:]] (Optional)

====+Target Monitor:====
Adds a target monitor gauge that shows the targeted ship's relative orientation and hull strength, among other things.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Monitor Filename:|Monitor Filename:]] (Optional) (needs animation with 2 frames, 1st is the background for the target, 2nd is the border; rendered last)
{{table3615|
:[[Hud_gauges.tbl#Monitor Alpha Mask Filename:|Monitor Alpha Mask Filename:]] (Optional) (needs animation with a single frame)}}
:[[Hud_gauges.tbl#Integrity Bar Filename:|Integrity Bar Filename:]] (Optional) (needs animation with 2 frames, 1st is a zero/dark filled bar, 2nd is a max/bright filled bar)
:[[Hud_gauges.tbl#Viewport Offsets:|Viewport Offsets:]] (Optional)
:[[Hud_gauges.tbl#Viewport Size:|Viewport Size:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Offsets:|Integrity Bar Offsets:]] (Optional)
:[[Hud_gauges.tbl#Integrity Bar Foreground Clip Height:|Integrity Bar Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Status Offsets:|Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Class Offsets:|Class Offsets:]] (Optional)
:[[Hud_gauges.tbl#Distance Offsets:|Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Speed Offsets:|Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Hull Offsets:|Hull Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Contents Offsets:|Cargo Contents Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Start Offsets:|Cargo Scan Start Offsets:]] (Optional)
:[[Hud_gauges.tbl#Cargo Scan Size:|Cargo Scan Size:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Subsystem Name Offsets:|Subsystem Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Subsystem Integrity Offsets:|Subsystem Integrity Offsets:]] (Optional)
:[[Hud_gauges.tbl#Disabled Status Offsets:|Disabled Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Desaturate:|Desaturate:]] (Optional)
}}
{{table224|
:[[Hud_gauges.tbl#Wireframe:|Wireframe:]] (Optional. Valid values match $Wireframe Targetbox: and will override the global setting)
:[[Hud_gauges.tbl#Wireframe Color:|Wireframe Color:]] (Optional. Color. Takes three ints 0-255, R,G,B; will override the global setting)
}}

====+Extra Target Data:====
Adds a gauge that displays "extra" target data, such as its current orders and docking status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs an animation with 1 frame)
:[[Hud_gauges.tbl#Bracket Offsets:|Bracket Offsets:]] (Optional)
:[[Hud_gauges.tbl#Dock Offsets:|Dock Offsets:]] (Optional)
{{table373|
:[[Hud_gauges.tbl#Dock Max Width:|Dock Max Width:]] (Optional)}}
:[[Hud_gauges.tbl#Order Offsets:|Order Offsets:]] (Optional)
{{table373|
:[[Hud_gauges.tbl#Order Max Width:|Order Max Width:]] (Optional)}}
:[[Hud_gauges.tbl#Time Offsets:|Time Offsets:]] (Optional)

====+Radar:====
Adds a standard radar gauge

*Valid Sub-entries:
{{table190|
:[[Hud_gauges.tbl#Ngon Sides:|Ngon Sides:]] (Optional)
:[[Hud_gauges.tbl#Ngon Sides:|Ngon Offset:]] (Optional)
}}
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs animation with 2 frames, only the 2nd frame is used)
{{table373|
:[[Hud_gauges.tbl#Radar Center Offsets:|Radar Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Radar Size:|Radar Size:]] (Optional)
}}
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar Orb:====
Adds a 3D orb radar gauge

*Valid Sub-entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs animation with 2 frames, only the 2nd frame is used)
{{table373|
:[[Hud_gauges.tbl#Radar Center Offsets:|Radar Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Radar Size:|Radar Size:]] (Optional)
}}
:[[Hud_gauges.tbl#Infinity Distance Offsets:|Infinity Distance Offsets]] (Optional)
:[[Hud_gauges.tbl#Long Distance Offsets:|Long Distance Offsets:]] (Optional)
:[[Hud_gauges.tbl#Short Distance Offsets:|Short Distance Offsets:]] (Optional)

====+Radar BSG:====
Adds a BSG style radar (a.k.a DRADIS).

:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#XY Disc Filename:|XY Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#XZ YZ Disc Filename:|XZ YZ Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Sweep Disc Filename:|Sweep Disc Filename:]] (Optional)
:[[Hud_gauges.tbl#Default Contact Filename:|Default Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Unknown Contact Filename:|Unknown Contact Filename:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]]
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]]
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Loop Volume:|Loop Volume:]] (Optional)
:[[Hud_gauges.tbl#Minimum Beep Delay:|Minimum Beep Delay]] (Optional)

====+Afterburner Energy:====
Adds a gauge that shows the remaining afterburner energy. Note that it only supports a vertical fill.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs animation with 2 frames, the 1st is the bar lit for zero energy, the 2nd is the bar lit for max energy)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)

====+Weapon Energy:====
Adds a gauge that shows the remaining weapon energy. Note that it only supports a vertical fill.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs an animation with 4 frames, the 3rd is the bar lit for zero energy, the 2nd is the bar lit for max energy, frames 1 & 2 are not used)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Text Alignment:|Text Alignment:]] (Optional)
:[[Hud_gauges.tbl#Always Show Text:|Always Show Text:]] (Optional)
:[[Hud_gauges.tbl#Text Follows:|Text Follows:]] (Optional)
:[[Hud_gauges.tbl#Show Ballistic Ammo:|Show Ballistic Ammo:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Offsets:|Armed Guns List Offsets:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Alignment:|Armed Guns List Alignment:]] (Optional)
:[[Hud_gauges.tbl#Armed Guns List Entry Height:|Armed Guns List Entry Height:]] (Optional)
}}

====+Text Warnings:====
Adds a gauge that warns the player (current warnings are EMP, Launch, Evaded, Collision, Blast & Engine Wash).

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)

====+Center Reticle:====
Adds a "custom" center reticle.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Firepoint display:|Firepoint display:]] (Optional)
:[[Hud_gauges.tbl#Firepoint size:|Firepoint size:]] (Optional)
:[[Hud_gauges.tbl#Firepoint X coordinate multiplier:|Firepoint X coordinate multiplier:]] (Optional)
:[[Hud_gauges.tbl#Firepoint Y coordinate multiplier:|Firepoint Y coordinate multiplier:]] (Optional)

====+Throttle:====
Adds a gauge that shows the current throttle position.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Bottom Y-offset:|Foreground Clip Bottom Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Width:|Foreground Clip Width:]] (Optional)
:[[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Afterburner Clip Height:|Afterburner Clip Height:]] (Optional)
:[[Hud_gauges.tbl#Show Background:|Show Background:]] (Optional)
:[[Hud_gauges.tbl#Max Speed Label Offsets:|Max Speed Label Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Show Max Speed Label:|Show Max Speed Label:]] (Optional)}}
:[[Hud_gauges.tbl#Min Speed Label Offsets:|Min Speed Label Offsets:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Show Min Speed Label:|Show Min Speed Label:]] (Optional)}}
:[[Hud_gauges.tbl#Orbit Center Offsets:|Orbit Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Orbit Radius:|Orbit Radius:]] (Optional)
{{table3615|
:[[Hud_gauges.tbl#Current Speed Offsets:|Current Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Target Speed Offsets:|Target Speed Offsets:]] (Optional)
:[[Hud_gauges.tbl#Show Percentage:|Show Percentage:]] (Optional)
:[[Hud_gauges.tbl#Glide Status Offsets:|Glide Status Offsets:]] (Optional)
:[[Hud_gauges.tbl#Match Speed Status Offsets:|Match Speed Status Offsets:]] (Optional)
}}

====+Threat Indicator:====
Adds a gauge that indicates when a lock-on has been achieved by an attacker, and if the player is being shot at.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Filename:|Dumbfire Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Dumbfire Offsets:|Dumbfire Offsets:]] (Optional)
:[[Hud_gauges.tbl#Lock Offsets:|Lock Offsets:]] (Optional)

====+Multiplayer Messages:====
Adds a gauge that displays the multiplayer messages.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Voice Status:====
Adds a gauge that displays the voice status.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Ping:====
Adds a gauge that the ping time to the multiplayer server.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Supernova:====
Adds a gauge that warns the player of an impending supernova shock wave.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Lock Indicator:====
Adds a Lock Indicator gauge.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Lock Filename:|Lock Filename:]] (Optional)
:[[Hud_gauges.tbl#Locked Filename:|Locked Filename:]] (Optional)
:[[Hud_gauges.tbl#Lock Center Offsets:|Lock Center Offsets:]] (Optional)
:[[Hud_gauges.tbl#Locked Center Offsets:|Locked Center Offsets:]] (Optional)
{{table224|
:[[Hud_gauges.tbl#Loop Locked Animation:|Loop Locked Animation:]] (Optional)
:[[Hud_gauges.tbl#Blink Locked Animation:|Blink Locked Animation:]] (Optional)}}

====+Offscreen Indicator:====
Adds an Offscreen Indicator.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}

====+Target Brackets:====
Adds a Target Bracket gauge. This is drawn around current target(s) and talkers.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Dot Filename:|Dot Filename:]] (Optional)
{{table224|
:[[Hud_gauges.tbl#Enable Target Info:|Enable Target Info:]] (Optional boolean. Adds the target name and class to the brackets. Overrides the commandline setting.)}}

====+Hostile Triangle:====
Adds a gauge that points to the nearest attacker, if it is off-screen and is not currently targeted.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Target Triangle:====
Adds a gauge that points to the targeted craft, if it is currently off-screen.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Missile Triangles:====
Adds a gauge that is used during attempting to lock onto a target when using an aspect seeking missile.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)
:[[Hud_gauges.tbl#Triangle Base:|Triangle Base:]] (Optional)
:[[Hud_gauges.tbl#Triangle Height:|Triangle Height:]] (Optional)

====+Lead Indicator:====
Adds a gauge that leads (is in front) of the target. Aim your crosshairs at this indicator to increase probability of hitting the target.

*Valid Sub-entries:
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
::Frame #0: Secondaries lead indicator (Dumbfire)
::Frame #1: Secondaries lead indicator (Homing)
::Frame #2: Primaries lead indicator
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)

====+Orientation Tee:====
Adds a gauge that indicates the targeted craft's orientation in relation to the player's craft.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Radius:|Radius]] (Optional)

====+Lead Sight:====
Adds a gauge that lags (is behind) the target. Indicates where your shots will end up relative to the target's position. To score a hit, this gauge should be over the target. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
::Frame #0 is used for secondaries
::* If only one frame is found in the file, then it is used for primaries instead
::Frame #1 is used for primaries

====+Kills:====
Adds a gauge that keeps track of how many kills the player has scored during a mission.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Text Offsets:|Text Offsets:]] (Optional)
:[[Hud_gauges.tbl#Value Offsets:|Value Offsets:]] (Optional)

====+Weapon Linking:====
Adds a gauge that indicates the selected weapons and their firing rates.

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Arc Filename:|Arc Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Filename:|Single Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Filename:|Double Primary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Filename:|Single Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Filename:|Double Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Filename:|Triple Secondary Filename:]] (Optional)
:[[Hud_gauges.tbl#Single Primary Offsets:|Single Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Primary Offsets:|Double Primary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Single Secondary Offsets:|Single Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Double Secondary Offsets:|Double Secondary Offsets:]] (Optional)
:[[Hud_gauges.tbl#Triple Secondary Offsets:|Triple Secondary Offsets:]] (Optional)

====+Fixed Messages:====

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position]] (Optional)
{{table371|
:[[Hud_gauges.tbl#Scale Gauge:|Scale Gauge:]] (Optional)
}}
{{table373|
:[[Hud_gauges.tbl#Force Scaling Above:|Force Scaling Above:]] (Optional)
}}
{{table371|
:[[Hud_gauges.tbl#Origin:|Origin:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Offset:|Offset:]])
:[[Hud_gauges.tbl#Offset:|Offset:]] (Optional, incompatible with [[Hud_gauges.tbl#Position:|Position:]], requires [[Hud_gauges.tbl#Origin:|Origin:]])
}}
{{table3615|
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
}}
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
{{table375|
:[[Hud_gauges.tbl#Center Text On Gauge X-Position:|Center Text On Gauge X-Position:]] (Optional)
}}

====+Flight Path Marker:====
{{table3615|
Adds a gauge that indicates the direction where your ship is traveling. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional)
:[[Hud_gauges.tbl#Center Offsets:|Center Offsets:]] (Optional)}}

====+Warhead Count:====
{{table3615|
Displays the name of the current secondary weapon. Tallies the ammo left. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Filename:|Filename:]] (Optional) (needs an animation with a single frame)
:[[Hud_gauges.tbl#Name Offsets:|Name Offsets:]] (Optional)
:[[Hud_gauges.tbl#Count Offsets:|Count Offsets:]] (Optional)
:[[Hud_gauges.tbl#Icon Width:|Icon Width:]] (Optional)
:[[Hud_gauges.tbl#Icon Height:|Icon Height:]] (Optional)
:[[Hud_gauges.tbl#Max Icons:|Max Icons:]] (Optional)
:[[Hud_gauges.tbl#Max Columns:|Max Columns:]] (Optional)
:[[Hud_gauges.tbl#Name Alignment:|Name Alignment:]] (Optional)
}}

====+Hardpoints:====
{{table3615|
Draws a silhouette of the player's ship and mounted weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Size:|Size:]] (Optional)
:[[Hud_gauges.tbl#Line Width:|Line Width:]] (Optional)
:[[Hud_gauges.tbl#View Direction:|View Direction:]] (Optional)
:[[Hud_gauges.tbl#Show Primary Weapons:|Show Primary Weapons:]] (Optional)
:[[Hud_gauges.tbl#Show Secondary Weapons:|Show Secondary Weapons:]] (Optional)
}}

====+Primary Weapons:====
{{table3615|
Like the Weapons gauge but simpler. Only displays primary weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text:]] (Optional)
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#First Background Height:|First Background Height:]] (Optional)
:[[Hud_gauges.tbl#First Background X-offset:|First Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Entry Background Height:|Entry Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Background X-offset:|Entry Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional) (needs animation with a single frame)
:[[Hud_gauges.tbl#Last Background X-offset:|Last Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Y-offset:|Last Background Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Y-offset:|List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Ammo X-offset:|Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Link X-offset:|Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset:]] (Optional)
}}

====+Secondary Weapons:====
{{table3615|
Like the Weapons gauge but simpler. Only displays secondary weapons. Notably used by [[Diaspora]].

*Valid Sub-Entries:
:[[Hud_gauges.tbl#Position:|Position:]] (Optional)
:[[Hud_gauges.tbl#Cockpit Target:|Cockpit Target:]] (Optional)
::[[Hud_gauges.tbl#Canvas Size:|Canvas Size:]] (Optional)
::[[Hud_gauges.tbl#Display Offset:|Display Offset:]] (Optional)
::[[Hud_gauges.tbl#Display Size:|Display Size:]]
:[[Hud_gauges.tbl#Color:|Color:]] (Optional)
:[[Hud_gauges.tbl#Font:|Font:]] (Optional)
{{table381|
:[[Hud_gauges.tbl#Chase View Only:|Chase View Only:]] (Optional)}}
{{table224|
:[[Hud_gauges.tbl#Cockpit View Choice:|Cockpit View Choice:]] (Optional. Valid values are "cockpitactive", "cockpitinactive", "both")}}
:[[Hud_gauges.tbl#Slew:|Slew:]] (Optional)
:[[Hud_gauges.tbl#Header Offsets:|Header Offsets:]] (Optional)
:[[Hud_gauges.tbl#Header Text:|Header Text:]] (Optional)
:[[Hud_gauges.tbl#First Background Filename:|First Background Filename:]] (Optional)
:[[Hud_gauges.tbl#First Background Height:|First Background Height:]] (Optional)
:[[Hud_gauges.tbl#First Background X-offset:|First Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Filename:|Entry Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Entry Background Height:|Entry Background Height:]] (Optional)
:[[Hud_gauges.tbl#Entry Background X-offset:|Entry Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Filename:|Last Background Filename:]] (Optional)
:[[Hud_gauges.tbl#Last Background X-offset:|Last Background X-offset:]] (Optional)
:[[Hud_gauges.tbl#Last Background Y-offset:|Last Background Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Entry Height:|Entry Height:]] (Optional)
:[[Hud_gauges.tbl#List Start Y-offset:|List Start Y-offset:]] (Optional)
:[[Hud_gauges.tbl#Ammo X-offset:|Ammo X-offset:]] (Optional)
:[[Hud_gauges.tbl#Link X-offset:|Link X-offset:]] (Optional)
:[[Hud_gauges.tbl#Name X-offset:|Name X-offset:]] (Optional)
:[[Hud_gauges.tbl#Unlink X-offset:|Unlink X-offset:]] (Optional)
:[[Hud_gauges.tbl#Reload X-offset:|Reload X-offset:]] (Optional)
}}

===$End Gauges===
The Gauges section must end with $End Gauges. No Exceptions.

==#End==
The very last entry in the Hud_gauges.tbl must be #End. No Exceptions.

----
----

==Gauge Configuration Options==
Since a vast majority of gauges share the same entries, the configuration options for each gauge have been grouped here for formatting consistency.

====Position:====
Defines the screen coordinates for the upper left corner of this gauge.

*Syntax: '''Integer''' horizontal pixel, '''Integer''' vertical pixel position

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]] (and many others)

====Scale Gauge:====

{{table371|
Define if a gauge size will scale or not.

If false then gauge bitmaps will always show at their original size which may result in gauges being very small at high resolutions.

If true then gauge bitmaps will scale in proportion to the current resolution vs the base HUD resolution in use. This may result in gauges becoming blurry at non-base resolutions.

Defaults to yes/true.

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Boolean''' scale_this_gauge

Used by: most gauges
}}

====Force Scaling Above:====

{{Table373|
Optional. If scaling is disabled for this gauge, then it will be scaled as though the base resolution were this resolution or the real base resolution, whichever is greater.

Use this to disable scaling at lower resolutions while preventing gauges from getting too small at higher resolutions.

To disable this feature, use '''(-1, -1)'''.

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: ('''Integer''' width, '''Integer''' height)

Used by: most gauges
}}

====Origin:====

{{table371|
Define gauge position as a ratio of the screen size (base or current, it doesn't matter).

Requires [[Hud_gauges.tbl#Offset:|Offset:]]

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Float''' horizontal ratio 0.0 - 1.0, '''Float''' vertical ratio 0.0 - 1.0

Used by: most gauges
}}

====Offset:====

{{table371|
Define gauge offset from [[Hud_gauges.tbl#Origin:|Origin:]] in base resolution pixels

Requires [[Hud_gauges.tbl#Origin:|Origin:]]

Incompatible with [[Hud_gauges.tbl#Position:|Position:]]

*Syntax: '''Integer''' horizontal pixel offset from Origin:, '''Integer''' vertical pixel offset from Origin:

Used by: most gauges
}}

====Cockpit Target:====
The cockpit display that this gauge will be rendered to. Refers to the +Display Name: defined in [[ships.tbl#$Cockpit Display:|$Cockpit Display:]].

*Syntax: '''String''' String defined in +Display Name: in [[ships.tbl#$Cockpit Display:|$Cockpit Display:]]

=====Canvas Size:=====
The off-screen canvas this gauge will be rendered to before being interpolated into the actual cockpit display. The smaller this number is, the larger the gauge will appear on the cockpit display.

*Syntax: '''Integer''' width, '''Integer''' height

=====Display Offset:=====
The position of the canvas on the cockpit display texture

*Syntax: '''Integer''' width, '''Integer''' height

=====Display Size:=====
The interpolated size on the cockpit display texture that the canvas will be rendered to.

*Syntax: '''Integer''' width, '''Integer''' height

====Color:====
Optional. Overrides both previous color settings ([[Hud_gauges.tbl#$Color: 1|$Color]] HUD option and [[Hud_gauges#$Color: 2|$Color]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Color: 1|$Color:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Font:====
Optional. Overrides both previous font settings ([[Hud_gauges.tbl#$Font: 1|$Font]] HUD option and [[Hud_gauges#$Font: 2|$Font]] ship class option) for this particular gauge.

*Syntax: See [[Hud_gauges.tbl#$Font: 1|$Font:]]

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Training Messages:|+Training Messages:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Name:====
Defines the name of this custom gauge.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Text:====
Default text to be displayed. Can be altered using the hud-set-message, hud-set-text and hud-set-directive sexps.

*Syntax: '''String'''
*Max Length: 32 characters

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====X Offset:====
Optional. Defines the horizontal pixel offset (from the gauge's origin as defined by [[Hud_gauges.tbl#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Y Offset:====
Optional. Defines the vertical pixel offset (from the gauge's origin defined by [[Hud_gauges.tbl#Position:|Position:]]) that the Text will be displayed.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Gauge Type:====
Defines the type of gauge this is.

*Syntax: '''String'''
*Valid Values: Any one of the possible [[gauge types]].

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Slew:====
Optional. Determines whether or not this gauge is affected by afterburner shaking or similar effects. If set to "true", the gauge will not follow the player's head movements when using TrackIR/padlock. i.e. should be used for gauges like the gunsight/leadsight.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Max Lines:====
Optional. Specifies the maximum number of message lines that are displayed.

*Syntax: '''Integer'''
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Max Width:====
Optional. Determines how long each message line may be.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Line Height:====
Optional. Determines the distance between line origins. (i.g. for a 12pt Font, there are needs to be at least 12 pixels between the bottom of one line and the next, otherwise the text will overlap each)

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 9

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Total Lifetime:====
Optional. Determines the maximum time the message gauge will be displayed from the time a new message is received.

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 14000 (14 seconds)

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Scroll Time:====
Optional. Determines the time for the messages to scroll up one step.( See [[Hud_gauges.tbl#Step Size:|Step Size:]] )

*Syntax: '''Integer'''
*Units: milliseconds
*Default Value: 30

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Step Size:====
Optional. Determines how many pixels to shift message lines during scrolling. Messages will be shifted up by this amount until they are on the next line (as defined by [[Hud_gauges.tbl#Line Height:|Line Height:]])

*Syntax: '''Integer'''
*Units: Pixels
*Default Value: 3

Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]

====Active by default:====
Optional. Determines whether or not this gauge is always active, or only available after being activated via sexp.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]]

====Filename:====
Designates the [[Multimedia_Files#ANI|.ANI]] or [[Multimedia_Files#EFF|.EFF]] used for this gauge's background graphic.
{{Note| All HUD .ANI's must have the same color palette as the retail .ANI's in order to render properly. (.EFF's do not have this restriction)}}

*Syntax: '''Filename'''
**No filename extension is needed.

Used by: [[Hud_gauges.tbl#+Custom:|+Custom:]], [[Hud_gauges.tbl#+Support:|+Support]]

====Top Background Filename:====
Optional. Designates which file to use for the top background. (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Bottom Background Filename:====
Optional. Designates which file to use for the Bottom background (?)

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]]

====Left Background Filename:====
Optional. Designates which file to use for the Left side of gauge.

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====First Background Filename:====
Optional. Alias for [[Hud_gauges.tbl#Left Background Filename:|Left Background Filename:]]

====Right Background Filename:====
Optional. Designates which file to use for the Right side of the gauge.

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Last Background Filename:====
Optional. Alias for [[Hud_gauges.tbl#Right Background Filename:|Right Background Filename:]]

====Entry Background Filename:====
Optional. Designates which file to use for the (Wing) Entry section of the gauge (aka the middle sections).

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Damage|+Damage]], [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Primary List Top Background Filename:====
Optional. Designates which file to use for the Primary List Top Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Middle Background Filename:====
Optional. Designates which file to use for the Primary List Middle Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Bottom Background Filename:====
Optional. Designates which file to use for the Primary List Bottom Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Top Background Filename:====
Optional. Designates which file to use for the Secondary List Top Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Entry Background Filename:====
Optional. Designates which file to use for the Secondary List Entry Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Bottom Background Filename:====
Optional. Designates which file to use for the Secondary List Bottom Background

*Syntax: '''Filename'''
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic Filename:|Alt Ballistic Filename]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Alt Ballistic Filename:====
Optional. Designates an alternate file to be used for ballistic weapons.

*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#Primary List Top Background Filename:|Primary List Top Background Filename]], [[Hud_gauges.tbl#Primary List Middle Background Filename:|Primary List Middle Background Filename]], [[Hud_gauges.tbl#Primary List Bottom Background Filename:|Primary List Bottom Background Filename]], [[Hud_gauges.tbl#Secondary List Top Background Filename:|Secondary List Top Background Filename]], [[Hud_gauges.tbl#Secondary List Entry Background Filename:|Secondary List Entry Background Filename]], [[Hud_gauges.tbl#Secondary List Bottom Background Filename:|Secondary List Bottom Background Filename]]

====Dot Filename:====
Optional. Designates which file to use for the wingman graphic (a.k.a. the Dot)

*Syntax: '''Filename'''

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Header Offsets:====
Optional. Designates the offset from the gauge's upper left corner for headers of various gauges

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels
*Valid Sub-entries:
:Weapons:
::[[Hud_gauges.tbl#Alt Ballistic Offsets:|Alt Ballistic Offsets:]]

Used by: [[Hud_gauges.tbl#+Support:|+Support:]], [[Hud_gauges.tbl#+Damage|+Damage:]], [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Fixed Header Position:====
Optional. If set, the header text will not change position when the gauge changes size.

*Syntax: '''Boolean'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Text Y-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship Text. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Text Offsets:====
Optional. Defines the screen position offsets for the text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Value Offsets:====
Optional. Defines the screen position offsets for the value label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: :[[Hud_gauges.tbl#+Countermeasures:|+Countermeasures:]]

====Dock Status X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock status. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Dock Time X-offset:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship's dock time. (?)

*Syntax: '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Support:|+Support:]]

====Hull Integrity Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the Damage gauge Hull integrity textbox(?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Hull Integrity Value X-offset:====
Optional. Designates the offsets from the hull integrity textbox's upper left corner for the hull integrity value. (?)

*Syntax: '''Integer''' horizontal offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Top Background Height:====
Optional. Designates the height of the Top background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Left Background Width:====
Optional. Defines the width of the Left Background.

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Entry Width:====
Optional. Defines the width of the Entry Background (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Subsystem Entry Height:====
Optional. Designates the height of the Subsystem entry (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem List Start Offsets:====
Optional. Designates the offsets from the gauge's upper left corner for the for the start of the Subsytem List (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Subsystem Entry Value X-offset:====
Optional. Designates the horizontal offset from the Subsystem List's position (?)

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]

====Single Wing Offsets:====
Optional. Designates the offset from the gauge's upper left corner for a single wing (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Multiple Wing Start Offsets:====
Optional. Designates the offset from the gauge's upper left corner for multiple wings (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Wing Name Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the Support Ship header (?)

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Dot Offsets:====
Optional. Designates the offset from the gauge's upper left corner for the All wingman status icons.
*Syntax:
:'''Integer''' x, '''Integer''' y ;; Wingman 1
:'''Integer''' x, '''Integer''' y ;; Wingman 2
:'''Integer''' x, '''Integer''' y ;; Wingman 3
:'''Integer''' x, '''Integer''' y ;; Wingman 4
:'''Integer''' x, '''Integer''' y ;; Wingman 5
:'''Integer''' x, '''Integer''' y ;; Wingman 6
*Units: Pixels

{{Warning|
All 6 wingman positions must be defined}}

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]

====Expansion Mode:====
Optional. Denotes which direction (in relation to the player's wing) that the other wings should be appended to the gauge. If not present the gauge will expand to the left.

*Syntax: '''String'''
*Valid Values:
**Right
**Down

Used by: [[Hud_gagues.tbl#+Wingman Status:|+Wingman Status:]]

====Use Full Wing Names:====
{{Table214|
Optional. If enabled the wingmen gauge draws the full wing name and does not alter the capitalization. Default behavior is to draw the first three letters of the wing in all lower-case.

*Syntax: '''Boolean'''
*Default Value: '''False'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]
}}

====Use Expanded Colors:====
{{Table214|
Optional. If enabled the wingmen gauge status dots use red, yellow, or green color to designate wingmen health (green full to greater thon two-thirds, yellow two-thirds to greater than one-third, and red less than or equal to one-third). Default is to use red for less than half health and gauge color otherwise.

*Syntax: '''Boolean'''
*Default Value: '''False'''

Used by: [[Hud_gauges.tbl#+Wingman Status:|+Wingman Status:]]
}}

====Auto Offsets:====
Optional. Defines the screen coordinates for the "Auto" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]], [[Hud_gagues.tbl#+Auto Target:|+Auto Target:]]

====Speed Offsets:====
Optional. Defines the screen coordinates for the "Speed" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gagues.tbl#+Auto Speed:|+Auto Speed:]]

====Target Offsets:====
Optional. Defines the screen coordinates for the "Target" text label.

*Syntax: '''Integer''' horizontal position, '''Integer''' vertical position
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Auto Target:|+Auto Target:]]

====Animation Offsets:====
Optional. Defines the offsets for the animation graphics.

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====Animation Background Size:====
Deprecated. Originally, this set the size of the black box that's drawn behind the animation. Since Git revision 556e9a4 (2015-11-01), it has the same effect as [[Hud_gauges.tbl#Animation Size:|Animation Size:]].

*Syntax: '''Integer''' horizontal size, '''Integer''' vertical size
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]

====Animation Size:====
{{table373|
Optional. Defines the size of the animation. All animations will be scaled to match this size.

*Syntax: '''Integer''' horizontal size, '''Integer''' vertical size
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Talking Head:|+Talking Head:]]
}}

====List Start Offsets:====
Optional. Defines the screen coordinate offsets for the start of the Directives list.

*Syntax: '''Integer''' x, '''Integer''' y
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Entry Height:====
Optional. Defines the height of each Directive

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_guages.tbl#+Directives:|+Directives:]]

====Alt Ballistic Offsets:====
Opetional. Defines the screen coordinate offsets for headers of ballistic weapons

*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Header Offset:|+Header Offset:]]

====Top Primary Background X-offset:====
Optional. Defines the screen coordinate offset for the Top Primary Background

*Syntax: '''Integer'''
*Units: Pixels
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Text X-offset:====
(Optional) Defines the screen coordinate X-offset for weapon labels

*Syntax: '''Integer'''
*Units: Pixels
*Valid Sub-entries:
:[[Hud_gauges.tbl#Alt Ballistic X-offset:|Alt Ballistic X-offset:]]

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Alt Ballistic X-offset:====
Optional. Defines the screen coordinate X-offset for ballistic weapons

*Syntax: '''Integer'''
*Units: Pixels

Used by: [[Hud_gauges.tbl#Top Primary Background X-offset:|Top Primary Background X-offset:]], [[Hud_gauges.tbl#Text X-offset:|Text X-offset:]]

====Top Primary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Top Secondary Frame Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary List Start Y-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Link X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Ammo X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Linked X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Name X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Reload X-offset:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Primary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====Secondary Weapon Entry Height:====

Used by: [[Hud_gauges.tbl#+Weapons:|+Weapons:]]

====3 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 3 digit range (i.e. >= 100%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====2 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 2 digit range (i.e. 100% > hull damage% >= 10%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====1 Digit Hull Offsets:====
Designates the screen position offsets for the hull damage % when it is the 1 digit range (i.e. 10% > hull damage% >= 0%)

*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Mini Target Shields:|+Mini Target Shields:]]

====Objective Text Y-offset:====
Designates the screen position offset for the Objective label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Objective Value Y-offset====
Designates the screen position offset for the Objective value

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Text Y-offset:====
Designates the screen position offset for the Subspace label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Subspace Value Y-offset====
Designates the screen position offset for the Subspace value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Text Y-offset====
Designates the screen position offset for the Red Alert label

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Red Alert Value Y-offset====
Designates the screen position offset for the Red Alert value (?)

*Syntax: '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Objective notify:|+Objective notify:]]

====Command X-offset:====
*Syntax: '''Integer''' x offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Up Offsets:====
*Syntax: '''Integer''' x offset, '''Integer''' y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Page Down Offsets:====
*Syntax: '''Integer''' x offset, ''' Integer y offset
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Squad Message:|+Squad Message:]]

====Entry Height:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Entry Stagger Width:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Text:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Header Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====List Start Offsets:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Hull X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Name X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Status X-offset:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Ship Name Max Width:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Right-Align Ship Names:====

Used by: [[Hud_gauges.tbl#+Escort View:|+Escort View:]]

====Foreground Clip Height:====

* Sets the height, in pixels, of the gauge.
** For the [[Hud_gauges.tbl#+Throttle|Throttle]], sets the height of the gauge that represents 0% to 100% throttle. The total height of the gauge is the sum of this value and the [[Hud_gauges.tbl#Afterburner Clip Height:|Afterburner Clip Height]] value.
* Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]], [[Hud_gauges.tbl#+ETS Weapons:|+ETS Weapons]], [[Hud_gauges.tbl#+ETS Engines:|+ETS Engines]], [[Hud_gauges.tbl#+ETS Shields:|+ETS Shields]], [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor]], [[Hud_gauges.tbl#+Afterburner Energy|+Afterburner Energy]], [[Hud_gauges.tbl#+Weapon Energy|+Weapon Energy]], [[Hud_gauges.tbl#+Throttle:|+Throttle]]

====Letter Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Top Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Bottom Offsets:====

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Gauge Offset:====
*Distance between the individual weapon/shield/engine ETS gauges that comprise this gauge
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+ETS Retail:|+ETS Retail:]]

====Monitor Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Filename:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Viewport Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Integrity Bar Foreground Clip Height:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Status Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Name Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Class Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Speed Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Hull Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Contents Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Start Offsets:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Cargo Scan Size:====

Used by: [[Hud_gauges.tbl#+Target Monitor:|+Target Monitor:]]

====Bracket Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Dock Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Dock Max Width:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Order Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Order Max Width:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Time Offsets:====

Used by: [[Hud_gauges.tbl#+Extra Target Data:|+Extra Target Data:]]

====Radar Center Offsets:====
Defines the radar's plot origin as an offset, in pixels, from this gauge's [[Hud_gauges.tbl#Position|Position]] coordinates
*Syntax: '''Integer''' horizontal offset, '''Integer''' vertical offset

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Radar Size:====
Size, in pixels, of the radar plot area.

Syntax: '''Integer''' horizontal size, '''Integer''' vertical size

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

====Infinity Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the infinity radar range symbol.

====Long Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the long range radar text (i.e. 10k).

====Short Distance Offsets:====

Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]

Offset to draw the short range radar text (i.e. 2k).

====Size:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XY Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====XZ YZ Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Sweep Disc Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Default Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Unknown Contact Filename:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG:]]

====Loop Volume:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Minimum Beep Delay:====

Used by: [[Hud_gauges.tbl#+Radar BSG:|+Radar BSG]]

====Firepoint display:====
Displays the positions of the gun firepoints on your ship
*Syntax: '''Boolean''', YES or NO

NOTE: The position of the firepoints is calculated from the Eye Point position in the POF. You may encounter weird results if you have no Eye Point defined, but no debug warnings will be raised.

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint size:====
Diameter of the gunpoint circles. '''Must be 4 or greater''' in order to work properly.
*Syntax: '''Integer'''

Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint X coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Firepoint Y coordinate multiplier:====
Used by: [[Hud_gauges.tbl#+Center Reticle:|+Center Reticle]]

====Foreground Clip Bottom Y-offset:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Foreground Clip Width:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Afterburner Clip Height:====
* Sets the area of the throttle gauge that represents the Afterburner segment (which is on top of the 0% to 100% area). The total height of the gauge is determined by the sum of this value and [[Hud_gauges.tbl#Foreground Clip Height:|Foreground Clip Height:]]

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Show Background:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Max Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Min Speed Label Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Center Offsets:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Orbit Radius:====

Used by: [[Hud_gauges.tbl#+Throttle:|+Throttle:]]

====Arc Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Needs to be an [[Multimedia_Files#ANI|ani]] with a least 2 frames (but only the 2nd frame is used ?!?!? for threat & weapon linking so far)

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Needs to be an [[Multimedia_Files#ANI|ani]] with a least 2 frames. The 1st frame is "no warning", the rest of the frames are cycled through when a warning is active.

Internally FSO also refers to this as the "laser threat warning".

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Needs to be an [[Multimedia_Files#ANI|ani]] with a least 2 frames. The 1st frame is "no warning", the rest of the frames are cycled through when a warning is active. Frames cycle twice as fast when a lock has been acquired, compared to when a lock is being acquired.

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Dumbfire Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Offsets:====
*Filename for the background graphic for this gauge
*Syntax: '''Filename'''

Used by: [[Hud_gauges.tbl#+Threat Indicator:|+Threat Indicator:]]

====Lock Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Filename:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Lock Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Locked Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Loop Locked Animation:====

Controls whether the animation should loop after locking on, like in FS1.

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Blink Locked Animation:====

Controls whether the animation should blink after locking on, like in FS2.

Used by: [[Hud_gauges.tbl#+Lock Indicator:|+Lock Indicator:]]

====Radius:====
Defines the distance from the center of the screen to the base of the Hostile Triangle gauge.

*Syntax: '''Integer'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Base:====
Defines the width of the Hostile Triangle's base.

*Syntax: '''Float'''
*Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Triangle Height:====
Defines the height of the Hostile Triangle.

*Syntax: '''Float'''
Default value:
*Units: Pixels

Used by: [[Hud_gauges.tbl#+Hostile Triangle:|+Hostile Triangle:]]

====Center Offsets:====

Used by: [[Hud_gauges.tbl#+Lead Indicator:|+Lead Indicator:]]

====Single Primary Filename:====
Designates the file to use for primary linking for ships with a single primary bank.

Needs to be an [[Multimedia_Files#ANI|ani]] with 2 frames; 1st is bank 1 not selected (not that this should ever be able to happen), 2nd is bank 1 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Filename:====

Designates the file to use for primary linking for ships with two primary banks.

Needs to be an [[Multimedia_Files#ANI|ani]] with 4 frames:
* Frame 0 is no banks selected
* Frame 1 is 1st bank selected
* Frame 2 is 2nd bank selected
* Frame 3 is both banks selected/linked

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Filename:====

Designates the file to use for selected secondary bank for ships with a single secondary bank.

Needs to be an [[Multimedia_Files#ANI|ani]] with 2 frames; 1st is bank 1 not selected, 2nd is bank 1 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Filename:====

Designates the file to use for selected secondary bank for ships with two secondary banks.

Needs to be an [[Multimedia_Files#ANI|ani]] with 3 frames; 1st is no banks selected, 2nd is bank 1 selected, 3rd is bank 2 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Filename:====

Designates the file to use for selected secondary bank for ships with two secondary banks.

Needs to be an [[Multimedia_Files#ANI|ani]] with 4 frames; 1st is no banks selected, 2nd is bank 1 selected, 3rd is bank 2 selected, 4th is bank 3 selected.

Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Primary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Single Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Double Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Triple Secondary Offsets:====
Used by: [[Hud_gauges.tbl#+Weapon Linking:|+Weapon Linking:]]

====Hidden By Comms Menu:====
{{Table3615|
Defines whether the messages gauge may be drawn at the same time as the wingman comms menu.
*Syntax: '''Boolean'''
*Default Value: '''false''' (messages are not visible while the comms menu is open)
Used by: [[Hud_gauges.tbl#+Messages:|+Messages:]]}}

====Bottom Background Offset:====
{{Table3615|
Defines the vertical pixel offset added to the position of the bottom background frame.
*Syntax: '''Integer''' vertical offset
*Units: Pixels
Used by: [[Hud_gauges.tbl#+Damage:|+Damage:]]}}

====Center Text On Gauge X-Position:====
{{Table375|
Sets whether to position the center of the text to the gauge's X-position.
*Syntax '''Boolean'''
*Default Value: '''false''' if the gauge is explicitly given a position, '''true''' otherwise
Used by: [[Hud_gauges.tbl#+Fixed Messages:|+Fixed Messages:]]}}

====Ngon Sides:====
{{Table190|
Defines the number of sides a regular polygon (N-gon) radar has. If defined, the standard radar's edge is drawn as an N-gon, instead of the standard ellipsoid. Blips that are projected outside of the N-gon are snapped to the edge: the blip's angle stays the same but the blip's radius to the center of the plot area is reduced.
*Syntax '''Integer'''
*Default Value: '''0''' A value of 0 means to use the standard ellipsoid radar
*Minimum value: '''3''' (which is a triangle)
Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]}}

====Ngon Offset:====
{{Table190|
Defines the angular offset to apply to the N-gon perimeter. The first vertex is at the 3 o'clock position, positive offsets spin this vertex counter-clockwise, negative offsets spin this clockwise.
*Syntax '''Float''' (radians)
*Default Value: '''0'''
Used by: [[Hud_gauges.tbl#+Radar:|+Radar:]]}}

[[Category:Tables]]

Weapons.tbl

2022-11-11T01:10:42Z

EatThePath: /* $Light color: */

{{TableVersionGit|2022-05-29|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.
*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}}

===$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:'''''}}

===$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'''''

===$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
}}

===$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]]

===$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:===
*Reduces the range to the target where the weapons under AI will start firing from the regular lifetime x velocity calculation. 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 1 -> 0 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}}
*'''+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)

===$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: '''''Integer'''''
**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: '''''Integer'''''
**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.
}}

{{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
}}

===$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]]

==="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}}

==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]]

Frequently Asked Questions (FAQ)

2022-10-09T20:14:58Z

EatThePath: /* Where do I get the Joystick ID's and GUID's? */

This page contains answers to questions that may be asked when playing newer versions of FSO. They are usually questions related to new behaviors not present in older version or vanilla FreeSpace, and are often questions that don't have a simple one-line answer.

===Why are my bindings back to defaults?===
If you created or played with a pilot on FSO 22.0 or later, your bindings were moved into files known as "presets" which are saved in a sub directory of your players folder.

'''Example:''' '''''C:\Users\z64555\AppData\Roaming\HardLightProductions\FreeSpaceOpen\data\players\presets'''''

The reason why your bindings are back to defaults in pre-22.0 version is because:

1. Older versions of FSO still require that the pilot have bindings in them, or else FSO will crash because it doesn't know how to handle a pilot with missing data.

2. To prevent having a new preset generated each time the same pilot is used across pre- and post-22.0 versions of FSO, the bindings within the pilot are forced to the defaults.
* The bindings that were originally saved are still safe within the '''''\presets''''' sub directory.

Related Github issue: [https://github.com/scp-fs2open/fs2open.github.com/issues/3902 Issue 3902]

===Why can't I use my pilot with different versions of FSO?===
Our pilot file handling code has improved over the years to allow new data to be added to the pilot file, but we still haven't managed to get it in a perfect state due to a lack of manpower and interest.

Pilot files might be still usable across different versions of FSO, but this can not be guaranteed at this point in time. When in doubt, it is always recommended that you make a clone of your pilot and use the clone for that version of FSO.

===Can I use multiple joysticks in FSO?===
As of FSO version 22.0, players are now able to assign up to 4 independent joysticks, gamepads, throttles, or game controllers; independently assign the mouse to controls; can assign a primary input binding and a secondary input binding from two different joysticks per control.

In order to make use of this capability, you must use a compatible launcher or manually set the joystick ID and GUID's within your '''fs2_open.ini''' file.

====Where is the fs2_open.ini file?====
This may be found within AppData.

'''Example:''' '''''C:\Users\z64555\AppData\Roaming\HardLightProductions\FreeSpaceOpen\fs2_open.ini'''''

====How do I assign my joysticks in the fs2_open.ini?====
Add the following keys to your .ini, underneath the '''[Default]''' section:

'''''Joy0ID='''''
'''''Joy0GUID='''''
'''''Joy1ID='''''
'''''Joy1GUID='''''
'''''Joy2ID='''''
'''''Joy2GUID='''''
'''''Joy3ID='''''
'''''Joy3GUID='''''

'''Joy0''' is effectively the same as '''CurrentJoystick'''

====Where do I get the Joystick ID's and GUID's?====
{{Note|For best reliability, the GUID's must be obtained from FSO itself, not from any other third-party app.}}

This is the most difficult part of manually assigning the joysticks, depending on your operating system and familiarity with command prompt/ shell. Essentially, you'll want to run FSO with the '''-get_flags json_v1''' commandline flag from the command prompt, power shell, or bash.

'''Example:''' '''''C:\Games\FreespaceOpen\bin\FSO-22.0.0\windows\x64> fs2_open_22_0_0_x64_SSE2.exe -get_flags json_v1 > flags.txt'''''

Keep in mind this is an example only. You will need to change '''FSO-22.0.0''' and '''fs2_open_22_0_0_x64_SSE2.exe''' to fit the version you have installed.

Windows users will probably also need to set the '''FSO_KEEP_STDOUT''' environment variable, due to its tendency to shut down the STDOUT streams to console when the application is identified as a WINDOWS application (as opposed to a CONSOLE application), in which case they should try the following:

'''cmd /V /C "set FSO_KEEP_STDOUT=1&& fs2_open_22_0_0_x64_SSE2.exe -get_flags json_v1 > flags.txt"'''

As above, '''fs2_open_22_0_0_x64_SSE2.exe''' will need to match the actual version you are working with.

Once you have a flags.txt file created, look for a section that looks like this:

{
"joysticks": [
{
"name": "Joystick Name",
"guid": "03000000EFBE00006D04000000000000",
"id": 0,
"device": 0
}
]
}

Use the "guid" and "id" key values to assign that joystick to Joy0, Joy1, Joy2, or Joy3 respectively.

=====Windows Tutorial for obtaining the GUID=====
# Navigate to your FSO installation using File Explorer. If you're using Knossos, then this directory is the same as "Library Path" within Knossos's settings.
# Right click the address bar within File Explorer and "Copy the Address as Text"
# Open the command prompt from the start menu:
#* Open the start menu,
#* Type in "prompt",
#* and then left click on "Command Prompt"
# In the command prompt window, type in "cd /D " (without the quotes), with a space after the D. Then, right click on the command prompt and Paste the address you copied from before. Hit the Enter key to execute the cd command. The prompt should then show the address text again with ">" as the last character to show that its now in that directory.
# In the command prompt, type in "dir" and hit enter to execute the dir command, which should show you a list of all files and folders within the directory. Confirm that your fs2_open.exe is in there.
# Follow the directions outlined in [[#Where do I get the Joystick ID's and GUID's?]], Using the full name of your fs2_open.exe should it differ from the instructions.

Sample Lighting Settings

2022-09-16T22:56:58Z

EatThePath:

{{Table224|
This method of configuring a mod's lighting has been replaced with the [[Lighting_Profiles.tbl]], and these settings do not apply to 22.4 or later. New lighting flags listed in [[Command-Line Reference#Lighting|Command Line Reference]] now mainly serve usability and accessibility reasons, with some legacy support for modifying ambient intensity.}}

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

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

=Modern lighting presets=

==[https://imgur.com/gallery/MshrBKk FrikgFeek's Settings]==

[[Image:Ff lighting 00.png|thumb|A compromise between space darkness and playability.]]
Focusing on star-based lighting with relatively high bloom to help glowpoints illuminate ships. This setting provides a highly contrasting light-darkness look that puts a lot of emphasis on star position. Light and shadow are emphasized and very distinct.
*-ambient_factor 55
*-spec_point 0.7
*-spec_static 2.12
*-spec_tube 1.2
*-bloom_intensity 45
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 55 -spec_point 0.7 -spec_static 2.12 -spec_tube 1.2 -bloom_intensity 45 -no_emissive_light}}

[[Image:Ff lighting 01.png|thumb|Similar idea to the previous setting, adding more ambient to reduce the contrast. Still somewhat dark but never fully black.]]
Omnidirectional ambient lighting is more emphasized while still darker than static lighting. Bloom is reduced to de-emphasize glowpoints. Compared to the previous setting there's a lot less light-dark contrast but overall visibility is improved.
*-ambient_factor 91
*-spec_point 1.2
*-spec_static 0.55
*-spec_tube 1.3
*-bloom_intensity 19
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 91 -spec_point 1.2 -spec_static 0.55 -spec_tube 1.3 -bloom_intensity 19 -no_emissive_light }}

[[Image:Ff lighting 02.png|thumb|Extremely dark setting exclusively focused on glowpoints and dynamic lighting from weapons and beams.]]
This setting contains more screenshots since its look rapidly changes as action happens. Ships switch from very dark to very bright when engaged in combat. The beams also light up nearby fighters. The very high bloom(at least compared to other settings, still reduced from the default setting of 75) provides extremely bright and bleeding flashes of light during explosions, further emphasizing the dynamic nature of this preset.
*-ambient_factor 45
*-spec_point 1.5
*-spec_static 0.7
*-spec_tube 1.8
*-bloom_intensity 56
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 45 -spec_point 1.5 -spec_static 0.7 -spec_tube 1.8 -bloom_intensity 56 -no_emissive_light }}

==Rhymes' Settings==
Generally dark but not pitch-black environments, with a heavy emphasis on lighting from weapons fire and the in-mission sun.
*-ambient_factor 80
*-spec_point 0.3
*-spec_static 2
*-spec_tube 0.7
*-bloom_intensity 10
*-no_emissive_light

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 80 -spec_point 0.3 -spec_static 2 -spec_tube 0.7 -bloom_intensity 10 }}

=Recommended Diaspora Settings=
These are the recommended light settings for Diaspora. For now, you'll only see them available in Diaspora's version of the launcher.
* -ambient_factor 90
* -spec_exp 0.7
* -spec_point 0.7
* -spec_static 1.0
* -spec_tube 1.0
* -ogl_spec 15
* -bloom_intensity 20

{{note|Copy and paste this line into your launcher's custom flags box to make it work: -ambient_factor 90 -spec_exp 0.7 -spec_tube 1.0 -spec_point 0.7 -spec_static 1.0 -ogl_spec 15 -bloom_intensity 20}}

=Deprecated lighting presets=

{{note|These settings are obsolete as of FSO 3.8.0}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[[Category:Source Code Project]]

Command-Line Reference

2022-09-16T22:55:50Z

EatThePath: /* Lighting */

{{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.
}}

====-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===

====-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_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"'''

==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.}}

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

====-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.}}

====-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.

====-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

2022-09-16T22:52:44Z

EatThePath: /* Other */

{{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.
}}

====-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===

====-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_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"'''

==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].
====-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.}}

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

====-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.}}

====-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.

====-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

2022-09-15T01:08:25Z

EatThePath: /* -emissive_light */

{{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.
}}

====-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===

====-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_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"'''

==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].

====-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.

====-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.

====-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.

====-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.

====-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.}}

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

====-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.}}

====-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.

====-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

2022-09-14T23:00:04Z

EatThePath:

{{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|
*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]]
}}

==#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-26T15:35:24Z

EatThePath:

{{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:===
{{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]]

GTF Achilles (Warmachine)

2022-07-13T21:30:45Z

EatThePath: /* Veteran Comments */

{{WMArticle}}

{{shipimage|image=[[Image:AchillesMardukThumb.png]]|link=[[AchillesMardukThumb.PNG]]|caption=GTF Achilles}}

==Description:==

===Warmachine R2 Tech Description===
The GTF Achilles has been the highly public face of the enormous breakthroughs powering the next generation of Alliance technology for the last three years. The Achilles has been shown regularly at official functions and has seen some small-scale action against high profile pirate groups, but procurement programs have not resulted in Morgan Technologies and Destiny Industries providing anywhere near the number of spaceframes the Alliance public is clamoring for. Only small numbers are available for critical missions and on modern Destroyers and installations near potential hot spots even after continual budget increases.

The Achilles’s primary role is as a superheavy interceptor. It’s eight primary afterburners can operate at full power for 25 seconds at significantly higher speeds than any Capella-era interceptor, allowing it to rapidly reposition between hot spots in a chaotic battlespace. Additionally the frame mounts six reverse afterburners for nearly as much thrust backwards, allowing the Achilles to turn and shower pursuers with its withering armament. Full 3d mobility is provided by dozens of reverse and turning thrusters, giving the enormous ship startling nimbleness and the ability to slide and reverse freely.

In support of its mission to quickly destroy any opposition and move on to the next hot spot, the Achilles is equipped with eight high capacity direct fire weapon mounts in two banks of four. Sporting an incredible power supply, the Achilles can dogfight with greater lethality than the GTF Erinyes. The same power plant also supports extensive shielding, allowing the Achilles to survive pitched battles or short engagements alike. For secondary armament, the craft has an internal magazine capable of launching Wraith and Massacre chassis missiles through four launchers, as well as two sets of external pylons compatible with Spectre, Thundercloud, and Shadowhawk missiles. A large articulated belly hardpoint is compatible with either the CATAPULT missile pod or the PASIPHAE-chassis heavy gunpods.

A truly massive fighter, the Achilles measures 28 meters in length and with all surfaces deployed 24.8 meters in width and 9.3 meters in height. It is the product of the TABLET and STYX breakthrough technology programs as well as the SWORDSMAN strike craft development program’s APEX initiative. It is composed of 75% classified material by volume. Unauthorized access to the internals of the ship is strictly prohibited.

The only significant flaw of the Achilles is that in no small part due to its laundry list of features it is an enormous target, but it can survive huge amounts of incoming fire and dish it back out. In comparison to modern craft, the Achilles has slightly stronger armor than the GTF Otrera heavy fighter and stronger shields that recharge more rapidly than the GTF Theia. This ship is designed to provide the kind of fighting capability that the Alliance did not have on Capella’s last, darkest day. Able to bring the fight successfully to any kind of Shivan ship and demonstrating an enormous leap in capabilities compared to the Myrmidon, Ares, and Erinyes spaceframes of the last war, the Achilles is as much a political weapon as it is a military one. It is in fact often showcased alongside those older fighter craft instead of more modern equivalents such as the Otrera, Lampeto, Theia, or Hippolyta. With the Achilles, the leadership of the Alliance has been able to reassure a terrified populace that despite what is common knowledge of the Shivan’s raw strength, the Alliance maintains enough of a technological edge that it can still protect them.

Try not to get it blown up. We need all of these we can get.

===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the greek hero of the Trojan War.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Advanced Space Superiority
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Destiny Industries
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| High
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 2.9, 2.9, 3.2 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 95 - 145 mps forward, 70 mps aft, 45 mps lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 240 mps forward, 170 aft
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| Very High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 445
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 850
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 28.1 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 4
| [[Sarrisa]]
|- align="center"
| 1st
| 4
| [[Enyo]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Amirani]], [[Enyo]], [[Khopesh]], [[Kiya]], [[Makhaira]], [[Sarissa]], [[Xiphos]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 80
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Osiris pod]], [[Hypnos Pod]]
|- align="center"
| 2nd
| 80
| [[Wraith]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Tiamat pod]], [[Marduk Pod]]
|- align="center"
| 3rd
| 96
| [[Spectre]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|- align="center"
| 4th
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|}

===Veteran Comments===
{{comment|The Achilles is power fantasy in fighter form. Able to mount all but the heaviest missiles and with enough banks to bring a variety of tools; if you see it's available you'll probably need it. Don't forget to use its glide and full strafe capabilities}}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

==View on P3D==
* https://p3d.in/IZc04 animations not all implemented in game

GTB Marathon

2022-07-08T04:33:44Z

EatThePath:

{{WMArticle}}

{{shipimage|image=[[Image:WM_Marathon_Thumb.png]]|link=[[WM_Marathon.PNG]]|caption=GTB Marathon (Loud config)}}

==Description:==

===Warmachine R2 Tech Description===
The GTB Marathon is based on the stealth technology first deployed on the Pegasus fighter of the last war. Marathon is an interim craft, taking technologies that were cutting edge in the Second Incursion and bringing them to full maturation. It has been procured in small numbers for the last seven years. Unlike its small predecessor, the Marathon is a large bomber, measuring just under 46m in length and 36m in width, with a height of 12.6m.

The Marathon can be operated in two modes. Primarily it is operated in a stealthy configuration. It can also be flown in a "loud" configuration with better performance and additional weapons. Unlike conventional craft, the ship's afterburners do not provide a sudden burst of high speed in stealth mode. Instead, the Marathon's afterburners provide slow, steady, and most importantly stealthy acceleration over a much longer period of time. It takes half a minute to reach maximum speed while maintaining a stealthy profile, but that speed combined with the stealthy nature of the ship renders it almost physically impossible for this ship to be intercepted before it can strike its target - the Marathon will traverse the window where sensors can detect it in 2.67 seconds.

The Marathon's primary mission is to use stealth to slip into range of larger Shivan ships or installations and unleash specialized Firelance bombs while flying at high speeds and at close range. In support of that role, it has four massive shielded bomb bays. These are backed up by two articulated panels shielding a cluster of six direct fire hardpoints and a front-mounted quad Xiphos turret to provide the ship some self defense means.

While not at all maneuverable, the Marathon does have integrated reverse thrusters and can be flown in non-stealthy configurations where it can take advantage of two additional ventral missile stanchions. The main missile pods can carry a payload of twelve Shadowhawk anti-ship missiles or Firelance bombs. On two winglets midships are four stanchions for a respectable armament of Spectre or Thundercloud missiles. For self defense there is an internal magazine feeding two launchers along the fuselage for Wraith or Massacre missiles. Two hardpoints for mounting individual Sunflare heavy ASMs are on the belly for non-stealthy missions. A minimum crew of two is required to operate the craft, a dedicated pilot and an operator for the extensive ECM and stealth suites. Intended for long sorties there is a spartan - euphemistically referred to as "efficient" in the design documents - internal space for the crew to rest in. Total life support is for a deployment crew of four persons for up to ten days, though most sorties are planned for a crew of two to stretch the loiter length and take advantage of passive stealth to allow the crew to rest. Internal access is from a cramped hatch directly behind the chin Xiphos turret.

The Marathon was designed in the PHILIPPIDES program to be a devastating raiding craft that can be flexibly used as a stealthy precision and medium bomber. As of this writing, the Marathon has been deployed in both roles against non-combat and light fleet assets but has not yet been used against major warships. The PHILIPPIDES program provided for above average subspace maneuverability to aid in quick exfiltration after delivering its payload and wargaming shows that a small number of well-supplied Marathon wings could interdict Shivan convoys with near impunity. In the event of another Shivan incursion, all Marathon wings are expected to be deployed in this role to buy the Alliance as much time as possible to analyze the nature and scope of the threat. Any pilot assigned to these craft can expect to quickly find themselves behind Shivan lines should the enemy return.

===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the site of an important battle in ancient Greece.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Stealth/Strike Bomber
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Nankam Aeronautical
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| Low
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 7.5, 7.4, 7.5 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 80 - 100 mps forward, 20 mps aft, 10 mps lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 190 mps forward
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 375
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 600
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 46 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 3
| [[Xiphos]]
|- align="center"
| 1st
| 3
| [[Xiphos]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Xiphos]], [[Kiya]], [[Makhaira]], [[Sarrisa]], [[Khopesh]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 64
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]]
|- align="center"
| 2nd
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]]
|- align="center"
| 3rd
| 288
| [[Firelance]]
| [[Firelance]], [[Shadowhawk]]
|- align="center"
| 4th (Loud Only)
| 96
| [[Sunflare]]
| [[Sunflare]]
|}

===Veteran Comments===
{{comment|In current tables the Marathon has an unusual afterburner with very long 'run up'. This design is meant for particular kinds of missions and hasn't been well refined yet. You might want to change it for conventional uses. }}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

==View on P3D:==
*https://p3d.in/rPBf3

GTF Achilles (Warmachine)

2022-07-08T04:31:48Z

EatThePath:

{{WMArticle}}

{{shipimage|image=[[Image:AchillesMardukThumb.png]]|link=[[AchillesMardukThumb.PNG]]|caption=GTF Achilles}}

==Description:==

===Warmachine R2 Tech Description===
The GTF Achilles has been the highly public face of the enormous breakthroughs powering the next generation of Alliance technology for the last three years. The Achilles has been shown regularly at official functions and has seen some small-scale action against high profile pirate groups, but procurement programs have not resulted in Morgan Technologies and Destiny Industries providing anywhere near the number of spaceframes the Alliance public is clamoring for. Only small numbers are available for critical missions and on modern Destroyers and installations near potential hot spots even after continual budget increases.

The Achilles’s primary role is as a superheavy interceptor. It’s eight primary afterburners can operate at full power for 25 seconds at significantly higher speeds than any Capella-era interceptor, allowing it to rapidly reposition between hot spots in a chaotic battlespace. Additionally the frame mounts six reverse afterburners for nearly as much thrust backwards, allowing the Achilles to turn and shower pursuers with its withering armament. Full 3d mobility is provided by dozens of reverse and turning thrusters, giving the enormous ship startling nimbleness and the ability to slide and reverse freely.

In support of its mission to quickly destroy any opposition and move on to the next hot spot, the Achilles is equipped with eight high capacity direct fire weapon mounts in two banks of four. Sporting an incredible power supply, the Achilles can dogfight with greater lethality than the GTF Erinyes. The same power plant also supports extensive shielding, allowing the Achilles to survive pitched battles or short engagements alike. For secondary armament, the craft has an internal magazine capable of launching Wraith and Massacre chassis missiles through four launchers, as well as two sets of external pylons compatible with Spectre, Thundercloud, and Shadowhawk missiles. A large articulated belly hardpoint is compatible with either the CATAPULT missile pod or the PASIPHAE-chassis heavy gunpods.

A truly massive fighter, the Achilles measures 28 meters in length and with all surfaces deployed 24.8 meters in width and 9.3 meters in height. It is the product of the TABLET and STYX breakthrough technology programs as well as the SWORDSMAN strike craft development program’s APEX initiative. It is composed of 75% classified material by volume. Unauthorized access to the internals of the ship is strictly prohibited.

The only significant flaw of the Achilles is that in no small part due to its laundry list of features it is an enormous target, but it can survive huge amounts of incoming fire and dish it back out. In comparison to modern craft, the Achilles has slightly stronger armor than the GTF Otrera heavy fighter and stronger shields that recharge more rapidly than the GTF Theia. This ship is designed to provide the kind of fighting capability that the Alliance did not have on Capella’s last, darkest day. Able to bring the fight successfully to any kind of Shivan ship and demonstrating an enormous leap in capabilities compared to the Myrmidon, Ares, and Erinyes spaceframes of the last war, the Achilles is as much a political weapon as it is a military one. It is in fact often showcased alongside those older fighter craft instead of more modern equivalents such as the Otrera, Lampeto, Theia, or Hippolyta. With the Achilles, the leadership of the Alliance has been able to reassure a terrified populace that despite what is common knowledge of the Shivan’s raw strength, the Alliance maintains enough of a technological edge that it can still protect them.

Try not to get it blown up. We need all of these we can get.

===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the greek hero of the Trojan War.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Advanced Space Superiority
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Destiny Industries
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| High
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 2.9, 2.9, 3.2 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 95 - 145 mps forward, 70 mps aft, 45 mps lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 240 mps forward, 170 aft
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| Very High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 445
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 850
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 28.1 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 4
| [[Sarrisa]]
|- align="center"
| 1st
| 4
| [[Enyo]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Amirani]], [[Enyo]], [[Khopesh]], [[Kiya]], [[Makhaira]], [[Sarissa]], [[Xiphos]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 80
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Osiris pod]], [[Hypnos Pod]]
|- align="center"
| 2nd
| 80
| [[Wraith]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Tiamat pod]], [[Marduk Pod]]
|- align="center"
| 3rd
| 96
| [[Spectre]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|- align="center"
| 4th
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|}

===Veteran Comments===
{{comment|The Achilles is power fantasy in fighter form. Able to mount all but the heaviest missiles and with enough banks to bring a variety of tools, if you see it's available you'll probably need it. Don't forget to use its glide and full strafe capabilies}}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

==View on P3D==
* https://p3d.in/IZc04 animations not all implemented in game

GTF Achilles (Warmachine)

2022-07-08T04:31:26Z

EatThePath:

{{WMArticle}}

{{shipimage|image=[[Image:AchillesMardukThumb.png]]|link=[[AchillesMardukThumb.PNG]]|caption=GTF Achilles}}

==Description:==

===Warmachine R2 Tech Description===
The GTF Achilles has been the highly public face of the enormous breakthroughs powering the next generation of Alliance technology for the last three years. The Achilles has been shown regularly at official functions and has seen some small-scale action against high profile pirate groups, but procurement programs have not resulted in Morgan Technologies and Destiny Industries providing anywhere near the number of spaceframes the Alliance public is clamoring for. Only small numbers are available for critical missions and on modern Destroyers and installations near potential hot spots even after continual budget increases.

The Achilles’s primary role is as a superheavy interceptor. It’s eight primary afterburners can operate at full power for 25 seconds at significantly higher speeds than any Capella-era interceptor, allowing it to rapidly reposition between hot spots in a chaotic battlespace. Additionally the frame mounts six reverse afterburners for nearly as much thrust backwards, allowing the Achilles to turn and shower pursuers with its withering armament. Full 3d mobility is provided by dozens of reverse and turning thrusters, giving the enormous ship startling nimbleness and the ability to slide and reverse freely.

In support of its mission to quickly destroy any opposition and move on to the next hot spot, the Achilles is equipped with eight high capacity direct fire weapon mounts in two banks of four. Sporting an incredible power supply, the Achilles can dogfight with greater lethality than the GTF Erinyes. The same power plant also supports extensive shielding, allowing the Achilles to survive pitched battles or short engagements alike. For secondary armament, the craft has an internal magazine capable of launching Wraith and Massacre chassis missiles through four launchers, as well as two sets of external pylons compatible with Spectre, Thundercloud, and Shadowhawk missiles. A large articulated belly hardpoint is compatible with either the CATAPULT missile pod or the PASIPHAE-chassis heavy gunpods.

A truly massive fighter, the Achilles measures 28 meters in length and with all surfaces deployed 24.8 meters in width and 9.3 meters in height. It is the product of the TABLET and STYX breakthrough technology programs as well as the SWORDSMAN strike craft development program’s APEX initiative. It is composed of 75% classified material by volume. Unauthorized access to the internals of the ship is strictly prohibited.

The only significant flaw of the Achilles is that in no small part due to its laundry list of features it is an enormous target, but it can survive huge amounts of incoming fire and dish it back out. In comparison to modern craft, the Achilles has slightly stronger armor than the GTF Otrera heavy fighter and stronger shields that recharge more rapidly than the GTF Theia. This ship is designed to provide the kind of fighting capability that the Alliance did not have on Capella’s last, darkest day. Able to bring the fight successfully to any kind of Shivan ship and demonstrating an enormous leap in capabilities compared to the Myrmidon, Ares, and Erinyes spaceframes of the last war, the Achilles is as much a political weapon as it is a military one. It is in fact often showcased alongside those older fighter craft instead of more modern equivalents such as the Otrera, Lampeto, Theia, or Hippolyta. With the Achilles, the leadership of the Alliance has been able to reassure a terrified populace that despite what is common knowledge of the Shivan’s raw strength, the Alliance maintains enough of a technological edge that it can still protect them.

Try not to get it blown up. We need all of these we can get.

===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the greek hero of the Trojan War.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Advanced Space Superiority
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Destiny Industries
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| High
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 2.9, 2.9, 3.2 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 95 - 145 mps forward, 70 mps aft, 45 mps lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 240 mps forward, 170 aft
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| Very High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 445
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 850
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 28.1 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 4
| [[Sarrisa]]
|- align="center"
| 1st
| 4
| [[Enyo]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Amirani]], [[Enyo]], [[Khopesh]], [[Kiya]], [[Makhaira]], [[Sarissa]], [[Xiphos]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 80
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Osiris pod]], [[Hypnos Pod]]
|- align="center"
| 2nd
| 80
| [[Wraith]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Tiamat pod]], [[Marduk Pod]]
|- align="center"
| 3rd
| 96
| [[Spectre]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|- align="center"
| 4th
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|}

===Veteran Comments===
{{comment|The Achilles is power fantasy in fighter form. Able to mount all but the heaviest missiles and with enough banks to bring a variety of tools, if you see it's available you'll probably need it. Don't forget to use its glide and full strafe capabilies}}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

==View on P3D==
* https://fsnebula.org/mod/Warmachine animations not all implemented in game

https://p3d.in/IZc04

Achilles

2022-07-08T03:55:45Z

EatThePath: Created page with "{{DisambiguationScreens|screen1=GTIAchilles_HTL.jpg| screen1cap=The TI Achilles| screen2=GTFAchilles.jpg| screen2cap=The Earth Defense GTF Achilles| screen3=AchillesMa..."

{{DisambiguationScreens|screen1=GTIAchilles_HTL.jpg| screen1cap=The [[TI Achilles]]| screen2=GTFAchilles.jpg| screen2cap=The Earth Defense [[GTF Achilles]]| screen3=AchillesMardukThumb.png| screen3cap=The Warmachine [[GTF_Achilles_(Warmachine)|GTF Achilles]]}} 
*[[TI Achilles]] - a [[Terran]] installation originally by Woomeister, updated by Nyctaeus
*[[GTF Achilles]] - a [[Terran]] fighter made by Petrev and Freespaceking
*[[GTF Achilles (Warmachine)]] - a [[Terran]] fighter made by Talhydras

GTB Marathon

2022-07-07T00:16:44Z

EatThePath:

{{WMArticle}}

{{shipimage|image=[[Image:WM_Marathon_Thumb.png]]|link=[[WM_Marathon.PNG]]|caption=GTB Marathon (Loud config)}}

==Description:==

===Warmachine R2 Tech Description===
The GTB Marathon is based on the stealth technology first deployed on the Pegasus fighter of the last war. Marathon is an interim craft, taking technologies that were cutting edge in the Second Incursion and bringing them to full maturation. It has been procured in small numbers for the last seven years. Unlike its small predecessor, the Marathon is a large bomber, measuring just under 46m in length and 36m in width, with a height of 12.6m.

The Marathon can be operated in two modes. Primarily it is operated in a stealthy configuration. It can also be flown in a "loud" configuration with better performance and additional weapons. Unlike conventional craft, the ship's afterburners do not provide a sudden burst of high speed in stealth mode. Instead, the Marathon's afterburners provide slow, steady, and most importantly stealthy acceleration over a much longer period of time. It takes half a minute to reach maximum speed while maintaining a stealthy profile, but that speed combined with the stealthy nature of the ship renders it almost physically impossible for this ship to be intercepted before it can strike its target - the Marathon will traverse the window where sensors can detect it in 2.67 seconds.

The Marathon's primary mission is to use stealth to slip into range of larger Shivan ships or installations and unleash specialized Firelance bombs while flying at high speeds and at close range. In support of that role, it has four massive shielded bomb bays. These are backed up by two articulated panels shielding a cluster of six direct fire hardpoints and a front-mounted quad Xiphos turret to provide the ship some self defense means.

While not at all maneuverable, the Marathon does have integrated reverse thrusters and can be flown in non-stealthy configurations where it can take advantage of two additional ventral missile stanchions. The main missile pods can carry a payload of twelve Shadowhawk anti-ship missiles or Firelance bombs. On two winglets midships are four stanchions for a respectable armament of Spectre or Thundercloud missiles. For self defense there is an internal magazine feeding two launchers along the fuselage for Wraith or Massacre missiles. Two hardpoints for mounting individual Sunflare heavy ASMs are on the belly for non-stealthy missions. A minimum crew of two is required to operate the craft, a dedicated pilot and an operator for the extensive ECM and stealth suites. Intended for long sorties there is a spartan - euphemistically referred to as "efficient" in the design documents - internal space for the crew to rest in. Total life support is for a deployment crew of four persons for up to ten days, though most sorties are planned for a crew of two to stretch the loiter length and take advantage of passive stealth to allow the crew to rest. Internal access is from a cramped hatch directly behind the chin Xiphos turret.

The Marathon was designed in the PHILIPPIDES program to be a devastating raiding craft that can be flexibly used as a stealthy precision and medium bomber. As of this writing, the Marathon has been deployed in both roles against non-combat and light fleet assets but has not yet been used against major warships. The PHILIPPIDES program provided for above average subspace maneuverability to aid in quick exfiltration after delivering its payload and wargaming shows that a small number of well-supplied Marathon wings could interdict Shivan convoys with near impunity. In the event of another Shivan incursion, all Marathon wings are expected to be deployed in this role to buy the Alliance as much time as possible to analyze the nature and scope of the threat. Any pilot assigned to these craft can expect to quickly find themselves behind Shivan lines should the enemy return.

===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the site of an important battle in ancient Greece.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Stealth/Strike Bomber
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Nankam Aeronautical
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| Low
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 7.5, 7.4, 7.5 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 80 - 100 mps forward, 20 mbps aft, 10 mpbs lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 190 mps forward
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 375
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 600
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 46 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 3
| [[Xiphos]]
|- align="center"
| 1st
| 3
| [[Xiphos]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Xiphos]], [[Kiya]], [[Makhaira]], [[Sarrisa]], [[Khopesh]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 64
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]]
|- align="center"
| 2nd
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]]
|- align="center"
| 3rd
| 288
| [[Firelance]]
| [[Firelance]], [[Shadowhawk]]
|- align="center"
| 4th (Loud Only)
| 96
| [[Sunflare]]
| [[Sunflare]]
|}

===Veteran Comments===
{{comment|In current tables the Marathon has an unusual afterburner with very long 'run up'. This design is meant for particular kinds of missions and hasn't been well refined yet. You might want to change it for conventual uses. }}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

GTB Marathon

2022-07-07T00:15:08Z

EatThePath:

{{WMArticle}}

{{shipimage|image=[[Image:WM_Marathon_Thumb.png]]|link=[[WM_Marathon.PNG]]|caption=GTF Achilles}}

==Description:==

===Warmachine R2 Tech Description===
The GTB Marathon is based on the stealth technology first deployed on the Pegasus fighter of the last war. Marathon is an interim craft, taking technologies that were cutting edge in the Second Incursion and bringing them to full maturation. It has been procured in small numbers for the last seven years. Unlike its small predecessor, the Marathon is a large bomber, measuring just under 46m in length and 36m in width, with a height of 12.6m.

The Marathon can be operated in two modes. Primarily it is operated in a stealthy configuration. It can also be flown in a "loud" configuration with better performance and additional weapons. Unlike conventional craft, the ship's afterburners do not provide a sudden burst of high speed in stealth mode. Instead, the Marathon's afterburners provide slow, steady, and most importantly stealthy acceleration over a much longer period of time. It takes half a minute to reach maximum speed while maintaining a stealthy profile, but that speed combined with the stealthy nature of the ship renders it almost physically impossible for this ship to be intercepted before it can strike its target - the Marathon will traverse the window where sensors can detect it in 2.67 seconds.

The Marathon's primary mission is to use stealth to slip into range of larger Shivan ships or installations and unleash specialized Firelance bombs while flying at high speeds and at close range. In support of that role, it has four massive shielded bomb bays. These are backed up by two articulated panels shielding a cluster of six direct fire hardpoints and a front-mounted quad Xiphos turret to provide the ship some self defense means.

While not at all maneuverable, the Marathon does have integrated reverse thrusters and can be flown in non-stealthy configurations where it can take advantage of two additional ventral missile stanchions. The main missile pods can carry a payload of twelve Shadowhawk anti-ship missiles or Firelance bombs. On two winglets midships are four stanchions for a respectable armament of Spectre or Thundercloud missiles. For self defense there is an internal magazine feeding two launchers along the fuselage for Wraith or Massacre missiles. Two hardpoints for mounting individual Sunflare heavy ASMs are on the belly for non-stealthy missions. A minimum crew of two is required to operate the craft, a dedicated pilot and an operator for the extensive ECM and stealth suites. Intended for long sorties there is a spartan - euphemistically referred to as "efficient" in the design documents - internal space for the crew to rest in. Total life support is for a deployment crew of four persons for up to ten days, though most sorties are planned for a crew of two to stretch the loiter length and take advantage of passive stealth to allow the crew to rest. Internal access is from a cramped hatch directly behind the chin Xiphos turret.

The Marathon was designed in the PHILIPPIDES program to be a devastating raiding craft that can be flexibly used as a stealthy precision and medium bomber. As of this writing, the Marathon has been deployed in both roles against non-combat and light fleet assets but has not yet been used against major warships. The PHILIPPIDES program provided for above average subspace maneuverability to aid in quick exfiltration after delivering its payload and wargaming shows that a small number of well-supplied Marathon wings could interdict Shivan convoys with near impunity. In the event of another Shivan incursion, all Marathon wings are expected to be deployed in this role to buy the Alliance as much time as possible to analyze the nature and scope of the threat. Any pilot assigned to these craft can expect to quickly find themselves behind Shivan lines should the enemy return.

===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the site of an important battle in ancient Greece.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Stealth/Strike Bomber
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Nankam Aeronautical
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| Low
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 7.5, 7.4, 7.5 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 80 - 100 mps forward, 20 mbps aft, 10 mpbs lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 190 mps forward
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 375
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 600
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 46 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 3
| [[Xiphos]]
|- align="center"
| 1st
| 3
| [[Xiphos]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Xiphos]], [[Kiya]], [[Makhaira]], [[Sarrisa]], [[Khopesh]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 64
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]]
|- align="center"
| 2nd
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]]
|- align="center"
| 3rd
| 288
| [[Firelance]]
| [[Firelance]], [[Shadowhawk]]
|- align="center"
| 4th (Loud Only)
| 96
| [[Sunflare]]
| [[Sunflare]]
|}

===Veteran Comments===
{{comment|In current tables the Marathon has an unusual afterburner with very long 'run up'. This design is meant for particular kinds of missions and hasn't been well refined yet. You might want to change it for conventual uses. }}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

GTB Marathon

2022-07-07T00:14:04Z

EatThePath: Created page with "{{WMArticle}} {{shipimage|image=Image:WM_Marathon_Thumb.png|link=WM_Marathon.PNG|caption=GTF Achilles}} ==Description:== ===Warmachine R2 Tech Description=== The GT..."

{{WMArticle}}

{{shipimage|image=[[Image:WM_Marathon_Thumb.png]]|link=[[WM_Marathon.PNG]]|caption=GTF Achilles}}

==Description:==

===Warmachine R2 Tech Description===
The GTB Marathon is based on the stealth technology first deployed on the Pegasus fighter of the last war. Marathon is an interim craft, taking technologies that were cutting edge in the Second Incursion and bringing them to full maturation. It has been procured in small numbers for the last seven years. Unlike its small predecessor, the Marathon is a large bomber, measuring just under 46m in length and 36m in width, with a height of 12.6m.

The Marathon can be operated in two modes. Primarily it is operated in a stealthy configuration. It can also be flown in a "loud" configuration with better performance and additional weapons. Unlike conventional craft, the ship's afterburners do not provide a sudden burst of high speed in stealth mode. Instead, the Marathon's afterburners provide slow, steady, and most importantly stealthy acceleration over a much longer period of time. It takes half a minute to reach maximum speed while maintaining a stealthy profile, but that speed combined with the stealthy nature of the ship renders it almost physically impossible for this ship to be intercepted before it can strike its target - the Marathon will traverse the window where sensors can detect it in 2.67 seconds.

The Marathon's primary mission is to use stealth to slip into range of larger Shivan ships or installations and unleash specialized Firelance bombs while flying at high speeds and at close range. In support of that role, it has four massive shielded bomb bays. These are backed up by two articulated panels shielding a cluster of six direct fire hardpoints and a front-mounted quad Xiphos turret to provide the ship some self defense means.

While not at all maneuverable, the Marathon does have integrated reverse thrusters and can be flown in non-stealthy configurations where it can take advantage of two additional ventral missile stanchions. The main missile pods can carry a payload of twelve Shadowhawk anti-ship missiles or Firelance bombs. On two winglets midships are four stanchions for a respectable armament of Spectre or Thundercloud missiles. For self defense there is an internal magazine feeding two launchers along the fuselage for Wraith or Massacre missiles. Two hardpoints for mounting individual Sunflare heavy ASMs are on the belly for non-stealthy missions. A minimum crew of two is required to operate the craft, a dedicated pilot and an operator for the extensive ECM and stealth suites. Intended for long sorties there is a spartan - euphemistically referred to as "efficient" in the design documents - internal space for the crew to rest in. Total life support is for a deployment crew of four persons for up to ten days, though most sorties are planned for a crew of two to stretch the loiter length and take advantage of passive stealth to allow the crew to rest. Internal access is from a cramped hatch directly behind the chin Xiphos turret.

The Marathon was designed in the PHILIPPIDES program to be a devastating raiding craft that can be flexibly used as a stealthy precision and medium bomber. As of this writing, the Marathon has been deployed in both roles against non-combat and light fleet assets but has not yet been used against major warships. The PHILIPPIDES program provided for above average subspace maneuverability to aid in quick exfiltration after delivering its payload and wargaming shows that a small number of well-supplied Marathon wings could interdict Shivan convoys with near impunity. In the event of another Shivan incursion, all Marathon wings are expected to be deployed in this role to buy the Alliance as much time as possible to analyze the nature and scope of the threat. Any pilot assigned to these craft can expect to quickly find themselves behind Shivan lines should the enemy return.

===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the site of an important battle in ancient Greece.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Stealth/Strike Bomber
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Nankam Aeronautical
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| High
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 7.5, 7.4, 7.5 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 80 - 100 mps forward, 20 mbps aft, 10 mpbs lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 190 mps forward
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| Very High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 375
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 600
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 46 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 3
| [[Xiphos]]
|- align="center"
| 1st
| 3
| [[Xiphos]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Xiphos]], [[Kiya]], [[Makhaira]], [[Sarrisa]], [[Khopesh]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 64
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]]
|- align="center"
| 2nd
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]]
|- align="center"
| 3rd
| 288
| [[Firelance]]
| [[Firelance]], [[Shadowhawk]]
|- align="center"
| 4th (Loud Only)
| 96
| [[Sunflare]]
| [[Sunflare]]
|}

===Veteran Comments===
{{comment|In current tables the Marathon has an unusual afterburner with very long 'run up'. This design is meant for particular kinds of missions and hasn't been well refined yet. You might want to change it for conventual uses. }}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

File:WM Marathon Thumb.png

2022-07-07T00:13:35Z

EatThePath:

File:WM Marathon.PNG

2022-07-07T00:13:17Z

EatThePath:

Lighting Profiles.tbl

2022-06-12T03:31:49Z

EatThePath:

{{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|
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 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]]

Weapons.tbl

2022-06-06T00:50:55Z

EatThePath:

{{TableVersionGit|2022-05-29|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 otherwies }}

===$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.
*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}}

===$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:'''''}}

===$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'''''

===$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
}}

===$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]]

===$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:===
*Defines the range to the target where the weapons under AI will start firing. 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.
*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 1 -> 0 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}}
*'''+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)

===$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: '''''Integer'''''
**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: '''''Integer'''''
**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.
}}

{{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
}}

===$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]]

==="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 to use this weapon only on capital ships}}

==="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}}

==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

2022-06-06T00:02:21Z

EatThePath:

{{SCP_table}}
{{TableVersionGit|2021-12-02|c5410c6}}
{{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|
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 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]]

Lighting Profiles.tbl

2022-06-06T00:01:50Z

EatThePath:

{{SCP_table}}
{{TableVersionGit|2021-12-02|c5410c6}}
{{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|
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 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]]
}}

==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'''''
}}

==#END DEFAULT PROFILE==
{{Table220|
Required to close the default profile section.
}}
==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]]

GTF Achilles (Warmachine)

2022-05-31T20:25:24Z

EatThePath: /* Warmachine R2 Tech Description */

{{WMArticle}}

{{shipimage|image=[[Image:AchillesMardukThumb.png]]|link=[[AchillesMardukThumb.PNG]]|caption=GTF Achilles}}

==Description:==

===Warmachine R2 Tech Description===
The GTF Achilles has been the highly public face of the enormous breakthroughs powering the next generation of Alliance technology for the last three years. The Achilles has been shown regularly at official functions and has seen some small-scale action against high profile pirate groups, but procurement programs have not resulted in Morgan Technologies and Destiny Industries providing anywhere near the number of spaceframes the Alliance public is clamoring for. Only small numbers are available for critical missions and on modern Destroyers and installations near potential hot spots even after continual budget increases.

The Achilles’s primary role is as a superheavy interceptor. It’s eight primary afterburners can operate at full power for 25 seconds at significantly higher speeds than any Capella-era interceptor, allowing it to rapidly reposition between hot spots in a chaotic battlespace. Additionally the frame mounts six reverse afterburners for nearly as much thrust backwards, allowing the Achilles to turn and shower pursuers with its withering armament. Full 3d mobility is provided by dozens of reverse and turning thrusters, giving the enormous ship startling nimbleness and the ability to slide and reverse freely.

In support of its mission to quickly destroy any opposition and move on to the next hot spot, the Achilles is equipped with eight high capacity direct fire weapon mounts in two banks of four. Sporting an incredible power supply, the Achilles can dogfight with greater lethality than the GTF Erinyes. The same power plant also supports extensive shielding, allowing the Achilles to survive pitched battles or short engagements alike. For secondary armament, the craft has an internal magazine capable of launching Wraith and Massacre chassis missiles through four launchers, as well as two sets of external pylons compatible with Spectre, Thundercloud, and Shadowhawk missiles. A large articulated belly hardpoint is compatible with either the CATAPULT missile pod or the PASIPHAE-chassis heavy gunpods.

A truly massive fighter, the Achilles measures 28 meters in length and with all surfaces deployed 24.8 meters in width and 9.3 meters in height. It is the product of the TABLET and STYX breakthrough technology programs as well as the SWORDSMAN strike craft development program’s APEX initiative. It is composed of 75% classified material by volume. Unauthorized access to the internals of the ship is strictly prohibited.

The only significant flaw of the Achilles is that in no small part due to its laundry list of features it is an enormous target, but it can survive huge amounts of incoming fire and dish it back out. In comparison to modern craft, the Achilles has slightly stronger armor than the GTF Otrera heavy fighter and stronger shields that recharge more rapidly than the GTF Theia. This ship is designed to provide the kind of fighting capability that the Alliance did not have on Capella’s last, darkest day. Able to bring the fight successfully to any kind of Shivan ship and demonstrating an enormous leap in capabilities compared to the Myrmidon, Ares, and Erinyes spaceframes of the last war, the Achilles is as much a political weapon as it is a military one. It is in fact often showcased alongside those older fighter craft instead of more modern equivalents such as the Otrera, Lampeto, Theia, or Hippolyta. With the Achilles, the leadership of the Alliance has been able to reassure a terrified populace that despite what is common knowledge of the Shivan’s raw strength, the Alliance maintains enough of a technological edge that it can still protect them.

Try not to get it blown up. We need all of these we can get.

===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the greek hero of the Trojan War.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Advanced Space Superiority
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Destiny Industries
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| High
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 2.9, 2.9, 3.2 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 95 - 145 mps forward, 70 mbps aft, 45 mpbs lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 240 mps forward, 170 aft
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| Very High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 445
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 850
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 28.1 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 4
| [[Sarrisa]]
|- align="center"
| 1st
| 4
| [[Enyo]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Amirani]], [[Enyo]], [[Khopesh]], [[Kiya]], [[Makhaira]], [[Sarissa]], [[Xiphos]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 80
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Osiris pod]], [[Hypnos Pod]]
|- align="center"
| 2nd
| 80
| [[Wraith]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Tiamat pod]], [[Marduk Pod]]
|- align="center"
| 3rd
| 96
| [[Spectre]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|- align="center"
| 4th
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|}

===Veteran Comments===
{{comment|The Achilles is power fantasy in fighter form. Able to mount all but the heaviest missiles and with enough banks to bring a variety of tools, if you see it's available you'll probably need it. Don't forget to use its glide and full strafe capabilies}}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

GTF Achilles (Warmachine)

2022-05-31T03:03:19Z

EatThePath:

{{WMArticle}}

{{shipimage|image=[[Image:AchillesMardukThumb.png]]|link=[[AchillesMardukThumb.PNG]]|caption=GTF Achilles}}

==Description:==

===Warmachine R2 Tech Description===
A truly massive fighter, the Achilles is composed of 75% classified material by volume. All the panels marked CLASSIFICATION LEVEL: UPSILON, or TABLET-STYX PROGRAM are backed up by this ship's full marine contingent and that's before flight ops gets their hands on you if you ruin their opportunity to work on the latest and greatest. All we know for sure is that the Achilles possesses massive firepower, a combination of internal missile bays and external mounting points, and has both durable armor and a shield that can shrug off damage like a Seraphim. All of that pales to the powerful thrusters, and something Destiny Industries and Morgan Technologies has been cooking up is powering those thrusters because the Achilles has full three-D acceleration and can afterburn for ages. The Achilles is an enormous target, but can survive all that incoming fire and dish it back out. This thing can run rings around the Perseus interceptor while loaded down with a battery of antiship missiles and those heavy Enyo cannons. If it's an option, consider taking it or the Ishtar.

Try not to get it blown up, there aren't very many of these fighters.
===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the greek hero of the Trojan War.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Advanced Space Superiority
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Destiny Industries
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| High
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 2.9, 2.9, 3.2 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 95 - 145 mps forward, 70 mbps aft, 45 mpbs lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 240 mps forward, 170 aft
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| Very High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 445
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 850
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 28.1 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 4
| [[Sarrisa]]
|- align="center"
| 1st
| 4
| [[Enyo]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Amirani]], [[Enyo]], [[Khopesh]], [[Kiya]], [[Makhaira]], [[Sarissa]], [[Xiphos]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 80
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Osiris pod]], [[Hypnos Pod]]
|- align="center"
| 2nd
| 80
| [[Wraith]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Tiamat pod]], [[Marduk Pod]]
|- align="center"
| 3rd
| 96
| [[Spectre]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|- align="center"
| 4th
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|}

===Veteran Comments===
{{comment|The Achilles is power fantasy in fighter form. Able to mount all but the heaviest missiles and with enough banks to bring a variety of tools, if you see it's available you'll probably need it. Don't forget to use it's glide and full strafe capabilies}}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

File:AchillesMardukThumb.png

2022-05-31T03:02:03Z

EatThePath:

GTF Achilles (Warmachine)

2022-05-31T02:59:52Z

EatThePath: Created page with "{{WMArticle}} {{shipimage|image=Image:AchillesMarduk.png|caption=GTF Achilles}} ==Description:== ===Warmachine R2 Tech Description=== A truly massive fighter, the Achil..."

{{WMArticle}}

{{shipimage|image=[[Image:AchillesMarduk.png]]|caption=GTF Achilles}}

==Description:==

===Warmachine R2 Tech Description===
A truly massive fighter, the Achilles is composed of 75% classified material by volume. All the panels marked CLASSIFICATION LEVEL: UPSILON, or TABLET-STYX PROGRAM are backed up by this ship's full marine contingent and that's before flight ops gets their hands on you if you ruin their opportunity to work on the latest and greatest. All we know for sure is that the Achilles possesses massive firepower, a combination of internal missile bays and external mounting points, and has both durable armor and a shield that can shrug off damage like a Seraphim. All of that pales to the powerful thrusters, and something Destiny Industries and Morgan Technologies has been cooking up is powering those thrusters because the Achilles has full three-D acceleration and can afterburn for ages. The Achilles is an enormous target, but can survive all that incoming fire and dish it back out. This thing can run rings around the Perseus interceptor while loaded down with a battery of antiship missiles and those heavy Enyo cannons. If it's an option, consider taking it or the Ishtar.

Try not to get it blown up, there aren't very many of these fighters.
===Credits List===
*Produced by '''Talhydras'''
===Name Origin===
Named after the greek hero of the Trojan War.
==Performance:==

===Warmachine R2===
{|
|-
| style="width:200px" | '''[[Technical_Terms_and_Definitions#Type|Type]]'''
| style="width:200px" | Advanced Space Superiority
|-
| '''[[Technical_Terms_and_Definitions#Manufacturer|Manufacturer]]'''
| Destiny Industries
|-
| '''[[Technical_Terms_and_Definitions#Maneuverablity|Maneuverability]]'''
| High
|-
| '''[[Technical_Terms_and_Definitions#Yaw, Pitch, Roll|Yaw, Pitch, Roll]]'''
| 2.9, 2.9, 3.2 s
|-
| '''[[Technical_Terms_and_Definitions#Max Velocity|Max Velocity]]'''
| 95 - 145 mps forward, 70 mbps aft, 45 mpbs lateral
|-
| '''[[Technical_Terms_and_Definitions#Max Afterburner Velocity|Max Afterburner Velocity]]'''
| 240 mps forward, 170 aft
|-
| '''[[Technical_Terms_and_Definitions#Armor|Armor]]'''
| Very High
|-
| [[Technical_Terms_and_Definitions#Hitpoints|Hitpoints]]
| 445
|-
| [[Technical_Terms_and_Definitions#Shields|Shields]]
| 850
|-
| '''[[Technical_Terms_and_Definitions#Length|Length]]'''
| 28.1 m
|}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Gun Mounts|Gun Mounts]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=3 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Guns
| style="width:160px" |Standard Loadout
|- align="center"
|- align="center"
| 1st
| 4
| [[Sarrisa]]
|- align="center"
| 1st
| 4
| [[Enyo]]
|- align="center"
|- align="center"
| colspan=3| Compatible Primaries
|-align="center"

| colspan=3| [[Amirani]], [[Enyo]], [[Khopesh]], [[Kiya]], [[Makhaira]], [[Sarissa]], [[Xiphos]]
|}

*'''[[Technical_Terms_and_Definitions#Missile Banks|Missile Banks]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=4 style="background:#701919;"| '''Warmachine'''
|- align="center"
| style="width:40px" |Bank
| style="width:60px" |Capacity
| style="width:160px" |Standard
| style="width:340px" |Compatible
|- align="center"
| 1st
| 80
| [[Massacre]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Osiris pod]], [[Hypnos Pod]]
|- align="center"
| 2nd
| 80
| [[Wraith]]
| [[Massacre]], [[Regret]], [[Wraith]], [[Tiamat pod]], [[Marduk Pod]]
|- align="center"
| 3rd
| 96
| [[Spectre]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|- align="center"
| 4th
| 96
| [[Thundercloud]]
| [[Spectre]], [[Phantom]], [[Thundercloud]], [[Shadowhawk]]
|}

===Veteran Comments===
{{comment|The Achilles is power fantasy in fighter form. Able to mount all but the heaviest missiles and with enough banks to bring a variety of tools, if you see it's available you'll probably need it. Don't forget to use it's glide and full strafe capabilies}}

==Download link:==
*Warmachine: https://fsnebula.org/mod/Warmachine

File:AchillesMarduk.PNG

2022-05-31T02:59:35Z

EatThePath: GTF Achilles mounting a Marduk weapon pod

== Summary ==
GTF Achilles mounting a Marduk weapon pod

Template:WMArticle

2022-05-31T02:28:27Z

EatThePath: Created page with "link=Warmachine {| border=0 align=center cellpadding=0 cellspacing=10 width=512px style="margin: 1 1 1em 1em; background: #000000; borde..."

[[File:WarmachineBannerKN.png|center|link=Warmachine]]
{| border=0 align=center cellpadding=0 cellspacing=10 width=512px style="margin: 1 1 1em 1em; background: #000000; border: 1px #000 solid; border-collapse: collapse; font-size: 100%;"
|- align = "center"
! style="color: white; height: 25px; background: #000; 100%;"|'''''The following information pertains to the [[Warmachine]] mod and is not canon to either Freespace or [[Blue Planet]]'''''
|-
|}
<includeonly>{{#ifeq:{{FULLPAGENAME}}|Category:Warmachine||[[Category:Warmachine|{{PAGENAME}}]]}}[[Category:Non-canon]]</includeonly>
<noinclude>[[Category:Templates|WMArticle]]</noinclude>

File:WarmachineBannerKN.png

2022-05-31T02:27:16Z

EatThePath: Big warmachine banner

== Summary ==
Big warmachine banner

Sounds.tbl

2022-05-24T04:40:03Z

EatThePath: /* +Limit: */

{{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'''

==Sample==
*Retail FreeSpace 2 table

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

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

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

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

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

#Flyby Sounds End
</pre>

[[Category:Tables]]

Universal Truth

2022-04-29T17:09:28Z

EatThePath: Undo revision 63746 by Androgeos Exeunt (talk) - Checked both mission file and in play, and Alpha 1 is not in an Ares by default.

{{BPArticle}}

:''This article is about the Blue Planet: Age of Aquarius mission. You may be looking for [[Universal Truth (WiH)|the Blue Planet: War in Heaven mission with the same name]].''

{{Mission|previous=A Time for Heroes|next=Journey's End|campaign=Blue Planet: Age of Aquarius Campaign Walkthrough}}

'''MISSION 22'''

'''Fighter squadron:''' [[222nd Nightwolves]]

'''Description:''' The 14th Battlegroup attempts to jump through the Delta Serpentis-Sol jump node and replicate the conditions that brought them to this universe in an attempt to go home.

----
==Background==
The ''Fortune'' and ''Solace'' have used up most of their supplies in order to sustain the fighting capabilities of the 14th Battlegroup and repair ships damaged in Shivan attacks. The entire fleet now risks running out of supplies with nowhere to go for help. For this reason, Admiral Bei has decided that the fleet will make its way back to the [[Delta Serpentis]]-[[Sol]] jump node. He is confident that, if the conditions for their original jump to Sol were replicated, the fleet will make it back to their home universe.

Admiral Bei has also sent a private communique addressed to you only. After speaking to Rear-Admiral Carey, Commanding Officer of the [[GTD Temeraire|GTD ''Temeraire'']], he decided not to submit you for court-martial for insubordination, disobedience and desertion, reasoning that because it is unknown how Vishnan psychic influence affects your sense of judgement and because of supporting evidence from your two wingmen, Corey and Taylor, your actions may not have been of sound judgement. That, officially, is his reason.

The admiral, however, acknowledges the amount of courage it required for you, a former Commander, to lead an entire fleet of [[Vishnans|Vishnan]] ships, including [[Vishnan Sacred Keeper|a destroyer approaching juggernaut specifications]], into [[Delta Serpentis]] and guide them into aiding the [[GTD Orestes|''Orestes'']] and her battlegroup in their time of need. That is one of his two unofficial reasons.

Concluding the communique, Admiral Bei's other unofficial reason is this: While he openly treats your testimony on Vishnan psychic communications with the same level of scepticism as Rear-Admiral Carey and Admiral Nechyev of the Terran sleeper ship ''Sanctuary'', he concedes that he too, over the past few days, had experienced the exact same things you experienced before you merged with the Vishnans.

Captain Kristae of the ''Temeraire'''s 56th Squadron has attached a report regarding the flight records obtained from the [[GTF Pegasus|''Pegasus'' stealth fighter]] you piloted while pursuing the two [[Vishnan Missionary|Vishnan Missonaries]] deep in the ''[[Knossos]]'' beyond N362. What the ''Temeraire'''s engineers have extracted from your flight data so far shows no trace of anything that happened to the ship out there.

In the briefing room, your squad leader, Al'faddil, gives a quick status update on the fleet's transit to the jump node. The destruction of the ''Sathanas'' has triggered several massive skirmishes between Vishnan Sacred Keepers and Shivan ''Sathanas'' juggernauts all over [[Delta Serpentis]]. The 14th Battlegroup has succeeded so far in not getting in the way of any of these conflicts, but the long-range sensors on the fleet's warships have detected a massive build-up of Vishnan and Shivan fighters at the Sol jump node—the 14th Battlegroup's destination.

The ''Orestes'' and ''Temeraire'' are now preparing all remaining combat-ready fighters for launch immediately after the fleet jumps into the vicinity of the Delta Serpentis-Sol jump node. From there on, ''Orestes'' control will give you additional orders.

Al'faddil will be staying on the ''Orestes'' to assist in coordinating all escort fighters, while you have been given field command. He has given you permission to use his own [[GTF Erinyes|''Erinyes'' heavy assault fighter]] for this mission.

==Walkthrough==
This is a lengthy escort mission across several warships, so choose a ship that befits a role you are comfortable with. Although Al'faddil's ''Erinyes'' fighter is chosen for you by default, you have the option of swapping it out for other ships, including the [[GTF Ares|GTF ''Ares'']]. If you prefer to do close-combat intercept, the ''Erinyes'' or [[GTF Perseus|''Perseus'']], armed with a [[Balor]], [[GTW Maxim]] and at least one bank of [[GTM Trebuchet|Trebuchet]]s, should do nicely. If you just want to sit around and chuck ordnance from beyond the normal range of conventional weaponry, the [[GTF Hercules Mark II|''Hercules Mark II'']] and ''Ares'' fighters are there for this reason. Alternatively, you can choose to fly bomber escort, but this is not recommended for less experienced players.

This mission begins with the entire 14th Battlegroup jumping in to the area surrounding the Sol jump node. From your view port, you can see two massive warships at the node. One of them is parked directly behind the node and appeared to be of Vishnan origin, simply designated the [[Vishnan Preserver|''Preserver'']]; the other, parked to the left and facing the first, is more obviously a Shivan design, and shows up as the [[SSJ Dante|SJ ''Kalki'']] on your ship's sensors. ''Orestes'' control notes that both ships are so massive, they exceed the minimum specifications for a juggernaut by at least five times.

You order your wing, Alpha, as well as Beta and Gamma wings to form up and wait for further orders. As your wingmen do so, Beta 1 voices a question: Why are they not fighting?

''Temeraire'' control sidesteps this question by remarking that the rotating devices of the ''Preserver'' are generating some strange energy readings in the jump node. When ''Orestes'' control asks if it is a weapon, ''Temeraire'' control returns an inconclusive response and suggests being on the alert just to be safe.

As the fleet waits, you pick up a heated argument going on between the two alien warships.

The ''Preserver'', representing the Great Preserver Vishnu, demands that the ''Kalki'' grants the 14th Battlegroup passage. However, the ''Kalki'', representing the Great Destroyer Shiva, refuses to do so, adding that the Terran fleet is not what the [[Shivans]] are looking for. The ''Kalki'' then asks the ''Preserver'' why the [[Vishnans]] are protecting the [[Terrans]]. The ''Preserver'' brushes the question off, stating that Shiva is no position to exercise judgement on the Terrans. The ''Preserver'' adds that the 14th Battlegroup does not belong here, rebukes Shiva for failing to fulfil its duty, and questions it over its reason for relentlessly pursuing them even when they no longer pose a danger.

Shiva's terse reply: The Terrans are just like them. They destroy. Shiva then laments that the Terrans do not create like "the Brahmans of old" and are "a threat to those" of "the potential" they are looking for.

Vishnu feels otherwise. Vishnu has seen the Terrans create communities where they could live peacefully alongside their former enemies, the [[Vasudans]]. They have created peace from war, a peace where the two races, once the most bitter of enemies, are now the closest of allies. Vishnu expostulates that both the Terrans and Vasudans "exhibited potential".

<center>'''''"One is now extinct. Do you wish to eradicate the other as well?"'''''</center>

An unusually long pause follows, before Shiva replies with two simple words:

<center>'''''"We do."'''''</center>

As soon as you hear the ''Kalki'' utter those words, the ''Orestes'' and ''Temeraire'' pick up multiple wings of Shivan fighters and bombers jumping in all around the battlegroup. At the same time, the ''Preserver'' and ''Kalki'' begin exchanging beam salvos.

Disregard the ''Preserver'' and ''Kalki''. Engage incoming Shivan bombers, and be careful of bomb shockwaves.

Just as Shivan forces come within striking distance of the 14th Battlegroup, the ''Preserver'' sends out a message to the entire fleet:

<center>'''''"Those who we deem of potential, those who we can equate to the Brahmans of old, we implore you. The jump node is ready. We have prepared it for you. Move to the jump node, and your journey will end. Balance will be restored."'''''</center>

You alert the ''Orestes'', but it was unnecessary; they caught the message as well. The ''Preserver'' has finished making alterations to the jump node to send the fleet back to your home universe. Without hesitation, the ''Orestes'' orders all ships to make a run for the node.

Be sure to keep an eye on the overall situation. Use the F3 menu to highlight Shivan wings if need be. If any of the vulnerable cruisers come under attack, sortie your wingmen to defend them.

You can lose up to three cruisers in this mission and still pass. Every other ship ''must'' get through to the node, no matter what happens. If you lose anything larger than a cruiser, the mission ends immediately and is considered a failure.

The mission ends and becomes a cutscene once the ''Orestes'' jumps out. When this happens, the battlefield falls silent once again, as the two juggernauts conclude their argument.

Vishnu expresses its disappointment at Shiva for betraying the Vishnans while pursuing its own agenda. Vishnu banishes Shiva from the Great Council formed by Brahma in the First Time. With what can only be described as universal finality, Vishnu orders Shiva to remove its brethren, the Shivans, from "this place" and never return, adding that, in time, the Vishnans will find "another caretaker" but it will not be them.

<center>'''''"We shall see about that"'''''</center>

With these unsettling words, the ''Kalki'' jumps out.

Vishnu now turns its attention to you.

<center>'''''"Your people are safe now, Wanderer. Go now, and bring the rest of your race to enlightenment."'''''</center>

<center>'''''"We will meet again when your people are ready."'''''</center>

==Notes==
* It's unclear whether the jump home would have succeeded without Vishnan assistance.
* The [[Spacesuit]] was originally available for use in this mission. It has been removed since the Director's Cut release of Age of Aquarius.
* In the original version of this mission, the ''Kalki'' would always end up dealing more damage to the ''Preserver'' as the latter is almost unable to fire back, save for one beam turret, due to positioning issues. The ''Preserver'' receives a hitpoint buff in the Director's Cut, and the sole beam turret that has an unobstructed view of the ''Kalki'' will target and destroy one of the ''Kalki'''s main beam cannons each time it fires. In this fashion, the ''Preserver'' usually ends up robbing the ''Kalki'' of any powerful forward armaments by the final cutscene.
* The Shivan determination to wipe out the Terran presence in [[Preserving the Balance]] was a harbinger of what is revealed here: the Shivans and Vishnans appear to be carrying on a dispute over the suitability of the Terrans and Vasudans for some unknown purpose. The Vishnans are optimistic, but the Shivans are not.
* Whether the Vishnans play a regulatory role, superior to the Shivans, whether they are genuinely the other side of the coin from the Shivans, and how this schema fits into the idea that the Shivans are both preservers and destroyers remains unclear.
* The revelations in the dialogue between the ''Preserver'' and the ''Kalki'' are ambiguous. The war between the two powers may be over, or it may continue to rage in this universe, or even between or across numerous universes.

==Tips==
* Do not concern yourself with the fighters. Your allied fighters and warships will take care of them on their own. Focus on the Shivan bombers instead. If you go after them, you will do just fine and you will get many more kills to boot. The two [[SC Rakshasa|''Rakshasa'' cruisers]] that jump in midway through the mission will also be taken care of eventually without your intervention.

==Total number of forces==
{{total_numbers_2
|belligerent_1 =[[Galactic Terran-Vasudan Alliance|GTVA]]
* [[Vishnans]]
|belligerent_2 =[[Shivans]]
|ship_1 =
* 1 [[GTD Erebus|GTD ''Erebus'']]
** [[GTD Orestes|''Orestes'']]

* 1 [[GTD Titan|GTD ''Titan'']]
** [[GTD Temeraire|''Temeraire'']]

* 1 [[GTCv Bellerophon|GTCv ''Bellerophon'']]
** ''Boreas''

* 2 [[GTCv Chimera|GTCv ''Chimera'']]
** ''Labouchere''
** ''Miranda''

* 3 [[GTC Hyperion|GTC ''Hyperion'']]
** ''Bretonia''
** ''Duke''
** ''Persephone''

* 2 [[GTL Anemoi|GTL ''Anemoi'']]
** ''Fortune''
** ''Solace''

* 1 [[GTD Orion Phase II|''Orion'' Refit]]
** ''Sanctuary''

* 1 [[Vishnan Preserver]]
** ''Preserver''
|ship_2 =
* 1 [[SSJ Dante|SJ ''Kalki'']]
** ''Kalki''

* 2 [[SC Rakshasa|SC ''Rakshasa'']]
** ''Dmitri''
** ''Lucifuge''
|strikecraft_1 =
* 3 [[GTF Erinyes|GTF ''Erinyes'']] (*)
** ''Alpha 1''
*** Bei
** ''Alpha 2''
*** Corey
** ''Alpha 3''
*** Taylor

* 3 [[PTF Kulas|GTF ''Kulas'']]
** ''Beta'' (3)(**)
** ''Temeraire Beta'' (3)

* 6 [[GTF Perseus|GTF ''Perseus'']]
** ''Gamma'' (3)(***)
** ''Temeraire Alpha'' (3)

* 1 [[UTF Comanche|GTF ''Comanche'']]
** ''Sanctuary Alpha 1''
*** Iwakura

* 1 [[UTF Seminole|GTF ''Seminole'']]
** ''Sanctuary Alpha 2''
*** Tell

* 1 [[UTF Cherokee|GTF ''Cherokee'']]
** ''Sanctuary Alpha 3''
|strikecraft_2 =
* 6-24 [[SF Mara|SF ''Mara'']]
** ''Brahma'' (6) '''*4 waves'''

* 6-18 [[SF Dragon|SF ''Dragon'']]
** ''Vishnu'' (6) '''*3 waves'''

* 6-24 [[SB Taurvi|SB ''Taurvi]]
** ''Arjuna'' (6) '''*4 waves'''

* 18-66 [[SB Nahema|SB ''Nahema'']]
** ''Narayan'' (6)
** ''Rama'' (6) '''*4 waves'''
** ''Shiva'' (6) '''*6 waves'''

* 6-12 [[SB Seraphim|SB ''Seraphim'']]
** ''Shivore'' (6) '''*2 waves'''
|casualties_1 =
* 0-3 [[GTC Hyperion|GTC ''Hyperion'']]
** ''Bretonia''
** ''Duke''
** ''Persephone''

* 0-3 [[PTF Kulas|GTF ''Kulas'']]
** ''Beta'' (3)(**)
** ''Temeraire Beta'' (3)

* 0-6 [[GTF Perseus|GTF ''Perseus'']]
** ''Gamma'' (3)(***)
** ''Temeraire Alpha'' (3)
|casualties_2 =
* 0-2 [[SC Rakshasa|SC ''Rakshasa'']]
** ''Dmitri''
** ''Lucifuge''

* 0-24 [[SF Mara|SF ''Mara'']]
** ''Brahma'' (6) '''*4 waves'''

* 0-18 [[SF Dragon|SF ''Dragon'']]
** ''Vishnu'' (6) '''*3 waves'''

* 0-24 [[SB Taurvi|SB ''Taurvi]]
** ''Arjuna'' (6) '''*4 waves'''

* 0-66 [[SB Nahema|SB ''Nahema'']]
** ''Narayan'' (6)
** ''Rama'' (6) '''*4 waves'''
** ''Shiva'' (6) '''*6 waves'''

* 0-12 [[SB Seraphim|SB ''Seraphim'']]
** ''Shivore'' (6) '''*2 waves'''
}}
(*) '''May be replaced with the [[GTF Hercules Mark II|GTF ''Hercules Mark II'']], [[GTF Ares|GTF ''Ares'']], [[GTF Perseus|GTF ''Perseus'']], [[GTF Myrmidon|GTF ''Myrmidon'']], [[GTB Artemis|GTB ''Artemis'']], [[GTB Ursa|GTB ''Ursa'']], [[GTB Boanerges|GTB ''Boanerges'']], [[GTF Aurora|GTF ''Aurora'']] and/or [[PTF Kulas|GTF ''Kulas'']] 
(**) '''May be replaced with the [[GTF Hercules Mark II|GTF ''Hercules Mark II'']], [[GTF Ares|GTF ''Ares'']], [[GTF Perseus|GTF ''Perseus'']], [[GTF Myrmidon|GTF ''Myrmidon'']], [[GTB Artemis|GTB ''Artemis'']], [[GTB Ursa|GTB ''Ursa'']], [[GTB Boanerges|GTB ''Boanerges'']] and/or [[GTF Aurora|GTF ''Aurora'']] 
(***) '''May be replaced with the [[GTF Hercules Mark II|GTF ''Hercules Mark II'']], [[GTF Ares|GTF ''Ares'']], [[GTF Myrmidon|GTF ''Myrmidon'']], [[GTB Artemis|GTB ''Artemis'']], [[GTB Ursa|GTB ''Ursa'']], [[GTB Boanerges|GTB ''Boanerges'']], [[GTF Aurora|GTF ''Aurora'']] and/or [[PTF Kulas|GTF ''Kulas'']]

==Videos==
===QuantumDelta===
 <videoflash>CiPUOEQJ2_w</videoflash> 

[[Category: Blue Planet]]

Ai profiles.tbl

2022-04-25T14:24:35Z

EatThePath:

{{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:
{{Table372|
*'''fix ramming stationary targets bug'''}}
{{Table202|
*For version 21.0 and up, the following options are enabled by default:
*'''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:'''}}

==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
*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.
*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}}

==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]]

Particle Effects

2022-04-25T14:18:40Z

EatThePath:

{{SCP_table}}
{{TableVersionGit|2020-10-29|4546c8784}}
{{Tables}}
Particle Effects is a SCP feature which allows to define custom particle effects that can be assigned to various engine properties.

This table is one of the [[Modular Tables]] and can be extended with xxx-part.tbm. This table type does not have a main table like the other types. All particle effects must be specified in modular tables. Currently there is no support for the usual ''+nocreate'' ability the other modular tables have but that will be added in the future. Parts of this documentation are written with with ''+nocreate'' in mind for when that is implemented.

=General Info=
*Begins with #Particle Effects
*Contains zero or more particle effect definitions
*Ends with #End

Particle effects are created by specifying a name and a type. The type dictates which values are valid and will be described below.

==$Effect:==
*Creates a new effect and specifies its name. The name must be at least one character long.
*Syntax: '''String'''

===$Type:===
*Sets the type of this effect. See [[#Effect Types|Effect Types]] for possible values.
*Syntax: '''String'''

=Effect Types=
There are multiple different types of effects. They are specified by passing the given name to ''$Type''.

==Single==
This effect type creates exactly one particle per processing step.

===+Filename:===
*Sets the filename of the animation that should be used.
*Required if ''+nocreate'' wasn't used
*Syntax: '''String''', filename
{{Table202|
*Allows for setting list of filenames the animation should use. If multiple animations are listed it picks randomly from the list for each spawned animation.
*Syntax: '''String''' or '''String List''', filename(s)
}}

===+Size:===
*Sets the size of the created particles. This is a uniformly distributed random range, see [[#Uniform random range]].
*Required if ''+nocreate'' wasn't used
*Syntax: See [[#Uniform random range]]

===+Length:===
*If specified, orients the animation along its velocity, and stretches it by this distance. This is a uniformly distributed random range, see [[#Uniform random range]].
*This is optional
*Syntax: See [[#Uniform random range]]

===+Lifetime:===
*Sets the life time of the particles. This is a uniformly distributed random range, see [[#Uniform random range]], or the string ''<none>'' in which case the runtime of the animation is used. Defaults to ''<none>''.
*This is optional
*Syntax: See [[#Uniform random range]], or the string ''<none>''

{{Table220|
===+Parent Velocity Factor:===
*Allows the particles to inherit the velocity of an attached object, like a weapon/ship/particle if applicable, or the last velocity of the associated weapon in the case of a weapon's $Impact Effect.
*0 is none of the velocity, 1 is 100% of the velocity, but the value can exceed those in either direction if desired.
*Syntax: See [[#Uniform random range]]
*Default: 0
}}

===+Duration:===
*Sets for how long this effect will be active. The duration can be once, always or a random range. If the effect should run only once then you can use the string ''Onetime''. If the effect should always be active you can specify the string ''Always''. Otherwise a non-negative random range is expected.
*This is optional
*Syntax: ''Onetime'', ''Always'', or a [[#Uniform random range]].

===+Delay:===
*Specifies after how much time after the effect is triggered the effect starts creating particles. This is not a valid option if the duration is ''Onetime''.
*This is optional
*Syntax: See [[#Uniform random range]], or the string ''<none>''

===+Effects per second:===
*Specifies how many times per second this effect is triggered. If this is not specified then the effect is triggered every frame. "Triggering" an effect means that one instance of the effect with the properties from above is created. If this is specified then the amount of triggers per second is always the same regardless of the FPS the game is running at. Values higher than the FPS (e.g. 120 if the game is running at 60 FPS) are handled correctly and will trigger the effect multiple times per frame if necessary.
*This is optional
*Syntax: ''number''. Must be greater than 0.

==Composite==
A composite effects contains multiple other effects which are all displayed at the same time. This is useful if you want to create complex effects that require more than one individual particle effect. The amount of child effects is not limited. This type currently does not support ''+nocreate''.

===+Child effect:===
*This specifies a child effect that should be added to the composite effect. The effect is specified using [[#Inline effect creation]].

==Cone==
This effects creates multiple particles which are sent in a direction determined by a cone around a specific direction. The particles are created in a [https://en.wikipedia.org/wiki/Normal_distribution normal distribution] around the direction vector. That means that more particle are created along the direction vector than far away from it. The velocity of a particle is scaled based on the angle it is away from the direction vector. This may be changed in the future to allow different effects.

===+Filename:===
*Sets the filename of the animation that should be used.
*Required if ''+nocreate'' wasn't used
*Syntax: '''String''', filename
{{Table202|
*Allows for setting list of filenames the animation should use. If multiple animations are listed it picks randomly from the list for each spawned animation.
*Syntax: '''String''' or '''String List''', filename(s)
}}

===+Size:===
*Sets the size of the created particles. This is a uniformly distributed random range, see [[#Uniform random range]].
*Required if ''+nocreate'' wasn't used
*Syntax: See [[#Uniform random range]]

===+Length:===
*If specified, orients the animation along its velocity, and stretches it by this distance. This is a uniformly distributed random range, see [[#Uniform random range]].
*This is optional
*Syntax: See [[#Uniform random range]]

===+Lifetime:===
*Sets the life time of the particles. This is a uniformly distributed random range, see [[#Uniform random range]], or the string ''<none>'' in which case the runtime of the animation is used. Defaults to ''<none>''.
*This is optional
*Syntax: See [[#Uniform random range]], or the string ''<none>''

===+Deviation:===
*Sets the standard deviation from the direction vector. Must not be 0 (though 0.1 is acceptable).
*Required if ''+nocreate'' is not present
*Syntax: '''float''', in degrees

===+Velocity:===
*Sets the velocity of the created particles. This is a [[#Uniform random range]].
*Required if ''+nocreate'' is not present
*Syntax: See [[#Uniform random range]]

===+Number:===
*Sets the amount of particles created for every frame the effect is active. This is a [[#Uniform random range]].
*Required if ''+nocreate'' is not present
*Syntax: See [[#Uniform random range]]

===+Chance:===
{{Table222|
*Sets a chance to spawn for each particle specified by +Number
*Syntax: '''float''' between 1.0 and 0.0. 1.0 is a 100% chance, and 0.0 is a 0% chance.
}}

===+Direction:===
*Sets the direction the cone will be centered around. Can be one of:
**''Incoming'': The direction vector is the direction of the particle source, e.g. for a weapon this would be the orientation it is currently facing.
**''Normal'': The normal vector of the particle source. This data may not exist for all sources. The debug log file will contain the warning message "<tt>Effect '<EffectName>' tried to use normal direction for source without a normal!</tt>" if an effect tries to use the normal vector without it existing.
**''Reflected'': The reflected vector from incoming and normal vector. This is a good way of simulating armor deflecting a shot. This direction requires the normal for work properly so the same warning message as above may appear in your log if the source has no normal vector assigned to it.
**''Reverse'': The reverse of the incoming vector
*Optional
*Syntax: '''String''', one of the strings specified above

{{Table220|
===+Parent Velocity Factor:===
*Allows the particles to inherit the velocity of an attached object, like a weapon/ship/particle if applicable, or the last velocity of the associated weapon in the case of a weapon's $Impact Effect.
*0 is none of the velocity, 1 is 100% of the velocity, but the value can exceed those in either direction if desired.
*Syntax: See [[#Uniform random range]]
*Default: 0
}}

===+Duration:===
*Sets for how long this effect will be active. The duration can be once, always or a random range. If the effect should run only once then you can use the string ''Onetime''. If the effect should always be active you can specify the string ''Always''. Otherwise a non-negative random range is expected.
*This is optional
*Syntax: ''Onetime'', ''Always'', or a [[#Uniform random range]].

===+Delay:===
*Specifies after how much time after the effect is triggered the effect starts creating particles. This is not a valid option if the duration is ''Onetime''.
*This is optional
*Syntax: See [[#Uniform random range]], or the string ''<none>''

===+Effects per second:===
*Specifies how many times per second this effect is triggered. If this is not specified then the effect is triggered every frame. "Triggering" an effect means that one instance of the effect with the properties from above is created. If this is specified then the amount of triggers per second is always the same regardless of the FPS the game is running at. Values higher than the FPS (e.g. 120 if the game is running at 60 FPS) are handled correctly and will trigger the effect multiple times per frame if necessary.
*This is optional
*Syntax: ''number''. Must be greater than 0.

===+Trail effect:===
*Sets the particle effect used for the trail of the created particles. This option uses [[#Inline effect creation]].
*Optional
*Syntax: See [[#Inline effect creation]].

==Sphere==
This effect creates particles which are randomly sent in all directions.

===+Filename:===
*Sets the filename of the animation that should be used.
*Required if ''+nocreate'' wasn't used
*Syntax: '''String''', filename
{{Table202|
*Allows for setting list of filenames the animation should use. If multiple animations are listed it picks randomly from the list for each spawned animation.
*Syntax: '''String''' or '''String List''', filename(s)
}}

===+Size:===
*Sets the size of the created particles. This is a uniformly distributed random range, see [[#Uniform random range]].
*Required if ''+nocreate'' wasn't used
*Syntax: See [[#Uniform random range]]

===+Length:===
*If specified, orients the animation along its velocity, and stretches it by this distance. This is a uniformly distributed random range, see [[#Uniform random range]].
*This is optional
*Syntax: See [[#Uniform random range]]

===+Lifetime:===
*Sets the life time of the particles. This is a uniformly distributed random range, see [[#Uniform random range]], or the string ''<none>'' in which case the runtime of the animation is used. Defaults to ''<none>''.
*This is optional
*Syntax: See [[#Uniform random range]], or the string ''<none>''

===+Velocity:===
*Sets the velocity of the created particles. This is a [[#Uniform random range]].
*Required if ''+nocreate'' is not present
*Syntax: See [[#Uniform random range]]

===+Number:===
*Sets the amount of particles created for every frame the effect is active. This is a [[#Uniform random range]].
*Required if ''+nocreate'' is not present
*Syntax: See [[#Uniform random range]]

===+Chance:===
{{Table222|
*Sets a chance to spawn for each particle specified by +Number
*Syntax: '''float''' between 1.0 and 0.0. 1.0 is a 100% chance, and 0.0 is a 0% chance.
}}

{{Table220|
===+Parent Velocity Factor:===
*Allows the particles to inherit the velocity of an attached object, like a weapon/ship/particle if applicable, or the last velocity of the associated weapon in the case of a weapon's $Impact Effect.
*0 is none of the velocity, 1 is 100% of the velocity, but the value can exceed those in either direction if desired.
*Syntax: See [[#Uniform random range]]
*Default: 0
}}

===+Duration:===
*Sets for how long this effect will be active. The duration can be once, always or a random range. If the effect should run only once then you can use the string ''Onetime''. If the effect should always be active you can specify the string ''Always''. Otherwise a non-negative random range is expected.
*This is optional
*Syntax: ''Onetime'', ''Always'', or a [[#Uniform random range]].

===+Delay:===
*Specifies after how much time after the effect is triggered the effect starts creating particles. This is not a valid option if the duration is ''Onetime''.
*This is optional
*Syntax: See [[#Uniform random range]], or the string ''<none>''

===+Effects per second:===
*Specifies how many times per second this effect is triggered. If this is not specified then the effect is triggered every frame. "Triggering" an effect means that one instance of the effect with the properties from above is created. If this is specified then the amount of triggers per second is always the same regardless of the FPS the game is running at. Values higher than the FPS (e.g. 120 if the game is running at 60 FPS) are handled correctly and will trigger the effect multiple times per frame if necessary.
*This is optional
*Syntax: ''number''. Must be greater than 0.

===+Trail effect:===
*Sets the particle effect used for the trail of the created particles. This option uses [[#Inline effect creation]].
*Optional
*Syntax: See [[#Inline effect creation]].

{{Table214|
==Volume==
This effect creates particles within a sperical (or ellipsoidal) volume.

===+Filename:===
*Sets the filename of the animation that should be used.
*Required if ''+nocreate'' wasn't used
*Syntax: '''String''', filename
*Also Allows for setting list of filenames the animation should use. If multiple animations are listed it picks randomly from the list for each spawned animation.
*Syntax: '''String''' or '''String List''', filename(s)

===+Size:===
*Sets the size of the created particles. This is a uniformly distributed random range, see [[#Uniform random range]].
*Required if ''+nocreate'' wasn't used
*Syntax: See [[#Uniform random range]]

===+Length:===
*If specified, orients the animation along its velocity, and stretches it by this distance. This is a uniformly distributed random range, see [[#Uniform random range]].
*This is optional
*Syntax: See [[#Uniform random range]]

===+Lifetime:===
*Sets the life time of the particles. This is a uniformly distributed random range, see [[#Uniform random range]], or the string ''<none>'' in which case the runtime of the animation is used. Defaults to ''<none>''.
*This is optional
*Syntax: See [[#Uniform random range]], or the string ''<none>''

===+Velocity:===
*Sets the velocity of the created particles. This is a [[#Uniform random range]]. This value will be scaled based the particle's starting distance from the center of the volume.
*Required if ''+nocreate'' is not present
*Syntax: See [[#Uniform random range]]

===+Number:===
*Sets the amount of particles created for every frame the effect is active. This is a [[#Uniform random range]].
*Required if ''+nocreate'' is not present
*Syntax: See [[#Uniform random range]]

===+Chance:===
{{Table222|
*Sets a chance to spawn for each particle specified by +Number
*Syntax: '''float''' between 1.0 and 0.0. 1.0 is a 100% chance, and 0.0 is a 0% chance.
}}

===+Volume radius:===
*Sets the radius of the spherical volume.
*Required if ''+nocreate'' is not present
*Syntax: '''Float''', meters

===+Bias:===
*Causes the particles to spawn more frequently near the edges or near the center. Values greater than 1 bias the particles toward the center, less than 1 biases them towards the edge.
*This is optional.
*Syntax: '''Float'''

===+Stretch:===
*'Stretches' or squashes the spherical volume into an ellipsoid. Values greater than 1 stretch it, less than 1 squashes it.
*This is optional.
*Syntax: '''Float'''

{{Table220|
===+Parent Velocity Factor:===
*Allows the particles to inherit the velocity of an attached object, like a weapon/ship/particle if applicable, or the last velocity of the associated weapon in the case of a weapon's $Impact Effect.
*0 is none of the velocity, 1 is 100% of the velocity, but the value can exceed those in either direction if desired.
*Syntax: See [[#Uniform random range]]
*Default: 0
}}

===+Duration:===
*Sets for how long this effect will be active. The duration can be once, always or a random range. If the effect should run only once then you can use the string ''Onetime''. If the effect should always be active you can specify the string ''Always''. Otherwise a non-negative random range is expected.
*This is optional
*Syntax: ''Onetime'', ''Always'', or a [[#Uniform random range]].

===+Delay:===
*Specifies after how much time after the effect is triggered the effect starts creating particles. This is not a valid option if the duration is ''Onetime''.
*This is optional
*Syntax: See [[#Uniform random range]], or the string ''<none>''

===+Effects per second:===
*Specifies how many times per second this effect is triggered. If this is not specified then the effect is triggered every frame. "Triggering" an effect means that one instance of the effect with the properties from above is created. If this is specified then the amount of triggers per second is always the same regardless of the FPS the game is running at. Values higher than the FPS (e.g. 120 if the game is running at 60 FPS) are handled correctly and will trigger the effect multiple times per frame if necessary.
*This is optional
*Syntax: ''number''. Must be greater than 0.

===+Trail effect:===
*Sets the particle effect used for the trail of the created particles. This option uses [[#Inline effect creation]].
*Optional
*Syntax: See [[#Inline effect creation]].
}}

==Inline effect creation==
At some places in this table a particle effect may be created within another particle effect. This is used for composite effects and particle trails. If inline creation is valid for an option then you may either specify a name of a previously defined effect or use '''$New Effect''' which will create a new, unnamed effect. If a name is specified then that effect must be already defined. In order to ensure that the effect is always defined no matter in which order the effect tables are parsed the effect should be defined in the same table. Some options using this construct require a specific type of effect. That will be noted in the documentation of the option.

If '''$New Effect''' is used then a new unnamed effect is created. If the surrounding option has not forced an effect type then you can specify it using the standard syntax described above. All options are the same as if the effect would have been parsed in the normal way. ''+nocreate'' is not valid within this element.

==Random range==
The particle effect system uses randomization to provide variation to the created particles. This is implemented by letting the mod author specify the values for the random distribution. There are different types of distributions which are explained below.

===Uniform random range===
*This accepts 1 or 2 values. If one value is used then the random range always returns that value. If two values are specified then a uniformly distributed random value will be picked from the range.
*Syntax: '''(Random values)''', a list of floating point values. Either one or two values. If only one value is specified then the parentheses are optional.
**Example: ''(4 20)''
**Example: ''4''

===Normal distribution random range===
*This accepts 1 or 2 values. This random range generates values according to a [https://en.wikipedia.org/wiki/Normal_distribution normal distribution]. The first value specified the mean value of the distribution. The second value specifies the standard deviation of the distribution, this defaults to 1.
*Syntax: '''(Random values)''', a list of floating point values. Either one or two values.
**Example: ''(4 20)''

=Example=
<pre>
#Particle Effects

$Effect: MassDriverImpact
$Type: Cone
+Filename: exp05
+Size: (5 7)
+Lifetime: (0.6)
+Deviation: 5
+Velocity: (500 700)
+Number: (20 30)
+Direction: Reflected
+Trail effect: $New Effect
$Type: Single
+Filename: exp20
+Size: (10)
+Lifetime: (1)
+Duration: Always

$Effect: ApocalypseIgnition
$Type: Single
+Filename: exp20
+Size: (10 20)

$Effect: Small_Explosion
$Type: Single
+Filename: ("exp20" "exp05")
+Size: (10 20)

$Effect: ApocalypseHomed
$Type: Composite
+Child effect: $New Effect
$Type: Single
+Filename: exp05
+Size: (5 7)
+Duration: (2 10)
+Child effect: $New Effect
$Type: Single
+Filename: exp06b
+Size: (5 7)
+Duration: (2 10)
+Delay: (8 15)
+Effects per second: 20

#End
</pre>

[[Category:Tables]]

Template:Tables

2022-04-25T14:12:46Z

EatThePath:

{| border=0 align=right cellpadding=2 cellspacing=1 style="margin: 0 0 1em 1em; background: #202020; border: 1px #AA2020 solid; border-collapse: collapse; font-size: 95%;"
! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"|'''''List of [[Tables]] and related code files'''''
|-
! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"|'''* Notes [[Modular Tables]]'''
|-
! colspan="2" style="color: white; height: 30px; background: #512020; 70%;"|'''** Notes tables which only use modular tables'''
|-
| align="center"| [[Ai.tbl]]
| '''/ai/'''aicode.cpp
|-
| align="center"| [[Ai_profiles.tbl]]*
| '''/ai/'''ai_profiles.cpp
|-
| align="center"| [[Animation.tbl]]**
| '''/model/'''modelanimation.cpp
|-
| align="center"| [[Armor.tbl]]*
| '''/ship/'''ship.cpp
|-
| align="center"| [[Asteroid.tbl]]
| '''/asteroid/'''asteroid.cpp
|-
| align="center"| [[Autopilot.tbl]]
| '''/autopilot/'''autopilot.cpp
|-
| align="center"| [[Colors.tbl]]*
| '''/globalincs/'''alphacolors.cpp
|-
| align="center"| [[Controlconfigdefaults.tbl]]
| '''/controlconfig/'''controlsconfigcommon.cpp
|-
| align="center"| [[Credits.tbl]]*
| '''/menuui/'''credits.cpp
|-
| align="center"| [[Cutscenes.tbl]]
| '''/cutscene/'''cutscenes.cpp
|-
| align="center"| [[Decals.tbl]]**
| '''/decals/'''decals.cpp
|-
| align="center"| [[Fireball.tbl]]*
| '''/fireball/'''fireballs.cpp
|-
| align="center"| [[Fonts.tbl]]
| '''/graphics/'''font.cpp
|-
| align="center"| [[Game_settings.tbl]]*
| '''/mod_table/'''mod_table.cpp
|-
| align="center"| [[Glowpoints.tbl]]*
| '''/model/'''modelread.cpp
|-
| align="center"| [[Help.tbl]]*
| '''/gamehelp/'''contexthelp.cpp
|-
| align="center"| [[Hud_gauges.tbl]]*
| '''/hud/'''hudparse.cpp
|-
| align="center"| [[Icons.tbl]]*
| '''/mission/'''missionbriefcommon.cpp
|-
| align="center"| [[Iff_defs.tbl]]
| '''/iff_defs/'''iff_defs.cpp
|-
| align="center"| [[Lighting_Profiles.tbl]]*
| '''/lighting/'''lighting_profiles.cpp
|-
| align="center"| [[Lightning.tbl]]
| '''/nebula/'''neblightning.cpp
|-
| align="center"| [[Mainhall.tbl]]*
| '''/menuui/'''mainhallmenu.cpp
|-
| align="center"| [[Medals.tbl]]
| '''/stats/'''medals.cpp
|-
| align="center"| [[Messages.tbl]]
| '''/mission/'''missionmessage.cpp
|-
| align="center"| [[Mflash.tbl]]*
| '''/weapon/'''muzzleflash.cpp
|-
| align="center"| [[Music.tbl]]*
| '''/gamesnd/'''eventmusic.cpp
|-
| align="center"| [[Nebula.tbl]]
| '''/nebula/'''neb.cpp
|-
| align="center"| [[Objecttypes.tbl]]*
| '''/ship/'''ship.cpp
|-
| align="center"| [[Particle Effects|Particle effects(-part.tbm)]]**
| '''/particle/effects'''...
|-
| align="center"| [[Pixels.tbl]]
| '''/palman/'''palman.cpp
|-
| align="center"| [[Post_processing.tbl]]
| '''/graphics/'''gropenglpostprocessing.cpp
|-
| align="center"| [[Rank.tbl]]
| '''/stats/'''scoring.cpp
|-
| align="center"| [[Scripting.tbl]]*
| '''/parse/'''scripting.cpp
|-
| align="center"| [[Ships.tbl]]*
| '''/ship/'''ship.cpp
|-
| align="center"| [[Dynamic SEXPs|Sexps.tbl]]**
| '''/parse/sexp/'''sexp_lookup.cpp
|-
| align="center"| [[Sounds.tbl]]*
| '''/gamesnd/'''gamesnd.cpp
|-
| align="center"| [[Species_defs.tbl]]*
| '''/species_defs/'''species_defs.cpp
|-
| align="center"| [[Species.tbl]]
| '''/menuui/'''techmenu.cpp
|-
| align="center"| [[Ssm.tbl]]*
| '''/hud/'''hudartillery.cpp
|-
| align="center"| [[Stars.tbl]]*
| '''/starfield/'''starfield.cpp
|-
| align="center"| [[Strings.tbl]]*
| '''/localization/'''localize.cpp
|-
| align="center"| [[Tips.tbl]]
| '''/menuui/'''playermenu.cpp
|-
| align="center"| [[Traitor.tbl]]
| '''/missionui/'''missiondebrief.cpp
|-
| align="center"| [[Tstrings.tbl]]*
| '''/localization/'''localize.cpp
|-
| align="center"| [[Weapon_expl.tbl]]*
| '''/weapon/'''weapons.cpp
|-
| align="center"| [[Weapons.tbl]]*
| '''/weapon/'''weapons.cpp
|-
|}<noinclude>[[Category:Templates|Tables]]</noinclude>

Command-Line Reference

2022-03-21T21:49:52Z

EatThePath: /* -profile_write_file */

{{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.
}}

====-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.
}}

====-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===

====-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_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"''''

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"'''

==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].

====-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.

====-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.

====-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.

====-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.

====-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.}}

====-clipdist====
Changes the distance from the viewpoint for the near-clipping plane.

Takes one argument decimal specifying the distance to the near-clipping plane.

====-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.}}

====-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.

====-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]]

Glowpoints.tbl

2021-12-30T03:52:23Z

EatThePath: /* +light */

{{TableVersionGit|2015-05-12|5dfbc6d292}}
{{Tables}}
The '''glowpoints.tbl''' defines glowpoint lights for ships under the new deferred lighting renderer.

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

=General Format=
* glowpoints.tbl currently has only one section: '''<nowiki>#</nowiki>Glowpoint overrides'''.
** Optional entries, if omitted, leave it as it was defined in the model (if applicable) or use the specified default value.
** The end of the section is indicated with '''<nowiki>#</nowiki>End'''.

=Glowpoint Override Entry=

==$Name:==
*Specifies the name of the glowpoint override (to be referenced in the '''[[Ships.tbl#.24Glowpoint_overrides:|$Glowpoint overrides:]]''' entry of a ship).
*Syntax: '''''String'''''

==+nocreate==
* (optional) In [[Modular Tables]], the name can be followed by the line '''+nocreate''' to prevent the game from creating an incomplete entry by leaving the entry unread unless it already exists (either in glowpoints.tbl or an earlier-parsed *-gpo.tbm file) by the time this *-gpo.tbm is read.
**'''Important note:''' At present, if an existing preset is overwritten, everything will be reset to default values and must be specified again.

==$On:==
* (optional) Ignored if standard blinking is used.
*Syntax: '''''Boolean'''''

==$Displacement time:==
* (optional) Displacement time for blinking (e.g. for Orion runway lights).
*Syntax: '''''Integer'''''

==$On time:==
* (optional) Amount of time the glowpoint stays on.
*Syntax: '''''Integer'''''

==$Off time:==
* (optional) Amount of time the glowpoint stays off.
*Syntax: '''''Integer'''''

==$Texture:==
* (optional) Specifies the name of the texture to use, or "none" for glowpoints that should only be light sources.
*Syntax: '''''String'''''

==$Type:==
* (optional) Defines what type of glowpoint this is (generally always 0).
*Syntax: '''''Integer'''''

==$Pulse type:==
* (optional) Specifies an interpolation of the glowpoint brightness with the given interpolation function.
*Syntax: one of '''''Sine''''', '''''Cosine''''', '''''Triangle''''', or '''''ShiftedTriangle'''''

==$Pulse period:==
* (optional) The period of the selected interpolation function. The lower the value the faster the pulsing.
*Syntax: '''''Float'''''
*Default Value: Two times the “On time” from the model or table.

==$Pulse amplitude:==
* (optional) Amplitude of the pulse function (unused with '''''ShiftedTriangle''''').
*Syntax: '''''Float'''''
*Default Value: 0.5

==$Pulse bias:==
* (optional) This is added to the function so one can control the minimum and maximum value (unused with '''''ShiftedTriangle''''').
*Syntax: '''''Float'''''
*Default Value: 0.5

==$Pulse exponent:==
* (optional) This raises the function to the given power to modify the look of the function (unused with '''''ShiftedTriangle''''').
*Syntax: '''''Float'''''
*Default Value: 1.0

==+light==
* (optional) Makes this glowpoint emit light. Further defined via additional sub-entries
* If +light is used, '''''$Light color:''''' is required

===$Light radius multiplier:===
* (optional) Multiplied by the radius of the glowpoint to get the radius of the light.
*Syntax: '''''Float'''''
*Default Value: 15.0

===$Light color:===
* Specifies the RGB values for the light.
*Syntax: '''''Int''''', '''''Int''''', '''''Int''''' (0 - 255)

===$Light mix color:===
* (optional) Requires '''$Pulse type:'''. Instead of dimming the light by the glowpoint intensity, linearly interpolates between '''$Light color:''' and '''$Light mix color:''' (cross-fade).
*Syntax: '''''Int''''', '''''Int''''', '''''Int''''' (0 - 255)
*Default Value: 0, 0, 0

===+lightcone===
* (optional) Makes this light a cone. Further defined via additional sub-entries
* If +lightcone is used, '''''$Cone direction:''''' is required

====$Cone angle:====
* (optional) Defines how wide this lightcone is.
*Syntax: '''''Float''''' (0 - 180)
*Default Value: 90.0

====$Cone direction:====
* The direction the cone points in, in submodel space.
*Syntax: ('''''Float''''', '''''Float''''', '''''Float''''')

====+dualcone====
* (optional) Allows the light cone to shine in both the direction specified ''and'' in the opposite direction.

====+rotating====
* (optional) Makes this light cone rotate. Further defined via additional sub-entries, both required.

=====$Rotation axis:=====
* The axis of rotation, in submodel space.
*Syntax: ('''''Float''''', '''''Float''''', '''''Float''''')

=====$Rotation speed:=====
* Speed of rotation, specified as the number of rotations per minute.
*Syntax: '''''Float'''''

Tonemapping

2021-12-11T19:04:44Z

EatThePath: Created page with "This page is intended to help you choose and potentially understand your mod's tonemapping configuration using [lighting_profiles.tbl]. This is a work in progress, more inform..."

This page is intended to help you choose and potentially understand your mod's tonemapping configuration using [lighting_profiles.tbl]. This is a work in progress, more information and comparisons are planned.

==What is Tonemapping and why do I need it?==
The choice of tonemapper makes a big difference in how the game looks. If you need to understand what tonemapping is doing and why, read this. If you just want to treat it as a black box of graphical options, the next section has pictures.

To understand tonemapping, you need to understand high dynamic range(HDR) lighting. The name might remind you of annoying games that proudly blind you with pitch dark or blazing bright screens when you move between light and dark regions, but these are purely optional features that confuse the issue. HDR lighting is in reality a fundamental feature of physically based rendering, and it’s presence demands tonemapping.

Non HDR lighting, low dynamic range(LDR), handles light and color in a way that’ll be very familiar to anyone who has done digital art. Pixels range between fully black to fully white, 0.0 to 1.0 or 0 to 255 depending on your context. Since this is how screens work, with pixels having a hard maximum brightness, this makes a lot of intuitive sense.

However if you instead think about rendering as mimicking the real behavior of light, LDR breaks down. Practically speaking in reality there is no maximum brightness, so HDR lighting doesn’t have one. Instead of colors topping out at 1.0 brightness they can get as bright as they need to, and the math is happy. But when you go to send it to the screen this of course becomes a problem again, you can’t make a screen pixel be brighter than full.

This is where tonemapping takes over. Tonemapping algorithms, sometimes called operators, do math to the raw HDR color values to squeeze them back into the 0-1 range in a variety of ways. Many of them try to mimic the way human eyes react to real world brightness, or model the behavior of cameras or film stock, or just do abstract mathematical things to try to make a frame look how an artist wants it to.

==More reading==

# [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