Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanabi1224/bevy_assets_bundler
Assets Bundler for bevy, with encryption support
https://github.com/hanabi1224/bevy_assets_bundler
assets bevy bundler
Last synced: about 2 months ago
JSON representation
Assets Bundler for bevy, with encryption support
- Host: GitHub
- URL: https://github.com/hanabi1224/bevy_assets_bundler
- Owner: hanabi1224
- License: mit
- Created: 2021-08-15T10:04:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-04T22:34:42.000Z (over 1 year ago)
- Last Synced: 2024-10-25T01:34:53.530Z (about 2 months ago)
- Topics: assets, bevy, bundler
- Language: Rust
- Homepage:
- Size: 267 KB
- Stars: 43
- Watchers: 3
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bevy Assets Bundler
[](https://github.com/hanabi1224/bevy_assets_bundler/actions/workflows/main.yml)
[](https://codecov.io/gh/hanabi1224/bevy_assets_bundler)
[](https://deps.rs/repo/github/hanabi1224/bevy_assets_bundler)
[](https://github.com/hanabi1224/bevy_assets_bundler)
[](https://github.com/hanabi1224/bevy_assets_bundler/blob/master/LICENSE)
[](https://crates.io/crates/bevy_assets_bundler)
[](https://docs.rs/bevy_assets_bundler)
Assets Bundler for bevy, with content encryption support. Current archive format is tar and encryption algorithm is AES
## Features
- Bundle asset folder into a single assets.bin file
- Asset encryption with custom key
- Asset file names encoding (base58 when ecryption is off, AES+base58 otherwise)
- One simple switch to turn off bundling on debug build
## [Installation](https://github.com/hanabi1224/bevy_assets_bundler/blob/main/example/Cargo.toml)
```toml
# Cargo.toml
[dependencies]
bevy = "0.9"
bevy_assets_bundler = "0.5"
[build-dependencies]
bevy_assets_bundler = "0.5"
```
## [Build Script](https://github.com/hanabi1224/bevy_assets_bundler/blob/main/example/build.rs)
You can generate a random key with [this playground](https://play.rust-lang.org/?version=stable&mode=release&edition=2018&gist=cd3cb4ca8b86e67070b94caf366d162e)
```rust
use bevy_assets_bundler::*;
// build.rs
// encryption key: [u8; 16] array
// make sure the key is consistent between build.rs and main.rs
// or follow the example code to share code between build.rs and main.rs
fn main() {
let key = [30, 168, 132, 180, 250, 203, 124, 96, 221, 206, 64, 239, 102, 20, 139, 79];
let mut options = AssetBundlingOptions::default();
options.set_encryption_key(key);
options.encode_file_names = true;
options.enabled_on_debug_build = true;
AssetBundler::from(options).build();//.unwrap();
}
```
## [Bevy Setup](https://github.com/hanabi1224/bevy_assets_bundler/blob/main/example/src/main.rs)
```rust
use bevy_assets_bundler::*;
use bevy::{asset::AssetPlugin, prelude::*};
fn main() {
// encryption key: [u8; 16] array
// make sure the key is consistent between build.rs and main.rs
// or follow the example code to share code between build.rs and main.rs
let key = [30, 168, 132, 180, 250, 203, 124, 96, 221, 206, 64, 239, 102, 20, 139, 79];
let mut options = AssetBundlingOptions::default();
options.set_encryption_key(key);
options.encode_file_names = true;
options.enabled_on_debug_build = true;
App::new()
.add_plugins(
DefaultPlugins
.build()
.add_before::(BundledAssetIoPlugin::from(
options,
)),
)
.add_startup_system(setup)
.run();
}
fn setup(mut commands: Commands, asset_server: Res) {
}
```
## [Options](https://github.com/hanabi1224/bevy_assets_bundler/blob/main/src/plugin/bundled_asset_options.rs)
```rust
#[derive(Debug, Clone)]
pub struct AssetBundlingOptions {
#[cfg(feature = "encryption")]
pub encryption_on: bool,
#[cfg(feature = "encryption")]
pub encryption_key: Option<[u8; 16]>,
#[cfg(feature = "compression")]
pub enable_compression: bool,
pub enabled_on_debug_build: bool,
pub encode_file_names: bool,
pub asset_bundle_name: String,
}
```
## TODO
- Compression
- More encryption algorithms
## Bevy Version Supported
|bevy|bevy_assets_bundler|
|---|---|
|main|bevy_main|
|0.10|0.6|
|0.9|0.5|
|0.8|0.4|
|0.7|0.3|
|0.6|0.2|
|0.5|0.1|
## Examples
Check out [example](https://github.com/hanabi1224/bevy_assets_bundler/tree/main/example) and [E2E test](https://github.com/hanabi1224/bevy_assets_bundler/blob/main/tests/e2e.rs)
To run example: ```cargo run -p example```
go to ```target/release``` folder, now you can move example(.exe) and assets.bin to some other place and run, just keep the relative path between them.
## Disclaimer
The encryption mechnism this library provides does not protect your assets from **ALL** kinds of reverse engineering as long as the game executable and the assets bundle are distributed to end users.
## [License](https://github.com/hanabi1224/bevy_assets_bundler/blob/main/LICENSE)
MIT