qpak
=======================================================================================================================
Unofficial Quake PAK file modification tool
Provides a multiplatform command-line tool for inspecting and modifying and PAK files.
Usage
-----------------------------------------------------------------------------------------------------------------------
`qpak --help`
- [qpak list](#qpak-list)
- [qpak unpack](#qpak-unpack)
- [qpak pack](#qpak-pack)
### qpak list
`qpak list <pak_file>`
Describes the contents of a PAK file.
**pak_file**: The PAK file to inspect
### qpak unpack
`qpak unpack <pak_file> <dest_dir>`
Extracts a pak file into a directory.
**pak_file**: The PAK file to extract from
**dest_dir**: The directory to extract into
### qpak pack
`qpak pack <src_dir> <pak_file>`
Creates a PAK file from a directory.
**src_dir**: The directory to copy files from
**pak_file**: The PAK file to create
Installing
-----------------------------------------------------------------------------------------------------------------------
### Cargo
With [Rust](https://rustup.rs/) installed:
`cargo install qpak`
Compiling
-----------------------------------------------------------------------------------------------------------------------
Written against [Rust](https://rustup.rs/) 2024 edition.
`cargo build`
Contributing
-----------------------------------------------------------------------------------------------------------------------
Pull requests are more than welcome!
Check out the [TODO](../docs/TODO.md).
License (MIT)
-----------------------------------------------------------------------------------------------------------------------
qpak: Unofficial Quake PAK file modification tool
Copyright (C) 2025 cornmonger
Copyright (C) 2017-2020 Cormac O'Brien
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
### Fork
A large portion of this project's original source-code was forked out of Cormac O'Brien's ambitious
[richter](https://github.com/cormac-obrien/richter) project.
### Trademarks
"Quake" is a trademark of [id Software LLC](https://idsoftware.com).
This software is not endorsed by id Software or its parent companies.