Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Frotty committed Jun 11, 2017
1 parent e3b0875 commit fadc677
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[![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) [![codebeat badge](https://codebeat.co/badges/5ccfd060-8d57-4a51-9c6b-2688482f857e)](https://codebeat.co/projects/github-com-inwc3-jmpq3-master)
# JMPQ3
## What?
JMPQ3 is a small java library for accessing and modifying MoPaQ (.mpq,.w3m,.w3x) Archives.
JMPQ3 is a small java library for accessing and modifying mpq (MoPaQ) archives. Common file endings are .mpq, .w3m, .w3x.

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

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

## Get it
*currently only warcraft 3 maps and mpqs are fully supported. Mpqs from other games (WoW, starcraft) might cause problems.*
*currently only warcraft 3 maps and mpqs are confirmed supported. Mpqs from other games (WoW, starcraft) might cause problems.*

It is recommended to use jitpack with a dependency manager like gradle.

Expand Down Expand Up @@ -43,7 +43,7 @@ Jmpq provides the OpenOptions `READ_ONLY` which should be selfexplanatory and `F
e.close(); //Rebuilds the mpq and applies all changes that were made. In readonly mode it only closes the filechannel.
```

###Known issues:
### Known issues:
* To work around https://bugs.openjdk.java.net/browse/JDK-4724038 jmpq creates tempfiles for every object in the mpq
* Unsupported decompression algorithms: sparse, pkware and bzip2
* Only supported compression is zlib
Expand Down

0 comments on commit fadc677

Please sign in to comment.