Changes

Jump to navigation Jump to search

Documentation/Engine/Game data

5,167 bytes added, 12:15, 22 November 2018
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=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=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=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=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=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=sound_player.sii}} ''Defines sounds for UI actions and global game sounds.''
├{{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|Players truck 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-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.''
</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 ===
Player truck definitions are containing Defines all definitions world items that configures trucks can be placed on the map with Map Editor and their accessories that player can use in gamebehaviour. All of the different item types have their own definition file where items of the same type are defined.
Each truck is configured in it's own subfolder containingWhile 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:* "''data'model.mymod.sii'''" file for basic rules and data of the truck (cameras, required accessories and fallback rules for mandatory parts of the truck.* subfolders defining different parts and accessories of the truck.
<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=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=#Vehicle definitions|name=detail_vegetation_def.sii}} ''Defines detail vegetation models to texture assignments.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=hinge.sii}} ''Currently unused. It defined object that could be placed on map and be swung by player trucke.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=|mark_currentname=model.custom.sii}} ''Obsolete. Used only for backward compatibility.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=1mover.sii}} ''Defines map models with animations which can be in Map Editor used as '''Movers''' or '''Walkers''' item type.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=<brandoverlay.truck>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-IconFolderIconFileSii|type=|name=accessoryrailing.sii}} ''Defines side roads elements like: crash barriers, anti noise barriers etc.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=cabinroad.sii}} ''Basic road data definition like different road lines lengths.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=chassisroad_edge.sii}} ''New template road system edge definitions.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=engineroad_look.sii}} ''Old road system definitions. In Map Editor used as '''Road''' item type.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=headlightroad_look.template.sii}} ''New template road system definitions. In Map Editor used as '''Road''' item type.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=interiorroad_material.sii}} ''Old road system materials definitions.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=paint_jobroad_sidewalk.sii}} ''Old road system side walk definitions.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=soundsemaphore_model.sii}} ''Defines semaphore models that can be used in semaphore profiles.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=transmissionsemaphore_profile.sii}} ''Defines 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'' item type.'' ├{{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=<brand1sign.custom.truck>sii}} ''Obsolete. Used only for backward 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}} ''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=common_sound_extterrain_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_ext_datatraffic_lane.suisii}} ''Defines general traffic lanes data like: allowed vehicles types, spawn count limits and frequencies.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=common_sound_inttraffic_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=common_sound_int_datatraffic_rules.suicompat.sii}} ''Obsolete. Used only for backward compatibility.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<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=<brand1_truck>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}}
├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=font|mark_current=1}} ├─{{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.''
</div>
<div class="folder_structure">
{{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=custom}} ''Lorem ipsum..'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=decal}} ''Lorem ipsum..'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=deferred}} ''Lorem ipsum..'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=editor}} ''Lorem ipsum.Map Editor background textures.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=environment}} ''Lorem ipsum.Environmental cube maps used for reflections.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=flags...}} ''Lorem ipsum..'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=logo}} ''Logos of the Textures for in game, company logos & SCS Software and libraries used by the gamelogos.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=metal...}} ''Lorem ipsum..'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=overlayroad}} ''Lorem ipsumTextures & materials for roads.Folder supports material aliasing.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=prefab}} ''Lorem ipsum..'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=road.}} ''Lorem ipsum..'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=rockssign}} ''Lorem ipsum.Texture atlases & frames for new sign system.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=ropesspecial}} ''Lorem ipsum.Special purposes texture atlases.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=signterrain}} ''Lorem ipsumTerrain textures & materials e.g.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=special}} ''Lorem ipsumfor grass, sand, water.Folder supports material aliasing.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=terraintiled}} ''Lorem ipsum.Collection of tillable textures.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=tiledui}} ''Lorem ipsum.Textures and materials used by UI such like buttons, windows, icons etc.'' └─ {{FileSystemTreeEntry|icon=FST-IconFolderIconFileSii|type=|name=uimaterial.db}} ''Textures and Physical materials (substances) database. Names of this substances may be used by UI such like buttons, windows, icons etcon materials attribute called "Substance".''
</div>
<div class="folder_structure">
{{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=ai}} ''Sounds used by AI Traffic vehicles such like engine sounds, horns and sirens.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=environment}} ''Environment ambient loops.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=mover}} ''Sounds produced by mover objects in game.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=music}} ''Music used in many places for example during cutscenes.'' ├─ {{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=ui}} ''Sound effects used when user is interacting with the UI. For example click on the UI element.''
</div>
<div class="folder_structure">
{{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=company_manager}} ''Company manager 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=editor}} ''Editor 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=template}} ''UI templates (definitions of the controls look).'' └─ {{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''UI window layouts for all in game windows.''
</div>
<div class="folder_structure">
{{FileSystemTreeEntry|icon=FST-IconRoot|type=|name=[[#Root game folder|Root Game Folder]]}}
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=vehicle|mark_current=1}} ├─ {{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=driver}} ''Driver models for usage in AI traffic vehicles.'' ├─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=share}} ''Shared texture resources for vehicles.'' ├─ {{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=truck}} ''Player trucks vehicles models and resources.'' └─ {{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=wheel}} ''Models and resources for all vehicle wheels except wheels for player trucks.''
</div>
 
[[Category:TODO]]

Navigation menu