BSPSource: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Rewrote the article.)
(updated cite template.)
 
(25 intermediate revisions by 11 users not shown)
Line 1: Line 1:
{{otherlang2|ru=BSPSource:ru}}
{{LanguageBar}}
[[Image:Bspsrc.jpg|thumb|right|300px|BSPSource v1.4.0]]
[[File:BSPSource.png|thumb|right|300px|Screenshot of BSPSource.]]
[[File:BSPSource icon.png|48px|left]]'''BSPSource''' is a [[VMEX]]-based map decompiler for [[Source]] games. It converts [[BSP]] files back into [[VMF]] files that can be loaded in [[Hammer]], and also includes numerous bug fixes and new features for doing so, such as extracting embedded assets, processing multiple BSPs at once, and more.
{{Stub}}
{{Bspsource|4}} is a GUI map decompiler for {{src|4}} games, written in {{java|4}}.


Based on [[VMEX]], it converts [[BSP]] files into [[VMF]] ones that can be loaded in [[Hammer]]. It also includes numerous bug fixes over '''VMEX''' and new features for doing the conversion, such as extracting embedded assets, processing multiple BSPs at once, and more.
{{Bug|Newer version (starting with 1.4.4 or later) may not launch{{cite|1}} on some systems (especially with systems with Windows 11 or localized version of the OS). Users can try to install latest version of Java and download the {{path|bspsrc-jar-only|zip}} version and run the {{file|bspsrc|jar}} file, or alternatively, use older version of BSPSource, or downgrade/upgrade/reinstall Windows.}}
{{note|Due to technical reasons, decompiling maps doesn't accurately recreate their original '''VMF''' state, often presenting issues such as invalid geometry solids, tools textures such as NPC Clip or Player Clip all replaced with either Nodraw or entirely replaced with NPC Clip or Player Clip which cause lighting issues or NPCs to get stuck, or misplaced [[areaportal]] brushes in the decompiled file. {{workaround|Decompiling the file again or more times may generate better results, such as avoiding some of these issues{{why}}.}} }}
{{note|If there is decompilation protection present, the conversion may be more difficult to work with.}}
== BSP with File Packing ==
In the tab "Other" set tick in in "Extract embedded files". Then put downloaded files in game directory.
== BSPInfo ==
BSPInfo is a mode of BSPSource that instead of decompiling .bsp files, analyses them. Content such as: bsp version, compression type, checksums, AppID, lumps and compile parameters. It can also extract embedded files similarly to {{Gcfscape|2}}.
== See also ==
*{{hlusmd|4}} - GUI map decompiler for {{Gldsrc|4}}
== External links ==
* [https://github.com/ata4/bspsrc/releases BSPSource on GitHub]
* [https://www.oracle.com/java/technologies/downloads Latest Java] (optional, for 1.4.4 or later. This is only required if you are using {{path|bspsrc-jar-only|zip}} (which does not have Java bundled in.)
** After installing, try to run the {{path|bspsrc|jar}} executable, or type {{code|javaw -jar "C:\your-bspsrc-folder\bspsrc.jar"}} in Command Prompt (CMD).
* [https://www.java.com/download/ Java 8] (required in order to use BSPSource 1.4.3 or earlier)
{{references|1=
{{ref2|cite id=1|access-date=June 19, 2025|"[https://github.com/ata4/bspsrc/issues/180 Application not launching caused by "java.lang.IllegalArgumentException: Comparison method violates its general contract!"]". BSPSource. ''GitHub Issues''.}}
}}


{{note|Decompiled maps aren't identical to the original [[VMF|source files]] that were used to compile them, and often present issues such as invalid geometry solids or misplaced [[Areaportal|areaportal]] brushes.}}
{{note|Maps protected from decompilation will prevent '''BSPSource''' from performing the conversion.}}
==External links==
*[https://github.com/ata4/bspsrc/releases BSPSource v1.4.0 (January 1, 2020)] Download from GitHub
[[Category:Third Party Tools]]
[[Category:Third Party Tools]]
[[Category:Level Design]]
{{sdktools|cat=0|0}}

Latest revision as of 01:14, 19 June 2025

English (en)Polski (pl)Русский (ru)Translate (Translate)
Screenshot of BSPSource.

Stub

This article or section is a stub. You can help by expanding it.

BSPSource BSPSource is a GUI map decompiler for Source Source games, written in Java Java.

Based on VMEX, it converts BSP files into VMF ones that can be loaded in Hammer. It also includes numerous bug fixes over VMEX and new features for doing the conversion, such as extracting embedded assets, processing multiple BSPs at once, and more.

Icon-Bug.pngBug:Newer version (starting with 1.4.4 or later) may not launch[1] on some systems (especially with systems with Windows 11 or localized version of the OS). Users can try to install latest version of Java and download the 🖿bspsrc-jar-only.zip version and run the 🖿bspsrc.jar file, or alternatively, use older version of BSPSource, or downgrade/upgrade/reinstall Windows.  [todo tested in ?]
Note.pngNote:Due to technical reasons, decompiling maps doesn't accurately recreate their original VMF state, often presenting issues such as invalid geometry solids, tools textures such as NPC Clip or Player Clip all replaced with either Nodraw or entirely replaced with NPC Clip or Player Clip which cause lighting issues or NPCs to get stuck, or misplaced areaportal brushes in the decompiled file.
PlacementTip.pngWorkaround:Decompiling the file again or more times may generate better results, such as avoiding some of these issues[Why?].
Note.pngNote:If there is decompilation protection present, the conversion may be more difficult to work with.

BSP with File Packing

In the tab "Other" set tick in in "Extract embedded files". Then put downloaded files in game directory.

BSPInfo

BSPInfo is a mode of BSPSource that instead of decompiling .bsp files, analyses them. Content such as: bsp version, compression type, checksums, AppID, lumps and compile parameters. It can also extract embedded files similarly to GCFScape GCFScape.

See also

External links

  • BSPSource on GitHub
  • Latest Java (optional, for 1.4.4 or later. This is only required if you are using 🖿bspsrc-jar-only.zip (which does not have Java bundled in.)
    • After installing, try to run the 🖿bspsrc.jar executable, or type javaw -jar "C:\your-bspsrc-folder\bspsrc.jar" in Command Prompt (CMD).
  • Java 8 (required in order to use BSPSource 1.4.3 or earlier)

References

References