View source for Creating a Material

{{LanguageBar}}

{{toc-right}}
This tutorial is a step-by-step guide to creating a brand new [[material]], including the creation of the material's [[texture]].

== Creating a Texture ==
Any image file can be used as a texture, so long as both of its dimensions (height and width) are a power of two (1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096). To decide which to use, examine existing textures that fill the same role as yours. Higher resolutions lower performance but make an image sharper when viewed up close.

Different classes of object have different standard resolutions (e.g. character models' are very high). Check Valve's choices in {{code|hl2_textures_dir.vpk}} (from {{hl2|1}}) with [[GCFScape]] or [[VPKEdit]] if you are ever confused.

{{note|Texture source files should be saved in a lossless format like [[Wikipedia:Truevision TGA|TGA]] pre-compile, to prevent unnecessary loss in quality. For textures without an alpha channel, PNG is also acceptable.}}
{{note|The file size limit is 33,554,432 bytes (32 MB). Compiling a .vtf over this amount will cause errors.}}

=== Converting the Texture ===

Textures must be converted to the [[Valve Texture Format]] before Source can use them. The tool Valve provides for this is [[Vtex (Source 1)|VTEX]]. It's a [[command line]] tool with quite a few limitations, so the third-party tool {{Vtfedit|4}} (or {{Vtfeditrld|4}}) is preferable: it provides a graphical user interface, allows you to change a texture's properties without re-compiling it from scratch, accepts a wide range of image formats, and doesn't require the creation of script files for every texture. There are a handful of situations where you'll need to fall back on VTEX… but only a handful. Also, if you have textures that use transparency, it is recommended that you save them in TIFF format before importing to VTFedit as PNG transparency tends to have problems.

(There are VTF plug-ins that let you save to the format directly from [[Photoshop_VTF_Plugin|Photoshop]], [http://code.google.com/p/gimp-vtf/ GIMP], and [http://nemesis.thewavelength.net/index.php?p=50 Paint.NET], but this tutorial will not cover them as not everyone uses those tools.)

'''To import your texture with VTFEdit''', use <code>File > Import</code> or press {{key|Ctrl+I}}. Select your image and you will be presented with the import screen:

[[File:Vtfedit importoptions.png|center|VTFEdit's import screen]]

==== General settings ====

These settings are the most important. There are three:

; Normal format
: The color/compression format should be used if the texture is opaque.
; Alpha format
: The color/compression format should be used if the texture has an alpha channel.
; Texture type
: Importing more than one image determines what they will be used as (animation frames/cubemap faces/depth slices).

If you're making a plain and simple world texture you won't need to change any of these. If you're making a texture with fine gradient detail however, you'll need to [[Valve Texture Format#Choosing_an_image_format|choose a non-lossy compression mode]].

==== Mipmap settings ====

[[MIP Mapping|Mipmaps]] are low-resolution versions of a texture that swap in when a surface is far away from the camera. They greatly reduce the amount of texture resizing needed, improving both performance and image quality. Mips are required for texture LOD to work.

{{tip|Textures that will appear in the 3D world should have mipmaps. To conserve memory, textures that will only be used in a 2D interface should not.}}

The following images demonstrate the various mipmap filters available in VTFEdit:

<gallery perrow=5 widths=150 heights=180>
File:Vtf sharpen filters.jpg|Sharpen filters
File:Vtf mipmap filters1.jpg|Mip filters #1
File:Vtf mipmap filters2.jpg|Mip filters #2
File:Vtf mipmap filters3.jpg|Mip filters #3
File:Vtf mipmap filters4.jpg|Mip filters #4
</gallery>

==== Normal map settings ====

These (mislabelled{{how}}) settings allow you to automatically generate a [[bump map]] from your input image. You'll want to do this properly with an image editor for the material you ship, but the automated option is there if you want quick results or a base to work from.

=== Configuring and Saving ===

When you hit OK the input file is converted (there may be quite a lengthy pause for large images) and the output VTF appears. Now all that is left is configuring the texture with the options in the checkbox list on the left-hand side of the screen. See [[Valve Texture Format#Image_flags]] for descriptions of each.

Finally, save the file somewhere under your game or mod's <code>\materials</code> folder.

==Creating a Material==
Source doesn't access textures directly. Everything goes through a '''[[material]]'''.

Materials are script files that can be created in any text editor, but it's recommended that you use {{npp|4}} in conjunction with the community-made [[Notepad++ VDF languages|syntax highlighting rules]]. For your material to be detected, '''you must save it under your game or mod's <code>\materials</code> folder with the extension <tt>.vmt</tt>'''.
{{note|If you are creating materials and textures exclusively for a map for an existing mod, consider using [[BSPZIP]]\{{pbsp|3.1}}\{{pakrat|3.1}}\{{Compilepal|3.1}} to package the material and texture files within the map file itself. This will prevent them from ever becoming lost.}}
{{warning|Although your computer will let you save a file name that contains the <tt>%</tt> character, and [[VTF]]s work just fine with the character in the name, Hammer '''cannot''' handle [[VMT]]s whose names contain the <tt>%</tt> character.}}

===Syntax===
A material file looks like this:

 <[[shader]]>
 {
 	<parameter> <value>
 	...
 }

 LightmappedGeneric
 {
 	$basetexture coast\shingle_01
 	$surfaceprop gravel
 }

There are many [[shader]]s to choose from, but most materials will use either {{ent|LightmappedGeneric}} ([[brush]]es) or {{ent|VertexLitGeneric}} ([[model]]s). The third most common shader is {{ent|UnlitGeneric}}, which is used for [[VGUI2|UI]] materials and the occasional [[tool texture]]. A full list of shaders can be found [[:Category:Shaders|here]].

===Parameters===
:''For a list of all documented shader parameters, see [[:Category:List of Shader Parameters]].''

With a shader chosen, you're onto parameters (also called commands). There are hundreds of options for what to put in a material so this article will only cover the most common, which are accepted by more or less all shaders. They are:
*{{ent|$basetexture}}
*{{ent|$surfaceprop}}
*{{ent|$envmap}}
*{{ent|$bumpmap}}
*{{ent|$detail}}
*{{ent|$selfillum}}
*{{ent|$model (VMT)|alt=$model}}
{{tip|If you ever need to use a space or tab character in a parameter value, you must wrap the whole value with "quote marks." You'll often see absolutely everything wrapped like this, but this is wholly unnecessary.}}
{{tip|To refresh a material in-game without restarting it, use the following console command: <tt>mat_reloadmaterial "vmt_name without .vmt and quotation marks"</tt>. Even though the <code>mat_reloadallmaterials</code> command exists, it's not recommended to use it, since various artifacts may appear. <tt>mat_reloadtextures</tt> is presented, too, but it seems to be very buggy.
For instance:
  mat_reloadmaterial combine_barricade_short01a
will reload every single material in the filesystem named <tt>combine_barricade_short01a</tt>, including all the custom content. For example: both <tt>materials/models/props_combine/combine_barricade_short01a.vmt</tt> and <tt>materials/models/props_metal_barricade/combine_barricade_short01a.vmt</tt> will be reloaded. This may appear very useful when writing proxies.}}

== Utilities ==
{{Xblahmt|4}}

==See also==
* [[Material]]
* [[Material Editor]]
* [[Creating Reflective Materials]]
* [[Creating PBR materials]]
* [[Adapting PBR Textures to Source]]
* [[:Category:List of Shader Parameters]]

[[Category:Material System]]
[[Category:Tutorials]]