Building

Requirements

cmake
C++ 17 compiler
StormLib (provided as Git Submodule)
CLI11 (provided as Git Submodule)

Linux

$ git clone --recursive https://github.com/TheGrayDot/mpqcli.git
$ cd mpqcli
$ cmake -B build
$ cmake --build build

The mpqcli binary will be available in: ./build/bin/mpqcli

Windows

$ git clone --recursive https://github.com/TheGrayDot/mpqcli.git
$ cd mpqcli
$ cmake -B build
$ cmake --build build --config Release

The mpqcli.exe binary will be available in: .\build\bin\Release\mpqcli.exe

This project requires the StormLib library. Many thanks to Ladislav Zezula for authoring such a good library and releasing the code under an open-source license. The StormLib library has a number of requirements. However, the build method specifies using the libraries bundled with StormLib.

CLI11

This project also uses the CLI11 command line parser for C++11 and beyond. It provides simple and easy-to-use CLI arguments.

Tests

This project implements End-to-end (E2E) testing, sometimes referred to as system testing or integration testing. This methodology is used because it verifies application functionality by simulating actual usage by an end user. Testing includes creating a variety of MPQ archives, as well as dynamically downloading some small (~1-5MB) MPQ archives from the Internet Archive. The Python programming language coupled with the pytest framework is used to implement testing, mainly due to ease of implementation.

To configure the testing environment you will need Python installed, as well as the required pytest package. On a Debian-based Linux system, the following will configure the environment:

$ sudo apt install python3-venv python3-pip
$ python3 -m venv test/.venv
$ source test/.venv/bin/activate
$ pip3 install -r test/requirements.txt

Then you can run the tests using:

$ python3 -m pytest test -s

Keyboard shortcuts

mpqcli