bevy-histrion-packer
| Crates.io | bevy-histrion-packer |
| lib.rs | bevy-histrion-packer |
| version | 0.5.0 |
| source | src |
| created_at | 2023-12-28 11:36:47.965795 |
| updated_at | 2024-11-29 22:09:40.578334 |
| description | A Bevy Plugin to pack all your game assets into a single common PAK like file format. |
| homepage | |
| repository | https://github.com/ldubos/bevy-histrion-packer |
| max_upload_size | |
| id | 1082360 |
| size | 2,066,002 |
Ludwig DUBOS (ldubos)
documentation
https://docs.rs/bevy-histrion-packer
README
bevy-histrion-packer
Pack all your game assets into a single common PAK like file format.
[!WARNING] This crate is in early development.
Use it with caution as the format and API is not yet stabilized.
File Structure
+--------------------------------+ 0x0000
| Header |
+--------------------------------+
| File Content |
+--------------------------------+ <entries_offset>
| Entries Tables |
+--------------------------------+
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 |
|---|---|
| deflate | Enables the deflate compression algorithm. |
| writer | Enables the ability to generate a HPAK file with HpakWriter. |
Bevy Compatibility
| bevy | bevy-histrion-packer |
|---|---|
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 or https://www.apache.org/licenses/LICENSE-2.0)
- MIT license (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.