initial checkin

AUTHORS

@@ -0,0 +1,3 @@
+Project Initiator & Lead Programmer:
+
+	- Maik Broemme <[email protected]>

FAQ

@@ -0,0 +1,63 @@
+FAQ - Frequently Asked Questions
+================================
+
+Q: What is libmpq/mpq-tools?
+A: libmpq is a library for manipulating MoPaQ mpq archives mostly used
+   used by Blizzard in their games. mpq-tools are utilities using
+   libmpq.
+
+Q: What can i do with libmpq/mpq-tools?
+A: With libmpq you can write applications which can extract and
+   create mpq archives or delete files within those. mpq-tools
+   is a package which demonstrates this functionality.
+
+Q: Is it possible to extract files with their filenames?
+A: Yes, since version 0.3.0 of libmpq you can use namebased or
+   numberbased extraction. Notice: You need a corresponding listfile
+   for that archive.
+
+Q: Is it legal?
+A: Yes, i think so. I have no idea why it should not, all informations
+   about the fileformat are available.
+
+Q: Is there a description of the functions?
+A: Not yet :(
+
+Q: Can i help?
+A: Yes, help is needed, not only with developing, also with testing.
+   A good point to start is using a recent CVS version of mpq-tools.
+   and trying to use it with every mpq archive you could get :)
+
+Q: Where can i found recent CVS version?
+A: Here: http://babelize.org/cgi-bin/cvsweb.cgi/
+
+Q: Where can i subscribe to the mailing lists?
+A: Here: http://www.babelize.org/ml.php
+
+Q: Can you give a small example to demonstrate the usage?
+A: Of course :-) The example below takes first parameter
+   as mpq archive and extracts first file from it.
+
+   /*
+    *  Compile with:
+    *
+    *  gcc mpq-example.c -o mpq-example -lmpq -I/usr/local/include/libmpq
+    */
+
+   #include <linux/limits.h>
+   #include "libmpq/mpq.h"
+
+   int main(int argc, char **argv) {
+           char listfile[PATH_MAX] = "/usr/local/share/libmpq/db/diablo2/setup.mpq.conf"
+           mpq_archive *mpq_a;
+
+           mpq_a = malloc(sizeof(mpq_archive));
+           memset(mpq_a, 0, sizeof(mpq_archive));
+
+           libmpq_archive_open(mpq_a, argv[1]);
+           libmpq_listfile_open(mpq_a, listfile);
+           libmpq_file_extract(mpq_a, 1);
+           libmpq_archive_close(mpq_a);
+
+           free(mpq_a);
+   }

INSTALL

@@ -0,0 +1,182 @@
+Basic Installation
+==================
+
+   These are generic installation instructions.
+
+   The `configure' shell script attempts to guess correct values for
+various system-dependent variables used during compilation.  It uses
+those values to create a `Makefile' in each directory of the package.
+It may also create one or more `.h' files containing system-dependent
+definitions.  Finally, it creates a shell script `config.status' that
+you can run in the future to recreate the current configuration, a file
+`config.cache' that saves the results of its tests to speed up
+reconfiguring, and a file `config.log' containing compiler output
+(useful mainly for debugging `configure').
+
+   If you need to do unusual things to compile the package, please try
+to figure out how `configure' could check whether to do them, and mail
+diffs or instructions to the address given in the `README' so they can
+be considered for the next release.  If at some point `config.cache'
+contains results you don't want to keep, you may remove or edit it.
+
+   The file `configure.in' is used to create `configure' by a program
+called `autoconf'.  You only need `configure.in' if you want to change
+it or regenerate `configure' using a newer version of `autoconf'.
+
+The simplest way to compile this package is:
+
+  1. `cd' to the directory containing the package's source code and type
+     `./configure' to configure the package for your system.  If you're
+     using `csh' on an old version of System V, you might need to type
+     `sh ./configure' instead to prevent `csh' from trying to execute
+     `configure' itself.
+
+     Running `configure' takes awhile.  While running, it prints some
+     messages telling which features it is checking for.
+
+  2. Type `make' to compile the package.
+
+  3. Optionally, type `make check' to run any self-tests that come with
+     the package.
+
+  4. Type `make install' to install the programs and any data files and
+     documentation.
+
+  5. You can remove the program binaries and object files from the
+     source code directory by typing `make clean'.  To also remove the
+     files that `configure' created (so you can compile the package for
+     a different kind of computer), type `make distclean'.  There is
+     also a `make maintainer-clean' target, but that is intended mainly
+     for the package's developers.  If you use it, you may have to get
+     all sorts of other programs in order to regenerate files that came
+     with the distribution.
+
+Compilers and Options
+=====================
+
+   Some systems require unusual options for compilation or linking that
+the `configure' script does not know about.  You can give `configure'
+initial values for variables by setting them in the environment.  Using
+a Bourne-compatible shell, you can do that on the command line like
+this:
+     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
+
+Or on systems that have the `env' program, you can do it like this:
+     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
+
+Compiling For Multiple Architectures
+====================================
+
+   You can compile the package for more than one kind of computer at the
+same time, by placing the object files for each architecture in their
+own directory.  To do this, you must use a version of `make' that
+supports the `VPATH' variable, such as GNU `make'.  `cd' to the
+directory where you want the object files and executables to go and run
+the `configure' script.  `configure' automatically checks for the
+source code in the directory that `configure' is in and in `..'.
+
+   If you have to use a `make' that does not supports the `VPATH'
+variable, you have to compile the package for one architecture at a time
+in the source code directory.  After you have installed the package for
+one architecture, use `make distclean' before reconfiguring for another
+architecture.
+
+Installation Names
+==================
+
+   By default, `make install' will install the package's files in
+`/usr/local/bin', `/usr/local/man', etc.  You can specify an
+installation prefix other than `/usr/local' by giving `configure' the
+option `--prefix=PATH'.
+
+   You can specify separate installation prefixes for
+architecture-specific files and architecture-independent files.  If you
+give `configure' the option `--exec-prefix=PATH', the package will use
+PATH as the prefix for installing programs and libraries.
+Documentation and other data files will still use the regular prefix.
+
+   In addition, if you use an unusual directory layout you can give
+options like `--bindir=PATH' to specify different values for particular
+kinds of files.  Run `configure --help' for a list of the directories
+you can set and what kinds of files go in them.
+
+   If the package supports it, you can cause programs to be installed
+with an extra prefix or suffix on their names by giving `configure' the
+option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
+
+Optional Features
+=================
+
+   Some packages pay attention to `--enable-FEATURE' options to
+`configure', where FEATURE indicates an optional part of the package.
+They may also pay attention to `--with-PACKAGE' options, where PACKAGE
+is something like `gnu-as' or `x' (for the X Window System).  The
+`README' should mention any `--enable-' and `--with-' options that the
+package recognizes.
+
+   For packages that use the X Window System, `configure' can usually
+find the X include and library files automatically, but if it doesn't,
+you can use the `configure' options `--x-includes=DIR' and
+`--x-libraries=DIR' to specify their locations.
+
+Specifying the System Type
+==========================
+
+   There may be some features `configure' can not figure out
+automatically, but needs to determine by the type of host the package
+will run on.  Usually `configure' can figure that out, but if it prints
+a message saying it can not guess the host type, give it the
+`--host=TYPE' option.  TYPE can either be a short name for the system
+type, such as `sun4', or a canonical name with three fields:
+     CPU-COMPANY-SYSTEM
+
+See the file `config.sub' for the possible values of each field.  If
+`config.sub' isn't included in this package, then this package doesn't
+need to know the host type.
+
+   If you are building compiler tools for cross-compiling, you can also
+use the `--target=TYPE' option to select the type of system they will
+produce code for and the `--build=TYPE' option to select the type of
+system on which you are compiling the package.
+
+Sharing Defaults
+================
+
+   If you want to set default values for `configure' scripts to share,
+you can create a site shell script called `config.site' that gives
+default values for variables like `CC', `cache_file', and `prefix'.
+`configure' looks for `PREFIX/share/config.site' if it exists, then
+`PREFIX/etc/config.site' if it exists.  Or, you can set the
+`CONFIG_SITE' environment variable to the location of the site script.
+A warning: not all `configure' scripts look for a site script.
+
+Operation Controls
+==================
+
+   `configure' recognizes the following options to control how it
+operates.
+
+`--cache-file=FILE'
+     Use and save the results of the tests in FILE instead of
+     `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
+     debugging `configure'.
+
+`--help'
+     Print a summary of the options to `configure', and exit.
+
+`--quiet'
+`--silent'
+`-q'
+     Do not print messages saying which checks are being made.  To
+     suppress all normal output, redirect it to `/dev/null' (any error
+     messages will still be shown).
+
+`--srcdir=DIR'
+     Look for the package's source code in directory DIR.  Usually
+     `configure' can determine that directory automatically.
+
+`--version'
+     Print the version of Autoconf used to generate the `configure'
+     script, and exit.
+
+`configure' also accepts some other, not widely useful, options.

Makefile.am

@@ -0,0 +1,19 @@
+# The top-level input Makefile for mpq-tools
+
+# minimum required automake 1.6
+AUTOMAKE_OPTIONS = 1.6
+
+# Any directories which should be built and installed.
+SUBDIRS = db libmpq src
+
+# The directories which are part of the distribution.
+DIST_SUBDIRS = $(SUBDIRS)
+
+EXTRA_DIST =		\
+	AUTHORS		\
+	COPYING		\
+	ChangeLog	\
+	NEWS		\
+	README		\
+	THANKS		\
+	TODO

README

@@ -0,0 +1,41 @@
+Introduction
+============
+
+libmpq is a library which can be easily used in own applications
+and a set of tools for manipulating mpq archives. At this moment
+mpq-tools is able to show you file informations and extracting
+files by their corresponding number and name. The filenames will
+be identified through a listfile database.
+
+MPQ, or MoPaQ, is a proprietary archive format created by
+Mike O'Brien, the man hailed as Blizzard's multiplayer engine
+genius, back in 1996 as a general purpose archive for use with
+Diablo, and named narcissistically for its creator
+"Mike O'brien PaCK". The copyrights to it, however, are held by
+Havas Interactive, Blizzard's parent company. The archive format
+is used by many Blizzard titles like Diablo, Diablo 2, Starcraft,
+Warcraft 2: BNE or a newer version in Warcraft 3.
+
+Manual
+======
+
+Not yet written, for an example on how to use libmpq look at the
+`FAQ' file.
+
+Reporting Bugs
+==============
+
+Bug reports for libmpq should be send to the libmpq user mailing
+list.
+
+	[email protected]
+
+The discussion list `[email protected]' often contains
+information about new ports of libmpq, or discussions of new
+features or behavior changes that people would like. For humon
+readability mark bug reports with [BUG] in the subject.
+
+Enjoy!
+
+Maik Broemme <[email protected]>
+http://www.babelize.org/

THANKS

@@ -0,0 +1,14 @@
+mpq-tools and libmpq was originaly created by Maik Broemme <[email protected]>
+and the source is based on many sources from other people.
+
+	� Ladislav Zezula <[email protected]>
+	� Marko Friedemann <[email protected]>
+	� Tom Amigo <[email protected]>
+	� ShadowFlare <[email protected]>
+	� Justin Olbrantz (Quantam) <[email protected]>
+
+All this people have done a great job on reverse enigineering and
+analyzing the MPQ archive format. Special thanks goes to Ladislav
+Zezula the creator of the well known "stormlib" and Marko Friedemann
+for porting this source to linux. Justin for the really informative
+"Inside MoPaQ" article and all others I forgot :)

TODO

@@ -0,0 +1,14 @@
+Features and functionality which should be added in the future.
+
+	� Porting for 64 bit architectures.
+	� Porting for big endian systems.
+	� Porting for Windows? :)
+	� Namebased file extraction.
+	� Creating mpq archives.
+	� Brute all unknown filenames, Blizzard
+	  uses in their archives.
+	� Error handling
+
+Contact us at `[email protected]' if you want help us
+with libmpq, or if you have other interesting features which
+should be added.

autogen.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+#
+echo "Generating build information using aclocal, autoheader, automake and autoconf"
+echo "This may take a while ..."
+
+# Touch the timestamps on all the files since CVS messes them up
+directory=`dirname $0`
+touch $directory/configure.ac
+
+# Regenerate configuration files
+aclocal
+autoheader
+automake --foreign --add-missing --copy
+autoconf
+
+# Run configure for this platform
+#./configure $*
+echo "Now you are ready to run ./configure"