VRAD: Difference between revisions

Revision as of 08:11, 19 March 2025

Source Engine

Source 2

VBSP ▶ VVIS ▶ VRAD ▶ BSPZIP

VRAD is the command-line tool for Source that takes a compiled BSP map and embeds lighting data into it. VRAD's static and pre-compiled light is bounced around the world with a radiosity algorithm.

VRAD will:

Generate lightmaps
Generate ambient samples
Generate per-vertex prop_static lighting
Generate per-object detail prop lighting

VRAD is generally the slowest of the three compilers due to the many, many calculations it must perform. Lighting optimization can help, as can ensuring your map is free of leaks.

Syntax

vrad [options...] <bsp file>

For example, a regular compile would look like thus:

"Half-Life 2\bin\vrad.exe" -both -StaticPropLighting -StaticPropPolys -TextureShadows sdk_trainstation_01

This will generate and embed both Standard and High Dynamic Range lighting data, at per-vertex detail for prop_static entities. It also generates shadows based on transparency for prop_static entities that have been flagged as casting texture shadows.

Options

Use these in combination with expert compile mode, a batch file, or a frontend such as Compile Pal.

Effects

Todo: Split some of the game-specific options into their own page section.

Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO

-aoscale - Examples
-aoscale set to 0.25 -aoscale set to 2.0

Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO

Examples
Disabled. Enabled.

Template:CLIO

Expriemental AO examples
Ambient occlusion. Experimental ambient occlusion.

Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO

-PortalTraversalLighting - Examples
Without `-PortalTraversalLighting`. With `-PortalTraversalLighting`.

Template:CLIO

-PortalTraversalAO - Examples
Without `-PortalTraversalLightingAO`. With `-PortalTraversalLightingAO`.

Template:CLIO Template:CLIO Template:CLIO

-worldtextureshadows - Examples
Disabled. Enabled.

Template:CLIO

-translucentshadows - Examples
Disabled. Enabled.

Template:CLIO Template:CLIO

Performance

Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO

Template:CLIO

Todo: Find out if this is branch specific, as it doesn't work with TF2.

Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO

Debugging

Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO

Debug mode options

If VRAD is compiled in debug mode or the #if ALLOWDEBUGOPTIONS preprocessor is removed, additional options are available. Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO Template:CLIO

Lights files

Main article: RAD file#Source 1

Console Output

Todo: Add description about missing outputs output (BuildVisLeafs, other)

Bugs and Caveats

Warning:VRAD does not compile shadows based on transparent/translucent brushes or displacements. If you must have shadows made by a brush (such as a fence texture), you can turn the brush into a prop via

SourceIO,

Crafty or Propper++ and put it into the RAD file or compile with $casttextureshadows. Alternatively, use an existing fence prop or the "blocklight" tool texture.

Tip:(only in

) You can use -worldtextureshadows to make vrad compile shadows based on brush alpha channels (but not displacements).

Warning:VRAD will use 100% of your CPU unless specified otherwise with the -threads # launch option.

Bug:In

and

, users seeing crashes when VRAD compiles HDR lighting should read VRAD HDR Crash Fix.

Bug:In games before

, .mdl files that don't have .dx80.vtx files with them will lead to VRAD skipping lighting for that prop. Copying the .dx90.vtx file and renaming it to a .dx80.vtx will fix the issue.

Tip:A windows batch file to do this automatically has been created here, extract the zip contents into your game's models folder and run the included .ps1 file.

Note:

is exempt from this issue.

(tested in:

)

Bug:.mdl files that have the IDST1 header will fail to load for VBSP, and will give a error message stating the prop failed to load; this can be fixed by changing the header to IDST0 in a Hex Editor, or by recompiling the prop in a non-L4D branch Studiomdl application such as Source 2013. [todo tested in ?]

Bug:Since the release of Source SDK 2013 up until at least October 2017, all known copies of VRAD have a thread sharing bug which causes performance to scale poorly to multiple threads, particularly on outdoor scenes with -final set (despite showing 100% CPU usage). The fix to this bug for Source 2013 is available here and edited DLLs are available here. This issue is fixed in

,

and

.

Todo: Is this fixed in

? Also in Source 2007 and earlier, and Alien Swarm SDK, raytrace.cpp isn't present so check if these versions also have the bug or not.

(tested in:

)

Bug:Randomly causes corrupt lightmaps that look like "ink spills" or light splotches. These can be mostly avoided by not using very long or diagonal brushes, as well as not having too low of a light level in your indoor areas.

Tip:Source Engine BSP Lightmap Editor can be used to manually correct a .bsp lightmap data.

[todo tested in ?]

Note:If you are watching the compile dialog and it looks like it has hung at 9... this is usually because VRAD takes longer with each calculation.

Clarify: This isn't due to bounce calculations.^[1]

Bug:VRAD is unable to calculate texture shadows for textures using DXT3 compression. Use DXT5 instead. (tested in:

)

Note:Super sampling is not implemented on displacements (before

) and lightmapped props. The former is fixed in

Slammin' Source Map Tools.

Workaround:For the latter, compile the lightmap at a higher resolution than necessary, then downscale it and use as a $lightmap.

@@ Line 234: / Line 234: @@
 {{CLIO|noskyboxrecurse|Turn off recursion into 3d skybox (skybox shadows on world).}}
 {{CLIO|nossprops|Globally disable self-shadowing on static props.}}
-{{CLIO|dumppropmaps|Dump computed static prop lightmaps as [[TGA]] files.{{tip|This can be used to create lightmaps for dynamic props, using the {{ent|$lightmap}} shader parameter.}}{{tip|To pair static props in a map with their dumped lightmaps, use {{Cmd|r_staticpropinfo|2}} to show static prop IDs on screen.}}{{bug|hidetested=1|The resulting TGAs are written with the wrong color space {{fixed|{{gmod}}}}; convert the resulting [[PPL]] files instead. This command can be useful for indicating which model and at what location each prop is, which the PPL filenames lack.}} |game={{only|{{2013MP}}{{gmod}}}}}}
+{{CLIO|dumppropmaps|Dump computed static prop lightmaps as [[TGA]] files.{{tip|This can be used to create lightmaps for dynamic props, using the {{ent|$lightmap}} shader parameter.}}{{tip|To pair static props in a map with their dumped lightmaps, use {{Cmd|r_staticpropinfo|2}} to show static prop IDs on screen.}}{{bug|hidetested=1|The resulting TGAs are written with the wrong color space {{fixed|{{gmod}}}}; convert the resulting [[PPL]] files instead. This command can be useful for indicating which model and at what location each prop is, which the PPL filenames lack.}} |game={{only|{{src13mp}}{{gmod}}}}}}
 {{CLIO|unlitdetail|Disables lighting for detail props.|game={{only|{{csgo}}}}}}
 {{CLIO|reflectivityScale|param=float|Scale the [[$reflectivity]] of all textures. Default 1.0|game={{only|{{slamminsrc}}}}}}

VRAD: Difference between revisions

Revision as of 08:11, 19 March 2025

Contents

Syntax