View source for Vtex CLI use

Apart from the drag-and-drop method, [[Vtex]] can also be executed via the command prompt in the Command Line Interface (MS-DOS). This will allow you to use its more advanced features. You can provide additional parameters to create a basic .vmt file when the texture is compiled, as well as other options.

The syntax for <code>vtex.exe</code> is as follows:

 vtex [-quiet] [-nopause] [-mkdir] [-shader ShaderName] [-vmtparam Param Value] texture1 texture2 ...

Any file extentions are ignored. (You can refer to the non-existant ''texture1.asd'' without problems, as long as the tga image is still present.)



== Basic Vtex usage ==

:''[[Command-line]] may explain this better.''

The Windows environment variable "<code>%sourcesdk%</code>" can be utilized to locate <code>vtex.exe</code> easily in a command-line statement. This variable contains the location of the Source SDK installation directory.

For example, to compile a Half-Life 2 material called "<code>sample_material.tga</code>" in the directory "<code>sourcesdk_content/hl2/materialsrc/metal</code>", you would open a command prompt, change to the directory to "<code>sourcesdk_content/hl2/materialsrc/metal</code>" and type this at the command-line:

 "%sourcesdk%\bin\vtex" sample_material.tga

The compiled .vtf file would be compiled to this folder (assuming you had set '''Half-Life 2''' as your current game directory):

 SteamApps\''username''\half-life 2\hl2\materials\metal

{{note|It is very important that you set the '''Current Game''' in either the '''SDK Launcher''' or '''VConfig''' to the correct game directory ''before'' you open a command prompt to compile textures. Changing the '''Current Game''' will not affect any command prompt windows that are already open. This is due to how Windows uses environment variables.}}

== Vtex commands ==


=== -mkdir ===

You can add the <code>-mkdir</code> command to vtex, and it will add the destination directory if it does not exist. For example, if you had a .tga at <code>/sourcesdk_content/hl2/materialsrc/sample/sample_material.tga</code> you would type this at the command-line:

 "%sourcesdk%\bin\vtex" -mkdir sample_material.tga

This would create a new directory called "<code>sample</code>" in your<code> Half-Life 2/hl2/materials</code> directory, if it didn't already exist, and then place the compiled .VTF file in that new location. If the directory already exists, the <code>-mkdir</code> parameter is ignored.



=== -shader ===

You can use the <code>-shader <''shadername''></code> command to have Vtex create a .VMT for the new material with the [[shader]] specified. For example, to create a basic <code>LightmappedGeneric</code> material, use the <code>-shader</code> command like this:

 "%sourcesdk%\bin\vtex" -shader LightmappedGeneric sample_material.tga

This would compile the material sample_material.vtf in <code>half-life 2/hl2/materials/metal</code> as well as create a new material file <code>sample_material.vmt</code> in the same location, using the <code>LightmappedGeneric</code> shader, like this:

<pre>
"LightmappedGeneric"
{
	"$baseTexture" "sample/lightmappedgeneric"
}
</pre>



=== -vmtparam ===

You can use the <code>-vmtparam <''parameter''> <''value''></code> command to additional material parameters to the created .vmt file. If a .vmt already exists in the same location, any new parameters will not be added. For example, to make a material translucent, you would type the following:

 "%sourcesdk%\bin\vtex" -shader LightmappedGeneric -vmtparam $translucent 1 sample_material.tga

Which would create the following <code>sample_material.vmt</code><nowiki>:</nowiki>

<pre>
"LightmappedGeneric"
{
	"$baseTexture" "sample/lightmappedgeneric"
	"$translucent" 1
}
</pre>

You can add multiple <code>-vmtparam</code> statements in the same Vtex command, like this:

 "%sourcesdk%\bin\vtex" -shader LightmappedGeneric -vmtparam "$bumpmap" "sdk/bumpspecular_normal" -vmtparam "$envmap" "env_cubemap" sample_material.tga

This would create the following <code>sample_material.vmt</code> specifying parameters for a bumpmapped specular material:

<pre>
 "LightmappedGeneric"
 {
 	"$baseTexture" "sample/sample_material"
 	"$bumpmap" "sdk/bumpspecular_normal"
 	"$envmap" "env_cubemap"
 }
</pre>



=== -quiet ===

When added, this commands will cause Vtex to do its work without producing any output to the console and will not pause when finished.



=== -nopause ===

Removes the "<code>Hit a key to continue</code>" message that appears when Vtex has finished working.



=== -outdir ===

You can use the <code>-outdir <''parameter''> <''value''></code> command to override the output directory out the VTF file.


=== -quickconvert ===

Used to quickly convert an older VTF file format to a newer VTF file format. 

=== -dontusegamedir ===

Puts output files in same folder as input files. Best used with <code>-quickconvert</code>


== Wildcards ==

Command-line ''wildcards'' can also be used with Vtex. This command-line would compile all .tga files in the current directory:

 "%sourcesdk%\bin\vtex" *.tga

This command-line would compile all .tga files in the current directory with names than begin with "sample":

 "%sourcesdk%\bin\vtex" sample*.tga

In this case, the files "<code>sample_metal</code>" and "<code>sample3</code>" would be compiled, but not "<code>samp_metal</code>" or "<code>sampl_2</code>".



== Chaining ==

Vtex can compile multiple materials from the same command-line. Simply add the name of each .tga after the first, like this:

 "%sourcesdk%\bin\vtex" sample_material1.tga sample_material2.tga sample_material3.tga

If a .vmt is generated on the command-line using the <code>-shader</code> command, a unique .vmt will be created for each .tga in the chain, all with the same parameters specified by the <code>-shader</code> and <code>-vmtparam</code> commands. If you need more individual control of the shader parameters of each .tga, use a batch (.bat) file to run vtex multiple times instead.



==See also==

* [[Vtex]]
* [[Vtex troubleshooting]]
* [[Material Creation]]
* [[Shader Types and Parameters]]



[[Category: Tools]]
[[Category: Material System]]