bevy-histrion-packer

KO | EN

gitlite — search

#python #hacktoberfest #go #linux #docker #nodejs #macos #java #windows #cli #awesome-list #security #pytorch #open-source

bevy-histrion-packer

(★ 22)

A Bevy plugin to pack assets into a single PAK like file :package:

bevy-histrion-packer Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">bevy-histrion-packer</h1>

![MIT or Apache 2.0](https://img.shields.io/badge/License-MIT%20or%20Apache%202.0-blue.svg)
[![Crate](https://img.shields.io/crates/v/bevy-histrion-packer.svg)](https://crates.io/crates/bevy-histrion-packer)
[![Docs](https://docs.rs/bevy-histrion-packer/badge.svg)](https://docs.rs/bevy-histrion-packer)
[![CI](https://github.com/ldubos/bevy-histrion-packer/workflows/CI/badge.svg)](https://github.com/ldubos/bevy-histrion-packer/actions)

Pack all your game assets into a single common PAK like file format.

</div>

> [!WARNING]
> This crate is in early development.<br/>
> Use it with caution as the format and API is not yet stabilized.

## File Structure

Header
====================================================
Offset  Size    Description
0x0000  4       Magic number (HPAK signature)
0x0004  4       Version number (u32)
0x0008  1       Metadata compression method
0x0009  8       Entries offset (u64)

Directory Entry
====================================================
Offset  Size    Description
0x0000  8       Hash of the directory path
0x0008  8       Number of paths in the directory
0x0010  var     Array of paths in the directory

File Entry
====================================================
Offset  Size    Description
0x0000  8       Path hash (u64)
0x0008  1       Compression method
0x0009  8       Metadata offset (u64)
0x0011  8       Metadata size (u64)
0x0019  8       Data size (u64)

Entries Tables
====================================================
Offset  Size    Description
0x0000  8       Number of directory entries (u64)
0x0008  var     Array of directory entries
0x????  8       Number of file entries (u64)
0x????  var     Array of file entries
```

## Features

| feature     | description                                                                              |
| ----------- | ---------------------------------------------------------------------------------------- |
| writer      | Enables the ability to generate a HPAK file with [`HpakWriter`](./src/format/writer.rs). |
| debug-impls | Implement the `Debug` trait for applicable types.                                        |

## Bevy Compatibility

| bevy     | bevy-histrion-packer |
| -------- | -------------------- |
| `0.18.0` | `0.8`                |
| `0.17.0` | `0.7`                |
| `0.16.0` | `0.6`                |
| `0.15`   | `0.5`                |
| `0.14`   | `0.4`                |
| `0.13`   | `0.2-0.3`            |
| `0.12`   | `0.1`                |

## License

Dual-licensed under either of

- Apache License, Version 2.0, ([LICENSE-APACHE](/LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](/LICENSE-MIT) or <https://opensource.org/licenses/MIT>)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
additional terms or conditions.

bevy-histrion-packer

bevy-histrion-packer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

bevy-histrion-packer

bevy-histrion-packer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README