Readme File for Developers
Purpose
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.
Building
- 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
.dll
files are adjacent to thepom.xml
file. (Having them there makes it easier to do debugging and unit tests.) - (Optional) If you need to create a new
.exe
launcher, download Launch4J ans open thelauncher_conf.xml
file with it. Then generate a new launcher that replacespackbsp.exe
.
Modifying GUI components
GUI forms are managed using the GUI tools in Netbeans 6.8 or above,
and any .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
target/packbsp-{VERSION}-dist.dir/
directory.
When releasing a new version
- Update the changelog and readme files
- Edit
pom.xml
and update version numbers - Edit
launcher_conf.xml
and update version numbers - Use Launch4J to create a new
packbsp.exe
file. - 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.