From Valve Developer Community
Revision as of 14:38, 2 May 2019 by SpyShadow (talk | contribs) (Advanced options)
Jump to: navigation, search

VBSP is the tool that compiles a raw VMF file into the Binary Space Partition format. It is generally followed by VVIS and VRAD.

VBSP does:

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

Bug.png Bug: In non-L4D branch games, .mdl files that have the IDST1 header will fail to load for VBSP, see VRAD's bugs.

Launch options


vbsp [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.png Note: -onlyents and -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.
Turn on verbose output (also shows more command-line options). Use without any other parameters.
Only import the entities from the VMF. Brushes and internal entities are not modified. Conserves existing lighting data.
Only update static and detail props (i.e. the internal entities). Does not generate a .prt file, making VVIS fail!
Writes glview data to the VMF's directory. -tmpout will cause the files will be written to \tmp instead.
Removes func_detail brushes. The geometry left over is what affects visibility.
Get rid of water brushes.
Run as an idle-priority process.
-vproject <directory>
Override the VPROJECT environment variable.
-game <directory>
Specify the folder of the gameinfo.txt file
-embed <directory>
Embed the contents of <directory> in the packfile

Advanced options

Don't bring up graphical UI on vproject errors.
Control the number of threads vbsp uses (defaults to the # of processors (times 2 for Hypertreading/SMT CPU's) on your machine).
If -v is on, this disables verbose output for submodels.
Don't join face vertexes together.
Don't chop out intersecting brush areas.
Emit unique face edges instead of sharing them.
Don't fixup t-junctions.
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.
Don't prune neighboring solid nodes.
Don't merge together chopped faces on nodes.
Don't merge together chopped faces on water.
Don't subdivide faces for lightmapping.
-micro <#>
vbsp will warn when brushes are output with a volume less than this number (default: 1.0).
Mark all detail geometry as normal geometry (so all detail geometry will affect visibility).
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.
Force all surfaces to be bump mapped.
Snap axial planes to integer coordinates.
-block # #
Control the grid size mins that vbsp chops the level on.
Bug.png Bug: Causes VBSP to fail completely.
-blocks # # # #
Enter the mins and maxs for the grid size vbsp uses.
Dump static props to staticprop*.txt
Write files with collision info.
-luxelscale #
Scale all lightmaps by this amount (default: 1.0).
Force lightmaps to be generated for all surfaces even if they don't need lightmaps.
To do: Currently unknown.
Keep the BSP's zip files intact but regenerate everything else.
Substitute materials according to materialsub.txt in content\maps
Write large minidumps on crash.
Fix Physics Entities fall through displacements at cost of bigger bsp size

Static Prop Combine (in all games since Counter-Strike: Global Offensive)

Merges static props together according to the rules defined in scripts/hammer/spcombinerules/spcombinerules.txt. 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.
Automatically generate static prop combine rules for props that VBSP deems should be combined.
Note.png Note: This does not write to spcombinerules.txt.
Instead of using the distance limit, combine all props in the group that share visclusters.
Lists models sharing the same material that should be added to spcombinerules.txt.
-StaticPropCombine_MinInstances <int>
Set the minimum number of props in a combine group required to create a combined prop.
Tip.png Tip: Valve had this set to 3 for the new Dust 2.
Confirm:Prints the combine rules? Hasn't been working for me.
Confirm:Does this color the instances?
Don't delete the autogenerated QCs and unpacked model files after finishing.
Combine props, even if they have differing Render in Fast Reflections settings.
Combine props, even if they have differing Ignore Normals settings.
Combine props, even if they have differing Disable Shadows settings.
Combine props, even if they have differing Disable Vertex lighting settings.
Combine props, even if they have differing Disable flashlight settings.
Combine props, even if they have differing Disable Self-Shadowing settings.
Combine props, even if they have differing Disable ShadowDepth settings.

Nonfunctional Options

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. )
Force it to not write physics data for linux multiplayer servers, even if there are multiplayer entities in the map.
Use virtual (not precomputed) displacement collision models
Enable mandatory Xbox 1 optimisation.

Console output

To do: Add description about every output (WriteBSP, other)

See also