VPKEdit

<div> <img align="left" width="44px" src="https://github.com/craftablescience/VPKEdit/blob/main/res/brand/logo_512.png?raw=true" alt="VPKEdit Logo" /> <h1>VPKEdit</h1> </div>

VPKEdit is an open source MIT-licensed tool that can create, extract from, preview the contents of and write to several pack file formats.

<div> <a href="https://github.com/craftablescience/VPKEdit/blob/main/LICENSE" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/github/license/craftablescience/VPKEdit?label=license" alt="License" /></a> <a href="https://github.com/craftablescience/VPKEdit/actions" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/github/actions/workflow/status/craftablescience/VPKEdit/build.yml?branch=main&label=builds" alt="Workflow Status" /></a> <a href="https://discord.gg/ASgHFkX" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/discord/678074864346857482?label=discord&logo=Discord&logoColor=%23FFFFFF" alt="Discord" /></a> <a href="https://ko-fi.com/craftablescience" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/donate-006dae?label=ko-fi&logo=ko-fi" alt="Ko-Fi" /></a> </div> <div> <img width="400px" src="https://github.com/craftablescience/VPKEdit/blob/main/res/brand/screenshot1.png?raw=true" alt="A screenshot of VPKEdit with a VPK and an MDL preview open in wireframe mode." /> <img width="400px" src="https://github.com/craftablescience/VPKEdit/blob/main/res/brand/screenshot2.png?raw=true" alt="A screenshot of VPKEdit with a VPK and an MDL preview open in shaded textured mode." /> </div> <div> <img width="400px" src="https://github.com/craftablescience/VPKEdit/blob/main/res/brand/screenshot3.png?raw=true" alt="A screenshot of VPKEdit with a BSP and a VTF preview open." /> <img width="400px" src="https://github.com/craftablescience/VPKEdit/blob/main/res/brand/screenshot4.png?raw=true" alt="A screenshot of the command-line version of VPKEdit." /> </div>

Installing

Please read this file for step-by-step installation instructions. VPKEdit is available for Windows 7+ and macOS (arm64), and has been packaged for multiple Linux distributions.

Features

• Supported file formats:

  | Format | Description | Create | Read | Write | |----------|---------------------------------------------------|:------:|:----:|:-----:| | 007 | Asset pack (007 - Nightfire) | ❌ | ✅ | ❌ | | APK | Axiom PacK file (Fairy Tale Busters) | ✅ | ✅ | ✅ | | BEE_PACK | BEE2.4 Package | ✅ | ✅ | ✅ | | BMZ | Bonus Map Zip (Source Engine) | ✅ | ✅ | ✅ | | BSP | Source 1 Map | N/A | ✅ | ✅ | | FGP | File group (PS3, The Orange Box) | ✅ | ✅ | ✅ | | FPX | VPK modification (Tactical Intervention) | ✅ | ✅ | ✅ | | GCF | Game Cache File (Pre-SteamPipe Steam games) | ❌ | ✅ | ❌ | | GMA | Garry's Mod Addon | ❌ | ✅ | ✅ | | HOG | Unknown acronym (Descent) | ❌ | ✅ | ❌ | | OL | Worldcraft Object Library | ❌ | ✅ | ❌ | | ORE | Unknown acronym (Narbacular Drop) | ❌ | ✅ | ❌ | | PAK | PAcK file (Quake, original Half-Life, HROT, etc.) | ✅ | ✅ | ✅ | | PCK | Godot PaCK file (Standalone or embedded) | ✅ | ✅ | ✅ | | PK3 | PacK v3 (Quake II) | ✅ | ✅ | ✅ | | PK4 | PacK v4 (Quake IV, Doom 3) | ✅ | ✅ | ✅ | | PKZ | PacK file (Quake II RTX) | ✅ | ✅ | ✅ | | SIN | SiN pack file (SiN 1998) | ❌ | ✅ | ✅ | | VPK | Valve PacK file (Source Engine) | ✅ | ✅ | ✅ | | VPK | Vampire PacK file (V:TMB) | ✅ | ✅ | ✅ | | VPP | Volition Pack file (Red Faction, Saints Row) | ❌ | ✅ | ❌ | | WAD | Where's All the Data (GoldSrc Engine) | ✅ | ✅ | ✅ | | XZP | Xbox ZiP (Xbox Half-Life 2) | ❌ | ✅ | ❌ | | ZIP | ZIP file | ✅ | ✅ | ✅ |

• Preview files contained within the pack file without extracting them:

  • Audio
  • Text files (any encoding)
  • KeyValues files (text files with syntax highlighting)
  • Images
  • Source 1 Textures
    • Prop lightmaps
    • Troika textures
    • Valve textures for both PC and console
  • Source 1 Models
  • Source 1 DMX files (particles, SFM sessions, etc.)

• Create pack files of any version from scratch or an existing folder

• Add and remove files and folders from writable pack files

  • Directly edit text files within writable pack files

• Extract files and folders from readable pack files

• Switch version of existing VPKs

• Native Linux builds

  • Packaged for Arch, Debian, Fedora, NixOS; standalone builds available

• User interface translated to the following languages (support the translation effort here):<br/> 🇧🇦 🇨🇳 🇭🇷 🇳🇱 🇩🇪 🇮🇹 🇯🇵 🇰🇷 🇵🇱 🇧🇷 🇷🇺 🇸🇮 🇪🇸 🇸🇪 🇻🇳

Please read this file to see all keyboard shortcuts.

A separate application with no external dependencies (vpkeditcli) provides a command-line interface.

Planned Features

See the open issues on this repository marked as an enhancement.

Contributing

This project accepts a wide range of contributions, mostly code and translations. Code contributions are done through this GitHub repository. Translations are open to everyone, only requiring a free POEditor account, and are hosted at https://poeditor.com/join/project/yxR9MLc9X2. Any contributors will be added to the credits in the form of a text file shipped with the CLI application and a popup in the GUI application.

Backend

This tool is powered by a collection of open-source C++20 Source engine parsers called sourcepp.

Star History

<a href="https://www.star-history.com/#craftablescience/VPKEdit&Date"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=craftablescience/VPKEdit&type=Date&theme=dark" /> <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=craftablescience/VPKEdit&type=Date" /> <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=craftablescience/VPKEdit&type=Date" /> </picture> </a>