vmf-tools

VMF Tools

Programmatically modify VMF files.

Rules

Currently the following is implemented:

• Christmas lights - add lights to ropes in your map

Usage

The tool can be ran in two ways: manually, or as part of the compile step. In both cases you must install Node.js, as this is what is used to actually execute the toolset.

As part of compilation

This is the most user friendly way once you've set it up, as it works more or less transparently.

1. Test that the program is runnable by doing npx vmf-tools in a command prompt (this should complain about needing a map to work on)
2. Go to your Hammer compilation settings (F9) and enable advanced mode if not already set.
3. For each mode you want to compile in, do the following:
   1. Add a new command to run (img)
   2. Enter npx vmf-tools as command and $path\$file.$ext $path\$file-processed.$ext as parameters (img)
   3. Make sure the new command is the top-most command and is enabled (img)
   4. In all other commands, replace $path\file with $path\file-processed (img)

Done. Whenever you compile the map it will now automatically be processed.

Manually

Run the tool manually, specifying the VMF as the first argument and the output as the second argument (npx vmf-tools path\to\map.vmf path\to\processed.vmf).

Configuration

The configuration usually happens through Hammer by using custom keyvalues. The specifics of how this works can be found on each rule's README.

For more advanced configuration a configuration file is needed. This is simple a .js file that contains module.exports = { rules: { /* config goes here */ } }, with the configuration as specified in each rule's README.

If you want to use a configuration file you must tell the tool about it. This is done by going to Map > Map properties... in Hammer and adding a keyvalue of vmft_config with the value being the path to the config file. You may also give the path to the file as the third argument if you run the tool manually.

If the configuration file is specified as a map property and as the third argument when running the tool, then the one specified as a map property will be used.