Changes

Jump to navigation Jump to search

Documentation/Engine/Game data/Player trucks definitions

4,463 bytes added, 01:46, 10 March 2017
Restructured article and added wikilinks to relevant unit definitions.
Player trucks are defined using two complementary systems of unit definitions. [[#Data_Definitions|Data 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_and_Dealer_Definitions|Vehicle definitions are containing all ]] configure the data definitions into a vehicle that defines trucks that player can use in may be driven or purchased. Think of them as the instructions for the game and accessories for themto assemble the building blocks (data definitions) into a vehicle when it is first loaded.
==Data Definitions== Each truck is configured in it's 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 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 user can install in game Upgrade Shop. This folder holds another level of sub folders for separating different accessory types that player can install on the truck and will be listed in Upgrade Shop once player selects proper accessory type. Moreover names of subfolders directly correspond to the names of model locators truck 3D model has to have for ability of having that types of accessories enabled in the game.''
 
Still this configurations are not enough to have truck shown up in the game. For proper inclusion of truck in the game, truck initial configuration files have to be created for:
# Dealers inside folder: "'''/def/vehicle/truck_dealer/'''" (if truck has RHD variant also in UK dealers folder: "'''/def/vehicle/truck_dealer_uk/'''").
# Desktop preview inside folder: "'''/def/vehicle/truck_desktop/'''" (if truck has RHD variant also in UK dealers folder: "'''/def/vehicle/truck_desktop_uk/'''").
# Quick Jobs trucks inside folder (optionally): "'''/def/vehicle/truck_company/'''" (if truck has RHD variant also in UK dealers folder: "'''/def/vehicle/truck_company_uk/'''").
<div class="folder_structure">
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck|mark_current=1}}
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<brand.truck>}} ''Truck main configuration folder.''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=accessory}} ''Folder for defining all [[Documentation/Engine/Units/accessory_addon_data|accessory ]] types which can be installed on this truck.'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=beacon}} ''Folder for defining accessory accessories of the type "beacon".''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=shape1.sii}} ''File defining one beacon model which can be named freely (no restriction applies on SII file naming inside accessory type).''
└{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''More beacon models definition files.''
└{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=...}} ''Folders defining more accessory types and it's model definitions.''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=cabin}} ''Folder with SII files defining [[Documentation/Engine/Units/accessory_cabin_data|cabin ]] mandatory truck part; one cabin per one SII file.'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=chassis}} ''Folder with SII files defining [[Documentation/Engine/Units/accessory_chassis_data|chassis ]] mandatory truck part; one chassis per one SII file.'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=engine}} ''Folder with SII files defining [[Documentation/Engine/Units/accessory_engine_data|engine ]] mandatory truck part; one engine per one SII file.'' ├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=head_light}} ''Folder with SII files defining [[Documentation/Engine/Units/accessory_head_lights_data|head light ]] mandatory truck part; one head light type per one SII file.'' ├{{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: one for '' ├{{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 and second for exterior sounds .'' └{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''Additional sound definitionfiles (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_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).''
 
</div>
 
==Vehicle and Dealer Definitions==
 
There are three types of player truck configurations, depending on their use in the game:
# Dealers inside folder: "'''/def/vehicle/truck_dealer/'''" (if truck has RHD variant also in UK dealers folder: "'''/def/vehicle/truck_dealer_uk/'''").
# Desktop preview inside folder: "'''/def/vehicle/truck_desktop/'''" (if truck has RHD variant also in UK dealers folder: "'''/def/vehicle/truck_desktop_uk/'''").
# (Optional) Quick Jobs trucks inside folder: "'''/def/vehicle/truck_company/'''" (if truck has RHD variant also in UK dealers folder: "'''/def/vehicle/truck_company_uk/'''").
 
<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=...}}
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_company}} ''Truck configurations for Quick Jobs.''
├{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=some_truck_a.sii}} ''Quick Job truck configuration. There are no naming restrictions, but be wary of naming collisions.''
└{{FileSystemTreeEntry|icon=FST-IconFileSii|type=|name=...}} ''Additional Quick Job truck configurations''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=truck_company_uk}} ''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 configurations.''
├{{FileSystemTreeEntry|icon=FST-IconFolder|type=|name=<brand>}} ''Contains truck configurations. The name of the folder is not restricted.''
├{{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=...}}
</div>
309
edits

Navigation menu