Difference between revisions of "Games/ETS2/Modding guides"

From SCS Modding Wiki
Jump to navigation Jump to search
(Patch: 1.20)
(Patch: 1.19)
Line 22: Line 22:
 
* [[Games/ETS2/Modding Guides/1.9]]
 
* [[Games/ETS2/Modding Guides/1.9]]
 
* [[Games/ETS2/Modding Guides/1.4.1]]
 
* [[Games/ETS2/Modding Guides/1.4.1]]
 
= Patch: 1.19 =
 
 
== Recommendations ==
 
<ul>
 
<li> Some new models utilizing the "fr" suffix or prefix are still work in progress and it is likely that they might change significantly in some next patch. For this reason it is recommended that you avoid using them in your mods at this time.
 
</li> <li> When basing you model on the original ones, add to your mod also <strong>ALL</strong> original /automat/ files used by it. The names of the files are generated as SHA1 hash of theirs content so whenever we change the parameters of the material in any way, a different file will be used to store them and the original file might cease to exist if there is no other model utilizing the original parameters.
 
</li> <li> When modifying original models, always include <strong>ALL</strong> compoments of the model (pmg+pmd) instead of just those you changed. Otherwise you risk crash if we change the model.
 
</li> <li> As always when adding new objects to files which support multi-file approach (e.g. road_look.sii) it is <strong>HIGHLY RECOMMENDED</strong> to use suffix or prefix in the name to avoid conflicts with new objects we are adding in patches. Otherwise you might have to use the batch renaming functionality (see Batch renaming) to fix the conflicts when new patch appears.
 
</li>
 
</ul>
 
 
== How to convert map ==
 
<ul>
 
<li> If your mod overrides <strong>signs.sii</strong> or <strong>sign.dlc_north.sii</strong>, you need to update those files to account for us moving some signs from DLC Scandinavia to base.
 
</li> <li> Convert AI model storage definitions to the new format
 
</li> <li> Convert the road look definitions to the new format.
 
</li> <li> Convert the speed limit and license plate definitions in country data to the new format.
 
</li>
 
</ul>
 
 
== Changes ==
 
=== Traffic-related changes ===
 
==== AI vehicle model storage ====
 
For each supported vehicle type (currently: <strong><em>car, truck, bus</em></strong>) a separate unit exists in <strong>/def/vehicle/traffic_vehicle_type.sii</strong>. These units contain paths to actual model storage for given vehicle type (e.g.<strong> /def/vehicle/traffic_storage_car.sii</strong>)
 
 
==== AI trailer model storage ====
 
For each supported trailer type (currently: <strong><em>semi_trailer</em></strong>) a separate unit exists in <strong>/def/vehicle/traffic_trailer_type.sii</strong>. These units contain paths to actual model storage for given trailer type (e.g.<strong> /def/vehicle/traffic_storage_semi_trailer.sii</strong>)
 
 
==== AI vehicle definition ====
 
Property <strong>attachable</strong> is now obsolete. It has been replaced by an array attribute <strong>attachable_trailer</strong>. The array contains unit names (as strings) of all trailer models which can be attached to the given vehicle.
 
 
To allow <strong>all</strong> trailer models, add an empty string at the beginning of the array:
 
 
<code>attachable_trailer[]: ""</code>
 
 
==== AI trailer definition ====
 
To allow future features and improvements, the type of the unit defining an AI trailer <strong>CHANGED FROM</strong> <code>trailer</code> <strong>TO</strong> <code>traffic_trailer</code>
 
 
For example:
 
 
<code>trailer : traffic.trailer.fuel_cistern</code>
 
 
changes to
 
 
<code>trafic_trailer : traffic.trailer.fuel_cistern</code>
 
 
==== Road look definition ====
 
The <strong>lane_count_left</strong>, <strong>lane_count_right</strong> and <strong>ai_speed_type</strong> attributes are now obsolete. They were replaced by <strong>lanes_left</strong> and <strong>lanes_right</strong> arrays. (The array items are ordered from the center of the road to the borders) This allows specifying some traffic lane attributes for each lane separately - see "<em>Traffic lane definition</em>"
 
 
==== Traffic lane definition ====
 
Traffic lane definitions can be found in <strong>/def/world/traffic_lane.sii</strong>.
 
 
==== License plate definition ====
 
The definitions of per-country license plates were moved into separate <strong>/def/country/&lt;country_name&gt;/license_plates.sii</strong> file. It contains separate unit for each vehicle type (car, truck, bus). If more than one unit exists for some type, the game will use the first unit it encounters.
 
 
==== Country speed limit definition ====
 
The definitions of per-country speed limits were moved into separate <strong>/def/country/&lt;country_name&gt;/speed_limits.sii</strong> file. It contains separate unit for each vehicle type (car, truck, bus). If more than one unit exists for some type, the game will use the first unit it encounters.
 
 
 
=== Vehicle changes ===
 
==== Separate interior model ====
 
The cabin interior now uses separate model for rendering from external views. That model is defined using new <strong>ext_model</strong>, <strong>ext_variant</strong> and <strong>ext_look</strong> attributes of interior accessory.
 
 
=== Editor changes ===
 
<ul>
 
<li> <span style="background-color: transparent;">The toolbar window and editor window were combined into one.</span>
 
</li> <li> <span style="background-color: transparent;">Editor window can be resized, docked, maximized.</span>
 
</li> <li> <span style="background-color: transparent;">Resolution can be choosed from menu View &gt; Resolution.</span>
 
</li> <li> <span style="background-color: transparent;">Mouse cursor behaves significantly better.</span>
 
</li> <li> <span style="background-color: transparent;">Free camera can be rotated with right mouse button (RMB).</span>
 
</li> <li> <span style="background-color: transparent;">Several items can be combined into one by "Ctrl+G" or from menu Tools &gt; Compound Selection.</span>
 
</li></ul>
 
 
==== 3D move manipulator ====
 
<ul>
 
<li> <span style="background-color: transparent;">Editor contains 3D move manipulator ("gizmo").</span>
 
</li> <li> <span style="background-color: transparent;">Move manipulator can lock movement along one axis when X, Y or Z pressed.</span>
 
</li> <li> <span style="background-color: transparent;">Move manipulator can lock movement along one plane when Shift+X, Shift+Y or Shift+Z pressed.</span>
 
</li> <li> <span style="background-color: transparent;">Eg. </span><span style="background-color: transparent;">Shift+Y means that movement does not change in Y axis.</span>
 
</li>
 
</ul>
 
 
==== Grid ====
 
<ul>
 
<li> <span style="background-color: transparent;">Editor can render grid when enabled from menu View &gt; Grid.</span>
 
</li> <li> <span style="background-color: transparent;">On toolbar you can enable/disable Snap to grid and Snap to nodes.</span>
 
</li> <li> <span style="background-color: transparent;">Beware: Grid is placed in zero height, if you have items in different height, the snapping may seem weird as it is distorted by perspective.</span>
 
</li>
 
</ul>
 

Revision as of 15:58, 10 February 2016

With each new game patch we are also shipping modding guides for users to be able to get their existing mods up-to-date.

Page is organizing modding guides by patch version numbers.

Misc useful commands

  • Running the game with -unlimitedlog command line parameter will disable the standard 1MB limit on size of game log file. This might be useful during update if you want to focus on some bugs first.
  • Running the game with -validate command line parameter or executing validate command on the console will run special game mode which will load all defined models, prefabs, vehicles and other objects to detect missing textures and similar errors. By examining the game log you can determine what the game was trying to do when error appeared. Note that there is still lot of things which might be wrong which are not checked in this mode.
  • Running the game with -error_overlay command line parameter will show overlay with number of error and warning messages printed to the log once at least one such message is printed.

Patches