Readme File for Developers
PackBSP is a utilty program for games based on Valve Inc's "Source" game engine. It allows map-makers to easily package dependencies and media into their map for redistribution. It is intended as a successor to the aging PakRat utility.
- Install Maven if you haven't already.
- Download (or use
git fetch) the PackBSP source files into a project directory.
- Download the jhllib DLLs and extract the files in it to the PackBSP root directory, so that the
.dllfiles are adjacent to the
pom.xmlfile. (Having them there makes it easier to do debugging and unit tests.)
- (Optional) If you need to create a new
.exelauncher, download Launch4J ans open the
launcher_conf.xmlfile with it. Then generate a new launcher that replaces
Modifying GUI components
GUI forms are managed using the GUI tools in Netbeans 6.8 or above,
.java file with a corresponding
.form file should not be modified through
any other tool, or risk inconsistencies.
When using Netbeans to edit GUI components, it helps to compile the project once before opening any forms so that compositional dependencies can be seamlessly displayed. Netbeans may present an error popup otherwise.
Creating a distributable copy
Switch to the packbsp folder and run
mvn clean install assembly:assembly.
This should create a redistributable set of files in the
When releasing a new version
- Update the changelog and readme files
pom.xmland update version numbers
launcher_conf.xmland update version numbers
- Use Launch4J to create a new
- Clean, build, and assemble a new distributable.
When using a new version of jhllib
- Update the DLLs and license to match the JAR, as detailed in the "general build" section.