Skip to content

Commit

Permalink
Update Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Frotty committed Jun 4, 2017
1 parent c03e618 commit d910215
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,33 @@
[![Build Status](https://travis-ci.org/inwc3/JMPQ3.svg?branch=master)](https://travis-ci.org/inwc3/JMPQ3) [![Coverage Status](https://coveralls.io/repos/github/inwc3/JMPQ3/badge.svg?branch=master)](https://coveralls.io/github/inwc3/JMPQ3?branch=master)

[![Build Status](https://travis-ci.org/inwc3/JMPQ3.svg?branch=master)](https://travis-ci.org/inwc3/JMPQ3) [![Jit](https://jitpack.io/v/inwc3/JMPQ3.svg)](https://jitpack.io/#inwc3/JMPQ3) [![Coverage Status](https://coveralls.io/repos/github/inwc3/JMPQ3/badge.svg?branch=master)](https://coveralls.io/github/inwc3/JMPQ3?branch=master)
## What?
JMPQ3 is a small java library for accessing and modifying MoPaQ (.mpq,.w3m,.w3x) Archives.

MoPaQ is Blizzard's old, proprietary archive format for storing gamedata (replaced with CASC).

You can find more info and an excellent editor here http://www.zezula.net/en/mpq/main.html

For Java programs however it is neater to rely on Java only instead of some native libraries.
## Get it
It is recommended to use the jitpack dependency.
For that just add jitpack as maven repository and add the jmpq dependency.

```gradle
dependencies {
compile 'com.github.inwc3:JMPQ3:1.4.0'
}
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}
```
See https://jitpack.io/#inwc3/JMPQ3/

**Download** the latest release here:
But you can still download the jar directly if you prefer
https://github.com/inwc3/JMPQ3/releases

Maven artifacts will hopefully be back soon.

## How to use
Quick API Overview:

Jmpq provides the OpenOptions `READ_ONLY` which should be selfexplanatory and `FORCE_V0` which forces the mpq to be opened like warcraft3 would open it, ignoring optional data from later specifications for compatability.
Expand Down

0 comments on commit d910215

Please sign in to comment.