libupkg: Make decodeindex test accept an empty string.
[upkg.git] / README
1 This package contains upkg: a tool for working with Unreal Engine package
2 files.  This is alpha-quality software, and there are almost certainly packages
3 which cause the tool to choke.  That being said, the list and info functions
4 should work with most packages from the original Unreal and Unreal Tournament
5 games.  Other Unreal Engine games may or may not work.  Extracting music files
6 should work.
7
8 == Installation ==
9 === Prerequisites ===
10 Upkg is written in C99, and therefore requires a somewhat modern C compiler.
11 The only hard run-time dependency beyond those required by standard C is the
12 glib-2.0 library, as upkg is based on the GObject type system.  Upkg can also
13 optionally make use of the libmodplug library, but at the moment this is only
14 used to identify module formats when extracting music files, and upkg has its
15 own code to do this identification if modplug is not available.
16
17 Sources checked out from Git (which is the typical case, since there are
18 currently no actual releases of upkg) do not contain any of the generated files
19 which would normally be included in the distribution tarballs.  As such, a
20 number of additional tools are required.  Any version numbers listed represent
21 minimum tested versions.  Using newer versions of the tools should work, but
22 older versions should not be expected to.
23
24  * GNU Autoconf version 2.68
25  * GNU Automake version 1.11.1
26  * GNU Libtool version 2.4
27  * GObject Builder (GOB) 2.0.9999 (**)
28
29 (**) Unfortunately, the current releases of GObject Builder are missing support
30 for dynamic types which are used extensively by upkg.  Moreover, GOB appears
31 dead upstream, so you will need to use a custom-patched version, available
32 from
33
34   http://git.draconx.ca/?p=gob2.git