Difference between revisions of "Documentation/Engine/Game data"

From SCS Modding Wiki
Jump to navigation Jump to search
(Root game folder)
(Root game folder)
Line 9: Line 9:
 
<div class="folder_structure">
 
<div class="folder_structure">
  
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=automat}} - material storage with generated material files got during conversion of 3D model assets with conversion tools.
+
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=automat}} - material storage with generated material files produced during conversion of 3D model assets with conversion tools.
 
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=contentbrowser}} - folder used by Map Editor content browser.
 
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=contentbrowser}} - folder used by Map Editor content browser.
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=custom}} - legacy folder where the custom/modded definitions were stored (NOTE: This folder is deprecated and might be removed in the future).
+
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=custom}} - legacy folder for storing custom/modded definitions (NOTE: This folder is deprecated and might be removed in the future).
  ├─ def - folder storing definitions for most of configurable game content like: game world, game objects, vehicles, economy etc. See more at: [[{{FULLPAGENAME}}#Definitions structure|Definitions structure]]
+
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=|name=def}} - definitions for most of configurable game content like: vehicles, economy, map assets etc. See more at: [[{{FULLPAGENAME}}#Definitions structure|Definitions structure]]
     ├─ animatedmodel
+
     ├─ animated_model
 
     ├─ camera
 
     ├─ camera
 
     ├─ cargo
 
     ├─ cargo
Line 44: Line 44:
 
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=uilab}} - (not sure if we ship this folder, yes we are shipping it)
 
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=uilab}} - (not sure if we ship this folder, yes we are shipping it)
 
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=|name=unit}}unit -  
 
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=|name=unit}}unit -  
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=|name=vehicle}}vehicle - vehicle related files.
+
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=|name=vehicle}} - vehicle related files.
 
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=video}} - video based animated textures.
 
  ├─ {{FileSystemTreeEntry|icon=FST-Folder|type=FST-ReadOnly|name=video}} - video based animated textures.
 
  ├─ {{FileSystemTreeEntry|icon=FST-TxtFile|type=FST-ReadOnly|name=autoexec.cfg}} - configuration file which is automatically exectued on game startup
 
  ├─ {{FileSystemTreeEntry|icon=FST-TxtFile|type=FST-ReadOnly|name=autoexec.cfg}} - configuration file which is automatically exectued on game startup

Revision as of 13:08, 3 March 2016

All of SCS games are using partially prescribed folder structure. This means that some resources must have proper name and be placed into proper folder otherwise game may malfunction or even crash. That's why this topic is giving insight to game base folder structure, it's crucial resources and their place in folders.

In general topic is showing and describing structure of the folder and files as you get them by using Game Archive Extractor for two basic files with .scs extension found in game installation directory: "base.scs" and "def.scs".

Root game folder

Root game folder consists of:

├─ automat - material storage with generated material files produced during conversion of 3D model assets with conversion tools.
├─ contentbrowser - folder used by Map Editor content browser.
├─ custom - legacy folder for storing custom/modded definitions (NOTE: This folder is deprecated and might be removed in the future).
├─ def - definitions for most of configurable game content like: vehicles, economy, map assets etc. See more at: Definitions structure
   ├─ animated_model
   ├─ camera
   ├─ cargo
   ├─ city
   ├─ climate
   ├─ company
   ├─ country
   ├─ desktop
   ├─ ferry
   ├─ initial_save
   ├─ jobs
   ├─ regional_settings
   ├─ sign
   ├─ stamp
   ├─ vehicle
   ├─ world
├─ dlc - shared models used by dlc such like "dead end" sign.
├─ effect - set of the graphical effects (shaders)
├─ font - fonts used by game.
├─ map - map data.
├─ material - materials used by UI and the objects (there you put materials before conversion???).
├─ model - storage for models.
├─ model2 - storage for models. (describe diference) 
├─ prefab - storage for prefabs.
├─ prefab2 - storage for prefabs. (describe difference prefab<>prefab2)
├─ road_templateroad_template - road template models for new system of road generation
├─ sound - sounds used by game.
├─ system - 
├─ ui - ui dialogs and windows definitions.
├─ uilab - (not sure if we ship this folder, yes we are shipping it)
├─ unitunit - 
├─ vehicle - vehicle related files.
├─ video - video based animated textures.
├─ autoexec.cfg - configuration file which is automatically exectued on game startup
└─ version.txt- TXT file containing game version string

ICONS TODO

  • SII / SUI
  • TEXT FILE

Probably not needed

  • Model
  • Audio (OGG)
  • Material
  • Textures
    • TOBJ
    • DDS etc etc
  • Video Texture (OGV)
  • Map content
  • .font