Bevy common assets

Collection of Bevy plugins offering generic asset loaders for common file formats.

Supported formats:

| format | feature | example | |:----------|:----------|:--------------------------------------| | json | json | json.rs | | msgpack | msgpack | msgpack.rs | | ron | ron | ron.rs | | toml | toml | toml.rs | | yaml | yaml | yaml.rs |

Usage

Enable the feature(s) for the format(s) that you want to use.

Define the types that you would like to load from files and derive serde::Deserialize and bevy::reflect::TypeUuid for them. The latter requires a unique uuid as an attribute: ```rust use bevy::reflect::TypeUuid;

[derive(serde::Deserialize, bevy::reflect::TypeUuid)]

[uuid = "413be529-bfeb-41b3-9db0-4b8b380a2c46"] // <-- keep me unique

struct Level { positions: Vec<[f32;3]>, } ```

With your types ready, you can add asset plugins for each type. Every plugin gets the asset type as a generic parameter. You also need to configure custom file endings for each type: ```rust norun use bevy::prelude::*; use bevycommonassets::json::JsonAssetPlugin; use bevycommonassets::msgpack::MsgPackAssetPlugin; use bevycommonassets::ron::RonAssetPlugin; use bevycommonassets::toml::TomlAssetPlugin; use bevycommon_assets::yaml::YamlAssetPlugin;

fn main() { App::new() .addplugins(DefaultPlugins) .addplugin(JsonAssetPlugin::::new(&["json.level", "custom"])) .addplugin(MsgPackAssetPlugin::::new(&["msgpack.level"])) .addplugin(RonAssetPlugin::::new(&["ron.level"])) .addplugin(TomlAssetPlugin::::new(&["toml.level"])) .addplugin(YamlAssetPlugin::::new(&["yaml.level"])) // ... .run(); }

[derive(serde::Deserialize, bevy::reflect::TypeUuid)]

[uuid = "413be529-bfeb-41b3-9db0-4b8b380a2c46"]

struct Level { positions: Vec<[f32; 3]>, } ```

See the examples for working Bevy apps using the different formats.

Compatible Bevy versions

The main branch is compatible with the latest Bevy release.

Compatibility of bevy_common_assets versions:

| bevy_common_assets | bevy | |:---------------------|:-------| | 0.3 | 0.8 | | 0.1 - 0.2 | 0.7 | | main | 0.8 | | bevy_main | main |

Prior art

If you only need to load ron files, bevy_asset_ron offers the same functionality as bevy_common_assets.

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.