Skip to content

Latest commit

 

History

History
89 lines (71 loc) · 5.1 KB

README.md

File metadata and controls

89 lines (71 loc) · 5.1 KB
Raw
VPKEdit Logo

VPKEdit

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

License Workflow Status Discord Ko-Fi
A screenshot of VPKEdit with a VPK and an MDL preview open in wireframe mode. A screenshot of VPKEdit with a VPK and an MDL preview open in shaded textured mode.
A screenshot of VPKEdit with a BSP and a VTF preview open. A screenshot of the command-line version of VPKEdit.

Installing

Please read this file for step-by-step installation instructions.

Features

  • Supported file formats:

    Format Description Create Read Write
    BMZ Bonus Map Zip (Source Engine) ✅ ✅ ✅
    BSP Source 1 Map N/A ✅ ✅
    FPX VPK modification (Tactical Intervention) ✅ ✅ ✅
    GCF Game Cache File (Pre-SteamPipe Steam games) ❌ ✅ ❌
    GMA Garry's Mod Addon ❌ ✅ ✅
    PAK PAcK file (Quake, original Half-Life, etc.) ✅ ✅ ✅
    PCK Godot PaCK file (Standalone or embedded) ✅ ✅ ✅
    VPK Vampire PacK file (V:TMB) 〰️1 ✅ ✅
    VPK Valve PacK file (Source Engine) ✅ ✅ ✅
    WAD Where's All the Data (GoldSrc Engine) ✅ ✅ ✅
    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
    • Source 1 Models
    • Source 1 DMX files (particles, SFM sessions, etc.)
    • Source 1 Prop Lightmaps (PPL files)

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

  • Add and remove files and folders from writable pack files

  • Extract files and folders from readable pack files

  • Switch version of existing VPKs

  • Native Linux compatibility

  • User interface translated to the following languages (support the translation effort here):

    • Bosnian
    • Chinese (simplified)
    • Dutch
    • Italian
    • Japanese
    • Polish
    • Russian
    • Spanish
    • Swedish

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.

Footnotes

  1. Only supported in the CLI interface. ↩