Packaged data file format

Although the builder and loader for this format are implemented in Python, the format can of course be read by any languange.

• 0x00 (2-byte unsigned little-endian int): File format version.
• 0x01 (8-byte unsigned little-endian int): Size of the file location header, in bytes, as stored in the file (i.e. after compression).
• 0x09 (1-byte bool): Whether the header is compressed (not including these first 10 bytes, which are never compressed).
• 0x0A (1-byte bool): Whether the file paths use crc32 encoding.
• 0x0B (UTF-8 string): The file location header, as JSON.
• The rest is file data, placed end-to-end.

File location header (JSON)

{"folder\\file1.txt":
        [file location, relative to the end of the entire header (int),
         file size, after compression if enabled (int),
         file is compressed (bool),
         first byte of file (int),
         last byte of file (int)],
"folder\\file2.txt": [...], ...}

Note

This example is multi-line for readability, but the actual format has no newlines.

Note

File paths are stored as actual double backslashes (\\). Python’s JSON loader handles this automatically, make sure yours does or reformat the string.

Note

If using crc32 file paths, they are stored as strings of integers.