Overview
The BspSource class is the main control class for all decompiling modules in BSPSource. It coordinates the decompilation process for one or more BSP files, managing parallel execution and progress tracking.
As the original author noted: “A simple decompiler for HL2 bsp files”
Package: info.ata4.bspsrc.decompiler
Source: BspSource.java:56
Constructor
BspSource
public BspSource(BspSourceConfig config, List<BspFileEntry> entries)
Configuration settings for the decompilation process. See BspSourceConfig for details. entries
List<BspFileEntry>
required
List of BSP file entries to decompile. Each entry contains paths for the BSP file and output VMF file.
Public Methods
run
public void run(Consumer<Signal> signalConsumer) throws InterruptedException
Consumer that receives progress signals during decompilation (TaskStarted, TaskFinished, TaskFailed).
InterruptedException - if the decompilation process is interrupted
Source: BspSource.java:78
decompile (static)
public static void decompile(BspFileEntry entry, BspSourceConfig config)
throws BspSourceException, BspException
The BSP file entry containing input BSP path and output VMF path.
Configuration settings for the decompilation.
BspSourceException - if an error occurs during decompilationBspException - if there’s an error loading or processing the BSP file
Source: BspSource.java:142
getEntryUuids
public List<UUID> getEntryUuids()
BspSource.java:240
Public Fields
VERSION
public static final String VERSION = "1.4.8-DEV"
BspSource.java:61
DECOMPILE_TASK_ID_IDENTIFIER
public static final String DECOMPILE_TASK_ID_IDENTIFIER = "decompile_id"
BspSource.java:59
Nested Types
Signal (sealed interface)
Signals emitted during the decompilation process:
TaskStarted(int index) - Emitted when a task startsTaskFinished(int index) - Emitted when a task completes successfullyTaskFailed(int index, Throwable exception) - Emitted when a task fails
Source: BspSource.java:244
Usage Example
import info.ata4.bspsrc.decompiler.BspSource;
import info.ata4.bspsrc.decompiler.BspSourceConfig;
import info.ata4.bspsrc.decompiler.BspFileEntry;
import java.nio.file.Path;
import java.util.List;
// Create configuration
BspSourceConfig config = new BspSourceConfig();
config.writeWorldBrushes = true;
config.writeEntities = true;
// Create file entry
BspFileEntry entry = new BspFileEntry(
Path.of("maps/dm_example.bsp"),
Path.of("output/dm_example.vmf")
);
// Create BspSource instance
BspSource bspSource = new BspSource(config, List.of(entry));
// Run decompilation with progress tracking
bspSource.run(signal -> {
switch (signal) {
case BspSource.Signal.TaskStarted(int index) ->
System.out.println("Started task " + index);
case BspSource.Signal.TaskFinished(int index) ->
System.out.println("Finished task " + index);
case BspSource.Signal.TaskFailed(int index, Throwable e) ->
System.err.println("Task " + index + " failed: " + e.getMessage());
}
});
See Also