README

mpyq.js

mpyq.js is a port of the mpyq Python library for reading MPQ archives used in many of Blizzard's games.

It is a straightforward port with the same functionnalities and limitations. See the original Readme for details.

Installation

npm install -S mpyqjs

Usage

As a library

const mpq = require('mpyq');
const MPQArchive = mpq.MPQArchive;

From the command line

usage: mpq.js [-h] [-I] [-H] [-b] [-s] [-t] [-x] file

mpq.js reads and extracts MPQ archives

Options:
  -h, --help           show this help message and exit                 [boolean]
  -I, --headers        print header information from the archive       [boolean]
  -H, --hash-table     print hash table                                [boolean]
  -b, --block-table    print block table                               [boolean]
  -s, --skip-listfile  skip reading(listfile)                          [boolean]
  -t, --list-file      list files inside the archive                   [boolean]
  -x, --extract        extract files from the archive                  [boolean]

Port status

This is a direct port with nothing fancy and little Javascript adjustments or optimizations.

While this port has been successfully used to perform the operations provided and analyze replay files of Heroes of the Storm, not all codepaths have been tested and bugs may arise.

mpyqjs

Usage no npm install needed!