Difference between revisions of "Documentation/Engine/Game data"
Line 8: | Line 8: | ||
<div class="folder_structure"> | <div class="folder_structure"> | ||
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=}} | {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=}} | ||
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=automat}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=automat}} ''Material storage with generated material files produced during conversion of 3D model assets with conversion tools.'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=contentbrowser}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=contentbrowser}} ''Folder used by Map Editor content browser TODO: wait for confirmation.'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=custom}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=custom}} ''Legacy folder for storing custom/modded definitions (NOTE: This folder is deprecated and might be removed in the future).'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}} ''See: [[#Definitions|Definitions]].'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=dlc}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=dlc}} ''Shared models used by dlc such like "dead end" sign.'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=effect}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=effect}} ''Set of compiled shader effects used by game for rendering of any visual element.'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=font|link=#Fonts}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=font|link=#Fonts}} ''See: [[#Fonts|Fonts]].'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=map}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=map}} ''Storage for maps and it's additional data.'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=material|link=#Predefined materials}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=material|link=#Predefined materials}} ''See: [[#Predefined materials|Predefined materials]].'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=matlib}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=matlib}} TODO: wait for confirmation. |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=model}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=model}} storage for 1st generation of static map assets. |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=model2}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=model2}} storage for 2nd generation of static map assets. |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=prefab}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=prefab}} storage for 1st generation of prefab map assets. |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=prefab2}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=prefab2}} storage for 2nd generation of prefab map assets. |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=road_template}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=road_template}} road template models for new system of road generation |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sound|link=#Sounds}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sound|link=#Sounds}} ''See: [[#Sounds|Sounds]].'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=system}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=system}} ''Low level engine resources needed for console and fall-back cases of missing resources.'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}} ''See: [[#UI definitions|UI definitions]].'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=uilab}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=uilab}} TODO: wait for confirmation. |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=unit}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=unit}} ''Definitions for predefined hookups spawned in game trough locators, for example: light flare, light sources, no weather areas.'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle}} ''See: [[#Vehicle model resources|Vehicle model resources]].'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=video}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=FST-ReadOnly|name=video}} ''Video based animated textures for UI.'' |
− | ├{{FileSystemTreeEntry|icon=FST-IconFileTxt|type=FST-ReadOnly|name=autoexec.cfg}} | + | ├{{FileSystemTreeEntry|icon=FST-IconFileTxt|type=FST-ReadOnly|name=autoexec.cfg}} ''Configuration file which is automatically executed on game start-up.'' |
− | └{{FileSystemTreeEntry|icon=FST-IconFileTxt|type=FST-ReadOnly|name=version.txt}} | + | └{{FileSystemTreeEntry|icon=FST-IconFileTxt|type=FST-ReadOnly|name=version.txt}} ''File containing game version string.'' |
</div> | </div> |
Revision as of 15:34, 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".
Contents
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 static map assets. ├model2 storage for 2nd generation of static map assets. ├prefab storage for 1st generation of prefab map 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 Folder ├─ def ├─ animated_model ├─ camera ├─ cargo ├─ city ├─ climate ├─ company ├─ country ├─ desktop ├─ ferry ├─ initial_save ├─ jobs ├─ regional_settings ├─ sign ├─ stamp ├─ vehicle └─ world
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 Folder ├ui ├─ company_manager ├─ dashboard ├─ desc ├─ editor ├─ license_plate ├─ options └─ template
Vehicle model resources
Root Game Folder ├vehicle ├─ ai ├─ driver ├─ share ├─ trailer* ├─ truck └─ wheel