Difference between revisions of "Documentation/Tools/Conversion Tools"

From SCS Modding Wiki
Jump to navigation Jump to search
m
(60 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
Conversion tools are a set of binaries used to convert mid-format files to binary format files which are used by the game.
+
=What are conversion tools and when to use them=
  
−
In general you should convert your whole mod file system structure for in game usage using this tools including:
+
Conversion tools are set of binaries used to convert mid-format files to binary format files which are used by the game. They are needed for in game usage of any 3D assets exported with [[Tools/SCS_Blender_Tools|SCS Blender Tools]].
−
any 3D assets exported with SCS Blender Tools, any definition files, sound files, map files etc.
 
  
−
= Download & Installation =
+
=What is included in package=
  
−
=== Download ===
+
Downloaded archive consists of following folders and files:
  
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_18.zip LINK (v2.18)]''' - ETS2 ('''1.50+''') & ATS ('''1.50+''') - with prefab v24
+
*'''conversion_tools''' - conversion tools binaries and predefined folder structure
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_17.zip LINK (v2.17)]''' - '''BETA''' - ETS2 ('''1.50+''') & ATS ('''1.50+''')
+
*'''blender_addon''' - "SCS Conversion Helper" Blender addon for using conversion tools out of the box from Blender
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_15.zip LINK (v2.15)]''' - ETS2 ('''1.49+''') & ATS ('''1.49+''')
+
*'''README.md'''
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_14.zip LINK (v2.14)]''' - ETS2 ('''1.47+''') & ATS ('''1.47+''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_13.zip LINK (v2.13)]''' - ETS2 ('''1.44+''') & ATS ('''1.44+''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_12.zip LINK (v2.12)]''' - ETS2 ('''1.37 - 1.43''') & ATS ('''1.37 - 1.43''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_10.zip LINK (v2.10)]''' - ETS2 ('''1.36''') & ATS ('''1.36''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_9.zip LINK (v2.9)]''' - ETS2 ('''1.36''') & ATS ('''1.36''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_8.zip LINK (v2.8)]''' - ETS2 ('''1.35''') & ATS ('''1.35''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_7.zip LINK (v2.7)]''' - ETS2 ('''1.32''') & ATS ('''1.32''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_6.zip LINK (v2.6)]''' - ETS2 ('''1.31''') & ATS ('''1.31''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_5.zip LINK (v2.5)]''' - ETS2 ('''1.30''') & ATS ('''1.29''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_2_4.zip LINK (v2.4)]''' - ETS2 ('''1.27 - 1.28''') & ATS ('''1.6 - 1.28''')
 
−
* '''[https://download.eurotrucksimulator2.com/conversion_tools_1_8.zip LINK (v1.8)]''' - ETS2 ('''1.27 and below''') & ATS ('''1.5 and below''')
 
  
−
{{Note|Old conversion tools compatible with ETS2 (up to '''v1.26'''), ATS (up to '''v1.5''') also require older SCS Blender Tools versions up to '''v1.6'''.}}
+
NOTE: Blender addon doesn't have to be used as the addon itself is only helper for using conversion tools directly from Blender.
  
−
=== Install ===
+
=Installation=
  
−
To install conversion tools binaries simply extract the ZIP package into a folder somewhere on the PC where it can be found and '''read-write access is granted'''.
+
Before installation download current version of conversion tools from [http://download.eurotrucksimulator2.com/conversion_tools_1_6.zip here]
  
−
= Usage =
+
Installation:
 +
 
 +
#To install conversion tools binaries simply copy "conversion_tools" folder somewhere on the PC where it can be found and read-write access is granted.
 +
#To install Blender addon named "SCS Conversion Helper" copy "blender_addon/scs_conversion_helper" folder to <code>< blender_version >/scripts/addons</code> within Blender installation folder (for other installation procedures please visit [http://wiki.blender.org/index.php/Doc:2.6/Manual/Extensions/Python/Add-Ons Blender wiki]). After installing "SCS Conversion Helper" make sure that addon is enabled!
 +
 
 +
=Usage=
  
 
There are two options of usage for conversion tools:
 
There are two options of usage for conversion tools:
  
−
# '''''Use conversion tools from Blender'''''
+
==Use conversion tools from Blender==
−
#* First make sure you installed SCS Blender Tools. See: [[Documentation/Tools/SCS Blender Tools/Installation]]
+
 
−
#* Navigate to ''Conversion Helper'' panel in ''Output'' properties tab.
+
Use "SCS Conversion Helper" addon. This addon actually grabs "SCS Project Base Path" property from [https://github.com/SCSSoftware/BlenderTools/wiki/Global-Settings#path-settings SCS Blender Tools Global Settings] and uses conversion tools binaries to convert resources with simple click of a button.
−
#* Set ''Conversion Tools Path'' to point to the extracted conversion tools folder.
+
 
−
#* Now conversion tools will be used when you will use operators of conversion helper (for more info see: [[Documentation/Tools/SCS Blender Tools/Conversion Helper]]).
+
After enabling of an addon, additional panel in Blender named "SCS Conversion Helper" will appear in properties window under "Scene" tab.
−
# '''''Use binaries directly (for advanced users)'''''
+
 
−
#: Direct usage of conversion tools is done from command line with execution of &quot;conversion_tools/convert.cmd&quot; script. Running this script will take any mid-format resources founded in &quot;conversion_tools/base&quot; folder, correctly convert them into binary format files and place them into &quot;conversion_tools/rsrc&quot; folder.
+
[[File:Scs conversion helper.jpg]]
−
#: After completed conversion all the content will be in inside &quot;conversion_tools/rsrc/base/@cache&quot;. To create a mod you can ZIP &quot;conversion_tools/rsrc/base/@cache&quot; folder and place it into the mod folder of the game as usual. In case of &quot;conversion_tools/extra_mount.txt&quot; usage each entry from extra mount will have its own converted folder entry inside &quot;conversion_tools/rsrc&quot; So to pack a mod you will have to take the result from each respective converted folder and put it together in the same ZIP file (e.g. extra mount entry "my_mod" will have conversion result in "conversion_tools/rsrc/my_mod/@cache").
+
 
−
<blockquote>{{Note|Usage of &quot;conversion_tools/extra_mount.txt&quot; file with specified additional sibling folder paths of &quot;base&quot; in each line of the file may also be used. This will cause conversion tools to mount all of the paths the same as &quot;conversion_tools/base&quot; folder. }}</blockquote>
+
Panel features:
−
<blockquote>{{Note|If something goes wrong during the conversion, you can find additional information in the conversion tools log file (&quot;bin/win_x86/mass_convert.log&quot;).}}</blockquote>
+
 
 +
*'''"Conversion Tools Path" property''' - specified path to extracted conversion tools binaries mentioned above
 +
*'''"Clean 'rsrc' folder" property''' - using this option any content in "conversion_tools/rsrc" will first be removed then conversion will take place
 +
*'''"CONVERT CURRENT SCS PROJECT" operator''' - will write current "SCS Project Base Path" to "extra_mount.txt" and run the conversion.
 +
NOTE: This kind of usage will convert only resources which are in "conversion_tools/base" and resources from "SCS Project Base Path". After conversion is done, content inside "conversion_tools/rsrc" folder can be ZIP-ed and placed into the mod folder of the game as usual.
 +
 
 +
==Use binaries directly (for advanced users)==
 +
 
 +
Direct usage of conversion tools is done from command line with execution of <code>conversion_tools/convert.cmd</code> script.
 +
 
 +
Running this script will take any mid-format resources founded in <code>conversion_tools/base</code> folder, correctly convert them into binary format files and place them into <code>conversion_tools/rsrc</code> folder.
 +
 
 +
NOTE: Usage of <code>conversion_tools/extra_mount.txt</code> file with specified additional <code>base</code> folder paths in each line of the file may also be used. This will cause conversion tools to mount all of the paths the same as <code>conversion_tools/base</code> folder. With extra mounted directories conversion tools will convert all resources from "base" and all additional paths!
 +
 
 +
After completed conversion all the content in <code>conversion_tools/rsrc</code> folder can be ZIP-ed and placed into the mod folder of the game as usual.
 +
 
 +
NOTE: if something goes wrong during the conversion, you can find additional information in conversion tools log file <code>bin/win_x86/mass_convert.log</code>.

Revision as of 14:27, 14 January 2016

What are conversion tools and when to use them

Conversion tools are set of binaries used to convert mid-format files to binary format files which are used by the game. They are needed for in game usage of any 3D assets exported with SCS Blender Tools.

What is included in package

Downloaded archive consists of following folders and files:

  • conversion_tools - conversion tools binaries and predefined folder structure
  • blender_addon - "SCS Conversion Helper" Blender addon for using conversion tools out of the box from Blender
  • README.md

NOTE: Blender addon doesn't have to be used as the addon itself is only helper for using conversion tools directly from Blender.

Installation

Before installation download current version of conversion tools from here

Installation:

  1. To install conversion tools binaries simply copy "conversion_tools" folder somewhere on the PC where it can be found and read-write access is granted.
  2. To install Blender addon named "SCS Conversion Helper" copy "blender_addon/scs_conversion_helper" folder to < blender_version >/scripts/addons within Blender installation folder (for other installation procedures please visit Blender wiki). After installing "SCS Conversion Helper" make sure that addon is enabled!

Usage

There are two options of usage for conversion tools:

Use conversion tools from Blender

Use "SCS Conversion Helper" addon. This addon actually grabs "SCS Project Base Path" property from SCS Blender Tools Global Settings and uses conversion tools binaries to convert resources with simple click of a button.

After enabling of an addon, additional panel in Blender named "SCS Conversion Helper" will appear in properties window under "Scene" tab.

File:Scs conversion helper.jpg

Panel features:

  • "Conversion Tools Path" property - specified path to extracted conversion tools binaries mentioned above
  • "Clean 'rsrc' folder" property - using this option any content in "conversion_tools/rsrc" will first be removed then conversion will take place
  • "CONVERT CURRENT SCS PROJECT" operator - will write current "SCS Project Base Path" to "extra_mount.txt" and run the conversion.

NOTE: This kind of usage will convert only resources which are in "conversion_tools/base" and resources from "SCS Project Base Path". After conversion is done, content inside "conversion_tools/rsrc" folder can be ZIP-ed and placed into the mod folder of the game as usual.

Use binaries directly (for advanced users)

Direct usage of conversion tools is done from command line with execution of conversion_tools/convert.cmd script.

Running this script will take any mid-format resources founded in conversion_tools/base folder, correctly convert them into binary format files and place them into conversion_tools/rsrc folder.

NOTE: Usage of conversion_tools/extra_mount.txt file with specified additional base folder paths in each line of the file may also be used. This will cause conversion tools to mount all of the paths the same as conversion_tools/base folder. With extra mounted directories conversion tools will convert all resources from "base" and all additional paths!

After completed conversion all the content in conversion_tools/rsrc folder can be ZIP-ed and placed into the mod folder of the game as usual.

NOTE: if something goes wrong during the conversion, you can find additional information in conversion tools log file bin/win_x86/mass_convert.log.

Retrieved from "https://modding.scssoft.com/index.php?title=Documentation/Tools/Conversion_Tools&oldid=69"