Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A fast archive format, designed for storing game data. (Plus a reference implementation in Erlang)

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 ebin
Octocat-spinner-32 include
Octocat-spinner-32 src
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 COPYING
Octocat-spinner-32 Emakefile
Octocat-spinner-32 Makefile
Octocat-spinner-32 README
Octocat-spinner-32 README.format
Octocat-spinner-32 README.usage
README
kzkpack - a simple archive format for game data
===============================================

This project is licensed under the WTFPL, version 2. Check the COPYING
file for more details.

Any feedback, bug reports should be reported on :
<http://projects.artefact2.com/projects/kzk_pack>

If you need to contact the author, send an email to
<artefact2@gmail.com>.

Compiling
=========

To compile the Erlang source files, and create the "kzkpack"
executable utility, just run the `make` command.

To run the tests, run `make tests`. If they fail, then something is
very wrong!

Format specification
====================

A complete description is in the README.format file. If the
description is ambiguous in any way, then the Erlang implementation
provided acts as the reference.

Command-line interface
======================

Even though pack files are primarily intended for games (where pack
contents is accessed programmatically), a command-line tool is
provided, and can be used to manipulate / create packs from the
command-line.

The full help can be read in the README.usage file. The same file will
also be printed if you try to use the tool with incorrect arguments.

Caveats / Known issues
======================

- A major version bump (for example 2.x -> 3.0) indicates incompatible
  changes in the pack format itself. The new version will NOT be able
  to read old packs! Be sure to unpack any existing packs with the old
  version before upgrading, then recreate the pack with the new
  version.
Something went wrong with that request. Please try again.