Documentation/Tools/SCS Blender Tools/Conversion Helper

From SCS Modding Wiki
Jump to: navigation, search


Conversion helper panel features tools for automated files conversion and mod packing. Panel with conversion helper can be found below Export Panel located within Scene tab in Blender properties window.

However before you use Conversion Helper you should download latest Conversion Tools for the game you want to create mod for. Also make sure you have checked Intended workflow images.

SCS Tools Conv Hlpr.png

Since BT v1.7 header of the conversion helper also features Clean Converted Data operator. This operator will immediately clean content that you converted before or is left there from some other time. In general this makes sure your mod won't have any unused resources (leftover textures, old materials) in the converted result. Same action can also be achieved while using Mod Packing with enabled Auto Clean option.

With BT v1.7 conversion tools also support switchable Custom Paths. Once they are enabled conversion helper panel gets extended as seen on image below.

SCS Tools Conv Hlpr Custom Paths.png

Custom Paths Usage

Custom Paths are holding list property for multiple custom paths that you want to convert at the same time. Use this custom paths if you want to merge resources from 2 or more different mods of yours. Example usage is shown in Intended workflow#Usual mod combined with dependency mod (using custom paths)

On the side of the list you can find operators for managing your custom paths:

  • SCS Tools Conv Hlpr Add Cstm Path.png - opens file selector where you should browse for new custom path you want to use.
  • SCS Tools Conv Hlpr Del Cstm Path.png - deletes currently selected custom path in the list.
  • SCS Tools Conv Hlpr Cstm Path Up.png - moves up currently selected custom path in the list. Ordering in the list doesn't have influence on converted result. It is only there so you can order paths however you like.
  • SCS Tools Conv Hlpr Cstm Path Down.png - moves down currently selected custom path in the list. Ordering in the list doesn't have influence on converted result. It is only there so you can order paths however you like.

Manual Conversion

While mod packing with Auto Convert already triggers automatic conversion before packing, one can still execute manual conversion. Currently there are three different variations:

  • CONVERT CURRENT SCS PROJECT - operator which will only convert resources in your currently set SCS Project Base Path.
  • CONVERT CUSTOM MAPS (seen and functional only if custom paths are enabled) - operator which converts resources only from defined custom paths.
  • CONVERT ALL (seen and functional only if custom paths are enabled) - operator which converts resources from custom paths + resources from currently set SCS Project Base Path.

Usage of manual conversion is recommended when you want to pack your mod later or by hand.

Mod Packing

This section is featuring properties and operators for packing a mod for SCS game.

First two options are specifying destination and name:

  • Mod Folder Path - property holding folder where mod should be placed. On the side of this property you have operator (SCS Tools Conv Hlpr Find Folder.png) for auto retrieve of the mod paths for Euro Truck Simulator 2 or American Truck Simulator.
  • Mod Name - property holding name of the mod ZIP file.

Third row is featuring switching of automated actions that should be done before mod will be packed:

  • Auto Clean - enable this switch if you want to make clean conversion without any leftovers from previous packing or converting.
  • Auto Export - enable this switch if you want to run automated Blender Tools export. Scope of the content which will be auto exported is defined with Export Scope property in Export Panel.
  • Auto Convert - enable this switch if you want for your resources to be converted before packing. This automated conversion will convert SCS Project Base Path as well as any defined custom paths.

Last switch "No Archive | No Compression | Deflated | BZIP2" defines type of the compression you want to use for your mod package.

Using No Archive option creates folder inside selected mod destination and copies result of conversion tools to it, instead of creating a ZIP package. Created folder is named the same as ZIP package: by mod name property.

PACK MOD aka Magic Button

Final magic operator found at the bottom of the panel is >>>> PACK MOD <<<<. This operator firstly executes enabled automated actions and on the end packs conversion tools result into the ZIP package and copies it to the selected mod destination.

So if you don't want to bother with manual exporting/converting, then for easy usage follow this few steps:

  1. Set mod folder path to: "<Game User Path>/mod"
  2. Fill-in mod name
  3. Enable all auto options
  4. Press PACK MOD.
  5. Once packing is done, run the game and try your mod out!