Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/craftablescience/VPKEdit
A CLI/GUI tool to create, read, and write several pack file formats.
https://github.com/craftablescience/VPKEdit
cpp source source-engine source2 source2-engine vpk vpk-editor
Last synced: about 2 months ago
JSON representation
A CLI/GUI tool to create, read, and write several pack file formats.
- Host: GitHub
- URL: https://github.com/craftablescience/VPKEdit
- Owner: craftablescience
- License: mit
- Created: 2022-07-30T03:10:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-19T00:01:34.000Z (2 months ago)
- Last Synced: 2024-07-19T11:22:27.136Z (2 months ago)
- Topics: cpp, source, source-engine, source2, source2-engine, vpk, vpk-editor
- Language: C++
- Homepage: https://developer.valvesoftware.com/wiki/VPKEdit
- Size: 4.4 MB
- Stars: 175
- Watchers: 8
- Forks: 15
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- RAWR - VPKEdit - A library and CLI/GUI tool to create, read, and write several pack file formats. (Gaming / Modding / Mapping / Texturing / Hammer Editor)
README
VPKEdit
VPKEdit is an open source MIT-licensed tool that can extract from, preview the contents of and write to several pack file formats.
It also supports creating new VPKs.
## Installing
Please read [this file](https://github.com/craftablescience/VPKEdit/blob/main/INSTALL.md) 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 | ❌ | ✅ | ✅ |
| GRP | Game Resource Package (Build Engine) | ❌ | ✅ | ✅ |
| PAK | PAcK file (Quake, original Half-Life, etc.) | ❌ | ✅ | ✅ |
| PCK | Godot PaCK file (Standalone or embedded) | ❌ | ✅ | ✅ |
| VPK | Valve PacK file (Source Engine) | ✅ | ✅ | ✅ |
| ZIP | ZIP file (Uncompressed) | ❌ | ✅ | ✅ |
- 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
- Create VPKs 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](https://poeditor.com/join/project/yxR9MLc9X2)):
Please read [this file](https://github.com/craftablescience/VPKEdit/blob/main/CONTROLS.md) to see all keyboard shortcuts.
A separate application with no external dependencies (`vpkeditcli`) provides a command-line interface. Currently it can only create VPK files.
## Planned Features
See [the open issues on this repository marked as an enhancement](https://github.com/craftablescience/VPKEdit/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement).
## 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](https://github.com/craftablescience/sourcepp).