This article relates to the game "Half-Life: Alyx". Click here for more information.
This article relates to the workshop tools for "Half-Life: Alyx". Click here for more information.
This article's documentation is for Source 2. Click here for more information.

ModelDoc Editor

From Valve Developer Community
Jump to: navigation, search

ModelDoc Editor enables an end-user to create, view, and edit models, all in a single tool.

Launching ModelDoc Editor

Like the rest of the tools, ModelDoc Editor can be opened in a variety of ways. You can:

  • Launch an empty session via the ModelDoc Editor icon from the Asset Browser:
    ModelDoc Editor Button.png
  • Launch an empty session through the Tools menu. This menu is visible within all tools:
    ModelDoc Editor from tools menu.png
  • Finally, you can open a model directly from the Asset Browser. Simple double-click a model in the Asset Browser, OR right click on it, and select Open in Model Editor:
    Model editor from asset.JPG

Understanding ModelDoc

The ModelDoc Editor, with a blank scene.

ModelDoc uses a node-based system for putting together models, but maybe not in the way you'd think. Nodes are stored in the Outliner, which is organized by Categories, each with their own unique settings and properties that are worth taking a once over.

Note.png Note: You can view all the available nodes for models and their settings by selecting "Show Empty Categories."

To preview your model as you're working on it, you have to manually compile it, using the HLVR-ModelDoc-NeedsCompiling.png button.

To add a mesh to your model, you will need to right click the Outliner, and add a Mesh Node to your model. This can be done by either finding the desired mesh node (usually RenderMeshFile) or more easily, clicking the "Add Meshes..." button which does the same thing.

The "Add Note Type" Dialog

Now, click the "Compile Model" button and your model should render! Usually though, your model won't spawn with it's textures, as it'll look for materials that aren't there. To override your materials from the .fbx file, add a new node called "DefaultMaterialGroup" which will override your default materials.

This is the most basic setup for compiling a model. You can now load it in Hammer, S2FM, or whatever tool you wish to use it with. And as long as your .vmdl exists in /content/ you will be able to go back and made modifications to the model! The final compiled model will be found in your mod's /game/ folder, in the same path it's in as /content/ is.

See also