Changes

Jump to navigation Jump to search

Documentation/Tools/SCS Blender Tools/Conversion Helper

278 bytes added, 14:58, 4 December 2019
no edit summary
Conversion helper panel features tools for automated files conversion and mod packing. Panel with conversion helper can be found below [[Documentation/Tools/SCS Blender Tools/Export Panel|Export Panel]] located within ''Output'' tab in Blender properties window.
However before you use Conversion Helper you should download latest [[Documentation/Tools/Conversion Tools|Conversion Tools]] for the game you want to create mod for and set path to conversion tools under ''Conversion Tools Path''. Additionally make sure you have checked [[Documentation/Tools/SCS Blender Tools/Intended workflow|Intended workflow]] images, for better understanding how mod system works when using SCS Blender Tools and Conversion Tools.
Conversion helper panel features tools for automated files conversion and mod packing. Panel with conversion helper can be found below [[Documentation/Tools/SCS Blender Tools/Export Panel|Export PanelFile:SCS_Tools_Conv_Hlpr.280.png]] located within Scene tab in Blender properties window.
However before you use Small razor icon located on the right side of SCS Conversion Helper panel header represents '''Clean Converted Data''' operator. This operator will immediately clean content that you should download latest [[Documentation/Tools/Conversion Tools|Conversion Tools]] for the game you want to create mod forconverted before or is left there from some other time. Also make In general this makes sure you your mod won't have checked any unused resources (leftover textures, old materials) in the converted result. Same action can also be achieved while using [[Documentation/Tools/SCS Blender Conversion Tools/Intended workflow#Mod Packing|Intended workflowMod Packing]] imageswith enabled '''Clean''' option.
[[File:SCS_Tools_Conv_HlprConversion helper also support switchable '''Custom Paths'''. Once they are enabled conversion helper panel gets extended as seen on image below.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 [[Documentation/Tools/Conversion Tools#Mod Packing|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. [[File:SCS Tools Conv Hlpr Custom Paths.280.png]]
== Custom Paths Usage ==
On the side of the list you can find operators for managing your custom paths:
* <span style="color:#FFFFFF">{{Blender Button|'''[[File:SCS_Tools_Conv_Hlpr_Add_Cstm_Path.png]]+''' }}</span> - opens file selector where you should browse for new custom path you want to use.* <span style="color:#FFFFFF">{{Blender Button|'''[[File:SCS_Tools_Conv_Hlpr_Del_Cstm_Path.png]]''' }}</span> - deletes currently selected custom path in the list.* '''[[File<span style="color:SCS_Tools_Conv_Hlpr_Cstm_Path_Up.png]]''' #FFFFFF">{{Blender Button|⯅}}</span> - 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.* '''[[File<span style="color:SCS_Tools_Conv_Hlpr_Cstm_Path_Down.png]]''' #FFFFFF">{{Blender Button|⯆}}</span> - 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.
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 search icon operator ([[File: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 defines type of automated actions that should be done before the compression you want to use for your mod will be packedpackage: * '''Auto CleanFolder''' - enable this switch if you want option creates folder inside selected mod destination and copies result of conversion tools to make clean conversion without any leftovers from previous packing or convertingit, instead of creating a ZIP package. Created folder is named the same as ZIP package: by mod name property.* '''Auto ExportZIP (Uncompressed)''' - 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 [[Documentation/Tools/SCS Blender Tools/Export Panel|Export Panel]]pack mod into uncompressed ZIP file.* '''Auto ConvertZIP (Moderate)''' - enable this switch if you want for your resources to be converted before packing. This automated conversion will convert pack mod into compressed ZIP file (helper uses deflated compression, which is supported by SCS Project Base Path as well as any defined custom pathsgames).
Last switch '''&quot;No Archive | No Compression | Deflated | BZIP2&quot;''' defines type Next row features switches of the compression you want to use for your automated actions that can be done before mod package.will be packed:
Using * '''Clean''No Archive' - enable this switch if you want to make clean conversion without any leftovers from previous packing or converting.* '''Export'' option creates folder inside selected mod destination and copies result ' - enable this switch if you want to run automated Blender Tools export. Scope of conversion tools the content which will be auto exported is defined with Export Scope property in [[Documentation/Tools/SCS Blender Tools/Export Panel|Export Panel]].* '''Convert''' - enable this switch if you want for your resources to it, instead of creating a ZIP packagebe converted before packing. Created folder is named the same This automated conversion will convert SCS Project Base Path as well as ZIP package: by mod name propertyany defined custom paths.
=== PACK MOD aka Magic Button ===
# Set mod folder path to: "[[Documentation/Engine/Game_user_path|<Game User Path>]]/mod"
# Fill-in mod name
# Enable all auto options
# Press PACK MOD.
# Once packing is done, run the game and try your mod out!

Navigation menu