diff --git a/crates/bevy_gltf_blueprints/Cargo.toml b/crates/bevy_gltf_blueprints/Cargo.toml index 9c47f0d..fbd0749 100644 --- a/crates/bevy_gltf_blueprints/Cargo.toml +++ b/crates/bevy_gltf_blueprints/Cargo.toml @@ -1,8 +1,8 @@ [package] name = "bevy_gltf_blueprints" -version = "0.9.0" +version = "0.10.0" authors = ["Mark 'kaosat-dev' Moissette"] -description = "Adds the ability to define Blueprints/Prefabs for [Bevy](https://bevyengine.org/) inside gltf files and spawn them in Bevy." +description = "Adds the ability to define Blueprints/Prefabs for Bevy inside gltf files and spawn them in Bevy." homepage = "https://github.com/kaosat-dev/Blender_bevy_components_workflow" repository = "https://github.com/kaosat-dev/Blender_bevy_components_workflow" keywords = ["gamedev", "bevy", "gltf", "blueprint", "prefab"] diff --git a/crates/bevy_gltf_blueprints/README.md b/crates/bevy_gltf_blueprints/README.md index 6cad9a1..4be5ee9 100644 --- a/crates/bevy_gltf_blueprints/README.md +++ b/crates/bevy_gltf_blueprints/README.md @@ -5,7 +5,7 @@ # bevy_gltf_blueprints -Built upon [bevy_gltf_components](https://crates.io/crates/bevy_gltf_components) this crate adds the ability to define Blueprints/Prefabs for [Bevy](https://bevyengine.org/) inside gltf files and spawn them in Bevy. +Built on [bevy_gltf_components](https://crates.io/crates/bevy_gltf_components) this crate adds the ability to define Blueprints/Prefabs for [Bevy](https://bevyengine.org/) inside gltf files and spawn them in Bevy. * Allows you to create lightweight levels, where all assets are different gltf files and loaded after the main level is loaded * Allows you to spawn different entities from gtlf files at runtime in a clean manner, including simplified animation support ! @@ -15,7 +15,9 @@ A blueprint is a set of **overrideable** components + a hierarchy: ie * just a Gltf file with Gltf_extras specifying components * a component called BlueprintName -Particularly useful when using [Blender](https://www.blender.org/) as an editor for the [Bevy](https://bevyengine.org/) game engine, combined with the [Blender plugin](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/tools/gltf_auto_export) that does a lot of the work for you +Particularly useful when using [Blender](https://www.blender.org/) as an editor for the [Bevy](https://bevyengine.org/) game engine, combined with the Blender add-ons that do a lot of the work for you +- [gltf_auto_export](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/tools/gltf_auto_export) +- [bevy_components](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/tools/bevy_components) ## Usage @@ -26,7 +28,7 @@ Here's a minimal usage example: # Cargo.toml [dependencies] bevy="0.13" -bevy_gltf_blueprints = { version = "0.9"} +bevy_gltf_blueprints = { version = "0.10"} ``` @@ -64,7 +66,7 @@ fn spawn_blueprint( Add the following to your `[dependencies]` section in `Cargo.toml`: ```toml -bevy_gltf_blueprints = "0.9" +bevy_gltf_blueprints = "0.10" ``` Or use `cargo add`: @@ -165,13 +167,10 @@ commands.spawn(( ### BluePrintBundle -There is also a bundle for convenience , which just has +There is also a ```BluePrintBundle``` for convenience , which just has * a ```BlueprintName``` component * a ```SpawnHere``` component -[```BluePrintBundle```](./src/lib.rs#22) - - ## Additional information - When a blueprint is spawned, all its children entities (and nested children etc) also have an ```InBlueprint``` component that gets insert @@ -219,7 +218,7 @@ the ordering of systems is very important ! For example to replace your proxy components (stand-in components when you cannot/ do not want to use real components in the gltf file) with actual ones, which should happen **AFTER** the Blueprint based spawning, -so ```bevy_gltf_blueprints``` provides a **SystemSet** for that purpose:[```GltfBlueprintsSet```](./src/lib.rs#16) +so ```bevy_gltf_blueprints``` provides a **SystemSet** for that purpose: ```GltfBlueprintsSet``` Typically , the order of systems should be @@ -281,8 +280,7 @@ pub fn animation_change_on_proximity_foxes( see https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_blueprints/animation for how to set it up correctly -particularly from https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_blueprints/animation/game/in_game.rs#86 -onward +particularly from https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_blueprints/animation/game/in_game.rs ## Materials @@ -346,7 +344,7 @@ The main branch is compatible with the latest Bevy release, while the branch `be Compatibility of `bevy_gltf_blueprints` versions: | `bevy_gltf_blueprints` | `bevy` | | :-- | :-- | -| `0.9` | `0.13` | +| `0.9 - 0.10` | `0.13` | | `0.3 - 0.8` | `0.12` | | `0.1 - 0.2` | `0.11` | | branch `main` | `0.13` | diff --git a/crates/bevy_gltf_components/Cargo.toml b/crates/bevy_gltf_components/Cargo.toml index cf1b664..2004d97 100644 --- a/crates/bevy_gltf_components/Cargo.toml +++ b/crates/bevy_gltf_components/Cargo.toml @@ -1,8 +1,8 @@ [package] name = "bevy_gltf_components" -version = "0.5.0" +version = "0.5.1" authors = ["Mark 'kaosat-dev' Moissette"] -description = "Allows you to define [Bevy](https://bevyengine.org/) components direclty inside gltf files and instanciate the components on the Bevy side." +description = "Allows you to define Bevy components direclty inside gltf files and instanciate the components on the Bevy side." homepage = "https://github.com/kaosat-dev/Blender_bevy_components_workflow" repository = "https://github.com/kaosat-dev/Blender_bevy_components_workflow" keywords = ["gamedev", "bevy", "assets", "gltf", "components"] diff --git a/crates/bevy_gltf_components/README.md b/crates/bevy_gltf_components/README.md index fa5289b..9ac3657 100644 --- a/crates/bevy_gltf_components/README.md +++ b/crates/bevy_gltf_components/README.md @@ -13,9 +13,9 @@ This crate allows you to define [Bevy](https://bevyengine.org/) components direc ***important*** : the plugin for processing gltf files runs in ***update*** , so you cannot use the components directly if you spawn your scene from gltf in ***setup*** (the additional components will not show up) Please see the - * [example](https://github.com/kaosat-dev/Blender_bevy_components_workflow/examples/basic) - * or use [```bevy_asset_loader```](https://github.com/NiklasEi/bevy_asset_loader) for a reliable workflow. - * alternatively, use the [```bevy_gltf_blueprints```](https://github.com/kaosat-dev/Blender_bevy_components_workflow/blob/main/crates/bevy_gltf_blueprints) crate, build on this crate's features, + * [example](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_components/basic) + * or use [```bevy_asset_loader```](https://github.com/NiklasEi/bevy_asset_loader) for reliable preloading of files, as this crate does not deal with loading your assets. + * alternatively, use the [```bevy_gltf_blueprints```](https://crates.io/crates/bevy_gltf_blueprints) crate, built on this crate's features, that allows you to directly spawn entities from gltf based blueprints. Here's a minimal usage example: @@ -29,7 +29,7 @@ bevy_gltf_components = { version = "0.5"} ``` ```rust no_run -//too barebones of an example to be meaningfull, please see https://github.com/kaosat-dev/Blender_bevy_components_workflow/examples/basic for a real example +//too barebones of an example to be meaningfull, please see https://github.com/kaosat-dev/Blender_bevy_components_workflow/bevy_gltf_components/examples/basic for a real example fn main() { App::new() .add_plugins(DefaultPlugins) @@ -84,7 +84,7 @@ Or disable the legacy mode: (enabled by default) ComponentsFromGltfPlugin{legacy_mode: false} ``` -You **need** to disable legacy mode if you want to use the [```bevy_components```](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/tools_bevy_blueprints/tools/bevy_components) Blender addon + the [```bevy_registry_export crate```](https://crates.io/crates/bevy_registry_export) ! +You **need** to disable legacy mode if you want to use the [```bevy_components```](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/tools/bevy_components) Blender addon + the [```bevy_registry_export crate```](https://crates.io/crates/bevy_registry_export) ! As it create custom properties that are writen in real **ron** file format instead of a simplified version (the one in the legacy mode) @@ -98,7 +98,7 @@ For example to replace your proxy components (stand-in components when you canno which should happen **AFTER** the components from the gltf files have been injected, -so ```bevy_gltf_components``` provides a **SystemSet** for that purpose:[```GltfComponentsSet```](./src/lib.rs#46) +so ```bevy_gltf_components``` provides a **SystemSet** for that purpose:```GltfComponentsSet``` Typically , the order of systems should be @@ -116,7 +116,7 @@ Typically , the order of systems should be ## Examples -https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/basic +https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_components/basic diff --git a/crates/bevy_gltf_save_load/Cargo.toml b/crates/bevy_gltf_save_load/Cargo.toml index 2da1390..4e7eeea 100644 --- a/crates/bevy_gltf_save_load/Cargo.toml +++ b/crates/bevy_gltf_save_load/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "bevy_gltf_save_load" -version = "0.4.0" +version = "0.4.1" authors = ["Mark 'kaosat-dev' Moissette"] description = "Save & load your bevy games" homepage = "https://github.com/kaosat-dev/Blender_bevy_components_workflow" @@ -15,8 +15,7 @@ workspace = true [dependencies] bevy = { version = "0.13", default-features = false, features = ["bevy_asset", "bevy_scene", "bevy_gltf"] } -#bevy_gltf_blueprints = "0.9" -bevy_gltf_blueprints = { version = "0.9", path = "../bevy_gltf_blueprints" } +bevy_gltf_blueprints = { version = "0.10", path = "../bevy_gltf_blueprints" } [dev-dependencies] bevy = { version = "0.13", default-features = false, features = ["dynamic_linking"] } diff --git a/crates/bevy_gltf_save_load/README.md b/crates/bevy_gltf_save_load/README.md index 1141132..43aec04 100644 --- a/crates/bevy_gltf_save_load/README.md +++ b/crates/bevy_gltf_save_load/README.md @@ -36,7 +36,7 @@ Here's a minimal usage example: [dependencies] bevy="0.13" bevy_gltf_save_load = "0.4" -bevy_gltf_blueprints = "0.9" // also needed +bevy_gltf_blueprints = "0.10" // also needed ``` ```rust no_run @@ -133,7 +133,7 @@ pub fn setup_game( ``` -take a look at the [example]('https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_save_load/basic/src/game/mod.rs) for more clarity +take a look at the [example](https://github.com/kaosat-dev/Blender_bevy_components_workflow/blob/main/examples/bevy_gltf_save_load/basic/src/game/mod.rs) for more clarity ## Installation @@ -142,12 +142,7 @@ Add the following to your `[dependencies]` section in `Cargo.toml`: ```toml bevy_gltf_save_load = "0.3" -<<<<<<< HEAD -bevy_gltf_blueprints = "0.8" // also needed, as bevy_gltf_save_load does not re-export it at this time -======= -bevy_gltf_blueprints = "0.6" // also needed, as bevy_gltf_save_load does not re-export it at this time ->>>>>>> 9cb9dda5d35c635d367fa81ca1a6c752cda9bc02 - +bevy_gltf_blueprints = "0.10" // also needed, as bevy_gltf_save_load does not re-export it at this time ``` Or use `cargo add`: @@ -268,7 +263,7 @@ pub fn request_load( - ```LoadingFinished``` for loading > Note: I **highly** recomend you change states when you start/finish saving & loading, otherwise things **will** get unpredictable -Please see [the example]('https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_save_load/basic/src/game/mod.rs#77') for this. +Please see [the example](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_save_load/basic/src/game/mod.rs) for this. ## Additional notes @@ -287,8 +282,8 @@ For convenience ```bevy_gltf_save_load``` provides two **SystemSets** Highly advised to get a better understanding of how things work ! To get started I recomend looking at -- [world setup]('https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_save_load/basic/src/game/in_game.rs#13') -- [various events & co]('https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_save_load/basic/src/game/mod.rs#77') +- [world setup](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_save_load/basic/src/game/in_game.rs) +- [various events & co](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_gltf_save_load/basic/src/game/mod.rs) All examples are here: diff --git a/crates/bevy_registry_export/Cargo.toml b/crates/bevy_registry_export/Cargo.toml index 2471063..30e72cd 100644 --- a/crates/bevy_registry_export/Cargo.toml +++ b/crates/bevy_registry_export/Cargo.toml @@ -1,11 +1,11 @@ [package] name = "bevy_registry_export" -version = "0.3.0" +version = "0.3.1" authors = ["Mark 'kaosat-dev' Moissette", "Pascal 'Killercup' Hertleif"] -description = "Allows you to define [Bevy](https://bevyengine.org/) components direclty inside gltf files and instanciate the components on the Bevy side." +description = "Allows you to create a Json export of all your components/ registered types of your Bevy app/game" homepage = "https://github.com/kaosat-dev/Blender_bevy_components_workflow" repository = "https://github.com/kaosat-dev/Blender_bevy_components_workflow" -keywords = ["gamedev", "bevy", "assets", "gltf", "components"] +keywords = ["gamedev", "bevy", "assets", "registry", "components"] categories = ["game-development"] edition = "2021" license = "MIT OR Apache-2.0" diff --git a/crates/bevy_registry_export/README.md b/crates/bevy_registry_export/README.md index 6fe601b..20a2a6e 100644 --- a/crates/bevy_registry_export/README.md +++ b/crates/bevy_registry_export/README.md @@ -36,7 +36,7 @@ fn main() { ``` -take a look at the [example]('https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_registry_export/basic/src/core/mod.rs) for more clarity +take a look at the [example](https://github.com/kaosat-dev/Blender_bevy_components_workflow/tree/main/examples/bevy_registry_export/basic/src/core/mod.rs) for more clarity ## Installation