StudioMDL (Source): Difference between revisions

Revision as of 09:59, 10 May 2022

For a guide to studiomdl's usage, see Compiling a model.

Studiomdl is the command-line tool used to compile models from intermediate formats exported from modeling packages to the binary .mdl format that is read by the Source engine.

It can be found at common\<gamename>\<gamefolder>\bin\studiomdl.exe.

Tip:The name "studio" is a throwback to the development of

Half-Life, during which Valve used 3D Studio Max to create their models.

Bug: Attempting to use Studiomdl or a shortcut of it pinned to the taskbar in Windows 8 will result in an invalid target path, even when -game and an associated path are specified. Using a shortcut on the desktop, however, still works. This is an issue on Microsoft's end, unfortunately. [todo tested in ?]

Parameters

The only parameter required is a QC file. Any others must come before it.

studiomdl [options] <path\QC>

General

-game <gamedir>: Override the VProject game path.
-quiet: Suppresses some console output, such as spewing the searchpaths.
-x360: Enable Xbox 360 output, overriding the Gameinfo.txt
-nox360: Disable Xbox 360 output, overriding the Gameinfo.txt
-nowarnings: Disable warnings.
-maxwarnings <int>: Print no more than the specified number of warnings.

Animation

-definebones: See $definebone.
-printbones: Writes extra bone info to the console.
-printgraph: Todo: Appears to dump xnode data for each node?
-overridedefinebones: Equivalent to specifying $unlockdefinebones in QC.
-checklengths: Prints engine-ready keyframe data for each animation.

Performance

-fastbuild

Skip processing DX7, DX8, X360, and software VTX variants (use .dx90.vtx only). This speeds up compiling.

-preview

Skip splitting quads into tris. This changes the rendering flags for the model, most likely resulting in slower performance or buggier rendering in-engine.

-fullcollide (only in )

Don't truncate really big collision meshes (in all games since

, use $maxconvexpieces).

-striplods

Ignore all $lod commands.

-minlod <lod>

Throw away data from LODs above the given one (see $minlod).

-mdlreport <path\model.mdl>

Report performance info for an already-compiled model. A QC file is not needed when using this command.

-perf <path\model.mdl>

Same as -mdlreport.

-mdlreportspreadsheet

Report performance info, per-LOD, as a comma-delimited spreadsheet. It will appear in the form:

Path to VTX, VTX file extension, LOD number (1 is the root lod), tri count, number of batches rendered, number of materials used

Must be used with -mdlreport or -perf!

Note:It doesn't actually write a spreadsheet to disk.

Debug

-d: Dumps various glview files (10 per LOD per VTX file),
-h: Dump hitboxes to console.
-n: Tag bad normals.
-dumpmaterials: Dump names of used materials to the console.
-i: Ignore warnings.
-t: Replaces all materials with the default pink check pattern
-parsecompletion: Prints an easily parseable message indicating whether the compile was successful or a failure.
-collapsereport: Prints info on which bones are being retained and which bones are being collapsed.

Other

-nop4: Disables Valve's Perforce integration. Unless you actually have Perforce set up for your game/mod (a highly unlikely scenario), you should use this.
-verify: Compile the model, but don't actually write the results to disk.
-a <normal_blend_angle>: Auto-smooth faces equal to or below specified angle. Will override normal data for all meshes.
-f (removed since ): Flip all triangles.; Bug:Does not work in Orange Box and later builds of Studiomdl. You can achieve the same behavior with $body, however. [todo tested in ?]
-vsi <path\[QC|MDL]>: Generates a VSI file from a QC or MDL.
-stripmodel <path\model.mdl>: Strips down a model, removing its LOD info.
-stripvhv <path\sp_hdr_x.vhv>: Strips down hardware verts (VHV) of their LOD info.
-makefile: Generates a simple makefile for later compiling. It also parses the QC for any errors, and runs in -quiet mode.
-basedir <path>: Runs studiomdl in the context of the provided path.
-tempcontent <path>: Adds the provided path as a content search path.

Nonfunctional

-r: "Tag reversed".
-ihvtest: Probably meant to test the model collision for any physics errors. Skips whatever argument is provided after it.

Input Files

StudioMDL supports a range of input formats. These include SMD, DMX, and OBJ for reference meshes and VTA files for vertex and flex animation. Counter-Strike: Global Offensive also supports FBX, but with limited functionality. Flexes are not directly supported, nor are FBX sequences, however an SMD/DMX sequence can be used on an FBX model.

Note:While FBX does technically seem to support flex animations, an SMD file is required to generate the VTA file, making the use of an FBX file for flexes redundant.

Output files

mymodel.mdl: Skeleton, animations, bounding/hit boxes, surface materials, LOD index…
mymodel.sw.vtx
mymodel.360.vtx
mymodel.dx80.vtx
mymodel.dx90.vtx: Vertex data optimised for software rendering, XBox 360, DirectX 7, 8 and 9 respectively.
Note:.360.vtx files are just byteswapped .dx90.vtx files.
mymodel.vvd: Remaining hardware-agnostic vertex data, including the UV map
mymodel.phy: Collision mesh data

@@ Line 1: / Line 1: @@
-{{otherlang2|ru=Studiomdl:ru|es=Studiomdl:es}}
+{{lang|Studiomdl}}
 :''For a guide to studiomdl's usage, see [[Compiling a model]].''
 {{toc-right}}
 '''Studiomdl''' is the [[command-line]] tool used to compile [[model]]s from intermediate formats exported from modeling packages to the binary .mdl format that is read by the Source engine.
-It can be found at <code>"common\<gamename>\<gamefolder>\bin\studiomdl.exe"</code>.
+It can be found at <code>common\<gamename>\<gamefolder>\bin\studiomdl.exe</code>.
-{{tip|The name "studio" is a throwback to the development of [[Half-Life 1]], during which Valve used [[3D Studio Max]] to create their models.}}
+{{tip|The name "studio" is a throwback to the development of {{hl|2}}, during which Valve used [[3D Studio Max]] to create their models.}}
-{{bug| Attempting to use Studiomdl or a shortcut of it pinned to the taskbar in Windows 8 will result in an invalid target path even when -game and an associated path is specified. However using a shortcut on the desktop still works. This is an issue on Microsoft's end unfortunately.}}
+{{bug| Attempting to use Studiomdl or a shortcut of it pinned to the taskbar in Windows 8 will result in an invalid target path, even when <code>-game</code> and an associated path are specified. Using a shortcut on the desktop, however, still works. This is an issue on Microsoft's end, unfortunately.}}
 == Parameters ==
+The only parameter required is a [[QC|QC file]]. Any others must come ''before'' it.
-The only parameter required is a [[Qc|QC file]]. Any others must come ''before'' it.
   studiomdl [options] <path\QC>
 === General ===
 ;<code>-game <gamedir></code>
 :Override the VProject game path.
 ;<code>-quiet</code>
-:Suppresses <i>some</i> console output, such as spewing the searchpaths.
+:Suppresses ''some'' console output, such as spewing the searchpaths.
 ;<code>-x360</code>
-:Enable Xbox 360 output, overriding the [[Gameinfo.txt]]
+:Enable Xbox 360 output, overriding the {{ent|Gameinfo.txt}}
 ;<code>-nox360</code>
-:Disable Xbox 360 output, overriding the [[Gameinfo.txt]]
+:Disable Xbox 360 output, overriding the <code>Gameinfo.txt</code>
 ;<code>-nowarnings</code>
 :Disable warnings.
@@ Line 33: / Line 30: @@
 === Animation ===
 ; <code>-definebones</code>
-: See [[$definebone]].
+: See {{ent|$definebone}}.
 ; <code>-printbones</code>
 : Writes extra bone info to the console.
@@ Line 41: / Line 37: @@
 : {{Todo|Appears to dump xnode data for each node?}}
 ; <code>-overridedefinebones</code>
-: Equivalent to specifying [[$unlockdefinebones]] in QC.
+: Equivalent to specifying {{ent|$unlockdefinebones}} in QC.
 ; <code>-checklengths</code>
 : Prints engine-ready keyframe data for each animation.
 === Performance ===
 ; <code>-fastbuild</code>
-: Skip processing DX7, DX8, X360, and software VTX variants (use .dx90.vtx only). This speeds up compiling.
+: Skip processing DX7, DX8, X360, and software VTX variants (use <code>.dx90.vtx</code> only). This speeds up compiling.
 ; <code>-preview</code>
 : Skip splitting quads into tris. This changes the rendering flags for the model, most likely resulting in slower performance or buggier rendering in-engine.
-; <code>-fullcollide</code>
+; <code>-fullcollide</code> {{src06|only}}
-: Don't truncate really big [[collision mesh]]es (Ep1 only; OB uses [[$maxconvexpieces]]).
+: Don't truncate really big [[collision mesh]]es {{src07|since|addtext=, use {{ent|$maxconvexpieces}}}}.
 ; <code>-striplods</code>
-: Ignore all [[$lod]] commands.
+: Ignore all {{ent|$lod}} commands.
 ;<code>-minlod <lod></code>
-:Throw away data from LODs above the given one (see [[$minlod]]).
+:Throw away data from LODs above the given one (see {{ent|$minlod}}).
 ;<code>-mdlreport <path\model.mdl></code>
 :Report performance info for an already-compiled model. A QC file is not needed when using this command.
 ;<code>-perf <path\model.mdl></code>
-:Same as '''-mdlreport'''.
+:Same as <code>-mdlreport</code>.
 ;<code>-mdlreportspreadsheet</code>
-:Report performance info, per LOD, as a comma-delimited spreadsheet. It will appear in the form:
+:Report performance info, per-LOD, as a comma-delimited spreadsheet. It will appear in the form:
 :<source>Path to VTX, VTX file extension, LOD number (1 is the root lod), tri count, number of batches rendered, number of materials used </source>
-:'''Must be used with -mdlreport or -perf!''' {{Note|It doesn't actually <i>write</i> a spreadsheet to disk.}}
+:'''Must be used with -mdlreport or -perf!''' {{Note|It doesn't actually ''write'' a spreadsheet to disk.}}
 === Debug ===
 ;<code>-d</code>
 :Dumps various [[glview]] files (10 per LOD per VTX file),
@@ Line 86: / Line 80: @@
 === Other ===
 ;<code>-nop4</code>
 :Disables Valve's Perforce integration. Unless you actually have Perforce set up for your game/mod (a highly unlikely scenario), you should use this.
@@ Line 93: / Line 86: @@
 ;<code>-a <normal_blend_angle></code>
 :Auto-smooth faces equal to or below specified angle. Will override normal data for all meshes.
-;<code>-f</code>
+;<code>-f</code> {{src07|removed}}
 :Flip all triangles.
-:{{bug|Does not work in Orangebox and later builds of Studiomdl. You can achieve the same behavior with [[$body]], however.}}
+:{{bug|Does not work in Orange Box and later builds of Studiomdl. You can achieve the same behavior with {{ent|$body}}, however.}}
 ;<code>-vsi <path\[QC|MDL]></code>
 :Generates a [[VSI]] file from a [[QC]] or [[MDL]].
@@ Line 110: / Line 103: @@
 === Nonfunctional ===
 ;<code>-r</code>
 :"Tag reversed".
@@ Line 117: / Line 109: @@
 == Input Files ==
-StudioMDL supports a range of input formats. These include [[Studiomdl Data|SMD]], [[DMX model|DMX]], and [[OBJ]] for reference meshes and [[VTA]] files for vertex and flex animation. {{csgo}} [[Counter-Strike: Global Offensive]] also supports [[FBX]], but with limited functionality. [[Flex_animation|Flexes]] are not directly supported, nor are FBX sequences, however an SMD/DMX sequence can be used on an FBX model.
+StudioMDL supports a range of input formats. These include [[Studiomdl Data|SMD]], [[DMX model|DMX]], and [[OBJ]] for reference meshes and [[VTA]] files for vertex and flex animation. {{csgo|2}} also supports [[FBX]], but with limited functionality. [[Flex_animation|Flexes]] are not directly supported, nor are FBX sequences, however an SMD/DMX sequence can be used on an FBX model.
 {{note|While FBX does technically seem to support flex animations, an SMD file is required to generate the VTA file, making the use of an FBX file for flexes redundant.}}
 == Output files ==
 ;<code>mymodel.mdl</code>
-:[[Skeleton]], animations, bounding/hit boxes, surface materials, [[LOD]] index...
+:[[Skeleton]], animations, bounding/hit boxes, surface materials, [[LOD]] index…
 ;<code>mymodel.sw.vtx</code>
 ;<code>mymodel.360.vtx</code>
 ;<code>mymodel.dx80.vtx</code>
 ;<code>mymodel.dx90.vtx</code>
-:Vertex data optimised for software rendering, XBox 360, DirectX 7, 8 and 9 respectively. {{Note|.360.vtx files are just byteswapped .dx90.vtx files.}}
+:Vertex data optimised for software rendering, XBox 360, DirectX 7, 8 and 9 respectively. {{Note|<code>.360.vtx</code> files are just byteswapped <code>.dx90.vtx</code> files.}}
 ;<code>mymodel.vvd</code>
 :Remaining hardware-agnostic vertex data, including the [[UV map]]
@@ Line 135: / Line 126: @@
 :Collision mesh data
-== See also ==
+== See Also ==
+* [[Compiling a model#Common errors|Common Studiomdl errors]]
-* [[Compiling a model#Common_errors|Common Studiomdl errors]]
 * [[Crowbar]], a popular graphical interface for studiomdl which also supports model decompiling and other advanced features.
 * [[Studiocompiler]], a graphical interface for studiomdl
@@ Line 143: / Line 133: @@
 * [[Source Model Compiler]], a web based model compiler and QC generator.
 * [https://gamebanana.com/tuts/12511 Fixing the 5% Weight Bone Link Cull], for SFM
+{{SDKTools}}[[Category:Modeling]]
-{{SDKTools}}
-[[Category:Modeling]]

StudioMDL (Source): Difference between revisions

Revision as of 09:59, 10 May 2022

Contents