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.

Other Languages

Version Python Versions

Wrappers for libraries considered complete exist for C, C#, and/or Python, depending on the library.

The Python wrappers can be found on PyPI in the sourcepp package.

Included Libraries

Name Supports Read Write Wrappers
bsppp* BSP v17-27
• Console modifications
• Left 4 Dead 2 modifications
Strata Source modifications
Python
dmxpp* DMX Binary v1-5
srctools modifications
fspp* Source 1 filesystem accessor
gamepp Get Source engine instance window title/position/size C
Python
Run commands in a Source engine instance remotely
kvpp KeyValues v1 Text
KeyValues v1 Binary
mdlpp* MDL v44-49
VTX v7
VVD v4
sndpp* WAV
XWV v4
steampp Find Steam install folder - C
Python
Find installed Steam games -
Find Steam game library assets -
toolpp FGD (Source 1)
J.A.C.K. modifications
Hammer++ modifications
Strata Source modifications
Python
WC (CmdSeq) v0.1-0.2
Strata Source modifications
vcryptpp VICE encrypted files C
C#
Python
VFONT encrypted fonts
vpkpp 007 v1.1, v1.3 (007 - Nightfire) C
C#
Python
FPX v10 (Tactical Intervention)
GCF v6
GMA v1-3 (Garry's Mod)
HOG (Descent)
OL (Worldcraft Object Library)
ORE (Narbacular Drop)
PAK (Quake, WON Half-Life)
SiN modifications
HROT modifications
PCK v1-2 (Godot Engine)
VPK pre-v1, v1-2, v54
Counter-Strike: 2 modifications
Counter-Strike: Source ClientMod modifications
VPK (Vampire: The Masquerade - Bloodlines)
VPP v1-3 (Red Faction)
WAD v3
XZP v6 (Half-Life 2 for XBOX)
ZIP, and some of its aliases:
BEE_PACK (BEE2.4 Package)
BMZ (Source 1 Bonus Maps)
• FPK (Tactical Intervention)
PK3 (Quake III)
PK4 (Quake IV, Doom 3)
• PKZ (Quake II RTX)
vtfpp APNG C
Python
BMP
EXR v1
GIF
HDR
JPEG
PIC
PNG
PNM (PGM, PPM)
PPL v0
PSD
QOI
SHT v0-1
TGA
TTX (TTH, TTZ) v1.0
VTF v7.0-7.6
Strata Source modifications
XTF v5.0 (Xbox, Half-Life 2)
VTFX v8 (X360 & PS3, Orange Box)
VTF3 v8 (PS3, Portal 2 & CS:GO)
WebP

(*) These libraries are incomplete and still in development. Their interfaces are unstable and will likely change in the future. Libraries not starred should be considered stable, and their existing interfaces will not change much if at all. Note that wrappers only exist for stable libraries.

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

Gallery

Anything using the sourcepp parser set that I know of, directly or indirectly.

Tools

  • gimp-vtf: A GIMP plugin to load and save VTF files.
  • 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.
  • MareTF: An open source MIT-licensed CLI/GUI tool that can create, extract from, preview the contents of and write to every variant of VTF file. Replicates the functionality of Valve's vtex.exe and VTFEdit.
  • Myst IV: Revolution: Performs various fixes for the game Myst IV: Revelation.
  • PBR-2-Source: A Python-powered GUI for converting PBR materials into materials compatible with the Source engine.
  • RectMaker: A freeware GUI tool that can create and modify .rect files used in Hammer++'s hotspotting algorithm.
  • Source Map Compiler Tools: An open source recreation of the Slammin' Source Map Tools.
  • Verifier: A small program that can build an index of a game's files, and validate existing files based on that index. Similar to Steam's "Verify integrity of game files" option, but without overwriting any files.
  • VPKEdit: An open source MIT-licensed CLI/GUI tool that can create, extract from, preview the contents of and write to several pack file formats. Replicates the functionality of Valve's vpk.exe and GCFScape.
    • bsp-linux-fix: Patches maps which have improperly cased packed assets by repacking the assets, fixing an issue on Linux.
    • CS2-EomVotesFix: Fixes displaying workshop map names and thumbnails during end-of-match voting for LAN events.
    • dham: Modifies Dota 2 hero aliases based on a configuration file and packages the changes.
    • Linux BSP Case Folding Workaround: A bash script designed to resolve issues with improperly cased packed map assets in Source engine games on Linux. Extracting the assets allows the game to find them properly.
    • props_scaling_recompiler: Allows converting prop_scalable into a static prop, effectively implementing static prop scaling outside CS:GO.
    • rock:sail: CS2 client-side tool to use skins for free (only visible to the user of the tool).

Games

Portal 2: Community Edition
  • Local addon assets are packed with sourcepp.
  • Verifier and VPKEdit are shipped with the game.
Nightmare House: The Original Mod
  • Game assets are packed with VPKEdit.

Special Thanks

About

Several modern C++20 libraries for sanely parsing Valve's formats

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Contributors 13