#component #bevy #assets #registry #gamedev

bevy_registry_export

Allows you to create a Json export of all your components/ registered types of your Bevy app/game

5 unstable releases

0.3.1 Mar 18, 2024
0.3.0 Mar 4, 2024
0.2.0 Mar 4, 2024
0.1.1 Feb 7, 2024
0.1.0 Feb 5, 2024

#805 in Game dev

Download history 31/week @ 2024-02-03 5/week @ 2024-02-10 44/week @ 2024-02-17 41/week @ 2024-02-24 343/week @ 2024-03-02 86/week @ 2024-03-09 144/week @ 2024-03-16 42/week @ 2024-03-23 53/week @ 2024-03-30 37/week @ 2024-04-06

283 downloads per month

MIT/Apache

19KB
311 lines

Crates.io Docs License Bevy tracking

bevy_registry_export

This plugin allows you to create a Json export of all your components/ registered types. Its main use case is as a backbone for the bevy_components Blender add-on, that allows you to add & edit components directly in Blender, using the actual type definitions from Bevy (and any of your custom types & components that you register in Bevy).

Usage

Here's a minimal usage example:

# Cargo.toml
[dependencies]
bevy="0.13"
bevy_registry_export = "0.3"
use bevy::prelude::*;
use bevy_registry_export::*;

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            ExportRegistryPlugin::default() // will save your registry schema json file to assets/registry.json
        ))
        .run();
}

take a look at the example for more clarity

Installation

Add the following to your [dependencies] section in Cargo.toml:

bevy_registry_export = "0.3"

Or use cargo add:

cargo add bevy_registry_export

Setup

use bevy::prelude::*;
use bevy_registry_export::*;

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins
            ExportRegistryPlugin::default()
        ))
        .run();
}

you can also configure the output path

use bevy::prelude::*;
use bevy_registry_export::*;

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins
            ExportRegistryPlugin {
                save_path: "assets/registry.json".into(),
                ..Default::default()
            },
        ))
        .run();
}

Usage

  • The output file will be generated in the Startup schedule whenever you run your app.
  • Every time you compile & run your app, the output json file will be updated.

Examples

All examples are here:

the examples use bevy_gltf_blueprints with the legacy_mode set to FALSE as the new custom properties generated by the Blender add-on require newer/ non legacy logic.

Compatible Bevy versions

The main branch is compatible with the latest Bevy release, while the branch bevy_main tries to track the main branch of Bevy (PRs updating the tracked commit are welcome).

Compatibility of bevy_registry_export versions:

bevy_registry_export bevy bevy_components (Blender add-on)
0.3 0.13 0.3
0.2 0.12 0.3
0.1 0.12 0.1 -0.2
branch main 0.12 0.1
branch bevy_main main n/a

Contributors

Thanks to all the contributors helping out with this project ! Big kudos to you, contributions are always appreciated ! :) A big shout out to killercup, that did the bulk of the Bevy side code !

License

This crate, all its code, contents & assets is Dual-licensed under either of

Dependencies

~20–59MB
~1M SLoC