Blender_bevy_components_wor.../crates/bevy_registry_export
Mark Moissette 9b50d77790
chore(v0.14): upgraded all current crates, examples, testing setup etc to Bevy 0.14 (#195)
* chore(v0.14): upgraded all current crates, examples, testing setup etc to Bevy 0.14
* chore(Blender tools): some minor fixed for Bevy 0.14 & version bump
2024-07-19 01:24:24 +02:00
..
src chore(Bevy): Update to bevy 0.13 (#136) 2024-03-04 22:16:31 +01:00
Cargo.toml chore(v0.14): upgraded all current crates, examples, testing setup etc to Bevy 0.14 (#195) 2024-07-19 01:24:24 +02:00
LICENSE.md feat(tools/bevy_blueprints): bevy plugin + blender addon for components UI to more easily create components (#70) 2024-02-05 23:01:19 +01:00
LICENSE_APACHE.md feat(tools/bevy_blueprints): bevy plugin + blender addon for components UI to more easily create components (#70) 2024-02-05 23:01:19 +01:00
LICENSE_MIT.md feat(tools/bevy_blueprints): bevy plugin + blender addon for components UI to more easily create components (#70) 2024-02-05 23:01:19 +01:00
README.md chore(v0.14): upgraded all current crates, examples, testing setup etc to Bevy 0.14 (#195) 2024-07-19 01:24:24 +02:00

README.md

Crates.io Docs License Bevy tracking

bevy_registry_export (deprecated in favor of Blenvy)

bevy_registry_export has been deprecated in favor of its successor Blenvy, part of the Blenvy project. No further development or maintenance will be done for Bevy bevy_registry_export. See #194 for background.

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.14"
bevy_registry_export = "0.4"
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.4"

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.4 0.14 0.3
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