Changes

Jump to navigation Jump to search

Documentation/Engine/Game data/Player trucks definitions

556 bytes removed, 17:12, 13 December 2023
Vehicle Configurations: add folders for used trucks
Player truck definitions can be thought of in two components:
*[[#Parts_Data_DefinitionsVehicle_Parts_Definitions|Parts data Vehicle parts definitions]] describe the characteristics of the truck and its many accessories.
:-Think of these as a set of building blocks from which the truck can be built; They don't assemble themselves!
*[[#Vehicle_Configurations|Vehicle configurations]] assemble the parts definitions into a vehicle that may be driven or purchased.
:-Think of them as the instructions for the game to assemble the building blocks (data definitions) into a vehicle when it is first loaded.
==Vehicle Parts Data Definitions==
Each truck is configured in its own folder (e.g. "'''<brand.truck>'''" in tree view below) containing:
# SII file: '''data.sii''' - ''defining: truck info, cameras, fallback rules for parts of the truck and required accessories. There is are 8 mandatory fallback rules: chassis, cabin, interior, engine, transmission, f_wheel (or f_tire), r_wheel (or r_tire), paint_job and head_light''.
# Subfolders: ('''chassis''', '''cabin''', '''interior''', '''engine''', '''transmission''', '''paint_job''', '''head_light''', '''sound''') - ''defining different parts and accessories of the truck. First 7 folders are needed because of mandatory fallback rules and sound folder is needed for truck mandatory sounds definitions.''
# Optional folder: '''accessory''' - ''defining all possible accessories for the truck that the user can install in the game Upgrade Shop. This folder holds another level of sub folders for separating different accessory types that the player can install on the truck and will be listed in the Upgrade Shop once the player selects the proper accessory type. Moreover names of subfolders directly correspond to the names of model locators that the truck 3D model has to have for the ability of having that those types of accessories enabled in the game.''
<div class="folder_structure">
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=interior}} ''Folder with SII files defining [[Documentation/Engine/Units/accessory_interior_data|interior]] mandatory truck part, its [[Documentation/Engine/Truck_Interior_Animations_and_IDs#Interior_Animations|animations]], dashboard colors and glass data; one interior per one SII file.''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=paint_job}} ''Folder with SII files defining [[Documentation/Engine/Units/accessory_paint_job_data|paint job]] mandatory truck part; one paint job per one SII file.''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=sound}} ''Folder with SII files defining [[Documentation/Engine/Units/accessory_sound_data|sound]] mandatory truck part. There should be at least two SII files:''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<name>_ext.sii}} ''File defining exterior sounds.''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<name>_int.sii}} ''File defining interior sounds.''
└{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''Additional sound definition files (if applicable).''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=transmission}} ''Folder with SII files defining [[Documentation/Engine/Units/accessory_transmission_data|transmission]] mandatory truck part; one transmission per one SII file.''
└{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=data.sii}} ''Defining [[Documentation/Engine/Units/accessory_truck_data|truck global data]]: info, cameras and fallback rules.''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<2nd_brand.truck>}} ''Folder defining second truck having the same inner folder structure as first truck above.''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}} ''Folders for defining more trucks.''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=common_sound_ext.sui}} ''Defines common sounds list for exterior. This list has to be [[Documentation/Engine/Units#Includes|included]] in each truck exterior sounds definition file.''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=common_sound_ext_data.sui}} ''Defines common sounds data for "'''common_sound_ext.sii'''" list.''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=common_sound_int.sui}} ''Defines common sounds list for interior. This list has to be included in each truck interior sounds definition file.''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=common_sound_int_data.sui}} ''Defines common sounds data for "'''common_sound_int.sii'''" list.''
└{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=fallback.sii}} ''Configuration of fallback truck in the case player loads save with truck that is not in game data any more (may happen when truck mod is removed).''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_company}} ''Truck configurations for Quick Jobs.''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=double}} ''Truck configurations for doubles Quick Jobs (ETS2 Only)'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=heavy}} ''Truck configurations for heavy Quick Jobs'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=oversize}} ''Truck configurations for Special Transport Quick Jobs'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=some_truck_a&lt;brand&gt;_truck_a.sii}} ''Quick Job truck configurationconfigurations. There are no naming restrictions, but be wary of naming collisionsThe file name up to the first underscore is used for brand sorting.''
└{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''Additional Quick Job truck configurations''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_company_uk}} ''Truck Quick Job truck configurations for RHD trucks (UK related) Quick Jobs. (ETS2 Only)'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_dealer}} ''Contains dealer showroom configurations (sortiments) and folders containing truck configurationsin brand-specific subfolders..'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<&lt;brand>&gt;}} ''Contains truck configurations. The name of the folder is not restrictedshould be tokenizable and will be detected as a brand.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=some_truck.sii}} ''Dealer truck configuration. Do not use the <code>SiiNunit</code> magic mark because these are [[Documentation/Engine/Units#Includes|included]] into the sortiment.''
└{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''More dealer truck configurations. Typically one per file.''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<brand>.sii}} ''Sortiment defining default trucks in dealers of a specific brand. (ETS2 only)''
└{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=<brand>.<infix>.sii}} ''Additional sortiments defining trucks in dealers of a specific brand.''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_dealer_uk}} ''Defines assortment of RHD trucks for dealers and has the same structure as '''truck_dealer'''. (ETS2 only)''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_desktop}} ''Truck configurations used in Truck Browser.''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=some_truck.sii}} ''Desktop truck configuration. There are no naming restrictions, but be wary of naming collisions.''
└{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''Additional Desktop truck configurations''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_desktop_uk}} ''Truck configurations for RHD trucks used in Truck Browser if player started game in UK. (ETS2 only)'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_used}} ''Contains used truck configurations in brand-specific subfolders..'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=&lt;brand&gt;}} ''Contains truck configurations. The name of the folder should be tokenizable and will be detected as a brand.'' ├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=some_truck.sii}} ''Used truck configuration.'' └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''More used truck configurations. Typically one per file.'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_used_uk}} ''Defines assortment of used RHD trucks and has the same structure as '''truck_used'''. (ETS2 only)'' └{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}}
</div>
309
edits

Navigation menu