summaryrefslogtreecommitdiff
path: root/README.md
blob: 7da26912869fddc271ca832b35ba025f43a94d3e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# Nekopack

Nekopack is a tool for extracting game data from Nekopara's XP3 archives. It was
the result of a month-long effort to reverse engineer the archive format used by
Nekopara.

Nekopack is free software, licensed under the [GNU General Public
License.](http://gnu.org/licenses/gpl.html)

## Compilation

Nekopack can be compiled on Linux by running `make` from the repository's root
directory.

*BSD users will have to install and run `gmake` to build Nekopack.

The test suite is run with `make test` or `gmake test`, depending on your
platform.

You can add specific flags to the Makefile with `USER_CFLAGS` and/or
`USER_LDFLAGS`.

## TODO

- Full unit testing, test static functions.
- Clean up `main.c`, move functions like `load_table` and `make_dirs` into more
  appropriate files.
- Clean up `create_archive`.
- Strict warnings.
- Game-compatible file encryption on created archives.