|
|
| Line 1: |
Line 1: |
| {{lang|VRAD}} | | {{Multipage}} |
| {{toc-right}}
| |
| | |
| '''VRAD''' is the [[command-line]] tool 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 [[Wikipedia:Radiosity (3D computer graphics)|radiosity]] algorithm.
| |
| VRAD will:
| |
| | |
| * Generate [[lightmap]]s
| |
| * Generate [[Ambient light|ambient samples]]
| |
| * Generate per-object or per-vertex [[prop_static]] and [[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 [[leak]]s.
| |
| | |
| {{ModernWarning|Vrad does not compile shadows based on Brush entities alpha channel. If you must have shadows made by a brush entities fence texture , turn the brush entity into a prop via [[SourceIO]], [[crafty]] or [[propper]] and put it into your lights.rad. Alternatively, use an existing fence prop.}}
| |
| | |
| {{ModernTip|If you are watching the compile dialog and it looks like it has hung at ''<code>9...</code>'' this is usually because VRAD takes longer with each light bounce calculation. You can use <code>-bounce</code> to limit the amount of bounces for faster compilation.}}
| |
| | |
| {{ModernBug|In {{ep1}}{{l4d}}, users seeing crashes when VRAD compiles HDR lighting should read [[VRAD HDR Crash Fix]].}}
| |
| | |
| {{ModernBug|In games before {{l4d}}, <code>.mdl</code> files that don't have <code>.dx80.vtx</code> files with them will lead to VRAD skipping lighting for that prop. Copying the <code>.dx90.vtx</code> file and renaming it to a <code>.dx80.vtx</code> will fix the issue.
| |
| : {{Tip|A windows batch file to do this automatically has been created [https://drive.google.com/file/d/1OlQcFDlJPbK5vp6PTv7CZGXBjF9Z1UU0 here], place above model folder and run .bat.}}
| |
| : {{Note|{{Dmmm}} is exempt from this issue.}}}}
| |
| | |
| {{ModernBug|<code>.mdl</code> files that have the <code>IDST1</code> 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 <code>IDST0</code> in a Hex Editor, or by recompiling the prop in a non-L4D branch [[Studiomdl]] application such as Source 2013.}}
| |
| | |
| {{ModernWarning|VRAD will use 100% of your CPU unless specified otherwise with the -threads # launch option.}}
| |
| | |
| {{ModernBug|As of around 5-10 years ago 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 [https://github.com/ValveSoftware/source-sdk-2013/pull/436 here] and edited DLLs are available [http://www.content.tophattwaffle.com/Content/modded_vrad_dll.zip here]. This issue is fixed in {{csgo}} and {{tf2}}}}
| |
| | |
| {{ModernBug|Randomly causes corrupt lightmaps that look like "ink spills". 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|[https://github.com/Enderlux/sourcelightmap Source Engine BSP Lightmap Editor] can be used to manually correct a <code>.bsp</code> lightmap data.}}}}
| |
| == Syntax ==
| |
| | |
| vrad [options...] <bsp file>
| |
| | |
| For example:
| |
| | |
| "Half-Life 2\bin\vrad.exe" -both -StaticPropLighting sdk_trainstation_01
| |
| | |
| This will generate and embed both standard and [[HDR|High Dynamic Range]] lighting data, at per-vertex detail for prop_static entities.
| |
| | |
| ==Options==
| |
| | |
| Use these in combination with [[expert compile mode]] or a batch file.
| |
| | |
| === Effects ===
| |
| {{ColumnBox|count=1|{{IO|-ldr}}
| |
| {{IO|-hdr}}
| |
| {{IO|-both|Whether to compile Standard Dynamic Range lighting, [[HDR|High Dynamic Range]] lighting, or both respectively.
| |
| : {{note|Since {{l4d2}}, SDR support was dropped. Thus making <code>-ldr</code> and <code>-both</code> obsolete in engine branches made on or after {{l4d2}}. Instead, <code>-hdr</code> is required in order to produce proper lighting for your map.}}
| |
| : {{note|{{bms}} defaults to compiling HDR automatically.}}}}
| |
| {{IO|-fast|Compiles quick low quality lighting. Used for quick previewing.
| |
| : {{Note|<code>-fast</code> will cause random and miscolored splotching to appear in darker areas. As well as shadowed edges around Displacements. It is advised to not ship your map using <code>-fast</code>.}}}}
| |
| {{IO|-final|Increases the quality of {{Ent|light_environment}} and indirect lighting by spending more time firing rays.<br>{{csgo}} Sets<code>-StaticPropSampleScale</code> to 16.}}
| |
| {{IO|-extrasky|param=int|Trace N times as many rays for indirect light and sky ambient. {{clr}}(<code>-final</code> is equivalent to <code>-extrasky 16</code>; normal is equivalent to <code>-extrasky 1</code>)}}
| |
| {{IO|-lights <filename>.rad|Load a custom [[#Lights_files|lights file]] in addition to <code>lights.rad</code> and the map-specific lights file. Include the file extension in the parameter.}}
| |
| {{IO|-bounce|param=int|Set the maximum number of light ray bounces. (default: 100).}}
| |
| {{IO|-smooth|param=int|Set the threshold for [[smoothing group]]s, in degrees (default: 45).}}
| |
| {{IO|-luxeldensity|param=normal|Scale down all luxels. Default (and maximum) value is 1.}}
| |
| {{IO|-reflectivityScale|param=float|Scale the [[$reflectivity]] of all textures. Default 1.0}} (Does not work in {{css}})
| |
| {{IO|-softsun|param=float|Treat the sun as an area light source of this many degrees. Produces soft shadows. Recommended values are 0-5, default is 0. Identical to the SunSpreadAngle parameter for <code>light_environment</code>, use that instead.}}
| |
| {{IO|-StaticPropLighting|Generate per-vertex lighting on {{Ent|prop_static}}s; always enabled for {{Ent|light_spot}} entities. Disables {{Ent|info_lighting}} entities on props without [[bump maps]]. Does not work on props with bump maps, except in {{csgo}}.
| |
| : {{Warning|This can increase your map's filesize substantially. Disable vertex lighting for props that don't need it to keep filesize low.}}
| |
| : {{note|In {{csgo}}, in order to get proper lighting on your static props, you will need to run VRAD with this command.}}|since=EP2}}
| |
| {{IO|-StaticPropPolys|Use the actual meshes of static props to generate shadows instead of using their [[collision mesh]]es. This results in far more accurate shadowing.|since=EP2}}
| |
| {{IO|-TextureShadows|Generates lightmap shadows from {{Command|$translucent}} surfaces of models (NOT brushes) that are specified in a [[#Lights_files|lights file]] and being used with <code>prop_static</code>. Usually requires <code>-StaticPropPolys</code> to have any effect.
| |
| : {{note|A surface will need a low [[lightmap]] scale for most texture shadows to be recognisable.}}
| |
| : {{note|This will not work if a translucent texture's $basetexture parameter in the VMT contains the .vtf file extension.}}|since=EP2}}
| |
| {{IO|-aoscale|param=float|Scales the intensity of VRAD's simulated ambient occlusion. 1.0 is default.
| |
| : {{Tip|Valve uses 1.5 for the new Dust 2.}}|since=CSGO}}
| |
| {{IO|-aoradius|param=float|Set the radius of VRAD's simulated ambient occlusion. {{TODO|Figure out what exactly this does.}}|only={{Nwi_games}}}}
| |
| {{IO|-aosamples|param=int|How many samples to use for VRAD's simulated ambient occlusion.|only={{Nwi_games}}}}
| |
| {{IO|-StaticPropBounce|param=int|Number of static prop light bounces to simulate. The default is 0.
| |
| : {{Tip|Valve uses 3 static prop bounces for the new Dust 2.}}
| |
| : {{Note|Any static props that you want light to bounce off of must also have their "Enable Bounced Lighting" keyvalue set.}}|only=CSGO}}
| |
| {{IO|-StaticPropLightingFinal|{{obs}} Replaced by <code>-final</code>.|only=CSGO}}
| |
| {{IO|-StaticPropLightingOld|Will use the old lighting algorithm on props, light affects them much more.|only=CSGO}}
| |
| {{IO|-choptexlights|Enables chopping of texture lights generated from a lights file. Control texture light quality with lightmap density in Hammer. Dramatically increases both texture light quality and compile time.|only=BMS}}
| |
| {{IO|-extratransfers|Enable overscaling of light transfers.|only=BMS}}
| |
| {{IO|-transferscale|param=float|This is the scale factor of light transfers. Increased values make surfaces transfer extra light (scale of 2-4 suggested). Default 1.0.|only=BMS}}
| |
| {{IO|-satthresh|param=float|This is the threshold that checks how saturated a material color is. Used with <code>-satthreshscale</code>. Default 0.4.|only=BMS}}
| |
| {{IO|-satthreshscale|param=float|The amount to scale light transfers from surfaces that pass the saturation threshold. Default 3.0.|only=BMS}}
| |
| {{IO|-ambientocclusion|Enable lightmapped ambient occlusion|only=BMS}}
| |
| {{IO|-experimentalambientocclusion|Use an improved algorithm for the ambient occlusion|only=BMS}}
| |
| {{IO|-cascadeshadows|indicates that lightmap alpha data is interleved in the lighting lump, required for CSM.|only=BMS}}
| |
| {{IO|-realskylight|Enables VRAD to compute skylight ambient color by using actual values from skybox.|only=BMS}}
| |
| {{IO|-realskylightscale|param=float|Scale factor of -realskylight intensity. Default: 1.0|only=BMS}}
| |
| {{IO|-directsunlightisforadditivemode|Toggles direct sunlight for additive mode.|only=BMS}}
| |
| {{IO|-ambient|param=vector|Sets the ambient term. Can be used to tweak lightmap color. Appears to just mix the color into all lightmaps.|only=CSGO|also={{Dmmm}}}}
| |
| {{IO|-PortalTraversalLighting|Enables static lights to go through static worldportals.|only={{P2CE}}}}
| |
| {{IO|-PortalTraversalAO|Enables static light AO to go through static worldportals.|only={{P2CE}}}}
| |
| }}
| |
| | |
| === Performance ===
| |
| | |
| {{ColumnBox|count=1|{{IO|-low|Run as a low-priority process.}}
| |
| {{IO|-threads|param=int|Override the number of CPU threads used. Maximum is 16 threads (32 in {{csgo}}, unlimited in {{tf2}}). With a [[Increased_Thread_Limit_for_Compile_Tools|patched vrad_dll]] you can use 32 threads.}}
| |
| {{IO|-mpi|Use [[Vmpi|VMPI]] to distribute computations.}}
| |
| {{IO|-mpi_pw|param=string|Use a password to choose a specific set of VMPI workers.}}
| |
| {{IO|-noextra|Disable supersampling. This will lead to blockier, more inaccurate lighting.}}
| |
| {{IO|-chop|param=int|Smallest number of [[luxel]] widths for a bounce patch, used on edges. (Default: 4)}}
| |
| {{IO|-maxchop|param=int|Coarsest allowed number of luxel widths for a patch, used in face interiors. (Default: 4)}}
| |
| {{IO|-dispchop|param=int|Smallest acceptable [[luxel]] width of displacement patch face. (Default: 8)}}
| |
| {{IO|-LargeDispSampleRadius|This can be used if there are splotches of bounced light on terrain. The compile will take longer, but it will gather light across a wider area.}}
| |
| {{IO|-compressconstant|param=int|Compress [[lightmap]]s whose color variation is less than this many units.}} {{todo|Find out if this is branch specific, as it doesn't work with TF2.}}
| |
| {{IO|-fastambient|Uses low quality per-leaf ambient sampling to save compute time.}}
| |
| {{IO|-LeafAmbientSampleReduction|param=float|Reduction factor for ambient samples. Defaults to 1.0.|only=CSGO}}
| |
| {{IO|-noao|Disables compiling simulated ambient occlusion for lightmaps.|only={{Nwi_games}}}}
| |
| {{IO|-StaticPropSampleScale|param=float|Regulates the generated per-vertex prop_static lighting.
| |
| : slow: 16 (high quality); default: 4 (normal); fast: 0.25 (low quality)
| |
| : {{note|-final is the equivalent of having -StaticPropSampleScale 16.}}|only=CSGO}}
| |
| {{IO|-disppatchradius|param=float|Sets the maximum radius allowed for displacement patches.}}
| |
| {{IO|-ambientfromleafcenters|Samples ambient lighting from the center of the leaf.|only=CSGO}}
| |
| }}
| |
| | |
| === Debugging ===
| |
| | |
| {{ColumnBox|count=1|{{IO|-rederrors|Emit red light when "a luxel has no samples".}}
| |
| {{IO|-vproject <directory>}}
| |
| {{IO|-game <directory>|Override the VPROJECT environment variable.}}
| |
| {{IO|-insert_search_path <directory>|Includes an extra base directory for mounting additional content (like [[Gameinfo.txt]] entries). Useful if you want to separate some assets from the mod for whatever reason.}}
| |
| {{IO|-v}}
| |
| {{IO|-verbose|Turn on verbose output.}}
| |
| {{IO|-novconfig|Don't bring up graphical UI on vproject errors.}}
| |
| {{IO|-dump|Dump patches to debug files.}}
| |
| {{IO|-dumpnormals|Write normals to debug .txt files.}}
| |
| {{IO|-debugextra|Places debugging data in lightmaps to visualize supersampling.}}
| |
| {{IO|-dlightmap|Force direct lighting into different lightmap than radiosity.}}
| |
| {{IO|-stoponexit|Wait for a keypress on exit.}}
| |
| {{IO|-nodetaillight|Don't light detail props.}}
| |
| {{IO|-centersamples|Move sample centers.}}
| |
| {{IO|-loghash|Log the sample hash table to samplehash.txt.}}
| |
| {{IO|-onlydetail|Only light detail props and per-leaf lighting.}}
| |
| {{IO|-maxdispsamplesize|param=int|Set max displacement sample size (default: 512).}}
| |
| {{IO|-FullMinidump|Write large minidumps on crash.}}
| |
| {{IO|-OnlyStaticProps|Only perform direct static prop lighting.}}
| |
| {{IO|-StaticPropNormals|When lighting static props, just show their normal vector.}}
| |
| {{IO|-noskyboxrecurse|Turn off recursion into 3d skybox (skybox shadows on world).}}
| |
| {{IO|-nossprops|Globally disable self-shadowing on static props.}}
| |
| {{IO|-dumppropmaps|Dump computed prop lightmaps.|only=2013MP}}
| |
| {{IO|-unlitdetail|Disables lighting for detail props.|only=CSGO}}
| |
| }}
| |
| | |
| ==Lights files==
| |
| | |
| A light file is a plain text file that can be used to manipulate the way [[Vrad|VRAD]] handles given [[material]]s when compiling static lighting. All lights files must have the .rad file extension and must be in the same folder as your [[gameinfo.txt]].
| |
| | |
| There are:
| |
| | |
| #'''<code>lights.rad</code>''', the global file.
| |
| #'''An auto-loaded map light file''', using the format <code><map name>.rad</code>. The file must be placed in the same folder as <code><map name>.vmf</code>.
| |
| #'''Any number of additional lights files''' that can be added with [[#Effects|the <code>-lights</code> parameter]].
| |
| | |
| === Rules ===
| |
| | |
| Lights files perform these functions, one rule per line:
| |
| | |
| ;<code><material> <red> <green> <blue> <intensity> <hdr_red> <hdr_green> <hdr_blue> <hdr_intensity></code>
| |
| :Makes the material emit the given light value when applied to a [[brush]] face (<code>hdr_</code> values are optional). Texture scale has an effect on final intensity.
| |
| :{{Note|The material does not truly emit light, but instead, a {{ent|light}} entity is [https://developer.valvesoftware.com/w/images/8/8e/Lightsrad_light_generation.png generated across the surface.] More technically, lights are placed at the center of every subdivision on the surface. The brightness of each light is distributed uniformly, by taking the area of each subdivision. Lower lightmap scales will increase subdivision and therefore more lights will be created. This will not occur on textures that are unlit, as no subdivision occurs on these textures. Leaf splits will still incur subdivision however, which might make the light creation unpredictable (using a [[func_detail]] will avoid this). It may be smarter and cheaper to instead manually place <code>light</code> entities near the material.}}
| |
| :{{note|Materials that aren't in a folder must have a slash before their name.}}
| |
| {{warning|A [[func_detail]] with an emissive material applied on a face may randomly cause VRAD to fail computing lighting for the face.}}
| |
| ;<code>noshadow <material name></code>
| |
| :Prevents the named material from casting shadows.
| |
| ;<code>forcetextureshadow <model path>.mdl</code>
| |
| :Enables translucency shadow testing for a model when VRAD is run with <code>[[#Effects|-TextureShadows]]</code>. Path is relative to the models folder.
| |
| ;<code><nowiki>ldr:</nowiki></code>
| |
| ;<code><nowiki>hdr:</nowiki></code>
| |
| :Prefixes to make any rule only apply to SDR or HDR lighting.
| |
| ;<code><nowiki>hdr:ldr:</nowiki></code>
| |
| :Lines beginning with both tags (in that order) will always be ignored by VRAD. Can be used to add comments or quickly disable some entries.
| |
| | |
| ==Console Output ==
| |
| {{todo|Add description about missing outputs output (BuildVisLeafs, other)}}
| |
| | |
| ==See Also ==
| |
| | |
| * [[QRAD]] - {{goldsrc|4}} counterpart.
| |
| * [[VRAD_(Source 2)|VRAD2 & VRAD3]] - {{source2|4}} counterpart.
| |
| * [[Map Compiling Theory]]
| |
| * [[HDR Lighting Basics]]
| |
| * [[VRAD HDR Crash Fix]]
| |
| * [[Static Props show up black]]
| |
| | |
| {{SDKTools}} | | {{SDKTools}} |
|
| |
|
| [[Category:Level Design]] | | [[Category:Level Design]] |
