View source for VBSP

{{LanguageBar}}
{{Source topicon}}
{{map compile pipeline|source1}}
 {{toc-right}}
{{vbsp|4}} is the tool that compiles a raw [[VMF]] file into [[BSP (Source)|Source 1's BSP format]]. It is generally followed by [[VVIS]] and [[VRAD]].

VBSP will:
* Convert [[brush]]es to polygons
* Generate [[visleaf|visleaves]]
* Generate [[detail props]]
* Swallow most [[:Category:Internal entities|internal entities]] into [[Worldspawn|the world]]
* Replace [[$envmap|specular materials]] with [[patch]]ed versions that link to the nearest [[env_cubemap|cubemap]]
* Report [[leak]]s as [[.lin]] files
* Embed the [[entity block]]
* Merge groups of [[prop_static|static props]] sharing the same [[material]] {{csgo|since}}

While the resulting BSP file can be played directly it has no visibility control (poor performance) and no lighting.

{{Bug|In non-{{l4dbranch|4}} games, [[MDL (Source)|MDL]] files that have the <code>IDST1</code> header will fail to load for VBSP, see [[VRAD]]'s bugs.}}
{{bug|tested={{src13}}|In {{src13|4}} and possibly other engine branches, [[smoothing groups]] are not properly written for {{ent|func_detail}} brush faces. This is fixed in the {{slamminsrc|2|nt=1}}, {{gmod|2}}'s VBSP and {{mapbase|2}}' VBSP, and code for this fix can be found in [https://github.com/ValveSoftware/source-sdk-2013/pull/391 pull request 391 on GitHub].}}
{{bug|tested={{src13}}|'''VBSP''' doesn't recognize custom lightmapped shaders, and thus it won't allow [[VRAD]] to generate lightmaps for them. This is fixed in {{slamminsrc|2|nt=1}} and in {{mapbase|2}}' VBSP.}}
{{note|VBSP can also compile [[MAP]] files with the {{code|"mapversion" "400"}} [[KV]] in [[worldspawn]].}}

== Launch options ==
=== Syntax ===
 <vbsp.exe path> [options] <VMF File>

For example:
 "Half-Life 2\bin\vbsp.exe" -onlyents sdk_trainstation_01

This will re-embed the entity block without affecting the world.

=== Common options ===
{{Note|{{Code|-onlyents}} and {{Code|-keepstalezip}} will mark the map as stale by embedding the file stale.txt into the BSP. Loading stale maps in the engine will cause a "This map is not final!!" warning message in the console.}}

{{def|code=1|-v}} {{def|code=1|-verbose}} Turn on verbose output (also shows more [[Command Line Options|command-line options]] if used without any other parameters).
{{def|code=1|-onlyents}} Only import the [[Entity|entities]] from the VMF. Brushes and internal entities are not modified. Brush Entities' boundaries will not be modified, however, their [[Keyvalues|Keyvalues]] will be. Conserves existing lighting and vis data.
{{def|code=1|-onlyprops}} Only update static and detail props (i.e. the internal entities). Does not generate a .prt file, making VVIS fail!
{{def|code=1|-glview}} Writes [[glview]] data to the VMF's directory. <code>-tmpout</code> will cause the files will be written to <code>\tmp</code> instead.
{{def|code=1|-nodetail}} Removes [[func_detail]] brushes. The geometry left over is what affects visibility.
{{def|code=1|-nowater}} Get rid of water brushes. {{confirm|Does this affect CONTENTS_SLIME, or only CONTENTS_WATER?}}
{{def|code=1|-low}} Run as an idle-priority process.
{{def|code=1|-vproject|type=directory}} Override the [[Game Directory|VPROJECT]] environment variable.
{{def|code=1|-game|type=directory}} Specify the folder of the <code>gameinfo.txt</code> file.
{{def|code=1|-insert_search_path|type=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.
{{def|code=1|-embed|type=directory|add={{src13mp|only}}}} Embed the contents of <directory> in the pakfile lump.
{{def|code=1|-instancepath|type=directory|add={{p2ce|only}}}} Overrides InstancePath key in gameinfo.

=== Advanced options ===
{{def|code=1|-autoviscluster #|add={{csgo|since}}}} {{Todo|Used on dz_sirocco, found in <code>scripts/mapautocompile.txt</code>.}}
{{def|code=1|-novconfig}} Don't bring up graphical UI on vproject errors.
{{def|code=1|-threads}} Control the number of threads vbsp uses (defaults to the # of processors (times 2 for Hypertreading/SMT CPU's) on your machine).
{{def|code=1|-verboseentities}} If -v is on, this disables verbose output for submodels.
{{def|code=1|-noweld}} Don't join face vertexes together.
{{def|code=1|-nocsg}} Don't chop out intersecting brush areas.
{{def|code=1|-noshare}} Emit unique face edges instead of sharing them.
{{def|code=1|-notjunc}} Don't fixup any t-junctions.
{{def|code=1|-allowdetailcracks}} Don't fixup t-junctions on {{Ent|func_detail}}.
{{def|code=1|-nodrawtriggers}} Compiles all triggers as if they were using Nodraw texture, only affects triggers using a texture with [[Material Map Compile Flags#%CompileTrigger_(toolstrigger)|%CompileTrigger]].
{{def|code=1|-noopt}} By default, vbsp removes the 'outer shell' of the map, which are all the faces you can't see because you can never get outside the map. -noopt disables this behavior.
{{def|code=1|-noprune}} Don't prune neighboring solid nodes.
{{def|code=1|-nomerge}} Don't merge together chopped faces on nodes.
{{def|code=1|-nomergewater}} Don't merge together chopped faces on water.
{{def|code=1|-nosubdiv}} Don't subdivide faces for lightmapping.
{{def|code=1|-micro|type=[[float]]}} vbsp will warn when brushes are output with a volume less than this number (default: 1.0).
{{def|code=1|-fulldetail}} Mark all detail geometry as normal geometry (so all detail geometry will affect visibility).
{{def|code=1|-alldetail|add={{as|only|addtext={{dota2}} {{asrd}}}}}} Convert all structural brushes to detail brushes, except func_brush entities whose names begin with structure_.
{{def|code=1|-leaktest|add={{not|{{mapbase}}}}}} Stop processing the map if a leak is detected. Whether or not this flag is set, a leak file will be written out at <vmf filename>[[.lin]], and it can be imported into {{hammer|4}}.
{{def|code=1|-noleaktest|add={{only|{{slamminsrc}} {{mapbase}}}}}}Disables leaktest as it's enabled by default.
{{def|code=1|-bumpall}} Force all surfaces to be treated as if they were [[bumpmap]]ed (generating three lightmaps for the surface instead of one), regardless of if they actually are.
{{def|code=1|-snapaxial}} Snap axial planes to integer coordinates.
{{def|code=1|-block # #}} Control the grid size mins that vbsp chops the level on. {{Bug|Causes VBSP to fail completely.}}
{{def|code=1|-blocks # # # #}} Enter the mins and maxs for the grid size vbsp uses.
{{def|code=1|-blocksize|type=[[integer|int]]|add={{csgo|since}}{{slamminsrc|also}}{{gmod|also}}}} Control the size of each grid square that vbsp chops the level on. Default is 1024.
{{def|code=1|-dumpstaticprops}} Dump static props to staticprop*.txt.
{{def|code=1|-dumpcollide}} Write files with collision info.
{{def|code=1|-forceskyvis}} Enable vis calculations in [[3D Skybox]] leaves. 
{{tip|Use this if the 3D skybox room can be accessed without noclip.}}
{{def|code=1|-luxelscale|type=[[float]]}} Scale all lightmaps by this amount (default: 1.0).
{{def|code=1|-minluxelscale|type=[[float]]}} Lets you limit the minimum luxel scale in your map.
{{def|code=1|-maxluxelscale|add={{slamminsrc|only}}}} Lets you limit the maximum luxel scale in your map.
{{def|code=1|-lightifmissing}} Force lightmaps to be generated for all surfaces even if they don't need lightmaps.
{{def|code=1|-localphysx}} {{Todo|Currently unknown.}}
{{def|code=1|-keepstalezip}} Keep the BSP's zip files intact but regenerate everything else.
{{def|code=1|-visgranularity # # #|add={{csgo|since}}{{slamminsrc|also}}}} Force visibility splits # of units along X, Y, Z.
{{def|code=1|-replacematerials}} Substitute materials according to materialsub.txt in content\maps.
{{def|code=1|-FullMinidumps}} Write large minidumps on crash.
{{def|code=1|-novirtualmesh}} Fix Physics [[entities fall through displacements]] at cost of bigger BSP size.
{{def|code=1|-xbox}} Treat [[%CompileTrigger]] surfaces as nodraw, and treat [[%CompileWater]] surfaces as having [[%CompileNoLight]] (but not [[%CompileSlime]]). Implies {{code|-nodrawtriggers}}.
{{def|code=1|-nodefaultcubemap|add={{slamminsrc|only}}}} Disables automatic skybox cubemap generation.
{{def|code=1|-defaultcubemap|add={{mapbase|only}}}} By default in Mapbase "dummy" cubemaps are not generated during map compilation but can be forced to generate again by this parameter.
{{def|code=1|-allowdynamicpropsasstatic|add={{gmod|only}}}} Allow all models with the 'static' flag in the model viewer to be used on [[prop_static]], even when their propdata doesn't contain 'allowstatic'.

=== Static Prop Combine ===
{{csgo|since}}
{{def|code=1|-StaticPropCombine}} Merges static props together according to the rules defined in <code>scripts/hammer/spcombinerules/spcombinerules.txt</code>. This lowers the number of draw calls, increasing performance. It can also be used to lower the number of static props present in a map. See [[Static Prop Combine]].
{{def|code=1|-StaticPropCombine_AutoCombine}} Automatically generate static prop combine rules for props that VBSP deems should be combined. {{note|This does not write to <code>spcombinerules.txt</code>.}}
{{def|code=1|-StaticPropCombine_ConsiderVis}} Instead of using the distance limit, combine all props in the group that share visclusters.
{{def|code=1|-StaticPropCombine_SuggestRules}} Lists models sharing the same material that should be added to <code>spcombinerules.txt</code>.
{{def|code=1|-StaticPropCombine_MinInstances|type=[[integer|int]]}} Set the minimum number of props in a combine group required to create a combined prop. {{Tip|Valve had this set to 3 for the new Dust 2.}}
{{def|code=1|-StaticPropCombine_PrintCombineRules}} {{confirm|Prints the combine rules? Hasn't been working for me.}}
{{def|code=1|-StaticPropCombine_ColorInstances}} {{confirm|Does this color the instances?}}
{{def|code=1|-KeepSources}} Don't delete the autogenerated QCs and unpacked model files after finishing.
{{def|code=1|-CombineIgnore_FastReflection}} Combine props, even if they have differing '''Render in Fast Reflections''' settings.
{{def|code=1|-CombineIgnore_Normals}} Combine props, even if they have differing '''Ignore Normals''' settings.
{{def|code=1|-CombineIgnore_NoShadow}} Combine props, even if they have differing '''Disable Shadows''' settings.
{{def|code=1|-CombineIgnore_NoVertexLighting}} Combine props, even if they have differing '''Disable Vertex lighting''' settings.
{{def|code=1|-CombineIgnore_NoFlashlight}} Combine props, even if they have differing '''Disable flashlight''' settings.
{{def|code=1|-CombineIgnore_NoSelfShadowing}} Combine props, even if they have differing '''Disable Self-Shadowing''' settings.
{{def|code=1|-CombineIgnore_DisableShadowDepth}} Combine props, even if they have differing '''Disable ShadowDepth''' settings.

=== Nonfunctional Options ===
{{def|code=1|-linuxdata}} Force it to write physics data for linux multiplayer servers. (It will automatically write this data if it finds certain entities like info_player_terrorist, info_player_deathmatch, info_player_teamspawn, info_player_axis, or info_player_coop.)
{{modernDeprecated|{{removed|{{src07}}}} All modern branches of Source use the same physics data on all platforms.}}
{{def|code=1|-nolinuxdata}} Force it to not write physics data for linux multiplayer servers, even if there are multiplayer entities in the map.
{{def|code=1|-virtualdispphysics}} Use virtual (not precomputed) displacement collision models

== Console output ==
{{Todo|Add descriptions for other VBSP outputs (WriteBSP, PruneNodes, ProcessBlock_Thread, etc).}}

VBSP prints various information about the compile process to the console. Note that output from older versions of the tool can be different.
; <code>Patching WVT material: ''material path to patched WVT material''</code>
: The map contains WorldVertexTransition materials that are being used on non-displacement faces. VBSP patches these materials to use a different material shader (such as LightmappedGeneric) so that they properly render on these map faces.
; <code>FixTjuncs...</code>
: T-junctions are created when {{Ent|func_detail}} brushes touch world geometry. To avoid visual cracks or seams, VBSP fixes up these T-junctions.
; <code>Placing detail props : 0...1...2...3...4...5...6...7...8...9...10</code>
: [[Detail props]] are being placed in the map.

== See also ==
* [[Map Compiling Theory]]
* [[Decompiling Maps]]
* [[PTS]]
* [[PRT]]

{{sdktools}}

[[Category:Official Source Tools]]
[[Category:Source 1 BSP compilers]]