Ships.tbl

Ships.tbl reference has was made following the older guide (originally written by GE) by

• Wanderer
• WMCoolmon
• Contribute and include yourself here

General Format

• Ship.tbl is formed of several different sections:
  • #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.
  • #Engine Wash Info
    • Includes all the definitions of all engine washes used in the game.
  • #Ship Classes
    • Includes entries for every ship and also defines their attributes that are used in the game
    • Is discussed in detail at 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 Table Options.

Engine Wash

• Defines the engines washes
• First entry must be named 'default'

$Name:

• Defines the name of the engine wash.
• Syntax: Name

$Angle:

• Defines the angle from the engine where the engine wash exists
• Syntax: Value', (degrees)

$Radius Mult:

• Defines something???
• Syntax: Value, (multiplier)

$Length:

• Defines the lenght of the engine wash
• Syntax: Value, (meters)

$Intensity:

• Defines the strenght of the engine wash
• Syntax: Value, (blast effect)

Example

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

Table Options

• Retail options will look like this

• SCP options are marked with red color
  • Most of the entries in ships.tbl are optional (does anyone have the default values?)

$Name:

• Model name that is used also in game. It is also used as name for the whole ship entry.
• Syntax: name,
  • Example: Ulysses

$Short name:

• Shortened model name, for FRED, Usually more descriptive than the real name.
• Syntax: name,
  • Example: TFight

$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. More species have been enabled, and all of these are defined in species_defs.tbl.
• Syntax: Terran, Shivan or Vasudan
• Syntax: Name of the species, as defined in species_defs.tbl
  • Example: Terran

Technical description

List of discriptive terms for techroom and ship selection screens. Number after the quotes refers to tstrings.tbl (does this have any function?)

  +Type:                     XSTR("", -1)
  +Maneuverability:          XSTR("", -1)
  +Armor:                    XSTR("", -1)
  +Manufacturer:             XSTR("", -1)
  +Description:              XSTR("", -1)
  $end_multi_text
  +Tech Description:         XSTR("", -1)
  $end_multi_text
  +Length:                   20 m
  +Gun Mounts:               4
  +Missile Banks:            1

$POF file:

• filename of the model file (.pof) at data/models folder
• Syntax: Filename.pof
  • Example: fighter01.pof

$Detail distance:

• Definies the distance where the change between different Levels-Of-Details (LODs) occurs
• Syntax: (Value, Value, ...) (distances from the model in meters)
  • Example: (0, 80, 300, 900)

$ND:

• No Dim field field was used in FS1 for ship lights. Nowadays we use glowmaps.
• Syntax: Value, Value, Value (Red, Green, Blue respectively, value from 0 to 255)
  • Example: 42, 42, 224

$Show damage:

• No known function. Best left alone to avoid possible compatibility issues.
• Syntax: YES or NO, usually YES

$Density:

• ????
• Syntax: Value, usually 1

$Damp:

• Damp affects how quickly you will accel/decel to your target velocity. Higher damp means slow acceleration and deceleration. The lower this number, the faster the ship responds. For example, specifying a value of 0.0 means there is no damping, in other words, people would say, "this has no physics, like Wing Commander." The more damping, the harder to control, but the more smoothly it moves.
• Syntax: Value

$Rotdamp:

• Same thing, but for rotational movement.
• Syntax: Value

$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.
• Syntax: Value, Value, Value, (meters per second) x-axis, y-axis, z-axis
  • Example: 0.0, 0.0, 80.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
• Syntax: Value, Value, Value, (seconds per 360 degree turn) x-axis, y-axis, z-axis
  • Example: 3.0, 2.6, 5.0

$Rear Velocity:

• Defines rear velocity
• Syntax: Value, (meters per second) usually zero

$Forward accel:

• Number of seconds needed from full stop to maximum velocity
• Syntax: Value, (seconds)

$Forward decel:

• Number of seconds needed from maxumum velocity to full stop
• Syntax: Value, (seconds)

$Slide accel: and $Slide decel:

• Same for sliding as the $Forward accel: and $Forward decel: for normal movement.
• Syntax: Value, (seconds) for both

$Glide:

• Allows gliding in game
• Syntax: YES or NO

$Warpin speed:

• Sets the speed at which the ship warps in
• Syntax: Value

$Warpout speed:

• Sets the speed at which the ship warps out from the game
• Syntax: Value

$Player warpout speed:

• Sets the speed at which the player warps out from the game
• Syntax: Value, can not be greater than $Max Oclk Speed:

$Expl inner rad:

• Radius at which the full explosion damage is done
• Syntax: Value, (meters)

$Expl outer rad:

• Maximum radius at which any damage is done
• Syntax: Value, (meters)

$Expl damage:

• Amount of damage done inside the inner radius
• Syntax: Value, (damage value)

$Expl blast:

• The intensity of the blast effect when you're within the outer radius
• Syntax: Value, (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: YES or NO

$Shockwave Speed:

• Speed shockwave expands at, 0 means no shockwave
• Syntax: Value, (meters per second)

Primary Weapons

$Allowed PBanks:

• List of allowed primary weapons in brackets (weapon name marked with quotes). Each of the primary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
• Syntax: ( "Name" "Name" )
• Syntax: ( "Name" "Name" ) ( "Name" "Name" )
  • Example: ( "Subach HL-7" "Prometheus R")

$Allowed Dogfight PBanks:

• Primary weapons for multiplayer dogfights. Each of the primary weapon banks can be given their own list of allowed weapons, in which case each bank has it's own bracketed entry.
• Syntax: ( "Name" "Name" )
• Syntax: ( "Name" "Name" ) ( "Name" "Name" )
  • Example: ( "Subach HL-D" "Prometheus D")

$Default PBanks:

• Defines default primary weapons for each of the primary weapon banks
• Syntax: ( "Name" "Name" )
  • Example: ( "Subach HL-7" "Prometheus R")

$PBank Capacity:

• Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas. REQUIRES FLAG "ballistic primaries"
• Syntax: ( Value, Value ), usually all primary bank capacities are 1.
  • Example: ( 1, 1 )

Secondary Weapons

$Allowed SBanks:

• Same for secondary weapons. 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: ( "Name" "Name" )
• Syntax: ( "Name" "Name" ) ( "Name" "Name" )
  • Example: ( "Harpoon" "Hornet")

$Allowed Dogfight SBanks:

• Same for secondary weapons. 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: ( "Name" "Name" )
• Syntax: ( "Name" "Name" ) ( "Name" "Name" )
  • Example: ( "Harpoon D" "Hornet D")

$Default SBanks:

• Defines default primary weapons for each of the primary weapon banks
• Syntax: ( "Name" "Name" )
  • Example: ( "Harpoon" "Hornet")

$SBank Capacity:

• Defines ammunition capacity of secondary weapon banks. In brackets, different weapon banks separated by commas.
• Syntax: ( Value, Value ), (ammo capacity)
  • Example: ( 40, 40 )

$Shields:

• Determines the shield strenght
• Syntax: Value, (total hitpoints in all quadrants together)

$Shield Color:

• RGB value for shield color
• Syntax: "Value, Value, Value (Red, Green, Blue respectively, value from 0 to 255)
  • Example: 100, 100, 255

$Power Output:

• The amount of energy available. The higher the output, the faster your weapons recharge.
• Syntax: Value

$Max Oclk Speed:

• Maximum velocity with all energy diverted to engines
• Syntax: Value, (meters per second)

$Max Weapon Eng:

• The maximum amount of energy you can store in your primary weapons bank.
• Syntax: Value

$Hitpoints:

• How much damage the ship can take
• Syntax: Value, (hitpoints)

$Hull Repair Rate:

• Repair rates for hull at percent per second (default 0.0)
• Syntax: Value, % of hitpoints repaired per second

$Subsystem Repair Rate:

• Repair rates for sybsystems percent per second (default 0.2)
• Syntax: Value, % of hitpoints repaired per second

$Armor Type

• Location: Right after the $Hitpoinrs:
• REQUIRES ADDITIONAL TABLE. Defines armor type used for the ship
• Syntax: Armor name, as defined in armor.tbl

$Flags:

• See below
• Syntax: ( "Flag" "Flag" )
  • Example: ( "fighter" "in tech database" )

$AI Class:

• Default AI class
• Syntax: AI name, as defined in AI.tbl

$Afterburner:

• Defines if the ships has afterburner
• Syntax: YES or NO
• +Aburn Max Vel:
  • In same format as in $Max Velocity:
  • Syntax: Value, (meters per second)
• +Aburn For accel:
  • Defined only as the forward acceleration. In same format as $Forward accel:
  • Syntax: Value, (seconds)
• +Aburn Fuel:
  • Amount of afterburner fuel the ship has
  • Syntax: Value (fuel units)
• +Aburn Burn Rate:
  • Rate the fuel is consumed when afterburner is engaged (in units per seconds)
  • Syntax: Value (fuel units per second)
• +Aburn Rec Rate:
  • Rate the fuel is restored.
  • Syntax: Value (fuel units per second)
• $Trails:
  • Allows afterburner trails to be used
  • +Bitmap:
    • Texture used to draw the afterburner trail
    • Syntax: Filename
  • +Width:
    • Width of afterburner trail at the beginning of it (ie. the thruster end)
    • Syntax: Value, (in meters)
  • +Alpha:
    • Transparancy of the trail, value from 1 (non-transparent) to 0 (totally transparent)
    • Syntax: Value
  • +Life:
    • How long the trail will last
    • Syntax: Value, (in seconds)

$Countermeasures:

• Number of countermeasures that can be loaded to the ship
• Syntax: Value

$Scan time:

• Time it takes to scan the ship
• Syntax: Value, (milliseconds)

$EngineSnd:

• Engine sound used for the ship with number referring to sounds.tbl
• Syntax: Value, identification number of the sound as defined in sounds.tbl

$Closeup_pos:

• How the model will show at techroom. The position of the camera relative to the model in the tech room and the target box view
• Syntax: Value, Value, Value, (X, Y and Z values)

$Closeup_zoom:

• How the model will show at techroom. How far the camera's zoomed in.
• Syntax: Value

$Shield_icon:

• This .ani file must be at data/hud and included to the hud.tbl. Reference to the hud.tbl is no longer needed.
• Syntax: Filename
  • Example: shield-f01

$Ship_icon:

• The icon used in ship selection
• Syntax: Filename
  • Example: iconfighter01

$Ship_anim:

• The glowing green grid animation used in ship selection
• Syntax: Filename
  • Example: ssfighter01

$Ship_overhead:

• The overhead view used in the weapons loadout
• Syntax: Filename
  • Example: loadfighter01

$Score:

• Points awarded for destroying the ship
• Syntax: Value, (points)

$Trail:

• These are the origins of the white contrails that appear in the nebula missions. Ship may have multiple trails.
• +Offset:
  • The position of the contrail's head
  • Syntax: Value, Value, Value, (X, Y, Z values) relative to the centerpoint of the model
• +Start Width:
  • The width of the contrail's head
  • Syntax: Value, (meters)
• +End Width:
  • The width of the contrail's tail
  • Syntax: Value, (meters)
• +Start Alpha:
  • The opacity of the contrail's head
  • Syntax: Value, value between 0 and 1
• +End Alpha:
  • The opacity of the contrail's tail
  • Syntax: Value, value between 0 and 1
• +Max Life:
  • How long the contrail remains
  • Syntax: Value, (seconds)
• +Spew Time:
  • ????
  • Syntax: Value, (seconds)
• +Bitmap:
  • The image to use for the contrail.
  • Syntax: Filename
    • Example: Contrail01

$Thruster Particles:

• Defines the alternative particle thruster
• $Thruster Particle Bitmap:
  • Name of the animation used for particle thrusters, up to three can be defined
  • Syntax: Filename, of ani file used
    • Example: Exp04
• $Min Radius:
  • Defines the minimum radius of new particles
  • Syntax: Value, (in meters)
• $Max Radius:
  • Defines the maximum radius of new particles
  • Syntax: Value, (in meters)
• $Min created:
  • Defines the minimum amount of particles created per second
  • Syntax: Value, (per second)
• $Max created:
  • Defines the maximum amount of particles created per second
  • Syntax: Value, (per second)
• $Variance:
  • Value that describes the randomnes or 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: Value, (per second)

$Thruster Particles:

• Defines the alternative particle afterburners (requires at least 1 particle thruster)
• $Afterburner Particle Bitmap:
  • Name of the animation used for particle thruster afterburners, up to three can be defined
  • Syntax: Filename, of ani file used
    • Example: Exp04
• $Min Radius:
  • Defines the minimum radius of new particles
  • Syntax: Value, (in meters)
• $Max Radius:
  • Defines the maximum radius of new particles
  • Syntax: Value, (in meters)
• $Min created:
  • Defines the minimum amount of particles created per second
  • Syntax: Value, (per second)
• $Max created:
  • Defines the maximum amount of particles created per second
  • Syntax: Value, (per second)
• $Variance:
  • Value that describes the randomnes or 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: Value, (per second)

$Subsystem:

• The name of the subsystem as defined in .pof file, % of ship's total hitpoints the subsystem has and rotation time (360 degrees) for multipart turrets. Note: Assinging zero to the %-hitpoint entry causes the subsystem to be without hitpoints, like fighterbays on some capital ships.
• Animation code can be applied to the subsystems that consist of submodels, like multipart turrets. (Link to proper refences of the animation code??)
• Syntax: Subsystem name , Value, (% of ships hitpoints) Value, (seconds per 360 degree turn) subsystem name must be the same as described in model file (.pof).
  • Example: communications, 5, 0.0

Turret

• In addition to the previous entry all turrets require information concerning the weapon mounted to the turret. The entry can be either $Default PBanks for turret primaries (including beams) or $Default SBanks for turret secondaries
• Syntax: ( "Name" )
  • Example: ( "Subach HL-7" )
  • Combined example for turret entry:

  $Subsystem: turret01, 1.0, 1.0
  $Default PBanks: ( "Terran Turret" )

Engine

• In addition to the previous entry all engines may use information concerning the engine wash. Engine washes are usually used only with larger vessels.
• Syntax: ( "Name" ), as defined in Engine Wash section
  • Example: ( "Default1000" )
  • Combined example for turret entry:

  $Subsystem: engine01, 5.0, 0.0
  $Engine Wash: ( "Default1000" )

Ships.tbl flags

"player_ship"

• Makes it possible to player to fly the ship

"default_player_ship"

• Makes this ship as a default part of the loadout options in FRED

"in tech database"

• Includes ships description to the tech database from the beginning of tha campaing

"repair_rearm"

• Defines the ship as repair and rearm vessel and sets AI behaviour accordingly.
• Only one such vessel can be defined per species.

"fighter"

• Defines ship as a fighter and also sets the AI behaviour

"bomber"

• Defines ship as a bomber and also sets the AI behaviour

"transport"

• Defines ship as a transport and also sets the AI behaviour

"freighter"

• Defines ship as a freighter and also sets the AI behaviour

"cruiser"

• Defines ship as a cruiser and also sets the AI behaviour

"corvette"

• Defines ship as a corvette and also sets the AI behaviour

"capital"

• Defines ship as a capitalship and also sets the AI behaviour

"supercap"

• Defines ship as a super capitalship and also sets the AI behaviour

"cargo"

• Defines ship as a cargo crate 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

"navbuoy"

• Defines ship as a navbuoy and also sets the AI behaviour

"sentrygun"

• Defines ship as a sentrygun and also sets the AI behaviour

"drydock"

• Defines ship as a drydock and also sets the AI behaviour

"escapepod"

• Defines ship as a escapepod and also sets the AI behaviour

"knossos"

• Defines ship as a Knossos and also sets the AI behaviour

"dont collide invisible"

• Defines...

"no_collide"

• Defines...

"big damage"

• Limits the damage mage to the ship by non-huge weapons.

"no_fred"

• Ship will not appear in FRED.

"Ballistic primaries"

• Enables the ship to use ballistic primaries

Player Ship Precedence

• Syntax: ( "Name" "Name")
• Example:

  $Player Ship Precedence: (
       "GTF Ulysses"
       "GTF Hercules"
       "GTB Medusa"
       "GTB Ursa"
  )

Sample

  #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"
        "GTF Hercules"
        "GTB Medusa"
        "GTB Ursa")