Difference between revisions of "FS2 Data Structure"

From FreeSpace Wiki
Jump to: navigation, search
Line 7: Line 7:
  
 
Like all your applications you'll have Freespace 2 installed in one folder in your hard 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:
 
Like all your applications you'll have Freespace 2 installed in one folder in your hard 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:
*Unpacked, ie. individual files, inside '''data''' folder within Freespace 2 installation folder, ie. in '''/freespace2/data'''. ('''data''' name is compulsory).<br>Inside '''data''' folder, the game contents are classified and stored in several 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 are:
+
*Unpacked, ie. individual files, inside '''data''' folder within Freespace 2 installation folder, ie. in '''/freespace2/data'''. ('''data''' name is compulsory).<br>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 are:
**Effects
+
**[[FS2_Data_Structure#effects|effects]]
**Maps
+
**[[FS2_Data_Structure#maps|maps]]
**Missions
+
**[[FS2_Data_Structure#missions|missions]]
**Models
+
**[[FS2_Data_Structure#models|models]]
**Music
+
**[[FS2_Data_Structure#music|music]]
**Sounds
+
**[[FS2_Data_Structure#sounds|sounds]]
**Tables
+
**[[FS2_Data_Structure#tables|tables]]
**Voices
+
**[[FS2_Data_Structure#voice|voice]]
 
*Packed in vp archives data holders. 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.<br>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.
 
*Packed in vp archives data holders. 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.<br>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.
 
*<font color=red>'''SCP fs2_open addition:''' Auxiliary data folders loaded through [[Command-Line_Reference#-mod|-MOD launcher flag]]. Retail version only use both former places. But fs2_open, (and FRED2_open), can use any other auxiliary folder to contain game data. This feature allows using several different mods without having undesired cross-effects. More important info about this feature and about loading priority can be found in [[Command-Line_Reference#-mod|-MOD launcher flag help]].</font>
 
*<font color=red>'''SCP fs2_open addition:''' Auxiliary data folders loaded through [[Command-Line_Reference#-mod|-MOD launcher flag]]. Retail version only use both former places. But fs2_open, (and FRED2_open), can use any other auxiliary folder to contain game data. This feature allows using several different mods without having undesired cross-effects. More important info about this feature and about loading priority can be found in [[Command-Line_Reference#-mod|-MOD launcher flag help]].</font>
Line 88: Line 88:
  
  
===voices===
+
===voice===
  
 
====briefing====
 
====briefing====

Revision as of 15:42, 27 May 2007

WARNING: THIS PAGE IS FULLY UNDER DEVELOPMENT !!


Introduction

Apart from the game engine (the game executable), or mission editor (FRED), the game needs data to run; it needs missions, sounds, 3D models, textures... Freespace2 is highly moddable because nearly none of this data is embedded inside the game executable. In this way the user can always change nearly all game data.

Like all your applications you'll have Freespace 2 installed in one folder in your hard 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:

  • 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. 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 are:
  • Packed in vp archives data holders. 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.
    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.
  • SCP fs2_open addition: Auxiliary data folders loaded through -MOD launcher flag. Retail version only use both former places. But fs2_open, (and FRED2_open), can use any other auxiliary folder to contain game data. This feature allows using several different mods without having undesired cross-effects. More important info about this feature and about loading priority can be found in -MOD launcher flag help.


data subfolders

cache

cbanims

effects

fonts

force feedback

freddocs

hud

intelanims

interface

maps

missions

models

movies

multidata

music

players

images

multi

single

squads

sounds

8b22k

16b11k

tables

voice

briefing

command_briefings

debriefing

personas

special

Loading order