Overview
The BspFile class provides low-level access to BSP files, handling file I/O, header parsing, and lump management. It supports various Source engine game formats including special handling for Titanfall, Left 4 Dead 2, Dark Messiah, and other variants.
Package: info.ata4.bspsrc.lib
Source: BspFile.java:46
Constructor
BspFile
Creates a new empty BspFile instance.
Source: BspFile.java:84
Public Methods
load
public void load(Path file, boolean memMapping) throws BspException, IOException
If true, the file will be memory-mapped for faster access. If false, the entire file is loaded into memory. Memory-mapping is faster but prevents saving to the same file due to JVM restrictions.
BspException - if the file format is invalid or unsupportedIOException - if the file cannot be opened or read
Source: BspFile.java:97
public void load(Path file) throws BspException, IOException
BspFile.java:164
save
public void save(Path file) throws IOException
Destination file path to save to.
IOException - if the file cannot be written
Source: BspFile.java:168
loadLumpFiles
public void loadLumpFiles()
mapname_l_0.lmp) and overrides internal lumps with their content.
Source: BspFile.java:392
getLumps
public List<Lump> getLumps()
BspFile.java:728
getLump
public Lump getLump(LumpType type)
The lump type to retrieve.
BspFile.java:736
getGameLumps
public List<GameLump> getGameLumps()
BspFile.java:745
getGameLump
public GameLump getGameLump(String sid)
FourCC string identifier (e.g., “sprp” for static props).
BspFile.java:755
compress
Compresses all lumps using LZMA compression, except for the pakfile lump.
Source: BspFile.java:768
uncompress
Uncompresses all compressed lumps.
Source: BspFile.java:808
hasCompressedLumps
public boolean hasCompressedLumps()
BspFile.java:826
getPakFile
public PakFile getPakFile()
BspFile.java:837
canReadLump
public boolean canReadLump(LumpType type)
BspFile.java:847
getNextLumpFile
public Path getNextLumpFile()
mapname_l_N.lmp.
Returns: Path for new lump file, or null if maximum number reached
Source: BspFile.java:857
getName
Returns the name of this file (filename without .bsp extension).
Returns: BSP name
Source: BspFile.java:874
setName
public void setName(String name)
getNextLumpFile().
Source: BspFile.java:884
getFile
Returns the file path on the file system for this BSP file.
Returns: File path
Source: BspFile.java:893
getVersion
Returns the BSP format version number.
Returns: BSP version
Source: BspFile.java:902
setVersion
public void setVersion(int version) throws BspException
BspFile.java:913
getRevision
Returns the map revision number, usually matching the “mapversion” keyvalue in the world spawn entity.
Returns: Map revision
Source: BspFile.java:923
setRevision
public void setRevision(int mapRev)
BspFile.java:932
getByteOrder
public ByteOrder getByteOrder()
BspFile.java:942
getAppId
Returns the detected Source engine application ID for this file.
Returns: Source engine application ID (see SourceAppId constants)
Source: BspFile.java:951
setAppId
public void setAppId(int appId)
New Source engine application ID.
BspFile.java:959
getReader
public BspFileReader getReader()
BspFile.java:967
Public Constants
BSP_ID
public static final int BSP_ID
BspFile.java:52
BSP_ID_TF
public static final int BSP_ID_TF
BspFile.java:55
public static final int HEADER_LUMPS = 64
BspFile.java:61
public static final int HEADER_LUMPS_TF = 128
BspFile.java:62
public static final int HEADER_SIZE = 1036
BspFile.java:63
MAX_LUMPFILES
public static final int MAX_LUMPFILES = 128
BspFile.java:64
Usage Example
import info.ata4.bspsrc.lib.BspFile;
import info.ata4.bspsrc.lib.lump.LumpType;
import java.nio.file.Path;
// Load a BSP file
BspFile bsp = new BspFile();
bsp.load(Path.of("maps/dm_example.bsp"));
// Get basic information
System.out.println("BSP Version: " + bsp.getVersion());
System.out.println("Map Name: " + bsp.getName());
System.out.println("App ID: " + bsp.getAppId());
// Access lumps
Lump entityLump = bsp.getLump(LumpType.LUMP_ENTITIES);
System.out.println("Entity lump size: " + entityLump.getLength());
// Access game lumps
GameLump staticProps = bsp.getGameLump("sprp");
if (staticProps != null) {
System.out.println("Static props found");
}
// Extract embedded files
bsp.getPakFile().unpack(Path.of("output/embedded"));
// Decompress if needed
if (bsp.hasCompressedLumps()) {
bsp.uncompress();
}
See Also