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

From SCS Modding Wiki
Jump to navigation Jump to search
m
(→‎Cargo Definitions)
(122 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{Tip|Be aware that this page is obsolete, due to big changes in game structure with each update! For more information on structure changes check [[Games/ETS2/Modding_guides|modding updates]] pages.}}
+
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 [[Documentation/Tools/Game Archive Extractor|Game Archive Extractor]] for two basic files with .scs extension found in game installation directory: "'''base.scs'''" and "'''def.scs'''".
−
All of SCS games are using partially prescribed folder structure. This means that some resources must have the proper name and be placed into the proper folder otherwise game may malfunction or even crash. That's why this topic is giving insight to game base folder structure, its crucial resources and their place in folders.
 
−
 
 
−
In general, this topic is showing and describing the structure of the folders and files as you get them by using the [[Documentation/Tools/Game Archive Extractor|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 =
Line 10: Line 7:
 
Root game folder consists of:
 
Root game folder consists of:
 
<div class="folder_structure">
 
<div class="folder_structure">
−
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|mark_current=1}}
+
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=}}
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=automat}}        ''Material storage with generated material files produced during conversion of 3D model assets with conversion tools.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=automat}}        ''Material storage with generated material files produced during conversion of 3D model assets with conversion tools.''
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=contentbrowser}}  ''Folder used by Map Editor content browser.''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=contentbrowser}}  ''Folder used by Map Editor content browser TODO: wait for confirmation.''
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=custom}}          ''Legacy folder for storing custom/modded definitions (NOTE: This folder is obsolete and might be removed in the future).''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|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}}            ''See: [[#Definitions|Definitions]].''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}            ''See: [[#Definitions|Definitions]].''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=dlc}}            ''Shared models used by dlc such like "dead end" sign.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=dlc}}            ''Shared models used by dlc such like "dead end" sign.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=effect}}          ''Set of compiled shader effects used by game for rendering of any visual element.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|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}}            ''See: [[#Fonts|Fonts]].''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=font|link=#Fonts}}            ''See: [[#Fonts|Fonts]].''
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=map}}            ''Storage for maps and its additional data.''
+
   ├{{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}}        ''See: [[#Predefined materials|Predefined materials]].''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=material|link=#Predefined materials}}        ''See: [[#Predefined materials|Predefined materials]].''
 +
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=matlib}}          TODO: wait for confirmation.
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=model}}          ''Storage for 1st generation of map assets.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=model}}          ''Storage for 1st generation of map assets.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=model2}}          ''Storage for 2nd generation of map assets.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=model2}}          ''Storage for 2nd generation of map assets.''
Line 28: Line 26:
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=system}}          ''Low level engine resources needed for console and fall-back cases of missing resources.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=system}}          ''Low level engine resources needed for console and fall-back cases of missing resources.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}}              ''See: [[#UI definitions|UI definitions]].''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}}              ''See: [[#UI definitions|UI definitions]].''
 +
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=uilab}}          TODO: wait for confirmation.
 
   ├{{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=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}}        ''See: [[#Vehicle model resources|Vehicle model resources]].''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle}}        ''See: [[#Vehicle model resources|Vehicle model resources]].''
Line 42: Line 41:
 
<div class="folder_structure">
 
<div class="folder_structure">
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}  
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}  
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|mark_current=1}}
+
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def}}
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=animated_model}}                ''Directory with definitions for animated models triggered when distance to player is small enough.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=animated_model}}                ''Directory with definitions for animated models triggered when distance to player is small enough.''
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=camera|link=#Camera definitions}}                        ''See: [[#Camera definitions|Camera definitions]].''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=camera|link=#Camera Definitions}}                        ''See: [[#Camera Definitions|Camera Definitions]]
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=cargo|link=#Cargo definitions}}                        ''See: [[#Cargo definitions|Cargo definitions]].''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=cargo|link=#Cargo Definitions}}                        ''See: [[#Cargo Definitions|Cargo Definitions]]
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=city}}                         ''Defines cities for game. Each city is defined in its own SII file.''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=city}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=climate|link=#Climate definitions}}                       ''See: [[#Climate definitions|Climate definitions]].''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=climate}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=company|link=#Company definitions}}                       ''See: [[#Company definitions|Company definitions]].''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=company}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=country|link=#Country definitions}}                       ''See: [[#Country definitions|Country definitions]].''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=country}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=desktop}}                       ''Desktop (main menu) scene configurations. By default "'''/def/desktop/config.sii'''" is used.''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=desktop}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ferry|link=#Ferry definitions}}                       '' See: [[#Ferry definitions|Ferry definitions]].''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ferry}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=initial_save}}                 ''Stores zero day save files where folder: '''normal''' is used by creating new user profile and '''preview''' while running game in preview mode.''
+
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=initial_save}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=regional_settings}}             ''Regional settings profiles data. By default there should be 3 profiles: Europe, USA and UK.''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=jobs}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sign|link=#Sign definitions}}                         ''See: [[#Sign definitions|Sign definitions]].''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=regional_settings}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=stamp}}                         ''Defines brush stamping layouts which are defined as stamps in "'''/def/world/stamp.sii'''" and used in Map Editor while using Stamp Tool.''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sign}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle|link=#Vehicle definitions}}                       ''See: [[#Vehicle definitions|Vehicle definitions]].''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=stamp}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=world|link=#World definitions}}                         ''See: [[#World definitions|World definitions]].''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle}}
 +
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=world}}
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=aux_lamp_colors.sii}}          ''Defines players vehicle auxiliary light mask colors.''  
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=aux_lamp_colors.sii}}          ''Defines players vehicle auxiliary light mask colors.''  
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=bank_data.sii}}                ''Bank loans configuration.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=bank_data.sii}}                ''Bank loans configuration.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=car_colors.sii}}                ''Defines colors for AI traffic cars.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=car_colors.sii}}                ''Defines colors for AI traffic cars.''
−
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=cargo.sii}}                    ''Storage of cargoes for trailer generation. When defining your own cargoes use infixed version of this SII file for example: "cargo.my_mod.sii".''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=cargo.sii}}                    ''Storage of cargoes for trailer generation. When defining your own cargoes use infixed version of this Sii file for example: "cargo.my_mod.sii".''
−
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=city.sii}}                      ''Storage of cities in game. When defining your own cities use infixed version of this SII file for example: "city.my_mod.sii".''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=city.sii}}                      ''Storage of cities in game. When defining your own cities use infixed version of this Sii file for example: "city.my_mod.sii".''
−
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=climate.sii}}                  ''Storage of climate profiles. When defining your own climate use infixed version of this SII file for example: "climate.my_mod.sii".''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=climate.sii}}                  ''Storage of climate profiles. When defining your own climate use infixed version of this Sii file for example: "climate.my_mod.sii".''
−
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=company.sii}}                  ''Storage of companies that can be used in game. When defining your own companies use infixed version of this SII file for example: "company.my_mod.sii".''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=company.sii}}                  ''Storage of companies that can be used in game. When defining your own companies use infixed version of this Sii file for example: "company.my_mod.sii".''
 
   ├...
 
   ├...
−
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=country.sii}}                  ''Storage of countries used in game. When defining your own countries use infixed version of this SII file for example: "country.my_mod.sii".''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=country.sii}}                  ''Storage of countries used in game. When defining your own countries use infixed version of this Sii file for example: "country.my_mod.sii".''
 
   ├...
 
   ├...
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=economy_data.sii}}              ''Game economy definition.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=economy_data.sii}}              ''Game economy definition.''
 
   ├...
 
   ├...
−
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=env_data.sii}}                  ''Environment global configuration such as day in the year.''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=env_data.sii}}                  ''Environment global configuration such as day in the year.'' << TODO: This is not clean enough for me.
 
   ├...
 
   ├...
−
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=ferry.sii}}                    ''Storage of ferry ports. When defining your own cargoes use infixed version of this SII file for example: "ferry.my_mod.sii".''
+
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=ferry.sii}}                    ''Storage of ferry ports. When defining your own cargoes use infixed version of this Sii file for example: "ferry.my_mod.sii".''
 
   ├...
 
   ├...
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=game_data.sii}}                ''Various global game definitions.''
 
   ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=game_data.sii}}                ''Various global game definitions.''
Line 100: Line 100:
 
</div>
 
</div>
  
−
=== Camera definitions ===
+
=== Camera Definitions ===
  
−
Camera definitions folder ("'''/def/camera'''") is using "'''camera_storage(.infix).sii'''" files as storage files defining cameras that can be used by player while in game (UI interface is not handled by cameras, as UI is drawn directly on screen 2D plane). Note that this defines only storage for available in game cameras, but which camera is used in the game depends on currently user selected view and current used player vehicle.
+
Camera definitions directory ("'''/def/camera'''") is using "'''camera_storage(.infix).sii'''" files as storage files defining cameras that can be used by player while in game (UI interface is not handled by cameras, as UI is drawn directly on screen 2D plane). Note that this defines only storage for available in game cameras, but which camera is used in the game depends on currently user selected view and current used player vehicle.
  
−
Beside storage files camera definitions folder also includes "'''cutscene.sii'''" file which defines camera and its movement in different cut-scenes.
+
Beside storage files camera definitions folder also includes "'''cutscene.sii'''" file which defines camera and it's movement in different cut-scenes.
  
 
<div class="folder_structure">
 
<div class="folder_structure">
Line 110: Line 110:
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}  
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}  
 
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=camera|mark_current=1}}
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=camera}}
−
     ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}                        ''Folders for cut scenes camera definitions.''
+
     ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}                        ''Directories for cut scenes camera definitions.''
−
     ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}}                        ''Folder for storing camera movement definitions related to game desktop (main menu).''
+
     ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}}                        ''Directory for storing camera movement definitions related to game desktop (main menu).''
−
     ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=units}}                      ''Folder for storing players camera included in "camera_storage" SII files.''
+
     ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=units}}                      ''Directory for storing players camera included in "camera_storage" Sii files.''
 
     ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=camera_storage.sii}}        ''Defining cameras storage that can be used in game by player. When creating your own cameras use infixed storage file name like: "camera_storage.mymod.sii".''
 
     ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=camera_storage.sii}}        ''Defining cameras storage that can be used in game by player. When creating your own cameras use infixed storage file name like: "camera_storage.mymod.sii".''
 
     ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=camera_storage.oculus.sii}}  ''Same as camera_storage.sii with purpose of defined cameras for Oculus Rift head set.''
 
     ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=camera_storage.oculus.sii}}  ''Same as camera_storage.sii with purpose of defined cameras for Oculus Rift head set.''
Line 120: Line 120:
 
</div>
 
</div>
  
−
=== Cargo definitions ===
+
=== Cargo Definitions ===
−
 
 
−
This folder contains all cargoes definitions that player can transport in the game.
 
−
 
 
−
Unique cargo is defined by SII file and folder having one or more SII files defining trailers which can carry this cargo. So for each cargo you have one SII file inside "'''/def/cargo/'''" and one or multiple SII files inside folder "'''/def/cargo/<cargo_name>/'''". Example definition for cargo: "'''<cargo_name>'''" is shown in the tree below.
 
−
 
 
−
<div class="folder_structure">
 
−
 
 
−
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}
 
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=cargo|mark_current=1}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<cargo_name_1>}}            ''Folder defining trailers that can carry cargo defined in "<cargo_name>.sii" file.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=trailer.unit.name.sii}}    ''Defines trailer that can carry this cargo. SII file is named by trailer SiiUnit name.''
 
−
      └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                      ''More definitions for different trailers carrying this cargo.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<cargo_name_2>}}
 
−
      └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}                        ''The rest of cargo trailer definition folders.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<cargo_name_1>.sii}}        ''Defining one cargo data.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<cargo_name_2>.sii}}
 
−
    └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                        ''The rest of unique cargoes definition.''
 
−
</div>
 
−
 
 
−
=== Climate definitions ===
 
−
 
 
−
Each climate is defined in its own folder "'''/def/climate/<climate_name>/'''" and usually have profile SII files: one for nice weather "'''nice.sii'''" and second for bad weather "'''bad.sii'''". Climates definitions are used  in Map Editor (Editor Settings -> Weather tab).
 
−
 
 
−
By default there should be at least two climates:
 
−
 
 
−
<div class="folder_structure">
 
−
 
 
−
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}
 
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=climate|mark_current=1}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=reference}}    ''Reference climate.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=bad.sii}}    ''Climate definition for bad weather.''
 
−
      └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=nice.sii}}  ''Climate definition for nice weather.''
 
−
    └{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}          ''The rest of climates.''
 
−
</div>
 
−
 
 
−
=== Company definitions ===
 
−
 
 
−
Companies are entry and exit places on map for player missions (e.g. trailer delivery). So when defining new company make sure to include it in company storage file "'''/def/company(.infix).sii'''" otherwise company won't appear in the Map Editor and later in game.
 
−
 
 
−
Company definition folder with included company "'''<company_name_1>'''" would look like:
 
−
 
 
−
<div class="folder_structure">
 
−
 
 
−
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}
 
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=company|mark_current=1}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<company_name_1>}}        ''Folder defining company data, named same as its corresponding company data file.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=editor}}                ''Folder containing definitions for cities in which this company exists and which prefab will be used for it.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=in}}                    ''Folder containing SII files for cargoes this company accepts.''
 
−
      └{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=out}}                  ''Folder containing SII files for cargoes this company is shipping out.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<company_name_2>}}
 
−
      └{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}                    ''The rest of the folders defining other companies data.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<company_name_1>.sii}}    ''File defining company: name, trailer look and sounds.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<company_name_2>.sii}}
 
−
    └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                    ''The rest of companies definitions.''
 
−
 
 
−
</div>
 
−
 
 
−
=== Country definitions ===
 
−
 
 
−
Defines available countries that can be used in the Map Editor and later in game. While defining new country make sure to include it in country storage file "'''/def/country(.infix).sii'''".
 
−
 
 
−
Each country has its own folder defining all possible country specific data. Worth mentioning is modification of AI traffic appearing frequencies, which is done by adding SII files inside "'''/def/country/<country_name>/ai/'''" folder. Each SII file defines modified frequency for one AI vehicle, where its name tells which car it is. Possible file names are AI vehicles unit name suffixes used inside AI vehicle definitions (AI vehicles definitions can be found in: "'''/def/vehicle/ai/'''").
 
−
 
 
−
Tree overview of country definitions:
 
−
 
 
−
<div class="folder_structure">
 
−
 
 
−
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}
 
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=country|mark_current=1}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<country_name_1>}}      ''Folder defining other country specific data: license plates, speed limits, AI cars frequency.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ai}}                  ''Folder containing SII files for AI traffic vehicles, that should have modified frequency in that country.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=license_plates.sii}}  ''Defines license plate data for that country.''
 
−
      └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=speed_limits.sii}}    ''Defines speed limits for AI traffic for that country.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<country_name_2>}}       
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}
 
−
      └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}                  ''Folders for the rest of the countries data.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<country_name_1>.sii}}  ''File defining country general data: id, name, country code, position, fuel price etc.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<country_name_2>.sii}}
 
−
    └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                  ''The rest of the countries definition.''
 
−
 
 
−
</div>
 
−
 
 
−
=== Ferry definitions ===
 
−
 
 
−
Defines names of the ferries and their connections. For proper working in game this ferries has to be used in Map Editor while adding Ferry points. All ferries also have to be included in ferry storage file "'''/def/ferry(.infix).sii'''".
 
−
 
 
−
Connections on the other hand are defined in "'''/def/ferry/connection/'''" folder. Each file in that folder defines one direction connection from one ferry to second ferry. How connection is directed is defined by SiiUnit name, so for example SiiUnit name: "'''conn.<ferry1>.<ferry2>'''" is presenting ferry connection from <ferry1> to <ferry2>.
 
−
 
 
−
Tree overview of ferry definitions:
 
−
 
 
−
<div class="folder_structure">
 
−
 
 
−
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}
 
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ferry|mark_current=1}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=connection}}  ''Folder with SII files defining connections between ferries. Each file defines one way direction between two ferries.''
 
−
    └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}          ''SII files defining ferries. Each file defines one unique ferry.''
 
−
 
 
−
</div>
 
−
 
 
−
=== Sign definitions ===
 
−
 
 
−
Sign definitions are meant for new on-the-fly sign generation system which uses:
 
−
* Image atlases which are used to combine several related image into one and use atlas entries to address only part of the image.
 
−
* Frame templates which replaces sign background images for generated ones, where quality is not compromised with scaling.
 
−
 
 
−
Moreover sign definitions includes projects and template folder where game saves projects and end sign templates created within Map Editor.
 
−
 
 
−
Whole sign definitions tree structure:
 
−
 
 
−
<div class="folder_structure">
 
−
 
 
−
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}
 
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sign|mark_current=1}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=atlas}}            ''Defines image atlases for signs. SII files are created by hand.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=frame}}            ''Defines frames templates for signs. SII files are created by hand''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=project}}          ''Defines sign projects which links associated data for example: creation of signs for one country. SII files are created by Map Editor.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=template}}        ''Defines signs template featuring all sign components, their positions and other properties. SII files are created by Map Editor.''
 
−
    └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=templates.sii}}    ''Templates storage file including templates from "'''/def/sign/template/''''' folder. Also managed by Map Editor''
 
−
 
 
−
</div>
 
−
 
 
−
=== Vehicle definitions ===
 
−
 
 
−
Vehicle definitions are responsible for configuration of any type of vehicles and its parts in SCS games that are not map assets. Biggest part of this configurations belongs to configuration of possible player vehicles and its parts.
 
−
 
 
−
<div class="folder_structure">
 
−
 
 
−
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}
 
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle|mark_current=1}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=addon_hookups}}                      ''Folder for defining available libraries of players truck accessory hookups e.g. horns, interior toys or grill lights.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ai|link=#AI vehicle definitions}}                                ''See: [[#AI vehicle definitions|AI vehicle definitions]]''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ai_wheel}}                          ''AI vehicle wheel definitions containing separate definitions for front and rear wheels.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=f_cover}}                            ''Players vehicle front wheel cover definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=f_disc}}                            ''Players vehicle front wheel rim definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=f_hub}}                              ''Players vehicle front wheel hub definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=f_nuts}}                            ''Players vehicle front wheel nuts definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=f_rim}}                              ''Obsolete. Used only for backward compatibility with 2nd gen. of players truck wheel system.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=f_tire}}                            ''Players vehicle front tire definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=f_wheel}}                            ''Partially obsolete. Used for backward compatibility with 1st gen. of players truck wheel system and defining AI trucks front wheel.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=r_cover}}                            ''Players vehicle rear wheel cover definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=r_disc}}                            ''Players vehicle rear wheel rim definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=r_hub}}                              ''Players vehicle rear wheel hub definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=r_nuts}}                            ''Players vehicle rear wheel nuts definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=r_rim}}                              ''Obsolete. Used only for backward compatibility with 2nd gen. of players truck wheel system.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=r_tire}}                            ''Players vehicle front tire definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=r_wheel}}                            ''Partially obsolete. Used for backward compatibility with 1st gen. of players truck wheel system and defining AI trucks rear wheel.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=trailer|link=#Trailer definitions}}                            ''See: [[#Trailer definitions|Trailer definitions]].''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck|link=#Player trucks definitions}}                              ''See: [[#Player trucks definitions|Player trucks definitions]].''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_company}}                      ''Trucks configurations for Quick Jobs.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_company_uk}}                  ''Trucks configurations for RHD trucks (UK related) Quick Jobs. This folder exists only in: ETS2 game data.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_dealer}}                      ''See: [[#Truck dealer definitions|Truck dealer definitions]].''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_dealer_uk}}                    ''Defines assortment of RHD trucks for dealers; has same structure as: [[#Truck dealer definitions|Truck dealer definitions]] and exists only in ETS2 game data.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_desktop}}                      ''Trucks configurations used in Truck Browser.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_desktop_uk}}                  ''Trucks configurations for RHD trucks used in Truck Browser, if player started game in UK.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=t_wheel}}                            ''Trailer wheels definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=addon_hookup_storage.sii}}          ''Storage file for including truck accessory hookup libraries in the game. For new libraries use e.g. "'''addon_hookup_storage.mymod.sii'''".''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=physics.sii}}                        ''Defines players vehicle common physics parameters.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=physics_interior_camera.sii}}        ''Defines interior camera movement physics parameters.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=rim_data.sii}}                      ''Defines players vehicle wheels assembling rules and backward compatibility for old game profiles using old wheels assembling system.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=traffic_storage_bus.sii}}            ''Storage file for AI traffic bus vehicles inclusion in game. For new AI buses use e.g. "'''traffic_storage_bus.mymod.sii'''".''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=traffic_storage_car.sii}}            ''Storage file for AI traffic car vehicles inclusion in game. For new AI cars use e.g. "'''traffic_storage_car.mymod.sii'''".''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=traffic_storage_semi_trailer.sii}}  ''Storage file for AI traffic semi trailers inclusion in game. For new AI semi trailers use e.g. "'''traffic_storage_semi_trailer.mymod.sii'''".''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=traffic_storage_truck.sii}}          ''Storage file for AI traffic trucks inclusion in game. For new AI truck use e.g. "'''traffic_storage_truck.mymod.sii'''".''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=traffic_trailer_type.sii}}          ''Defines types of AI traffic trailers for which storage files will be searched and included in game. For new trailer types use e.g. "'''traffic_storage_truck.mymod.sii'''".''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=traffic_vehicle_type.sii}}          ''Defines types of AI traffic vehicles for which storage files will be searched and included in game.''
 
−
    └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=trailer_storage.sii}}                ''Storage file for inclusion of trailers for player. For new trailers use e.g. "'''traffic_storage.mymod.sii'''".''
 
−
 
 
−
</div>
 
−
 
 
−
==== AI vehicle definitions ====
 
−
 
 
−
AI vehicle definition consists of AI traffic vehicles definition files and folders for them containing "'''chassis.sii'''" file defining chassis data of each vehicle. All of the vehicles definition files have to be included in one of traffic storage files:  "'''traffic_storage_bus(.infix).sii'''",  "'''traffic_storage_bus(.infix).sii'''", "'''traffic_storage_bus(.infix).sii'''" or any other custom defined traffic vehicle type storage file.
 
−
 
 
−
{{Note|Euro Truck Simulator 2 has extra: "'''/def/vehicle/ai/truck/'''" subfolder for grouping folders of traffic truck chassis definitions.}}
 
−
 
 
−
{{Note|This folder doesn't include trailers definitions for traffic as it's a common practice that trailers for AI traffic are defined inside [[#Trailer definitions|Trailer definitions]].}}
 
−
 
 
−
<div class="folder_structure">
 
−
 
 
−
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}
 
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle|link=#Vehicle definitions}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ai|mark_current=1}}
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<ai_vehicle_1>}}      ''Folder for defining AI traffic vehicle chassis file.''
 
−
        └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=chassis.sii}}        ''Defines AI traffic vehicle 3D model paths and variants/looks configuration for it.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<ai_vehicle_2>}}
 
−
        └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=chassis.sii}}
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}                  ''The rest of AI traffic vehicles chassis configuration folders.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<ai_vehicle_1>.sii}}  ''Defines AI traffic vehicle. Has to be included in some traffic vehicle storage file inside parent folder: "'''/def/vehicle/'''".''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<ai_vehicle_2>.sii}}
 
−
      └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                  ''The rest of AI traffic vehicles definition files.''
 
−
 
 
−
</div>
 
−
 
 
−
==== Trailer definitions ====
 
  
−
Trailer definitions defines trailers for usage with players truck or for usage by AI traffic. For defining a trailer, one SII file and folder with "'''chassis.sii'''" and/or additional cargo definitions has to be created. All of the trailers definition files also have to be included in one of the storage files to be used in game. In case trailer should be used by player it has to be included in one of the "'''trailer_storage(.infix).sii'''" files and if trailer should be used by AI trucks it has to be included in one of "'''traffic_storage_semi_trailer(.infix).sii'''" files or custom type of AI trailers storage file.
+
Unique cargo is defined by Sii file and directory with one or more Sii files defining trailers which can carry this cargo. So for each cargo you have one Sii file inside "'''/def/cargo/'''" and one or multiple Sii files inside folder "'''/def/cargo/<cargo_name>/'''". Example definition for cargo: "'''<cargo_name>'''" is shown in the tree below.
−
 
 
−
{{Note|AI trailers and player trailers are handled somewhat differently. Player trailers use the "'''trailer'''" SiiUnit class with a naming convention of <code>trailer.<name></code>, while AI trailers use the "'''traffic_trailer'''" SiiUnit class and a naming convention of <code>traffic.trailer.<name></code>.}}
 
  
 
<div class="folder_structure">
 
<div class="folder_structure">
Line 335: Line 128:
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}  
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}  
 
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
−
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle|link=#Vehicle definitions}}
+
   ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=cargo}}
−
     ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=trailer|mark_current=1}}
+
     ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<cargo_name>}}             ''Directory defining trailers that can carry cargo defined in "<cargo_name>.sii" file.''
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<trailer_1>}}               ''Folder for cargo hookup and chassis definition of first trailer.''
+
       ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=trailer.unit.name.sii}}  ''Defines trailer that can carry this cargo. Sii file is named by trailer SiiUnit name''
−
        ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=company_paint_job}}      ''Folder for company-specific paint job definitions of first trailer.''
+
      └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                    ''More definitions for different trailers carrying this cargo.''
−
          └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<trailer_look>.sii}}    ''Defines paint job for companies with corresponding trailer_look attribute. (eg plain, trameri, etc)''
+
     ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}                     ''Rest of cargo trailer definition folders.''
−
        ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=custom_paint_job}}        ''Folder for custom paint job definitions, selectable in the trailer selection dialog.''
+
     ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<cargo_name>.sii}}        ''Defining one cargo data.''
−
        ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<cargo_accessory>.sii}}  ''SII file defining cargo model hookup for this trailer.''
+
     └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                     ''Rest of unique cargo definitions.''
−
        ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                    ''More SII files defining cargo models available for second trailer.''
 
−
        └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=chassis.sii}}            ''Defines chassis model of the trailer.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<trailer_2>}}              ''Folder for cargo hookup and chassis definition of second trailer.''
 
−
        └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=chassis.sii}}         
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}                      ''The rest of the trailers folders for defining their cargo hookups and chassis.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<trailer_1>.sii}}          ''Trailer definition for player usage referencing just chassis file from "'''<trailer_1>'''" folder.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<trailer_1_cargo>.sii}}    ''Trailer definition for player usage referencing chassis and cargo hookup file from "'''<trailer_1>'''" folder.''
 
−
       ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<trailer_2>.sii}}          ''Second trailer definition for player usage referencing chassis from "'''<trailer_1>'''" folder.''
 
−
      ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<trailer_2_traffic>.sii}}  ''Second trailer definition for AI traffic referencing chassis from "'''<trailer_2>'''" folder.''
 
−
      └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                      ''The rest of definition files defining other trailers.''
 
−
 
 
−
</div>
 
−
 
 
−
==== Player trucks definitions ====
 
−
 
 
−
Player truck definitions are containing all definitions that defines trucks that player can use in game and accessories for them.
 
−
 
 
−
For more information see the dedicated page: [[/Player trucks definitions|Player trucks definitions]].
 
−
 
 
−
=== World definitions ===
 
−
 
 
−
Defines all world items that can be placed on the map with Map Editor and their behaviour. All of the different item types have their own definition file where items of the same type are defined.
 
−
 
 
−
While defining new world items alternative infixed naming of SII file shall be used e.g. for defining new static models infixed file example would be: "'''model.mymod.sii'''".
 
−
 
 
−
<div class="folder_structure">
 
−
 
 
−
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|link=#Root game folder}}  
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=def|link=#Definitions}}
 
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=world|mark_current=1}}
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=building_model.sii}}          ''Defines continuous models that can be used as curve path profile models.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=building_scheme.sii}}        ''Defines schemas for curve path building items  (hedges, fences, electro wirings, tree avenues ...). In Map Editor used as '''Buildings''' item type.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=detail_vegetation.sii}}      ''Defines global detail vegetation data.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=detail_vegetation_def.sii}}  ''Defines detail vegetation models to texture assignments.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=hinge.sii}}                  ''Currently unused. It defined object that could be placed on map and be swung by player truck e.g. swing doors.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=model.sii}}                  ''Defines static map models which can be in Map Editor used as '''Models''' item type.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=model.custom.sii}}            ''Obsolete. Used only for backward compatibility.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=mover.sii}}                  ''Defines map models with animations which can be in Map Editor used as '''Movers''' or '''Walkers''' item type.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=overlay.sii}}                ''Defines overlay names for cities and roads.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=overlay.custom.sii}}          ''Obsolete. Used only for backward compatibility.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=prefab.sii}}                  ''Defines prefab map models like companies, gas stations, dealers, crossings. In Map Editor used as '''Prefabs''' item type.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=prefab.custom.sii}}          ''Obsolete. Used only for backward compatibility.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=railing.sii}}                ''Defines side roads elements like: crash barriers, anti noise barriers etc.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=road.sii}}                    ''Basic road data definition like different road lines lengths.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=road_edge.sii}}              ''New template road system edge definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=road_look.sii}}              ''Old road system definitions. In Map Editor used as '''Road''' item type.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=road_look.template.sii}}      ''New template road system definitions. In Map Editor used as '''Road''' item type.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=road_material.sii}}          ''Old road system materials definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=road_sidewalk.sii}}          ''Old road system side walk definitions.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=semaphore_model.sii}}        ''Defines semaphore models that can be used in semaphore profiles.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=semaphore_profile.sii}}      ''Defines semaphore profiles which can be assigned to prefabs models. Used in Blender Tools or Maya.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=sign.sii}}                    ''Defines road signs. In Map Editor used as '''Sign'' item type.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=sign.custom.sii}}            ''Obsolete. Used only for backward compatibility.''
 
−
     ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=sound_item_data.sii}}        ''Defines sound items that can be placed on map and will be triggered once player comes near. In Map Editor used as '''Sound''' item type.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=stamp.sii}}                   ''Defines stamp brushes for brushing in Map Editor. They are used with '''Brush''' tool.''
 
−
     ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=terrain_material.sii}}        ''Defines terrain materials paths. Used indirectly on more map items through their properties.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=terrain_profile.sii}}        ''Defines terrain profiles that can be used on the sides of the road. Used indirectly on road items through properties.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=traffic_lane.sii}}            ''Defines general traffic lanes data like: allowed vehicles types, spawn count limits and frequencies.''
 
−
     ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=traffic_rules.sii}}          ''Defines traffic rules that can be used on ''Traffic area''' items in Map Editor. Additionally they can be used while creating prefab model using Blender Tools or Maya.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=traffic_rules.compat.sii}}   ''Obsolete. Used only for backward compatibility.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=trigger_action.sii}}          ''Defines action triggers that can be used to trigger different commands in game. Used in Blender Tools or Maya while creating prefab model.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=vegetation.sii}}              ''Defines vegetation profiles that can be used on road sides. In Map Editor they are used indirectly from properties of '''Road''' item type.''
 
−
    ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=vegetation_model.sii}}        ''Defines tree and bush vegetation models for usage in '''vegetation.sii''' file.''
 
−
    └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=vegetation_old.sii}}          ''Obsolete. Used only for backward compatibility.''
 
−
 
 
 
</div>
 
</div>
  
 
== Fonts ==
 
== Fonts ==
  
−
Folder for storing game fonts. Mostly used in UI and inside vehicle dashboard displays.
+
Folder for storing game fonts.
  
 
<div class="folder_structure">
 
<div class="folder_structure">
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root Game Folder|link=#Root game folder}}
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root Game Folder|link=#Root game folder}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=font|mark_current=1}}
+
  ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=font}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=license_plate}}            ''Fonts used by licence plates.''
+
    ├─{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=license_plate}}            ''Fonts used by licence plates.''
−
  └{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sign}}                      ''Fonts used by road signs.''
+
    └─{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sign}}                      ''Fonts used by road signs.''
 
</div>
 
</div>
  
Line 426: Line 154:
 
<div class="folder_structure">
 
<div class="folder_structure">
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root Game Folder|link=#Root game folder}}
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root Game Folder|link=#Root game folder}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=material|link=#Predefined materials|mark_current=1}}
+
  ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=material|link=#Predefined materials}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}                 
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=custom}}                   ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=editor}}         ''Map Editor background textures.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=decal}}                    ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=environment}}     ''Environmental cube maps used for reflections.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=deferred}}                ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=editor}}                   ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=logo}}           ''Textures for in game company logos & SCS Software logos.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=environment}}             ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=flags}}                    ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=road}}           ''Textures & materials for roads. Folder supports material aliasing.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=logo}}                     ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=metal}}                   ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sign}}           ''Texture atlases & frames for new sign system.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=overlay}}                  ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=special}}         ''Special purposes texture atlases.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=prefab}}                   ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=terrain}}         ''Terrain textures & materials e.g. for grass, sand, water. Folder supports material aliasing.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=road}}                     ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=tiled}}           ''Collection of tillable textures.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=rocks}}                    ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}}             ''Textures and materials used by UI such like buttons, windows, icons etc.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ropes}}                   ''Lorem ipsum..''
−
  └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=material.db}}     ''Physical materials (substances) database. Names of this substances may be used on materials attribute called "Substance".''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sign}}                     ''Lorem ipsum..''
 +
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=special}}                 ''Lorem ipsum..''
 +
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=terrain}}                 ''Lorem ipsum..''
 +
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=tiled}}                   ''Lorem ipsum..''
 +
    └─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}}                       ''Lorem ipsum..''
 
</div>
 
</div>
  
Line 449: Line 181:
 
<div class="folder_structure">
 
<div class="folder_structure">
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root Game Folder|link=#Root game folder}}
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root Game Folder|link=#Root game folder}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sound|mark_current=1}}
+
  ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sound}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ai}}                      ''Sounds used by AI Traffic vehicles such like engine sounds, horns and sirens.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ai}}                      ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=environment}}            ''Environment ambient loops.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=environment}}            ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=mover}}                  ''Sounds produced by mover objects in game.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=mover}}                  ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=music}}                  ''Music used in many places for example during cutscenes.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=music}}                  ''Lorem ipsum..''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck}}                  ''Truck related sounds such like engine sounds, crash sounds, trailer attach sounds etc.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck}}                  ''Lorem ipsum..''
−
  └{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}}                      ''Sound effects used when user is interacting with the UI. For example click on the UI element.''
+
    └─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}}                      ''Lorem ipsum..''
 
</div>
 
</div>
  
Line 464: Line 196:
 
<div class="folder_structure">
 
<div class="folder_structure">
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=[[#Root game folder|Root Game Folder]]}}
 
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=[[#Root game folder|Root Game Folder]]}}
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui|mark_current=1}}
+
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ui}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=company_manager}}        ''Company manager UI layouts.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=company_manager}}        ''Company manager UI layouts.''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=dashboard}}              ''Truck dashboard UI layouts.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=dashboard}}              ''Truck dashboard UI layouts.''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=desc}}                    ''UI descriptors.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=desc}}                    ''UI descriptors.''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=editor}}                  ''Editor UI layouts.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=editor}}                  ''Editor UI layouts.''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=license_plate}}          ''Licence plate UI layouts.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=license_plate}}          ''Licence plate UI layouts.''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=options}}                ''Options screens UI layouts.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=options}}                ''Options screens UI layouts.''
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=template}}                ''UI templates (definitions of the controls look).''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=template}}                ''UI templates (definitions of the controls look).''
−
  └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                    ''UI window layouts for all in game windows.''
+
    └─ {{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}}                    ''UI window layouts for all in game windows.''
 
</div>
 
</div>
  
Line 478: Line 210:
  
 
<div class="folder_structure">
 
<div class="folder_structure">
−
  {{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=[[#Root game folder|Root Game Folder]]}}
+
  [[#Root game folder|Root Game Folder]]  
−
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle|mark_current=1}}
+
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ai}}         ''AI traffic vehicles models and resources of all types: cars, trucks, buses, trains.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ai}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=driver}}    ''Driver models for usage in AI traffic vehicles.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=driver}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=share}}     ''Shared texture resources for vehicles.''
+
     ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=share}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=trailer*}}   ''Models and resources for player and AI traffic trailers. (*)- for ETS2 there will be "'''trailer_eu'''" instead.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=trailer*}}
−
  ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck}}     ''Player trucks vehicles models and resources.''
+
    ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck}}
−
  └{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=wheel}}     ''Models and resources for all vehicle wheels except wheels for player trucks.''
+
    └─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=wheel}}
 
</div>
 
</div>
 +
 +
[[Category:TODO]]

Revision as of 13:48, 7 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 folder 
├def
  ├animated_model                Directory with definitions for animated models triggered when distance to player is small enough.
  ├camera                        See: Camera Definitions
  ├cargo                         See: Cargo Definitions
  ├city
  ├climate
  ├company
  ├country
  ├desktop
  ├ferry
  ├initial_save
  ├jobs
  ├regional_settings
  ├sign
  ├stamp
  ├vehicle
  ├world
  ├aux_lamp_colors.sii           Defines players vehicle auxiliary light mask colors. 
  ├bank_data.sii                 Bank loans configuration.
  ├car_colors.sii                Defines colors for AI traffic cars.
  ├cargo.sii                     Storage of cargoes for trailer generation. When defining your own cargoes use infixed version of this Sii file for example: "cargo.my_mod.sii".
  ├city.sii                      Storage of cities in game. When defining your own cities use infixed version of this Sii file for example: "city.my_mod.sii".
  ├climate.sii                   Storage of climate profiles. When defining your own climate use infixed version of this Sii file for example: "climate.my_mod.sii".
  ├company.sii                   Storage of companies that can be used in game. When defining your own companies use infixed version of this Sii file for example: "company.my_mod.sii".
  ├...
  ├country.sii                   Storage of countries used in game. When defining your own countries use infixed version of this Sii file for example: "country.my_mod.sii".
  ├...
  ├economy_data.sii              Game economy definition.
  ├...
  ├env_data.sii                  Environment global configuration such as day in the year. << TODO: This is not clean enough for me.
  ├...
  ├ferry.sii                     Storage of ferry ports. When defining your own cargoes use infixed version of this Sii file for example: "ferry.my_mod.sii".
  ├...
  ├game_data.sii                 Various global game definitions.
  ├hdr.sii                       High dynamic range effect definitions.
  ├...
  ├job_trailer_preview.sii       Scene setup for generating preview images of trailers in freight market.
  ├job_truck_preview.sii         Scene setup for generating preview images of trucks in quick jobs.
  ├job_wotr_trailer_preview.sii  Scene setup for generating preview images of trailers in WOTR contracts.
  ├...
  ├mail_data.sii                 Defines players mails.
  ├photo_camera_data.sii         Configuration of Photo Mode camera.
  ├...
  ├police_data.sii               Defines player offences: fine amounts, offence check delay.
  ├...
  ├sound_player.sii              Defines sounds for UI actions and global game sounds.
  ├...
  ├traffic_data.sii              Defines different AI traffic data: total AI max count, yield attributes, safety distances etc.
  ├traffic_light_lamp_colors.sii Defines mask colors for traffic lights.
  ├trailer_preview_scene.sii     Defines scene configuration parameters for Trailer Browser.
  ├...
  ├truck_colors.sii              Defines colors for AI traffic trucks.
  ├truck_config_scene.sii        Defines scene configuration parameters for Upgrade Shop & Truck Browser.
  ├truck_dealer_scene.sii        Defines scene configuration parameters for Truck Dealers.
  ├...
  └vehicle_lamp_colors.sii       Defines players vehicle light mask colors.

Camera Definitions

Camera definitions directory ("/def/camera") is using "camera_storage(.infix).sii" files as storage files defining cameras that can be used by player while in game (UI interface is not handled by cameras, as UI is drawn directly on screen 2D plane). Note that this defines only storage for available in game cameras, but which camera is used in the game depends on currently user selected view and current used player vehicle.

Beside storage files camera definitions folder also includes "cutscene.sii" file which defines camera and it's movement in different cut-scenes. 

Root game folder 
├def
  ├camera
    ├...                        Directories for cut scenes camera definitions.
    ├ui                         Directory for storing camera movement definitions related to game desktop (main menu).
    ├units                      Directory for storing players camera included in "camera_storage" Sii files.
    ├camera_storage.sii         Defining cameras storage that can be used in game by player. When creating your own cameras use infixed storage file name like: "camera_storage.mymod.sii".
    ├camera_storage.oculus.sii  Same as camera_storage.sii with purpose of defined cameras for Oculus Rift head set.
    └cutscene.sii               Defines cut scene data for each type.

Cargo Definitions

Unique cargo is defined by Sii file and directory with one or more Sii files defining trailers which can carry this cargo. So for each cargo you have one Sii file inside "/def/cargo/" and one or multiple Sii files inside folder "/def/cargo/<cargo_name>/". Example definition for cargo: "<cargo_name>" is shown in the tree below. 

Root game folder 
├def
  ├cargo
    ├<cargo_name>             Directory defining trailers that can carry cargo defined in "<cargo_name>.sii" file.
      ├trailer.unit.name.sii  Defines trailer that can carry this cargo. Sii file is named by trailer SiiUnit name
      └...                    More definitions for different trailers carrying this cargo.
    ├...                      Rest of cargo trailer definition folders.
    ├<cargo_name>.sii         Defining one cargo data.
    └...                      Rest of unique cargo definitions.

Fonts

Folder for storing game fonts. 

Root Game Folder
├─ font
   ├─license_plate             Fonts used by licence plates.
   └─sign                      Fonts used by road signs.

Predefined materials

Library of predefined materials and textures. 

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

Sounds

Library of sounds used by game. 

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

UI definitions

Library of all UI layouts and control definitions including vehicle dashboards. 

Root Game Folder
 ├ui
   ├─ company_manager         Company manager UI layouts.
   ├─ dashboard               Truck dashboard UI layouts.
   ├─ desc                    UI descriptors.
   ├─ editor                  Editor UI layouts.
   ├─ license_plate           Licence plate UI layouts.
   ├─ options                 Options screens UI layouts.
   ├─ template                UI templates (definitions of the controls look).
   └─ ...                     UI window layouts for all in game windows.

Vehicle model resources

Root Game Folder 
 ├vehicle
   ├─ ai
   ├─ driver
   ├─ share
   ├─ trailer*
   ├─ truck
   └─ wheel
Retrieved from "https://modding.scssoft.com/index.php?title=Documentation/Engine/Game_data&oldid=2313"