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

From SCS Modding Wiki
Jump to navigation Jump to search
m (50keda moved page Tools/Asset Conversion to Tools/Conversion Tools without leaving a redirect: Ambigous title, from now one "asset conversion" should not be used becuse it implies only 3D assets have to be converted)
Line 1: Line 1:
=What are conversion tools and when to use them=
+
= What are Converion 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 [[Tools/SCS_Blender_Tools|SCS Blender Tools]].
+
Conversion tools are set of binaries used to convert mid-format files<br />
 +
to binary format files which are used by the game.<br />
 +
In general you should convert your whole mod file system structure for in game usage<br />
 +
using this tools including:<br />
 +
any 3D assets exported with SCS Blender Tools, any definition files, sound files, map files etc.
  
=What is included in package=
+
= Installation =
  
Downloaded archive consists of following folders and files:
+
# Download conversion tools: [http://download.eurotrucksimulator2.com/conversion_tools_X_X.zip LINK]
 +
# To install conversion tools binaries simply extract ZIP package into folder somewhere on<br />
 +
the PC where it can be found and read-write access is granted.
  
*'''conversion_tools''' - conversion tools binaries and predefined folder structure
+
= Usage =
*'''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 [http://download.eurotrucksimulator2.com/conversion_tools_1_6.zip here]
 
 
 
Installation:
 
 
 
#To install conversion tools binaries simply copy <code>conversion_tools</code> 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 <code>blender_addon/scs_conversion_helper</code> 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'''''
 
 
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.
 
 
 
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 <code>conversion_tools/rsrc</code> will first be removed then conversion will take place
 
*'''"CONVERT CURRENT SCS PROJECT" operator''' - will write current "SCS Project Base Path" to <code>extra_mount.txt</code> and run the conversion.
 
NOTE: This kind of usage will convert only resources which are in <code>conversion_tools/base</code> and resources from "SCS Project Base Path". After conversion is done, content inside <code>conversion_tools/rsrc</code> folder can be ZIP-ed and placed into the mod folder of the game as usual.
 
  
==Use binaries directly (for advanced users)==
+
* First make sure you installed [https://github.com/SCSSoftware/BlenderTools/wiki SCS Blender Tools]
 +
* Navigate to Conversion Helper panel in Scene properties tab.
 +
* Set &quot;Conversion Tools Path&quot; pointing to extracted conversion tools folder (the same folder as this readme file is in).
 +
* Now conversion tools will be used when you will use operators of conversion helper<br />
 +
(for more info see: https://github.com/SCSSoftware/BlenderTools/wiki/Conversion-Helper).
  
Direct usage of conversion tools is done from command line with execution of <code>conversion_tools/convert.cmd</code> script.
+
# '''''Use binaries directly (for advanced users)'''''
  
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.
+
Direct usage of conversion tools is done from command line<br />
 +
with execution of &quot;conversion_tools/convert.cmd&quot; script.
  
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 <code>base</code> and all additional paths!
+
Running this script will take any mid-format resources founded in<br />
 +
&quot;conversion_tools/base&quot; folder, correctly convert them into<br />
 +
binary format files and place them into &quot;conversion_tools/rsrc&quot; folder.
  
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.
+
<blockquote>NOTE: Usage of &quot;conversion_tools/extra_mount.txt&quot; file with specified additional<br />
 +
&quot;base&quot; folder paths in each line of the file may also be used. This will cause<br />
 +
conversion tools to mount all of the paths the same as &quot;conversion_tools/base&quot;<br />
 +
folder. With extra mounted directories conversion tools will convert<br />
 +
all resources from &quot;base&quot; and all additional paths!
 +
</blockquote>
 +
After completed conversion all the content in &quot;conversion_tools/rsrc&quot;<br />
 +
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>.
+
<blockquote>NOTE: if something goes wrong during the conversion, you can find additional<br />
 +
information in conversion tools log file (&quot;bin/win_x86/mass_convert.log&quot;).
 +
</blockquote>

Revision as of 12:41, 22 January 2016

What are Converion 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.
In general you should convert your whole mod file system structure for in game usage
using this tools including:
any 3D assets exported with SCS Blender Tools, any definition files, sound files, map files etc.

Installation

  1. Download conversion tools: LINK
  2. To install conversion tools binaries simply extract ZIP package into folder somewhere on

the PC where it can be found and read-write access is granted.

Usage

There are two options of usage for conversion tools:

  1. Use conversion tools from Blender
  • First make sure you installed SCS Blender Tools
  • Navigate to Conversion Helper panel in Scene properties tab.
  • Set "Conversion Tools Path" pointing to extracted conversion tools folder (the same folder as this readme file is in).
  • Now conversion tools will be used when you will use operators of conversion helper

(for more info see: https://github.com/SCSSoftware/BlenderTools/wiki/Conversion-Helper).

  1. 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").