Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.33 KB

README.md

File metadata and controls

65 lines (41 loc) · 2.33 KB

Bevy Vach Assets [BVA]

Warning! Very basic, very opinionated, rough edges everywhere!

This project is written to work for me and my ideas, it might not suite your needs.

Bevy plugin

A plugin to use an archive file for your assets in your Bevy projects.

It builds on vach for the archive format which provides compression and encryption.

Both of those features are non-negotiatable defaults in BVA.

Bevy compatibility

bevy bevy_vach_assets
0.12 0.1.*

Limitations and constraints

As mentioned compression and encryption (plus signing) are enabled by default. This does come with performance hits compared to native direct asset loading. There are no benchmarks, but asset loading performance is not a goal right now.

It should work for WASM as a target, but only if the public/verifiying key and the archive are provides as byte arrays to the plugin. Thus the best way is to embed the assets archive into the binary, making it quite similar to directly embed the assets with bevy_embedded_assets. The difference is that the embedded archive still benefits from the compression and encryption, making it harder to inspect the binary for asset data.

Inspirations

CLI

The bva_cli package provides a helper program (bva executable) to quickly generate keys and archive the assets.

Note: vach also provides a CLI, but bva is tailored to work with your Bevy project and the bevy_vach_assets plugin.


License

Licensed under either of

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.