MPQ Archive Parser

Kotlin/Java library to parse MPQ archives used by Blizzard games. Written mostly for Starcraft II replay files.

Table of Contents

• Getting Started
  • Gradle
  • Maven
• Usage
• Contributing
• License
• Contact
• Acknowledgements

Getting Started

Follow the steps below to use this within project.

Gradle

implementation group: 'me.honnold', name: 'mpq', version: ...

Maven

<dependency>
    <groupId>me.honnold</groupId>
    <artifactId>mpq</artifactId>
    <version>...</version>
</dependency>

Usage

Import the base Archive class and supply a path to the MPQ file.

import me.honnold.mpq.Archive;

public class Example {
    public static void main(String[] args) {
        Archive archive = new Archive(/* Path to file */);
       
        // ...
    }
}

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Jay Honnold

Project Link: https://github.com/jhonnold/mpq

Acknowledgements

• mpyq
• Scelight
• MPQ Archives