When a feature or function is deprecated, this means that future versions will not support it. Although it may work in current or older versions of the software, the relevant code will not be updated, and it will eventually be deleted outright. Projects that rely on deprecated features or functions should find another way to accomplish the same effect.

== Deprecated Features ==
*DirectX API. The game now uses OpenGL.
*AVI and MPG format support, both used through system player. Currently, the game has built-in support for original uncompressed MVE format clips and compressed Theora OGG ones.
*It is no longer possible to use FreeSpace 1-style nebulae in [[Portal:FRED|FRED2]]. Setting up a nebula that way will crash the mission editor.
*The ''-htl'' flag is no longer necessary ever since FreeSpace Open 3.6(?). In fact, now there's a ''[[Command-Line_Reference#-nohtl|-nohtl]]'' flag.
*The ''[[Command-Line_Reference#-jpgtga|-jpgtga]]'' flag is no longer necessary since FreeSpace Open 3.6.10. It's always on.
*The ''[[Command-Line_Reference#-pcx32|-pcx32]]'' flag is no longer present.
*The ''[[Command-Line_Reference#-alpha_env|-alpha_env]]'' flag is no longer necessary since FreeSpace Open 3.6.10. It's always on.
*The ''[[Command-Line_Reference#-2d_poof|-2d_poof]]'' flag is no longer necessary since FreeSpace Open 3.6.10. It's always on.
*Smart shield recharging (''[[Command-Line_Reference#-smart_shields|-smart_shields]]'' flag) has been converted into an Ai_profiles.tbl feature. It is no longer controlled through a command line flag.
*The ''[[Command-Line_Reference#-rlm|-rlm]]'' flag is no longer necessary. It's always on.

[[Category:Source Code Project]]

Deprecation

2009-03-06T21:11:04Z

ARSPR: -pcx32 and links

FS2 Data Structure

2009-03-06T17:25:44Z

ARSPR: comment about -weapon_choice_3d in interface

'''WARNING: THIS PAGE HAS BEEN WRITTEN WITHOUT EXPERT REVISION!!'''

Although some expert hand should revise all the page, where the writer HAS more 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: Mainly [[FS2_Data_Structure#tables|tables]] and [[FS2_Data_Structure#missions|missions]].
#*smarty_fs2.vp: [[FS2_Data_Structure#intelanims|Intelligence animations]].
#*sparky_fs2.vp: 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: Extra [[FS2_Data_Structure#hud|hud]] and [[FS2_Data_Structure#interface|interface]] data for hi res (1024x768).
#*stu_fs2.vp: [[FS2_Data_Structure#voice|Voice]] data.
#*tango1_fs2.vp: 1st pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*tango2_fs2.vp: 2nd pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*tango3_fs2.vp: 3rd pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*warble_fs2.vp: [[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. [[FS2_Data_Structure#models|models]] folder contains raw [[%2A.POF]] 3D model files. But the game has to ''"compile"'' them in order to use them. So each original ''AnyShip.pof'' generates one compiled and ready to use ''AnyShip.ibx'' file (and also one ''AnyShip.tsb'' in SCP fs2_open).
*'''Supported files:'''
**Retail: [[%2A.IBX]] model cache files.
**SCP fs2_open: The former ones and [[%2A.TSB]] files which contain associated normal map data, (since 3.6.10 version).
**[[%2A.CLR]] and [[%2A.TMP]] files ????
*'''Notes:'''
**The content of this folder can be autogenerated by FS2.
**Generating cache files takes a bit of time. If you release a pack or mod with a lot of new models, providing their cache files too is a good idea because, on the very first run afterwards, the game will seem hung while it is generating them.
**FS2 detects model upgrades so it rebuilds cache files if they don't match. BUT sometimes corrupted cache files can cause problems. So sometimes, while debugging or trying to solve problems, deleting cache contents can be useful. (See also [[Command-Line_Reference#-noibx|-noibx launcher flag help]]).

===cbanims===
*'''Contents:''' Command and mission briefing animations. (They are assigned to missions through FRED2 editor).
*'''Supported files:''' [[%2A.ANI]] animations.

===config===
*'''Contents:''' ???????
*'''Supported files:''' [[%2A.CFG]] 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 likelyhood 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.DDS]], [[%2A.JPG]] and [[%2A.TGA]] for bitmaps, and [[%2A.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.DDS]] and [[%2A.EFF]] are the preferred formats.
**Till version 3.6.9. (included), [[%2A.JPG]] and [[%2A.TGA]] formats require the usage of [[Command-Line_Reference#-jpgtga|-jpgtga launcher flag]]. If not used they will be ignored. From this version, all the supported formats are always used.
**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.DDS]] and [[%2A.TGA]] formats.Is jpg supported here? Are dds, jpg and tga fully supported for everything?
*'''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 bitmaps. Example: every ship shield graphic uses five bitmaps, (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.

===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.DDS]] and [[%2A.TGA]] formats.Is jpg supported here? Are dds, jpg and tga fully supported for everything?
*'''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. More over, some mods need a compulsory use of these flags because they have no available animations for their ships or missiles.
**As an exception, fs2_open doesn't require the usage of [[Command-Line_Reference#-jpgtga|-jpgtga launcher flag]] for intro splash screen. But the rest of [[%2A.TGA]] format usage needs it (until version 3.6.9.).

===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 one and [[%2A.DDS]], [[%2A.JPG]] and [[%2A.TGA]] 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.
**Till version 3.6.9. (included), [[%2A.JPG]] and [[%2A.TGA]] formats require the usage of [[Command-Line_Reference#-jpgtga|-jpgtga launcher flag]]. If not used they will be ignored. From this version, all the supported formats are always used.

===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.
**[[%2A.MSB]] 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]] 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.

====images====
*'''Contents:''' Selectable appearances of the player in ''Barracks'' screen, ie. the player's photograph.
*'''Supported files:''' [[%2A.PCX]] bitmaps.

====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''.
**[[%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 XXXXXX. 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: At least [[%2A.DDS]] bitmaps 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 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)
/data (cfg, log, txt)
/data/maps (pcx, ani, eff, tga, jpg, 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, tga, dds)
/data/fonts (vf)
/data/effects (ani, eff, pcx, neb, tga, jpg, dds)
/data/hud (ani, pcx, tga, dds)
/data/players ()
/data/players/images (pcx)
/data/cache (clr, tmp, ibx)
/data/players (hcf)
/data/players/single (pl2, cs2, plr, csg, css)
/data/players/multi (plr)
/data/multidata (pcx, fs2)
/data/config (cfg)
/data/players/squads (pcx)
/data/demos (fsd)
/data/cbanims (ani)
/data/intelanims (ani)
/data/scripts (lua, lc)


[[Category:Modding]]

Deprecation

2009-03-06T17:19:35Z

ARSPR: avi and MPG

When a feature or function is deprecated, this means that future versions will not support it. Although it may work in current or older versions of the software, the relevant code will not be updated, and it will eventually be deleted outright. Projects that rely on deprecated features or functions should find another way to accomplish the same effect.

== Deprecated Features ==
*DirectX API. The game now uses OpenGL.
*AVI & MPG clip format support, both used through system player. Currently, the game has built-in support for original uncompressed MVE format and compressed Theora OGG.
*It is no longer possible to use FreeSpace 1-style nebulae in [[Portal:FRED|FRED2]]. Setting up a nebula that way will crash the mission editor.
*The ''-htl'' flag is no longer necessary ever since FreeSpace Open 3.6(?).
*The ''-jpgtga'' command line parameter is no longer necessary since FreeSpace Open 3.6.10.
*The ''-alpha_env'' flag is always on.
*The ''-2d_poof'' flag is always on.
*Smart shield recharging (-smart_shield flag) has been converted into an Ai_profiles.tbl feature. It is no longer controlled through a command flag.

== Miscellaneous ==

[[Category:Source Code Project]]

FS2 Data Structure

2009-03-06T17:17:44Z

ARSPR: link to deprecation in movies

'''WARNING: THIS PAGE HAS BEEN WRITTEN WITHOUT EXPERT REVISION!!'''

Although some expert hand should revise all the page, where the writer HAS more 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: Mainly [[FS2_Data_Structure#tables|tables]] and [[FS2_Data_Structure#missions|missions]].
#*smarty_fs2.vp: [[FS2_Data_Structure#intelanims|Intelligence animations]].
#*sparky_fs2.vp: 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: Extra [[FS2_Data_Structure#hud|hud]] and [[FS2_Data_Structure#interface|interface]] data for hi res (1024x768).
#*stu_fs2.vp: [[FS2_Data_Structure#voice|Voice]] data.
#*tango1_fs2.vp: 1st pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*tango2_fs2.vp: 2nd pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*tango3_fs2.vp: 3rd pack of [[FS2_Data_Structure#cbanims|Command briefing animations]].
#*warble_fs2.vp: [[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. [[FS2_Data_Structure#models|models]] folder contains raw [[%2A.POF]] 3D model files. But the game has to ''"compile"'' them in order to use them. So each original ''AnyShip.pof'' generates one compiled and ready to use ''AnyShip.ibx'' file (and also one ''AnyShip.tsb'' in SCP fs2_open).
*'''Supported files:'''
**Retail: [[%2A.IBX]] model cache files.
**SCP fs2_open: The former ones and [[%2A.TSB]] files which contain associated normal map data, (since 3.6.10 version).
**[[%2A.CLR]] and [[%2A.TMP]] files ????
*'''Notes:'''
**The content of this folder can be autogenerated by FS2.
**Generating cache files takes a bit of time. If you release a pack or mod with a lot of new models, providing their cache files too is a good idea because, on the very first run afterwards, the game will seem hung while it is generating them.
**FS2 detects model upgrades so it rebuilds cache files if they don't match. BUT sometimes corrupted cache files can cause problems. So sometimes, while debugging or trying to solve problems, deleting cache contents can be useful. (See also [[Command-Line_Reference#-noibx|-noibx launcher flag help]]).

===cbanims===
*'''Contents:''' Command and mission briefing animations. (They are assigned to missions through FRED2 editor).
*'''Supported files:''' [[%2A.ANI]] animations.

===config===
*'''Contents:''' ???????
*'''Supported files:''' [[%2A.CFG]] 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 likelyhood 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.DDS]], [[%2A.JPG]] and [[%2A.TGA]] for bitmaps, and [[%2A.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.DDS]] and [[%2A.EFF]] are the preferred formats.
**Till version 3.6.9. (included), [[%2A.JPG]] and [[%2A.TGA]] formats require the usage of [[Command-Line_Reference#-jpgtga|-jpgtga launcher flag]]. If not used they will be ignored. From this version, all the supported formats are always used.
**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.DDS]] and [[%2A.TGA]] formats.Is jpg supported here? Are dds, jpg and tga fully supported for everything?
*'''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 bitmaps. Example: every ship shield graphic uses five bitmaps, (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.

===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.DDS]] and [[%2A.TGA]] formats.Is jpg supported here? Are dds, jpg and tga fully supported for everything?
*'''Notes:'''
**Most people use [[Command-Line_Reference#-ship_choice_3d|-ship_choice_3d launcher flag]]. With this flag, only primary weapon animations are needed in ''Weapon loadout'' screen. There's no need for ship or secondary weapon animations. Even, some mods need a compulsory use of this flag because they have no available animations for their ships or missiles.
**As an exception, fs2_open doesn't require the usage of [[Command-Line_Reference#-jpgtga|-jpgtga launcher flag]] for intro splash screen. But the rest of [[%2A.TGA]] format usage needs it (until version 3.6.9.).

===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 one and [[%2A.DDS]], [[%2A.JPG]] and [[%2A.TGA]] 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.
**Till version 3.6.9. (included), [[%2A.JPG]] and [[%2A.TGA]] formats require the usage of [[Command-Line_Reference#-jpgtga|-jpgtga launcher flag]]. If not used they will be ignored. From this version, all the supported formats are always used.

===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.
**[[%2A.MSB]] 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]] 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.

====images====
*'''Contents:''' Selectable appearances of the player in ''Barracks'' screen, ie. the player's photograph.
*'''Supported files:''' [[%2A.PCX]] bitmaps.

====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''.
**[[%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 XXXXXX. 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: At least [[%2A.DDS]] bitmaps 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 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)
/data (cfg, log, txt)
/data/maps (pcx, ani, eff, tga, jpg, 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, tga, dds)
/data/fonts (vf)
/data/effects (ani, eff, pcx, neb, tga, jpg, dds)
/data/hud (ani, pcx, tga, dds)
/data/players ()
/data/players/images (pcx)
/data/cache (clr, tmp, ibx)
/data/players (hcf)
/data/players/single (pl2, cs2, plr, csg, css)
/data/players/multi (plr)
/data/multidata (pcx, fs2)
/data/config (cfg)
/data/players/squads (pcx)
/data/demos (fsd)
/data/cbanims (ani)
/data/intelanims (ani)
/data/scripts (lua, lc)


[[Category:Modding]]

Development Reference

2009-03-06T17:15:10Z

ARSPR: Link to deprecation

* [[Getting the FreeSpace2: SCP Source Code|Getting the Source Code]]
* [[Sourcecode Reference]]
* [[Scripting API]]
* [[FS2_Open Lua Scripting]]
* [[OpenGL_Shaders_(GLSL)]]
* [[Deprecation|List (WIP) of deprecated game features]]

===External Links===
[http://scp.indiegames.us/ SCP Developers' Page]

[[Category:Source Code Project]]

Deprecation

2009-03-06T17:09:10Z

ARSPR: DirectX & AVI. -alpha_env, -2d_poof & -smart_shields flags.

2008-12-30T19:28:30Z

ARSPR: /* Ships Table Options */

{{TableVersion|4562|4499}}


==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.
{{Table37|
:*<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===
{{Table36|
*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
*Syntax: '''''Float''''', blast effect

===Example===

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

==Ship Template Options==
{{Table37|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

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

===+Use Template:===
{{Table37|
*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. 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" mission, appears to the player just as any other '''SF Dragon''', although, as its name suggests, it is less powerful than the original one.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. More over '''@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===
{{Table36|
*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:===
{{Table37|
*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}}

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

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

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

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

===$Texture Replace:===
{{Table36|
*'''+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:===
{{Table36|
*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. ''(We need a coder to post here the multiplier values that each level sets)''.
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*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''

===$Show damage:===
*No known function. Best left alone to avoid possible compatibility issues.
*Syntax: '''''Boolean''''', yes or no, usually yes

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

===$Impact Spew:===
{{Table36|
*Used to define the impact particle spew
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''}}

{{Table37|
*In 3.7 impact spew earlier entry has been replaced with full particle emitter
*'''+Texture:'''
**Defines the texture used for the particle
**Syntax: '''''String''''', filename
*'''+Relative Position:'''
**Defines the relative position of the particle
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Velocity:'''
**Defines the relative velocity of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Normal:'''
**Defines the relative normal of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Normal Variance:'''
**Syntax: '''''Float''''
*'''+Min Radius:'''
**Syntax: '''''Float''''
*'''+Max Radius:'''
**Syntax: '''''Float''''
*'''+Min Speed:'''
**Syntax: '''''Float''''
*'''+Max Speed:'''
**Syntax: '''''Float''''
*'''+Min Lifetime:'''
**Syntax: '''''Float''''
*'''+Max Lifetime:'''
**Syntax: '''''Float''''
*'''+Min Particles:'''
**Syntax: '''''Integer''''
*'''+Max Particles:'''
**Syntax: '''''Integer''''}}

===$Damage Spew:===
{{Table36|
*Used to define the damage particle spew
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''}}

{{Table37|
*In 3.7 damage spew earlier entry has been replaced with full particle emitter
*'''+Texture:'''
**Defines the texture used for the particle
**Syntax: '''''String''''', filename
*'''+Relative Position:'''
**Defines the relative position of the particle
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Velocity:'''
**Defines the relative velocity of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Normal:'''
**Defines the relative normal of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Normal Variance:'''
**Syntax: '''''Float''''
*'''+Min Radius:'''
**Syntax: '''''Float''''
*'''+Max Radius:'''
**Syntax: '''''Float''''
*'''+Min Speed:'''
**Syntax: '''''Float''''
*'''+Max Speed:'''
**Syntax: '''''Float''''
*'''+Min Lifetime:'''
**Syntax: '''''Float''''
*'''+Max Lifetime:'''
**Syntax: '''''Float''''
*'''+Min Particles:'''
**Syntax: '''''Integer''''
*'''+Max Particles:'''
**Syntax: '''''Integer''''}}

===$Debris:===
{{Table36|
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table37|
*'''+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}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will severely damage your ship, and push the lower density object away; the higher the numbers are, the harder they will hit and the farther they will be pushed. Setting a density of 10 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid.
*Syntax: '''''Float''''', 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: '''''Float'''''

===$Rotdamp:===
*Same thing, but for rotational movement.
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table37|
*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.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**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: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second

===$Forward accel:===
*Number of seconds needed from full stop to maximum velocity
*Syntax: '''''Float''''', seconds

===$Forward decel:===
*Number of seconds needed from maximum velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide accel:===
*Same for sliding as the $Forward accel: is for for normal movement.
*Syntax: '''''Float''''', seconds

===$Slide decel:===
*Same for sliding as the $Forward decel: is for for normal movement.
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table36|
*Allows gliding in game, i.e. turning the ship's facing without changing its direction.
*Syntax: '''''Boolean''''', yes or no}}

===+Max Glide Speed:===
{{Table36|
*Defines the maximum glide speed if the glide has been enabled
*Syntax: '''''Float'''''}}

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

===$Warpin type:===
{{Table36|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
**''Default''
**''BTRL''
**''Homeworld''
**''Hyperspace''
*Syntax: '''''String'''''}}
{{Table37|
*Can be defined as:
**''Default''
**''BTRL''}}

===$Warpin speed:===
{{Table36|
*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:===
{{Table36|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

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

===$Warpin animation:===
{{Table36|
*Defines the animation used as the warpin effect.
*Syntax: '''''String''''', filename}}

===$Warpout type:===
{{Table36|
*Allow an animation to be defined as a warpout effect.
*Can be defined as ''BTRL'' or ''default''.
*Syntax: '''''String'''''}}

===$Warpout speed:===
{{Table36|
*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
*Syntax: '''''Float''''', meters per second or milliseconds}}

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

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

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

===$Player warpout speed:===
{{Table36|
*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

===$Shockwave Damage Type:===
{{Table36|
*'''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:===
{{Table36|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

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

===$Weapon Model Draw Distance:===
{{Table36|
*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
{{Table36|
*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
{{Table36|
*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:====
{{Table36|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table36|
*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
{{Table36|
*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
{{Table36|
*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:====
{{Table36|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

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

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', 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: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table36|
*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''}}

===$Weapon Regeneration Rate:===
{{Table36|
*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''}}

===$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:===
{{Table36|
*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}}

===$Subsystem Repair Rate:===
{{Table36|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Armor Type===
{{Table36|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for 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" )

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

===$Countermeasure Type:===
{{Table36|
*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

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

===$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: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown offset:===
{{Table36|
*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.
{{Table36|
*Reference to the hud.tbl is no longer needed.}}

*Syntax: ''Filename''

===$Ship_icon:===
*The icon used in ship selection.
{{Table36|
*Ship model is used by default to generate the image.}}

*Syntax: ''Filename''

===$Ship_anim:===
*The glowing green grid animation used in ship selection.
{{Table36|
*Ship model is used by default to generate the image.}}

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

===$Ship_overhead:===
*The overhead view used in the weapons loadout.
{{Table36|
*Ship model is used by default to generate the image.}}

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

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

===Customized Thruster Effects===
{{Table36|
*'''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'''''}}

===$Thruster Particles:===
{{Table36|
*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.
{{Table36|
This field is deprecated, and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max decals:===
{{Table36|
*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.}}

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

===$Thruster:===
{{Table36|
*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'''''}}
{{Table37|
*'''+Flags:'''
**Flags that modify thruster behavior. As of now, only "no scale" exists, which causes all thrusters to be displayed at the same size regardless of thrust amount.
**List of flags: no scale
**Syntax: ("'''''String'''''"), names of the flags}}
{{Table36|
*'''+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]]}}

===[[Subsystems|$Subsystem:]]===

==Ships.tbl flags==

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

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

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table36|
*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

===="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"====
{{Table36|
*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"===
{{Table36|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table36|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table36|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table36|
*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"===
{{Table36|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table36|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no primary linking"===
{{Table37|
*Prevents ships from linking primary weapons}}

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

2008-12-30T19:25:45Z

ARSPR: /* $Name: */

{{TableVersion|4562|4499}}


==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.
{{Table37|
:*<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===
{{Table36|
*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
*Syntax: '''''Float''''', blast effect

===Example===

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

==Ship Template Options==
{{Table37|
*Example of template usage [[Ship_Templates]] in which both [[GTB Artemis]] variants have been defined using a single template}}

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

===+Use Template:===
{{Table37|
*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. 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" mission, appears to the player just as any other '''SF Dragon''', although, as its name suggests, it is less powerful than the original one.
**'''@'''. It's used before the proper ship name. It is fully ignored by the game. More over '''@WhateverShip''' and '''WhateverShip''' are exactly the same name and therefore they appear as '''WhateverShip''' inside the game. It just allows the user marking ships in the table because of any modding reason. An example from retail FS2 ships.tbl: '''@GTDR Amazon'''
*Syntax: '''''String''''', name

===+nocreate===
{{Table36|
*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:===
{{Table37|
*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}}

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

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

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

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

===$Texture Replace:===
{{Table36|
*'''+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:===
{{Table36|
*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. ''(We need a coder to post here the multiplier values that each level sets)''.
*Syntax: '''''(Detail Distances)''''' , list of '''integers''' (same amount as LODs), distances from the model in meters
**Example: ''(0, 80, 300, 900)''

===$ND:===
*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''

===$Show damage:===
*No known function. Best left alone to avoid possible compatibility issues.
*Syntax: '''''Boolean''''', yes or no, usually yes

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

===$Impact Spew:===
{{Table36|
*Used to define the impact particle spew
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''}}

{{Table37|
*In 3.7 impact spew earlier entry has been replaced with full particle emitter
*'''+Texture:'''
**Defines the texture used for the particle
**Syntax: '''''String''''', filename
*'''+Relative Position:'''
**Defines the relative position of the particle
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Velocity:'''
**Defines the relative velocity of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Normal:'''
**Defines the relative normal of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Normal Variance:'''
**Syntax: '''''Float''''
*'''+Min Radius:'''
**Syntax: '''''Float''''
*'''+Max Radius:'''
**Syntax: '''''Float''''
*'''+Min Speed:'''
**Syntax: '''''Float''''
*'''+Max Speed:'''
**Syntax: '''''Float''''
*'''+Min Lifetime:'''
**Syntax: '''''Float''''
*'''+Max Lifetime:'''
**Syntax: '''''Float''''
*'''+Min Particles:'''
**Syntax: '''''Integer''''
*'''+Max Particles:'''
**Syntax: '''''Integer''''}}

===$Damage Spew:===
{{Table36|
*Used to define the damage particle spew
*'''+Max particles:'''
**Defines the maximum number of particles spewed
**Setting to zero causes model to generate no particles at all
**Syntax: '''''Integer'''''}}

{{Table37|
*In 3.7 damage spew earlier entry has been replaced with full particle emitter
*'''+Texture:'''
**Defines the texture used for the particle
**Syntax: '''''String''''', filename
*'''+Relative Position:'''
**Defines the relative position of the particle
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Velocity:'''
**Defines the relative velocity of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Relative Normal:'''
**Defines the relative normal of the particle emitter
**Syntax: '''''Vector'''', three '''floats''', x-axis, y-axis, z-axis, respectively
*'''+Normal Variance:'''
**Syntax: '''''Float''''
*'''+Min Radius:'''
**Syntax: '''''Float''''
*'''+Max Radius:'''
**Syntax: '''''Float''''
*'''+Min Speed:'''
**Syntax: '''''Float''''
*'''+Max Speed:'''
**Syntax: '''''Float''''
*'''+Min Lifetime:'''
**Syntax: '''''Float''''
*'''+Max Lifetime:'''
**Syntax: '''''Float''''
*'''+Min Particles:'''
**Syntax: '''''Integer''''
*'''+Max Particles:'''
**Syntax: '''''Integer''''}}

===$Debris:===
{{Table36|
*'''+Damage Type:'''
**Defines the damage type of the debris
**Syntax: '''''String''''', name of the armor as defined in [[armor.tbl]]}}
{{Table37|
*'''+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}}

===$Density:===
*This defines how hard you hit something. If you set it very high, a collision will severely damage your ship, and push the lower density object away; the higher the numbers are, the harder they will hit and the farther they will be pushed. Setting a density of 10 on a fighter with 180 hitpoints will cause the fighter to immediately explode if it collides with, say, an asteroid.
*Syntax: '''''Float''''', 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: '''''Float'''''

===$Rotdamp:===
*Same thing, but for rotational movement.
*Syntax: '''''Float'''''

===$Banking Constant:===
{{Table37|
*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.
*Syntax: '''''Vector''''', three '''floats''', x-axis, y-axis, z-axis, respectively, meters per second
**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: '''''Vector''''', three '''floats''', seconds per 360 degree turn around x-axis, y-axis, z-axis, respectively
**Example: ''3.0, 2.6, 5.0''

===$Rear Velocity:===
*Defines rear velocity
*Syntax: '''''Float''''', meters per second

===$Forward accel:===
*Number of seconds needed from full stop to maximum velocity
*Syntax: '''''Float''''', seconds

===$Forward decel:===
*Number of seconds needed from maximum velocity to full stop
*Syntax: '''''Float''''', seconds

===$Slide accel:===
*Same for sliding as the $Forward accel: is for for normal movement.
*Syntax: '''''Float''''', seconds

===$Slide decel:===
*Same for sliding as the $Forward decel: is for for normal movement.
*Syntax: '''''Float''''', seconds

===$Glide:===
{{Table36|
*Allows gliding in game, i.e. turning the ship's facing without changing its direction.
*Syntax: '''''Boolean''''', yes or no}}

===+Max Glide Speed:===
{{Table36|
*Defines the maximum glide speed if the glide has been enabled
*Syntax: '''''Float'''''}}

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

===$Warpin type:===
{{Table36|
*Allow an animation to be defined as a warpin effect.
*Can be defined as:
**''Default''
**''BTRL''
**''Homeworld''
**''Hyperspace''
*Syntax: '''''String'''''}}
{{Table37|
*Can be defined as:
**''Default''
**''BTRL''}}

===$Warpin speed:===
{{Table36|
*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:===
{{Table36|
*Defines the effect duration
*Syntax: '''''Float''''', seconds}}

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

===$Warpin animation:===
{{Table36|
*Defines the animation used as the warpin effect.
*Syntax: '''''String''''', filename}}

===$Warpout type:===
{{Table36|
*Allow an animation to be defined as a warpout effect.
*Can be defined as ''BTRL'' or ''default''.
*Syntax: '''''String'''''}}

===$Warpout speed:===
{{Table36|
*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
*Syntax: '''''Float''''', meters per second or milliseconds}}

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

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

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

===$Player warpout speed:===
{{Table36|
*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

===$Shockwave Damage Type:===
{{Table36|
*'''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:===
{{Table36|
*Defines the textured model used as the ship's 3D shockwave
*Syntax: '''''String.pof''''', model filename}}

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

===$Weapon Model Draw Distance:===
{{Table36|
*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
{{Table36|
*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
{{Table36|
*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:====
{{Table36|
*Defines ammunition capacity of primary weapon banks. In brackets, different weapon banks separated by commas.
*Syntax: '''''( Integer, Integer )'''''}}

====$Show Primary Models:====
{{Table36|
*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
{{Table36|
*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
{{Table36|
*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:====
{{Table36|
*Defines the use of weapon models for secondary weapons. In brackets, different weapon banks may have different definitions
*Syntax: '''''( Boolean Boolean )'''''
**Example: ''(YES YES)''}}

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

===$Shield Color:===
*RGB value for shield color
*Syntax: '''''Color''''', 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: '''''Float'''''

===$Shield Regeneration Rate:===
{{Table36|
*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''}}

===$Weapon Regeneration Rate:===
{{Table36|
*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''}}

===$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:===
{{Table36|
*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}}

===$Subsystem Repair Rate:===
{{Table36|
*Repair rates for sybsystems percent per second
*Syntax: ''Value'', multiplier of total subsystem hitpoints repaired per second, '''NOT A PERCENTAGE''', 0.01 equals 1% recharged per second}}

===$Armor Type===
{{Table36|
*'''REQUIRES ADDITIONAL TABLE'''. Defines armor type used for 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" )

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

===$Countermeasure Type:===
{{Table36|
*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

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

===$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: '''''Vector''''', three '''floats''', x, y and z values respectively

===$Closeup_zoom:===
*How the model will show at techroom. How far the camera's zoomed in, defines camera's FOV.
*Syntax: '''''Float''''', radians

===$Topdown offset:===
{{Table36|
*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.
{{Table36|
*Reference to the hud.tbl is no longer needed.}}

*Syntax: ''Filename''

===$Ship_icon:===
*The icon used in ship selection.
{{Table36|
*Ship model is used by default to generate the image.}}

*Syntax: ''Filename''

===$Ship_anim:===
*The glowing green grid animation used in ship selection.
{{Table36|
*Ship model is used by default to generate the image.}}

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

===$Ship_overhead:===
*The overhead view used in the weapons loadout.
{{Table36|
*Ship model is used by default to generate the image.}}

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

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

===Customized Thruster Effects===
{{Table36|
*'''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'''''}}

===$Thruster Particles:===
{{Table36|
*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.
{{Table36|
This field is deprecated, and mods using 3.6.8 and above should use the "stealth" flag.}}

===$Max decals:===
{{Table36|
*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.}}

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

===$Thruster:===
{{Table36|
*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'''''}}
{{Table37|
*'''+Flags:'''
**Flags that modify thruster behavior. As of now, only "no scale" exists, which causes all thrusters to be displayed at the same size regardless of thrust amount.
**List of flags: no scale
**Syntax: ("'''''String'''''"), names of the flags}}
{{Table36|
*'''+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]]}}

===[[Subsystems|$Subsystem:]]===

==Ships.tbl flags==

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

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

----

===Ship Type===
*Flags in this section are used to define the type of the ship
*Use only one '''ship type''' flag per table entry
{{Table36|
*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

===="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"====
{{Table36|
*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"===
{{Table36|
*Enables the ship to use ballistic primaries
*No longer needed, game handles it automatically}}

==="flash"===
{{Table36|
*Makes a flash when a ship dies}}

==="surface shields"===
{{Table36|
*Shots that impact the hull are applied to shields, regardless of if the ship has a shield mesh.}}

==="show ship"===
{{Table36|
*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"===
{{Table36|
*Creates a HUD icon from the model itself}}

==="gun convergence"===
{{Table36|
*Enables ship to use the firing points' normals in defining the direction where the weapon fire}}

==="no primary linking"===
{{Table37|
*Prevents ships from linking primary weapons}}

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