Porting GoldSrc content to Source: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
Tag: New redirect
Line 1: Line 1:
{{Language subpage}}
#REDIRECT [[Porting GoldSrc content (maps, models, etc.) to Source]]
{{mergeto|Converting Textures}}
 
Porting a [[Goldsource]] model to the Source engine is a short process. For best results, have all original source content ready for the model: original 3d package file, textures, and [[Qc|.QC]] file. [[SMD]] files may also be useful if the original 3d package file is unavailable.
 
For the most part, porting models is straightforward: Set the [[VPROJECT]] properly, convert old textures to [[VTF]] format, tweak .QC file to include new Source syntax, and then compile the new content into a new Source model file.
 
=Set VPROJECT=
 
{{main|Game Directory}}
 
The VPROJECT variable is referenced by several [[Source SDK]] tools: basically, it directs applications where to find or place compiled models (.MDL) and materials (.VTF). [[Studiomdl]] and [[Vtex (Source 1)|Vtex]] both use VPROJECT to place compiled models and materials in the correct directory. [[Half-Life Model Viewer]] (HLMV) uses VPROJECT to find model materials. To set the VPROJECT (Current Game), use the [[Source SDK launcher]] or [[The Game Directory#Using VConfig to set the game directory|VConfig.exe]].
 
=Convert old textures to new materials=
 
{{seealso|[[Material system]]}}
 
In the GoldSrc engine, [[Wikipedia:BMP_file_format|.BMP]] textures designed for Models were compiled into the [[.mdl|.MDL]] file, while the other [[Wikipedia:BMP_file_format|.BMP]] textures are stored in the [[.wad|.WAD]] file. However in the Source engine, developers export textures as [[.vtf|.VTF]] files, which are simply referenced and not actually compiled into the .MDL file.
 
Originally, in the preliminary release of the Source SDK, developers were confined to using the included command-line exporter [[Vtex (Source 1)|Vtex]] to compile materials. Since then, a variety of community produced tools provide Windows-friendly GUIs and interfaces, batch conversions, and texture previewing. [[VTFEdit|VTFedit]] is highly recommended; though there are also [[VTF#Utilities|other tools available]]. This tutorial will assume that the user is using Vtex.
 
{{main|Creating a Material}}
 
First, convert all old texture files to .TGA format, using Photoshop or a similar image editing application.
 
# Create a shortcut to vtex.exe on your desktop. Vtex.exe is located in the SourceSDK\bin directory.
# Right-click the shortcut and select the "Properties" option.
# In the "Target" box, add <code>-mkdir -shader vertexlitgeneric</code> after vtex.exe with a space between them. Click OK.
 
Use this shortcut when converting new materials by dragging each .TGA file onto the desktop shortcut itself. The argument "-mkdir" will automatically create the materialsrc directory. The argument <code>-shader VertexLitGeneric</code> tells Vtex to automatically make a new .VMT that points to the .VTF as the diffuse texture.
 
{{note|The VertexLitGeneric shader is only used for models; it should not be used for sprites or brushes. Check the [[:category:Material System|Materials]] documentation for more info.}}
 
=Export .SMD files=
 
{{seealso|[[Model Creation Overview#.SMD_files|Model Creation Overview]]}}
 
If the original 3D model file is lost, use an SMD plug-in (e.g. Valve Addon for Softimage|XSI) and import the .smd directly for editing.
 
=Modify .QC file=
 
{{main|Qc}}
 
While old .QC files will work with the new Studiomdl, there have been syntax changes for Source models to compile correctly.
 
* <code>$modelname</code> now works in conjunction with VPROJECT and automatically assumes a directory output location of VPROJECT + a 'models' directory. For example: <code>C:\Program Files\Valve\Steam\SteamApps\SourceMods\MyMod\models</code>. So if <code>$modelname</code> were set to "player\myplayer.mdl", Studiomdl will compile the model and write it to <code>C:\Program Files\Valve\Steam\SteamApps\SourceMods\MyMod\models\player\myplayer.mdl</code>.
* Replace <code>$cdtexture</code> with <code>$cdmaterials</code>. <code>$cdmaterials</code> also uses VPROJECT and assumes the output directory to be VPROJECT + 'materials' directory. For example: <code>C:\Program Files\Valve\Steam\SteamApps\SourceMods\MyMod\materials</code>. Break the material directory tree up based on context - in this case, a model. Keeping the same example as in the <code>$modelname</code> step above, set <code>$cdmaterials</code> to "models\player" so that the model will look for materials in the directory <code>C:\Program Files\Valve\Steam\SteamApps\SourceMods\MyMod\materials\models\player</code>.
 
=Create a Collision Model (Physbox)=
 
{{seealso|[[Physics and Ragdolls]]}}
 
A "collision model" is the simplified mesh that defines how the model will interact with the world when it is being physically simulated. This document will not cover the details of creating a physbox. While Studiomdl will create a physics hull if one is not specified, the result will be extremely simple. It will not "vacuum seal" the model; it will simply connect all the furthest points of the model together directly. To demonstrate, imagine looking down on a model and that it is shaped like a plus sign.
 
The most correct collision hull would resemble the plus sign.
 
[[Image:Phys_demo2.jpg]]
 
The automatically generated collision hull would connect all the most extended parts directly.
 
[[Image:Phys_demo3.jpg]]
 
In some cases, it is acceptable if the object is insignificant or does not interact with the player or the game world. However, if the example object were a revolving door, then this physbox would be unacceptable.
 
=Compile the Model=
 
{{main|Compiling Models}}
 
The actual process of compiling hasn't changed outside of Studiomdl using VPROJECT. To associate .QC files with Studiomdl for double-click compiling:
 
# Open a Windows Explorer. (Windows Key + E)
# At the top of the window, click "Tools", then "Folder Options...".
# Click the "File Types" tab then scroll down to QC. If you do not have a QC extension in your list, you can add it by hitting the "New" button below the list, and enter "QC" in the box. Hit "OK" to enter the extension into the list.
# Click the QC extension. It should become highlighted.
# In the "Details for 'QC' extension" area of the "Folder Options" panel, click the "Change..." button to the right of the text "Opens with:".
# Click the "Browse..." button at the bottom right of the "Open With" panel.
# Browse to the file "studiomdl.exe" in the SDK tools. Click the "Open" button.
# Make sure that "studiomdl.exe" is highlighted in the "Open With" panel. Click the "OK" button.
# Close the "Folder Options" panel with the "Close button.
 
=Check the Model with the Half-Life Model Viewer=
 
Find the [[Half-Life Model Viewer]] in the "Bin" directory with the rest of the Source SDK tools, and open the model. Some common problems:
 
* A black and pink checkerboard texture: the materials are not in the location specified by the .QC file or the materials did not compile correctly (you can check that with hammer for example).
* Incorrect collision hull: select the "Render" tab and click the "Physics Model" checkbox to view the model's collision hull.
 
=Mapping=
{{main|Porting GoldSrc maps to Source}}
 
Hammer 4.x has backwards compatibility for both .map files and .rmf files. Attempting to open .map files in Hammer 4 can sometimes result in the application freezing or crashing; if this happens, open it in Hammer 3.5 or [[JACK]] first, save as RMF/VMF, then open in Hammer 4.
 
==External Links==
*[https://developer.valvesoftware.com/wiki/User:NOUG4AT/Porting_GoldSrc_content_(maps,_models,_etc.)_to_Source Noug4at' tutorial on porting goldsource content]

Revision as of 14:50, 23 June 2023

Redirect to:

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Porting_GoldSrc_content_to_Source&oldid=320926"