Skip to content

craftablescience/sourcepp

Repository files navigation

The Source Pretty Parsers logo. A printer-esque device is scanning a page with hex codes and printing a picture of Cordon Freeman.

Source Pretty Parsers

Build Status License Discord Ko-fi

Several modern C++20 libraries for sanely parsing Valve formats, rolled into one big repository.

Included Libraries

Name Supports Read Write Wrappers
bsppp
dmxpp
  • DMX Binary v1-5
fgdpp
gamepp
  • Get Source engine instance window title/position/size
  • Run commands in a Source engine instance remotely
n/a n/a
kvpp
mdlpp
steampp
  • Find Steam install folder
  • Find installed Steam games
n/a n/a C
vicepp
  • VICE Encrypted Files
C
C#
vpkpp
  • BMZ
  • BSP v17-27
  • FPX v10 (Tactical Intervention)
  • GCF v6
  • GMA v1-3 (Garry's Mod)
  • PAK (Quake, WON Half-Life)
  • PCK v1-2 (Godot Engine)
  • PK3 (Quake III)
  • PK4 (Quake IV, Doom 3)
  • VPK v1-2
  • VPK (Vampire: The Masquerade - Bloodlines)
  • ZIP
C
C#
vtfpp

(*) Many text-based formats in Source are close to (if not identical to) KeyValues v1, such as VDF, VMT, and VMF.

(†) The MDL parser is not complete. It is usable in its current state, but it does not currently parse more complex components like animations. This parser is still in development.

Special Thanks

Gallery

A list of projects using the sourcepp parser set. If you'd like to see your project here, make a PR!

  • VPKEdit: An open source MIT-licensed tool that can create, extract from, preview the contents of and write to several pack file formats. A CLI application is bundled with the program which replicates the functionality of Valve's vpk.exe.
  • GodotSource: A work-in-progress set of bindings to connect the sourcepp libraries to Godot. Allows GDScript to work with the libraries, and allows Godot to directly load Source engine assets from a user project or from installed Source games.
  • Verifier: A small program that can build an index of a game's files, and validate existing files based on that index. Think Steam's "Verify integrity of game files" option, but without actually overwriting any files. sourcepp is used to parse Steam depot configs, as well as enable indexing the contents of VPKs.