FreeSpace Wiki - User contributions [en]

User:The E

2026-07-26T11:51:04Z

The E:

Hi there. This is The E, the most common letter in the english alphabet. What makes me special among all the E's out there is my unique capacity to troubleshoot FS2Open installs. No other letter of the english alphabet has ever done this. It is my sincere hope that other letters and numbers will follow my example and contribute to the community.

{{SCP_table}}
{{Tables}}

The '''lens_flares.tbl''' defines physically-based lens systems used to render camera lens flares for suns. Added in '''FS2 Open, 26.1'''.

Unlike the sprite-based '''$Flare:''' effect defined in [[Stars.tbl]], a lens system is described the way a real lens is: as a stack of glass surfaces. The engine traces that stack at table load and derives everything the flare needs from it, so the ghosts, their colours and the starburst all follow from the optics rather than from hand-placed sprites.

A mission mounts exactly '''one''' of these as its camera lens, because there is one camera: every sun in the background flares through the same glass, so the flares of two suns can never disagree about the lens they came from. The lens is chosen with '''$Camera Lens:''' in the mission info section (see [[#Using a lens]]), falling back to the '''$Default Lens:''' this table declares; a mission can also opt out explicitly with '''<nowiki><none></nowiki>'''. A mission with no lens mounted is completely unaffected, which is what the shipped table defaults to, so retail and existing content keeps the retail look until a mod opts in.

While a lens is mounted, the legacy sprite '''$Flare:''' of [[Stars.tbl]] is not drawn at all, since the lens models the same artifact properly.

FreeSpace Open ships a default lens_flares.tbl built into the engine, so the lens systems listed under [[#Default lens systems]] are always available even when no table file is present.

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

==General Format==
*The table consists of a single section
*Begins with <nowiki>#</nowiki>'''Lens Systems'''
*May be followed by '''$Default Lens:''', then by any number of lens systems, each beginning with '''$Name:'''
*Must be closed with <nowiki>#</nowiki>'''End'''
*A lens system in a .tbm that reuses the '''$Name:''' of an existing one replaces it completely, rather than adding a second lens of the same name
*'''Entries must appear in the order listed on this page.''' Options are read in sequence, so an option placed out of order is skipped, and one placed after the surface list will abort the parsing of the whole table
*Within a lens system, every option except '''$Name:''' is optional and falls back to the default given below

==Table options==
*'''$Default Lens:'''
**The lens mounted by missions that do not name one themselves with '''$Camera Lens:''', and what the '''<nowiki><default></nowiki>''' argument of '''set-camera-lens''' restores
**Appears once, directly after <nowiki>#</nowiki>'''Lens Systems''' and before the first '''$Name:'''
**The shipped table leaves this unset, so no mission gets a flare until either the mission or a .tbm asks for one. Setting it in a xxx-lens.tbm is how a mod puts its whole campaign on the same glass with a single line
**The name is resolved after every table has been read, so it may name a lens declared later in the same table, or in a different table altogether. A later .tbm that sets it again replaces the earlier value
**Syntax: '''String''', default is ''' ''(empty — no lens)'' '''

==Lens system options==
*'''$Name:'''
**The name used to refer to this lens system from '''$Camera Lens:''' in a mission, from '''$Default Lens:''' above, and from the lens [[#SEXPs|SEXPs]]
**Begins a new lens system
**Syntax: '''String'''
*'''$Entrance Pupil Radius:'''
**Radius of the front element, in millimetres. For a real design this is the focal length divided by twice the f-number
**Controls how large the ghosts are and how much light the lens gathers
**Syntax: '''Float''', default is '''10.0'''
*'''$Aperture Radius:'''
**Half-opening of the iris, in millimetres
**This is the setting that decides whether a ghost is lit at all: each ghost slides across the iris as the sun moves off-axis, by an amount that grows with the field angle and shrinks with this value, and a ghost that slides off the iris goes black. Too small a value confines the whole flare to a sun near the centre of the frame; too large a one shrinks the ghosts within the iris until the blades stop shaping them
**The physical value is the paraxial marginal-ray height where it crosses the '''$Stop:'''. The shipped lenses use 1.25x that
**Syntax: '''Float''', default is '''5.0'''
*'''$Sensor Width:'''
**Width of the film gate, in millimetres. 36.0 is a full 35mm frame
**Together with the focal length the engine derives from the surfaces, this sets how far the ghosts travel as the sun moves off-axis
**Syntax: '''Float''', default is '''36.0'''
*'''$Anamorphic Squeeze:'''
**Stretches every ghost and the starburst horizontally, giving the oval ghosts of the anamorphic look. '''1.0''' is an ordinary spherical lens; '''2.0''' matches a classic 2x anamorphic. Values below 1.0 compress instead of stretching, which is not what the option is for and can thin a tightly focused ghost below a pixel
**A front anamorphic attachment is an afocal cylindrical telescope, so to first order all it does is magnify one meridian. That is why a whole anamorphic lens is one number here rather than a second set of surfaces, and why the iris behind it is unaffected — the aperture, its mask and the starburst shape are all still the ones described below
**Only the '''footprints''' stretch: ghosts stay on the sun exactly where they were, which is what a desqueezed anamorphic frame shows. FSO composes the frame directly and has no desqueeze stage, so treat this as a look control rather than a simulated 2x capture pipeline
**Costs nothing: it is applied as the flare is drawn, so unlike the aperture settings it forces no texture rebuild
**Syntax: '''Float''', default is '''1.0'''
*'''$Anamorphic Streak:'''
**The long horizontal flare a cylindrical element throws across the frame, and the other half of the anamorphic look. On its own '''$Anamorphic Squeeze:''' only ever widens things; the streak is what actually reads as anamorphic, because a real one runs 20-50 times longer than it is thick
**It is a separate effect from the starburst, not a stretched one: the starburst is the iris seen end-on and swings around as the sun moves, while the streak lies along the cylindrical element and so stays '''horizontal wherever the sun is'''
**Like the aperture imperfections it is off by default, and it needs no texture rebuild
**Syntax: '''Float''', strength; default is '''0.0''' (off)
**'''+Length:'''
***Half-length as a fraction of the sensor width. '''1.0''' spans the frame
***Syntax: '''Float''', default is '''1.0'''
**'''+Thickness:'''
***As a fraction of the length, so '''0.02''' gives a 50:1 bar
***Syntax: '''Float''', default is '''0.02'''
**'''+Tint:'''
***Multiplied onto the sun's own colour rather than replacing it, so a red sun keeps a reddish streak
***The default leans blue, which is where the classic look comes from — real streaks take their colour from the coating on the cylindrical element
***Syntax: '''( Float, Float, Float )''', default is '''( 0.35, 0.55, 1.0 )'''
*'''$Coating Wavelength:'''
**Wavelength in nanometres that the anti-reflection coating is tuned to, as a quarter-wave layer
**500-570 (green-centred, like real broadband coatings) gives the classic magenta and cyan ghost tints. '''0''' disables coatings entirely for an uncoated vintage look: much brighter, neutral grey ghosts
**Can be overridden per surface with '''+Coating Wavelength:'''
**Syntax: '''Float''', default is '''540.0'''

===Aperture===
A lens has exactly one aperture, and it drives both the ghosts and the starburst: every ghost is an image of the iris, and the starburst is that same image's diffraction pattern. Changing a blade count therefore restyles both at once.

*'''$Aperture Blades:'''
**Number of iris blades. Fewer than 3 gives a perfectly round iris
**Syntax: '''Integer''', default is '''6'''
*'''+Blade Rotation:'''
**Rotation of the iris, in degrees
**Syntax: '''Float''', default is '''0.0'''
*'''+Blade Curvature:'''
**How the blades bow. '''0''' leaves them straight, '''1''' bows their midpoints out to the corner radius for a circular iris, and negative values bow them inward into a star
**Syntax: '''Float''', -1.0 to 1.0, default is '''0.0'''
*'''+Edge Softness:'''
**Feathering of the iris edge, as a fraction of the iris radius
**The default is also the floor the engine clamps to (about a two pixel ramp, so the mask never aliases), so asking for less has no effect. Softening the edge visibly weakens the starburst spikes, because those come from the sharpness of that edge
**Syntax: '''Float''', default is '''0.0039'''

===Aperture imperfections===
Three optional layers darken the iris on top of the blade shape, for a dirty or damaged lens. All are off by default, and each takes its strength on the '''$'''-line followed by optional '''+''' sub-options.

Note that the starburst is normalized against its own brightest value, so these layers dim the core spikes as they add speckle around them, rather than only adding to what was already there.

*'''$Aperture Grating:'''
**A diffraction grating around the rim of the iris: radial ridges that throw extra spikes into the starburst
**Syntax: '''Float''', 0.0 to 1.0, strength; default is '''0.0''' (off)
**'''+Density:'''
***Fraction of the 360 possible ridges
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Length:'''
***How far in from the rim the ridges reach, as a fraction of the iris radius
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Width:'''
***Ridge width, as a duty cycle of the spacing between neighbouring ridges. Because it is relative, raising '''+Density:''' thins the ridges rather than merging them into a solid ring
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.25'''
**'''+Softness:'''
***Syntax: '''Float''', default is '''0.0'''
*'''$Aperture Scratches:'''
**Scratches on the glass: randomly placed slivers
**Syntax: '''Float''', 0.0 to 1.0, strength; default is '''0.0''' (off)
**'''+Density:'''
***Fraction of the 1000 possible scratches
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Length:'''
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Width:'''
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.25'''
**'''+Rotation:'''
***Direction the scratches run, in degrees
***Syntax: '''Float''', default is '''0.0'''
**'''+Rotation Variation:'''
***'''0''' leaves every scratch parallel, '''1''' scatters them completely
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.0'''
**'''+Softness:'''
***Syntax: '''Float''', default is '''0.0'''
*'''$Aperture Dust:'''
**Dust on the glass: randomly placed specks
**Syntax: '''Float''', 0.0 to 1.0, strength; default is '''0.0''' (off)
**'''+Density:'''
***Fraction of the 1000 possible specks
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Radius:'''
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Softness:'''
***Syntax: '''Float''', default is '''0.0'''

===Starburst and brightness===
*'''$Starburst:'''
**Whether this lens draws the diffraction starburst around the suns themselves. For each sun that gets one, the sun's own bitmap and glow are skipped so the two do not stack. A sun the flare pass does not reach keeps its ordinary bitmap and glow — one that is occluded, one outside the flare's reach, and every sun in an environment map, since those are rendered without the post-processing pass that draws the starburst
**Syntax: '''Boolean''', default is '''YES'''
*'''+Starburst Scale:'''
**Size of the starburst relative to the frame
**Syntax: '''Float''', default is '''1.0'''
*'''$Intensity:'''
**Overall brightness of this lens's flare
**This is the artistic control, and it is best set by comparing against the shipped lenses in the lab. An uncoated lens ('''$Coating Wavelength: 0''') reflects far more light and needs a much smaller value to stay in the same range
**Syntax: '''Float''', default is '''0.2'''
*'''$Max Ghosts:'''
**How many of the brightest ghosts to draw. A lens with many elements can produce several hundred, so this caps the cost
**Values above 63 are clamped to 63
**Syntax: '''Integer''', default is '''40'''

==Optical prescription==
The rest of the entry is the lens itself: an ordered list of the surfaces light passes through, front element first. Every ordered pair of surfaces produces one ghost, so the number and arrangement of surfaces is what gives a lens its character.

These numbers are "lens prescriptions" as published in lens patents and optical design references, and can be transcribed directly, one element per '''$Surface:''' row. Scaling all radii and thicknesses by the same factor changes the focal length. The engine derives the focal length, the sensor distance, the ghost list and each ghost's brightness and tint from this stack at table load.

*'''$Surface:'''
**One spherical glass surface
**Syntax: '''( Float, Float, Float )''' — curvature radius in millimetres, distance to the next surface in millimetres, and refractive index of the glass '''behind''' the surface ('''1.0''' being air)
**A positive radius means the surface bulges toward the front of the lens, with its centre of curvature behind it; a negative radius bulges toward the sensor; '''0''' is a flat surface
**The distance on the ''last'' surface is ignored: the engine places the sensor at the focus it computes
**'''+Abbe:'''
***Abbe V-number of the glass behind the surface, which sets how much it disperses. Crown glasses are around 55-60, dense flints around 30-40. This only drives the chromatic fringing of the ghosts, so approximate values are fine
***Syntax: '''Float''', default is '''0.0''' (no dispersion)
**'''+Coating Wavelength:'''
***Overrides '''$Coating Wavelength:''' for this surface alone
***Syntax: '''Float''', defaults to the lens's own value
*'''$Stop:'''
**Marks the iris plane. It does not refract or reflect; it is where the aperture sits in the stack
**Syntax: '''( Float )''', distance to the next surface in millimetres
**A lens without a '''$Stop:''' uses its middle surface as the aperture plane

A lens system needs at least two surfaces, and its prescription must actually form an image. One that does not (for instance an afocal stack) is dropped with a warning at table load and cannot be referenced.

==Using a lens==
*Mount a lens on a mission with '''$Camera Lens:''' in its info section (as in <code>$Camera Lens: tessar_50mm</code>), naming a lens system from this table. It sits alongside '''$Lighting Profile:''' and is the same kind of setting: one global render choice belonging to one mission
**The option takes a lens name, or one of two tokens in place of one: '''<nowiki><none></nowiki>''' for no flares at all, and '''<nowiki><default></nowiki>''' for the table's '''$Default Lens:'''. These are the same values '''set-camera-lens''' accepts
**A mission that omits the option entirely gets the table's '''$Default Lens:''', which is what keeps existing content unaffected. An unknown name warns and falls back to that default as well — only '''<nowiki><none></nowiki>''' turns the flares off, so that a typo can never silently read as "this mod wanted none"
**Both FRED and qtFRED expose it as a ''Camera lens'' drop-down in the background editor. '''Default''' leaves the mission silent so it follows the table, '''None''' writes '''<nowiki><none></nowiki>''' — these are different answers whenever a '''$Default Lens:''' is declared, and the drop-down keeps them apart so a saved mission never loses an explicit "no flares"
*Every visible sun in the background flares through the mounted lens — there is no per-sun setting on the lens. What differs between suns is only where each one sits in the frame and how bright it is
*'''A sun only flares if its [[Stars.tbl]] entry says so.''' The sun entry decides ''whether'' a sun flares and the mounted lens only decides ''how'' it is drawn, so mounting a lens never invents flares on suns that were deliberately tabled without one. A sun that does not ask keeps its ordinary bitmap and glow and gets nothing from the lens
**'''<nowiki>+Camera Lens Flare:</nowiki>''' (boolean) is the direct way to say it. It goes in the '''<nowiki>$Sun:</nowiki>''' entry, after any '''<nowiki>$Flare:</nowiki>''' block and before '''<nowiki>$NoGlare:</nowiki>'''
**With the option absent, a legacy sprite '''<nowiki>$Flare:</nowiki>''' block stands in for it, since that was the only way to declare a flare before the option existed — so tables written earlier keep working untouched. Where both are present the option wins, which is the only way to keep a sun's sprite flare while leaving it out of the physically-based one
**This matters because '''<nowiki>$Flare:</nowiki>''' is expensive to write: it requires a full set of sprite fields ('''<nowiki>+FlareCount:</nowiki>''', '''<nowiki>$FlareTexture1:</nowiki>''', '''<nowiki>$FlareGlow1:</nowiki>''' and so on) that are never drawn while a lens is mounted. '''<nowiki>+Camera Lens Flare: YES</nowiki>''' opts a sun in on its own, with none of them
**Retail's stars.tbl declares no '''<nowiki>$Flare:</nowiki>''' at all. The MediaVPs add one to the six standard suns (''SunWhite'', ''SunRed'', ''SunGreen'', ''SunBlue'', ''SunGold'', ''SunViolet'') and to many of the named stars, but not all of them — so if a background's sun shows no flare with a lens mounted, check its sun entry first, and add '''<nowiki>+Camera Lens Flare: YES</nowiki>''' in a '''<nowiki>-str.tbm</nowiki>''' to opt it in
*Missions can swap the lens and edit the iris at runtime with the lens [[#SEXPs|SEXPs]]
*The F3 lab (''Render options'' -> ''Lens flare options'') can override the mission's lens and adjust every aperture setting live, which is the practical way to dial in '''$Intensity:''', the anamorphic settings and the imperfection layers. It also exposes the global ghost and starburst brightness calibration and the HDR headroom, reports the mounted lens's ghost count, computed focal length and f-number, and lists what the last flare pass actually drew for each sun (visibility, off-axis angle, instance count). Lab edits are undone the same way mission edits are
*The flare is suppressed in full-nebula missions, in subspace, in VR, when post-processing is disabled, and when the Planets/Backgrounds detail setting is off

===SEXPs===
*'''set-camera-lens''' — mount a different lens system. Also accepts '''<nowiki><none></nowiki>''' for no flares at all and '''<nowiki><default></nowiki>''' for the table's '''$Default Lens:'''
*'''set-lens-aperture''' — blade count, rotation, curvature and edge softness
*'''set-lens-grating''', '''set-lens-scratches''', '''set-lens-dust''' — the imperfection layers

The four aperture operators take no lens argument: they restyle the iris of whatever lens is mounted, so a mission cannot edit a lens it is not looking through. With no lens mounted they do nothing and warn — use '''set-camera-lens''' first.

Note that these operators take '''percentages''' (0 to 100) and whole '''degrees''' where the table takes fractions (0.0 to 1.0) and floats; '''+Blade Curvature: 0.3''' in the table is an argument of '''30''' to '''set-lens-aperture'''.

Both the mounted lens and any iris edits are undone when the mission ends, so nothing carries into the next mission. These operators are not sent over the network, so in multiplayer they only affect the host.

The lens name given to '''set-camera-lens''' is validated when the mission loads, and a name that does not resolve aborts the load. This is safe because lens_flares.tbl is an engine default — the built-in lenses always resolve — but a mission naming a lens from a xxx-lens.tbm must ship with that .tbm.

==Default lens systems==
The built-in table ships eight lens systems, transcribed from published patents. All of them are spherical designs that leave the imperfection layers and both anamorphic options off — for an anamorphic look, set '''$Anamorphic Squeeze:''' and '''$Anamorphic Streak:''' on one of these in a xxx-lens.tbm.

*'''angenieux_100mm''' — double-Gauss cine prime, f/2.2. The reference prescription from the research this renderer is based on, and the lens the others are calibrated against
*'''tessar_50mm''' — classic Tessar, f/3.5. Few elements, so a sparse and subtle ghost set
*'''canon_70_200mm''' — modern multicoated telephoto zoom, f/2.8. The busiest shipped lens: a dense, strongly tinted ghost train
*'''kodak_100mm''' — symmetric double Gauss, f/3.8, single-coated. A sparse, orderly ghost set that stays stable as the sun moves off-axis
*'''leica_35mm''' — fast aspherical wide-angle prime, f/1.4. The shortest focal length shipped, so its ghosts sweep the furthest
*'''nikon_50_135mm''' — multicoated telephoto zoom, f/3.5
*'''color_heliar_105mm''' — uncoated vintage prime, f/3.5. The uncoated reference: few, large, colourless, obvious ghosts
*'''zeiss_master_prime_50mm''' — modern multicoated cine prime, T1.3. Many large, bright, strongly tinted ghosts; the closest to a contemporary cinema look

==Sample==
<pre>
#Lens Systems

; Classic Tessar, f/3.5, f=50mm, with a little dust on the front element.
$Name: tessar_50mm
$Entrance Pupil Radius: 7.0
$Aperture Radius: 5.0
$Sensor Width: 36.0
$Coating Wavelength: 520
$Aperture Blades: 8
+Blade Rotation: 0.0
+Blade Curvature: 0.3
$Aperture Dust: 0.4
+Density: 0.3
+Radius: 0.25
$Starburst: YES
+Starburst Scale: 0.8
$Intensity: 0.2
$Max Ghosts: 24
$Surface: ( 16.25, 2.90, 1.6116 )
+Abbe: 56.9
$Surface: ( -285.90, 0.29, 1.0 )
$Surface: ( -30.05, 1.20, 1.6053 )
+Abbe: 43.6
$Surface: ( 17.47, 1.38, 1.0 )
$Stop: ( 1.15 )
$Surface: ( 31.55, 1.20, 1.5123 )
+Abbe: 51.0
$Surface: ( 21.30, 3.50, 1.6116 )
+Abbe: 56.9
$Surface: ( -23.70, 40.0, 1.0 )

#End
</pre>

To use it, name it from the info section of a mission (or pick it in the background editor, which writes the same line):

<pre>
$Camera Lens: tessar_50mm
</pre>

To put a whole campaign on it instead, without touching a single mission, declare it as the default in a xxx-lens.tbm:

<pre>
#Lens Systems

$Default Lens: tessar_50mm

#End
</pre>

[[Category:Tables]]

User:The E

2026-07-26T09:03:58Z

The E:

Hi there. This is The E, the most common letter in the english alphabet. What makes me special among all the E's out there is my unique capacity to troubleshoot FS2Open installs. No other letter of the english alphabet has ever done this. It is my sincere hope that other letters and numbers will follow my example and contribute to the community.

{{SCP_table}}
{{Tables}}

The '''lens_flares.tbl''' defines physically-based lens systems used to render camera lens flares for suns. Added in '''FS2 Open, 26.1'''.

Unlike the sprite-based '''$Flare:''' effect defined in [[Stars.tbl]], a lens system is described the way a real lens is: as a stack of glass surfaces. The engine traces that stack at table load and derives everything the flare needs from it, so the ghosts, their colours and the starburst all follow from the optics rather than from hand-placed sprites.

A mission mounts exactly '''one''' of these as its camera lens, because there is one camera: every sun in the background flares through the same glass, so the flares of two suns can never disagree about the lens they came from. The lens is chosen with '''$Camera Lens:''' in the mission info section (see [[#Using a lens]]), falling back to the '''$Default Lens:''' this table declares. A mission with no lens mounted is completely unaffected, which is what the shipped table defaults to, so retail and existing content keeps the retail look until a mod opts in.

While a lens is mounted, the legacy sprite '''$Flare:''' of [[Stars.tbl]] is not drawn at all, since the lens models the same artifact properly.

FreeSpace Open ships a default lens_flares.tbl built into the engine, so the lens systems listed under [[#Default lens systems]] are always available even when no table file is present.

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

==General Format==
*The table consists of a single section
*Begins with <nowiki>#</nowiki>'''Lens Systems'''
*May be followed by '''$Default Lens:''', then by any number of lens systems, each beginning with '''$Name:'''
*Must be closed with <nowiki>#</nowiki>'''End'''
*A lens system in a .tbm that reuses the '''$Name:''' of an existing one replaces it completely, rather than adding a second lens of the same name
*'''Entries must appear in the order listed on this page.''' Options are read in sequence, so an option placed out of order is skipped, and one placed after the surface list will abort the parsing of the whole table
*Within a lens system, every option except '''$Name:''' is optional and falls back to the default given below

==Table options==
*'''$Default Lens:'''
**The lens mounted by missions that do not name one themselves with '''$Camera Lens:''', and what the '''<nowiki><default></nowiki>''' argument of '''set-camera-lens''' restores
**Appears once, directly after <nowiki>#</nowiki>'''Lens Systems''' and before the first '''$Name:'''
**The shipped table leaves this unset, so no mission gets a flare until either the mission or a .tbm asks for one. Setting it in a xxx-lens.tbm is how a mod puts its whole campaign on the same glass with a single line
**The name is resolved after every table has been read, so it may name a lens declared later in the same table, or in a different table altogether. A later .tbm that sets it again replaces the earlier value
**Syntax: '''String''', default is ''' ''(empty — no lens)'' '''

==Lens system options==
*'''$Name:'''
**The name used to refer to this lens system from '''$Camera Lens:''' in a mission, from '''$Default Lens:''' above, and from the lens [[#SEXPs|SEXPs]]
**Begins a new lens system
**Syntax: '''String'''
*'''$Entrance Pupil Radius:'''
**Radius of the front element, in millimetres. For a real design this is the focal length divided by twice the f-number
**Controls how large the ghosts are and how much light the lens gathers
**Syntax: '''Float''', default is '''10.0'''
*'''$Aperture Radius:'''
**Half-opening of the iris, in millimetres
**This is the setting that decides whether a ghost is lit at all: each ghost slides across the iris as the sun moves off-axis, by an amount that grows with the field angle and shrinks with this value, and a ghost that slides off the iris goes black. Too small a value confines the whole flare to a sun near the centre of the frame; too large a one shrinks the ghosts within the iris until the blades stop shaping them
**The physical value is the paraxial marginal-ray height where it crosses the '''$Stop:'''. The shipped lenses use 1.25x that
**Syntax: '''Float''', default is '''5.0'''
*'''$Sensor Width:'''
**Width of the film gate, in millimetres. 36.0 is a full 35mm frame
**Together with the focal length the engine derives from the surfaces, this sets how far the ghosts travel as the sun moves off-axis
**Syntax: '''Float''', default is '''36.0'''
*'''$Anamorphic Squeeze:'''
**Stretches every ghost and the starburst horizontally, giving the oval ghosts of the anamorphic look. '''1.0''' is an ordinary spherical lens; '''2.0''' matches a classic 2x anamorphic. Values below 1.0 compress instead of stretching, which is not what the option is for and can thin a tightly focused ghost below a pixel
**A front anamorphic attachment is an afocal cylindrical telescope, so to first order all it does is magnify one meridian. That is why a whole anamorphic lens is one number here rather than a second set of surfaces, and why the iris behind it is unaffected — the aperture, its mask and the starburst shape are all still the ones described below
**Only the '''footprints''' stretch: ghosts stay on the sun exactly where they were, which is what a desqueezed anamorphic frame shows. FSO composes the frame directly and has no desqueeze stage, so treat this as a look control rather than a simulated 2x capture pipeline
**Costs nothing: it is applied as the flare is drawn, so unlike the aperture settings it forces no texture rebuild
**Syntax: '''Float''', default is '''1.0'''
*'''$Anamorphic Streak:'''
**The long horizontal flare a cylindrical element throws across the frame, and the other half of the anamorphic look. On its own '''$Anamorphic Squeeze:''' only ever widens things; the streak is what actually reads as anamorphic, because a real one runs 20-50 times longer than it is thick
**It is a separate effect from the starburst, not a stretched one: the starburst is the iris seen end-on and swings around as the sun moves, while the streak lies along the cylindrical element and so stays '''horizontal wherever the sun is'''
**Like the aperture imperfections it is off by default, and it needs no texture rebuild
**Syntax: '''Float''', strength; default is '''0.0''' (off)
**'''+Length:'''
***Half-length as a fraction of the sensor width. '''1.0''' spans the frame
***Syntax: '''Float''', default is '''1.0'''
**'''+Thickness:'''
***As a fraction of the length, so '''0.02''' gives a 50:1 bar
***Syntax: '''Float''', default is '''0.02'''
**'''+Tint:'''
***Multiplied onto the sun's own colour rather than replacing it, so a red sun keeps a reddish streak
***The default leans blue, which is where the classic look comes from — real streaks take their colour from the coating on the cylindrical element
***Syntax: '''( Float, Float, Float )''', default is '''( 0.35, 0.55, 1.0 )'''
*'''$Coating Wavelength:'''
**Wavelength in nanometres that the anti-reflection coating is tuned to, as a quarter-wave layer
**500-570 (green-centred, like real broadband coatings) gives the classic magenta and cyan ghost tints. '''0''' disables coatings entirely for an uncoated vintage look: much brighter, neutral grey ghosts
**Can be overridden per surface with '''+Coating Wavelength:'''
**Syntax: '''Float''', default is '''540.0'''

===Aperture===
A lens has exactly one aperture, and it drives both the ghosts and the starburst: every ghost is an image of the iris, and the starburst is that same image's diffraction pattern. Changing a blade count therefore restyles both at once.

*'''$Aperture Blades:'''
**Number of iris blades. Fewer than 3 gives a perfectly round iris
**Syntax: '''Integer''', default is '''6'''
*'''+Blade Rotation:'''
**Rotation of the iris, in degrees
**Syntax: '''Float''', default is '''0.0'''
*'''+Blade Curvature:'''
**How the blades bow. '''0''' leaves them straight, '''1''' bows their midpoints out to the corner radius for a circular iris, and negative values bow them inward into a star
**Syntax: '''Float''', -1.0 to 1.0, default is '''0.0'''
*'''+Edge Softness:'''
**Feathering of the iris edge, as a fraction of the iris radius
**The default is also the floor the engine clamps to (about a two pixel ramp, so the mask never aliases), so asking for less has no effect. Softening the edge visibly weakens the starburst spikes, because those come from the sharpness of that edge
**Syntax: '''Float''', default is '''0.0039'''

===Aperture imperfections===
Three optional layers darken the iris on top of the blade shape, for a dirty or damaged lens. All are off by default, and each takes its strength on the '''$'''-line followed by optional '''+''' sub-options.

Note that the starburst is normalized against its own brightest value, so these layers dim the core spikes as they add speckle around them, rather than only adding to what was already there.

*'''$Aperture Grating:'''
**A diffraction grating around the rim of the iris: radial ridges that throw extra spikes into the starburst
**Syntax: '''Float''', 0.0 to 1.0, strength; default is '''0.0''' (off)
**'''+Density:'''
***Fraction of the 360 possible ridges
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Length:'''
***How far in from the rim the ridges reach, as a fraction of the iris radius
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Width:'''
***Ridge width, as a duty cycle of the spacing between neighbouring ridges. Because it is relative, raising '''+Density:''' thins the ridges rather than merging them into a solid ring
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.25'''
**'''+Softness:'''
***Syntax: '''Float''', default is '''0.0'''
*'''$Aperture Scratches:'''
**Scratches on the glass: randomly placed slivers
**Syntax: '''Float''', 0.0 to 1.0, strength; default is '''0.0''' (off)
**'''+Density:'''
***Fraction of the 1000 possible scratches
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Length:'''
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Width:'''
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.25'''
**'''+Rotation:'''
***Direction the scratches run, in degrees
***Syntax: '''Float''', default is '''0.0'''
**'''+Rotation Variation:'''
***'''0''' leaves every scratch parallel, '''1''' scatters them completely
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.0'''
**'''+Softness:'''
***Syntax: '''Float''', default is '''0.0'''
*'''$Aperture Dust:'''
**Dust on the glass: randomly placed specks
**Syntax: '''Float''', 0.0 to 1.0, strength; default is '''0.0''' (off)
**'''+Density:'''
***Fraction of the 1000 possible specks
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Radius:'''
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Softness:'''
***Syntax: '''Float''', default is '''0.0'''

===Starburst and brightness===
*'''$Starburst:'''
**Whether this lens draws the diffraction starburst around the suns themselves. For each sun that gets one, the sun's own bitmap and glow are skipped so the two do not stack
**Syntax: '''Boolean''', default is '''YES'''
*'''+Starburst Scale:'''
**Size of the starburst relative to the frame
**Syntax: '''Float''', default is '''1.0'''
*'''$Intensity:'''
**Overall brightness of this lens's flare
**This is the artistic control, and it is best set by comparing against the shipped lenses in the lab. An uncoated lens ('''$Coating Wavelength: 0''') reflects far more light and needs a much smaller value to stay in the same range
**Syntax: '''Float''', default is '''0.2'''
*'''$Max Ghosts:'''
**How many of the brightest ghosts to draw. A lens with many elements can produce several hundred, so this caps the cost
**Values above 63 are clamped to 63
**Syntax: '''Integer''', default is '''40'''

==Optical prescription==
The rest of the entry is the lens itself: an ordered list of the surfaces light passes through, front element first. Every ordered pair of surfaces produces one ghost, so the number and arrangement of surfaces is what gives a lens its character.

These numbers are "lens prescriptions" as published in lens patents and optical design references, and can be transcribed directly, one element per '''$Surface:''' row. Scaling all radii and thicknesses by the same factor changes the focal length. The engine derives the focal length, the sensor distance, the ghost list and each ghost's brightness and tint from this stack at table load.

*'''$Surface:'''
**One spherical glass surface
**Syntax: '''( Float, Float, Float )''' — curvature radius in millimetres, distance to the next surface in millimetres, and refractive index of the glass '''behind''' the surface ('''1.0''' being air)
**A positive radius means the surface bulges toward the front of the lens, with its centre of curvature behind it; a negative radius bulges toward the sensor; '''0''' is a flat surface
**The distance on the ''last'' surface is ignored: the engine places the sensor at the focus it computes
**'''+Abbe:'''
***Abbe V-number of the glass behind the surface, which sets how much it disperses. Crown glasses are around 55-60, dense flints around 30-40. This only drives the chromatic fringing of the ghosts, so approximate values are fine
***Syntax: '''Float''', default is '''0.0''' (no dispersion)
**'''+Coating Wavelength:'''
***Overrides '''$Coating Wavelength:''' for this surface alone
***Syntax: '''Float''', defaults to the lens's own value
*'''$Stop:'''
**Marks the iris plane. It does not refract or reflect; it is where the aperture sits in the stack
**Syntax: '''( Float )''', distance to the next surface in millimetres
**A lens without a '''$Stop:''' uses its middle surface as the aperture plane

A lens system needs at least two surfaces, and its prescription must actually form an image. One that does not (for instance an afocal stack) is dropped with a warning at table load and cannot be referenced.

==Using a lens==
*Mount a lens on a mission with '''$Camera Lens:''' in its info section (as in <code>$Camera Lens: tessar_50mm</code>), naming a lens system from this table. It sits alongside '''$Lighting Profile:''' and is the same kind of setting: one global render choice belonging to one mission
**Both FRED and qtFRED expose it as a ''Camera lens'' drop-down in the background editor, where entry '''None''' means no flares
**A mission that omits the option (or leaves it empty) gets the table's '''$Default Lens:'''. An unknown name warns and falls back to that default as well
*Every visible sun in the background flares through the mounted lens — there is no per-sun setting. What differs between suns is only where each one sits in the frame and how bright it is
*Missions can swap the lens and edit the iris at runtime with the lens [[#SEXPs|SEXPs]]
*The F3 lab (''Render options'' -> ''Lens flare options'') can override the mission's lens and adjust every aperture setting live, which is the practical way to dial in '''$Intensity:''', the anamorphic settings and the imperfection layers. It also exposes the global ghost and starburst brightness calibration and the HDR headroom, reports the mounted lens's ghost count, computed focal length and f-number, and lists what the last flare pass actually drew for each sun (visibility, off-axis angle, instance count). Lab edits are undone the same way mission edits are
*The flare is suppressed in full-nebula missions, in subspace, in VR, when post-processing is disabled, and when the Planets/Backgrounds detail setting is off

===SEXPs===
*'''set-camera-lens''' — mount a different lens system. Also accepts '''<nowiki><none></nowiki>''' for no flares at all and '''<nowiki><default></nowiki>''' for the table's '''$Default Lens:'''
*'''set-lens-aperture''' — blade count, rotation, curvature and edge softness
*'''set-lens-grating''', '''set-lens-scratches''', '''set-lens-dust''' — the imperfection layers

The four aperture operators take no lens argument: they restyle the iris of whatever lens is mounted, so a mission cannot edit a lens it is not looking through. With no lens mounted they do nothing and warn — use '''set-camera-lens''' first.

Note that these operators take '''percentages''' (0 to 100) and whole '''degrees''' where the table takes fractions (0.0 to 1.0) and floats; '''+Blade Curvature: 0.3''' in the table is an argument of '''30''' to '''set-lens-aperture'''.

Both the mounted lens and any iris edits are undone when the mission ends, so nothing carries into the next mission. These operators are not sent over the network, so in multiplayer they only affect the host.

The lens name given to '''set-camera-lens''' is validated when the mission loads, and a name that does not resolve aborts the load. This is safe because lens_flares.tbl is an engine default — the built-in lenses always resolve — but a mission naming a lens from a xxx-lens.tbm must ship with that .tbm.

==Default lens systems==
The built-in table ships eight lens systems, transcribed from published patents. All of them are spherical designs that leave the imperfection layers and both anamorphic options off — for an anamorphic look, set '''$Anamorphic Squeeze:''' and '''$Anamorphic Streak:''' on one of these in a xxx-lens.tbm.

*'''angenieux_100mm''' — double-Gauss cine prime, f/2.2. The reference prescription from the research this renderer is based on, and the lens the others are calibrated against
*'''tessar_50mm''' — classic Tessar, f/3.5. Few elements, so a sparse and subtle ghost set
*'''canon_70_200mm''' — modern multicoated telephoto zoom, f/2.8. The busiest shipped lens: a dense, strongly tinted ghost train
*'''kodak_100mm''' — symmetric double Gauss, f/3.8, single-coated. A sparse, orderly ghost set that stays stable as the sun moves off-axis
*'''leica_35mm''' — fast aspherical wide-angle prime, f/1.4. The shortest focal length shipped, so its ghosts sweep the furthest
*'''nikon_50_135mm''' — multicoated telephoto zoom, f/3.5
*'''color_heliar_105mm''' — uncoated vintage prime, f/3.5. The uncoated reference: few, large, colourless, obvious ghosts
*'''zeiss_master_prime_50mm''' — modern multicoated cine prime, T1.3. Many large, bright, strongly tinted ghosts; the closest to a contemporary cinema look

==Sample==
<pre>
#Lens Systems

; Classic Tessar, f/3.5, f=50mm, with a little dust on the front element.
$Name: tessar_50mm
$Entrance Pupil Radius: 7.0
$Aperture Radius: 5.0
$Sensor Width: 36.0
$Coating Wavelength: 520
$Aperture Blades: 8
+Blade Rotation: 0.0
+Blade Curvature: 0.3
$Aperture Dust: 0.4
+Density: 0.3
+Radius: 0.25
$Starburst: YES
+Starburst Scale: 0.8
$Intensity: 0.2
$Max Ghosts: 24
$Surface: ( 16.25, 2.90, 1.6116 )
+Abbe: 56.9
$Surface: ( -285.90, 0.29, 1.0 )
$Surface: ( -30.05, 1.20, 1.6053 )
+Abbe: 43.6
$Surface: ( 17.47, 1.38, 1.0 )
$Stop: ( 1.15 )
$Surface: ( 31.55, 1.20, 1.5123 )
+Abbe: 51.0
$Surface: ( 21.30, 3.50, 1.6116 )
+Abbe: 56.9
$Surface: ( -23.70, 40.0, 1.0 )

#End
</pre>

To use it, name it from the info section of a mission (or pick it in the background editor, which writes the same line):

<pre>
$Camera Lens: tessar_50mm
</pre>

To put a whole campaign on it instead, without touching a single mission, declare it as the default in a xxx-lens.tbm:

<pre>
#Lens Systems

$Default Lens: tessar_50mm

#End
</pre>

[[Category:Tables]]

User:The E

2026-07-26T07:26:07Z

The E:

Hi there. This is The E, the most common letter in the english alphabet. What makes me special among all the E's out there is my unique capacity to troubleshoot FS2Open installs. No other letter of the english alphabet has ever done this. It is my sincere hope that other letters and numbers will follow my example and contribute to the community.

{{SCP_table}}
{{Tables}}

The '''lens_flares.tbl''' defines physically-based lens systems used to render camera lens flares for suns. Added in '''FS2 Open, 26.1'''.

Unlike the sprite-based '''$Flare:''' effect defined in [[Stars.tbl]], a lens system is described the way a real lens is: as a stack of glass surfaces. The engine traces that stack at table load and derives everything the flare needs from it, so the ghosts, their colours and the starburst all follow from the optics rather than from hand-placed sprites.

A mission mounts exactly '''one''' of these as its camera lens, because there is one camera: every sun in the background flares through the same glass, so the flares of two suns can never disagree about the lens they came from. The lens is chosen with '''$Camera Lens:''' in the mission info section (see [[#Using a lens]]), falling back to the '''$Default Lens:''' this table declares. A mission with no lens mounted is completely unaffected, which is what the shipped table defaults to, so retail and existing content keeps the retail look until a mod opts in.

While a lens is mounted, the legacy sprite '''$Flare:''' of [[Stars.tbl]] is not drawn at all, since the lens models the same artifact properly.

FreeSpace Open ships a default lens_flares.tbl built into the engine, so the lens systems listed under [[#Default lens systems]] are always available even when no table file is present.

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

==General Format==
*The table consists of a single section
*Begins with <nowiki>#</nowiki>'''Lens Systems'''
*May be followed by '''$Default Lens:''', then by any number of lens systems, each beginning with '''$Name:'''
*Must be closed with <nowiki>#</nowiki>'''End'''
*A lens system in a .tbm that reuses the '''$Name:''' of an existing one replaces it completely, rather than adding a second lens of the same name
*'''Entries must appear in the order listed on this page.''' Options are read in sequence, so an option placed out of order is skipped, and one placed after the surface list will abort the parsing of the whole table
*Within a lens system, every option except '''$Name:''' is optional and falls back to the default given below

==Table options==
*'''$Default Lens:'''
**The lens mounted by missions that do not name one themselves with '''$Camera Lens:''', and what the '''<nowiki><default></nowiki>''' argument of '''set-camera-lens''' restores
**Appears once, directly after <nowiki>#</nowiki>'''Lens Systems''' and before the first '''$Name:'''
**The shipped table leaves this unset, so no mission gets a flare until either the mission or a .tbm asks for one. Setting it in a xxx-lens.tbm is how a mod puts its whole campaign on the same glass with a single line
**The name is resolved after every table has been read, so it may name a lens declared later in the same table, or in a different table altogether. A later .tbm that sets it again replaces the earlier value
**Syntax: '''String''', default is ''' ''(empty — no lens)'' '''

==Lens system options==
*'''$Name:'''
**The name used to refer to this lens system from '''$Camera Lens:''' in a mission, from '''$Default Lens:''' above, and from the lens [[#SEXPs|SEXPs]]
**Begins a new lens system
**Syntax: '''String'''
*'''$Entrance Pupil Radius:'''
**Radius of the front element, in millimetres. For a real design this is the focal length divided by twice the f-number
**Controls how large the ghosts are and how much light the lens gathers
**Syntax: '''Float''', default is '''10.0'''
*'''$Aperture Radius:'''
**Half-opening of the iris, in millimetres
**This is the setting that decides whether a ghost is lit at all: each ghost slides across the iris as the sun moves off-axis, by an amount that grows with the field angle and shrinks with this value, and a ghost that slides off the iris goes black. Too small a value confines the whole flare to a sun near the centre of the frame; too large a one shrinks the ghosts within the iris until the blades stop shaping them
**The physical value is the paraxial marginal-ray height where it crosses the '''$Stop:'''. The shipped lenses use 1.25x that
**Syntax: '''Float''', default is '''5.0'''
*'''$Sensor Width:'''
**Width of the film gate, in millimetres. 36.0 is a full 35mm frame
**Together with the focal length the engine derives from the surfaces, this sets how far the ghosts travel as the sun moves off-axis
**Syntax: '''Float''', default is '''36.0'''
*'''$Coating Wavelength:'''
**Wavelength in nanometres that the anti-reflection coating is tuned to, as a quarter-wave layer
**500-570 (green-centred, like real broadband coatings) gives the classic magenta and cyan ghost tints. '''0''' disables coatings entirely for an uncoated vintage look: much brighter, neutral grey ghosts
**Can be overridden per surface with '''+Coating Wavelength:'''
**Syntax: '''Float''', default is '''540.0'''

===Aperture===
A lens has exactly one aperture, and it drives both the ghosts and the starburst: every ghost is an image of the iris, and the starburst is that same image's diffraction pattern. Changing a blade count therefore restyles both at once.

*'''$Aperture Blades:'''
**Number of iris blades. Fewer than 3 gives a perfectly round iris
**Syntax: '''Integer''', default is '''6'''
*'''+Blade Rotation:'''
**Rotation of the iris, in degrees
**Syntax: '''Float''', default is '''0.0'''
*'''+Blade Curvature:'''
**How the blades bow. '''0''' leaves them straight, '''1''' bows their midpoints out to the corner radius for a circular iris, and negative values bow them inward into a star
**Syntax: '''Float''', -1.0 to 1.0, default is '''0.0'''
*'''+Edge Softness:'''
**Feathering of the iris edge, as a fraction of the iris radius
**The default is also the floor the engine clamps to (about a two pixel ramp, so the mask never aliases), so asking for less has no effect. Softening the edge visibly weakens the starburst spikes, because those come from the sharpness of that edge
**Syntax: '''Float''', default is '''0.0039'''

===Aperture imperfections===
Three optional layers darken the iris on top of the blade shape, for a dirty or damaged lens. All are off by default, and each takes its strength on the '''$'''-line followed by optional '''+''' sub-options.

Note that the starburst is normalized against its own brightest value, so these layers dim the core spikes as they add speckle around them, rather than only adding to what was already there.

*'''$Aperture Grating:'''
**A diffraction grating around the rim of the iris: radial ridges that throw extra spikes into the starburst
**Syntax: '''Float''', 0.0 to 1.0, strength; default is '''0.0''' (off)
**'''+Density:'''
***Fraction of the 360 possible ridges
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Length:'''
***How far in from the rim the ridges reach, as a fraction of the iris radius
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Width:'''
***Ridge width, as a duty cycle of the spacing between neighbouring ridges. Because it is relative, raising '''+Density:''' thins the ridges rather than merging them into a solid ring
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.25'''
**'''+Softness:'''
***Syntax: '''Float''', default is '''0.0'''
*'''$Aperture Scratches:'''
**Scratches on the glass: randomly placed slivers
**Syntax: '''Float''', 0.0 to 1.0, strength; default is '''0.0''' (off)
**'''+Density:'''
***Fraction of the 1000 possible scratches
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Length:'''
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Width:'''
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.25'''
**'''+Rotation:'''
***Direction the scratches run, in degrees
***Syntax: '''Float''', default is '''0.0'''
**'''+Rotation Variation:'''
***'''0''' leaves every scratch parallel, '''1''' scatters them completely
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.0'''
**'''+Softness:'''
***Syntax: '''Float''', default is '''0.0'''
*'''$Aperture Dust:'''
**Dust on the glass: randomly placed specks
**Syntax: '''Float''', 0.0 to 1.0, strength; default is '''0.0''' (off)
**'''+Density:'''
***Fraction of the 1000 possible specks
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Radius:'''
***Syntax: '''Float''', 0.0 to 1.0, default is '''0.5'''
**'''+Softness:'''
***Syntax: '''Float''', default is '''0.0'''

===Starburst and brightness===
*'''$Starburst:'''
**Whether this lens draws the diffraction starburst around the suns themselves. For each sun that gets one, the sun's own bitmap and glow are skipped so the two do not stack
**Syntax: '''Boolean''', default is '''YES'''
*'''+Starburst Scale:'''
**Size of the starburst relative to the frame
**Syntax: '''Float''', default is '''1.0'''
*'''$Intensity:'''
**Overall brightness of this lens's flare
**This is the artistic control, and it is best set by comparing against the shipped lenses in the lab. An uncoated lens ('''$Coating Wavelength: 0''') reflects far more light and needs a much smaller value to stay in the same range
**Syntax: '''Float''', default is '''0.2'''
*'''$Max Ghosts:'''
**How many of the brightest ghosts to draw. A lens with many elements can produce several hundred, so this caps the cost
**Values above 63 are clamped to 63
**Syntax: '''Integer''', default is '''40'''

==Optical prescription==
The rest of the entry is the lens itself: an ordered list of the surfaces light passes through, front element first. Every ordered pair of surfaces produces one ghost, so the number and arrangement of surfaces is what gives a lens its character.

These numbers are "lens prescriptions" as published in lens patents and optical design references, and can be transcribed directly, one element per '''$Surface:''' row. Scaling all radii and thicknesses by the same factor changes the focal length. The engine derives the focal length, the sensor distance, the ghost list and each ghost's brightness and tint from this stack at table load.

*'''$Surface:'''
**One spherical glass surface
**Syntax: '''( Float, Float, Float )''' — curvature radius in millimetres, distance to the next surface in millimetres, and refractive index of the glass '''behind''' the surface ('''1.0''' being air)
**A positive radius means the surface bulges toward the front of the lens, with its centre of curvature behind it; a negative radius bulges toward the sensor; '''0''' is a flat surface
**The distance on the ''last'' surface is ignored: the engine places the sensor at the focus it computes
**'''+Abbe:'''
***Abbe V-number of the glass behind the surface, which sets how much it disperses. Crown glasses are around 55-60, dense flints around 30-40. This only drives the chromatic fringing of the ghosts, so approximate values are fine
***Syntax: '''Float''', default is '''0.0''' (no dispersion)
**'''+Coating Wavelength:'''
***Overrides '''$Coating Wavelength:''' for this surface alone
***Syntax: '''Float''', defaults to the lens's own value
*'''$Stop:'''
**Marks the iris plane. It does not refract or reflect; it is where the aperture sits in the stack
**Syntax: '''( Float )''', distance to the next surface in millimetres
**A lens without a '''$Stop:''' uses its middle surface as the aperture plane

A lens system needs at least two surfaces, and its prescription must actually form an image. One that does not (for instance an afocal stack) is dropped with a warning at table load and cannot be referenced.

==Using a lens==
*Mount a lens on a mission with '''$Camera Lens:''' in its info section (as in <code>$Camera Lens: tessar_50mm</code>), naming a lens system from this table. It sits alongside '''$Lighting Profile:''' and is the same kind of setting: one global render choice belonging to one mission
**Both FRED and qtFRED expose it as a ''Camera lens'' drop-down in the background editor, where entry '''None''' means no flares
**A mission that omits the option (or leaves it empty) gets the table's '''$Default Lens:'''. An unknown name warns and falls back to that default as well
*Every visible sun in the background flares through the mounted lens — there is no per-sun setting. What differs between suns is only where each one sits in the frame and how bright it is
*Missions can swap the lens and edit the iris at runtime with the lens [[#SEXPs|SEXPs]]
*The F3 lab (''Render options'' -> ''Lens flare options'') can override the mission's lens and adjust every aperture setting live, which is the practical way to dial in '''$Intensity:''' and the imperfection layers. It also exposes the global ghost and starburst brightness calibration and the HDR headroom, reports the mounted lens's ghost count, computed focal length and f-number, and lists what the last flare pass actually drew for each sun (visibility, off-axis angle, instance count). Lab edits are undone the same way mission edits are
*The flare is suppressed in full-nebula missions, in subspace, in VR, when post-processing is disabled, and when the Planets/Backgrounds detail setting is off

===SEXPs===
*'''set-camera-lens''' — mount a different lens system. Also accepts '''<nowiki><none></nowiki>''' for no flares at all and '''<nowiki><default></nowiki>''' for the table's '''$Default Lens:'''
*'''set-lens-aperture''' — blade count, rotation, curvature and edge softness
*'''set-lens-grating''', '''set-lens-scratches''', '''set-lens-dust''' — the imperfection layers

The four aperture operators take no lens argument: they restyle the iris of whatever lens is mounted, so a mission cannot edit a lens it is not looking through. With no lens mounted they do nothing and warn — use '''set-camera-lens''' first.

Note that these operators take '''percentages''' (0 to 100) and whole '''degrees''' where the table takes fractions (0.0 to 1.0) and floats; '''+Blade Curvature: 0.3''' in the table is an argument of '''30''' to '''set-lens-aperture'''.

Both the mounted lens and any iris edits are undone when the mission ends, so nothing carries into the next mission. These operators are not sent over the network, so in multiplayer they only affect the host.

The lens name given to '''set-camera-lens''' is validated when the mission loads, and a name that does not resolve aborts the load. This is safe because lens_flares.tbl is an engine default — the built-in lenses always resolve — but a mission naming a lens from a xxx-lens.tbm must ship with that .tbm.

==Default lens systems==
The built-in table ships eight lens systems, transcribed from published patents. All of them leave the imperfection layers off.

*'''angenieux_100mm''' — double-Gauss cine prime, f/2.2. The reference prescription from the research this renderer is based on, and the lens the others are calibrated against
*'''tessar_50mm''' — classic Tessar, f/3.5. Few elements, so a sparse and subtle ghost set
*'''canon_70_200mm''' — modern multicoated telephoto zoom, f/2.8. The busiest shipped lens: a dense, strongly tinted ghost train
*'''kodak_100mm''' — symmetric double Gauss, f/3.8, single-coated. A sparse, orderly ghost set that stays stable as the sun moves off-axis
*'''leica_35mm''' — fast aspherical wide-angle prime, f/1.4. The shortest focal length shipped, so its ghosts sweep the furthest
*'''nikon_50_135mm''' — multicoated telephoto zoom, f/3.5
*'''color_heliar_105mm''' — uncoated vintage prime, f/3.5. The uncoated reference: few, large, colourless, obvious ghosts
*'''zeiss_master_prime_50mm''' — modern multicoated cine prime, T1.3. Many large, bright, strongly tinted ghosts; the closest to a contemporary cinema look

==Sample==
<pre>
#Lens Systems

; Classic Tessar, f/3.5, f=50mm, with a little dust on the front element.
$Name: tessar_50mm
$Entrance Pupil Radius: 7.0
$Aperture Radius: 5.0
$Sensor Width: 36.0
$Coating Wavelength: 520
$Aperture Blades: 8
+Blade Rotation: 0.0
+Blade Curvature: 0.3
$Aperture Dust: 0.4
+Density: 0.3
+Radius: 0.25
$Starburst: YES
+Starburst Scale: 0.8
$Intensity: 0.2
$Max Ghosts: 24
$Surface: ( 16.25, 2.90, 1.6116 )
+Abbe: 56.9
$Surface: ( -285.90, 0.29, 1.0 )
$Surface: ( -30.05, 1.20, 1.6053 )
+Abbe: 43.6
$Surface: ( 17.47, 1.38, 1.0 )
$Stop: ( 1.15 )
$Surface: ( 31.55, 1.20, 1.5123 )
+Abbe: 51.0
$Surface: ( 21.30, 3.50, 1.6116 )
+Abbe: 56.9
$Surface: ( -23.70, 40.0, 1.0 )

#End
</pre>

To use it, name it from the info section of a mission (or pick it in the background editor, which writes the same line):

<pre>
$Camera Lens: tessar_50mm
</pre>

To put a whole campaign on it instead, without touching a single mission, declare it as the default in a xxx-lens.tbm:

<pre>
#Lens Systems

$Default Lens: tessar_50mm

#End
</pre>

[[Category:Tables]]

User:The E

2026-07-26T07:15:45Z

The E:

Talk:The Lucifer invincibility misconception

2023-12-19T12:57:01Z

The E:

What's the point of this article? Why is it written in a weirdly argumentative manner? Why is it claiming to cite multiple sources when it only cites ''one'' source that has been quoted multiple times? Why is it framing the long-running discussion on the Lucifer's shields as a "misconception"? --[[User:The E|The E]] ([[User talk:The E|talk]]) 09:32, 19 December 2023 (UTC)
* The point of this article is the exact same point of other articles addressing a wide range of topics concerning the FreeSpace Universe. This Wiki hosts them and they all have the exact same right to exist, providing they're grounded on canon or comparable sources. Though there's a ''caveat'' concerning the information provided by this article, as it's an indirect report from Volition instead of a proper source extrapolated from the two games, it still falls under the greater umbrella of canonical information just like the well known phrase "The Shivans are merely a symptom of a much bigger problem" (see. [[Canon]] and references therein). Though the phrasing and overall structure of the article may be improved and anyone can in fact edit it, I wouldn't say that it's written in a "weirdly argumentative manner". I also wouldn't argue over the purpose and existence of an article, as anything on the Wiki that does contribute to the general knowledge we have on the FreeSpace universe (''e.g.,'' this article) should be more than welcome. Furthermore, the fact that the references point to one specific source is not relevant, as the Volition source reporting on the Lucifer's supposed invincibility is indeed one source that was later brought to HLP by one veteran member of the community, but remained stagnant for years. And finally, the article does not undermine other arguments concerning the Lucifer's shields, as they are addressed elsewhere. - [[User:Mobius|Mobius]] ([[User talk:Mobius|talk]]) 12:01, 19 December 2023 (UTC)
** This should IMHO just be a section in the Lucifer article. You're drawing in multiple long-running discussions in the fandom (i.e. "are the Lucifer's shields really invulnerable" and "are FS1's Ancient Monologues meant to be interpreted literally or figuratively"), making completely unfounded statements on them based on what I assume is your interpretation of them, and presenting everything not agreeing with that interpretation as "misconception". This is why it reads as "weirdly argumentative": The entire argument is based on a post IceFire half-remembered years ago and several posts by others half-remembering that IceFire remembered something; that's borderline deceptive argumentation and smells of someone trying desperately to win an internet argument. Bottom line, this is a bad article, written with unclear motivations, that presents a tiny morsel of actual information and blows it up into a rant about "misconceptions" instead of doing something useful like providing an overview over the Lucifer shield debate. [[User:The E|The E]] ([[User talk:The E|talk]]) 12:56, 19 December 2023 (UTC)

Talk:The Lucifer invincibility misconception

2023-12-19T12:56:32Z

The E:

What's the point of this article? Why is it written in a weirdly argumentative manner? Why is it claiming to cite multiple sources when it only cites ''one'' source that has been quoted multiple times? Why is it framing the long-running discussion on the Lucifer's shields as a "misconception"? --[[User:The E|The E]] ([[User talk:The E|talk]]) 09:32, 19 December 2023 (UTC)
* The point of this article is the exact same point of other articles addressing a wide range of topics concerning the FreeSpace Universe. This Wiki hosts them and they all have the exact same right to exist, providing they're grounded on canon or comparable sources. Though there's a ''caveat'' concerning the information provided by this article, as it's an indirect report from Volition instead of a proper source extrapolated from the two games, it still falls under the greater umbrella of canonical information just like the well known phrase "The Shivans are merely a symptom of a much bigger problem" (see. [[Canon]] and references therein). Though the phrasing and overall structure of the article may be improved and anyone can in fact edit it, I wouldn't say that it's written in a "weirdly argumentative manner". I also wouldn't argue over the purpose and existence of an article, as anything on the Wiki that does contribute to the general knowledge we have on the FreeSpace universe (''e.g.,'' this article) should be more than welcome. Furthermore, the fact that the references point to one specific source is not relevant, as the Volition source reporting on the Lucifer's supposed invincibility is indeed one source that was later brought to HLP by one veteran member of the community, but remained stagnant for years. And finally, the article does not undermine other arguments concerning the Lucifer's shields, as they are addressed elsewhere. - [[User:Mobius|Mobius]] ([[User talk:Mobius|talk]]) 12:01, 19 December 2023 (UTC)
** This should IMHO just be a section in the Lucifer article. You're drawing in multiple long-running discussions in the fandom (i.e. "are the Lucifer's shields really invulnerable" and "are FS1's Ancient Monologues meant to be interpreted literally or figuratively"), making completely unfounded statements on them based on what I assume is your interpretation of them, and presenting everything not agreeing with that interpretation as "misconception". This is why it reads as "weirdly argumentative": The entire argument is based on a post IceFire half-remembered years ago and several posts by others half-remembering that IceFire remembered something; that's borderline deceptive argumentation and smells of someone trying desperately to win an internet argument.
Bottom line, this is a bad article, written with unclear motivations, that presents a tiny morsel of actual information and blows it up into a rant about "misconceptions" instead of doing something useful like providing an overview over the Lucifer shield debate. [[User:The E|The E]] ([[User talk:The E|talk]]) 12:56, 19 December 2023 (UTC)

Talk:The Lucifer invincibility misconception

2023-12-19T09:32:21Z

The E:

Talk:The Lucifer invincibility misconception

2023-12-19T09:32:03Z

The E: Created page with "What's the point of this article? Why is it written in a weirdly argumentative manner? Why is it claiming to cite multiple sources when it only cites ''one'' source that has b..."

SD Lucifer

2023-12-19T09:29:06Z

The E: Rewrite this entire section to be more neutral, remove "multiple sources" that are just one source

{{FS12_Ships}}
The '''''SD Lucifer''''' was a massive superdestroyer that led the [[Shivans|Shivan]] incursion during the [[Great War]]. Armed with two flux cannons—termed today as [[Beam weapons|beam cannons]]—the ''Lucifer'' possessed enough firepower to destroy capital ships and bombard planetary targets with ease. The vessel was rendered invulnerable to [[Terrans|Terran]] and [[Vasudans|Vasudan]] weapons through the employment of an advanced [[Shields|shield system]]. The ''Lucifer'' was responsible for the destruction of several worlds in Terran and Vasudan space, including the Vasudans' homeworld, [[Vasuda]] Prime.

Near the end of the Great War, Vasudan scientists fleeing the destruction of their homeworld discovered [[Ancient artifacts]] on a planet in the [[Altair]] system. The information enclosed in the artifacts described the technology necessary to track vessels in [[subspace]], something that neither the Terrans nor Vasudans had been able to do before. Coupled with the knowledge that [[shields]] did not function in subspace, a desperate plan was formulated to stop the ''Lucifer'' before the superdestroyer destroyed [[Sol]].

Launching from the [[GTD Bastion|GTD ''Bastion'']], a small number of fighter and bomber wings followed the ''Lucifer'' into subspace as the superdestroyer made the jump from [[Delta Serpentis]] to Sol. The gamble succeeded, with the ''Lucifer'' destroyed and Sol spared. Unfortunately, the destruction of the ''Lucifer'' within the subspace corridor had the unintended side effect of collapsing the subspace corridor from Sol to Delta Serpentis, cutting off the heart of the [[Galactic Terran Alliance]] from the rest of the universe. Nevertheless, the victory over the ''Lucifer'' effectively ended the Shivan incursion and Terran and Vasudan forces quickly evicted the remaining Shivan forces from their territories.

In the many decades following the Great War, the Terrans and Vasudans commissioned the jointly-designed [[GTVA Colossus|GTVA ''Colossus'']], which was originally designed to neutralize Shivan warships, including the ''Lucifer'', while at the same time being able to withstand multiple hits from the ''Lucifer'''s flux cannons. Ironically, no ''Lucifer''-class destroyers were ever encountered by both species again, even during the [[Second Shivan Incursion]].
{{shipimage|image=[[Image:Sdlucifer-old.jpg]]|caption=The SD Lucifer}}

==Description:==

===FS1 Tech Room Description===
The Lucifer is the greatest threat to the survival of the GTA, the PVN, and both the Terran and Vasudan species. It wields three massive Flux Cannons which can destroy one of our capital ships in a few hits. These same cannons have been seen bombarding colonized worlds. With four full fighter squadrons, and a massive array of defensive turrets, the Lucifer would be extremely difficult to destroy.

The fact that it is protected by a sheath shielding system which makes it completely impervious to any kind of kinetic or plasma damage makes it impossible to destroy. We have yet to find a way to breach this shielding technology. It is hoped that a solution will be found soon.
Assuming that a solution is found, we have managed to gather enough data on the Lucifer to destroy it. In a recon mission, we were able to determine that the Lucifer is powered by five reactors across its surface. If these reactors are destroyed in a short amount of time, the Lucifer will be stopped.

If we cannot stop the Lucifer, we do not expect to be able to defeat the Shivans.

We have no way of knowing if there are more than one Lucifer-class destroyer. However, any that exist should be considered more dangerous than a Class A threat.

===FS2 Tech Room Description===
The SD Lucifer was a massive superdestroyer that led the Shivan armada in the Great War. No weapon in the allied arsenal could penetrate the Lucifer's shields. In the Altair system, Vasudan scientists uncovered ancient artifacts that explained how to track ships into subspace, where the Lucifer's shields would not function. A desperate mission to attack the Lucifer in subspace succeeded. But the explosion of the Lucifer collapsed the Sol jump node, severing all contact with Earth. The victory over the Lucifer effectively ended the Shivan invasion.

==History==
{{Gtvaship
| image = [[Image:RScreen0023.jpg|300px]]
| name = SD ''Lucifer''
| class = SD ''Lucifer''
| 1stapp = [[The Aftermath]] (mentioned) [[Playing Judas]] (appeared)
| inservice = [[Great War]]
| faction = [[Shivans]]
| fate = [[Good Luck|Destroyed]] in 2335
}}
The ''Lucifer's'' first known sighting was in the [[Ross 128]] system, the prelude to the Great War with the Shivans (FS1 Intro).

The ''Lucifer'' did not reemerge until 2/11/35, when it suddenly appeared in the [[Ribos]] system, destroying the ''Tombaugh Installation'' and all its defences. Terran Command believed that it had tracked the captured Shivan Cruiser, the ''Taranis'', through subspace to the ''Tombaugh Installation'' ([[Briefing_texts_%28FS1%29#Command_Briefing_6|CB sm2-01a.fsm]] and [[Briefing_texts_%28FS1%29#Command_Briefing_8|CB sm2-05a.fsm]]).

By 2/20/35, the [[Shivans]] had completely bypassed the Terran blockades in [[Antares]] and [[Beta Aquilae]], proceeding immediately to [[Deneb]] through [[Vega]] (CB sm2-07a.fsm). Terran Command believed that the ''Lucifer'' would attack [[Vasuda]] through [[Antares]], while the ''Eva'', [[SD Demon|a Shivan Demon-class destroyer]], would attack through [[Deneb]].

However, on 2/31/35 the ''Lucifer'' was seen jumping into Deneb system from the Deneb-Vega jump node with the SD Eva taking the lead([[Playing Judas|sm2-08a.fsm]] and [[Briefing_texts_%28FS1%29#Debriefing_18|its debriefing]], [[Briefing_texts_%28FS1%29#Mission_Briefing_19|mission briefing sm2-09a.fsm]]). It is unknown whether the Lucifer jumped to Vega directly from Ribos, or through Antares (the Eva entered Vega through the Antares-Vega jumpnode).

In retaliation for the destruction of the SD Eva, the ''Lucifer'' directly confronted and destroyed the GTD Galatea (at 1900hrs 2/31/35; [[Doomsday|sm2-10a.fsm]] and [[Briefing_texts_%28FS1%29#Debriefing_20|its debriefing]], [[Briefing_texts_%28FS1%29#Command_Briefing_11|CB sm3-01a.fsm]]).

Shortly afterwards, the ''Lucifer'' made the jump to [[Vasuda]] through the Deneb-Vasuda jumpnode ([[Briefing_texts_%28FS1%29#Command_Briefing_11|CB sm3-01a.fsm]]). Once in Vasuda, 2/31/25-3/01/35, the Lucifer Fleet bombarded [[Vasuda Prime]] from orbit for 13 consecutive hours, rendering the planet uninhabitable. The 'Lucifer fleet rapidly redeployed, now searching for the Terran homeworld.

On 3/01/35-3/02/35, the ''Lucifer'' jumped to [[Beta Aquilae]], destroying the ''Beta Aquilae Installation'', but left the PVD Hope and the ''Beta Aquilae Communications Terminal'' intact ([[Briefing_texts_%28FS1%29#Mission_Briefing_23|mission briefing sm3-03a.fsm]], [[Briefing_texts_%28FS1%29#Command_Briefing_12|CB sm3-04a.fsm]]).

The ''Lucifer'' was not encountered until 3/02/35, when it jumped next to the Deneb-Altair jumpnode, deploying fighter wings to attack transports carrying scientists to the [[Altair]] system ([[Briefing_texts_%28FS1%29#Running_the_Gauntlet|sm3-05a.fsm]] and [[Briefing_texts_%28FS1%29#Debriefing_25|its debriefing]]).

By 3/29/35, after determining the location of the Sol system, the Lucifer was reported to be in the Sirius system to make the jump to [[Delta Serpentis]] ([[Briefing_texts_%28FS1%29#Command_Briefing_13|CB sm3-07a.fsm]]). GTA Command ordered the [[GTD Bastion]] to intercept and destroy the ''Lucifer'' before it could reach Sol. Admiral Shima quickly drew up plans to intercept the Lucifer at the Sirius-Delta Serpentis jumpnode. However by the time the Bastion arrived in range of the jumpnode, the Lucifer had already departed the system. Admiral Shima estimated that the ''Lucifer'' would reach Earth in 40 hours ([[Briefing_texts_%28FS1%29#Debriefing_27|Debriefing 4: sm3-07a.fsm]]).

On the GTD ''Bastion's'' final approach to the Delta Serpentis-Sol jumpnode, the ''Lucifer'' was on the brink of jumping to Sol ([[Briefing_texts_%28FS1%29#The_Great_Hunt|sm3-08a.fsm]]). The ''Bastion'' scrambled its fighters and a wing of Ursa Bombers to pursue the Lucifer into subspace. While inside the subspace corridor, the Ursa bombers managed to destroy all five of the Lucifer's reactors, resulting in the Lucifer's destruction ([[Briefing_texts_%28FS1%29#The_Great_Hunt|sm3-09a.fsm]]).

===Inconsistency===
In the Command Briefing of sm2-08a.fsm (2/31/35), Admiral Wolf indicates that Alpha 1 had investigated the Lucifer in Antares: "We have now entered the Deneb system. After your investigation of the Lucifer at Antares, Terran Command has deduced that the Shivans will be attempting a multiple pronged attack on Vasuda Prime coming from Deneb and Antares." However, Alpha 1 does not see the Lucifer in Antares, nor does Alpha 1 play a mission "investigating" the ''Lucifer'' in Antares. It may be that the mission designer incorrectly meant Alpha 1's investigation of the ''Eva'' in Antares near the Antares-Vega Jump Node (which jumped out shortly after its arrival; sm2-06a.fsm).

==Developer Notes==
*'''Also read: [[The Lucifer invincibility misconception]]
[https://www.hard-light.net/forums/index.php?topic=26456.msg531216#msg531216 According to a long-time community member], [[Volition]] developers stated on the now-defunct Volition Watch boards that the Lucifer was not supposed to be truly invincible and that sufficient firepower could eventually penetrate its shields. Since the forums where these statements were made are no longer accessible, we do not have a direct quote for this.

==Name Origin==
The name "Lucifer" is of Latin origin. It's composed by the name ''lux'', which means ''light'', and the verb ''ferre'', which has many meanings (in this case ''bringing'' and ''bearing'' fit well). The meaning of the name would be ''"Bringer/Bearer of Light"''.

Lucifer is a fallen angel who was cast out of heaven after losing The War of Heaven. Lucifer is said to be the enemy of God, and the embodiment of evil.

Lucifer is also depicted sometimes as being the judge of the Inferno, answering to Satan himself. It is said that the demonic persona Belial was his father. It's highly probable that Dante Alighieri's vision of Lucifer affected the popular vision, too. Dante represented it as a monster with three heads devouring the traitors Judas, Brutus and Cassius.

Lucifer was also one of the names given to the planet Venus, when it was thought to be a star. Other given names depending on its position were Hesperos and Phosphoros and, of course, the Shepherd's Star.

==Performance:==
===Statistics===
{{Ship_box
|name = SD Lucifer
|type = Destroyer
|max_velocity = 15
|hitpoints = 800 000
|length = 2 777
|turrets = 17+
|fighters = ?
}}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Turrets|Turrets]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=2 style="background:#351515;"| '''FreeSpace 1'''
| colspan=2 style="background:#300505;"| '''FreeSpace 2'''
|- align="center"
| style="width:120px" |Turret Type
| style="width:60px" |Amount
| style="width:120px" |Turret Type
| style="width:60px" |Amount
|- align="center"
| [[Shivan Turret Laser]]
| 11
| [[Shivan Turret Laser]]
| 11
|- align="center"
| [[FighterKiller]]
| 2
| [[FighterKiller]]
| 2
|- align="center"
| [[Shivan Cluster]]
| 2
| [[Shivan Cluster]]
| 2
|- align="center"
| [[Shivan Super Laser]]
| 2
| [[SRed|Small Red Beam]]
| 2
|}

==Modding Resources==
{{shipimage|image=[[Image:Lucifer480x340.jpg]]|caption=3.6.10 SD Lucifer}}
'''Retail''': 
:$POF File: capital02.pof 
:Textures: capital02-01(a/b/c), capital02-02(a/b), capital02-03(a/b), capital02-04(a/b) 

'''MediaVP 3.6.10''': 
:$POF File: capital02.pof 
:Textures: lucifer-htl, capital02-01c, Lucifer-HTL_Debris, DocTile6A 
 
[http://www.sectorgame.com/forums/viewtopic.php?t=1639 History] 
First WIP Post: Vasudan Admiral on 04/21/2005 
First In-Game Model: ??? on ??? 
Completed In-Game Model: Vasudan Admiral on [http://www.hard-light.net/forums/index.php?topic=37131.0 12/09/2005] 
Final Corrections: ??? on ??? 

==Gallery==

<gallery>
Image:RScreen0004.jpg | The nigh-invulnerable ''Lucifer'' cruising through space.
Image:RScreen0023.jpg | The ''Lucifer'' enters the [[Ribos]] system.
Image:FSPort Lucifer Subspace.jpg | The ''Lucifer'' in the Delta Serpentis-Sol jump corridor.
</gallery>

==Veteran Comments==
{{Comment|''Very deadly in FS1, but in FS2 its [[Shivan Super Laser]]s have been replaced with [[SRed]]s, making it more of a heavily armored target and less of a superdestroyer.''

''FREDders should be aware that, except for the FreeSpace Port version of the FS1 main campaign, the ''Lucifer'' has no such thing as a shield. It's invulnerable because it has the Invulnerable flag turned on (Ship Editor -- Misc).''

''Cutscenes and command briefing videos feature the Lucifer having a pair of "horns" sticking out on its top. Yet in FreeSpace 1 and retail FreeSpace 2, no such things are encountered on the Lucifer at all. However, they are added on in the MediaVPs.''

''The MediaVPs model also includes a two extra turrets which are unused by default and appear as decorations (you can't even target them). These are the side-mounted "claw" beams seen in the cutscenes and command briefing animations, occasionally referred to as the "bombardment beams" it used to bombard Vasuda Prime. They can be activated by a simple table edit if you choose to do so for your mod, giving the Lucifer a bit more bite.

''Its four missile launchers (2 FighterKillers and 2 cluster missile launchers) are the Lucifer's primary means of defense against fighters. It just doesn't have enough Shivan Turret Lasers to cover its whole area.''

''MediaVPs model also includes an actual shield mesh, making the Lucifer effectively invulnerable to bombing runs, primaries, and turret fire. It can still, however, be damaged with anti-warship beams, though it has enough health to survive enemy beam weapons and the SRed will eventually peck away at an Orion or a Typhon.''}}

[[Category:Unique ships|Lucifer]]
[[Category:Ship]]

Awakenings

2023-04-22T12:38:17Z

The E: correct name spelling

Classic FS1 campaign remastered by the [[FreeSpace Campaign Restoration Project|FSCRP]]

==Overview==
Team

*John Hanton

*Nicole Hoying

Mods: none

*Voice Acted

Missions: 13

==Description==
Three years have passed since the collapse of the Sol jump nodes. The Galactic Terran Alliance have just successfully completed their counterstrike against the confused Shivan forces. But now, things are going bad for the GTA. Shivan ships are pushing back in to reclaimed systems, in higher numbers than during the first months of the Great War. With the Terrans and Vasudans still recovering from the loss of key bases and ship yards, the Shivans are preparing for the next great push over.

You are one of the many pilots stationed at Galatea Station in the Vasuda system. As a seasoned veteran of the 14-year war, you look at your new assignment as one of confusion, as you are now sworn to protect the very system you vowed to destroy. Things go slowly on the station. You spend most of your time protecting the construction of the Vasuda 5 Shipyards, the largest Terran-Vasudan shipyard ever built. From the new shipyards, the T-V alliance plans to take the fight to the Shivan homeworld.

While conducting a routine attack on HOL cruisers near the jump to Antares, a pair of GTD Orion class destroyers jump out of the middle of nowhere. Where did these ships come from? What happened to the crew? What will become of the GTA?

==Comments==

==Availability==
[http://www.hard-light.net/forums/index.php/topic,42579.0.html Release thread for FSPort version]

[http://www.freespacemods.net/download.php?view.16 Freespacemods.net Download]

[[Category:User-made_Campaigns]]

Weapons.tbl

2023-01-17T13:55:09Z

The E: /* +Weapon Range: */

{{TableVersionGit|2022-22-11|cfdeeb7109248248d5437e635e509ca0ae65247e}}
{{Tables}}
The '''weapons.tbl''' defines all of the weapon classes used in FSO.

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

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

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

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

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

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

==General Format==
*The weapons table consist of several sections
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>'''End''' before the next section.
**<nowiki>#</nowiki>'''Primary Weapons'''
***Defines all '''standard primaries weapons''' as well as '''beam cannons''' and '''flak cannons'''.
**<nowiki>#</nowiki>'''Secondary Weapons'''
***Defines all '''secondary weapons'''.
**<nowiki>#</nowiki>'''Beam Weapons'''
***I haven't got any ideas for this one.
**<nowiki>#</nowiki>'''[[Weapons.tbl#Countermeasures|Countermeasures]]'''
***Defines the used countermeasure.
**'''$Player Weapon Precedence'''
***Player Weapon Precedence is used in weapon selection when a default specified by the mission designer is not available to the player. The next weapon on the list is used in its place (assuming that weapon is allowed for the player).

==Core Table==

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

====+nocreate====
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in Weapons.tbl or in earlier parsed *-wep.tbm files) by the time the *-wep.tbm is read.}}

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

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

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

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

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

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

'''Example'''

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

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

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

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

'''Example'''

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Blending type: additive

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

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

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

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

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

Blending type: additive

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

====@Laser Length:====
Defines the length of the weapon effect.
*This option stretches the 2D plane "away" from its origin.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Length: 1.0
</pre>

====@Laser Head Radius:====
Defines the width of the leading edge, or "head," of the weapon effect.
*The edge of the 2D plane farthest away from its origin is the leading edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Head Radius: 0.75
</pre>

====@Laser Tail Radius:====
Defines the width of the trailing edge, or "tail" of the weapon effect.
*The edge of the 2D plane that is closest to its origin is the trailing edge.
Syntax: '''''Float''''', meters

'''Example:'''
<pre>
@Laser Tail Radius: 0.75
</pre>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

===$Angle of Incidence Damage Multiplier:===
{{Table212|
*Causes the weapon's damage to be multiplied by these factors depending on the angle of incidence.
*It is ''not'' linear, it is based on the sine of the angle to the surface. If the factors are 1x for minimum, and 2x for maximum, at an angle of 45° the multiplier is 1.707x, for instance.
====+Min:====
*The damage multiplier at a perfectly glancing hit, parallel to the surface (although not technically possible).
*Syntax: '''''Float'''''
====+Max:====
*The damage multiplier when hit straight on, perpendicular to the surface.
*Syntax: '''''Float'''''}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

===$Outer Radius:===
*Maximum radius at which any damage is done. See $Inner Radius for the attenuation formula.
*Also defines the size of the shockwave (if shockwave speed is > 0)
*Note: adding an inner and/or outer radius to a weapon doubles its effective damage to the target (i.e. 1x impact, 1x area effect)
*Syntax: '''''Float''''', meters

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Defines if the bolts/missiles in question is homing

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

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

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

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

===='''+Turning Acceleration Time:'''====
{{Table202|
Determines how quickly the missile reaches its maximum turn speed.
*Note: Requires [[Game_settings.tbl#.24AI_use_framerate_independent_turning:|$AI use framerate independent turning]] in game_settings.tbl
**Syntax: '''''Float''''', seconds}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

===$Trail:===
*This is used if you want your weapon to have a trail. Trail is often used only with secondaries though it works with standard primaries as well.
*'''+Start Width:'''
**How wide the head of the trail is.
**Syntax: '''''Float''''', meters
*'''+End Width:'''
**How wide the tail of the trail is.
**Syntax: '''''Float''''', meters
*'''+Start Alpha:'''
**The opacity of the trail head.
**Syntax: '''''Float''''', value between 0 and 1
*'''+End Alpha:'''
**The opacity of the trail tail.
**Syntax: '''''Float''''', value between 0 and 1
{{Table212|
*'''+Alpha Decay Exponent:'''
**Causes the trail to fade away non-linearly. The 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)

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

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

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

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

}}

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

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

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

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

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

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

===$Countermeasure:===

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

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

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

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

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

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

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

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

====+Failure Launch Delay Multiplier for AI:====
*After a failed countermeasure launch the game waits a certain time interval before attempting another launch.
*Previously, the amount of time was calculated as ('fire wait' + 2000 * 'countermeasure firing chance').
*If set to a non negative number, this value will be multiplied to the fire wait value to determine the amount of time before another countermeasure can be attempted.
*Syntax: '''''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
}}
{{Table224|
*'''+Use Random Rotation:'''
**Syntax: '''''Boolean''''', Whether or not a random rotation is added to the decal; default is NO
}}

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

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

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

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

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

===$Burst Flags:===
{{Table3611|
*Defines the flags used to define the burst firing behaviour
**Syntax: ( '''''String''''' '''''String''''' ), list of flags
**Available burst flags:
***'''"fast firing"''', acts as if '''same turret cooldown''' flag would be used between the shots in the burst.
***'''"random length"''', makes AI to fire burst of random length (from 1 to burst shots).}}
{{Table202|'''"resets"''', as long as a full fire wait has passed since last fired, the burst is reset and can be fired in full again.}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

}}

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

+Val: Name Value

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

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

==Weapons.tbl Flags==

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

==Sample==

<pre>
#Primary Weapons

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

#End

#Secondary Weapons

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

#End

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

[[Category:Tables]]

Command-Line Reference

2020-06-07T17:43:58Z

The E: /* -fxaa_preset */

{{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====
{{Table201|
'''"Enable post-processing antialiasing"'''
This flag enables 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. If that is insufficient, or if it is to taxing on the GPU, the -aa_preset commandline parameter can be used to choose a different preset; 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.
{{Table201|
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.
{{Table201|
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)

===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| This feature is not available in current builds.}}

====-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====
{{table201|
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 microseconds. ''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"'''

==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 75. 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====
{{table201|
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.
{{table201|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.
{{table201|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, 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.

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

2020-06-07T17:39:33Z

The E: /* -smaa_preset */

{{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====
{{Table201|
'''"Enable post-processing antialiasing"'''
This flag enables 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. If that is insufficient, or if it is to taxing on the GPU, the -aa_preset commandline parameter can be used to choose a different preset; 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.
{{Table201|
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.
{{Table201|
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)

===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| This feature is not available in current builds.}}

====-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====
{{table201|
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 microseconds. ''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"'''

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

====-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.
{{table201|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.
{{table201|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, 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.

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

2020-06-07T17:39:21Z

The E: /* -fxaa_preset */

{{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====
{{Table201|
'''"Enable post-processing antialiasing"'''
This flag enables 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. If that is insufficient, or if it is to taxing on the GPU, the -aa_preset commandline parameter can be used to choose a different preset; 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.
{{Table201|
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.
{{Table201|
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)

===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| This feature is not available in current builds.}}

====-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====
{{table201|
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 microseconds. ''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"'''

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

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

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

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

2020-06-07T17:37:20Z

The E: /* -shadow_quality */

{{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====
{{Table201|
'''"Enable post-processing antialiasing"'''
This flag enables 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. If that is insufficient, or if it is to taxing on the GPU, the -aa_preset commandline parameter can be used to choose a different preset; 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.
{{Table201|
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.
{{Table201|
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)

===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| This feature is not available in current builds.}}

====-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====
{{table201|
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 microseconds. ''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"'''

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

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

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

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

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

Decals

2020-05-23T09:32:34Z

The E:

{{TableVersionGit|2017-11-17|a3651026}}

The Decal system in FreeSpaceOpen can be used to create permanent or semi-permanent effects, like impact marks for example.

This table is distributed exclusively in tbm format (as *-dcl.tbms).

Note that decals are only usable on systems that support deferred rendering and normal mapping.

==General Format==
*This table consists of one section, beginning with <nowiki>#</nowiki>Decals and ending with <nowiki>#</nowiki>End.

==Core Table==

===$Decal:===
*Starts a decal definition. The name chosen here can be referenced elsewhere and should be unique.
*Syntax: '''''String'''''
====+Diffuse:====
*The filename for a diffuse map. This can be an animation.
*Syntax: '''''String''''', filenames should be provided without an extension.
=====+Loop:=====
*Whether the animation should loop.
*Syntax: '''''Boolean''''', default is True
====+Glow:====
*The filename for a glow map. This can be an animation.
*Syntax: '''''String''''', filenames should be provided without an extension.
=====+Loop:=====
*Whether the animation should loop.
*Syntax: '''''Boolean''''', default is True
====+Normal:====
*The filename for a normal map. This can be an animation.
*Syntax: '''''String''''', filenames should be provided without an extension.
=====+Loop:=====
*Whether the animation should loop.
*Syntax: '''''Boolean''''', default is True

Decals

2020-05-23T09:31:49Z

The E: Add a basic page for the decal system

{{TableVersionGit|2017-11-17|a3651026}}

The Decal system in FreeSpaceOpen can be used to create permanent or semi-permanent effects, like impact marks for example.

This table is distributed exclusively in tbm format (as *-dcl.tbms).

Note that decals are only usable on systems that support deferred rendering and normal mapping.

==General Format==
*This table consists of one section, beginning with <nowiki>#</nowiki>Decals and ending with <nowiki>#</nowiki>End.

==Core Table==

===$Decal:===
*Starts a decal definition. The name chosen here can be referenced elsewhere and should be unique.
*Syntax: '''''String'''''
====+Diffuse:====
*The filename for a diffuse map. This can be an animation.
*Syntax: '''''String''''', filenames should be provided without an extension.
====+Loop:====
*Whether the animation should loop.
*Syntax: '''''Boolean''''', default is True
====+Glow:====
*The filename for a glow map. This can be an animation.
*Syntax: '''''String''''', filenames should be provided without an extension.
====+Loop:====
*Whether the animation should loop.
*Syntax: '''''Boolean''''', default is True
====+Normal:====
*The filename for a normal map. This can be an animation.
*Syntax: '''''String''''', filenames should be provided without an extension.
====+Loop:====
*Whether the animation should loop.
*Syntax: '''''Boolean''''', default is True

Weapons.tbl

2020-05-23T09:15:17Z

The E: Add documentation for the new decal system

{{TableVersionGit|2017-08-25|2039815}}

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

[[Tables|List of Tables]]

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

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

===$Mass:===
*How much of a kinetic effect this weapon has on its target. 3+ gives you the Flail effect. Set it to 10 and you can knock cruisers around.
*This is somehow multiplied by the speed. ie ''$Mass: 3'' and ''$Velocity: 200'' has much weaker kinetic effect than ''$Mass: 3'' and ''$Velocity: 1000''. Also $Mass is used to calculate intensity of "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 5.5 times the damage value per second. The actual damage is this number multiplied by one of the factors below.
*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.}}

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

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

===$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 travelling its max range - 20 meters.
*Syntax: '''''Float''''', penalty in meters.}}

===$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.
*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 turretted 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.'''

Defines if the bolts/missiles in question is homing
*The bolts of primaries will turn to face their target if this option is set to YES... but is otherwise the same as a normal bolt ( when the option is set to NO ).

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 well the missile maneuvers. Is defined as the number of seconds it takes the missile to do a 360 degree circle
**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.}}

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

===$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. Especially when fired off-bore.
*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
***Max: 0.5 (Resets to default if set over 0.5)}}

===$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 travelling 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 currently parses but doesn't use the value, and prints a warning in the log saying that the value will not be used.}}
}}

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

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

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

===$InFlightSnd===
{{Table3615|
*The looping sound played when the missile is 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}}

===$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
*'''+Max Life:'''
**How long the trail lasts.
**Syntax: '''''Float''''', seconds
*'''+Bitmap:'''
**The graphic file to use for the trail.
**Syntax: '''''String''''', filename
{{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:===
*If it has an EMP effect, how deeply it scrambles your electronics
*Basically a percentage, a value of 250 results in a 25% chance of something getting scrambled each frame.
*Maximum value of 500
**Syntax: '''''Float'''''

===$EMP Time:===
**Duration of the EMP effect
**Syntax: '''''Float''''', seconds

===$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 missiles centerline. The maximum possible angle between any two child weapons would be ''Value*2''.
*Spawn angle can be defined as many times as the carrier missile has child weapons defined for it (up to 5).
*Syntax: '''''Float''''', degrees}}

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

===$BeamInfo:===
*'''+Type:'''
**Defines the type of beam in question. Beam types: 0 is a standard non-slashing type beam. 1 is a slashing type beam. 2 is a targeting beam that is used to trigger SSMs. 3 is a beam type that fires pulses in anti-fighter role and acts like type 0 beam in other roles. 4 is a beam that is restricted to what is directly in front of it, along turrets firepoints normal.
**Syntax: '''''Integer''''',, only values from 0 to 4 are legal
*'''+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:
**Syntax: '''''Integer'''''
*'''+ShrinkFactor:'''
**What percentage of lifetime where beam starts shrinking (0.1 == 10% life left)
**Syntax: '''''Float'''''
*'''+ShrinkPct:'''
**What percentage of max width we subtract per second
**Syntax: '''''Float'''''
{{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''''
{{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'''''}}

*'''$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 illiminates 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 strenght 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
**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).}}

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

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

==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 targetable with the B key, and the AI prefers to use it against large ships

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

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

==="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).'''}}

==="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.
'''Do not use this with MVPs or retail ships unless you increase their density to 10 or use either $Recoil Modifier: in weapons.tbl or $Ship Recoil Modifier in ships.tbl. This is to avoid exaggerated effects due to retail models having manually defined masses.'''}}

==="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"===
{{Table201|
*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.}}

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

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

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

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

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

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

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

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

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

==Sample==

<pre>
#Primary Weapons

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

#End

#Secondary Weapons

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

#End

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

[[Category:Tables]]

Command-Line Reference

2020-05-04T20:14:34Z

The E:

{{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====
{{Table201|
'''"Enable post-processing antialiasing"'''
This flag enables 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. If that is insufficient, or if it is to taxing on the GPU, the -aa_preset commandline parameter can be used to choose a different preset; 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.
{{Table201|
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.
{{Table201|
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)

===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| This feature is not available in current builds.}}

====-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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-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 microseconds. ''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"'''

==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 75. Range is 0-200.

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

Valid ranges are 0 to 2 with 2 being the default.

* 0 disables shadows (so there's no point in setting it!)
* 1 uses 512x512 shadow maps (lower quality)
* 2 uses 1024x1024 shadow maps (higher 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.

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

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

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

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

2020-05-01T17:47:49Z

The E: Add documentation for the -fxaa and -smaa cmdline flags.

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

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

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

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

===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| This feature is not available in current builds.}}

====-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====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

====-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 microseconds. ''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"'''

==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 75. Range is 0-200.

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

Valid ranges are 0 to 2 with 2 being the default.

* 0 disables shadows (so there's no point in setting it!)
* 1 uses 512x512 shadow maps (lower quality)
* 2 uses 1024x1024 shadow maps (higher 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.

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

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

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

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

Ships.tbl

2020-02-22T11:39:21Z

The E: /* "capital" */

{{TableVersionGit|2019-05-07 UTC|5f5616c0f}}

The '''ships.tbl''' defines all the ship classes used in FSO.

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

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*This setting does nothing
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

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

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$POF file Techroom:===
*Filename of the model file (.pof) at data/models folder; used only in the weapon loadout screen
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

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

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$Collision LOD:===
{{Table373|
*Defines an alternative LOD (Level-Of-Detail) to use for collision detection. Using this can increase performance without visible drawbacks if the LOD chosen has much simpler geometry but the shape still closely matches the base model.
*This works as follows: collision detection proceeds normally through the various model/submodel radius and bounding box checks based on LOD0, but when the game decides to perform a mesh-based collision check of a given submodel, it will use the submodel's LOD mesh instead. However, all submodels do not need to have a counterpart in the given LOD; if one is not found, the closest alternative will automatically be used instead.
*For example, if ''$Collision LOD: 3'' is used and the submodel engine01a is checked for a hit, the game will attempt to use the mesh of engine01d instead. However, if there is no engine01d submodel, the game will find the closest alternative: it'll look for engine01c, then engine01b, and finally fall back to engine01a. Note the implications of for example the root LOD submodel (detaild, detail3, etc) including the geometry of subsystem submodels; if detail0 is checked for a collision before engine01a, and detail3 includes the engine geometry (as opposed to having it in engine01d), then the subsystem engine01a cannot be hit.
**Syntax: '''''Integer'''''}}

===$ND:===
NOTE: this option has done nothing since before 2008

*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1. Must not be 0.

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

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

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Player Minimum Velocity:===
{{Table38|
*Defines minimum velocities on x (left/right), y (up/down), and z (forward) -axis (respectively). This affects the player only, the AI ignores the value.
*The x and y velocities are considered slide velocities, the minimums for them are '''not currently implemented'''.
*When gliding, if the absolute speed vector of the players ship falls below the minimum then the ships engines will re-engage and cannot be switched off again until the ships absolute vector exceeds the z-minimum.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 40.0''
}}

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence
{{Note|If none of the following optional strings are added, the weapon will not converge. Don't forget to use them.}}
}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, [[Game_settings.tbl#.24Minimum player warpout time:|defaults to]] 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Death Roll X rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on X-axis (pitch) rotation during the ships deathroll. The value is radians per second. The current hard-coded minimum is 0.8. Note the code generally won't use this value for ships with radius > 150 (hard-coded).
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Y rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Y-axis (yaw) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Z rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Z-axis (roll) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used the final explosion of this ship type,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Ship Death Particles'' is not a valid option!
}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization, 0 to 100}}

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

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

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

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Minimum Weapon Span:====
{{Table373|
*Determines the minimum distance weapons must have traveled before impacting the shield (for example if fired close to or inside the shield). Does not affect whether the weapon bypasses shields, unless +Allow Bypass (see below) is set to ''YES''. Only valid with auto spread shields.
*Syntax: '''''Float''''', defaults to the shield thickness.}}

====+Allow Bypass:====
{{Table371|
*Determines whether weapons which impact on the ship's hull (see +Minimum Weapon Span above) will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean'''''
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Shield Impact Explosion:===
{{Table373|
*Impact explosion animation to trigger when this ship's shields are hit. Works identically for all shield types.
*Note: The size of the explosion is defined by the weapon, see [[Weapons.tbl#.24Shield_Impact_Explosion_Radius:]].
*Syntax: '''''String''''', filename or ''none''
}}

===$Max Shield Recharge:===
{{Table373|
*Determines a maximum recharge limit of shields. When used, the combined maximum shield energy is lowered, meaning that shield energy can be moved between quadrants even with shields fully charged.
*Syntax: '''''Float''''', multiplier ranging from 0.0 to 1.0, defaults to 1.0
**Example: ''$Max Shield Recharge: 0.5'' caps the combined shield energy to 50%, meaning that a ship with 4 shield quadrants will by default have 12.5% strength on all quadrants (instead of normal 25%), allowing it to for example augment one quadrant to 50% while dropping other quadrants to 0%.
}}

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''
*Affected by ETS Shields value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Shield Recharge Scale:}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''
*Affected by ETS Guns value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Weapon Recharge Scale:}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', percentage of total subsystem hitpoints repaired per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$Scan range Normal:===
{{Table381|
*Distance at which the ship can scan other small ships or large ship subsystems
*Syntax: '''''Float''''', distance
}}

===$Scan range Capital:===
{{Table381|
*Distance at which the ship can scan capital (& similar size) ships
*Syntax: '''''Float''''', distance
}}

===$Ask Help Shield Percent:===
{{Table381|
*Percentage of shield damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$Ask Help Hull Percent:===
{{Table381|
*Percentage of hull damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ExplosionSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the ship explodes
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Flyby Sound===
{{Table382|
*Optional sound to be used for the fly-by sound
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). The position of the camera relative to the model in the tech room and the target box view. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). How far the camera's zoomed in, defines camera's FOV. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''("String" "String")'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Subsystem<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour
*By default, the ship's subsystems are scannable (this can be overridden by mission designers)
*The ship will warp out without ramping up to warpout speed
*When using the "Knossos" warpout, this ship will aim for the center of the portal

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour
*The following things are true for all ships with this flag:
**When hit by debris, damage dealt by the collision is capped to between 10 and 20% of the ship's health maximum (determined randomly for each collision)
**All damage dealt by weapons without the corresponding supercap flag from weapons.tbl will be reduced by 75%
**In addition, once the ship is at or below 75% health, damage from non-supercap weapons is completely negated
**Do note that shockwave damage, regardless of origin, is not subject to these rules unless the "$Weapon shockwave damage respects huge ship flags:" setting in game_settings.tbl is set to true
**Ship subsystems are scannable by default (can be overridden by mission designers)
**The ship does not need to ramp up to warpout speed before entering subspace
**When using the "Knossos" warpout, the ship will aim for a departure point at the center of the Knossos portal

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Ships.tbl

2020-02-22T11:28:47Z

The E: /* "super cap" */

{{TableVersionGit|2019-05-07 UTC|5f5616c0f}}

The '''ships.tbl''' defines all the ship classes used in FSO.

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

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*This setting does nothing
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

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

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$POF file Techroom:===
*Filename of the model file (.pof) at data/models folder; used only in the weapon loadout screen
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

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

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$Collision LOD:===
{{Table373|
*Defines an alternative LOD (Level-Of-Detail) to use for collision detection. Using this can increase performance without visible drawbacks if the LOD chosen has much simpler geometry but the shape still closely matches the base model.
*This works as follows: collision detection proceeds normally through the various model/submodel radius and bounding box checks based on LOD0, but when the game decides to perform a mesh-based collision check of a given submodel, it will use the submodel's LOD mesh instead. However, all submodels do not need to have a counterpart in the given LOD; if one is not found, the closest alternative will automatically be used instead.
*For example, if ''$Collision LOD: 3'' is used and the submodel engine01a is checked for a hit, the game will attempt to use the mesh of engine01d instead. However, if there is no engine01d submodel, the game will find the closest alternative: it'll look for engine01c, then engine01b, and finally fall back to engine01a. Note the implications of for example the root LOD submodel (detaild, detail3, etc) including the geometry of subsystem submodels; if detail0 is checked for a collision before engine01a, and detail3 includes the engine geometry (as opposed to having it in engine01d), then the subsystem engine01a cannot be hit.
**Syntax: '''''Integer'''''}}

===$ND:===
NOTE: this option has done nothing since before 2008

*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1. Must not be 0.

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

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

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Player Minimum Velocity:===
{{Table38|
*Defines minimum velocities on x (left/right), y (up/down), and z (forward) -axis (respectively). This affects the player only, the AI ignores the value.
*The x and y velocities are considered slide velocities, the minimums for them are '''not currently implemented'''.
*When gliding, if the absolute speed vector of the players ship falls below the minimum then the ships engines will re-engage and cannot be switched off again until the ships absolute vector exceeds the z-minimum.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 40.0''
}}

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence
{{Note|If none of the following optional strings are added, the weapon will not converge. Don't forget to use them.}}
}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, [[Game_settings.tbl#.24Minimum player warpout time:|defaults to]] 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Death Roll X rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on X-axis (pitch) rotation during the ships deathroll. The value is radians per second. The current hard-coded minimum is 0.8. Note the code generally won't use this value for ships with radius > 150 (hard-coded).
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Y rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Y-axis (yaw) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Z rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Z-axis (roll) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used the final explosion of this ship type,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Ship Death Particles'' is not a valid option!
}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization, 0 to 100}}

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

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

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

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Minimum Weapon Span:====
{{Table373|
*Determines the minimum distance weapons must have traveled before impacting the shield (for example if fired close to or inside the shield). Does not affect whether the weapon bypasses shields, unless +Allow Bypass (see below) is set to ''YES''. Only valid with auto spread shields.
*Syntax: '''''Float''''', defaults to the shield thickness.}}

====+Allow Bypass:====
{{Table371|
*Determines whether weapons which impact on the ship's hull (see +Minimum Weapon Span above) will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean'''''
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Shield Impact Explosion:===
{{Table373|
*Impact explosion animation to trigger when this ship's shields are hit. Works identically for all shield types.
*Note: The size of the explosion is defined by the weapon, see [[Weapons.tbl#.24Shield_Impact_Explosion_Radius:]].
*Syntax: '''''String''''', filename or ''none''
}}

===$Max Shield Recharge:===
{{Table373|
*Determines a maximum recharge limit of shields. When used, the combined maximum shield energy is lowered, meaning that shield energy can be moved between quadrants even with shields fully charged.
*Syntax: '''''Float''''', multiplier ranging from 0.0 to 1.0, defaults to 1.0
**Example: ''$Max Shield Recharge: 0.5'' caps the combined shield energy to 50%, meaning that a ship with 4 shield quadrants will by default have 12.5% strength on all quadrants (instead of normal 25%), allowing it to for example augment one quadrant to 50% while dropping other quadrants to 0%.
}}

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''
*Affected by ETS Shields value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Shield Recharge Scale:}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''
*Affected by ETS Guns value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Weapon Recharge Scale:}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', percentage of total subsystem hitpoints repaired per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$Scan range Normal:===
{{Table381|
*Distance at which the ship can scan other small ships or large ship subsystems
*Syntax: '''''Float''''', distance
}}

===$Scan range Capital:===
{{Table381|
*Distance at which the ship can scan capital (& similar size) ships
*Syntax: '''''Float''''', distance
}}

===$Ask Help Shield Percent:===
{{Table381|
*Percentage of shield damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$Ask Help Hull Percent:===
{{Table381|
*Percentage of hull damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ExplosionSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the ship explodes
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Flyby Sound===
{{Table382|
*Optional sound to be used for the fly-by sound
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). The position of the camera relative to the model in the tech room and the target box view. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). How far the camera's zoomed in, defines camera's FOV. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''("String" "String")'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Subsystem<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour
*The following things are true for all ships with this flag:
**When hit by debris, damage dealt by the collision is capped to between 10 and 20% of the ship's health maximum (determined randomly for each collision)
**All damage dealt by weapons without the corresponding supercap flag from weapons.tbl will be reduced by 75%
**In addition, once the ship is at or below 75% health, damage from non-supercap weapons is completely negated
**Do note that shockwave damage, regardless of origin, is not subject to these rules unless the "$Weapon shockwave damage respects huge ship flags:" setting in game_settings.tbl is set to true
**Ship subsystems are scannable by default (can be overridden by mission designers)
**The ship does not need to ramp up to warpout speed before entering subspace
**When using the "Knossos" warpout, the ship will aim for a departure point at the center of the Knossos portal

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Ships.tbl

2020-02-22T11:18:38Z

The E: /* "super cap" */

{{TableVersionGit|2019-05-07 UTC|5f5616c0f}}

The '''ships.tbl''' defines all the ship classes used in FSO.

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

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*This setting does nothing
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

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

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$POF file Techroom:===
*Filename of the model file (.pof) at data/models folder; used only in the weapon loadout screen
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

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

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$Collision LOD:===
{{Table373|
*Defines an alternative LOD (Level-Of-Detail) to use for collision detection. Using this can increase performance without visible drawbacks if the LOD chosen has much simpler geometry but the shape still closely matches the base model.
*This works as follows: collision detection proceeds normally through the various model/submodel radius and bounding box checks based on LOD0, but when the game decides to perform a mesh-based collision check of a given submodel, it will use the submodel's LOD mesh instead. However, all submodels do not need to have a counterpart in the given LOD; if one is not found, the closest alternative will automatically be used instead.
*For example, if ''$Collision LOD: 3'' is used and the submodel engine01a is checked for a hit, the game will attempt to use the mesh of engine01d instead. However, if there is no engine01d submodel, the game will find the closest alternative: it'll look for engine01c, then engine01b, and finally fall back to engine01a. Note the implications of for example the root LOD submodel (detaild, detail3, etc) including the geometry of subsystem submodels; if detail0 is checked for a collision before engine01a, and detail3 includes the engine geometry (as opposed to having it in engine01d), then the subsystem engine01a cannot be hit.
**Syntax: '''''Integer'''''}}

===$ND:===
NOTE: this option has done nothing since before 2008

*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1. Must not be 0.

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

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

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Player Minimum Velocity:===
{{Table38|
*Defines minimum velocities on x (left/right), y (up/down), and z (forward) -axis (respectively). This affects the player only, the AI ignores the value.
*The x and y velocities are considered slide velocities, the minimums for them are '''not currently implemented'''.
*When gliding, if the absolute speed vector of the players ship falls below the minimum then the ships engines will re-engage and cannot be switched off again until the ships absolute vector exceeds the z-minimum.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 40.0''
}}

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence
{{Note|If none of the following optional strings are added, the weapon will not converge. Don't forget to use them.}}
}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, [[Game_settings.tbl#.24Minimum player warpout time:|defaults to]] 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Death Roll X rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on X-axis (pitch) rotation during the ships deathroll. The value is radians per second. The current hard-coded minimum is 0.8. Note the code generally won't use this value for ships with radius > 150 (hard-coded).
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Y rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Y-axis (yaw) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Z rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Z-axis (roll) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used the final explosion of this ship type,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Ship Death Particles'' is not a valid option!
}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization, 0 to 100}}

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

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

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

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Minimum Weapon Span:====
{{Table373|
*Determines the minimum distance weapons must have traveled before impacting the shield (for example if fired close to or inside the shield). Does not affect whether the weapon bypasses shields, unless +Allow Bypass (see below) is set to ''YES''. Only valid with auto spread shields.
*Syntax: '''''Float''''', defaults to the shield thickness.}}

====+Allow Bypass:====
{{Table371|
*Determines whether weapons which impact on the ship's hull (see +Minimum Weapon Span above) will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean'''''
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Shield Impact Explosion:===
{{Table373|
*Impact explosion animation to trigger when this ship's shields are hit. Works identically for all shield types.
*Note: The size of the explosion is defined by the weapon, see [[Weapons.tbl#.24Shield_Impact_Explosion_Radius:]].
*Syntax: '''''String''''', filename or ''none''
}}

===$Max Shield Recharge:===
{{Table373|
*Determines a maximum recharge limit of shields. When used, the combined maximum shield energy is lowered, meaning that shield energy can be moved between quadrants even with shields fully charged.
*Syntax: '''''Float''''', multiplier ranging from 0.0 to 1.0, defaults to 1.0
**Example: ''$Max Shield Recharge: 0.5'' caps the combined shield energy to 50%, meaning that a ship with 4 shield quadrants will by default have 12.5% strength on all quadrants (instead of normal 25%), allowing it to for example augment one quadrant to 50% while dropping other quadrants to 0%.
}}

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''
*Affected by ETS Shields value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Shield Recharge Scale:}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''
*Affected by ETS Guns value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Weapon Recharge Scale:}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', percentage of total subsystem hitpoints repaired per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$Scan range Normal:===
{{Table381|
*Distance at which the ship can scan other small ships or large ship subsystems
*Syntax: '''''Float''''', distance
}}

===$Scan range Capital:===
{{Table381|
*Distance at which the ship can scan capital (& similar size) ships
*Syntax: '''''Float''''', distance
}}

===$Ask Help Shield Percent:===
{{Table381|
*Percentage of shield damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$Ask Help Hull Percent:===
{{Table381|
*Percentage of hull damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ExplosionSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the ship explodes
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Flyby Sound===
{{Table382|
*Optional sound to be used for the fly-by sound
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). The position of the camera relative to the model in the tech room and the target box view. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). How far the camera's zoomed in, defines camera's FOV. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''("String" "String")'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Subsystem<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour
*The following things are true for all ships with this flag:
**When hit by debris, damage dealt by the collision is capped to between 10 and 20% of the ship's health maximum (determined randomly for each collision)
**All damage dealt by weapons without the corresponding supercap flag from weapons.tbl will be reduced by 75%
**In addition, once the ship is at or below 75% health, damage from non-supercap weapons is completely negated
**Do note that shockwave damage, regardless of origin, is not subject to these rules unless the "$Weapon shockwave damage respects huge ship flags:" setting in game_settings.tbl is set to true

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Ships.tbl

2020-02-22T11:18:10Z

The E: /* "super cap" */

{{TableVersionGit|2019-05-07 UTC|5f5616c0f}}

The '''ships.tbl''' defines all the ship classes used in FSO.

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

[[Tables|List of Tables]]

==General Format==
*Ship.tbl is formed of several different sections.
*All sections beginning with <nowiki>#</nowiki> need <nowiki>#</nowiki>End before the next section.
**<nowiki>#</nowiki>'''Default Player Ship'''
***Defines the default player ship in the game and also in the FRED. If in a mission appears a ship that has not been properly included to tables then game replaces the ship with the Default Player Ship.
**<nowiki>#</nowiki>'''Engine Wash Info'''
***Includes all the definitions of all engine washes used in the game.
{{Table3610|
:*<nowiki>#</nowiki>'''Ship Templates'''
:**Includes entries for ship templates}}

:*<nowiki>#</nowiki>'''Ship Classes'''
:**Includes entries for every ship and also defines their attributes that are used in the game
:**Is discussed in detail at [[Ships.tbl#Table_Options|Table Options]] section.
:*'''$Player Ship Precedence'''
:**Player Ship Precedence is used in ship selection when a ship specified by the mission designer is not available to the player. The next ship on the list is used in its place (assuming that ship is allowed for the player)

==Default Player Ship==
*Defines the default ship in the game.
*Syntax: ''Name'', name of ship model as defined in [[Ships.tbl#Table_Options|Table Options]].

==Engine Wash==
*Defines the engines washes
*First entry must be named 'default'

===$Name:===
*Defines the name of the engine wash.
*Syntax: '''''String'''''

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===$Angle:===
*Defines the angle from the engine where the engine wash exists
*Syntax: '''''Float''''', degrees

===$Radius Mult:===
*Defines engine wash multiplier
*Syntax: '''''Float'''''

===$Length:===
*Defines the length of the engine wash
*Syntax: '''''Float''''', meters

===$Intensity:===
*Defines the strength of the engine wash
*This setting does nothing
*Syntax: '''''Float''''', blast effect

'''Example'''

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

==Ship Template Options==
{{Warning|
The ship templates feature has always caused crashes and memory issues. As of 2014/07/24, it has been removed from the codebase.}}
{{Table3610|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

===$Template:===
{{Table3610|
*Defines the name of template
*Syntax: '''''String''''', name}}

===+Use Template:===
{{Table3610|
*Another template can be used as template for the current template
*Syntax: '''''String''''', name}}

==Ships Table Options==

===$Name:===
*Model name that is used also in game. It is also used as name for the whole ship entry. There are two special characters can be used in the name: '''#''' and '''@'''
**'''#'''. It's used in the middle of the name and cannot be the first character in the $Name: string. It makes the right part of the name not being shown in the ship class info of the target window, (or beside the target brackets in FS_Open builds). It allows making different versions of a base ship while showing the same class name inside the game. An example from FSPort FreeSpace 1: The '''SF Dragon#weakened''' ship, used in [[Enter the Dragon]], appears to the player just as any other '''SF Dragon'''.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. Moreover, '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they both appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. In the retail FS2 ships there are several ships starting by '''@'''.
*Syntax: '''''String''''', name

===+nocreate===
{{Table3610|
*In [[Modular Tables]] name can be followed by line '''+nocreate''' that prevent game from creating an incomplete entry by leaving the entry unread unless it already exists (either in ship.tbl or in earlier parsed *-shp.tbm files) by the time the *-shp.tbm is read.}}

===+Use Template:===
{{Table3610|
*Sets the table entry to use template based on an existing table entry instead of creating totally new one
*Syntax: '''''String''''', name of the template}}

===$Alt Name:===
{{Table3613|
*Alternative $Name: for the ship.
*Syntax: '''''String''''', Alternate $Name:}}

===$Short name:===
*Shortened model name, for FRED, Usually more descriptive than the real name.
*Syntax: '''''String''''''

===$Species:===
*Defines species (Terran, Vasudan or Shivan). Determines many things, including the color of the engine glow, the flyby sound effects, the briefing icon and the support ship.
{{Table3610|
*More species have been enabled, and all of these have to be defined in [[species_defs.tbl]].}}

*Syntax: '''''String''''', name of the species
**Example: ''Terran''

===Technical Description===
List of descriptive terms for techroom and ship selection screens. Number after the quotes refers to [[tstrings.tbl]]

====+Type:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Maneuverability:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Armor:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Manufacturer:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Tech Title:====
{{Table3613|
*Defines name of the ship as displayed in the tech room
*Syntax: '''''String'''''}}

====+Tech Description:====
*Syntax: XSTR("'''''String'''''", integer)
*Requires '''$end_multi_text''' after the entry
*Example:
::XSTR("", -1)
::$end_multi_text

====+Length:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Gun Mounts:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

====+Missile Banks:====
*Syntax: XSTR("'''''String'''''", integer)
*Example: XSTR("", -1)

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

===$Cockpit POF file:===
{{Table3610|*Filename of the cockpit model file
*Syntax: '''''String.pof''''', model filename}}

===+Cockpit Offset:===
{{Table3610|*Defines the offset of the cockpit model
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Cockpit Display:===
{{Table3615|
*Defines a rectangle surface on a cockpit texture that can be updated dynamically. Multiple displays can be defined, but only one needs to be defined for each texture on the cockpit model.
*'''+Texture:'''
*The filename of the cockpit texture to be replaced.
*Syntax: '''''String''''', texture filename
*'''+Offsets:'''
* (Optional) The offsets of the rectangle surface into the texture that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Size:'''
* The size of the rectangle surface that will be drawn into.
*Syntax: '''''Vector''''', two '''integers'''
*'''+Background:'''
* (Optional) Filename of the bitmap to be used as the background of this display.
*Syntax: '''''String''''', texture filename
*'''+Foreground:'''
* (Optional) Filename of the bitmap to be used as the foreground of this display.
*Syntax: '''''String''''', texture filename
*'''+Display Name:'''
* A name to be used as a reference handle.
*Syntax: '''''String'''''}}

===$POF File:===
*Filename of the model file (.pof) at data/models folder
*Syntax: '''''String.pof''''', model filename

===$POF file Techroom:===
*Filename of the model file (.pof) at data/models folder; used only in the weapon loadout screen
*Syntax: '''''String.pof''''', model filename

===$Texture Replace:===
{{Table3610|
*'''+old:'''
*Defines the texture to be replaced
**Syntax: '''''String''''', filename
*'''+new:'''
*Defines the new texture
**Syntax: '''''String''''', filename}}

===$POF Target File:===
*Optional hud targeting model
*Syntax: '''''String.pof''''', model filename

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

===$Detail Distance:===
*Defines the distance where the change between different Levels-Of-Details (LODs) occurs
*Take notice that these are base values. Model detail in Detail options, (within game press F2), applies a multiplier to these values. These multipliers default to (from left to right): 1/8, 1/4, 1, 4, and 8, and may be overridden by the [[Ai_profiles.tbl#$Detail Distance Multiplier:|$Detail Distance Multiplier]]
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$Collision LOD:===
{{Table373|
*Defines an alternative LOD (Level-Of-Detail) to use for collision detection. Using this can increase performance without visible drawbacks if the LOD chosen has much simpler geometry but the shape still closely matches the base model.
*This works as follows: collision detection proceeds normally through the various model/submodel radius and bounding box checks based on LOD0, but when the game decides to perform a mesh-based collision check of a given submodel, it will use the submodel's LOD mesh instead. However, all submodels do not need to have a counterpart in the given LOD; if one is not found, the closest alternative will automatically be used instead.
*For example, if ''$Collision LOD: 3'' is used and the submodel engine01a is checked for a hit, the game will attempt to use the mesh of engine01d instead. However, if there is no engine01d submodel, the game will find the closest alternative: it'll look for engine01c, then engine01b, and finally fall back to engine01a. Note the implications of for example the root LOD submodel (detaild, detail3, etc) including the geometry of subsystem submodels; if detail0 is checked for a collision before engine01a, and detail3 includes the engine geometry (as opposed to having it in engine01d), then the subsystem engine01a cannot be hit.
**Syntax: '''''Integer'''''}}

===$ND:===
NOTE: this option has done nothing since before 2008

*No Dim field field was used in FreeSpace for ship lights. Use of glowmaps is preferred to the $ND entry. Only noticeable in Glide or Software mode.
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''42, 42, 224''

===$Enable Team Colors:===
{{Table3615|
*Enables Team Colors for a ship without setting a default color setting.
*Syntax: '''''Boolean'''''}}

===$Default Team:===
{{Table3615|
*Specifies the default team name to be used for coloring a ship.
*None is will set the default to 'no coloring'.
*Syntax: '''''String''''', name of the teams as defined in [[colors.tbl]]}}

===$Show Damage:===
*No function at all. The engine will read values, but discard them. In 3.6.10 or later, this can be left out without adverse consequences.
*Syntax: '''''Boolean''''', yes or no, usually yes

===$Damage Lightning Type:===
{{Table3613|
*Changes the damage lightning effect shown on highly damaged ships.
*Can be defined as:
**''None''
**''Default''}}

===$Impact:===
{{Table3610|
*'''+Damage Type:'''
**Defines the damage type of the collision
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Impact Spew:===
{{Table3610|
*Used to define the impact particle spew
*Note: You CANNOT define a different type of particle spew here; the only option possible is listed below
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''
**Default Value: 30}}{{Table3613|
*'''+Min particles:'''
**Defines the minimum number of particles spewed
**Syntax: '''''Integer'''''
**Default Value: 25
*'''+Max Radius:'''
**Defines the maximum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.5f
*'''+Min Radius:'''
**Defines the minimum radius of particles
**Syntax: '''''Float'''''
**Default Value: 0.2f
*'''+Max Lifetime:'''
**Defines the maximum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.55f
*'''+Min Lifetime:'''
**Defines the minimum lifetime of particles
**Syntax: '''''Float'''''
**Default Value: 0.05f
*'''+Max Velocity:'''
**Defines the maximum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 12.0f
*'''+Min Velocity:'''
**Defines the minimum velocity of particles
**Syntax: '''''Float'''''
**Default Value: 2.0f
*'''+Normal Variance:'''
**Defines the variance of particle direction from the normal
**Syntax: '''''Float'''''
**Default Value: 1.0f}}

===$Damage Spew:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the 'smoke' released on weapon impact point
*Certain default values (marked with '''X''') gain a specific multiplier based on ship radius
::If the radius is less than 20 the multiplier is 1
::If the radius is larger than 40 the multipler is 1.2
::Otherwise it is between 1 and 1.2
{{Table3610|
*'''+Max Particles:'''
**Default Value: 50 * '''X'''}}{{Table3613|
*'''+Min Particles:'''
**Default Value: 20 * '''X'''
*'''+Max Radius:'''
**Default Value: 1.3
*'''+Min Radius:'''
**Default Value: 0.7
*'''+Max Lifetime:'''
**Default Value: 1.5 * '''X'''
*'''+Min Lifetime:'''
**Default Value: 0.7 * '''X'''
*'''+Max Velocity:'''
**Default Value: 12.0
*'''+Min Velocity:'''
**Default Value: 3.0
*'''+Normal Variance:'''
**Default Value: 0.2 * '''X'''}}

===$Collision Physics:===
{{Table3613|
*Parameters affecting collision physics, including landings.
*"Landing" means the ship will not take damage or shake when it touches down. Instead, the ship will reorient towards a neutral resting orientation. "Reorient" thresholds below mean that the ship will still take damage (counts as a crash) but will move towards the correct landing orientation.

====+Bounce:====
When this ship collides with a large ship, how many meters to instantly move it away. Default is 5.0.
====+Both Small Bounce:====
When this ship collides with a small ship, how many meters to instantly move it away. Default is 5.0.
====+Friction:====
During collisions, how much friction to apply (slowing lateral movement). Default is 0.0.
====+Rotation Factor:====
Affects the rotational energy of collisions. Default is 0.2.
====+Landing Max Forward Vel:====
Maximum velocity for which landing physics are used.
====+Landing Min Forward Vel:====
Minimum velocity for which landing physics are used.
====+Landing Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still be considered a landing.
====+Landing Max Horizontal Vel:====
Maximum sideways velocity the ship can land at.
====+Landing Max Angle:====
Maximum angle of attack the ship can land at (in degrees).
====+Landing Min Angle:====
Minimum angle of attack the ship can land at (in degrees).
====+Landing Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to count as a landing.
====+Reorient Max Forward Vel:====
Maximum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Min Forward Vel:====
Minimum velocity for which the ship will be adjusted to the correct landing orientation.
====+Reorient Max Descent Vel:====
Maximum velocity at which the ship can "hit the deck" and still reorient.
====+Reorient Max Horizontal Vel:====
Maximum sideways velocity for reorienting.
====+Reorient Max Angle:====
Maximum angle of attack for reorienting to kick in (in degrees).
====+Reorient Min Angle:====
Minimum angle of attack for reorienting to kick in (in degrees).
====+Reorient Max Rotate Angle:====
How many degrees the ship can be rotated relative to the landing surface in order to be reoriented on impact.
====+Reorient Speed Mult:====
How quickly the reorientation takes place (when applicable)
====+Landing Rest Angle:====
Angle of the ship's nose relative to the plane of the landing surface when the ship is at rest. Reorient will move the ship towards this angle.
====+Landing Sound:====
Sound to play when landing (if it's not a landing, normal collision sound is used).
}}

===$Debris:===
{{Table3610|
*'''+Min Lifetime:'''
**Defines the minimum lifetime of the debris (Default value is a random number)
**Syntax: '''''Float,''' Seconds
*'''+Max Lifetime:
**Defines the maximum lifetime of the debris
**Syntax: '''''Float,''' Seconds
*'''+Min Speed:
**Defines the minimum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Max Speed:
**Defines the maximum speed of the debris
**Syntax: '''''Float,''' Meters/second
*'''+Min Rotation speed:
**Defines the minimum rotational speed of the debris (Default is (6 to 10)/Ship-radius)
**Syntax: '''''Float,''' Radians/second
*'''+Max Rotation speed:
**Defines the maximum rotational speed of the debris
**Syntax: '''''Float,''' Radians/second
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table3611|
*'''+Min Hitpoints:'''
**Defines the minimum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Max Hitpoints:'''
**Defines the maximum hitpoints assigned for the generated debris pieces
**Syntax: '''''Float'''''
*'''+Damage Multiplier:'''
**Defines the collision damage multiplier for collisions against the generated debris pieces
**Syntax: '''''Float'''''
*'''+Lightning Arc Percent:'''
**Controls what percent of debris pieces will have the damage lightning effect applied to them.
**Defaults to 50%.
**Syntax: '''''Float,''' 0-100}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will the lower density ship and not yours; the higher the numbers are, the harder they will hit and the farther they will be pushed. However, this doesn't apply to asteroids. When a high density fighter collides with an asteroid, the high-density fighter will receive damage, but it will also destroy the asteroid. Setting a density of 1000 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid. A low-density fighter will not have any effect on an asteroid, but if the fighter destroys the asteroid, the fighter will fly far away.
*Syntax: '''''Float''''', usually 1. Must not be 0.

===$Damp:===
*Sets the natural period (1 / omega) of the dampening effects on top of the acceleration model. (See [[Ships.tbl#$Forward Accel:|$Forward Accel:]])
*In essence, affects how quickly you will accel/decel to your target velocity. Higher damp means slower acceleration and deceleration, while lower values (down to 0.0001) means faster acceleration/deceleration.
**Specifying a value of 0.0 means there is no damping placed on top of the acceleration model, which is the most responsiveness you'll get.

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

===$Rotdamp:===
*Shares the same principles of [[Ships.tbl#$Damp:|$Damp]], but is applied to rotations directly. (there isn't a engine/thrust acceleration model for rotations)
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table3610|
*Defines a factor for how much roll is added during a yaw. Set as 1 for full roll and 0 is no roll. Default is 0.5.
*Syntax: '''''Float'''''}}

===$Max Velocity:===
*Defines maximum velocities with standard energy settings on x (left/right), y (up/down), and z (forward) -axis (respectively). z -axis velocity defines the maximum forward velocity.
*The x and y velocities are considered slide veocities
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 80.0''

===$Player Minimum Velocity:===
{{Table38|
*Defines minimum velocities on x (left/right), y (up/down), and z (forward) -axis (respectively). This affects the player only, the AI ignores the value.
*The x and y velocities are considered slide velocities, the minimums for them are '''not currently implemented'''.
*When gliding, if the absolute speed vector of the players ship falls below the minimum then the ships engines will re-engage and cannot be switched off again until the ships absolute vector exceeds the z-minimum.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**Example: ''0.0, 0.0, 40.0''
}}

===$Rotation Time:===
*Defines rotation times around the x, y, and z-axis. Number is seconds it takes to complete rotate a ship (360 degrees) around the given axis. X-axis is "pitch," y-axis is "yaw," and z-axis is "roll."
*Syntax: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''
**Note: Setting to Zero will cause the model to disappear in mission.

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second
**Note: This value must be set for [[Ships.tbl#.2BAburn_Max_Reverse_Vel:|+Aburn_Max_Reverse_Vel:]] to work

===$Forward Accel:===
*Number of seconds needed from full stop to 63.21% of the maximum forward (z) velocity
** We use 63.21% instead of 100% because FSO's acceleration/velocity model is based on a simplistic exponential function, rather than the more complex models seen for prop-driven, jet-driven, or rocket-driven craft.
** The equation is a derivative of v = 1 - e^(-t / T), where T is what we define in the ship.tbl
*Syntax: '''''Float''''', seconds

===$Forward Decel:===
*Number of seconds needed from maximum forward (z) velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide Accel:===
*Number of seconds needed from full stop to 63.21% maximum slide velocity
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Slide Decel:===
*Number of seconds needed from 63.21% maximum slide velocity to full stop
*Note: this is applied to both slide (x and y) axes
**See [[Ships.tbl#$Forward Accel:|$Forward Accel]] for an explanation of the 63.21%
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table3610|
*Allows gliding in game, i.e. turning the ship's attitude/facing without changing its current movement direction and speed.
*Syntax: '''''Boolean''''', yes or no}}

====+Dynamic Glide Cap:====
{{Table3611|
*If set, game uses dynamic glide cap. The dynamic glide cap means that the maximum glide speed will follow the same rules as normal flight, including the effects of afterburner and power to engines. If set to YES, the value in +Max Glide Speed is ignored.
*Syntax: '''''Boolean'''''}}

====+Max Glide Speed:====
{{Table3610|
*Defines the maximum glide speed if glide has been enabled. If 0, this is set to the fastest speed the ship can go. If negative, there is no glide cap (allowing practically infinite maximum gliding speed). Defaults to 0.
*Syntax: '''''Float'''''}}

====+Glide Accel Mult:====
{{Table3611|
*Defines the acceleration multiplier for the gliding mode. If > 0, sets a fixed acceleration rate in glide mode depending on value. If set to 0, impossible to accelerate while in glide mode. If negative, enables glide speed ramping (acceleration in glide mode ramps in the same way as in normal flight). Defaults to 0.
*Syntax: '''''Float'''''}}
{{Table3610|
*Entry exists as a dummy entry which doesnt do anything to prevent compatibility issues}}

===$Use Newtonian Dampening:===
{{Table3611|
*If set, forces the ship to use (or not use) newtonian dampening. Basically, allows overriding the AI Profiles flag on a per-ship basis.
*Syntax: '''''Boolean'''''}}

===$Autoaim FOV:===
{{Table3610|
*Defines the field of view for autoaim
*Syntax: '''''Integer'''''}}

====+Converging Autoaim====
{{Table3611|
*Defines that the autoaim uses convergence}}

====+Minimum Distance:====
{{Table3611|
*Defines the minimum distance for the convergence}}

===$Convergence:===
{{Table3611|
*Defines the weapons use convergence
{{Note|If none of the following optional strings are added, the weapon will not converge. Don't forget to use them.}}
}}

====+Automatic====
{{Table3611|
*Defines that the ship uses automatic convergence - converging distance calculated from estimated hit position (lead) of the current target.
*'''+Minimum Distance:'''
**Defines the minimum distance for the convergence. Overrides the setting for $Autoaim FOV's minimum distance.}}

====+Standard====
{{Table3611|
*Defines that ship uses fixed convergence.
*'''+Distance:'''
**Defines the converging distance from the ship}}

====+Offset:====
{{Table3611|
*Defines the offset from the ship centerpoint for the convergence
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively}}

===$Warpin Type:===
{{Table3610|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpin Start Sound:===
{{Table3610|
*File for playing at start of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin End Sound:===
{{Table3610|
*File for playing at end of warp in effect
*Syntax: '''''String''''', filename}}

===$Warpin Speed:===
{{Table3610|
*Sets the speed at which the ship warps in for '''default''' warpin effect
*Sets the time that the ships warp in (not the animation itself) takes for '''BTRL''' type warpin effects
*Syntax: '''''Float''''', meters per second or miiliseconds}}

===$Warpin Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpin Decel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the deceleration curve at the end of the warpin. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual deceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpin Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpin Animation:===
{{Table3610|
*Defines the animation used for the Homeworld warpin effect. Has no effect for other warpin types.
*Syntax: '''''String''''', filename}}

===$Warpout Type:===
{{Table3610|
*Allow an animation to be defined as a warpout effect.
*Can be defined as:
:*''Default''
:*''BTRL'' or ''Galactica''
:*''Homeworld''
:*''Hyperspace''}}
{{Table3613|
:*''Knossos''
:*''Babylon5''}}
{{Table3611|
::*''BTRL'' was replaced with ''Galactica'' after 3.6.10}}
{{Table3610|
*Syntax: '''''String'''''}}

===$Warpout Start Sound:===
{{Table3610|
*File for playing at start of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout End Sound:===
{{Table3610|
*File for playing at end of warp out effect
*Syntax: '''''String''''', filename}}

===$Warpout Engage Time:===
{{Table3615|
*Defines the delay the it takes for the warp drive of the ship to engage, during which the player may still abort the warpout. Affects both the player as well as AI ships. If not defined, [[Game_settings.tbl#.24Minimum player warpout time:|defaults to]] 3 seconds for the player and none for the AI.
*Syntax: '''''Float''''', seconds}}

===$Warpout Speed:===
{{Table3610|
*Sets the speed at which the ship warps out for '''default''' warpout effect
*Sets the time that the ships warp out (not the animation itself) takes for '''BTRL''' type warpout effects}}
{{Table3613|
*Sets the minimum speed required for the ship to warp out for '''hyperspace''' type warpout effects}}
{{Table3610|
*Syntax: '''''Float''''', meters per second or milliseconds}}

===$Warpout Time:===
{{Table3610|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

===$Warpout Accel Exp:===
{{Table3613|
*Only for the '''hyperspace''' warpin effect.
*Defines an exponent for the acceleration curve at the start of the warpout. Must be higher than 0; a value of 1 produces a constant velocity throughout the effect and higher values produce gradual acceleration.
*Syntax: '''''Float'''''
**Default: 1.0}}

===$Warpout Radius:===
{{Table3610|
*Defines the effect radius
*Syntax: '''''Float''''', meters}}

===$Warpout Animation:===
{{Table3610|
*Defines the animation used as the warpout effect.
*Syntax: '''''String''''', filename}}

===$Player Warpout Speed:===
{{Table3610|
*Sets the speed at which the player warps out from the game
*Syntax: '''''Float'''''}}

===$Expl Inner Rad:===
*Radius at which the full explosion damage is done
*Syntax: '''''Float''''', meters

===$Expl Outer Rad:===
*Maximum radius at which any damage is done
*Syntax: '''''Float''''', meters

===$Expl Damage:===
*Amount of damage done inside the inner radius
*Syntax: '''''Float''''', damage

===$Expl Blast:===
*The intensity of the blast effect when you're within the outer radius
*Syntax: '''''Float''''', blast effect

===$Expl Propagates:===
*This decides whether the ship explodes into debris immediately, or whether it has the many small explosions before breaking apart slowly
*Syntax: '''''Boolean''''', yes or no

===$Propagating Expl Radius Multiplier:===
{{Table3613|
*This sets the multiplier for the ship splitting propagating explosions
*Syntax: '''''Float''''', defaults to 1}}

===$Expl Visual Rad:===
{{Table3611|
*This determines the visual size of the main fireball for an exploding ship. Does not affect ships with propagating explosions.
*Syntax: '''''Float''''', meters}}

===$Base Death-Roll Time:===
{{Table3613|
*Defines the base death-roll time
*Values is modified depending on conditions when the ship died
*Syntax: '''''Integer''''', milliseconds
**Default: 3000}}

===$Death-Roll Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier for the radius of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death-Roll Explosion Intensity Mult:===
{{Table3613|
*Defines the multiplier for the amount of the ship surface explosions during death roll
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Radius Mult:===
{{Table3613|
*Defines the multiplier applied to the ship death explosions
*Syntax: '''''Float'''''
**Default: 1}}

===$Death FX Explosion Count:===
{{Table3613|
*Defines the number of explosion effect game uses when a large ship dies
*Syntax: '''''Integer'''''
**Default: 6}}

===$Death Roll X rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on X-axis (pitch) rotation during the ships deathroll. The value is radians per second. The current hard-coded minimum is 0.8. Note the code generally won't use this value for ships with radius > 150 (hard-coded).
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Y rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Y-axis (yaw) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Death Roll Z rotation Cap:===
{{Table382|
*Defines the cap (aka maximum) on Z-axis (roll) rotation during the ships deathroll. For other details see $Death Roll X rotation Cap:
*Syntax: '''''Float'''''
**Default: 4.725}}

===$Ship Splitting Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on every explosion event which happens when ship is splitting apart
*The old 'popcorn' effect
{{Table3613|
*'''+Max Particles:'''
**Default Value: 80
*'''+Min Particles:'''
**Default Value: 40
*'''+Max Radius:'''
**Default Value: Ship radius * 0.015
*'''+Min Radius:'''
**Default Value: Ship radius * 0.005
*'''+Max Lifetime:'''
**Default Value: 6.0 * (1 + 0.002 * Ship radius)
*'''+Min Lifetime:'''
**Default Value: 0.5 * (1 + 0.002 * Ship radius)
*'''+Max Velocity:'''
**Default Value: Speed of the propagating explosion
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Ship Death Effect:===
{{Table38|
*Specifies the [[Particle Effects|particle effect]] which will be used the final explosion of this ship type,
*Syntax: '''String''', the particle effect name
*If this option is specified then ''$Ship Death Particles'' is not a valid option!
}}

===$Ship Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released on the moment 'non-knossos' type object dies
{{Table3613|
*'''+Max Particles:'''
**Default Value: 100
*'''+Min Particles:'''
**Default Value: 50
*'''+Max Radius:'''
**Default Value: 1.5
*'''+Min Radius:'''
**Default Value: 0.1
*'''+Max Lifetime:'''
**Default Value: 4.0
*'''+Min Lifetime:'''
**Default Value: 0.5
*'''+Max Velocity:'''
**Default Value: 20.0
*'''+Min Velocity:'''
**Default Value: 0.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Alternate Death Particles:===
See [[Ship.tbl#$Impact Spew:|Impact Spew entry]]
*Controls the particles released when 'knossos' type object is dying
{{Table3613|
*'''+Max Particles:'''
**Default Value: 30
*'''+Min Particles:'''
**Default Value: 15
*'''+Max Radius:'''
**Default Value: 100.0
*'''+Min Radius:'''
**Default Value: 30.0
*'''+Max Lifetime:'''
**Default Value: 12.0
*'''+Min Lifetime:'''
**Default Value: 2.0
*'''+Max Velocity:'''
**Default Value: 350.0
*'''+Min Velocity:'''
**Default Value: 50.0
*'''+Normal Variance:'''
**Default Value: 2.0}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. Overrides the same flag in [[objecttypes.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization, 0 to 100}}

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

===$Shockwave Speed:===
*Speed shockwave expands at, 0 means no shockwave
*Syntax: '''''Float''''', meters per second

===$Shockwave Count:===
*Defines the number of shockwaves to spawned
*Syntax: '''''Integer'''''

===$Shockwave Model:===
{{Table3610|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

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

===$Explosion Animations:===
{{Table3610|
*Defines the explosion animations used for the ship
*Syntax: '''''Integer list'''''}}

===$Weapon Model Draw Distance:===
{{Table3610|
*Distance that external weapons are shown, ie. missiles and such.
*Syntax: '''''Float''''', meters
**Default: ''200''}}

===Primary Weapons===
====$Allowed PBanks:====
*List of allowed primary weapons in brackets (weapon name marked with quotes).
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has its own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight PBanks:====
*Primary weapons for multiplayer dogfights.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the primary weapon dogfight banks '''can optionally''' be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default PBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$PBank Capacity:====
{{Table3610|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*NOTE: In order for this to work, at least one of the primary weapons in the list of default primaries must be a ballistic weapon.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table3610|
*Defines the use of weapon models for primary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )''''', yes or no
**Example: ''( YES YES )'' - Note the spaces on the insides of the brackets.}}

===Secondary Weapons===
====$Allowed SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Allowed Dogfight SBanks:====
*Same for secondary weapons.
*Syntax: '''''( "String" "String" )''''', names of the weapons
{{Table3610|
*Each of the secondary weapon dogfight banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
*Syntax: '''''( "String" "String" ) ( "String" "String" )'''''}}

====$Default SBanks:====
*Defines default primary weapons for each of the primary weapon banks
*Syntax: '''''( "String" "String" )''''', names of the weapons

====$SBank Capacity:====
*Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''

====$Show Secondary Models:====
{{Table3610|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

===$Ship Recoil Modifier:===
{{Table373|
*Multiplies the recoil force of a weapon by this value, use a value greater than 1.0 to increase the force, use a value between 1.0 and 0.0 to decrease.
**Syntax: '''''Float''''' (defaults to 1.0)
{{Note|It is not required to have any weapons with the "apply recoil" flag set for this to be enabled.}}
}}

===$Shields:===
*Determines the shield strength
*Syntax: '''''Float''''', total shield strength

====+Auto Spread:====
{{Table371|
*Defines the thickness of auto spread shields. Note that the [[#.22auto_spread_shields.22|"auto spread shields"]] ship flag is also needed.
*Syntax: '''''Float''''', shield thickness in meters.}}

====+Minimum Weapon Span:====
{{Table373|
*Determines the minimum distance weapons must have traveled before impacting the shield (for example if fired close to or inside the shield). Does not affect whether the weapon bypasses shields, unless +Allow Bypass (see below) is set to ''YES''. Only valid with auto spread shields.
*Syntax: '''''Float''''', defaults to the shield thickness.}}

====+Allow Bypass:====
{{Table371|
*Determines whether weapons which impact on the ship's hull (see +Minimum Weapon Span above) will bypass shields. Only valid with auto spread shields.
*Syntax: '''''Boolean'''''
**Default: ''NO''}}

====+Spread From LOD:====
{{Table371|
*Causes the auto spread shields calculations to be done based off a LOD level other than LOD0. Using a lower-poly LOD will considerably speed up the shield collision detection, while being visually indistinguishable in most cases.
*Syntax: '''''Integer''''', defaults to 0}}

===$Model Point Shield Controls:===
{{Table371|
*Allows remapping of the 4 shield augmentation keys when [[Model Point Shields]] are used. You should usually supply as many values as you have shield segments. The first value determines which augmentation key to use for the first shield segment, the second value determines which key to use for the second shield segment, and so on (the order being defined by the order of the shield points in the model file). If less than 4 values are given, "none" is assumed for the missing ones. Note that as there are only 4 augmentation keys, player ships with more than 4 shield segments would generally not be a good idea.
*Syntax: '''''( String list )''''', possible values "front", "left", "right", "rear" and "none"
**Example: ''( "front" "rear" )'' for a ship with only two shield sections, front and rear; the left and right augmentation keys would be disabled.
**Example: ''( "left" "rear" "right" )'' for a ship with only three shield sections, left, right and rear; the front augmentation key would be disabled.
**Example: ''( "front" "right" "rear" "left" )'' for a ship with four shield sections but perhaps positioned in a non-standard way.}}

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', red, green, blue respectively, value from 0 to 255
**Example: ''100, 100, 255''

===$Shield Impact Explosion:===
{{Table373|
*Impact explosion animation to trigger when this ship's shields are hit. Works identically for all shield types.
*Note: The size of the explosion is defined by the weapon, see [[Weapons.tbl#.24Shield_Impact_Explosion_Radius:]].
*Syntax: '''''String''''', filename or ''none''
}}

===$Max Shield Recharge:===
{{Table373|
*Determines a maximum recharge limit of shields. When used, the combined maximum shield energy is lowered, meaning that shield energy can be moved between quadrants even with shields fully charged.
*Syntax: '''''Float''''', multiplier ranging from 0.0 to 1.0, defaults to 1.0
**Example: ''$Max Shield Recharge: 0.5'' caps the combined shield energy to 50%, meaning that a ship with 4 shield quadrants will by default have 12.5% strength on all quadrants (instead of normal 25%), allowing it to for example augment one quadrant to 50% while dropping other quadrants to 0%.
}}

===$Power Output:===
*Actually does *NOTHING* unless set to zero; in which case weapon/shield/burner energy regeneration is disabled. Checked via code inspection 2014/12/29
*Syntax: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table3610|
*Repair rates for shields at percent per second
*Syntax: '''''Float''''', multiplier of total shield hitpoints recharged each second. ('''NOT A PERCENTAGE''', 0.02 equals 2% recharged per second)
**Default: ''0.02''
*Affected by ETS Shields value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Shield Recharge Scale:}}

===$Support Shield Repair Rate:===
{{Table3611|
*Shield repair rate when docked to a support ship
*Syntax: '''''Float'''''}}

===$Weapon Regeneration Rate:===
{{Table3610|
*Regeneration rates for primary guns at percent per second
*Syntax: '''''Float''''', multiplier of total gun energy recharged each second ('''NOT A PERCENTAGE''', 0.04 equals 4% recharged per second)
**Default: ''0.04''
*Affected by ETS Guns value (1/3rd value recharged per sec at default ETS setting of '4')
*Affected by AI Profile Setting: $Player Weapon Recharge Scale:}}

===$Max Oclk Speed:===
*Can also be '''$Max Overclock Speed:'''
*Maximum velocity with all energy diverted to engines
*Syntax: '''''Float''''', meters per second

===$Max Weapon Eng:===
*Can also be '''$Max Weapon Energy:'''
*The maximum amount of energy you can store in your primary weapons bank.
*Syntax: '''''Float'''''

===$Hitpoints:===
*How much damage the ship can take
*Syntax: '''''Float''''', hitpoints
**Default: ''100''

===$Hull Repair Rate:===
{{Table3610|
*Repair rates for hull at percent per second
*Syntax: '''''Float''''', multiplier of hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Support Hull Repair Rate:===
{{Table3611|
*Repair rate for hull when docked to a support ship
*Syntax: '''''Float'''''}}

===$Subsystem Repair Rate:===
{{Table3610|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', percentage of total subsystem hitpoints repaired per second}}

===$Support Subsystem Repair Rate:===
{{Table3611|
*Repair rate for subsystems when docked to a support ship
*Syntax: '''''Float'''''}}

===$Armor Type:===
{{Table3610|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Shield Armor Type:===
{{Table3611|
*'''REQUIRES ADDITIONAL TABLE'''. Defines the armor type used for shield of the ship
*Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}

===$Flags:===
*See [[Ships.tbl#Ships.tbl_flags|below]]
*Syntax: '''''( "String" "String" )''''', names of the flags assigned to the ship
**Example: ( "fighter" "in tech database" )
{{Table3610|
*'''+noreplace'''
**Can be used to force game to retain existing flags instead of reseting the ship flags before parsing in the new flags.}}

===$AI Class:===
*Default AI class
*Syntax: '''''String''''', name of the AI class as defined in [[ai.tbl]]

===$Afterburner:===
*Defines if the ships has afterburner
*Syntax: '''''Boolean''''', yes or no
====+Aburn Max Vel:====
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
====+Aburn For accel:====
*Defined only for the forward acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]
*Syntax: '''''Float''''', seconds

====+Aburn Max Reverse Vel:====
{{Table3611|
*Defined only for the reverse acceleration, Sets the top speed for Reverse Afterburner.
*Syntax: '''''Float''''', seconds
**NOTE: Requires [[Ships.tbl#.24Rear_Velocity:|$Rear Velocity:]] to be set in order to work.
}}
====+Aburn Rev accel:====
{{Table3611|
*Defined only for the reverse acceleration. In same format as [[Ships.tbl#$Forward Accel:|$Forward Accel]]

*Syntax: '''''Float''''', seconds'''''}}

====+Aburn Fuel:====
*Amount of afterburner fuel the ship has
*Syntax: '''''Float''''', fuel
====+Aburn Burn Rate:====
*Rate the fuel is consumed when afterburner is engaged (in units per seconds)
*Syntax: '''''Float''''', fuel units per second
====+Aburn Rec Rate:====
*Rate the fuel is restored.
*Syntax: '''''Float''''', fuel units per second
{{Table3610|
====$Trails:====
*Allows afterburner trails to be used
=====+Bitmap:=====
*Texture used to draw the afterburner trail
*Syntax: '''''String''''', filename
=====+Width:=====
*Width of afterburner trail at the beginning of it (ie. the thruster end)
*Syntax: '''''Float''''', meters
=====+Alpha:=====
*Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
*Syntax: '''''Float'''''
=====+Life:=====
*How long the trail will last
*Syntax: '''''Float''''', seconds}}
{{Table3611|
=====+Faded Out Sections:=====
*Defines the number of the trail sections from the leading edge that are gradually faded away.
*Syntax: '''''Integer'''''}}

===$Countermeasure Type:===
{{Table3610|
*Defines the weapon used as a countermeasure. Weapon does not have to be included in the countermeasure section of the weapons.tbl, but it has to have "countermeasure" flag in that case.
*Syntax: '''''String''''', name of the weapon as defined in [[weapons.tbl]]}}

===$Countermeasures:===
*Number of countermeasures that can be loaded to the ship
*Syntax: '''''Integer'''''

===$Scan Time:===
*Time it takes to scan the ship
*Syntax: '''''Integer''''', milliseconds

===$Scan range Normal:===
{{Table381|
*Distance at which the ship can scan other small ships or large ship subsystems
*Syntax: '''''Float''''', distance
}}

===$Scan range Capital:===
{{Table381|
*Distance at which the ship can scan capital (& similar size) ships
*Syntax: '''''Float''''', distance
}}

===$Ask Help Shield Percent:===
{{Table381|
*Percentage of shield damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$Ask Help Hull Percent:===
{{Table381|
*Percentage of hull damage at which the ship will send a call for assistance message.
*Syntax: '''''Float''''', percentage. Valid range 0.0-1.0
}}

===$EngineSnd:===
*Engine sound used for the ship with number referring to sounds.tbl
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]

===$Minimum Engine Volume:===
{{Table373|
*Specifies how to multiply the volume of the engine sound based on ship speed. When the ship is stationary, the engine volume will be multiplied by the given value, with the value approaching 1.0 as the ship speed approaches maximum.
*Note: Default behavior is to ramp the multiplier from 0.5 (when ship is stationary) to 1.0 (when ship is at half speed or more).
*Syntax: '''''Float''''', volume multiplier, usually you'll want a value between 0.0 and 1.0
}}

===$GlideStartSnd:===
{{Table3613|
*Optional sound to be used when entering glide mode, instead of the default throttle down sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$GlideEndSnd:===
{{Table3613|
*Optional sound to be used when exiting glide mode, instead of the default throttle up sound.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CockpitEngineSnd===
{{Table3613|
*Optional sound to be used for looping engine sound heard in the cockpit.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$FullThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to full power.
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ZeroThrottleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when setting throttle to zero power
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleUpSnd===
{{Table3613|
*Optional sound to be used for the sound heard when increasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ThrottleDownSnd===
{{Table3613|
*Optional sound to be used for the sound heard when decreasing throttle power by 1/3
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerSnd===
{{Table3613|
*Optional optional sound to be used for the looping sound heard when the afterburner is active
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerEngageSnd===
{{Table3613|
*Optional optional sound to be used for the sound heard when the afterburner is engaged
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AfterburnerFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the activation of the afterburner failed
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileTrackingSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player tries to acquire a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a aspect seeking missile of the player has acquired a lock
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his primary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryCycleSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player cycles his secondary weapon
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$TargetAcquiredSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the player acquires a new target
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$PrimaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the primary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$SecondaryFireFailedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the secondary weapon fails to fire
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerLaunchWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is fired at the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileLockWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is locked onto the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$HeatSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a heat-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$AspectSeekerProximityWarningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when an aspect-seeker is in close proximity to the player
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$MissileEvadedSnd===
{{Table3613|
*Optional sound to be used for the sound heard when a missile has been evaded
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$CargoScanningSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the cargo of an object is being scanned
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$ExplosionSnd===
{{Table3613|
*Optional sound to be used for the sound heard when the ship explodes
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Flyby Sound===
{{Table382|
*Optional sound to be used for the fly-by sound
*Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
}}

===$Closeup_Pos:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). The position of the camera relative to the model in the tech room and the target box view. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_Zoom:===
*How the model will show at techroom and briefing screen animations (assuming a pre-rendered animation is not specified). How far the camera's zoomed in, defines camera's FOV. If 3D ship selection is used, also affects the drawing of the ship icon in the weapon & ship selection briefing screens.
*Syntax: '''''Float''''', radians

===$Topdown Offset:===
{{Table3610|
*Specifies how high the camera is above the center point of a ship in topdown camera views, or 2D missions.
*Syntax: '''''Float''''', meters}}

===$Shield_Icon:===
*This .ani file must be at data/hud and included to the hud.tbl.
{{Table3610|
*Reference to the hud.tbl is no longer needed.}}
**Syntax: ''Filename''

===$Model Icon Direction:===
{{Table373|
*The direction from which the ship should be drawn from, if $Ship_Icon is not used and the ship icon is generated from the model.
** By default, the direction is based on whether the game thinks the ship is a small ship, a capship or an installation.
**Syntax: ''String'', one of "top", "bottom", "front", "back", "left" or "right"}}

===$Ship_Icon:===
*The icon used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: ''Filename''

===$Ship_Anim:===
*The glowing green grid animation used in ship selection.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

===$Ship_Overhead:===
*The overhead view used in the weapons loadout.
{{Table3610|
*Ship model is used by default to generate the image.}}
**Syntax: '''''String''''', filename

{{Table371|
===$Briefing icon:===
*Defines if the ship has its own briefing icon information which overrides the standard briefing icon image
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing icon with cargo:===
*Defines if the ship has its own cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon:===
*Defines if the ship has its own wing briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

{{Table371|
===$Briefing wing icon with cargo:===
*Defines if the ship has its own wing-with-cargo briefing icon (which will only be an option if a ship icon is also specified)
====+Regular:====
*Syntax: '''''<regular anim filename>'''''
====+Fade:====
*Syntax: '''''<fade anim filename>'''''
====+Highlight:====
*Syntax: '''''<highlight anim filename>'''''}}

===$Score:===
*Points awarded for destroying the ship
*Syntax: '''''Float'''''

===Customized Thruster Effects===
{{Table3611|
*Defines the texture of the modeled thruster effect cone
*'''$Thruster Normal Flame:'''
**Syntax: '''''String''''', filename
*Defines the texture of the modeled thruster effect cone with afterburners lit
*'''$Thruster Afterburner Flame:'''
**Syntax: '''''String''''', filename}}
{{Table3610|
*'''Defines the primary thruster glow - the one visible only from behind'''
**'''$Thruster Bitmap 1:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Normal:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 1a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Afterburner:''' under the '''$Thrustglows:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster01 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
*'''Defines the secondary glow type-effect for thrusters - the feathery trail like haze behind the main glow'''
**'''$Thruster Bitmap 2:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Sec_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 2a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Sec_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster02 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster02 Length factor:'''
***Defines the length multiplier for the trail type (secondary) glowpoint thrusters
***Replaces the older '''$Thruster01 Length factor:'''
***Syntax: '''''Float'''''
*'''Defines the tertiary glow type-effect for thrusters - the one visible from all directions'''
**NOTE: The rotation of this effect is jittered, which can look quite bad with certain types of effects.
**'''$Thruster Bitmap 3:'''
***Defines the effect for the standard drives. Overrides [[Species_defs.tbl]] line '''+Ter_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap 3a:'''
***Defines the effect for the afterburner. Overrides [[Species_defs.tbl]] line '''+Ter_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster03 Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''}}
{{Table3613|
*'''Defines the distortion effect for thrusters'''
**'''$Thruster Bitmap Distortion:'''
***Defines name of normal thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Normal:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Bitmap Distortion a:'''
***Defines name of afterburner thruster distortion envelope animation. Overrides [[Species_defs.tbl]] line '''+Dist_Afterburn:''' under the '''$ThrustAnims:''' entry.
***Syntax: '''''String''''', filename
**'''$Thruster Distortion Radius factor:'''
***Defines the radius multiplier
***Syntax: '''''Float'''''
**'''$Thruster Distortion Length factor:'''
***Defines the length multiplier for the thruster distortion
***Syntax: '''''Float'''''
**'''$Thruster Distortion:'''
***Defines whether the distortion effect is rendered for this ship.
***Syntax: '''''Bool'''''}}
{{Table373|
*'''$Thruster Glow Noise Mult:'''
**A multiplier for how much noise is applied to the thruster glow radius. A value of 0 causes the radius to remain perfectly steady and values higher than 1 cause the radius to fluctuate more than the default.
** Defaults to 1.0.
**Syntax: '''''Float'''''
}}

===$Thruster Particles:===
{{Table3610|
*Defines the alternative particle thruster
*'''$Thruster Particle Bitmap:''' OR '''$Afterburner Particle Bitmap:'''
**Name of the animation used for particle thrusters, up to '''three''' can be defined for both '''standard''' thrusters and '''afterburners''' (6 in total). Afterburner particles require at least 1 existing particle thruster entry.
**Syntax: '''''String''''', filename
*'''$Min Radius:'''
**Defines the minimum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Max Radius:'''
**Defines the maximum radius of new particles
**Syntax: '''''Float''''', meters
*'''$Min Created:'''
**Defines the minimum amount of particles created
**Syntax: '''''Float'''''
*'''$Max Created:'''
**Defines the maximum amount of particles created
**Syntax: '''''Float'''''
*'''$Variance:'''
**Value that describes the randomness of particle generation, values close to 0 will cause particles to spew very close to the thrusters normal while values close 1 will cause some particles to be spewed even to opposite direction
**Syntax: '''''Float'''''}}

===$Stealth:===
*Defines: Ship behaves as a stealth-ship: non-targettable, and not on radar.
{{Table3610|
This field is [[deprecated]], and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max Decals:===
{{Table3610|
*Defines: Maximum number of weapon decals on a ship
*Syntax: '''''Integer''''', maximum number of decals on ship
**Default: 50 for anything below cruiser size, 100 for anything below superdestroyer/installation size, 300 for anything above destroyer size, 10 for everything else.}}
{{Table3613|
*Feature disabled. Parsing retained to maintain compatibility}}

===$Trail:===
*These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
{{Table3611|
*'''+ClearAll'''
**Clears all existing trail data from the ship}}
====+Offset:====
*The position of the contrail's head
*Syntax: '''''Vector''''', three '''floats''', x, y and z values respectively, relative to the center point of the model
====+Start Width:====
*The width of the contrail's head
*Syntax: '''''Float''''', meters
====+End Width:====
*The width of the contrail's tail
*Syntax: '''''Float''''', meters
====+Start Alpha:====
*The opacity of the contrail's head
*Syntax: '''''Float''''', value between 0 and 1
====+End Alpha:====
*The opacity of the contrail's tail
*Syntax: '''''Float''''', value between 0 and 1
====+Max Life:====
*How long the contrail remains
*Syntax: '''''Float'''''', seconds
====+Spew Time:====
*Syntax: '''''Integer'''''
====+Bitmap:====
*The image to use for the contrail.
*Syntax: '''''String''''', filename
{{Table3611|
====+Faded Out Sections:====
*Defines the number of the trail sections from the leading edge that are gradually faded away.}}

===$Thruster:===
{{Table3610|
*Defines maneuvering thrusters. Ship may have multiple $Thrusters defined.
*'''+Index:'''
**Defines the index number of the manoeuvring thruster defined in this entry
**Syntax: '''''Integer'''''
*'''+Used For:'''
**Defines the maneuver that triggers the maneuvering thruster
**List of maneuvers: Bank right, Bank left, Pitch up, Pitch down, Roll right, Roll left, Slide right, Slide left, Slide up, Slide down, Forward, Reverse
**Syntax: '''''("String" "String")'''''
*'''+Position:'''
**Defines thruster location
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), position from the ships center point, x, y, z axis respectively
*'''+Normal:'''
**Defines the direction where the thruster points to
**Syntax: ( '''''Float''''' '''''Float''''' '''''Float''''' ), direction of the thrusters normal, x, y, z axis respectively
*'''+Texture:'''
**Defines the graphic that will be used for trail, rendered like beams
**Syntax: '''''String''''', filename
*'''+Radius:'''
**Defines the radius of cylinder
**Syntax: '''''Float''''', meters
*'''+Length:'''
**Defines the length of thruster trail
**Syntax: '''''Float''''', meters
*'''+StartSnd:'''
**Defines the sound played when the thruster is started
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+LoopSnd:'''
**Defines the sound played when the thruster is continuously used
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]
*'''+StopSnd:'''
**Defines the sound played when the thruster is shutting down
**Syntax: '''''Integer''''' or '''''String''''', name or identification number of the sound as defined in [[sounds.tbl]]}}

===$Radar Image 2D:===
{{Table3611|
*Defines the bitmap used to represent the ship on the radar screen.
*Syntax: '''''Filename'''''}}
{{Table3615|
*'''$Radar Color Image 2D:'''
**Defines the color bitmap used to represent the ship on the radar screen.
**Syntax: '''''Filename'''''}}
{{Table3611|
*'''$Radar Image Size:'''
**Defines the size of the bitmap on the radar screen (length of the longer dimension)
**Syntax: '''''Integer'''''
*'''$3D Radar Blip Size Multiplier:'''
**Defines the multiplier used for blip size on the 3D radar.
**Syntax: '''''Float'''''}}

===$Glowpoint overrides:===
{{Table373|
*Creates a point that casts light onto ships and objects with the source being a glowpoint defined in the model file.
*Syntax: '''''( "String:Integer" )'''''
*String refers to name in [[glowpoints.tbl]]
*Essentially, [Name_of_glowpoint_override_in_glowpoints.tbl]:[Bank_in_POF]. If there is no override entry then the game will not generate a light. If you have multiple banks that use the same override, use a comma if they are not in order (2,4,7) and use a dash if they are in order (3-5 yields 3, 4, and 5).
**Example: '''$Glowpoint overrides: ( "teal_glow_10:1" "red_glow:2,3" "white_glow_10:4" "red_glow_10:5" "green_glow_10:6")'''
}}

===$Ship IFF Colors:===
{{Table3611|
*Defines the alternate color for the ship. Affects both the targeting brackets as well as the radar screen.
*'''+Seen By:'''
**Defines the IFF actually viewing the object (most often 'Friendly')
**Syntax: '''''String''''', name of an IFF class.
*'''+When IFF Is:'''
**Defines the IFF which the ship has to have for its color to be altered.
**Syntax: '''''String''''', name of an IFF class.
*'''+As Color:'''
**Defines the new color of the ship's targeting brackets and radar blip
**Syntax: '''''Integer list''''', red, blue and green respectively}}

===$Target Priority Groups:===
{{Table3611|
*Defines into which target priority groups the ship belongs to
*Syntax: '''''String list''''', names of the targeting groups
*'''+Override'''
**Overrides the ships existing groupings}}

===$EMP Resistance Modifier:===
{{Table3611|
*Defines the ships EMP resistance modifier:
*Syntax: '''''Float'''''}}

===$Piercing Damage Draw Limit:===
{{Table3611|
*Defines the maximum percentage of hitpoints ship has before piercing effects are enabled
*Syntax: '''''Float'''''
**Example: '''10''', sets the limit to 10%}}

===$Path Metadata:===
{{Table3613|
*Allows definition of extra metadata
*Syntax: '''''String''''', name of the path as defined in the ship POF file.
**Example: '''$Path Metadata: $Bay01'''
====+departure rvec:====
When using this path to depart via fighterbay, the departing ship will rotate to align itself with this rvec (so the right side of the ship is pointing in this direction). Only affects paths used to depart via fighterbay.
====+arrive speed multiplier:====
{{Table373|
*Modifies the speed of ships arriving from a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_arrive_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
====+depart speed multiplier:====
{{Table373|
*Modifies the speed of ships departing to a fighterbay using this path. See [[Ai_profiles.tbl#.24bay_depart_speed_multiplier:]] for details.
**Syntax: '''''Float'''''
}}
}}

===$Subsystem<nowiki>:</nowiki>===
:''Main article: [[Subsystem]]''

==Ships.tbl flags==

==="no_collide"===
*Defines ship as non-collideable, ie. everything will go through it

==="player_ship"===
*Makes it possible for the player to fly the ship

==="default_player_ship"===
*Makes this ship as a default part of the loadout options in FRED

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table3610|
*New ship types can be defined in [[objecttypes.tbl]]}}

===="repair_rearm"====
*Alternate name for "support"

===="support"====
*Defines the ship as repair and rearm vessel and sets AI behaviour accordingly
*Only one such vessel can be defined per species

===="cargo"====
*Defines ship as a cargo crate and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="fighter"====
*Defines ship as a fighter and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="bomber"====
*Defines ship as a bomber and also sets the AI behaviour
*In FS1/FS2 only ships flagged as fighters or bombers can accept the full set of player orders

===="transport"====
*Defines ship as a transport and also sets the AI behaviour

===="freighter"====
*Defines ship as a freighter and also sets the AI behaviour

===="capital"====
*Defines ship as a capital ship and also sets the AI behaviour

===="supercap"====
*Alternate name for "super cap"

===="super cap"====
*Defines ship as a super capital ship and also sets the AI behaviour
*The following things are true for all ships with this flag:
**When hit by debris, damage dealt by the collision is capped to between 10 and 20% of the ship's health maximum (determined randomly for each collision)
**All damage dealt by weapons without the corresponding supercap flag from weapons.tbl will be reduced by 75%
***In addition, once the ship is at or below 75% health, damage from non-supercap weapons is completely negated
***Do note that shockwave damage, regardless of origin, is not subject to these rules unless the "$Weapon shockwave damage respects huge ship flags:" setting in game_settings.tbl is set to true

===="drydock"====
*Defines ship as a drydock and also sets the AI behaviour

===="cruiser"====
*Defines ship as a cruiser and also sets the AI behaviour

===="navbuoy"====
*Defines ship as a navbuoy and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="sentrygun"====
*Alternate name for "sentry gun"

===="sentry gun"====
*Defines ship as a sentrygun and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="escapepod"====
*Alternate name for "escape pod"

===="escape pod"====
*Defines ship as a escapepod and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="corvette"====
*Defines ship as a corvette and also sets the AI behaviour

===="gas miner"====
*Defines ship as a gas miner and also sets the AI behaviour

===="awacs"====
*Defines ship as a AWACS and also sets the AI behaviour

===="knossos"====
*Alternate name for the "Knossos device"

===="knossos device"====
*Defines ship as a Knossos and also sets the AI behaviour
*In FS1/FS2 ships that are marked with this flag cannot accept any player orders

===="stealth"====
{{Table3610|
*Defines ship as a stealth-ship: non-targettable, and not on radar.}}

===="no type"====
*Does ???

----

==="ship copy"===
*Defines the ship as a copy of another model

==="in tech database"===
*Includes ships description to the tech database from the beginning of the campaign

==="in tech database multi"===
*Includes the ship to multiplayer tech database

==="dont collide invisible"===
*Defines invisible textures as non-collideable (For example, a hangar entrace)

==="big damage"===
*Limits the damage made to the ship by non-huge weapons.

==="no_fred"===
*Ship will not appear in FRED.

==="ballistic primaries"===
{{Table3610|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table3610|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table3610|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table3610|
*Enable rendering the ship even when the ship is a player ship
*Will result in the player's ship model being rendered, when in cockpit mode}}

==="generate icon"===
{{Table3610|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table3610|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no thruster geometry noise"===
{{Table3611|
*Prevents noise from being added to the thruster effects geometry}}

==="intrinsic no shields"===
{{Table3611|
*Defines that ship has no shields by default, to allow mixing and matching shielded and unshielded craft in loadout}}

==="no primary linking"===
{{Table3611|
*Bypasses linked primaries while cycling. Does not block SEXPs/scripts that might be able to lock them, only the act of cycling for players and determing whether to link or not for AI.}}

==="no pain flash"===
{{Table3613|
*Prevents pain flash from being shown when ship is hit}}

==="dynamic primary linking"===
{{Table37|
*Allows this ship use the primary firepoint cycling code. With a key bind added in 3.6.13, you can toggle between various factorizations of primary firepoint groupings on a per-primary bank basis. So a 4-firepoint bank could cycle through all four firepoints firing together (1x4), each firepoint firing individually (4x1, all 4 firing over the timespan of the bank cooldown, so no change in damage over time, or DPS, occurs from retail behavior), or firing in pairs (2x2).}}

==="no ets"===
{{Table37|
Sets ship class to have no ETS}}

==="no lighting"===
{{Table3613|
Ship will not receive lighting calculations}}

==="auto spread shields"===
{{Table371|
Causes the ship's shield mesh (if any) to be ignored and a shield of a given thickness to be automatically projected around the ship's hull. Weapons will impact the ship's shields at a distance equal to the shield thickness defined in [[Ships.tbl#.2BAuto_Spread:|#.2BAuto_Spread:]], but not before the weapon itself has travelled at least a distance equal to that. Note that impact effects normally projected onto the shield mesh will not work.}}

==="model point shields"===
{{Table371|
Instead of the standard 4 shield quadrants, the ship uses an arbitrary number of shield sections which must have been defined in the model file, see [[Model Point Shields]]. If used on a player ship, you must also define [[Ships.tbl#.24Model_Point_Shield_Controls:|#.24Model_Point_Shield_Controls:]] to allow the shield augmentation controls to be used.}}

==Player Ship Precedence==
*Syntax: ( '''''"String" "String"''''')
===Example===

<pre>
$Player Ship Precedence: (
"GTF Ulysses"
"GTF Hercules"
"GTB Medusa"
"GTB Ursa" )
</pre>

==Sample==

<pre>
#Default Player Ship

$Name: GTF Ulysses

#End

#Engine Wash Info

$Name: Default
$Angle: 10.0
$Radius Mult: 1.2
$Length: 400
$Intensity: 1.0

#End

#Ship Classes
$Name: GTF Ulysses
$Short name: TFight
$Species: Terran
+Type: XSTR("Space Superiority", -1)
+Maneuverability: XSTR("Excellent", -1)
+Armor: XSTR("Light", -1
+Manufacturer: XSTR("Triton / Mekhu", -1)
+Description: XSTR( " ", -1)
$end_multi_text
+Tech Description: XSTR("Descriptive text", -1)
$end_multi_text
+Length: 16 m
+Gun Mounts: 4
+Missile Banks: 1
$POF File: fighter01.pof
$Detail Distance: (0, 80, 300, 900)
$ND: 42 42 244
$Show Damage: YES
$Density: 1
$Damp: 0.1
$Rotdamp: 0.35
$Max Velocity: 0.0, 0.0, 70.0
$Rotation Time: 3.0, 2.6, 5.0
$Rear Velocity: 0.0
$Forward Accel: 2.0
$Forward Decel: 1.5
$Slide Accel: 0.0
$Slide Decel: 0.0
$Expl Inner Rad: 25.0
$Expl Outer Rad: 55.0
$Expl Damage: 15.0
$Expl Blast: 1000.0
$Expl Propagates: NO
$Shockwave Speed: 0.0
$Allowed PBanks: ( "Subach HL-7" "Prometheus R")
$Allowed Dogfight PBanks: ( "Subach HL-D" "Prometheus D" )
$Default PBanks: ( "Subach HL-7" "Prometheus R" )
$Allowed SBanks: ( "Rockeye" "Tempest" )
$Allowed Dogfight SBanks: ( "Tempest D" "Hornet D" )
$Default SBanks: ( "Harpoon" )
$SBank Capacity: ( 40 )
$Shields: 380
$Shield Color: 100 100 255
$Power Output: 2.0
$Max Oclk Speed: 94.0
$Max Weapon Eng: 80.0
$Hitpoints: 180
$Flags: ( "player_ship"
"default_player_ship"
"fighter"
"in tech database")
$AI Class: Captain
$Afterburner: YES
+Aburn Max Vel: 0.0, 0.0, 150.0
+Aburn For accel: 0.7
+Aburn Fuel: 300.0
+Aburn Burn Rate: 50.0
+Aburn Rec Rate: 25.0
$Countermeasures: 25
$Scan Time: 2000
$EngineSnd: 128
$Closeup_Pos: 0.0, 0.0, -22
$Closeup_Zoom: 0.5
$Shield_Icon: shield-f01
$Ship_Icon: iconfighter01
$Ship_Anim: ssfighter01
$Ship_Overhead: loadfighter01
$Score: 8
$Trail:
+Offset: -7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Trail:
+Offset: 7.75 -2.8 0.75
+Start Width: 0.25
+End Width: 0.05
+Start Alpha: 1.0
+End Alpha: 0.0
+Max Life: 1.0
+Spew Time: 60
+Bitmap: Contrail01
$Subsystem: communication, 10, 0
$Subsystem: navigation, 10, 0
$Subsystem: weapons, 20, 0
$Subsystem: sensors, 10, 0
$Subsystem: engines, 35, 0

#End

$Player Ship Precedence: (
"GTF Ulysses")
</pre>

[[Category:Tables]]

Good-secondary-time

2020-02-15T21:20:41Z

The E: Update the comment on good-secondary-time to better document what the sexp is actually doing

Set preferred secondary weapons
This sexpression is used to inform the AI about preferred secondary weapons to fire during combat.
When this expression is evaluated, any AI ships of the given team prefer to fire the given weapon at the given ship.
(Preferred over other secondary weapons)

Takes 4 argument...
1: Team name which will prefer firing given weapon
2: Maximum number of this type of weapon above team can fire.
3: Weapon name (list includes only the valid weapons for this expression
4: Ship name at which the above named team should fire the above named weapon

==Comments==
*Good-secondary-time forces the AI to use a specific secondary weapon (chosen from a limited list) against a specific ship when attacking that target.
*Only secondary weapons that are marked as "Huge" in the weapon.tbl (or .tbm) will be listed.
*The second parameter does not actually have an effect
*Once this sexp has been called, it will remain in effect until the mission ends (or the target is destroyed, at which point it will become irrelevant)

[[category: Retail SEXPs]]

Command-Line Reference

2019-11-30T18:03:34Z

The E: /* Deprecated Options */

{{TableVersionGit|2018-03-17|8b49ebf3}}

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

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

Disables support for height mapping.
}}

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

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

Disables fullscreen scaling of video clips.

====-post_process====
'''"Enable Post Processing"'''

Enables the use (if present) 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.

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

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

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

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

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

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

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

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

Valid ranges are 0 to 2 with 2 being the default.

* 0 disables shadows (so there's no point in setting it!)
* 1 uses 512x512 shadow maps (lower quality)
* 2 uses 1024x1024 shadow maps (higher 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.}}

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

===Game Speed===

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

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

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

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

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

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

===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| This feature is not available in current builds.}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

===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===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

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

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

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

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

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

Shows coordinates of the mouse cursor.

====-pofspew====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

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

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

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

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

====-profile_frame_time====
'''"Profile engine subsystems"'''

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 microseconds. ''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.

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

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

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

Writes the information stored in savefiles to JSON files.

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

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

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

====-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 75. Range is 0-200.

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

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

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

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

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

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

2019-11-30T18:02:52Z

The E: /* -no_emissive_light */

{{TableVersionGit|2018-03-17|8b49ebf3}}

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

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

Disables support for height mapping.
}}

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

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

Disables fullscreen scaling of video clips.

====-post_process====
'''"Enable Post Processing"'''

Enables the use (if present) 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.

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

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

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

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

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

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

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

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

Valid ranges are 0 to 2 with 2 being the default.

* 0 disables shadows (so there's no point in setting it!)
* 1 uses 512x512 shadow maps (lower quality)
* 2 uses 1024x1024 shadow maps (higher 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.}}

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

===Game Speed===

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

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

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

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

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

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

===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| This feature is not available in current builds.}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

===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===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

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

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

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

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

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

Shows coordinates of the mouse cursor.

====-pofspew====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

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

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

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

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

====-profile_frame_time====
'''"Profile engine subsystems"'''

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 microseconds. ''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.

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

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

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

Writes the information stored in savefiles to JSON files.

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

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

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

====-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 75. Range is 0-200.

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

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

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

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

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

====-show_mem_usage====

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

Engine limitations

2018-07-15T21:55:15Z

The E: /* Models */

The maximum numbers of certain types of entities that can exist in the FS2_Open engine. Please note that 'Inferno' refers to INF builds, which are standard from 3.6.12 on.

==General==
The overall limits of the various subsystem managers.
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Name'''
| style="background:#300505;"| '''Limit'''
|- align="center"
| Textures
| 4750 {{Table382|Mod-defined}}
|- align="center"
| Sound tracks
| 30
|- align="center"
| Sounds
| No Limit
|}

==Tables==
The maximum types of an entity that can exist in the table

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| rowspan=2 style="background:#351515; width:150px"| '''Name'''
| colspan=3 style="background:#300505;"| '''Limit'''
|- align="center"
| style="background:#300505; width:75px"| '''Standard'''
| style="background:#300505; width:75px"| '''Inferno'''
| style="background:#300505; width:75px"| '''3.7.4'''
|- align="center"
| [[Ships.tbl|Ship Classes]]
| 130
| 250
| 500
|- align="center"
| [[Weapons.tbl|Weapon Classes]]
| 200
| colspan=2| 300
|- align="center"
| Beam Sections
| colspan=3| 5
|- align="center"
| Pspews Per Weapon
| colspan=3| 4
|- align="center"
| [[Objecttypes.tbl|Object Types]]
| colspan=3| 16
|- align="center"
| [[Iff_defs.tbl|IFFs]]
| colspan=3|10
|- align="center"
| [[Ai_profiles.tbl|AI Profiles]]
| colspan=3| 5
|- align="center"
| [[Hud_gauges.tbl|Hud Gauges]]
| colspan=3| 64
|- align="center"
| [[Species.tbl|Intelligence Entries]]
| colspan=3| 75
|- align="center"
| Debriefing
| colspan=3| 2,000 Characters per Stage
|}

Please Note - Prior to r11156, there was a hardcoded limit of 32 [[Modular Tables|‎ .tbm files]] of any given type that the game would recognize.

==Objects==
The maximum number of objects that can exist in a mission at any given time (except for ships and waypoints, which apply to the whole mission).

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Name'''
| style="background:#300505; width:75px"| '''Limit'''
|- align="center"
| Objects
| 2000 {{Table3615|3500}}
|- align="center"
| Ships
| 400
|- align="center"
| Weapons
| 700 {{Table3615|2000}}
|- align="center"
| Beams
| 500
|- align="center"
| Waypoints Per Path
| 20 {{Table3613|Limit Removed}}
|- align="center"
| Waypoint Paths
| 32 {{Table3613|Limit Removed}}
|}

==Wings==
The maximum number wings or ships in a wing that can exist

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Name'''
| style="background:#300505; width:75px"| '''Limit'''
|- align="center"
| Wings
| 75
|- align="center"
| Ships per Wing
| 6
|- align="center"
| Starting Wings
| 3
|- align="center"
| Squadron Wings
| 5
|- align="center"
| TvT Teams
| 2
|- align="center"
| TvT Wings per Team
| 1
|- align="center"
| TvT Wings
| 2
|}

==Models==
The maximum number of models that can exist at one time

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| rowspan=2 style="background:#351515; width:150px"| '''Name'''
| colspan=2 style="background:#300505; width:75px"| '''Limit'''
|- align="center"
| style="background:#300505; width:75px"| '''Standard'''
| style="background:#300505; width:75px"| '''Inferno'''
|- align="center"
| Polygon Models
| 128
| 300
|}

The maximum number of a certain entity that can exist within a model

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Name'''
| style="background:#300505; width:75px"| '''Limit'''
|- align="center"
| Textures
| 64
|- align="center"
| Ship Primary Banks
| 3
|- align="center"
| Ship Secondary Banks
| 4
|- align="center"
| Firing Points Per-Bank
| 25
|- align="center"
| Debris Chunks
| 32
|}

==Sub-Weapon Types==

The maximums for the sub types of weapons.

{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| style="background:#351515; width:150px"| '''Type'''
| style="background:#300505; width:75px"| '''Max Instances'''
|- align="center"
| Corkscrew Missiles
| 200
|- align="center"
| Swarm Missiles
| 100
|}

[[Category:Source Code Project]]
[[Category:Modding]]

Command-Line Reference

2018-03-17T12:50:44Z

The E: Update the commandline reference

{{TableVersionGit|2018-03-17|8b49ebf3}}

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

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

Disables support for height mapping.
}}

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

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

Disables fullscreen scaling of video clips.

====-post_process====
'''"Enable Post Processing"'''

Enables the use (if present) 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.

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

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

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

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

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

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

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

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

Valid ranges are 0 to 2 with 2 being the default.

* 0 disables shadows (so there's no point in setting it!)
* 1 uses 512x512 shadow maps (lower quality)
* 2 uses 1024x1024 shadow maps (higher 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.}}

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

===Game Speed===

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

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

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

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

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

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

===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| This feature is not available in current builds.}}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

====-old_collision====
'''"Use old collision detection system"'''

Uses the old collision code instead of Swifty's new collision code introduced in the 'go_even_faster' project.

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

===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===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

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

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

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

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

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

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This does not mean that your card has this much memory, and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

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

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

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

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

====-profile_frame_time====
'''"Profile engine subsystems"'''

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 microseconds. ''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.

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

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

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

Writes the information stored in savefiles to JSON files.

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

==Other==
The following options are not available as checkboxes in the launcher. 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.

====-ambient_factor====
This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-spec_exp====
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. However, 11 is recommended. This is a relative value.

====-spec_point====
This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0. However, 0.6 is recommended. This is a relative value.

====-spec_static====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, is 0.8 recommended. This is a relative value.

====-spec_tube====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, 0.4 is recommended. This is a relative value.

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

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

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

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

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

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

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

Command-Line Reference

2018-03-17T09:28:56Z

The E: /* -shadow_quality */

{{TableVersionGit|2016-28-07|b40631e}}

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===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

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

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

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) 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.

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

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

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

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

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

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

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

Valid ranges are 0 to 2 with 2 being the default.

* 0 disables shadows (so there's no point in setting it!)
* 1 uses 512x512 shadow maps (lower quality)
* 2 uses 1024x1024 shadow maps (higher 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.}}

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

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

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

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

Will ideally reduce the load-time from one mission to another.

===HUD===
====-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===
====-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. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-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. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

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

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

===Audio===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

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

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

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

===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| This feature is not available in current builds.}}

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

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

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

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

====-safeloading====
Loads missions the old way. Typically safer, but slower.
{{Note| This parameter was removed as of the July 5, 2011 nightly build.}}

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

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

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

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

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

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

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

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

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

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

====-old_collision====
'''"Use old collision detection system"'''

Uses the old collision code instead of Swifty's new collision code introduced in the 'go_even_faster' project.

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

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

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

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

Displays current frames per second.

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

====-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"'''
{{Note| This feature is only available on Windows.}}

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
{{Note| This parameter was removed as of the July 5, 2011 nightly build.}}

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

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

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

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This does not mean that your card has this much memory, and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

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

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

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

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

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

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

====-profile_frame_time====
'''"Profile engine subsystems"'''

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 microseconds. ''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.

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

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

==Other==
The following options are not available as checkboxes in the launcher. 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.

====-ambient_factor====
This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-spec_exp====
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. However, 11 is recommended. This is a relative value.

====-spec_point====
This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0. However, 0.6 is recommended. This is a relative value.

====-spec_static====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, is 0.8 recommended. This is a relative value.

====-spec_tube====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, 0.4 is recommended. This is a relative value.

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

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

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

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

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

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

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

Objecttypes.tbl

2017-06-06T13:02:27Z

The E: use the correct name, stupid

{{SCP_table}}

{{TableVersionGit|2016-08-14|6f7039e}}

The '''objecttypes.tbl''' is a table added by the FSSCP, used to set attributes of different object types. Currently the only section of this table are ship type attributes. A ship 'type' supercedes ship classes defined in ships.tbl. For example, the [[GTF Perseus]] and [[GTF Ulysses]] belong to the 'fighter' ship type. However, the [[GTD Orion]] belongs to the 'capital' ship type.

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

[[Tables|List of Tables]]

==General Format==
*Note that objecttypes.tbl is fully XMT-compliant. In addition, the retail hardcoded types are being ported over to the objecttypes.tbl via an in-code table. So if a mod wishes to expand on the original types rather than replace them entirely, it should use a modular table file rather than a normal .tbl. Otherwise the in-code table will be ignored in favor of the one included in the mod, and the retail types will not be loaded (unless the mod includes them in its .tbl)
*Note that a number of aspects of the retail types are still hardcoded, although they may be moved to the objecttypes.tbl if a mod requests it.

==#Target Priorities==
All set target priorities function on additive basis. For example setting 'object type' "ship" already includes all the ships in the game.

===$Name:===
{{Table3611|
* Name of target priority group.
* Syntax: '''String'''}}

===+Object Type:===
{{Table3611|
* The object types which belong to this target priority group.
* Syntax: '''String'''
** Example: ''ship''
** Options
:::''"ship"''
:::''"asteroid"''
:::''"weapon"''}}
{{Table38|
:::''"debris"''}}

===+Weapon Class:===
{{Table3611|
* Name of weapon classes which belong to this target priority group.
* Syntax: '''String list''', names of the weapons}}
** Example: ( "''Cyclops''" "''Tsunami''")

===+Object Flags:===
{{Table3611|
* The object flags which make their owners belong to this target priority group.
* Syntax: '''String list'''
** Options:
:::''"no shields"''
:::''"targetable as bomb"''}}
{{Table38|
:::''"renders"''
:::''"collides"''
:::''"physics"''
:::''"invulnerable"''
:::''"player ship"''
:::''"special warpin"''
:::''"immobile"''}}

===+Ship Class Flags:===
{{Table3611|
* The ship class flags which make their owners belong to this target priority group.
* Syntax: '''String list'''
** Valid Options:
:::''"afterburners"''
:::''"big damage"''
:::''"has awacs"''}}
{{Table38|
:::''"no collide"''
:::''"player ship"''
:::''"default player ship"''
:::''"path fixup"''
:::''"support"''
:::''"cargo"''
:::''"fighter"''
:::''"bomber"''
:::''"cruiser"''
:::''"freighter"''
:::''"capital"''
:::''"transport"''
:::''"navbuoy"''
:::''"sentrygun"''
:::''"escapepod"''
:::''"no type"''
:::''"ship copy"''
:::''"in tech database"''
:::''"in tech database multi"''
:::''"stealth"''
:::''"supercap"''
:::''"drydock"''
:::''"dont collide invisible"''
:::''"corvette"''
:::''"gas miner"''
:::''"awacs"''
:::''"knossos"''
:::''"no fred"''
:::''"default in tech database"''
:::''"default in tech database multi"''
:::''"flash"''
:::''"show ship"''
:::''"surface shields"''
:::''"generate icon"''
:::''"no weapon damage scaling"''
:::''"gun convergence"''
:::''"no thruster geometry noise"''
:::''"intrinsic no shields"''
:::''"no primary linking"''
:::''"no pain flash"''
:::''"allow landings"''
:::''"no ets"''
:::''"no lighting"''
:::''"dyn primary linking"''
:::''"auto spread shields"''
:::''"draw weapon models"''
:::''"model point shields"''
:::''"repair disabled subsystems"''}}

===+Weapon Class Flags:===
{{Table3611|
* The weapon class flags which make their owners belong to this target priority group.
* Syntax: '''String list'''
** Valid Options:
:::''"bomb"''
:::''"huge damage"''
:::''"supercap damage"''
:::''"bomber+"''
:::''"electronics"''
:::''"puncture"''
:::''"emp"''
:::''"heat seeking"''
:::''"aspect seeking"''
:::''"engine seeking"''
:::''"pierce shields"''
:::''"local ssm"''}}
{{Table3613|
:::''"capital+"''}}
{{Table38|
:::''"heat-seeking"''
:::''"aspect-seeking"''
:::''"javelin"''
:::''"spawn"''
:::''"remote detonate"''
:::''"countermeasure"''
:::''"turns"''
:::''"swarm"''
:::''"trail"''
:::''"big ship"''
:::''"child"''
:::''"no dumbfire"''
:::''"thruster"''
:::''"in tech database"''
:::''"player allowed"''
:::''"corkscrew"''
:::''"particle spew"''
:::''"esuck"''
:::''"flak"''
:::''"tag"''
:::''"shudder"''
:::''"lockarm"''
:::''"stream"''
:::''"ballistic"''
:::''"default in tech database"''
:::''"tagged only"''
:::''"cycle"''
:::''"small only"''
:::''"same turret cooldown"''
:::''"apply no light"''
:::''"transparent"''
:::''"training"''
:::''"smart spawn"''
:::''"inherit parent target"''
:::''"no emp kill"''
:::''"variable lead homing"''
:::''"untargeted heat seeker"''
:::''"no radius doubling"''
:::''"no subsystem homing"''
:::''"no lifeleft penalty"''
:::''"custom seeker str"''
:::''"can be targeted"''
:::''"show on radar"''
:::''"show friendly on radar"''
:::''"chain external model fps"''
:::''"external model launcher"''
:::''"takes blast damage"''
:::''"takes shockwave damage"''
:::''"hide from radar"''
:::''"render flak"''
:::''"ciws"''
:::''"anti-subsystem beam"''
:::''"no primary linking"''
:::''"same emp time for capships"''
:::''"no primary linked penalty"''
:::''"no homing speed ramp"''
:::''"pulls aspect seekers"''
:::''"turret interceptable"''
:::''"fighter interceptable"''
:::''"aoe electronics"''
:::''"apply recoil"''
:::''"don't spawn if shot"''
:::''"die on lost lock"''}}

==#End==

==#Weapon Targeting Priorities==

===$Name:===
{{Table3611|
* Name of the weapon for which the target priorities are set
* Syntax: '''''String''''', name of the weapon}}

===+Target Priority:===
{{Table3611|
* Names (in order) of the target priorities set for this ship
* Syntax: '''''String list'''''}}

==#End==

==#Ship Types==

===$Name:===
{{Table3610|
* Name of ship type. To assign a ship class to a given type, simply place the name entered here in the ship class's "$Flags:" field.
* Syntax: '''String'''}}

===+nocreate===
{{Table3610|
*Used with [[Modular Tables|modular tables]]}}

===$Target Priority Groups:===
{{Table3611|
* Defines the target priority groups ships of this objecttype belong to
* Syntax: '''''String list'''''
* '''+Override'''
** Replaces the objecttypes existing groupings}}

===$Counts for Alone:===
{{Table3610|
* Whether ship counts for determing whether or not Freespace 2 will play the "No reinforcements are available" message.
* Syntax: '''Boolean''', Yes or No}}

===$Praise Destruction:===
{{Table3610|
* Whether wingmates will praise destruction of the ship.
* Syntax: '''Boolean''', Yes or No}}

===$On Hotkey List:===
{{Table3610|
* Whether ship will show up in hotkey screen.
* Syntax: '''Boolean''', Yes or No}}

===$Target as Threat:===
{{Table3610|
* Whether ship will be targetted with the 'H' key.
* Syntax: '''Boolean''', Yes or No}}

===$Scannable:===
{{Table3610|
* Toggles whether ship type can be scanned
* Syntax: '''Boolean''', Yes or No}}

===$Warp Pushes:===
{{Table3610|
* Whether ship will push other (pushable) ships out of the way while warping.
* Syntax: '''Boolean''', Yes or No}}

===$Warp Pushable:===
{{Table3610|
* Whether ship can be pushed out of the way by ships with Warp Pushes enabled
* Syntax: '''Boolean''', Yes or No}}

===$Turrets prioritize ship target:===
{{Table3611|
* Defines that ships turrets prioritize ships current target above normal turret targeting priorities
* Syntax: '''Boolean''', Yes or No}}

===$Max Debris Speed:===
{{Table3610|
* Defined the maximum speed for debris form this shiptype
* Syntax: '''float'''}}

===$FF Multiplier:===
{{Table3610|
* Friendly-fire damage to ship will be multiplied by this amount
* Syntax: '''Float'''}}

===$EMP Multiplier:===
{{Table3610|
* EMP effect will be multiplied by this amount. Higher values mean more HUD jittering/longer-lasting effect.
* Syntax: '''Float'''}}

===$Beams Easily Hit:===
{{Table3610|
* Whether beams can easily hit ship (eg capship beams rarely hit fighters)
* Syntax: '''Boolean''', Yes or No}}

===$Protected on cripple:===
{{Table3613|
* If ship should be protected when its subsystems are being targeted
* Syntax: '''Boolean''', Yes or No}}

===$No Huge Beam Impact Effects:===
{{Table3611|
* Defines if the huge beams will generate impact effects on ships of this type
* Syntax: '''Boolean'''}}

===$Don't display class in briefing:===
{{Table3613|
* Option to prevent ship class data from being shown during the briefings
* Syntax: '''Boolean'''}}

===$Fog:===

====+Start Dist:====
{{Table3610|
* Distance from camera that fogging effect will start
* Syntax: '''Float'''}}

====+Compl Dist:====
{{Table3610|
* Distance from camera that this object will be completely obscured by the fogging effect
* Syntax: '''Float'''}}

===$AI:===

====+Valid Goals:====
{{Table3610|
* Valid goals that can be given to this object.
* Syntax: '''( "String" "String" )'''
* '''Goals:'''
** attack ship
** dock
** waypoints
** waypoints once
** depart
** attack subsys
** form on wing
** undock
** attack wing
** guard ship
** disable ship
** disarm ship
** attack any
** ignore ship
** ignore ship (new)
** guard wing
** evade ship
** stay near ship
** keep safe dist
** rearm ship
** stay still
** play dead
** attack weapon
** fly to ship}}
{{Table38|
** attack ship class}}

====+Accept Player Orders:====
{{Table3610|
* Whether or not ship type will accept orders from player
* Syntax: ''Yes/No''}}

====+Player Orders:====
{{Table3610|
* Orders that ship type will accept from player
* Syntax: '''( "String" "String" )'''
* '''Orders:'''
** attack ship
** disable ship
** disarm ship
** disable subsys
** guard ship
** ignore ship
** form on wing
** cover me
** attack any
** depart
** dock
** rearm me
** abort rearm
** stay near me
** stay near ship
** keep safe dist}}

====+Auto Attacks:====
{{Table3610|
* Whether or not ship type will auto attack nearby ships
* Syntax: '''Boolean''', Yes or No}}

====+Attempt broadside:====
{{Table3610|
* Whether or not ship type will try to use broadside tactics against enemy ships
* Syntax: '''Boolean''', Yes or No}}

====+Actively Pursues:====
{{Table3610|
* Which ship types the current ship type will actively pursue (rather than simply return to guard position or whatnot)
* Syntax: '''( "String" "String" )''', shiptypes}}

====+Guards Attack this:====
{{Table3610|
* Whether ships assigned to guard another ship will attempt to engage ships of the type
* Syntax: '''Boolean''', Yes or No}}

====+Turrets Attack This:====
{{Table3610|
* Whether or not turrets will target the ships of the type
* Syntax: '''Boolean''', Yes or No}}

====+Can Form Wing:====
{{Table3610|
* Whether or not ship type can be formed into a wing
* Syntax: '''Boolean''', Yes or No}}

====+Active Docks:====
{{Table3610|
* Preferred docking bay type for ship when it is initiating the dock with another ship
* Syntax: '''( "String" "String" )''', names of the dock bays
* '''Dock bays:'''
** cargo
** rearm
** generic}}

====+Passive Docks:====
{{Table3610|
* Preferred docking bay type for ship when it is receiving a dock from another ship
* Syntax: '''( "String" "String" )'''
* '''Dock bays:'''
** cargo
** rearm
** generic}}

====+Ignored on cripple by:====
{{Table3613|
* Defines the ship types which ignore this ship if its has been crippled
* Syntax: '''String list''', ( "string" "string" )
}}

===$Explosion Animations:===
{{Table3610|
* Defines the animations used with the objecttype
* Syntax: '''Integer list'''}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. This can be overriden on a per-ship basis in [[ships.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

==#End==

==Examples==

===Default FreeSpace 2 Table===
*This is the default table built into the executable that is loaded when no objecttypes.tbl can be found in the games' load path
*Shiptypes '''Stealth''' and '''Fighter/Bomber''' do not seem to be used
<pre>
#Ship types

$Name: Navbuoy
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 10.0
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Turrets attack this: YES
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Sentry Gun
$Counts for Alone: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 200
$FF Multiplier: 0.10
$EMP Multiplier: 10.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Accept Player Orders: NO
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Escape Pod
$Praise Destruction: YES
$On Hotkey List: YES
$Warp Pushable: YES
$Turrets prioritize ship target: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 10.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Turrets attack this: YES
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Cargo
$Scannable: YES
$Max Debris Speed: 200
$FF Multiplier: 0.10
$EMP Multiplier: 10.0
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Passive docks: ( "cargo" )
$Vaporize Percent Chance: 0.0

$Name: Support
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Turrets prioritize ship target: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 3.5
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "dock" "undock" "waypoints" "waypoints once" "stay near ship" "keep safe dist" "stay still" "play dead" )
+Accept Player Orders: YES
+Player orders: ( "rearm me" "abort rearm" "depart" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Active docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

;;WMC - Stealth ships always have another type, so this isn't used
$Name: Stealth
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "waypoints" "waypoints once" "depart" "attack subsys" "attack wing" "guard ship" "disable ship" "disarm ship" "attack any" "ignore ship" "ignore ship (new)" "guard wing" "evade ship" "stay still" "play dead" "stay near ship" "keep safe dist" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "disable ship" "disarm ship" "guard ship" "ignore ship" "ignore ship (new)" "form on wing" "cover me" "attack any" "depart" "disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Fighter
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Turrets prioritize ship target: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "waypoints" "waypoints once" "depart" "attack subsys" "attack wing" "guard ship" "disable ship" "disarm ship" "attack any" "ignore ship" "ignore ship (new)" "guard wing" "evade ship" "stay still" "play dead" "stay near ship" "keep safe dist" "form on wing")
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "disable ship" "disarm ship" "guard ship" "ignore ship" "ignore ship (new)" "form on wing" "cover me" "attack any" "depart" "disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Bomber
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Turrets prioritize ship target: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "waypoints" "waypoints once" "depart" "attack subsys" "attack wing" "guard ship" "disable ship" "disarm ship" "attack any" "ignore ship" "ignore ship (new)" "guard wing" "evade ship" "stay still" "play dead" "stay near ship" "keep safe dist" "form on wing" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "disable ship" "disarm ship" "guard ship" "ignore ship" "ignore ship (new)" "form on wing" "cover me" "attack any" "depart" "disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

;;WMC - This fighter/bomber type doesn't seem to be used anywhere, because no ship is set as both fighter and bomber
$Name: Fighter/bomber
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "waypoints" "waypoints once" "depart" "attack subsys" "attack wing" "guard ship" "disable ship" "disarm ship" "attack any" "ignore ship" "ignore ship (new)" "guard wing" "evade ship" "stay still" "play dead" "stay near ship" "keep safe dist" "form on wing" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "disable ship" "disarm ship" "guard ship" "ignore ship" "ignore ship (new)" "form on wing" "cover me" "attack any" "depart" "disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Transport
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 2.0
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "dock" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Freighter
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Scannable: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 1.75
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "dock" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Active docks: ( "cargo" )
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: AWACS
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 0.8
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Gas Miner
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 1.0
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Cruiser
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 0.9
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Corvette
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 0.3333
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Capital
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushes: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.2
$Beams Easily Hit: YES
$Protected on cripple: NO
$Fog:
+Start dist: 10.0
+Compl dist: 750.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "waypoints" "waypoints once" "depart" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Super Cap
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushes: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.075
$Beams Easily Hit: YES
$Protected on cripple: NO
$Fog:
+Start dist: 10.0
+Compl dist: 1000.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "waypoints" "waypoints once" "depart" "stay still" "play dead" "stay near ship" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Drydock
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.5
$Beams Easily Hit: YES
$Protected on cripple: NO
$Fog:
+Start dist: 10.0
+Compl dist: 750.0
$AI:
+Accept Player Orders: YES
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Knossos Device
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.10
$Protected on cripple: NO
$Fog:
+Start dist: 10.0
+Compl dist: 1000.0
$AI:
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

#End </pre>

[[Category: Tables]]

Objecttypes.tbl

2017-06-06T13:01:21Z

The E: /* +Valid Goals: */

{{SCP_table}}

{{TableVersionGit|2016-08-14|6f7039e}}

The '''objecttypes.tbl''' is a table added by the FSSCP, used to set attributes of different object types. Currently the only section of this table are ship type attributes. A ship 'type' supercedes ship classes defined in ships.tbl. For example, the [[GTF Perseus]] and [[GTF Ulysses]] belong to the 'fighter' ship type. However, the [[GTD Orion]] belongs to the 'capital' ship type.

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

[[Tables|List of Tables]]

==General Format==
*Note that objecttypes.tbl is fully XMT-compliant. In addition, the retail hardcoded types are being ported over to the objecttypes.tbl via an in-code table. So if a mod wishes to expand on the original types rather than replace them entirely, it should use a modular table file rather than a normal .tbl. Otherwise the in-code table will be ignored in favor of the one included in the mod, and the retail types will not be loaded (unless the mod includes them in its .tbl)
*Note that a number of aspects of the retail types are still hardcoded, although they may be moved to the objecttypes.tbl if a mod requests it.

==#Target Priorities==
All set target priorities function on additive basis. For example setting 'object type' "ship" already includes all the ships in the game.

===$Name:===
{{Table3611|
* Name of target priority group.
* Syntax: '''String'''}}

===+Object Type:===
{{Table3611|
* The object types which belong to this target priority group.
* Syntax: '''String'''
** Example: ''ship''
** Options
:::''"ship"''
:::''"asteroid"''
:::''"weapon"''}}
{{Table38|
:::''"debris"''}}

===+Weapon Class:===
{{Table3611|
* Name of weapon classes which belong to this target priority group.
* Syntax: '''String list''', names of the weapons}}
** Example: ( "''Cyclops''" "''Tsunami''")

===+Object Flags:===
{{Table3611|
* The object flags which make their owners belong to this target priority group.
* Syntax: '''String list'''
** Options:
:::''"no shields"''
:::''"targetable as bomb"''}}
{{Table38|
:::''"renders"''
:::''"collides"''
:::''"physics"''
:::''"invulnerable"''
:::''"player ship"''
:::''"special warpin"''
:::''"immobile"''}}

===+Ship Class Flags:===
{{Table3611|
* The ship class flags which make their owners belong to this target priority group.
* Syntax: '''String list'''
** Valid Options:
:::''"afterburners"''
:::''"big damage"''
:::''"has awacs"''}}
{{Table38|
:::''"no collide"''
:::''"player ship"''
:::''"default player ship"''
:::''"path fixup"''
:::''"support"''
:::''"cargo"''
:::''"fighter"''
:::''"bomber"''
:::''"cruiser"''
:::''"freighter"''
:::''"capital"''
:::''"transport"''
:::''"navbuoy"''
:::''"sentrygun"''
:::''"escapepod"''
:::''"no type"''
:::''"ship copy"''
:::''"in tech database"''
:::''"in tech database multi"''
:::''"stealth"''
:::''"supercap"''
:::''"drydock"''
:::''"dont collide invisible"''
:::''"corvette"''
:::''"gas miner"''
:::''"awacs"''
:::''"knossos"''
:::''"no fred"''
:::''"default in tech database"''
:::''"default in tech database multi"''
:::''"flash"''
:::''"show ship"''
:::''"surface shields"''
:::''"generate icon"''
:::''"no weapon damage scaling"''
:::''"gun convergence"''
:::''"no thruster geometry noise"''
:::''"intrinsic no shields"''
:::''"no primary linking"''
:::''"no pain flash"''
:::''"allow landings"''
:::''"no ets"''
:::''"no lighting"''
:::''"dyn primary linking"''
:::''"auto spread shields"''
:::''"draw weapon models"''
:::''"model point shields"''
:::''"repair disabled subsystems"''}}

===+Weapon Class Flags:===
{{Table3611|
* The weapon class flags which make their owners belong to this target priority group.
* Syntax: '''String list'''
** Valid Options:
:::''"bomb"''
:::''"huge damage"''
:::''"supercap damage"''
:::''"bomber+"''
:::''"electronics"''
:::''"puncture"''
:::''"emp"''
:::''"heat seeking"''
:::''"aspect seeking"''
:::''"engine seeking"''
:::''"pierce shields"''
:::''"local ssm"''}}
{{Table3613|
:::''"capital+"''}}
{{Table38|
:::''"heat-seeking"''
:::''"aspect-seeking"''
:::''"javelin"''
:::''"spawn"''
:::''"remote detonate"''
:::''"countermeasure"''
:::''"turns"''
:::''"swarm"''
:::''"trail"''
:::''"big ship"''
:::''"child"''
:::''"no dumbfire"''
:::''"thruster"''
:::''"in tech database"''
:::''"player allowed"''
:::''"corkscrew"''
:::''"particle spew"''
:::''"esuck"''
:::''"flak"''
:::''"tag"''
:::''"shudder"''
:::''"lockarm"''
:::''"stream"''
:::''"ballistic"''
:::''"default in tech database"''
:::''"tagged only"''
:::''"cycle"''
:::''"small only"''
:::''"same turret cooldown"''
:::''"apply no light"''
:::''"transparent"''
:::''"training"''
:::''"smart spawn"''
:::''"inherit parent target"''
:::''"no emp kill"''
:::''"variable lead homing"''
:::''"untargeted heat seeker"''
:::''"no radius doubling"''
:::''"no subsystem homing"''
:::''"no lifeleft penalty"''
:::''"custom seeker str"''
:::''"can be targeted"''
:::''"show on radar"''
:::''"show friendly on radar"''
:::''"chain external model fps"''
:::''"external model launcher"''
:::''"takes blast damage"''
:::''"takes shockwave damage"''
:::''"hide from radar"''
:::''"render flak"''
:::''"ciws"''
:::''"anti-subsystem beam"''
:::''"no primary linking"''
:::''"same emp time for capships"''
:::''"no primary linked penalty"''
:::''"no homing speed ramp"''
:::''"pulls aspect seekers"''
:::''"turret interceptable"''
:::''"fighter interceptable"''
:::''"aoe electronics"''
:::''"apply recoil"''
:::''"don't spawn if shot"''
:::''"die on lost lock"''}}

==#End==

==#Weapon Targeting Priorities==

===$Name:===
{{Table3611|
* Name of the weapon for which the target priorities are set
* Syntax: '''''String''''', name of the weapon}}

===+Target Priority:===
{{Table3611|
* Names (in order) of the target priorities set for this ship
* Syntax: '''''String list'''''}}

==#End==

==#Ship Types==

===$Name:===
{{Table3610|
* Name of ship type. To assign a ship class to a given type, simply place the name entered here in the ship class's "$Flags:" field.
* Syntax: '''String'''}}

===+nocreate===
{{Table3610|
*Used with [[Modular Tables|modular tables]]}}

===$Target Priority Groups:===
{{Table3611|
* Defines the target priority groups ships of this objecttype belong to
* Syntax: '''''String list'''''
* '''+Override'''
** Replaces the objecttypes existing groupings}}

===$Counts for Alone:===
{{Table3610|
* Whether ship counts for determing whether or not Freespace 2 will play the "No reinforcements are available" message.
* Syntax: '''Boolean''', Yes or No}}

===$Praise Destruction:===
{{Table3610|
* Whether wingmates will praise destruction of the ship.
* Syntax: '''Boolean''', Yes or No}}

===$On Hotkey List:===
{{Table3610|
* Whether ship will show up in hotkey screen.
* Syntax: '''Boolean''', Yes or No}}

===$Target as Threat:===
{{Table3610|
* Whether ship will be targetted with the 'H' key.
* Syntax: '''Boolean''', Yes or No}}

===$Scannable:===
{{Table3610|
* Toggles whether ship type can be scanned
* Syntax: '''Boolean''', Yes or No}}

===$Warp Pushes:===
{{Table3610|
* Whether ship will push other (pushable) ships out of the way while warping.
* Syntax: '''Boolean''', Yes or No}}

===$Warp Pushable:===
{{Table3610|
* Whether ship can be pushed out of the way by ships with Warp Pushes enabled
* Syntax: '''Boolean''', Yes or No}}

===$Turrets prioritize ship target:===
{{Table3611|
* Defines that ships turrets prioritize ships current target above normal turret targeting priorities
* Syntax: '''Boolean''', Yes or No}}

===$Max Debris Speed:===
{{Table3610|
* Defined the maximum speed for debris form this shiptype
* Syntax: '''float'''}}

===$FF Multiplier:===
{{Table3610|
* Friendly-fire damage to ship will be multiplied by this amount
* Syntax: '''Float'''}}

===$EMP Multiplier:===
{{Table3610|
* EMP effect will be multiplied by this amount. Higher values mean more HUD jittering/longer-lasting effect.
* Syntax: '''Float'''}}

===$Beams Easily Hit:===
{{Table3610|
* Whether beams can easily hit ship (eg capship beams rarely hit fighters)
* Syntax: '''Boolean''', Yes or No}}

===$Protected on cripple:===
{{Table3613|
* If ship should be protected when its subsystems are being targeted
* Syntax: '''Boolean''', Yes or No}}

===$No Huge Beam Impact Effects:===
{{Table3611|
* Defines if the huge beams will generate impact effects on ships of this type
* Syntax: '''Boolean'''}}

===$Don't display class in briefing:===
{{Table3613|
* Option to prevent ship class data from being shown during the briefings
* Syntax: '''Boolean'''}}

===$Fog:===

====+Start Dist:====
{{Table3610|
* Distance from camera that fogging effect will start
* Syntax: '''Float'''}}

====+Compl Dist:====
{{Table3610|
* Distance from camera that this object will be completely obscured by the fogging effect
* Syntax: '''Float'''}}

===$AI:===

====+Valid Goals:====
{{Table3610|
* Valid goals that can be given to this object.
* Syntax: '''( "String" "String" )'''
* '''Goals:'''
** attack ship
** dock
** waypoints
** waypoints once
** depart
** attack subsys
** form on wing
** undock
** attack wing
** guard ship
** disable ship
** disarm ship
** attack any
** ignore ship
** ignore ship (new)
** guard wing
** evade ship
** stay near ship
** keep safe dist
** rearm ship
** stay still
** play dead
** attack weapon
** fly to ship}}
{{Table38|
** chase ship class}}

====+Accept Player Orders:====
{{Table3610|
* Whether or not ship type will accept orders from player
* Syntax: ''Yes/No''}}

====+Player Orders:====
{{Table3610|
* Orders that ship type will accept from player
* Syntax: '''( "String" "String" )'''
* '''Orders:'''
** attack ship
** disable ship
** disarm ship
** disable subsys
** guard ship
** ignore ship
** form on wing
** cover me
** attack any
** depart
** dock
** rearm me
** abort rearm
** stay near me
** stay near ship
** keep safe dist}}

====+Auto Attacks:====
{{Table3610|
* Whether or not ship type will auto attack nearby ships
* Syntax: '''Boolean''', Yes or No}}

====+Attempt broadside:====
{{Table3610|
* Whether or not ship type will try to use broadside tactics against enemy ships
* Syntax: '''Boolean''', Yes or No}}

====+Actively Pursues:====
{{Table3610|
* Which ship types the current ship type will actively pursue (rather than simply return to guard position or whatnot)
* Syntax: '''( "String" "String" )''', shiptypes}}

====+Guards Attack this:====
{{Table3610|
* Whether ships assigned to guard another ship will attempt to engage ships of the type
* Syntax: '''Boolean''', Yes or No}}

====+Turrets Attack This:====
{{Table3610|
* Whether or not turrets will target the ships of the type
* Syntax: '''Boolean''', Yes or No}}

====+Can Form Wing:====
{{Table3610|
* Whether or not ship type can be formed into a wing
* Syntax: '''Boolean''', Yes or No}}

====+Active Docks:====
{{Table3610|
* Preferred docking bay type for ship when it is initiating the dock with another ship
* Syntax: '''( "String" "String" )''', names of the dock bays
* '''Dock bays:'''
** cargo
** rearm
** generic}}

====+Passive Docks:====
{{Table3610|
* Preferred docking bay type for ship when it is receiving a dock from another ship
* Syntax: '''( "String" "String" )'''
* '''Dock bays:'''
** cargo
** rearm
** generic}}

====+Ignored on cripple by:====
{{Table3613|
* Defines the ship types which ignore this ship if its has been crippled
* Syntax: '''String list''', ( "string" "string" )
}}

===$Explosion Animations:===
{{Table3610|
* Defines the animations used with the objecttype
* Syntax: '''Integer list'''}}

===$Vaporize Percent Chance:===
{{Table3611|
*Allows ships to sometimes explode instantly (vaporize) instead of going through a death roll first. This can be overriden on a per-ship basis in [[ships.tbl]].
*Syntax: '''''Float''''', percent chance of vaporization}}

==#End==

==Examples==

===Default FreeSpace 2 Table===
*This is the default table built into the executable that is loaded when no objecttypes.tbl can be found in the games' load path
*Shiptypes '''Stealth''' and '''Fighter/Bomber''' do not seem to be used
<pre>
#Ship types

$Name: Navbuoy
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 10.0
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Turrets attack this: YES
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Sentry Gun
$Counts for Alone: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 200
$FF Multiplier: 0.10
$EMP Multiplier: 10.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Accept Player Orders: NO
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Escape Pod
$Praise Destruction: YES
$On Hotkey List: YES
$Warp Pushable: YES
$Turrets prioritize ship target: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 10.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Turrets attack this: YES
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Cargo
$Scannable: YES
$Max Debris Speed: 200
$FF Multiplier: 0.10
$EMP Multiplier: 10.0
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Passive docks: ( "cargo" )
$Vaporize Percent Chance: 0.0

$Name: Support
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Turrets prioritize ship target: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 3.5
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "dock" "undock" "waypoints" "waypoints once" "stay near ship" "keep safe dist" "stay still" "play dead" )
+Accept Player Orders: YES
+Player orders: ( "rearm me" "abort rearm" "depart" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Active docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

;;WMC - Stealth ships always have another type, so this isn't used
$Name: Stealth
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "waypoints" "waypoints once" "depart" "attack subsys" "attack wing" "guard ship" "disable ship" "disarm ship" "attack any" "ignore ship" "ignore ship (new)" "guard wing" "evade ship" "stay still" "play dead" "stay near ship" "keep safe dist" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "disable ship" "disarm ship" "guard ship" "ignore ship" "ignore ship (new)" "form on wing" "cover me" "attack any" "depart" "disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Fighter
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Turrets prioritize ship target: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "waypoints" "waypoints once" "depart" "attack subsys" "attack wing" "guard ship" "disable ship" "disarm ship" "attack any" "ignore ship" "ignore ship (new)" "guard wing" "evade ship" "stay still" "play dead" "stay near ship" "keep safe dist" "form on wing")
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "disable ship" "disarm ship" "guard ship" "ignore ship" "ignore ship (new)" "form on wing" "cover me" "attack any" "depart" "disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Bomber
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Turrets prioritize ship target: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "waypoints" "waypoints once" "depart" "attack subsys" "attack wing" "guard ship" "disable ship" "disarm ship" "attack any" "ignore ship" "ignore ship (new)" "guard wing" "evade ship" "stay still" "play dead" "stay near ship" "keep safe dist" "form on wing" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "disable ship" "disarm ship" "guard ship" "ignore ship" "ignore ship (new)" "form on wing" "cover me" "attack any" "depart" "disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

;;WMC - This fighter/bomber type doesn't seem to be used anywhere, because no ship is set as both fighter and bomber
$Name: Fighter/bomber
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushable: YES
$Max Debris Speed: 200
$FF Multiplier: 1.0
$EMP Multiplier: 4.0
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "waypoints" "waypoints once" "depart" "attack subsys" "attack wing" "guard ship" "disable ship" "disarm ship" "attack any" "ignore ship" "ignore ship (new)" "guard wing" "evade ship" "stay still" "play dead" "stay near ship" "keep safe dist" "form on wing" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "disable ship" "disarm ship" "guard ship" "ignore ship" "ignore ship (new)" "form on wing" "cover me" "attack any" "depart" "disable subsys" )
+Auto attacks: YES
+Actively Pursues: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Transport
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 2.0
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 500.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "dock" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Freighter
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Scannable: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 1.75
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "dock" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Active docks: ( "cargo" )
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: AWACS
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 0.8
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Gas Miner
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 1.0
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Cruiser
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 0.9
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Corvette
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 150
$FF Multiplier: 1.0
$EMP Multiplier: 0.3333
$Beams Easily Hit: YES
$Protected on cripple: YES
$Fog:
+Start dist: 10.0
+Compl dist: 600.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "dock" "waypoints" "waypoints once" "depart" "undock" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "attack ship" "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Capital
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushes: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.2
$Beams Easily Hit: YES
$Protected on cripple: NO
$Fog:
+Start dist: 10.0
+Compl dist: 750.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "waypoints" "waypoints once" "depart" "stay still" "play dead" "stay near ship" )
+Accept Player Orders: YES
+Player Orders: ( "depart" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Super Cap
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Warp Pushes: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.075
$Beams Easily Hit: YES
$Protected on cripple: NO
$Fog:
+Start dist: 10.0
+Compl dist: 1000.0
$AI:
+Valid goals: ( "fly to ship" "attack ship" "attack wing" "waypoints" "waypoints once" "depart" "stay still" "play dead" "stay near ship" )
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Can Form Wing: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Drydock
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.5
$Beams Easily Hit: YES
$Protected on cripple: NO
$Fog:
+Start dist: 10.0
+Compl dist: 750.0
$AI:
+Accept Player Orders: YES
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

$Name: Knossos Device
$Counts for Alone: YES
$Praise Destruction: YES
$On Hotkey List: YES
$Target as Threat: YES
$Show Attack Direction: YES
$Max Debris Speed: 100
$FF Multiplier: 1.0
$EMP Multiplier: 0.10
$Protected on cripple: NO
$Fog:
+Start dist: 10.0
+Compl dist: 1000.0
$AI:
+Auto attacks: YES
+Attempt Broadside: YES
+Actively Pursues: ( "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
+Guards attack this: YES
+Turrets attack this: YES
+Passive docks: ( "support" )
+Ignored on cripple by: ( "navbuoy" "sentry gun" "escape pod" "cargo" "support" "stealth" "fighter" "bomber" "fighter/bomber" "transport" "freighter" "awacs" "gas miner" "cruiser" "corvette" "capital" "super cap" "drydock" "knossos device" )
$Vaporize Percent Chance: 0.0

#End </pre>

[[Category: Tables]]

Iff defs.tbl

2017-02-19T12:57:11Z

The E: /* $Flags: */

{{SCP_table}}

{{TableVersion|5307}}

The '''iff_defs.tbl''' (Identification Friend or Foe) table stores data on FS2's IFF (Identification Friend or Foe) entries. This tables default version (shown as example) is included to the code so '''iff_defs.tbl''' is not required unless entries are to be added or changed.

[[Tables|List of Tables]]

==General Format==
*IFF_defs table consist of the generic definitions followed by actual iff definitions
*Table begins with #'''IFFs'''
*The traitor must be defined with '''$Traitor IFF:'''
**This entry is used to define which IFF is used to represent the traitors IFF
*Different IFFs entries begin with '''[[iff_defs.tbl#$IFF Name:|$IFF Name:]]
*Table ends with #'''End'''

===$Traitor IFF:===
*This entry is used to define which IFF is used to represent the traitors IFF
*Syntax: '''''String''''', IFF entry

===$Selection Color: or $Selection Colour:===
{{Table3611|
*Defines the color of the targeting brackets of selected targets (like asteroids and multi targeting targets and such)
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 255, 255, 255 )

===$Message Color: or $Message Colour:===
{{Table3611|
*Defines the color of the targeting brackets of the ship currently sending a message
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 127 )

===$Tagged Color: or $Tagged Colour:===
{{Table3611|
*Defines the color of the tagged targets
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 255, 255, 0 )

===$Dimmed IFF brightness:===
{{Table3611|
*Defines how much dimmer (transparent) are the dimmed objects of the HUD (most displays, distant targets on radar etc.)
*Syntax: '''Integer''', values from 0 to 15}}
:*Default: 4

===$Use Alternate Blip Coloring:===
{{Table3611|
*If set forces all blips to use uniform transparency based 'dimming' method instead of using 1/2 brightness (non-transparent) on the non-ship blips
*Syntax: '''Boolean'''}}
:*Default: NO

===$Missile Blip Color: or $Missile Blip Colour:===
{{Table3611|
*Defines the color of the weapons (bombs) on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 0 )

===$Navbuoy Blip Color: or $Navbuoy Blip Colour:===
{{Table3611|
*Defines the color of the navbuoys on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 127 )

===$Warping Blip Color: or $Warping Blip Colour:===
{{Table3611|
*Defines the color of the warping ships on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 0, 0, 255 )

===$Node Blip Color: or $Node Blip Colour:===
{{Table3611|
*Defines the color of the jump nodes on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 127 )

===$Tagged Blip Color: or $Tagged Blip Colour:===
{{Table3611|
*Defines the color of the tagged targets on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 255, 255, 0 )

===$Radar Target ID Flags:===
{{Table3611|
*Defines the appearance of the currently targeted blip on radar screen.
*Syntax: ( '''"String"''' ), name of the flag
**List of flags:
***''"crosshairs"''
***''"blink"''
***''"pulsate"''
***''"enlarge"''}}

==$IFF Name:==

===$Colour: or $Color:===
{{Table3610|
*Defines the color of the IFF as seen in by default (e.g. in briefing icons).
*Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively
**Example: ( 0, 255, 0 )}}

===$Attacks:===
{{Table3610|
*Defines the IFFs that are attacked by default
*Syntax: ( '''String''' ), name of the IFF
**Example: ( "Friendly" "Neutral" "Traitor" )}}

===+Sees ''IFF Name'' As:===
{{Table3610|
*IFF can be set to be seen as in different color than what that IFFS default color is.
*Same IFF may have multiple ''+Sees '''IFF Name''' As:'' entries
*'''''IFF Name''''' defines the name of the IFF to have a different color.
**Example: +Sees '''Hostile''' As:
*Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively
**Example: ( 255, 0, 0 )}}

===$Flags:===
{{Table3610|
*IFFs can have special flags assigned to them.
*Syntax: ( '''"String"''' ), name of the flag
**Example: ( "support allowed" )
**List of flags:
***''"support allowed"''
****When a ship with this IFF is disabled and in a wing, it can call for support (normal behaviour for a disabled ship in a wing is to self-destruct)
***''"exempt from all teams at war"''
****As the name says, when the "All Teams at War" flag is set for a mission, ships belonging to this iff will follow normal rules when choosing targets
***''"orders hidden"''
****The HUD will not show a targeted ship's orders
***''"orders shown"''
****The HUD will show a targeted ship's orders (enabled by default for all friendly IFFs)
***''"wing name hidden"''
****The HUD will not show a targeted ship's name if it is in a wing}}

===$Default Ship Flags:===
{{Table3610|
*Ships belonging to a particular IFF can have a default set of flags when created in FRED.
*Syntax: ( '''"String" "String"''' ), names of the flags
**Example: ( "cargo-known" )
**List of possible ship flags:
***''"cargo-known"''
***''"ignore-count"''
***''"protect-ship"''
***''"reinforcement"''
***''"no-shields"''
***''"escort"''
***''"player-start"''
***''"no-arrival-music"''
***''"no-arrival-warp"''
***''"no-departure-warp"''
***''"locked"''
***''"invulnerable"''
***''"hidden-from-sensors"''
***''"scannable"''
***''"kamikaze"''
***''"no-dynamic"''
***''"red-alert-carry"''
***''"beam-protect-ship"''
***''"guardian"''
***''"special-warp"''
***''"vaporize"''
***''"stealth"''
***''"friendly-stealth-invisible"''
***''"don't-collide-invisible"''}}

===$Default Ship Flags2:===
{{Table3610|
*Ships belonging to a particular IFF can have a default set of flags when created in FRED.
*Syntax: ( '''"String" "String"''' ), names of the flags
**Example: ( "cargo-known" )
**List of possible ship flags:
***''"primitive-sensors"''
***''"no-subspace-drive"''
***''"nav-carry-status"''
***''"no-bank"''
***''"affected-by-gravity"''
***''"toggle-subsystem-scanning"''
***''"targetable-as-bomb"''
***''"no-builtin-messages"''
***''"primaries-locked"''
***''"secondaries-locked"''
***''"no-death-scream"''
***''"always-death-scream"''
***''"nav-needslink"''}}

==Sample Entry==

<pre>
#IFFs

;; Every iff_defs.tbl must contain a Traitor entry. Traitors attack
;; one another (required by the dogfighting code) but it is up to you
;; to decide who attacks the traitor or whom else the traitor attacks.
$Traitor IFF: Traitor

;------------------------
; Friendly
;------------------------
$IFF Name: Friendly
$Color: ( 0, 255, 0 )
$Attacks: ( "Hostile" "Neutral" "Traitor" )
$Flags: ( "support allowed" )
$Default Ship Flags: ( "cargo-known" )

;------------------------
; Hostile
;------------------------
$IFF Name: Hostile
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Neutral" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )
+Sees Hostile As: ( 0, 255, 0 )

;------------------------
; Neutral
;------------------------
$IFF Name: Neutral
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )
+Sees Hostile As: ( 0, 255, 0 )
+Sees Neutral As: ( 0, 255, 0 )

;------------------------
; Unknown
;------------------------
$IFF Name: Unknown
$Color: ( 255, 0, 255 )
$Attacks: ( "Hostile" )
+Sees Neutral As: ( 0, 255, 0 )
+Sees Traitor As: ( 0, 255, 0 )
$Flags: ( "exempt from all teams at war" )

;------------------------
; Traitor
;------------------------
$IFF Name: Traitor
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Hostile" "Neutral" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )

#End
</pre>

[[Category:Tables]]

Iff defs.tbl

2017-02-19T12:56:29Z

The E: small clarification here

{{SCP_table}}

{{TableVersion|5307}}

The '''iff_defs.tbl''' (Identification Friend or Foe) table stores data on FS2's IFF (Identification Friend or Foe) entries. This tables default version (shown as example) is included to the code so '''iff_defs.tbl''' is not required unless entries are to be added or changed.

[[Tables|List of Tables]]

==General Format==
*IFF_defs table consist of the generic definitions followed by actual iff definitions
*Table begins with #'''IFFs'''
*The traitor must be defined with '''$Traitor IFF:'''
**This entry is used to define which IFF is used to represent the traitors IFF
*Different IFFs entries begin with '''[[iff_defs.tbl#$IFF Name:|$IFF Name:]]
*Table ends with #'''End'''

===$Traitor IFF:===
*This entry is used to define which IFF is used to represent the traitors IFF
*Syntax: '''''String''''', IFF entry

===$Selection Color: or $Selection Colour:===
{{Table3611|
*Defines the color of the targeting brackets of selected targets (like asteroids and multi targeting targets and such)
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 255, 255, 255 )

===$Message Color: or $Message Colour:===
{{Table3611|
*Defines the color of the targeting brackets of the ship currently sending a message
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 127 )

===$Tagged Color: or $Tagged Colour:===
{{Table3611|
*Defines the color of the tagged targets
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 255, 255, 0 )

===$Dimmed IFF brightness:===
{{Table3611|
*Defines how much dimmer (transparent) are the dimmed objects of the HUD (most displays, distant targets on radar etc.)
*Syntax: '''Integer''', values from 0 to 15}}
:*Default: 4

===$Use Alternate Blip Coloring:===
{{Table3611|
*If set forces all blips to use uniform transparency based 'dimming' method instead of using 1/2 brightness (non-transparent) on the non-ship blips
*Syntax: '''Boolean'''}}
:*Default: NO

===$Missile Blip Color: or $Missile Blip Colour:===
{{Table3611|
*Defines the color of the weapons (bombs) on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 0 )

===$Navbuoy Blip Color: or $Navbuoy Blip Colour:===
{{Table3611|
*Defines the color of the navbuoys on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 127 )

===$Warping Blip Color: or $Warping Blip Colour:===
{{Table3611|
*Defines the color of the warping ships on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 0, 0, 255 )

===$Node Blip Color: or $Node Blip Colour:===
{{Table3611|
*Defines the color of the jump nodes on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 127 )

===$Tagged Blip Color: or $Tagged Blip Colour:===
{{Table3611|
*Defines the color of the tagged targets on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 255, 255, 0 )

===$Radar Target ID Flags:===
{{Table3611|
*Defines the appearance of the currently targeted blip on radar screen.
*Syntax: ( '''"String"''' ), name of the flag
**List of flags:
***''"crosshairs"''
***''"blink"''
***''"pulsate"''
***''"enlarge"''}}

==$IFF Name:==

===$Colour: or $Color:===
{{Table3610|
*Defines the color of the IFF as seen in by default (e.g. in briefing icons).
*Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively
**Example: ( 0, 255, 0 )}}

===$Attacks:===
{{Table3610|
*Defines the IFFs that are attacked by default
*Syntax: ( '''String''' ), name of the IFF
**Example: ( "Friendly" "Neutral" "Traitor" )}}

===+Sees ''IFF Name'' As:===
{{Table3610|
*IFF can be set to be seen as in different color than what that IFFS default color is.
*Same IFF may have multiple ''+Sees '''IFF Name''' As:'' entries
*'''''IFF Name''''' defines the name of the IFF to have a different color.
**Example: +Sees '''Hostile''' As:
*Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively
**Example: ( 255, 0, 0 )}}

===$Flags:===
{{Table3610|
*IFFs can have special flags assigned to them.
*Syntax: ( '''"String"''' ), name of the flag
**Example: ( "support allowed" )
**List of flags:
***''"support allowed"''
****When a ship with this IFF is disabled and in a wing, it can call for support (normal behaviour for a disabled ship in a wing is to self-destruct)
***''"exempt from all teams at war"''
****As the name says, when the "All Teams at War" flag is set for a mission, ships belonging to this iff will follow normal rules when choosing targets
***''"orders hidden"''
****The HUD will not show a targeted ship's orders
***''"orders shown"''
****The HUD will show a targeted ship's orders (friendly has by default)
***''"wing name hidden"''
****The HUD will not show a targeted ship's name if it is in a wing}}

===$Default Ship Flags:===
{{Table3610|
*Ships belonging to a particular IFF can have a default set of flags when created in FRED.
*Syntax: ( '''"String" "String"''' ), names of the flags
**Example: ( "cargo-known" )
**List of possible ship flags:
***''"cargo-known"''
***''"ignore-count"''
***''"protect-ship"''
***''"reinforcement"''
***''"no-shields"''
***''"escort"''
***''"player-start"''
***''"no-arrival-music"''
***''"no-arrival-warp"''
***''"no-departure-warp"''
***''"locked"''
***''"invulnerable"''
***''"hidden-from-sensors"''
***''"scannable"''
***''"kamikaze"''
***''"no-dynamic"''
***''"red-alert-carry"''
***''"beam-protect-ship"''
***''"guardian"''
***''"special-warp"''
***''"vaporize"''
***''"stealth"''
***''"friendly-stealth-invisible"''
***''"don't-collide-invisible"''}}

===$Default Ship Flags2:===
{{Table3610|
*Ships belonging to a particular IFF can have a default set of flags when created in FRED.
*Syntax: ( '''"String" "String"''' ), names of the flags
**Example: ( "cargo-known" )
**List of possible ship flags:
***''"primitive-sensors"''
***''"no-subspace-drive"''
***''"nav-carry-status"''
***''"no-bank"''
***''"affected-by-gravity"''
***''"toggle-subsystem-scanning"''
***''"targetable-as-bomb"''
***''"no-builtin-messages"''
***''"primaries-locked"''
***''"secondaries-locked"''
***''"no-death-scream"''
***''"always-death-scream"''
***''"nav-needslink"''}}

==Sample Entry==

<pre>
#IFFs

;; Every iff_defs.tbl must contain a Traitor entry. Traitors attack
;; one another (required by the dogfighting code) but it is up to you
;; to decide who attacks the traitor or whom else the traitor attacks.
$Traitor IFF: Traitor

;------------------------
; Friendly
;------------------------
$IFF Name: Friendly
$Color: ( 0, 255, 0 )
$Attacks: ( "Hostile" "Neutral" "Traitor" )
$Flags: ( "support allowed" )
$Default Ship Flags: ( "cargo-known" )

;------------------------
; Hostile
;------------------------
$IFF Name: Hostile
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Neutral" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )
+Sees Hostile As: ( 0, 255, 0 )

;------------------------
; Neutral
;------------------------
$IFF Name: Neutral
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )
+Sees Hostile As: ( 0, 255, 0 )
+Sees Neutral As: ( 0, 255, 0 )

;------------------------
; Unknown
;------------------------
$IFF Name: Unknown
$Color: ( 255, 0, 255 )
$Attacks: ( "Hostile" )
+Sees Neutral As: ( 0, 255, 0 )
+Sees Traitor As: ( 0, 255, 0 )
$Flags: ( "exempt from all teams at war" )

;------------------------
; Traitor
;------------------------
$IFF Name: Traitor
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Hostile" "Neutral" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )

#End
</pre>

[[Category:Tables]]

Iff defs.tbl

2017-02-19T12:46:57Z

The E: Adding explanations for the IFF defs flags

{{SCP_table}}

{{TableVersion|5307}}

The '''iff_defs.tbl''' (Identification Friend or Foe) table stores data on FS2's IFF (Identification Friend or Foe) entries. This tables default version (shown as example) is included to the code so '''iff_defs.tbl''' is not required unless entries are to be added or changed.

[[Tables|List of Tables]]

==General Format==
*IFF_defs table consist of the generic definitions followed by actual iff definitions
*Table begins with #'''IFFs'''
*The traitor must be defined with '''$Traitor IFF:'''
**This entry is used to define which IFF is used to represent the traitors IFF
*Different IFFs entries begin with '''[[iff_defs.tbl#$IFF Name:|$IFF Name:]]
*Table ends with #'''End'''

===$Traitor IFF:===
*This entry is used to define which IFF is used to represent the traitors IFF
*Syntax: '''''String''''', IFF entry

===$Selection Color: or $Selection Colour:===
{{Table3611|
*Defines the color of the targeting brackets of selected targets (like asteroids and multi targeting targets and such)
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 255, 255, 255 )

===$Message Color: or $Message Colour:===
{{Table3611|
*Defines the color of the targeting brackets of the ship currently sending a message
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 127 )

===$Tagged Color: or $Tagged Colour:===
{{Table3611|
*Defines the color of the tagged targets
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 255, 255, 0 )

===$Dimmed IFF brightness:===
{{Table3611|
*Defines how much dimmer (transparent) are the dimmed objects of the HUD (most displays, distant targets on radar etc.)
*Syntax: '''Integer''', values from 0 to 15}}
:*Default: 4

===$Use Alternate Blip Coloring:===
{{Table3611|
*If set forces all blips to use uniform transparency based 'dimming' method instead of using 1/2 brightness (non-transparent) on the non-ship blips
*Syntax: '''Boolean'''}}
:*Default: NO

===$Missile Blip Color: or $Missile Blip Colour:===
{{Table3611|
*Defines the color of the weapons (bombs) on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 0 )

===$Navbuoy Blip Color: or $Navbuoy Blip Colour:===
{{Table3611|
*Defines the color of the navbuoys on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 127 )

===$Warping Blip Color: or $Warping Blip Colour:===
{{Table3611|
*Defines the color of the warping ships on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 0, 0, 255 )

===$Node Blip Color: or $Node Blip Colour:===
{{Table3611|
*Defines the color of the jump nodes on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 127, 127, 127 )

===$Tagged Blip Color: or $Tagged Blip Colour:===
{{Table3611|
*Defines the color of the tagged targets on radar screen. Dimmed color is 1/2 unless alternate blip coloring is in use.
*Syntax: '''Integer list''', values from 0 to 255, red, green and blue respectively}}
:*Default: ( 255, 255, 0 )

===$Radar Target ID Flags:===
{{Table3611|
*Defines the appearance of the currently targeted blip on radar screen.
*Syntax: ( '''"String"''' ), name of the flag
**List of flags:
***''"crosshairs"''
***''"blink"''
***''"pulsate"''
***''"enlarge"''}}

==$IFF Name:==

===$Colour: or $Color:===
{{Table3610|
*Defines the color of the IFF as seen in by default (e.g. in briefing icons).
*Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively
**Example: ( 0, 255, 0 )}}

===$Attacks:===
{{Table3610|
*Defines the IFFs that are attacked by default
*Syntax: ( '''String''' ), name of the IFF
**Example: ( "Friendly" "Neutral" "Traitor" )}}

===+Sees ''IFF Name'' As:===
{{Table3610|
*IFF can be set to be seen as in different color than what that IFFS default color is.
*Same IFF may have multiple ''+Sees '''IFF Name''' As:'' entries
*'''''IFF Name''''' defines the name of the IFF to have a different color.
**Example: +Sees '''Hostile''' As:
*Syntax: ( '''Color''' ), three '''integers''', values from 0 to 255; red, green and blue respectively
**Example: ( 255, 0, 0 )}}

===$Flags:===
{{Table3610|
*IFFs can have special flags assigned to them.
*Syntax: ( '''"String"''' ), name of the flag
**Example: ( "support allowed" )
**List of flags:
***''"support allowed"''
****When a ship with this IFF is disabled, it can call for support (normal behaviour is to self-destruct)
***''"exempt from all teams at war"''
****As the name says, when the "All Teams at War" flag is set for a mission, ships belonging to this iff will follow normal rules when choosing targets
***''"orders hidden"''
****The HUD will not show a targeted ship's orders
***''"orders shown"''
****The HUD will show a targeted ship's orders (friendly has by default)
***''"wing name hidden"''
****The HUD will not show a targeted ship's name if it is in a wing}}

===$Default Ship Flags:===
{{Table3610|
*Ships belonging to a particular IFF can have a default set of flags when created in FRED.
*Syntax: ( '''"String" "String"''' ), names of the flags
**Example: ( "cargo-known" )
**List of possible ship flags:
***''"cargo-known"''
***''"ignore-count"''
***''"protect-ship"''
***''"reinforcement"''
***''"no-shields"''
***''"escort"''
***''"player-start"''
***''"no-arrival-music"''
***''"no-arrival-warp"''
***''"no-departure-warp"''
***''"locked"''
***''"invulnerable"''
***''"hidden-from-sensors"''
***''"scannable"''
***''"kamikaze"''
***''"no-dynamic"''
***''"red-alert-carry"''
***''"beam-protect-ship"''
***''"guardian"''
***''"special-warp"''
***''"vaporize"''
***''"stealth"''
***''"friendly-stealth-invisible"''
***''"don't-collide-invisible"''}}

===$Default Ship Flags2:===
{{Table3610|
*Ships belonging to a particular IFF can have a default set of flags when created in FRED.
*Syntax: ( '''"String" "String"''' ), names of the flags
**Example: ( "cargo-known" )
**List of possible ship flags:
***''"primitive-sensors"''
***''"no-subspace-drive"''
***''"nav-carry-status"''
***''"no-bank"''
***''"affected-by-gravity"''
***''"toggle-subsystem-scanning"''
***''"targetable-as-bomb"''
***''"no-builtin-messages"''
***''"primaries-locked"''
***''"secondaries-locked"''
***''"no-death-scream"''
***''"always-death-scream"''
***''"nav-needslink"''}}

==Sample Entry==

<pre>
#IFFs

;; Every iff_defs.tbl must contain a Traitor entry. Traitors attack
;; one another (required by the dogfighting code) but it is up to you
;; to decide who attacks the traitor or whom else the traitor attacks.
$Traitor IFF: Traitor

;------------------------
; Friendly
;------------------------
$IFF Name: Friendly
$Color: ( 0, 255, 0 )
$Attacks: ( "Hostile" "Neutral" "Traitor" )
$Flags: ( "support allowed" )
$Default Ship Flags: ( "cargo-known" )

;------------------------
; Hostile
;------------------------
$IFF Name: Hostile
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Neutral" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )
+Sees Hostile As: ( 0, 255, 0 )

;------------------------
; Neutral
;------------------------
$IFF Name: Neutral
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )
+Sees Hostile As: ( 0, 255, 0 )
+Sees Neutral As: ( 0, 255, 0 )

;------------------------
; Unknown
;------------------------
$IFF Name: Unknown
$Color: ( 255, 0, 255 )
$Attacks: ( "Hostile" )
+Sees Neutral As: ( 0, 255, 0 )
+Sees Traitor As: ( 0, 255, 0 )
$Flags: ( "exempt from all teams at war" )

;------------------------
; Traitor
;------------------------
$IFF Name: Traitor
$Color: ( 255, 0, 0 )
$Attacks: ( "Friendly" "Hostile" "Neutral" "Traitor" )
+Sees Friendly As: ( 255, 0, 0 )

#End
</pre>

[[Category:Tables]]

FS2 Data Structure

2017-02-16T14:02:57Z

The E: /* fonts */

Although some expert hand has been through the page, where the (original) writer has doubts is marked in blue colour.

==Introduction==
::Through all this page, SCP fs2_open and FRED2_open additions over retail behaviour will be marked in red font.

Apart from the game engine or the mission editor, FRED, the game needs data to run; it needs missions, sounds, 3D models, textures... FreeSpace 2 is highly moddable because nearly none of these data are embedded inside the game executable. In this way the user can always change nearly all game behaviour and appearance.

Like all your applications you'll have FreeSpace 2 installed in one folder in your hard disk drive. We will call this folder '''/freespace2''', although it can have any other name (''/fs2'', ''/fspace2'', or whatever). Inside this folder, FreeSpace 2 stores all its game data in three places (retail version just in two):
#Unpacked, ie. individual files, inside '''data''' folder within FreeSpace 2 installation folder, ie. in '''/freespace2/data'''. ('''data''' name is compulsory). Inside '''data''' folder, the game contents are classified and stored in several subfolders. [[FS2_Data_Structure#data_subfolders|Below]], you have the full list of '''data''' subfolders with their description and contents, (remember that all their names are compulsory). The most commonly used and changed are:
#*[[FS2_Data_Structure#effects|effects]] contains all the textures and animations used in all explosions, weapon glows, smoke, particles and so on.
#*[[FS2_Data_Structure#maps|maps]] contains all the textures, (and animated textures), used over ship models.
#*[[FS2_Data_Structure#missions|missions]] contains all the mission ([[%2A.FS2]]) and campaign ([[%2A.FC2]]) definition files.
#*[[FS2_Data_Structure#models|models]] contains all 3D models ([[%2A.POF]]).
#*[[FS2_Data_Structure#music|music]] contains all the music files.
#*[[FS2_Data_Structure#sounds|sounds]] contains all ingame sound effect files.
#*[[FS2_Data_Structure#tables|tables]] contains all table files. Tables define all the behaviour the game components have. They are the most important thing for modders to know. See [[Tables]] section for deeper info.
#*[[FS2_Data_Structure#voice|voice]] contains all the ingame voices.
#Packed in vp archives. This kind of archives just contain individual files in a similar way as "normal" archives like rar or zip do. They are placed in '''/freespace2''' folder. Special software, like [[VPMage]], is needed to build them. Another really good utility is [[Maja|WMCoolmon's Maja]] which comes in a Java cross-platform executable. You can grab it from [http://wmc.freespacemods.net/repository/ WMC::Repository]. If you just want to browse or extract files from existing vps, but not editing or building them, then use [[VPView]]. You've got two versions of it in [http://www.descent-network.com/descman Descent Network download page] vp archives also follow the data structure, so, even while packed in a vp archive, your missions will be in /data/missions and your ship 3D models in /data/models. All retail data come packed in several vps. The next, and only the next, are the original game contents (when patched to v1.2):
#*root_fs2.vp (6,255 KB - 157 files - checksum of 0xce10d76c): Mainly [[FS2_Data_Structure#tables|tables]] and [[FS2_Data_Structure#missions|missions]]. (Number of files and checksum as reported in fs2_open.log when running a fs2_open ''debug'' build. Please notice that vp can actually contain more files than the reported number, but these are the pure game data files. As example root_fs2.vp contains 160 files with three useless ''vssver.scc'' in tables, images and squads).
#*smarty_fs2.vp (120,241 KB - 10 files - checksum of 0xddeb3b1e): [[FS2_Data_Structure#intelanims|Intelligence animations]].
#*sparky_fs2.vp (254,457 KB - 3027 files - checksum of 0x164fe65a): Most of the game data, mainly [[FS2_Data_Structure#models|models]], [[FS2_Data_Structure#maps|maps]], [[FS2_Data_Structure#effects|effects]], [[FS2_Data_Structure#hud|hud]], [[FS2_Data_Structure#interface|interface]] and [[FS2_Data_Structure#sounds|sounds]] data.
#*sparky_hi_fs2.vp (259,026 KB - 1337 files - checksum of 0xa11d56f1): Extra [[FS2_Data_Structure#hud|hud]] and [[FS2_Data_Structure#interface|interface]] data for hi res (1024x768).
#*stu_fs2.vp (169,108 KB - 2355 files - checksum of 0xd77da83a): [[FS2_Data_Structure#voice|Voice]] data.
#*tango1_fs2.vp (191,297 KB - 32 files - checksum of 0x4c25221e): 1st pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*tango2_fs2.vp (71,073 KB - 15 files - checksum of 0x86920b82): 2nd pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*tango3_fs2.vp (49,314 KB - 10 files - checksum of 0x705e8d71): 3rd pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*warble_fs2.vp (116,073 KB - 52 files - checksum of 0xd85c305d): [[FS2_Data_Structure#music|Music]] data.
#*[[%2A.MVE]] movies (cutscenes). They are not originally installed in the user hard disk drive. They are read from game CDs.
#'''One of the most important SCP fs2_open additions:''' Auxiliary data folders loaded through [[Command-Line_Reference#-mod|-MOD launcher flag]]. Retail game only use former both places. But fs2_open, (and FRED2_open), can use any other auxiliary folder in /freespace2 as game data holder. This feature allows installing and using several different mods without having undesired cross-effects.

The most important consequence of having several available locations for game data, is that several versions of each file can exist. '''There's a priority order between different locations''' as explained in [[Command-Line_Reference#-mod|-MOD launcher flag help]]. Due to this order, '''only the highest priority version of each file will be used'''. This feature allows the user to quickly replace existing ''mission.fs2'' or ''ShipModel.pof'' by new or improved versions, placing them in a higher priority place. There's no need to remove obsolete files.

The use of [[Command-Line_Reference#-mod|-MOD launcher flag]] implies that there will be two or more /data folder structures. Some game data, mainly model cache files ([[Model files#IBX|*.IBX]]), can be regenerated by the game itself. Unless explicitly specified, these autogenerated files will be placed in the ''highest'' priority /data folder structure.

==data subfolders==

===cache===
*'''Contents:''' Model cache files. In versions of FS2Open prior to 3.7.4, model files were processed to extract the actual render geometry. In 3.7.4, that processing step was optimized so that performing this extraction at runtime was just as fast as reading cache files off of the disk; as a consequence, it was decided to remove the cache file reading and writing code.

*'''Notes:'''
**This folder and its contents are obsolete as of FS2Open Release 3.7.4.

===cbanims===
*'''Contents:''' Command and mission briefing animations. (They are assigned to missions through FRED2 editor).
*'''Supported files:''' [[%2A.ANI]] animations.

===config===
*'''Contents''': Used by the SCP Builds. Contains (usually by reference) additional data as loaded by Scripts.
*'''Supported files''': [[%2A.CFG]] files.
{{table38|[[%2A.TBL]], [[%2A.TBM]], [[%2A.XML]] and [[%2A.CSV]] files.}}

===demos===
*'''Contents:''' This is probably where recordable demos would have been saved. If you look in the source code, there are functions in place to record events and play the recordings back at a later time. This code is does not (and in all likely hood will never) work.
*'''Supported files:''' [[%2A.FSD]] (FreeSpace Demo) files.

===effects===
*'''Contents:''' Bitmaps and animations for every game effect:
**All the explosions and weapon effects.
**Damage smoke animation.
**Particle animations.
**Thruster glows and afterburner trails.
**All the background images, sun bitmaps, sun glares and space motion debris (see [[Stars.tbl]] table).
**Warp-in / warp-out animations.
**Anything more you can think of in this category. If you have a texture which you know it doesn't belong to [[FS2_Data_Structure#maps|maps folder]], put it here. If you have doubts, put it here too.
**Since 3.6.10. version (including previously released nightly builds): GLSL shaders. See [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]]
*'''Supported files:'''
**Retail: [[%2A.PCX]] for bitmaps, (example, backgrounds) and [[%2A.ANI]] for animations (example: explosions).
**SCP fs2_open: Both formats and: [[%2A.JPG]], [[%2A.TGA]], [[%2A.PNG]], [[%2A.DDS]], for images, and [[.EFF]] for animations.
**Since 3.6.10. version (including previously released nightly builds): [[%2A.SDR]] shader files. See [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]]
**[[%2A.NEB]] files ?????? 
*'''Notes:'''
**Some effect bitmaps or animations can be assigned by table entries. But the name of many others is hardcoded, (example particlesmoke01).
**Not all the effects support animations. Example background bitmaps.
**[[%2A.PNG]] or [[%2A.DDS]] as/and [[%2A.EFF]] are the preferred formats.
**See [[Texturing]] section for important info about this aspect of the game. It is more important for [[FS2_Data_Structure#maps|maps folder]] contents, (ie. ship textures), but it also applies here.

===fonts===
*'''Contents:''' This folder contains font files for the engine to use. Its native format are .VF ("Volition Font") files, which are bitmapped fonts created using the fonttool.
{{Table373|TrueType Fonts (ttf) are also supported.}}
*'''Supported files:''' [[%2A.VF]] files, [[%2A.TTF]] files

===force feedback===
*'''Contents:''' ???????
*'''Supported files:''' ???????

===freddocs===
*'''Contents:''' This is where the help files for FRED are stored. Since the help files are viewed in a web browser, they were not able to be stored in the VP files.
*'''Supported files:''' *.html, *.gif, *.jpg, *.png.

===hud===
*'''Contents:''' All HUD building bricks. Anything you see on your HUD while flying is defined through this folder contents.
*'''Supported files:'''
**Retail: [[%2A.PCX]] and [[%2A.ANI]].
**SCP fs2_open: The former ones and [[%2A.TGA]], [[%2A.PNG]] and [[%2A.DDS]] formats.
*'''Notes:'''
**Most of this folder contents have a hardcoded name.
**Most of this folder contents are "false" animations. It means that the [[%2A.ANI]] file is only used to pack several related images. Example: every ship shield graphic uses five images, (the ship bitmap and then, front, right, back and left shield quadrants) packed in one [[%2A.ANI]].

===intelanims===
*'''Contents:''' Intelligence animations used in ''Technical Database'' > ''Intelligence'' section. They are used through [[Species.tbl]] table.
*'''Supported files:''' [[%2A.ANI]] animations and [[%2A.EFF]].

===interface===
*'''Contents:'''
**All the game screens and optional mission loading screens.
**All the button, mouse and icon bitmaps.
**Map ship icons in ''Briefing'' screen.
**Ship and weapon animations in ''Ship selection'' and ''Weapon loadout'' screens. These weapon animations are also used in ''Technical Database'' > ''Weapons'' section.
*'''Supported files:'''
**Retail: [[%2A.ANI]] animations and [[%2A.PCX]] bitmaps.
**SCP fs2_open: The former ones and [[%2A.TGA]], [[%2A.PNG]], [[%2A.DDS]] and [[%2A.EFF]] formats.
*'''Notes:'''
**Most people use [[Command-Line_Reference#-ship_choice_3d|-ship_choice_3d]] and [[Command-Line_Reference#-weapon_choice_3d|-weapon_choice_3d]] command-line flags. With these flags, only primary weapon animations are needed for the ''Weapon loadout'' screen. There's no need for ship or secondary weapon animations. Moreover, some mods need a compulsory use of these flags because they have no available animations for their ships or missiles.

===maps===
*'''Contents:''' All the textures used by 3D [[%2A.POF]] models. [[%2A.POF]] models use textures to "paint" their surfaces and to simulate glow points. [[%2A.POF]] files only have links to the names of their used textures, they don't have embedded textures. All their used textures are read from this folder.
*'''Supported files:'''
**Retail: [[%2A.PCX]] bitmaps.
**SCP fs2_open: The former and: [[%2A.JPG]], [[%2A.TGA]], [[%2A.PNG]], [[%2A.DDS]] formats. Some of the textures, (example: glow maps), support animated textures so [[%2A.EFF]] and [[%2A.ANI]] are also supported.
*'''Notes:'''
**See [[Texturing]] section for important info about this aspect of the game.
**[[%2A.DDS]] and [[%2A.EFF]] are the preferred formats.

===missions===
*'''Contents:''' All the mission and campaign files.
*'''Supported files:''' Each mission is one [[%2A.FS2]] file and each campaign is one [[%2A.FC2]] file.
**[[%2A.NTL]] and [[%2A.SSV]] files ????? 
*'''Notes:'''
**In ''Mission Simulator'' screen, ''Single Missions'' are just available [[%2A.FS2]] mission files which are not pointed by any of the available [[%2A.FC2]] campaign files. This is the only way to play this kind of missions.

===models===
*'''Contents:''' All the 3D models used by ships, asteroid and debris fields, missiles, subspace model, 3D shockwaves, 3D warp-in/warp-out effects and background star-holding model.
*'''Supported files:''' [[%2A.POF]] model files.
*'''Notes:'''
**[[%2A.POF]] models have direct relation with [[FS2_Data_Structure#maps|maps]] and [[FS2_Data_Structure#cache|cache]] folder contents.
**3D warp-in/warp-out effects need the usage of [[Command-Line_Reference#-3dwarp|-3dwarp launcher flag]].

===movies===
*'''Contents:''' Game cutscenes.
*'''Supported files:''' [[%2A.MVE]], [[%2A.OGG]], [[%2A.AVI]] and [[%2A.MPG]] clip files.

*'''Notes:'''
**This folder is a fully SCP addition. Retail game reads [[%2A.MVE]] cutscenes from game CDs.
**[[%2A.AVI]] and [[%2A.MPG]] formats are decoded through system player. Their support is [[Deprecation|deprecated]] and therefore not guaranteed in future fs2_open versions.
**Retail uncompressed [[%2A.MVE]] and Theora compressed [[%2A.OGG]] formats are the preferred ones. fs2_open has built-in support for them both.
**All the movies can have custom names, (their loading trigger is defined in FRED), but start-up movie. This movie must be called '''Intro'''.

===multidata===
*'''Contents:''' ???????
*'''Supported files:''' [[%2A.PCX]], [[%2A.DDS]], [[%2A.PNG]] and [[%2A.FS2]] files.

===music===
*'''Contents:''' Music files used through [[Music.tbl]] table.
*'''Supported files:'''
**Retail: PCM [[%2A.WAV]] sound clips up to 16bit - 22kHz - 2 channels.
**SCP fs2_open adds support for compressed [[%2A.OGG]] Vorbis sound clips.

===players===
*'''Contents:''' All game player data.
**It has 4 subfolders, each one has a deeper explanation below:
***[[FS2_Data_Structure#images|images]]: Selectable appearances of the player in ''Barracks'' screen.
***[[FS2_Data_Structure#multi|multi]]: Game data of multiplayer pilots
***[[FS2_Data_Structure#single|single]]: Game data of single player pilots
***[[FS2_Data_Structure#squads|squads]]: Selectable squad insignias of the player in ''Barracks'' screen.
**The main '''players''' folder just contains HUD appearance presets, ([[%2A.HCF]] files), which can be loaded, edited and saved in ''Options'' screen > ''HUD Config'' screen. From this screen they can be also applied to player's HUD settings.
*'''Supported files:''' [[%2A.HCF]] HUD configuration files.
*'''Notes:'''
**Only '''/freespace2/data/players''' main folder '''is used''' despite the [[Command-Line_Reference#-mod|-MOD launcher flag]] settings. Only [[FS2_Data_Structure#images|images]] and [[FS2_Data_Structure#squads|squads]] subfolders are read from any other locations (vp archives or other /mod/data/players folders).
**Of course, [[%2A.HCF]] files can be generated by the game itself, and are the settings for the HUD Options screen.

====images====
*'''Contents:''' Selectable appearances of the player in ''Barracks'' screen, ie. the player's photograph.
*'''Supported files:''' [[%2A.PCX]] images
**'''SCP fs2_open''': [[%2A.PNG]] and [[%2A.DDS]] files.

====multi====
*'''Contents:''' Game data of multiplayer pilots.
*'''Supported files:''' [[%2A.PLR]] files.
*'''Notes:'''
**Only '''/freespace2/data/players/multi''' folder '''is used''' despite the [[Command-Line_Reference#-mod|-MOD launcher flag]] settings.
**Of course, multi player data is generated and updated by the game itself.

====single====
*'''Contents:''' Game data of single player pilots.
*'''Supported files:'''
**Each pilot consists of several files:
***One [[%2A.PL2]] file, (let's call it ''MyPilot.pl2''), which contains main pilot data.
***Several [[%2A.CS2]] files. Each of these files is generated for each played campaign. They have the form ''MyPilot.Campaign name.cs2''.
***FSO: [[%2A.PLR]], [[%2A.CSG]] and [[%2A.CSS]] files.
*'''Notes:'''
**Only '''/freespace2/data/players/single''' folder '''is used''' despite the [[Command-Line_Reference#-mod|-MOD launcher flag]] settings.
**Of course, single player data is generated and updated by the game itself.
**Do not use pilot names longer than 32 characters. The game has problems with them, ie. use short pilot names.

====squads====
*'''Contents:''' Selectable squadron insignias of the player in ''Barracks'' screen.
*'''Supported files:'''
**Retail: [[%2A.PCX]] bitmaps.
**fs2_open: The above format and: [[%2A.PNG]], [[%2A.DDS]] images can be also used. But in order to maintain backwards and multiplayer compatibility, a [[%2A.PCX]] copy of the same insignia '''MUST''' be available. More info can be found in [http://scp.indiegames.us/mantis/view.php?id=1834 Mantis report 1834].

===scripts===
*'''Contents:''' This has something to do with LUA scripting SCP addition, but I know NOTHING about it. Please some expert fill it.
*'''Supported files:''' [[%2A.LUA]] and [[%2A.LC]] files. ???????.

===sounds===
*'''Contents:''' All the game sound effects. [[FS2_Data_Structure#music|Music tracks]] or [[FS2_Data_Structure#voices|ingame speech]] which have their own subfolders.
**It has two folders, [[FS2_Data_Structure#8b22k|8b22k]] and [[FS2_Data_Structure#16b11k|16b11k]] to classify the sounds depending on their quality. But using them is not needed, all the sounds can go in the main folder.
*'''Supported files:'''
**Retail: PCM [[%2A.WAV]] sound clips up to 16bit - 22kHz - 2 channels.
**SCP fs2_open adds support for compressed [[%2A.OGG]] Vorbis sound clips.
*'''Notes:'''
**In game sounds are used through [[Sounds.tbl]] table.
**Normally, game sounds only have one channel. Depending on the sound source location, the game will generate different right and left channel volumes.

====8b22k====
*'''Contents:''' Low quality sounds, but just use the main [[FS2_Data_Structure#sounds|sounds]] folder.

====16b11k====
*'''Contents:''' High quality sounds, but just use the main [[FS2_Data_Structure#sounds|sounds]] folder.

===tables===
*'''Contents:''' Data tables which set the whole game behaviour.
*'''Supported files:'''
**Retail: [[%2A.TBL]] tables.
**One of the most important SCP fs2_open additions: [[%2A.TBM]] [[Modular_Tables|modular table]] files.
*'''Notes:'''
**Tables are just the most important thing for modders to know.
**There is a lot of useful info about them in [[Tables]] section of the Wiki.

===text===
*'''Contents:''' ???????
*'''Supported files:''' [[%2A.TXT]] and [[%2A.NET]] files.

===voice===
*'''Contents:''' In game speech. This speech is separated in six different types. Each of them is located in its own subfolder inside voice folder.
**Campaign command briefing speeches. They are loaded from [[FS2_Data_Structure#command_briefings|command_briefings]] subfolder.
**Mission briefing explanation speeches. They are loaded from [[FS2_Data_Structure#briefing|briefing]] subfolder.
**Mission debriefing speeches. They are loaded from [[FS2_Data_Structure#debriefing|debriefing]] subfolder.
**Mission scripted speech. The voice files are loaded from [[FS2_Data_Structure#special|special]] subfolder.
**Random speech generated by flying mates or enemies. The voice files are loaded from [[FS2_Data_Structure#personas|personas]] subfolder.
**A "training" category- identical to [[FS2_Data_Structure#special|special]], but used by Volition to organize training messages.
*'''Supported files:''' All the speech kinds support these formats:
**Retail: PCM [[%2A.WAV]] sound clips up to 16bit - 22kHz - 2 channels.
**SCP fs2_open adds support for compressed [[%2A.OGG]] Vorbis sound clips.

====briefing====
*'''Contents:''' Mission briefing explanation speeches. They are set through FRED editor in each [[%2A.FS2]] mission file.

====command_briefings====
*'''Contents:''' General command briefing speeches you can see before some missions. As example, the first mission usually have command brienfing. They are set through FRED editor. They are attached to the next mission file.

====debriefing====
*'''Contents:''' Mission debriefing explanation speeches. They are set through FRED editor in each [[%2A.FS2]] mission file.

====personas====
*'''Contents:''' Random speech generated by flying ships or your command, for example to warn the player about "Bandit on your tail" or to praise him with "Good shoot!!" . This feature is used through [[Messages.tbl]] table.

====special====
*'''Contents:''' Scripted speech files in every mission. This speech is set through FRED SEXPs (mainly ''send-message-list'').

====training====
*'''Contents:''' Identical to '''special''', but used by Volition for training messages.

==Loading order==
Although each kind of game data has its right folder, they are really looked for in some related folders. As an example, the game looks for ship textures in [[FS2_Data_Structure#maps|maps]] folder but also in [[FS2_Data_Structure#effects|effects]] folder. Also if you have one effect and one ship texture with the same name you are going to have trouble.

Just for reference and troubleshooting, here you have the loading order and searched extensions of each subfolder. '''But always try to put every file in its right place'''. (You may see strange locations for some files, please don't use them).

/ (mve, avi, mpg, ogg, vp)
/data (cfg, log, txt)
/data/maps (pcx, ani, jpg, tga, eff, png, dds)
/data/text (txt, net)
/data/missions (fs2, fc2, ntl, ssv)
/data/models (pof)
/data/tables (tbl, tbm)
/data/sounds (wav, ogg)
/data/sounds/8b22k (wav, ogg)
/data/sounds/16b11k (wav, ogg)
/data/voice ()
/data/voice/briefing (wav, ogg)
/data/voice/command_briefings (wav, ogg)
/data/voice/debriefing (wav, ogg)
/data/voice/personas (wav, ogg)
/data/voice/special (wav, ogg)
/data/voice/training (wav, ogg)
/data/music (wav, ogg)
/data/movies (mve, msb, avi, mpg, ogg)
/data/interface (pcx, ani, jpg, tga, eff, png, dds)
/data/fonts (vf)
/data/effects (neb, pcx, ani, jpg, tga, eff, png, dds)
/data/hud (pcx, ani, tga, png, dds)
/data/players (plr, csg)
/data/players/images (pcx, png, dds)
/data/cache (clr, tmp, ibx)
/data/players (hcf)
/data/players/single (pl2, cs2, plr, csg, css)
/data/players/multi (plr)
/data/multidata (pcx, png, dds, fs2)
/data/config (cfg)
/data/players/squads (pcx, png, dds)
/data/demos (fsd)
/data/cbanims (ani, eff, png, dds)
/data/intelanims (ani, eff, png, dds)
/data/scripts (lua, lc)

[[Category:Modding]]

FS2 Data Structure

2017-02-16T13:56:26Z

The E: The cache is no longer in use.

Although some expert hand has been through the page, where the (original) writer has doubts is marked in blue colour.

==Introduction==
::Through all this page, SCP fs2_open and FRED2_open additions over retail behaviour will be marked in red font.

Apart from the game engine or the mission editor, FRED, the game needs data to run; it needs missions, sounds, 3D models, textures... FreeSpace 2 is highly moddable because nearly none of these data are embedded inside the game executable. In this way the user can always change nearly all game behaviour and appearance.

Like all your applications you'll have FreeSpace 2 installed in one folder in your hard disk drive. We will call this folder '''/freespace2''', although it can have any other name (''/fs2'', ''/fspace2'', or whatever). Inside this folder, FreeSpace 2 stores all its game data in three places (retail version just in two):
#Unpacked, ie. individual files, inside '''data''' folder within FreeSpace 2 installation folder, ie. in '''/freespace2/data'''. ('''data''' name is compulsory). Inside '''data''' folder, the game contents are classified and stored in several subfolders. [[FS2_Data_Structure#data_subfolders|Below]], you have the full list of '''data''' subfolders with their description and contents, (remember that all their names are compulsory). The most commonly used and changed are:
#*[[FS2_Data_Structure#effects|effects]] contains all the textures and animations used in all explosions, weapon glows, smoke, particles and so on.
#*[[FS2_Data_Structure#maps|maps]] contains all the textures, (and animated textures), used over ship models.
#*[[FS2_Data_Structure#missions|missions]] contains all the mission ([[%2A.FS2]]) and campaign ([[%2A.FC2]]) definition files.
#*[[FS2_Data_Structure#models|models]] contains all 3D models ([[%2A.POF]]).
#*[[FS2_Data_Structure#music|music]] contains all the music files.
#*[[FS2_Data_Structure#sounds|sounds]] contains all ingame sound effect files.
#*[[FS2_Data_Structure#tables|tables]] contains all table files. Tables define all the behaviour the game components have. They are the most important thing for modders to know. See [[Tables]] section for deeper info.
#*[[FS2_Data_Structure#voice|voice]] contains all the ingame voices.
#Packed in vp archives. This kind of archives just contain individual files in a similar way as "normal" archives like rar or zip do. They are placed in '''/freespace2''' folder. Special software, like [[VPMage]], is needed to build them. Another really good utility is [[Maja|WMCoolmon's Maja]] which comes in a Java cross-platform executable. You can grab it from [http://wmc.freespacemods.net/repository/ WMC::Repository]. If you just want to browse or extract files from existing vps, but not editing or building them, then use [[VPView]]. You've got two versions of it in [http://www.descent-network.com/descman Descent Network download page] vp archives also follow the data structure, so, even while packed in a vp archive, your missions will be in /data/missions and your ship 3D models in /data/models. All retail data come packed in several vps. The next, and only the next, are the original game contents (when patched to v1.2):
#*root_fs2.vp (6,255 KB - 157 files - checksum of 0xce10d76c): Mainly [[FS2_Data_Structure#tables|tables]] and [[FS2_Data_Structure#missions|missions]]. (Number of files and checksum as reported in fs2_open.log when running a fs2_open ''debug'' build. Please notice that vp can actually contain more files than the reported number, but these are the pure game data files. As example root_fs2.vp contains 160 files with three useless ''vssver.scc'' in tables, images and squads).
#*smarty_fs2.vp (120,241 KB - 10 files - checksum of 0xddeb3b1e): [[FS2_Data_Structure#intelanims|Intelligence animations]].
#*sparky_fs2.vp (254,457 KB - 3027 files - checksum of 0x164fe65a): Most of the game data, mainly [[FS2_Data_Structure#models|models]], [[FS2_Data_Structure#maps|maps]], [[FS2_Data_Structure#effects|effects]], [[FS2_Data_Structure#hud|hud]], [[FS2_Data_Structure#interface|interface]] and [[FS2_Data_Structure#sounds|sounds]] data.
#*sparky_hi_fs2.vp (259,026 KB - 1337 files - checksum of 0xa11d56f1): Extra [[FS2_Data_Structure#hud|hud]] and [[FS2_Data_Structure#interface|interface]] data for hi res (1024x768).
#*stu_fs2.vp (169,108 KB - 2355 files - checksum of 0xd77da83a): [[FS2_Data_Structure#voice|Voice]] data.
#*tango1_fs2.vp (191,297 KB - 32 files - checksum of 0x4c25221e): 1st pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*tango2_fs2.vp (71,073 KB - 15 files - checksum of 0x86920b82): 2nd pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*tango3_fs2.vp (49,314 KB - 10 files - checksum of 0x705e8d71): 3rd pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*warble_fs2.vp (116,073 KB - 52 files - checksum of 0xd85c305d): [[FS2_Data_Structure#music|Music]] data.
#*[[%2A.MVE]] movies (cutscenes). They are not originally installed in the user hard disk drive. They are read from game CDs.
#'''One of the most important SCP fs2_open additions:''' Auxiliary data folders loaded through [[Command-Line_Reference#-mod|-MOD launcher flag]]. Retail game only use former both places. But fs2_open, (and FRED2_open), can use any other auxiliary folder in /freespace2 as game data holder. This feature allows installing and using several different mods without having undesired cross-effects.

The most important consequence of having several available locations for game data, is that several versions of each file can exist. '''There's a priority order between different locations''' as explained in [[Command-Line_Reference#-mod|-MOD launcher flag help]]. Due to this order, '''only the highest priority version of each file will be used'''. This feature allows the user to quickly replace existing ''mission.fs2'' or ''ShipModel.pof'' by new or improved versions, placing them in a higher priority place. There's no need to remove obsolete files.

The use of [[Command-Line_Reference#-mod|-MOD launcher flag]] implies that there will be two or more /data folder structures. Some game data, mainly model cache files ([[Model files#IBX|*.IBX]]), can be regenerated by the game itself. Unless explicitly specified, these autogenerated files will be placed in the ''highest'' priority /data folder structure.

==data subfolders==

===cache===
*'''Contents:''' Model cache files. In versions of FS2Open prior to 3.7.4, model files were processed to extract the actual render geometry. In 3.7.4, that processing step was optimized so that performing this extraction at runtime was just as fast as reading cache files off of the disk; as a consequence, it was decided to remove the cache file reading and writing code.

*'''Notes:'''
**This folder and its contents are obsolete as of FS2Open Release 3.7.4.

===cbanims===
*'''Contents:''' Command and mission briefing animations. (They are assigned to missions through FRED2 editor).
*'''Supported files:''' [[%2A.ANI]] animations.

===config===
*'''Contents''': Used by the SCP Builds. Contains (usually by reference) additional data as loaded by Scripts.
*'''Supported files''': [[%2A.CFG]] files.
{{table38|[[%2A.TBL]], [[%2A.TBM]], [[%2A.XML]] and [[%2A.CSV]] files.}}

===demos===
*'''Contents:''' This is probably where recordable demos would have been saved. If you look in the source code, there are functions in place to record events and play the recordings back at a later time. This code is does not (and in all likely hood will never) work.
*'''Supported files:''' [[%2A.FSD]] (FreeSpace Demo) files.

===effects===
*'''Contents:''' Bitmaps and animations for every game effect:
**All the explosions and weapon effects.
**Damage smoke animation.
**Particle animations.
**Thruster glows and afterburner trails.
**All the background images, sun bitmaps, sun glares and space motion debris (see [[Stars.tbl]] table).
**Warp-in / warp-out animations.
**Anything more you can think of in this category. If you have a texture which you know it doesn't belong to [[FS2_Data_Structure#maps|maps folder]], put it here. If you have doubts, put it here too.
**Since 3.6.10. version (including previously released nightly builds): GLSL shaders. See [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]]
*'''Supported files:'''
**Retail: [[%2A.PCX]] for bitmaps, (example, backgrounds) and [[%2A.ANI]] for animations (example: explosions).
**SCP fs2_open: Both formats and: [[%2A.JPG]], [[%2A.TGA]], [[%2A.PNG]], [[%2A.DDS]], for images, and [[.EFF]] for animations.
**Since 3.6.10. version (including previously released nightly builds): [[%2A.SDR]] shader files. See [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]]
**[[%2A.NEB]] files ?????? 
*'''Notes:'''
**Some effect bitmaps or animations can be assigned by table entries. But the name of many others is hardcoded, (example particlesmoke01).
**Not all the effects support animations. Example background bitmaps.
**[[%2A.PNG]] or [[%2A.DDS]] as/and [[%2A.EFF]] are the preferred formats.
**See [[Texturing]] section for important info about this aspect of the game. It is more important for [[FS2_Data_Structure#maps|maps folder]] contents, (ie. ship textures), but it also applies here.

===fonts===
*'''Contents:''' ???????
*'''Supported files:''' [[%2A.VF]] files.

===force feedback===
*'''Contents:''' ???????
*'''Supported files:''' ???????

===freddocs===
*'''Contents:''' This is where the help files for FRED are stored. Since the help files are viewed in a web browser, they were not able to be stored in the VP files.
*'''Supported files:''' *.html, *.gif, *.jpg, *.png.

===hud===
*'''Contents:''' All HUD building bricks. Anything you see on your HUD while flying is defined through this folder contents.
*'''Supported files:'''
**Retail: [[%2A.PCX]] and [[%2A.ANI]].
**SCP fs2_open: The former ones and [[%2A.TGA]], [[%2A.PNG]] and [[%2A.DDS]] formats.
*'''Notes:'''
**Most of this folder contents have a hardcoded name.
**Most of this folder contents are "false" animations. It means that the [[%2A.ANI]] file is only used to pack several related images. Example: every ship shield graphic uses five images, (the ship bitmap and then, front, right, back and left shield quadrants) packed in one [[%2A.ANI]].

===intelanims===
*'''Contents:''' Intelligence animations used in ''Technical Database'' > ''Intelligence'' section. They are used through [[Species.tbl]] table.
*'''Supported files:''' [[%2A.ANI]] animations and [[%2A.EFF]].

===interface===
*'''Contents:'''
**All the game screens and optional mission loading screens.
**All the button, mouse and icon bitmaps.
**Map ship icons in ''Briefing'' screen.
**Ship and weapon animations in ''Ship selection'' and ''Weapon loadout'' screens. These weapon animations are also used in ''Technical Database'' > ''Weapons'' section.
*'''Supported files:'''
**Retail: [[%2A.ANI]] animations and [[%2A.PCX]] bitmaps.
**SCP fs2_open: The former ones and [[%2A.TGA]], [[%2A.PNG]], [[%2A.DDS]] and [[%2A.EFF]] formats.
*'''Notes:'''
**Most people use [[Command-Line_Reference#-ship_choice_3d|-ship_choice_3d]] and [[Command-Line_Reference#-weapon_choice_3d|-weapon_choice_3d]] command-line flags. With these flags, only primary weapon animations are needed for the ''Weapon loadout'' screen. There's no need for ship or secondary weapon animations. Moreover, some mods need a compulsory use of these flags because they have no available animations for their ships or missiles.

===maps===
*'''Contents:''' All the textures used by 3D [[%2A.POF]] models. [[%2A.POF]] models use textures to "paint" their surfaces and to simulate glow points. [[%2A.POF]] files only have links to the names of their used textures, they don't have embedded textures. All their used textures are read from this folder.
*'''Supported files:'''
**Retail: [[%2A.PCX]] bitmaps.
**SCP fs2_open: The former and: [[%2A.JPG]], [[%2A.TGA]], [[%2A.PNG]], [[%2A.DDS]] formats. Some of the textures, (example: glow maps), support animated textures so [[%2A.EFF]] and [[%2A.ANI]] are also supported.
*'''Notes:'''
**See [[Texturing]] section for important info about this aspect of the game.
**[[%2A.DDS]] and [[%2A.EFF]] are the preferred formats.

===missions===
*'''Contents:''' All the mission and campaign files.
*'''Supported files:''' Each mission is one [[%2A.FS2]] file and each campaign is one [[%2A.FC2]] file.
**[[%2A.NTL]] and [[%2A.SSV]] files ????? 
*'''Notes:'''
**In ''Mission Simulator'' screen, ''Single Missions'' are just available [[%2A.FS2]] mission files which are not pointed by any of the available [[%2A.FC2]] campaign files. This is the only way to play this kind of missions.

===models===
*'''Contents:''' All the 3D models used by ships, asteroid and debris fields, missiles, subspace model, 3D shockwaves, 3D warp-in/warp-out effects and background star-holding model.
*'''Supported files:''' [[%2A.POF]] model files.
*'''Notes:'''
**[[%2A.POF]] models have direct relation with [[FS2_Data_Structure#maps|maps]] and [[FS2_Data_Structure#cache|cache]] folder contents.
**3D warp-in/warp-out effects need the usage of [[Command-Line_Reference#-3dwarp|-3dwarp launcher flag]].

===movies===
*'''Contents:''' Game cutscenes.
*'''Supported files:''' [[%2A.MVE]], [[%2A.OGG]], [[%2A.AVI]] and [[%2A.MPG]] clip files.

*'''Notes:'''
**This folder is a fully SCP addition. Retail game reads [[%2A.MVE]] cutscenes from game CDs.
**[[%2A.AVI]] and [[%2A.MPG]] formats are decoded through system player. Their support is [[Deprecation|deprecated]] and therefore not guaranteed in future fs2_open versions.
**Retail uncompressed [[%2A.MVE]] and Theora compressed [[%2A.OGG]] formats are the preferred ones. fs2_open has built-in support for them both.
**All the movies can have custom names, (their loading trigger is defined in FRED), but start-up movie. This movie must be called '''Intro'''.

===multidata===
*'''Contents:''' ???????
*'''Supported files:''' [[%2A.PCX]], [[%2A.DDS]], [[%2A.PNG]] and [[%2A.FS2]] files.

===music===
*'''Contents:''' Music files used through [[Music.tbl]] table.
*'''Supported files:'''
**Retail: PCM [[%2A.WAV]] sound clips up to 16bit - 22kHz - 2 channels.
**SCP fs2_open adds support for compressed [[%2A.OGG]] Vorbis sound clips.

===players===
*'''Contents:''' All game player data.
**It has 4 subfolders, each one has a deeper explanation below:
***[[FS2_Data_Structure#images|images]]: Selectable appearances of the player in ''Barracks'' screen.
***[[FS2_Data_Structure#multi|multi]]: Game data of multiplayer pilots
***[[FS2_Data_Structure#single|single]]: Game data of single player pilots
***[[FS2_Data_Structure#squads|squads]]: Selectable squad insignias of the player in ''Barracks'' screen.
**The main '''players''' folder just contains HUD appearance presets, ([[%2A.HCF]] files), which can be loaded, edited and saved in ''Options'' screen > ''HUD Config'' screen. From this screen they can be also applied to player's HUD settings.
*'''Supported files:''' [[%2A.HCF]] HUD configuration files.
*'''Notes:'''
**Only '''/freespace2/data/players''' main folder '''is used''' despite the [[Command-Line_Reference#-mod|-MOD launcher flag]] settings. Only [[FS2_Data_Structure#images|images]] and [[FS2_Data_Structure#squads|squads]] subfolders are read from any other locations (vp archives or other /mod/data/players folders).
**Of course, [[%2A.HCF]] files can be generated by the game itself, and are the settings for the HUD Options screen.

====images====
*'''Contents:''' Selectable appearances of the player in ''Barracks'' screen, ie. the player's photograph.
*'''Supported files:''' [[%2A.PCX]] images
**'''SCP fs2_open''': [[%2A.PNG]] and [[%2A.DDS]] files.

====multi====
*'''Contents:''' Game data of multiplayer pilots.
*'''Supported files:''' [[%2A.PLR]] files.
*'''Notes:'''
**Only '''/freespace2/data/players/multi''' folder '''is used''' despite the [[Command-Line_Reference#-mod|-MOD launcher flag]] settings.
**Of course, multi player data is generated and updated by the game itself.

====single====
*'''Contents:''' Game data of single player pilots.
*'''Supported files:'''
**Each pilot consists of several files:
***One [[%2A.PL2]] file, (let's call it ''MyPilot.pl2''), which contains main pilot data.
***Several [[%2A.CS2]] files. Each of these files is generated for each played campaign. They have the form ''MyPilot.Campaign name.cs2''.
***FSO: [[%2A.PLR]], [[%2A.CSG]] and [[%2A.CSS]] files.
*'''Notes:'''
**Only '''/freespace2/data/players/single''' folder '''is used''' despite the [[Command-Line_Reference#-mod|-MOD launcher flag]] settings.
**Of course, single player data is generated and updated by the game itself.
**Do not use pilot names longer than 32 characters. The game has problems with them, ie. use short pilot names.

====squads====
*'''Contents:''' Selectable squadron insignias of the player in ''Barracks'' screen.
*'''Supported files:'''
**Retail: [[%2A.PCX]] bitmaps.
**fs2_open: The above format and: [[%2A.PNG]], [[%2A.DDS]] images can be also used. But in order to maintain backwards and multiplayer compatibility, a [[%2A.PCX]] copy of the same insignia '''MUST''' be available. More info can be found in [http://scp.indiegames.us/mantis/view.php?id=1834 Mantis report 1834].

===scripts===
*'''Contents:''' This has something to do with LUA scripting SCP addition, but I know NOTHING about it. Please some expert fill it.
*'''Supported files:''' [[%2A.LUA]] and [[%2A.LC]] files. ???????.

===sounds===
*'''Contents:''' All the game sound effects. [[FS2_Data_Structure#music|Music tracks]] or [[FS2_Data_Structure#voices|ingame speech]] which have their own subfolders.
**It has two folders, [[FS2_Data_Structure#8b22k|8b22k]] and [[FS2_Data_Structure#16b11k|16b11k]] to classify the sounds depending on their quality. But using them is not needed, all the sounds can go in the main folder.
*'''Supported files:'''
**Retail: PCM [[%2A.WAV]] sound clips up to 16bit - 22kHz - 2 channels.
**SCP fs2_open adds support for compressed [[%2A.OGG]] Vorbis sound clips.
*'''Notes:'''
**In game sounds are used through [[Sounds.tbl]] table.
**Normally, game sounds only have one channel. Depending on the sound source location, the game will generate different right and left channel volumes.

====8b22k====
*'''Contents:''' Low quality sounds, but just use the main [[FS2_Data_Structure#sounds|sounds]] folder.

====16b11k====
*'''Contents:''' High quality sounds, but just use the main [[FS2_Data_Structure#sounds|sounds]] folder.

===tables===
*'''Contents:''' Data tables which set the whole game behaviour.
*'''Supported files:'''
**Retail: [[%2A.TBL]] tables.
**One of the most important SCP fs2_open additions: [[%2A.TBM]] [[Modular_Tables|modular table]] files.
*'''Notes:'''
**Tables are just the most important thing for modders to know.
**There is a lot of useful info about them in [[Tables]] section of the Wiki.

===text===
*'''Contents:''' ???????
*'''Supported files:''' [[%2A.TXT]] and [[%2A.NET]] files.

===voice===
*'''Contents:''' In game speech. This speech is separated in six different types. Each of them is located in its own subfolder inside voice folder.
**Campaign command briefing speeches. They are loaded from [[FS2_Data_Structure#command_briefings|command_briefings]] subfolder.
**Mission briefing explanation speeches. They are loaded from [[FS2_Data_Structure#briefing|briefing]] subfolder.
**Mission debriefing speeches. They are loaded from [[FS2_Data_Structure#debriefing|debriefing]] subfolder.
**Mission scripted speech. The voice files are loaded from [[FS2_Data_Structure#special|special]] subfolder.
**Random speech generated by flying mates or enemies. The voice files are loaded from [[FS2_Data_Structure#personas|personas]] subfolder.
**A "training" category- identical to [[FS2_Data_Structure#special|special]], but used by Volition to organize training messages.
*'''Supported files:''' All the speech kinds support these formats:
**Retail: PCM [[%2A.WAV]] sound clips up to 16bit - 22kHz - 2 channels.
**SCP fs2_open adds support for compressed [[%2A.OGG]] Vorbis sound clips.

====briefing====
*'''Contents:''' Mission briefing explanation speeches. They are set through FRED editor in each [[%2A.FS2]] mission file.

====command_briefings====
*'''Contents:''' General command briefing speeches you can see before some missions. As example, the first mission usually have command brienfing. They are set through FRED editor. They are attached to the next mission file.

====debriefing====
*'''Contents:''' Mission debriefing explanation speeches. They are set through FRED editor in each [[%2A.FS2]] mission file.

====personas====
*'''Contents:''' Random speech generated by flying ships or your command, for example to warn the player about "Bandit on your tail" or to praise him with "Good shoot!!" . This feature is used through [[Messages.tbl]] table.

====special====
*'''Contents:''' Scripted speech files in every mission. This speech is set through FRED SEXPs (mainly ''send-message-list'').

====training====
*'''Contents:''' Identical to '''special''', but used by Volition for training messages.

==Loading order==
Although each kind of game data has its right folder, they are really looked for in some related folders. As an example, the game looks for ship textures in [[FS2_Data_Structure#maps|maps]] folder but also in [[FS2_Data_Structure#effects|effects]] folder. Also if you have one effect and one ship texture with the same name you are going to have trouble.

Just for reference and troubleshooting, here you have the loading order and searched extensions of each subfolder. '''But always try to put every file in its right place'''. (You may see strange locations for some files, please don't use them).

/ (mve, avi, mpg, ogg, vp)
/data (cfg, log, txt)
/data/maps (pcx, ani, jpg, tga, eff, png, dds)
/data/text (txt, net)
/data/missions (fs2, fc2, ntl, ssv)
/data/models (pof)
/data/tables (tbl, tbm)
/data/sounds (wav, ogg)
/data/sounds/8b22k (wav, ogg)
/data/sounds/16b11k (wav, ogg)
/data/voice ()
/data/voice/briefing (wav, ogg)
/data/voice/command_briefings (wav, ogg)
/data/voice/debriefing (wav, ogg)
/data/voice/personas (wav, ogg)
/data/voice/special (wav, ogg)
/data/voice/training (wav, ogg)
/data/music (wav, ogg)
/data/movies (mve, msb, avi, mpg, ogg)
/data/interface (pcx, ani, jpg, tga, eff, png, dds)
/data/fonts (vf)
/data/effects (neb, pcx, ani, jpg, tga, eff, png, dds)
/data/hud (pcx, ani, tga, png, dds)
/data/players (plr, csg)
/data/players/images (pcx, png, dds)
/data/cache (clr, tmp, ibx)
/data/players (hcf)
/data/players/single (pl2, cs2, plr, csg, css)
/data/players/multi (plr)
/data/multidata (pcx, png, dds, fs2)
/data/config (cfg)
/data/players/squads (pcx, png, dds)
/data/demos (fsd)
/data/cbanims (ani, eff, png, dds)
/data/intelanims (ani, eff, png, dds)
/data/scripts (lua, lc)

[[Category:Modding]]

Tstrings.tbl

2016-08-31T10:58:28Z

The E: It's a #end, not $end

{{TableVersion|10895}}

The '''tstrings.tbl''' is used for translations quite like the [[strings.tbl]] except that it is used for '''t'''able '''strings'''.

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

[[Tables|List of Tables]]

==General Info==
*Other files use the index values for finding translations located in the '''tstrings.tbl'''

==Format==
*Table consists of one or more sections, each beginning with a number sign followed by the name of the language (e.g., '''#German'''). The exception is the English section, which must begin with '''#default'''.
*Each section ends with '''#end'''
*Each section consists of many indexed text entries.

===Individual Lines===
*Each line starts with the number or index that it will be linked to from other tables.
*Each line also contains the full text to use for that index throughout FSO.
*There is a hard-coded limit of 4,500 strings per section. Do not reach or exceed this index number.
*Syntax: '''Integer''', '''String'''

==Sample==
*Part of retail FreeSpace 2 table
<pre>#default
0, "The main FreeSpace 2 campaign."

1, "Special Operations Command has selected you for a dangerous covert assignment. Will you accept?"

2, "Special Operations Command requests your participation in a high-risk rescue mission. Will you volunteer?"

3, "Act 3"

4, "Shivan Gauntlet"

5, "A gauntlet module in which you face waves of Shivan fighters and warships.
"

6, "Blah"
...
...
3413, "*Aeolus Duel"

3414, "*Deimos Duel"

3415, "*Close Quarters"

3416, "*Ganymede Redux"

3417, "*Team Chaos"

3418, "*Ganymede Showdown"

3419, "So where's the Iceni, Command? Let’s end this now."

3420, "Protect Tatenen"

#end</pre>

[[Category:Tables]]

Antipodes Commit Checklist

2016-01-26T09:08:14Z

The E: Updating this page a bit

This is a list of things to check before moving code from the Antipodes branch to Trunk, and who is in charge or capable of signing off on each item. We should have at least two members responsible for every task.

* Verify that building succeeds on the following platforms (Release Engineering):
** VS2010, VS2012 and VS2015 (done automatically by AppVeyor [https://ci.appveyor.com/project/z64555/fs2open-github-com])
** gcc 4.6.3 (Linux) and Apple LLVM 6 (MacOS) (done automatically by Travis CI [https://travis-ci.org/scp-fs2open/fs2open.github.com])
** Xcode 3.7.3 (chief1983, Echelon9)
** Xcode 4
* Verify builds run on the following, and interoperate properly with their respective launchers (HLP Bughunters):
** Windows XP (Zacam)
** Windows 7 (chief1983/Zacam)
** Windows 8.1
** Windows 10
** OS X 10.5 Intel ()
** OS X 10.6 (chief1983, Echelon9)
** Linux ()
* Verify standalone server functionality
* Verify on Windows that FRED runs, loads, check some dialogs, and saves

This is in addition to any other testing specific to the changes being made, that should already be done. This is mostly to catch common oversights when a coder is focusing on one platform and may neglect others in the process.

[[Category:Source Code Project]]

Messages.tbl

2015-11-21T15:37:08Z

The E: /* #Personas */

{{TableVersion|10943}}

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.

[[Tables|List of Tables]]

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

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

==#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) :
::'''Arrive Enemy'''
::'''Attack Target'''
::'''Beta Arrived'''
::'''Check 6'''
::'''Engage'''
::'''Gamma Arrived'''
::'''Help'''
::'''Praise'''
::'''Backup'''
::'''Ignore Target'''
::'''No'''
::'''Oops 1''' * (Only Command has code support in Retail)
::'''Permission''' *
::'''Stray''' *
::'''Depart'''
::'''yes'''
::'''Rearm on Way'''
::'''On way'''
::'''Rearm warping in'''
::'''No Target'''
::'''Docking Start''' *
::'''Repair Done'''
::'''Repair Aborted'''
::'''Traitor'''
::'''Rearm'''
::'''Disable Target'''
::'''Disarm Target'''
::'''Player Dead'''
::'''Death'''
::'''Support Killed'''
::'''All Clear''' *
::'''All Alone'''
::'''Repair'''
::'''Delta Arrived'''
::'''Epsilon Arrived'''
::'''Instructor Hit'''
::'''Instructor Attack'''
::'''Stray Warning'''
::'''Stray Warning Final'''
::'''AWACS at 75'''
::'''AWACS at 25'''
{{Table3611|
::'''Praise Self'''
::'''High Praise'''
::'''Primaries Low'''}} 

===$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 contrast to FREDded messages, the game does not attempt to use the file ''<string>''.ani in a persona message. Instead, it picks one of ''<string>''a.ani, ''<string>''b.ani and ''<string>''c.ani each time. So if you have defined ''+Avi Name: Head-Joe'', 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'''}} 

===$Append Suffix:===
{{Table372|
Optional. By default, built-in messages have a suffix added to them to choose from several variants of a persona (see +AVI name description). Setting to 'no' will allow the specified ani name to be unmodified when attempting to load it from the filesystem.
*Syntax: '''Boolean'''
*Default value: yes}} 

==#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', '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.}} 

==Sample==
This is a snippet of the retail FreeSpace 2 table, highlighting two major examples between a default (Terran) persona and a species (Vasudan) persona. Command, Support, and Large ship message examples are also included. Newer features have been added for extra clarification of their usage.
<pre>;; This is a list of moods that the game will use for builtin
;; messages. Any message without a mood is treated as General

#Moods

$Mood: Happy
$Mood: Angry
$Mood: Vengeful

#End

#Personas

$Persona: Wingman 1
$Type: wingman

$Persona: Wingman 6
$Type: wingman
+Vasudan

$Persona: Support Ship
$Type: support

$Persona: Support Ship Vasudan
$Type: support
+Vasudan

$Persona: Large Ship
$Type: large

$Persona: Large Ship Vasudan
$Type: large
+Vasudan

$Persona: Terran Command
$Type: Command

#Messages

;; ALL CLEAR ..................................................................................

$Name: All Clear
$Message: XSTR("Command, we have secured the area.", 2725)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_allclear.wav

$Name: All Clear
$Message: XSTR("All enemy forces negated.", 2730)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_allclear.wav

;; ARRIVAL (Enemy) ...................................................................

$Name: Arrive Enemy
$Message: XSTR("Bandits incoming!", 1079)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Reading hostile indicators.", 2734)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Incoming jump signature! Hostile configuration!", 2736)
+Persona: Terran Command
+Avi Name: Head-CM2
+Wave Name: TC_arrival.wav

;; ATTACK MY TARGET ...........................................................................

$Name: Attack Target
$Message: XSTR("Roger that, sir. Engaging your target.", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav

$Name: Attack Target
$Message: XSTR("Yes sir, I'll make the bastards pay for Capella!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav
$Mood: Vengeful
$Exclude Mood: ( "Happy" )

$Name: Attack Target
$Message: XSTR("Yes sir. I just love killing Shivans!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav
$Mood: Angry
$Exclude Mood: ( "Angry" "Vengeful" )

$Name: Attack Target
$Message: XSTR("Affirmative. We will destroy your target.", 2742)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_attack.wav

;; BACKUP ARRIVAL (previously named "REINFORCEMENTS") .........................................

$Name: Backup
$Message: XSTR("Reinforcements on station. Request status brief.", 2744)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_backup.wav

$Name: Backup
$Message: XSTR("We are here to assist. What is your status?", 2749)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_backup.wav

;; BETA WING ARRIVAL ..........................................................................

$Name: Beta Arrived
$Message: XSTR("Beta wing here. Standing by.", 2751)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_beta.wav

$Name: Beta Arrived
$Message: XSTR("Beta wing is on station.", 2756)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_beta.wav

;; CHECK YOUR SIX .............................................................................

$Name: Check 6
$Message: XSTR("Check your six!", 2758)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Check6.wav

$Name: Check 6
$Message: XSTR("Take evasive action, pilot!", 2763)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Check6.wav

;; DEATH (previously wingman scream)...................................................

$Name: Death
$Message: XSTR("Noooooooo!!!", 2765)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Death.wav

$Name: Death
$Message: XSTR("Avenge me!", 2770)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Death.wav

;; DELTA WING ARRIVAL .........................................................................

$Name: Delta Arrived
$Message: XSTR("This is Delta wing. What's your status?", 2772)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Delta.wav

$Name: Delta Arrived
$Message: XSTR("Delta wing is ready to assist, pilot.", 2777)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Delta.wav

;; DEPART (previously named "WARPOUT") ........................................................

$Name: Depart
$Message: XSTR("Yes, sir! I'm outta here!", 2779)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2784)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

$Name: Depart
$Message: XSTR("I copy. Engaging jump drive now.", 2786)
+Persona: Support Ship
+Avi Name: Head-TP3
+Wave Name: S_depart.wav

$Name: Depart
$Message: XSTR("Departing field of engagement.", 2787)
+Persona: Support Ship Vasudan
+Avi Name: Head-VP2
+Wave Name: VS_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2788)
+Persona: Large Ship Vasudan
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

;; DISABLE TARGET .............................................................................

$Name: Disable Target
$Message: XSTR("Roger that, sir. Disabling your target.", 2789)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disable.wav

$Name: Disable Target
$Message: XSTR("Affirmative. Disabling your target.", 2794)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disable.wav

;; DISARM TARGET ..............................................................................

$Name: Disarm Target
$Message: XSTR("Yes, sir! Targeting weapons now!", 2796)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disarm.wav

$Name: Disarm Target
$Message: XSTR("Acknowledged. Weapon subsystem targeted. ", 2801)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disarm.wav

#End

#Simulated Speech Overrides

$File Name: msg_1.wav
$File Name: msg_2.wav
$File Name: msg_3.wav
$File Name: msg_4.wav
$File Name: msg_5.wav
$File Name: msg_6.wav

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

Messages.tbl

2015-11-21T15:36:51Z

The E: Updating documentation here

{{TableVersion|10943}}

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.

[[Tables|List of Tables]]

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

FS2 Open, 3.7.3: {{{
===$Allow substitution of missing messages:===
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''' }}}

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

==#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) :
::'''Arrive Enemy'''
::'''Attack Target'''
::'''Beta Arrived'''
::'''Check 6'''
::'''Engage'''
::'''Gamma Arrived'''
::'''Help'''
::'''Praise'''
::'''Backup'''
::'''Ignore Target'''
::'''No'''
::'''Oops 1''' * (Only Command has code support in Retail)
::'''Permission''' *
::'''Stray''' *
::'''Depart'''
::'''yes'''
::'''Rearm on Way'''
::'''On way'''
::'''Rearm warping in'''
::'''No Target'''
::'''Docking Start''' *
::'''Repair Done'''
::'''Repair Aborted'''
::'''Traitor'''
::'''Rearm'''
::'''Disable Target'''
::'''Disarm Target'''
::'''Player Dead'''
::'''Death'''
::'''Support Killed'''
::'''All Clear''' *
::'''All Alone'''
::'''Repair'''
::'''Delta Arrived'''
::'''Epsilon Arrived'''
::'''Instructor Hit'''
::'''Instructor Attack'''
::'''Stray Warning'''
::'''Stray Warning Final'''
::'''AWACS at 75'''
::'''AWACS at 25'''
{{Table3611|
::'''Praise Self'''
::'''High Praise'''
::'''Primaries Low'''}} 

===$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 contrast to FREDded messages, the game does not attempt to use the file ''<string>''.ani in a persona message. Instead, it picks one of ''<string>''a.ani, ''<string>''b.ani and ''<string>''c.ani each time. So if you have defined ''+Avi Name: Head-Joe'', 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'''}} 

===$Append Suffix:===
{{Table372|
Optional. By default, built-in messages have a suffix added to them to choose from several variants of a persona (see +AVI name description). Setting to 'no' will allow the specified ani name to be unmodified when attempting to load it from the filesystem.
*Syntax: '''Boolean'''
*Default value: yes}} 

==#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', '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.}} 

==Sample==
This is a snippet of the retail FreeSpace 2 table, highlighting two major examples between a default (Terran) persona and a species (Vasudan) persona. Command, Support, and Large ship message examples are also included. Newer features have been added for extra clarification of their usage.
<pre>;; This is a list of moods that the game will use for builtin
;; messages. Any message without a mood is treated as General

#Moods

$Mood: Happy
$Mood: Angry
$Mood: Vengeful

#End

#Personas

$Persona: Wingman 1
$Type: wingman

$Persona: Wingman 6
$Type: wingman
+Vasudan

$Persona: Support Ship
$Type: support

$Persona: Support Ship Vasudan
$Type: support
+Vasudan

$Persona: Large Ship
$Type: large

$Persona: Large Ship Vasudan
$Type: large
+Vasudan

$Persona: Terran Command
$Type: Command

#Messages

;; ALL CLEAR ..................................................................................

$Name: All Clear
$Message: XSTR("Command, we have secured the area.", 2725)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_allclear.wav

$Name: All Clear
$Message: XSTR("All enemy forces negated.", 2730)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_allclear.wav

;; ARRIVAL (Enemy) ...................................................................

$Name: Arrive Enemy
$Message: XSTR("Bandits incoming!", 1079)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Reading hostile indicators.", 2734)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_arrival.wav

$Name: Arrive Enemy
$Message: XSTR("Incoming jump signature! Hostile configuration!", 2736)
+Persona: Terran Command
+Avi Name: Head-CM2
+Wave Name: TC_arrival.wav

;; ATTACK MY TARGET ...........................................................................

$Name: Attack Target
$Message: XSTR("Roger that, sir. Engaging your target.", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav

$Name: Attack Target
$Message: XSTR("Yes sir, I'll make the bastards pay for Capella!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav
$Mood: Vengeful
$Exclude Mood: ( "Happy" )

$Name: Attack Target
$Message: XSTR("Yes sir. I just love killing Shivans!", 2737)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_attack.wav
$Mood: Angry
$Exclude Mood: ( "Angry" "Vengeful" )

$Name: Attack Target
$Message: XSTR("Affirmative. We will destroy your target.", 2742)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_attack.wav

;; BACKUP ARRIVAL (previously named "REINFORCEMENTS") .........................................

$Name: Backup
$Message: XSTR("Reinforcements on station. Request status brief.", 2744)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_backup.wav

$Name: Backup
$Message: XSTR("We are here to assist. What is your status?", 2749)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_backup.wav

;; BETA WING ARRIVAL ..........................................................................

$Name: Beta Arrived
$Message: XSTR("Beta wing here. Standing by.", 2751)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_beta.wav

$Name: Beta Arrived
$Message: XSTR("Beta wing is on station.", 2756)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_beta.wav

;; CHECK YOUR SIX .............................................................................

$Name: Check 6
$Message: XSTR("Check your six!", 2758)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Check6.wav

$Name: Check 6
$Message: XSTR("Take evasive action, pilot!", 2763)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Check6.wav

;; DEATH (previously wingman scream)...................................................

$Name: Death
$Message: XSTR("Noooooooo!!!", 2765)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Death.wav

$Name: Death
$Message: XSTR("Avenge me!", 2770)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Death.wav

;; DELTA WING ARRIVAL .........................................................................

$Name: Delta Arrived
$Message: XSTR("This is Delta wing. What's your status?", 2772)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Delta.wav

$Name: Delta Arrived
$Message: XSTR("Delta wing is ready to assist, pilot.", 2777)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Delta.wav

;; DEPART (previously named "WARPOUT") ........................................................

$Name: Depart
$Message: XSTR("Yes, sir! I'm outta here!", 2779)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2784)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

$Name: Depart
$Message: XSTR("I copy. Engaging jump drive now.", 2786)
+Persona: Support Ship
+Avi Name: Head-TP3
+Wave Name: S_depart.wav

$Name: Depart
$Message: XSTR("Departing field of engagement.", 2787)
+Persona: Support Ship Vasudan
+Avi Name: Head-VP2
+Wave Name: VS_depart.wav

$Name: Depart
$Message: XSTR("We are departing as ordered.", 2788)
+Persona: Large Ship Vasudan
+Avi Name: Head-VP1
+Wave Name: 6_depart.wav

;; DISABLE TARGET .............................................................................

$Name: Disable Target
$Message: XSTR("Roger that, sir. Disabling your target.", 2789)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disable.wav

$Name: Disable Target
$Message: XSTR("Affirmative. Disabling your target.", 2794)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disable.wav

;; DISARM TARGET ..............................................................................

$Name: Disarm Target
$Message: XSTR("Yes, sir! Targeting weapons now!", 2796)
+Persona: Wingman 1
+Avi Name: Head-TP1
+Wave Name: 1_Disarm.wav

$Name: Disarm Target
$Message: XSTR("Acknowledged. Weapon subsystem targeted. ", 2801)
+Persona: Wingman 6
+Avi Name: Head-VP1
+Wave Name: 6_Disarm.wav

#End

#Simulated Speech Overrides

$File Name: msg_1.wav
$File Name: msg_2.wav
$File Name: msg_3.wav
$File Name: msg_4.wav
$File Name: msg_5.wav
$File Name: msg_6.wav

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

Messages.tbl

2015-11-21T15:34:28Z

The E: Updating documentation here

{{TableVersion|10943}}

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.

[[Tables|List of Tables]]

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

FS2 Open, 3.7.3: {{{
===$Allow substitution of missing messages:===
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''' }}}

==#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) :
::'''Arrive Enemy'''
::'''Attack Target'''
::'''Beta Arrived'''
::'''Check 6'''
::'''Engage'''
::'''Gamma Arrived'''
::'''Help'''
::'''Praise'''
::'''Backup'''
::'''Ignore Target'''
::'''No'''
::'''Oops 1''' * (Only Command has code support in Retail)
::'''Permission''' *
::'''Stray''' *
::'''Depart'''
::'''yes'''
::'''Rearm on Way'''
::'''On way'''
::'''Rearm warping in'''
::'''No Target'''
::'''Docking Start''' *
::'''Repair Done'''
::'''Repair Aborted'''
::'''Traitor'''
::'''Rearm'''
::'''Disable Target'''
::'''Disarm Target'''
::'''Player Dead'''
::'''Death'''
::'''Support Killed'''
::'''All Clear''' *
::'''All Alone'''
::'''Repair'''
::'''Delta Arrived'''
::'''Epsilon Arrived'''
::'''Instructor Hit'''
::'''Instructor Attack'''
::'''Stray Warning'''
::'''Stray Warning Final'''
::'''AWACS at 75'''
::'''AWACS at 25'''
{{Table3611|
::'''Praise Self'''
::'''High Praise'''
::'''Primaries Low'''}} 

===$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 contrast to FREDded messages, the game does not attempt to use the file ''<string>''.ani in a persona message. Instead, it picks one of ''<string>''a.ani, ''<string>''b.ani and ''<string>''c.ani each time. So if you have defined ''+Avi Name: Head-Joe'', 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'''}} 

===$Append Suffix:===
{{Table372|
Optional. By default, built-in messages have a suffix added to them to choose from several variants of a persona (see +AVI name description). Setting to 'no' will allow the specified ani name to be unmodified when attempting to load it from the filesystem.
*Syntax: '''Boolean'''
*Default value: yes}} 

==#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', '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.}} 

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

User talk:General Battuta

2015-11-10T17:48:43Z

The E:

Do you ''really'' think the FSWiki is a good place to try and start a stupid meme? [[User:The E|The E]] 09:33, 2 September 2010 (UTC)
::With all due respect, Battuta, please stop re-adding that line into the [[GTC Aeolus]] article. It serves no purpose. The past 9 edits on that page are solely between you re-adding that line for whatever reason and me removing it primarily because it is redundant. Seriously, please ''stop''. -- [[User:Androgeos Exeunt|Androgeos]] [[User_talk:Androgeos_Exeunt|Exeunt]] 15:54, 9 November 2015 (UTC)
::Honestly, Androgeos, a bit of levity is not wrong. This is not superserious wiki, this is goofy little Hard Light wiki. [[User:The E|The E]]

==bored?==

www.rhizzone.net/forum/3/

Game settings.tbl

2014-06-26T16:28:16Z

The E: Adds the new Fred Settings heading in game_settings.tbl

{{SCP_table}}

{{TableVersion|10824}}

The '''game_settings.tbl''', also known as mod.tbl, defines options that can be changed globally.

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

[[Tables|List of Tables]]

==#CAMPAIGN SETTINGS==
Optional. This group contains various Campaign related settings and overrides. 

===$Default Campaign File Name:===
Defines which campaign will be selected by default for new pilots. A file extension is not needed and, if present, is removed by the code.
*Syntax: '''''String''''' 

==#Ignored Campaign File Names==
Optional. Defines which campaigns, if present, will not appear in the Campaign Room. Only single-player campaigns can be ignored. ''File extensions are required.''
{{Table371|As of 3.7.1, file extensions are not required and, if present, are removed by the code.}}

===$Campaign File Name:===
File name of the campaign to ignore. Multiple entries may exist.
*Syntax: '''''String''''' 

==#HUD SETTINGS==
Optional. This group contains various HUD behavior settings and overrides 

===$Directive Wait Time:===
*Defines how long the game will wait before displaying a directive.
*Syntax: '''''Integer''''' 
*Values: '''''Greater than or equal to 0 ms'''''

===$Cutscene camera displays HUD:===
Show the HUD when the cutscene camera is enabled.
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Cutscene camera disables HUD: and had a default of YES.

===$Full color head animations:===
Enables full-color head ANIs. Normal head ANIs will appear in gray.
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Color head animations with hud colors: and had a default of YES.

==#SEXP SETTINGS==
Optional. This group contains SEXP settings and overrides. 

===$Loop SEXPs Then Arguments:===
Flips how when-argument settings loop. See: [http://www.hard-light.net/forums/index.php?topic=79602.0 SEXP Argument changes via mod.tbl]
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

===$Use Alternate Chaining Behavior:===
When set, this makes the event chaining behavior act as people expected it to be in [http://scp.indiegames.us/mantis/view.php?id=82 Mantis #82].
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

==#GRAPHICS SETTINGS==
Optional. This group contains settings related to graphics. 

===$Enable External Shaders:===
Enables the use of external shader files. By default, the engine will use the built-in shaders.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default Detail Level:===
{{Table3615|
Determines which graphics detail level preset (low, medium, high, very high) acts as the default for new pilots.
*Syntax: '''''Integer''''' (0-3)
*Default Value: '''''3''''' (very high) }}

===$Briefing Window FOV:===
{{Table371|
Determines the FOV in the briefing Icon window. Retail default for this is 0.29375, previous versions of FSO used a value of 0.5.
*Syntax: '''''Float''''' (0.0 to 1.0)
*Default Value: '''''0.29375''''' }}

==#SOUND SETTINGS==
Optional. This group contains sound-related settings 

===$Default Sound Volume:===
{{Table371|
*Defines the default sound fx volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0 
*Default Value: '''''1.0'''''}}

===$Default Music Volume:===
{{Table371|
*Defines the default music volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0 
*Default Value: '''''0.5'''''}}

===$Default Voice Volume:===
{{Table371|
*Defines the default voice volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0 
*Default Value: '''''0.7'''''}}

==#FRED SETTINGS==
Optional. This group contains settings for FRED. 

===$Disable Hard Coded Message Head Ani Files:===
{{table371|
If set, FRED will not fill the head ani selection in the Event Editor with the retail head ani filenames.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' }}

==#OTHER SETTINGS==
Optional. This group contains miscellaneous settings. 

===$Fixed Turret Collisions:===
Makes all hits to a turret's barrels count as hits to the turret subsystem. By default, this does not happen unless the point of impact falls inside the model radius of the turret's base.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Damage Impacted Subsystem First:===
If set, a hit to a physical subsystem will always deal damage to that subsystem first, even if another subsystem is closer to the point of impact. By default, the closest subsystem will always receive damage first.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default ship select effect:===
{{Table3615|
*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 "FS2", "FS1", and "off"}}

===$Default weapon select effect:===
{{Table3615|
*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 "FS2", "FS1", and "off"}}

===$Weapons inherit parent collision group:===
{{Table3615|
*When set to true, Weapons fired by a ship will inherit their parents' collision group setting. Default is false.}}

===$Flight controls follow eyepoint orientation:===
{{Table371|
*Specifies that if the player ship's eyepoint happens to rotate into a non-standard orientation, pitch and yaw axes should stay relative to the eyepoint orientation, not the ship. Note that this does not affect the pitch/yaw turning speed, which always remains relative to the ship. Default is false.}}

==#END==
Required. The last line of the table must be #END

==Sample Entry==

#CAMPAIGN SETTINGS
$Default Campaign File Name: NewCampaignFile

#Ignored Campaign File Names
$Campaign File Name: FreeSpace2.fc2

#HUD SETTINGS
$Directive Wait Time: 5000

#SEXP SETTINGS
$Loop SEXPs Then Arguments: True

#OTHER SETTINGS
$Self Praise Percentage: 75

#END

[[Category:Tables]]

Game settings.tbl

2014-06-17T12:31:19Z

The E: Adding the Briefing Window FOV setting

{{SCP_table}}

{{TableVersion|9771}}

The '''game_settings.tbl''', also known as mod.tbl, defines options that can be changed globally.

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

[[Tables|List of Tables]]

==#CAMPAIGN SETTINGS==
Optional. This group contains various Campaign related settings and overrides. 

===$Default Campaign File Name:===
Defines which campaign will be selected by default for new pilots. A file extension is not needed and, if present, is removed by the code.
*Syntax: '''''String''''' 

==#Ignored Campaign File Names==
Optional. Defines which campaigns, if present, will not appear in the Campaign Room. Only single-player campaigns can be ignored. ''File extensions are required.''
{{Table371|As of 3.7.1, file extensions are not required and, if present, are removed by the code.}}

===$Campaign File Name:===
File name of the campaign to ignore. Multiple entries may exist.
*Syntax: '''''String''''' 

==#HUD SETTINGS==
Optional. This group contains various HUD behavior settings and overrides 

===$Directive Wait Time:===
*Defines how long the game will wait before displaying a directive.
*Syntax: '''''Integer''''' 
*Values: '''''Greater than or equal to 0 ms'''''

===$Cutscene camera displays HUD:===
Show the HUD when the cutscene camera is enabled.
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Cutscene camera disables HUD: and had a default of YES.

===$Full color head animations:===
Enables full-color head ANIs. Normal head ANIs will appear in gray.
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

In earlier versions of the code, this option was controlled by $Color head animations with hud colors: and had a default of YES.

==#SEXP SETTINGS==
Optional. This group contains SEXP settings and overrides. 

===$Loop SEXPs Then Arguments:===
Flips how when-argument settings loop. See: [http://www.hard-light.net/forums/index.php?topic=79602.0 SEXP Argument changes via mod.tbl]
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

===$Use Alternate Chaining Behavior:===
When set, this makes the event chaining behavior act as people expected it to be in [http://scp.indiegames.us/mantis/view.php?id=82 Mantis #82].
*Syntax: '''''Boolean''''' 
*Default Value: '''''NO'''''

==#GRAPHICS SETTINGS==
Optional. This group contains settings related to graphics. 

===$Enable External Shaders:===
Enables the use of external shader files. By default, the engine will use the built-in shaders.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default Detail Level:===
{{Table3615|
Determines which graphics detail level preset (low, medium, high, very high) acts as the default for new pilots.
*Syntax: '''''Integer''''' (0-3)
*Default Value: '''''3''''' (very high) }}

===$Briefing Window FOV:===
{{Table371|
Determines the FOV in the briefing Icon window. Retail default for this is 0.29375, previous versions of FSO used a value of 0.5.
*Syntax: '''''Float''''' (0.0 to 1.0)
*Default Value: '''''0.29375''''' }}

==#SOUND SETTINGS==
Optional. This group contains sound-related settings 

===$Default Sound Volume:===
{{Table371|
*Defines the default sound fx volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0 
*Default Value: '''''1.0'''''}}

===$Default Music Volume:===
{{Table371|
*Defines the default music volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0 
*Default Value: '''''0.5'''''}}

===$Default Voice Volume:===
{{Table371|
*Defines the default voice volume for new pilots.
*Syntax: '''''Float''''', between 0.0 and 1.0 
*Default Value: '''''0.7'''''}}

==#OTHER SETTINGS==
Optional. This group contains miscellaneous settings. 

===$Fixed Turret Collisions:===
Makes all hits to a turret's barrels count as hits to the turret subsystem. By default, this does not happen unless the point of impact falls inside the model radius of the turret's base.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Damage Impacted Subsystem First:===
If set, a hit to a physical subsystem will always deal damage to that subsystem first, even if another subsystem is closer to the point of impact. By default, the closest subsystem will always receive damage first.
*Syntax: '''''Boolean'''''
*Default Value: '''''NO''''' 

===$Default ship select effect:===
{{Table3615|
*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 "FS2", "FS1", and "off"}}

===$Default weapon select effect:===
{{Table3615|
*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 "FS2", "FS1", and "off"}}

===$Weapons inherit parent collision group:===
{{Table3615|
*When set to true, Weapons fired by a ship will inherit their parents' collision group setting. Default is false.}}

===$Flight controls follow eyepoint orientation:===
{{Table371|
*Specifies that if the player ship's eyepoint happens to rotate into a non-standard orientation, pitch and yaw axes should stay relative to the eyepoint orientation, not the ship. Note that this does not affect the pitch/yaw turning speed, which always remains relative to the ship. Default is false.}}

==#END==
Required. The last line of the table must be #END

==Sample Entry==

#CAMPAIGN SETTINGS
$Default Campaign File Name: NewCampaignFile

#Ignored Campaign File Names
$Campaign File Name: FreeSpace2.fc2

#HUD SETTINGS
$Directive Wait Time: 5000

#SEXP SETTINGS
$Loop SEXPs Then Arguments: True

#OTHER SETTINGS
$Self Praise Percentage: 75

#END

[[Category:Tables]]

SC Raguel

2014-05-25T12:42:30Z

The E: Reverting additions by Bryan See: Incomplete models and WIPs with no release date have no place on the wiki

{{Inferno_Ships}}

[[Image:Scraguel.jpg|thumb|right|480px|SC Raguel.]]
[[Image:SCRaguel.png|thumb|right|550px|The Raguel from the 2011 model dump.]]

The '''SC ''Raguel''''' is a Shivan cruiser seen in [[INFR1]]. It is comparable to the EA's [[EAC Eclipse|Eclipse]] cruiser, in being heavily armed but slow.

==Description:==

===Inferno R1 Description===
The Raguel is extremely well-armed for a cruiser. With several medium, small and AAA beam cannons, it is preferred that a capital ship destroy this heavy vessel from as great a distance as possible. It exceeds the performance of our cruisers, although lacking in speed somewhat.

===Inferno: Alliance Standalone Description===

N/A

===Inferno SCP Description===

N/A

===Developer Notes===
None

===Name origin===

N/A

===Credits List===
*2011 dump model by '''Woomeister'''

==Performance:==
===Statistics===
{{Ship Stats|Cruiser|Shivan|N/A|20.0|N/A|N/A|40000|N/A|N/A|350}}

===Armaments===

*'''[[Technical_Terms_and_Definitions#Turrets|Turrets]]'''
{| border=1 cellpadding=4 style="border-collapse: collapse"
|- align="center"
| colspan=2 style="background:#351515;"| '''Inferno R1'''
| colspan=2 style="background:#300505;"| '''INFA SA'''
| colspan=2 style="background:#300505;"| '''INF SCP'''
|- align="center"
| style="width:120px" |Turret Type
| style="width:60px" |Amount
| style="width:120px" |Turret Type
| style="width:60px" |Amount
| style="width:120px" |Turret Type
| style="width:60px" |Amount
|- align="center"
| [[Shivan Mega Laser]]
| 3
|
|
|
|
|- align="center"
| [[Shivan Turret Laser]]
| 3
|
|
|
|
|- align="center"
| [[SAAA]]
| 6
|
|
|
|
|- align="center"
| MRed
| 1
|
|
|
|
|- align="center"
| [[SRed]]
| 6
|
|
|
|
|}

==Veteran Comments==
{{comment|The version from the 2011 model dump comes with no tables, is 350.2m long and has 18 turrets.}}

==Related Links:==
*[[Inferno Release 1|Inferno: Release 1]]:
**'''[http://www.freespacemods.net/download.php?view.95 Download | FreeSpaceMods.net]'''
*2011 Model Dump
**[http://www.hard-light.net/forums/index.php?topic=79199.msg1567447#msg1567447 Release thread | Hard-light forums]

[[Category:Inferno Ships]]
[[Category:User-made Ships]]

Talk:FreeSpace: Reunited

2014-01-16T12:10:38Z

The E: /* Regarding the "New Direction" section */ new section

==Reason for the Mod==
FSR is a mod that a personal friend of mine and I came up with since we like to compare stats, specs, weapons, ect. between the FreeSpace Universe and the Battlestar Galactica Universe. We did this for several months (YES, WE HAVE A LIFE!) and after doing this for so long, we thought, "Hey! Why don't we try to make a mod out of this?" We brainstormed what games would allow us to do that and the first game that came to mind was FreeSpace 2. Since then, we've been...working on and off, but we will get this done AND we may also release a CDF version of the mod shortly after. Either way, we feel this mod will be a mod worth adding into the next build of the FS Open Installer! -- [[User:NFSRacer|NFSRacer]], callsign "Cypher"

You do realize that this would be a one-sided slaughter of the Cylons by the GTVA, right? The GTVA uses nuclear weapons as air-air missiles and has bombs hundreds of times more powerful than anything the Cylons have. Crossovers in general tend not to work, and this is a particularly ill-advised one. - [[User:Woolie Wool|Woolie Wool]] 01:24, 22 December 2009 (UTC)

Actually, no it's not. My friend that I mentioned has followed the series very, VERY closely. In fact, the BSG Series is one of the two series where he is a almost like a living encyclopedia of the series. With this in mind, he has told me about different aspects about the series that almost mach the FS Universe, or can be bridged in the mod, like the point you gave about the GTVA destroying the Cylons. One fact you failed to take into concideration with the Cylons is their ships' "healing" ability. In addition to that (...and to even the odds a little...), we plan on bring back the radiation shielding that my friend mentioned was used in the First Cylon War. This shielding was described as something along the lines of a second skin to the ship (Remind you of another ship in the FS Universe?). Also, certin weeknesses that either series has are more or less exploited in the mod. For FreeSpace ships, it's the range and firepower of their beam weapons and missiles; for BSG, it's the shear number of their ships and their flak weapons (which means that, yes, several missions may end up being BoE-style missions; I'm trying to work around that, though). These weeknesses should make the mod more interesting, with the help of my friend's knowledge of CDF and Cylon battle tactics, that is. -- [[User:NFSRacer|NFSRacer]], callsign "Cypher"

I've just redesigned the page to reflect my current version that I'm developing right now, based on the ships from ''[[Diaspora]]''. It turns out that both Colonials and Cylons alike destroy any GTVA vessels (or those from the Shivans) in a matter of seconds, and any fighter was outrunned by those Raiders. I intend this to be set 150,446 years after the Fall of the Twelve Colonies of Kobol (setting in the same ''[[Blue Planet]]'' continuity in any way possible, and provide answers to the questions [http://en.battlestarwiki.org/wiki/Daybreak,_Part_II#Questions raised in the BSG series finale "Daybreak, Parts II and III"], revolving around a young pilot who shares the same destiny as Kara "Starbuck" Thrace. -- '''''[[User:Bryan See|Bryan]] [[User talk:Bryan See|See]]''''' 03:37, 6 September 2013 (UTC)

== Regarding the "New Direction" section ==

You say "The E and General Battuta wanted a 5-mission demo". This is not true. We ''recommended'' that ''you'' do a demo; you were and are completely free not to do this. I would recommend rewording it to something like "A demo campaign is currently under construction to show where this is going" or something like that. [[User:The E|The E]] 12:10, 16 January 2014 (UTC)

User talk:Bryan See

2013-09-22T13:49:16Z

The E: Created page with "===Your edits regarding FS:U=== It's great that you've got plans for this mod, but until you're actually ready to post more information to the various ship pages, I would ask th…"

===Your edits regarding FS:U===

It's great that you've got plans for this mod, but until you're actually ready to post more information to the various ship pages, I would ask that you stop putting placeholders with no information everywhere. If you want to have a list of assets you're going to use, use the page for your mod. [[User:The E|The E]] 13:49, 22 September 2013 (UTC)

Command-Line Reference

2013-09-21T08:06:59Z

The E: Adds the -profile_frame_time cmdline parameter introduced in rev 9806

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===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

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

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

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

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

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

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

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

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

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

Will ideally reduce the load-time from one mission to another.

===HUD===
====-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===
====-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. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-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. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-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===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

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

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

===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====
This feature is not available in current builds.

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

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

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

====-safeloading====
Loads missions the old way. Typically safer, but slower.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

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

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

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

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

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

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

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

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

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

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

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

===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===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

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

Displays current position coordinates of camera.

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

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

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

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

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

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This does not mean that your card has this much memory, and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

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

====-nograb====
Unix only. Disables focus grabbing in a window.

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

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

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

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

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

====-profile_frame_time====
'''"Profile engine subsystems"'''

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.

==Other==
The following options are not available as checkboxes in the launcher. 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.

====-ambient_factor====
This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-spec_exp====
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. However, 11 is recommended. This is a relative value.

====-spec_point====
This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0. However, 0.6 is recommended. This is a relative value.

====-spec_static====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, is 0.8 recommended. This is a relative value.

====-spec_tube====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, 0.4 is recommended. This is a relative value.

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

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

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").
{{Table3615|
*This feature is on by default. To manually disable, enter the flag -noheight}}

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

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

===Gameplay===
====-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, 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 width 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

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

===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====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-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]]

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

Command-Line Reference

2013-07-13T10:07:57Z

The E: Changing fxaa preset values to what is actually supported

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===
====-spec====
'''"Enable Specular"'''

Only polygons mapped with textures for which a shinemap exists will receive specular mapping; no attempt is made to generate spec maps where they do not exist. Specular maps are specified with the base map name plus "-shine" (i.e. TCov3A-shine.pcx).
{{Table3615|
*This feature is on by default, use launcher option Disable Specular or if necessary to manually disable enter the flag -nospec}}

====-env====
'''"Enable Environment maps"'''

It only works if [[Command-Line_Reference#-spec|-spec]] is also set. Environment mapping intensity will be determined from the shine map too (see [[Texturing]] for more info). [[Installing FreeSpace 2 Open#Video setup|See Video setup.]]
{{Table3615|
*This feature is on by default, use launcher option Disable Environment Maps or if necessary to manually disable enter the flag -noenv }}

====-glow====
'''"Enable Glowmaps"'''

Only polygons mapped with textures for which a glowmap exists will be glowmapped. Glow maps are specified with the base map name plus "-glow" (i.e. TCov4A-glow.pcx)
{{Table3615|
*This feature is on by default, use launcher option Disable Glow Maps or if necessary to manually disable enter the flag -noglow }}

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

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

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

Disables fullscreen scaling of video clips.

====-missile_lighting====
'''"Apply Lighting to Missiles"'''

====-normal====
'''"Enable Normal Maps"'''

Normal maps require GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary normal maps (the same name of the base map plus "-normal"). DXT5_NM DDS format is needed. (Technical note: DXT5 will work, since only the GREEN and ALPHA channels are read by the current shader system. One direction of lines goes into the GREEN channel, the other direction goes into the ALPHA channel. RED and BLUE can be either base gray (#808080) or black. Usual practice is after creating the DXT5_NM, copy the RED channel to the ALPHA channel, black out the RED and BLUE an then save as either a DXT5 or u8888 (uncompressed) DDS file.)
{{Table3615|
*This feature is on by default, use launcher option Disable Normal Maps or if necessary to manually disable enter the flag -nonormal }}

====-post_process====
'''"Enable Post Processing"'''

enables the use (if present) of post-processing effects as defined by the post_process.tbl. Bloom usage has an additional cmdline option for setting it's value, most post processing effects are achieved in mission per the mission designer or can be enabled globally in the table.

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

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

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

Enables the FXAA postprocessing stage. Further information can be found here: http://www.hard-light.net/forums/index.php?topic=76145.0

====-flightshaftsoff====
'''"Force Lightshafts off"'''

Disables Lightshafts even if a mission designer enables them via SEXP in a mission.

===Game Speed===
====-img2dds====
'''"Compress non-compressed images"'''

Converts all images to DDS (compressed) format. Decreases memory usage but potentially reduces image quality.

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

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

Will ideally reduce the load-time from one mission to another.

===HUD===
====-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===
====-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. 
Some mods need a compulsory use of this flag because they don't have available animations for their ships. In this situation, and if it is not used, the game will probably crash to desktop in the ship selection window.

====-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. 
Some mods need a compulsory use of this flag because they don't have available animations for their secondary weapons. In this situation, and if it is not used, the game will probably crash to desktop in the weapon loadout window.

====-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===
====-snd_preload====
'''"Preload mission game sounds"'''

Useful in preventing game stuttering when sounds are played for the first time.

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

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

===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====
This feature is not available in current builds.

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

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

===Troubleshooting===
====-nohtl====
'''"Software Mode (very slow)"'''
{{Warning| Enabling this will significantly reduce performance.}}
Reverts to software rendering mode.

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

====-safeloading====
Loads missions the old way. Typically safer, but slower.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

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

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

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

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

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

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

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

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

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

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

===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===
====-fps====
'''"Show frames per second on HUD"'''

Displays current frames per second.

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

Displays current position coordinates of camera.

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

====-timerbar====
Displays a timing bar across the top of the screen. Timerbar format varies by build. This is a relic from the Volition development days, and is unmaintained.
*'''Note:''' the parameter was removed as of the July 5, 2011 nightly build.

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

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

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

Shows coordinates of the mouse cursor.

====-show_mem_usage====
'''"Show Memory Usage"'''

Shows detailed RAM usage based on file, handler and process usage and display on the left-center side of the screen during mission load and while in mission.

The meaning of the info displayed in the upper right corner of the HUD is:

'''DYN''' = dynamic memory, basically anything that's been allocated by the vm_* memory functions. This does NOT indicate total memory usage but does account for most of it.

'''POF''' = model memory, how much memory is being used by models (does not include textures)

'''C-BMP, BMP''' = bmpman memory, how much is used by the textures/images that are loaded. C-BMP means that you are using -cache_bitmaps and it will try to keep textures in memory between level loads and as the new level is loading it will keep what it needs and unload what it doesn't. Can greatly increase level loading speed, but does so at the cost of memory between level loads. This does not increase overall memory usage though, only during the loading screen. BMP means that it is not cached and all textures are unloaded from memory at the start of level load and all needed textures are then loaded from the disk again.

'''S-RAM''' = sound memory, how much is used by the sounds loaded in memory at the time. This counts static sounds only (from sounds.tbl, etc.) and not streaming sounds (music, voices, briefing stuff, etc).

'''V-RAM''' = approximate memory usage of video textures. This does not mean that your card has this much memory, and can report higher numbers that your card actually has memory. For OpenGL it also includes some of the geometry data, but this number does not reflect the total memory that your video card is using. It only reports how much data the game has purposefully loaded into API memory (meaning it could be in system memory, video card memory, or AGP memory).

''(It only works with debug builds, not with release builds).''

====-pofspew====
Reads all objects in the pof file of the selected mod, and creates an ibx cache file for each object in the data/cache folder for that mod. 
Details for each object are output to a pofspew.txt file created in the data folder. 
Otherwise, ibx files are created in game before each mission.

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

====-nograb====
Unix only. Disables focus grabbing in a window.

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

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

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

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

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

==Other==
The following options are not available as checkboxes in the launcher. 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.

====-ambient_factor====
This must be entered into the "Custom flags" field. This is a multiplier applied to the intensity of ambient lighting. Ambient light is lighting applied to all parts of a ship. FS2's standard value is 120. Try 75 for a good and realistic looking value. However, that is relative.

====-no_emissive_light====
By default, all ships in FS2 have a light generated on their own, it is more or less similar to a minimal amount of -ambient_factor. This feature was implemented to help the player seeing the ships over a black background. This flag disables this feature. Use it with a low -ambient_factor value to obtain an ultra-realistic dark looking.

====-spec_exp====
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. However, 11 is recommended. This is a relative value.

====-spec_point====
This must be used with the -spec command line parameter and must be entered into the
"Custom flags" field. Adjusts how much laser weapons contribute to specular highlights. Higher number mean greater contributions. Default is 1.0. However, 0.6 is recommended. This is a relative value.

====-spec_static====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much suns contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, is 0.8 recommended. This is a relative value.

====-spec_tube====
This must be used with the -spec command line parameter and must be entered into the "Custom flags" field. Adjusts how much Beam Weapons contribute to specular highlights. Higher numbers mean a greater contribution. Default is 1.0. However, 0.4 is recommended. This is a relative value.

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

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

====-height====
Enables height maps (parallax mapping). It only works if [[Command-Line_Reference#-normal|-normal]] is also set. It also needs GLSL rendering, (see [[OpenGL_Shaders_(GLSL)|OpenGL Shaders (GLSL)]] for further info). It needs auxiliary height maps (with the same name than base map plus "-height").

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

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

===Gameplay===
====-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, 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 width 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

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

===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====
{{Sectstub}}
====-timeout====
{{Sectstub}}
====-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]]

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