Decompiling Maps: Difference between revisions
Jump to navigation
Jump to search
Warning:BSP2MAP, MBSPC, 005 and WinBSPC are unstable and may not compile correctly in the end; Half-Life Unified SDK Map Decompiler instead. It will still require manual cleanup, but is significantly more accurate.
Note:A few games may have extra maps sectioned into other mod folders, for example
Note:A few games use lump file edits to edit existing entities, and comment files to add new entities without recompiling maps. for example: 
adds info_remarkable entities and env_player_blocker entities this way.
BSPSource is capable of reading the .lmp files and incorporate its data, but it will not load entities from the commentary files. Luckily you can convert commentary files back to VMF files by following these steps. and merging those entities into the decompiled map.
Note:This VMF incompatibility issue does not affect Garry's Mod, as it ran on heavily modified version of Source 2013 that support assets from Left 4 Dead engine branch and later. Garry's Mod ships with modified version of Hammer which fixed the issue, allowing you to load VMFs (or decompiled maps) from Left 4 Dead 2 and later branches.
mNo edit summary |
|||
| (94 intermediate revisions by 31 users not shown) | |||
| Line 1: | Line 1: | ||
{{LanguageBar}} | |||
[[Category:Level Design]] | |||
[[Category:Tutorials]] | |||
Decompiling is the process of taking a compiled map file and generating a file that Hammer can open. Decompiled maps are not perfect recreations, because of format differences{{clarify}}, loss of data (such as missing [[Func viscluster]], tools textures such as NPC Clip or Player Clip all replaced with either Nodraw or entirely replaced with NPC Clip/Player Clip which cause lighting issues or NPCs/players to get stuck in some area, and imprecise vertex position on complex brushes). This makes them useful for learning, measurement, and inspection, but not direct recompilation. The original source is ideal for reproductions or modifications. | |||
Releasing reproductions, modifications, or approximations of another's work without permission nor credit may be considered rude to the author, is largely frowned upon, and is in fact copyright infringement, which may have legal consequences depending on the source of the map. There are methods of preventing maps from being fully decompiled (obfuscating textures, keeping entities or VScript server-side, etc.), but these are rarely used because most people who decompile maps are doing so to learn from them rather than to steal. | |||
==Decompilers== | |||
==={{source2|4}}=== | |||
*{{vrf|4}} (used to view the entities and other lumps on a map, decompiling to vmap, and exporting to glTF) | |||
==={{src|4}}=== | |||
*[[EntSpy]] (used to view and edit the entities of a BSP without recompiling) | |||
*[[BSPSource]] (open source map decompiler for Source engine maps, based on VMEX) | |||
*[[VMEX]] (decompiler for Source engine maps) | |||
*[[MapFool]] (helps porting HL1 maps to Source) | |||
*[[xwad]] (command-line tool to convert texture formats) | |||
==={{gldsrc|4}}=== | |||
* {{bspviewer|4}} requires .NET Framework v1.1. (not recommended) | |||
:{{Warning|In {{crafty|4}} the function of bsp decompilation was cut out.}} | |||
*{{hlusmd|4}} requires .NET Desktop Runtime 6 | |||
*{{mbspc|4}} (not recommended) | |||
*{{b2m|4}} (not recommended) | |||
*{{winbspc|4}} (not recommended) | |||
{{warning|[[BSP2MAP]], [[MBSPC]], [[005]] and [[WinBSPC]] are unstable and may not compile correctly in the end; {{hlusmd|1}} instead. It will still require manual cleanup, but is significantly more accurate.}} | |||
*{{005|4}} ({{hl}} not recommended; {{nightfire}} recommended) | |||
==Files== | |||
Most maps do not need to be extracted, as they are located in the file system rather than VPK. The map files are normally located in a ''maps'' folder, for example <code>common\Team Fortress 2\tf\maps\</code> holds all the official Team Fortress 2 maps. | |||
{{note|A few games may have extra maps sectioned into other mod folders, for example <code>Portal 2\portal2_dlc1\maps\</code>.}} | |||
{{note|A few games use [[Patching_levels_with_lump_files|lump file edits]] to edit existing entities, and [[Commentary_System|comment files]] to add new entities without recompiling maps. for example: {{l4d2}} adds [[info_remarkable]] entities and [[env_player_blocker]] entities this way.<br> | |||
BSPSource is capable of reading the .lmp files and incorporate its data, but it will not load entities from the commentary files. Luckily you can convert commentary files back to VMF files by following [[Commentary_System#Converting_Commentary_back_to_VMF|these steps]]. and merging those entities into the decompiled map.}} | |||
== Before | ==Before you go== | ||
Before you take this jump to run off and decompile a map take a second or two to think, "What am I trying to learn/do?". | Before you take this jump to run off and decompile a map take a second or two to think, "What am I trying to learn/do?". | ||
Read the included TXT files, you may just find the creator's e-mail, and that could be more helpful than you imagine. | Read the included TXT files, you may just find the creator's e-mail, and that could be more helpful than you imagine. | ||
Some mappers will offer | Some mappers will offer help and advice, they may even go so far as to provide examples of what you wanted to borrow from the map. | ||
==Porting newer maps to older Source games== | |||
Decompiled maps from [[Left 4 Dead 2]], [[Portal 2]], [[Counter-Strike: Global Offensive]], and [[Alien Swarm]] will crash when loaded in the Hammer for [[Half-Life 2]], [[Team Fortress 2]], [[Counter-Strike: Source]], [[Day of Defeat: Source]] and other games based on {{src13|1}}, [[Orange_Box_(engine_branch)|Orange Box branches]] ({{src07}} - {{src09}}/{{srcmp}}) or earlier. Opening the map in [[Left 4 Dead]] Hammer and re-saving it will automatically convert it to be compatible. | |||
{{Note|This VMF incompatibility issue does not affect {{gmod|1}}, as it ran on heavily modified version of {{src13|1}} that support assets from {{l4dbranch|1}} and later. Garry's Mod ships with modified version of Hammer which fixed the issue, allowing you to load VMFs (or decompiled maps) from Left 4 Dead 2 and later branches.}} | |||
{{todo|Document how to fix this manually. It's caused by L4D2 changing the character used to separate output values, but I'm not sure what character it changed to.}} | |||
[[ | ==See also== | ||
[[Category: | *[[Porting GoldSrc content (maps, models, etc.) to Source]] | ||
[[Category:Source]] | |||
Latest revision as of 04:59, 9 July 2025
Decompiling is the process of taking a compiled map file and generating a file that Hammer can open. Decompiled maps are not perfect recreations, because of format differences[Clarify], loss of data (such as missing Func viscluster, tools textures such as NPC Clip or Player Clip all replaced with either Nodraw or entirely replaced with NPC Clip/Player Clip which cause lighting issues or NPCs/players to get stuck in some area, and imprecise vertex position on complex brushes). This makes them useful for learning, measurement, and inspection, but not direct recompilation. The original source is ideal for reproductions or modifications.
Releasing reproductions, modifications, or approximations of another's work without permission nor credit may be considered rude to the author, is largely frowned upon, and is in fact copyright infringement, which may have legal consequences depending on the source of the map. There are methods of preventing maps from being fully decompiled (obfuscating textures, keeping entities or VScript server-side, etc.), but these are rarely used because most people who decompile maps are doing so to learn from them rather than to steal.
Decompilers
Source 2
Source 2 Viewer (used to view the entities and other lumps on a map, decompiling to vmap, and exporting to glTF)
Source
- EntSpy (used to view and edit the entities of a BSP without recompiling)
- BSPSource (open source map decompiler for Source engine maps, based on VMEX)
- VMEX (decompiler for Source engine maps)
- MapFool (helps porting HL1 maps to Source)
- xwad (command-line tool to convert texture formats)
GoldSrc
BSP Viewer requires .NET Framework v1.1. (not recommended)
- Warning:In
Crafty the function of bsp decompilation was cut out.
Half-Life Unified SDK Map Decompiler requires .NET Desktop Runtime 6
MBSPC (not recommended)- BspTwoMap (not recommended)
WinBSPC (not recommended)
Warning:BSP2MAP, MBSPC, 005 and WinBSPC are unstable and may not compile correctly in the end; Half-Life Unified SDK Map Decompiler instead. It will still require manual cleanup, but is significantly more accurate.
005 Decompiler (
not recommended; 
recommended)
Files
Most maps do not need to be extracted, as they are located in the file system rather than VPK. The map files are normally located in a maps folder, for example common\Team Fortress 2\tf\maps\ holds all the official Team Fortress 2 maps.
Note:A few games may have extra maps sectioned into other mod folders, for example Portal 2\portal2_dlc1\maps\.Note:A few games use lump file edits to edit existing entities, and comment files to add new entities without recompiling maps. for example: adds info_remarkable entities and env_player_blocker entities this way.BSPSource is capable of reading the .lmp files and incorporate its data, but it will not load entities from the commentary files. Luckily you can convert commentary files back to VMF files by following these steps. and merging those entities into the decompiled map.
Before you go
Before you take this jump to run off and decompile a map take a second or two to think, "What am I trying to learn/do?". Read the included TXT files, you may just find the creator's e-mail, and that could be more helpful than you imagine.
Some mappers will offer help and advice, they may even go so far as to provide examples of what you wanted to borrow from the map.
Porting newer maps to older Source games
Decompiled maps from Left 4 Dead 2, Portal 2, Counter-Strike: Global Offensive, and Alien Swarm will crash when loaded in the Hammer for Half-Life 2, Team Fortress 2, Counter-Strike: Source, Day of Defeat: Source and other games based on Source 2013, Orange Box branches (
- 
/
) or earlier. Opening the map in Left 4 Dead Hammer and re-saving it will automatically convert it to be compatible.
Note:This VMF incompatibility issue does not affect Garry's Mod, as it ran on heavily modified version of Source 2013 that support assets from Left 4 Dead engine branch and later. Garry's Mod ships with modified version of Hammer which fixed the issue, allowing you to load VMFs (or decompiled maps) from Left 4 Dead 2 and later branches.Todo: Document how to fix this manually. It's caused by L4D2 changing the character used to separate output values, but I'm not sure what character it changed to.