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

From SCS Modding Wiki
Jump to navigation Jump to search
(Definitions)
Line 35: Line 35:
 
</div>
 
</div>
  
= Definitions =
+
== Definitions ==
  
 
Definitions for most of configurable game content like: vehicles, economy, map assets etc.
 
Definitions for most of configurable game content like: vehicles, economy, map assets etc.
Line 64: Line 64:
 
</div>
 
</div>
  
= Fonts =
+
== Fonts ==
  
 
Folder for storing game fonts.
 
Folder for storing game fonts.
Line 75: Line 75:
 
</div>
 
</div>
  
= Predefined materials =
+
== Predefined materials ==
  
 
Library of predefined materials and textures.
 
Library of predefined materials and textures.
Line 102: Line 102:
 
</div>
 
</div>
  
= Sounds =
+
== Sounds ==
  
 
Library of sounds used by game.
 
Library of sounds used by game.
Line 117: Line 117:
 
</div>
 
</div>
  
= UI definitions =
+
== UI definitions ==
  
 
Library of all UI definitions including vehicle dashboards.
 
Library of all UI definitions including vehicle dashboards.
Line 133: Line 133:
 
</div>
 
</div>
  
= Vehicle model resources =
+
== Vehicle model resources ==
  
 
<div class="folder_structure">
 
<div class="folder_structure">

Revision as of 16:07, 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 folders 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 TODO: wait for confirmation.custom          Legacy folder for storing custom/modded definitions (NOTE: This folder is deprecated and might be removed in the future).def             See: Definitions.dlc             Shared models used by dlc such like "dead end" sign.effect          Set of compiled shader effects used by game for rendering of any visual element.font            See: Fonts.map             Storage for maps and it's additional data.material        See: Predefined materials.matlib          TODO: wait for confirmation.
 ├model           Storage for 1st generation of map assets.model2          Storage for 2nd generation of map assets.prefab          Storage for 1st generation of prefab assets.prefab2         Storage for 2nd generation of prefab map assets.road_template   Road template models for new system of road generation.sound           See: Sounds.system          Low level engine resources needed for console and fall-back cases of missing resources.ui              See: UI definitions.uilab           TODO: wait for confirmation.
 ├unit            Definitions for predefined hookups spawned in game trough locators, for example: light flare, light sources, no weather areas.vehicle         See: Vehicle model resources.video           Video based animated textures for UI.autoexec.cfg    Configuration file which is automatically executed on game start-up.version.txt     File containing game version string.

Definitions

Definitions for most of configurable game content like: vehicles, economy, map assets etc.

Root Game Folderdefanimated_modelcameracargocityclimatecompanycountrydesktopferryinitial_savejobsregional_settingssignstampvehicleworldaux_lamp_colors.siibank_data.siivehicle_lamp_colors.sii

Fonts

Folder for storing game fonts.

Root Game Folder 
├─ font
   ├─ license_plate
   └─ sign

Predefined materials

Library of predefined materials and textures.

Root Game Folder 
├─ material
   ├─ custom
   ├─ decal
   ├─ deferred
   ├─ editor
   ├─ environment
   ├─ flags
   ├─ logo
   ├─ metal
   ├─ overlay
   ├─ prefab
   ├─ road
   ├─ rocks
   ├─ ropes
   ├─ sign
   ├─ special
   ├─ terrain
   ├─ tiled
   └─ ui

Sounds

Library of sounds used by game.

Root Game Folder 
├─ sound
   ├─ ai
   ├─ environment
   ├─ mover
   ├─ music
   ├─ truck
   └─ ui

UI definitions

Library of all UI definitions including vehicle dashboards.

Root Game Folderui
   ├─ company_manager
   ├─ dashboard
   ├─ desc
   ├─ editor
   ├─ license_plate
   ├─ options
   └─ template

Vehicle model resources

Root Game Foldervehicle
   ├─ ai
   ├─ driver
   ├─ share
   ├─ trailer*
   ├─ truck
   └─ wheel