1,740
edits
Changes
no edit summary
{{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.
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root game folder|mark_current=1}}
├{{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 TODO: wait for confirmation.'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=custom}} ''Legacy folder for storing custom/modded definitions (NOTE: This folder is deprecated obsolete 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=dlc}} ''Shared models used by dlc such like "dead end" sign.''
├{{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=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=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=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-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.'' << 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=police_data.sii}} ''Defines player offences: fine amounts, offence check delay.''
├...
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=sound_player.sii}} ''Defines sounds for UI actions and global game sounds.''
├{{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-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'''".''
==== 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 "'''trailer_storage_semi_trailertraffic_storage_semi_trailer(.infix).sii'''" files or custom type of AI trailers storage file.
{{Note|Difference between AI trailer trailers and players trailer is in player trailers are handled somewhat differently. Player trailers use the type of SiiUnit in trailer definition file, where players trailer SiiUnit name is "'''trailer'''" and AI SiiUnit class with a naming convention of <code>trailer SiiUnit .<name is ></code>, while AI trailers use the "'''traffic.trailertraffic_trailer'''"SiiUnit class and a naming convention of <code>traffic.trailer.<name></code>.}}
<div class="folder_structure">
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=trailer|mark_current=1}}
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<trailer_1>}} ''Folder for cargo hookup and chassis definition of first trailer.''
├{{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=<trailer_look>.sii}} ''Defines paint job for companies with corresponding trailer_look attribute. (eg plain, trameri, etc)''
├{{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_accessory>.sii}} ''SII file defining cargo model hookup for this trailer.''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''More SII files defining cargo models available for second trailer.''
==== Player trucks definitions ====
Player truck definitions are containing all definitions that configures defines trucks and their accessories that player can use in gameand accessories for them.
<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=vehicleworld|linkmark_current=1}} ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=#Vehicle definitionsbuilding_model.sii}} ''Defines continuous models that can be used as curve path profile models.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=truckbuilding_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=|mark_currentname=1detail_vegetation.sii}} ''Defines global detail vegetation data.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=<branddetail_vegetation_def.truck>sii}} ''Truck main configuration folderDefines detail vegetation models to texture assignments.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=accessoryhinge.sii}} ''Folder for defining all accessory types which can Currently unused. It defined object that could be installed placed on this map and be swung by player trucke.g. swing doors.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=beaconmodel.sii}} ''Defines static map models which can be in Map Editor used as '''Models'''Folder for defining accessory of item type "beacon".'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=single_beaconmodel.custom.sii}} ''File defining one beacon modelObsolete. 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}} ''More beacon models definition filesDefines overlay names for cities and roads.'' └ ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|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''Folders defining more accessory types and it's model definitionsitem type.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=cabinprefab.custom.sii}} ''Folder with SII files defining cabin mandatory truck part; one cabin per one SII fileObsolete. Used only for backward compatibility.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=chassisrailing.sii}} ''Folder with SII files defining chassis mandatory truck part; one chassis per one SII fileDefines side roads elements like: crash barriers, anti noise barriers etc.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=engineroad.sii}} ''Folder with SII files defining engine mandatory truck part; one engine per one SII fileBasic 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-IconFolderIconFileSii|type=|name=head_lightroad_look.sii}} ''Old road system definitions. In Map Editor used as ''Folder with SII files defining head light mandatory truck part; one head light 'Road''' item type per one SII file.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=interiorroad_look.template.sii}} ''New template road system definitions. In Map Editor used as '''Road''Folder with SII files defining interior mandatory truck part, it's animations, dashboard colors and glass data; one interior per one SII fileitem type.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=paint_jobroad_material.sii}} ''Folder with SII files defining paint job mandatory truck part; one paint job per one SII fileOld road system materials definitions.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=soundroad_sidewalk.sii}} ''Folder with SII files defining sound mandatory truck partOld road system side walk definitions.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=semaphore_model. There should sii}} ''Defines semaphore models that can be at least two SII files: one for interior and second for exterior sounds definitionused in semaphore profiles.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=transmissionsemaphore_profile.sii}} ''Folder with SII files defining transmission mandatory truck part; one transmission per one SII fileDefines semaphore profiles which can be assigned to prefabs models. Used in Blender Tools or Maya.'' └ ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=datasign.sii}} ''Defines road signs. In Map Editor used as '''Sign''Defining truck global data: info, cameras and fallback rulesitem type.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=<2nd_brandsign.truck>custom.sii}} ''Folder defining second truck with the same structure folder structure as Obsolete. Used only for first truck examplebackward compatibility.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|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}} ''Folders Defines stamp brushes for defining more trucksbrushing in Map Editor. They are used with '''Brush''' tool.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=common_sound_extterrain_material.suisii}} ''Defines terrain materials paths. Used indirectly on more map items through their properties.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=common_sound_ext_dataterrain_profile.suisii}} ''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=common_sound_inttraffic_lane.suisii}} ''Defines general traffic lanes data like: allowed vehicles types, spawn count limits and frequencies.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=common_sound_int_datatraffic_rules.suisii}} ''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=<brand_truck>traffic_rules.compat.sii}} ''Obsolete. Used only for backward compatibility.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<2nd_brand_truck>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>
== Fonts ==
Folder for storing game fonts. Mostly used in UI and inside vehicle dashboard displays.
<div class="folder_structure">
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root Game Folder|link=#Root game folder}}
</div>
<div class="folder_structure">
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root Game Folder|link=#Root game folder}}
</div>
<div class="folder_structure">
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=Root Game Folder|link=#Root game folder}}
</div>
<div class="folder_structure">
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=[[#Root game folder|Root Game Folder]]}}
</div>
<div class="folder_structure">
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=[[#Root game folder|Root Game Folder]]}}
</div>