Home

Welcome to the srctools wiki!

Srctools is a package for dealing with Valve's Source Engine, and in particular its various file formats:

• VMFs
• BSPs
• VPKs
• FGDs
• cmdseq (Hammer compile tool commands)
• General keyvalues files

Each submodule deals with a specific file format. The main classes are re-exported in the main module, so they can be easily accessed.

Modules:

property_parser

Property objects represent a tree of keyvalues, which form the backbone of many file types. It is commonly used for configuration.

vec

Contains a 3D vector class, which follows the conventions used in the engine for orientations and rotation.

fgd

Parses and manipulates Forge Game Data files, which list the available entities and entity options for a particular game branch for use in Hammer.

vpk

Allows reading and writing to VPK files.

vmf

Parses a VMF file into a tree of objects, and provides facilities for manipulating and generating map content.

bsp

Reads and writes lumps to BSP files to allow modification.

filesys

Provides a unified interface to allow interchangeably accessing data from either a folder, a VPK file or a ZIP. It also allows chaining sources together, to allow locating resources from multiple locations in a similar way to the engine.

tokenizer

An internal class - this processes a text file, splitting it into a succession of tokens for parsing keyvalues and FGD files.