https://github.com/jhonnold/mpq
Kotlin/Java library to parse MPQ archive files
https://github.com/jhonnold/mpq
blizzard kotlin mpq starcraft2
Last synced: about 1 month ago
JSON representation
Kotlin/Java library to parse MPQ archive files
- Host: GitHub
- URL: https://github.com/jhonnold/mpq
- Owner: jhonnold
- License: mit
- Created: 2020-06-30T22:21:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-07-26T13:36:45.000Z (about 5 years ago)
- Last Synced: 2025-04-01T01:52:42.908Z (6 months ago)
- Topics: blizzard, kotlin, mpq, starcraft2
- Language: Kotlin
- Homepage:
- Size: 1.04 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
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](#getting-started)
* [Gradle](#gradle)
* [Maven](#maven)
* [Usage](#usage)
* [Contributing](#contributing)
* [License](#license)
* [Contact](#contact)
* [Acknowledgements](#acknowledgements)
## Getting Started
Follow the steps below to use this within project.
#### Gradle
```gradle
implementation group: 'me.honnold', name: 'mpq', version: ...
```
#### Maven
```xml
me.honnold
mpq
...
```
## Usage
Import the base `Archive` class and supply a path to the MPQ file.
```java
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](https://github.com/jhonnold/mpq)
## Acknowledgements
* [mpyq](https://github.com/eagleflo/mpyq)
* [Scelight](https://github.com/icza/scelight)
* [MPQ Archives](http://www.zezula.net/en/mpq/main.html)
[contributors-shield]: https://img.shields.io/github/contributors/jhonnold/mpq?style=flat-square
[contributors-url]: https://github.com/jhonnold/mpq/graphs/contributors
[issues-shield]: https://img.shields.io/github/issues/jhonnold/mpq.svg?style=flat-square
[issues-url]: https://github.com/jhonnold/mpq/issues
[license-shield]: https://img.shields.io/github/license/jhonnold/mpq.svg?style=flat-square
[license-url]: https://github.com/jhonnold/mpq/blob/master/LICENSE