Skip to content

thegraydot/mpqcli

Repository files navigation

mpqcli

Build Status Test Status

Release Version

Release downloads Package downloads

A command-line tool to create, add, remove, list, extract, read, and verify MPQ archives using the StormLib library.

⚠️ Warning: This project is under active development and will change functionality between released versions until version 1.0.0.

Overview

This is a command-line tool, designed for automation and built with the Unix philosophy in mind. It is designed to work seamlessly with other command-line tools, supporting piping, redirection, and integration into shell scripts and workflows. For example:

  • Run one command to create an MPQ archive from a directory of files or a single file
  • Run one command to list all files in an MPQ archive
  • Pipe the output to grep or other tools to search, filter, or process files
  • Redirect output to files or other commands for further automation

If you require an MPQ tool with a graphical interface (GUI) and explicit support for more MPQ archive versions — I would recommend using Ladik's MPQ Editor.

Releases

Pre-built binaries are available for Linux and Windows on GitHub releases.

Docker images are available on GitHub packages.

Quickstart

curl -fsSL https://raw.githubusercontent.com/thegraydot/mpqcli/main/scripts/install.sh | bash
...
mpqcli list <some-mpq-archive>

Microsoft Windows:

irm https://raw.githubusercontent.com/thegraydot/mpqcli/main/scripts/install.ps1 | iex
...
mpqcli.exe list <some-mpq-archive>

Documentation

Please see mpqcli.thegraydot.com for full documentation.

Contributing

Please see the CONTRIBUTING.md document.

About

A command-line tool to create, add, remove, list, extract, read, and verify MPQ archives using the StormLib library.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors