diff --git a/Cargo.toml b/Cargo.toml index c4d07cc..3ec929d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [workspace] members = [ "crates/*", - "examples/blenvy/*", + "examples/*", "testing/bevy_example/", ] resolver = "2" diff --git a/Migration_guide.md b/Migration_guide.md index d8e5ca1..8adb01f 100644 --- a/Migration_guide.md +++ b/Migration_guide.md @@ -1,12 +1,17 @@ # Blender add-ons -- gltf_auto_export and bevy_components have been replaced with a single Blenvy add-on for simplicity +- gltf_auto_export and bevy_components have been replaced with a single Blenvy add-on for simplicity , I recomend reading the [documentation](./tools/blenvy/README.md) + * settings are **not** transfered from the legacy add-ons ! + * first uninstall the old add-ons + * install Blenvy + * configure Blenvy (for these , see the Blenvy add-on docs) + * [upgrade your components](./tools/blenvy/README-components.md#renamingupgradingfixing-components) + ## Components: - no more need to add your components to an empty called xxx_components, you can now directly add your components to the blueprint's collection itself - you will need to "upgrade" your components from the previous add-on, as they are stored in a completely different way -- bonus: you can also visualize & edit your blueprint's component directly on each instance ## Multiple components with the same short name diff --git a/examples/blenvy/animation/Cargo.toml b/examples/animation/Cargo.toml similarity index 100% rename from examples/blenvy/animation/Cargo.toml rename to examples/animation/Cargo.toml diff --git a/examples/blenvy/animation/README.md b/examples/animation/README.md similarity index 100% rename from examples/blenvy/animation/README.md rename to examples/animation/README.md diff --git a/examples/blenvy/animation/art/animation.blend b/examples/animation/art/animation.blend similarity index 100% rename from examples/blenvy/animation/art/animation.blend rename to examples/animation/art/animation.blend diff --git a/examples/blenvy/animation/assets/blueprints/Fox.glb b/examples/animation/assets/blueprints/Fox.glb similarity index 100% rename from examples/blenvy/animation/assets/blueprints/Fox.glb rename to examples/animation/assets/blueprints/Fox.glb diff --git a/examples/blenvy/animation/assets/blueprints/Player.glb b/examples/animation/assets/blueprints/Player.glb similarity index 100% rename from examples/blenvy/animation/assets/blueprints/Player.glb rename to examples/animation/assets/blueprints/Player.glb diff --git a/examples/blenvy/animation/assets/blueprints/Wheelbot.glb b/examples/animation/assets/blueprints/Wheelbot.glb similarity index 100% rename from examples/blenvy/animation/assets/blueprints/Wheelbot.glb rename to examples/animation/assets/blueprints/Wheelbot.glb diff --git a/examples/blenvy/animation/assets/levels/World.glb b/examples/animation/assets/levels/World.glb similarity index 100% rename from examples/blenvy/animation/assets/levels/World.glb rename to examples/animation/assets/levels/World.glb diff --git a/examples/blenvy/animation/assets/registry.json b/examples/animation/assets/registry.json similarity index 100% rename from examples/blenvy/animation/assets/registry.json rename to examples/animation/assets/registry.json diff --git a/examples/blenvy/animation/src/component_examples.rs b/examples/animation/src/component_examples.rs similarity index 100% rename from examples/blenvy/animation/src/component_examples.rs rename to examples/animation/src/component_examples.rs diff --git a/examples/blenvy/animation/src/main.rs b/examples/animation/src/main.rs similarity index 100% rename from examples/blenvy/animation/src/main.rs rename to examples/animation/src/main.rs diff --git a/examples/blenvy/blueprints/Cargo.toml b/examples/blueprints/Cargo.toml similarity index 100% rename from examples/blenvy/blueprints/Cargo.toml rename to examples/blueprints/Cargo.toml diff --git a/examples/blenvy/blueprints/README.md b/examples/blueprints/README.md similarity index 100% rename from examples/blenvy/blueprints/README.md rename to examples/blueprints/README.md diff --git a/examples/blenvy/blueprints/art/basic.blend b/examples/blueprints/art/basic.blend similarity index 100% rename from examples/blenvy/blueprints/art/basic.blend rename to examples/blueprints/art/basic.blend diff --git a/examples/blenvy/blueprints/art/materials.blend b/examples/blueprints/art/materials.blend similarity index 100% rename from examples/blenvy/blueprints/art/materials.blend rename to examples/blueprints/art/materials.blend diff --git a/examples/blenvy/blueprints/assets/blueprints/Container.glb b/examples/blueprints/assets/blueprints/Container.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/Container.glb rename to examples/blueprints/assets/blueprints/Container.glb diff --git a/examples/blenvy/blueprints/assets/blueprints/Health_Pickup.glb b/examples/blueprints/assets/blueprints/Health_Pickup.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/Health_Pickup.glb rename to examples/blueprints/assets/blueprints/Health_Pickup.glb diff --git a/examples/blenvy/blueprints/assets/blueprints/Magic Sphere.glb b/examples/blueprints/assets/blueprints/Magic Sphere.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/Magic Sphere.glb rename to examples/blueprints/assets/blueprints/Magic Sphere.glb diff --git a/examples/blenvy/blueprints/assets/blueprints/MagicTeapot.glb b/examples/blueprints/assets/blueprints/MagicTeapot.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/MagicTeapot.glb rename to examples/blueprints/assets/blueprints/MagicTeapot.glb diff --git a/examples/blenvy/blueprints/assets/blueprints/Pillar.glb b/examples/blueprints/assets/blueprints/Pillar.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/Pillar.glb rename to examples/blueprints/assets/blueprints/Pillar.glb diff --git a/examples/blenvy/blueprints/assets/blueprints/Pillar2.glb b/examples/blueprints/assets/blueprints/Pillar2.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/Pillar2.glb rename to examples/blueprints/assets/blueprints/Pillar2.glb diff --git a/examples/blenvy/blueprints/assets/blueprints/Player.glb b/examples/blueprints/assets/blueprints/Player.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/Player.glb rename to examples/blueprints/assets/blueprints/Player.glb diff --git a/examples/blenvy/blueprints/assets/blueprints/Watermelon cut.glb b/examples/blueprints/assets/blueprints/Watermelon cut.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/Watermelon cut.glb rename to examples/blueprints/assets/blueprints/Watermelon cut.glb diff --git a/examples/blenvy/blueprints/assets/blueprints/Watermelon.glb b/examples/blueprints/assets/blueprints/Watermelon.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/Watermelon.glb rename to examples/blueprints/assets/blueprints/Watermelon.glb diff --git a/examples/blenvy/blueprints/assets/blueprints/Watermelon2.glb b/examples/blueprints/assets/blueprints/Watermelon2.glb similarity index 100% rename from examples/blenvy/blueprints/assets/blueprints/Watermelon2.glb rename to examples/blueprints/assets/blueprints/Watermelon2.glb diff --git a/examples/blenvy/blueprints/assets/levels/Level1.glb b/examples/blueprints/assets/levels/Level1.glb similarity index 100% rename from examples/blenvy/blueprints/assets/levels/Level1.glb rename to examples/blueprints/assets/levels/Level1.glb diff --git a/examples/blenvy/blueprints/assets/textures/juicy-watermelon-5882.png b/examples/blueprints/assets/textures/juicy-watermelon-5882.png similarity index 100% rename from examples/blenvy/blueprints/assets/textures/juicy-watermelon-5882.png rename to examples/blueprints/assets/textures/juicy-watermelon-5882.png diff --git a/examples/blenvy/blueprints/assets/textures/watermelon-6441.png b/examples/blueprints/assets/textures/watermelon-6441.png similarity index 100% rename from examples/blenvy/blueprints/assets/textures/watermelon-6441.png rename to examples/blueprints/assets/textures/watermelon-6441.png diff --git a/examples/blenvy/blueprints/src/component_examples.rs b/examples/blueprints/src/component_examples.rs similarity index 100% rename from examples/blenvy/blueprints/src/component_examples.rs rename to examples/blueprints/src/component_examples.rs diff --git a/examples/blenvy/blueprints/src/main.rs b/examples/blueprints/src/main.rs similarity index 100% rename from examples/blenvy/blueprints/src/main.rs rename to examples/blueprints/src/main.rs diff --git a/examples/blenvy/components/Cargo.toml b/examples/components/Cargo.toml similarity index 100% rename from examples/blenvy/components/Cargo.toml rename to examples/components/Cargo.toml diff --git a/examples/blenvy/components/README.md b/examples/components/README.md similarity index 100% rename from examples/blenvy/components/README.md rename to examples/components/README.md diff --git a/examples/blenvy/components/art/basic.blend b/examples/components/art/basic.blend similarity index 100% rename from examples/blenvy/components/art/basic.blend rename to examples/components/art/basic.blend diff --git a/examples/blenvy/components/assets/blueprints/Container.glb b/examples/components/assets/blueprints/Container.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/Container.glb rename to examples/components/assets/blueprints/Container.glb diff --git a/examples/blenvy/components/assets/blueprints/Enemy.glb b/examples/components/assets/blueprints/Enemy.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/Enemy.glb rename to examples/components/assets/blueprints/Enemy.glb diff --git a/examples/blenvy/components/assets/blueprints/Finger.glb b/examples/components/assets/blueprints/Finger.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/Finger.glb rename to examples/components/assets/blueprints/Finger.glb diff --git a/examples/blenvy/components/assets/blueprints/Hand.glb b/examples/components/assets/blueprints/Hand.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/Hand.glb rename to examples/components/assets/blueprints/Hand.glb diff --git a/examples/blenvy/components/assets/blueprints/Health_Pickup.glb b/examples/components/assets/blueprints/Health_Pickup.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/Health_Pickup.glb rename to examples/components/assets/blueprints/Health_Pickup.glb diff --git a/examples/blenvy/components/assets/blueprints/Humanoid_cactus.glb b/examples/components/assets/blueprints/Humanoid_cactus.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/Humanoid_cactus.glb rename to examples/components/assets/blueprints/Humanoid_cactus.glb diff --git a/examples/blenvy/components/assets/blueprints/MagicTeapot.glb b/examples/components/assets/blueprints/MagicTeapot.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/MagicTeapot.glb rename to examples/components/assets/blueprints/MagicTeapot.glb diff --git a/examples/blenvy/components/assets/blueprints/Pillar.glb b/examples/components/assets/blueprints/Pillar.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/Pillar.glb rename to examples/components/assets/blueprints/Pillar.glb diff --git a/examples/blenvy/components/assets/blueprints/Player.glb b/examples/components/assets/blueprints/Player.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/Player.glb rename to examples/components/assets/blueprints/Player.glb diff --git a/examples/blenvy/components/assets/blueprints/Unused_in_level_test.glb b/examples/components/assets/blueprints/Unused_in_level_test.glb similarity index 100% rename from examples/blenvy/components/assets/blueprints/Unused_in_level_test.glb rename to examples/components/assets/blueprints/Unused_in_level_test.glb diff --git a/examples/blenvy/components/assets/levels/World.glb b/examples/components/assets/levels/World.glb similarity index 100% rename from examples/blenvy/components/assets/levels/World.glb rename to examples/components/assets/levels/World.glb diff --git a/examples/blenvy/components/assets/registry.json b/examples/components/assets/registry.json similarity index 100% rename from examples/blenvy/components/assets/registry.json rename to examples/components/assets/registry.json diff --git a/examples/blenvy/components/index.html b/examples/components/index.html similarity index 100% rename from examples/blenvy/components/index.html rename to examples/components/index.html diff --git a/examples/blenvy/components/src/component_examples.rs b/examples/components/src/component_examples.rs similarity index 100% rename from examples/blenvy/components/src/component_examples.rs rename to examples/components/src/component_examples.rs diff --git a/examples/blenvy/components/src/main.rs b/examples/components/src/main.rs similarity index 100% rename from examples/blenvy/components/src/main.rs rename to examples/components/src/main.rs diff --git a/examples/blenvy/demo/Cargo.toml b/examples/demo/Cargo.toml similarity index 100% rename from examples/blenvy/demo/Cargo.toml rename to examples/demo/Cargo.toml diff --git a/examples/blenvy/demo/README.md b/examples/demo/README.md similarity index 100% rename from examples/blenvy/demo/README.md rename to examples/demo/README.md diff --git a/examples/blenvy/demo/art/common.blend b/examples/demo/art/common.blend similarity index 100% rename from examples/blenvy/demo/art/common.blend rename to examples/demo/art/common.blend diff --git a/examples/blenvy/demo/art/level1.blend b/examples/demo/art/level1.blend similarity index 100% rename from examples/blenvy/demo/art/level1.blend rename to examples/demo/art/level1.blend diff --git a/examples/blenvy/demo/art/level2.blend b/examples/demo/art/level2.blend similarity index 100% rename from examples/blenvy/demo/art/level2.blend rename to examples/demo/art/level2.blend diff --git a/examples/blenvy/demo/art/start_level.blend b/examples/demo/art/start_level.blend similarity index 100% rename from examples/blenvy/demo/art/start_level.blend rename to examples/demo/art/start_level.blend diff --git a/examples/blenvy/demo/assets/materials/common_materials_library.glb b/examples/demo/assets/materials/common_materials_library.glb similarity index 100% rename from examples/blenvy/demo/assets/materials/common_materials_library.glb rename to examples/demo/assets/materials/common_materials_library.glb diff --git a/examples/blenvy/demo/assets/models/Level1.glb b/examples/demo/assets/models/Level1.glb similarity index 100% rename from examples/blenvy/demo/assets/models/Level1.glb rename to examples/demo/assets/models/Level1.glb diff --git a/examples/blenvy/demo/assets/models/Level2.glb b/examples/demo/assets/models/Level2.glb similarity index 100% rename from examples/blenvy/demo/assets/models/Level2.glb rename to examples/demo/assets/models/Level2.glb diff --git a/examples/blenvy/demo/assets/models/StartLevel.glb b/examples/demo/assets/models/StartLevel.glb similarity index 100% rename from examples/blenvy/demo/assets/models/StartLevel.glb rename to examples/demo/assets/models/StartLevel.glb diff --git a/examples/blenvy/demo/assets/models/library/Container.glb b/examples/demo/assets/models/library/Container.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Container.glb rename to examples/demo/assets/models/library/Container.glb diff --git a/examples/blenvy/demo/assets/models/library/Crystal.glb b/examples/demo/assets/models/library/Crystal.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Crystal.glb rename to examples/demo/assets/models/library/Crystal.glb diff --git a/examples/blenvy/demo/assets/models/library/Health_Pickup.glb b/examples/demo/assets/models/library/Health_Pickup.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Health_Pickup.glb rename to examples/demo/assets/models/library/Health_Pickup.glb diff --git a/examples/blenvy/demo/assets/models/library/Interactible.glb b/examples/demo/assets/models/library/Interactible.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Interactible.glb rename to examples/demo/assets/models/library/Interactible.glb diff --git a/examples/blenvy/demo/assets/models/library/LevelTransition.glb b/examples/demo/assets/models/library/LevelTransition.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/LevelTransition.glb rename to examples/demo/assets/models/library/LevelTransition.glb diff --git a/examples/blenvy/demo/assets/models/library/MagicTeapot.glb b/examples/demo/assets/models/library/MagicTeapot.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/MagicTeapot.glb rename to examples/demo/assets/models/library/MagicTeapot.glb diff --git a/examples/blenvy/demo/assets/models/library/Nest_test.glb b/examples/demo/assets/models/library/Nest_test.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Nest_test.glb rename to examples/demo/assets/models/library/Nest_test.glb diff --git a/examples/blenvy/demo/assets/models/library/Pillar.glb b/examples/demo/assets/models/library/Pillar.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Pillar.glb rename to examples/demo/assets/models/library/Pillar.glb diff --git a/examples/blenvy/demo/assets/models/library/Player.glb b/examples/demo/assets/models/library/Player.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Player.glb rename to examples/demo/assets/models/library/Player.glb diff --git a/examples/blenvy/demo/assets/models/library/Portal.glb b/examples/demo/assets/models/library/Portal.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Portal.glb rename to examples/demo/assets/models/library/Portal.glb diff --git a/examples/blenvy/demo/assets/models/library/Rock Pile.glb b/examples/demo/assets/models/library/Rock Pile.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Rock Pile.glb rename to examples/demo/assets/models/library/Rock Pile.glb diff --git a/examples/blenvy/demo/assets/models/library/Rock.glb b/examples/demo/assets/models/library/Rock.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Rock.glb rename to examples/demo/assets/models/library/Rock.glb diff --git a/examples/blenvy/demo/assets/models/library/Sub_blueprint.glb b/examples/demo/assets/models/library/Sub_blueprint.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Sub_blueprint.glb rename to examples/demo/assets/models/library/Sub_blueprint.glb diff --git a/examples/blenvy/demo/assets/models/library/Template_Demo.glb b/examples/demo/assets/models/library/Template_Demo.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Template_Demo.glb rename to examples/demo/assets/models/library/Template_Demo.glb diff --git a/examples/blenvy/demo/assets/models/library/Unused_in_level_test.glb b/examples/demo/assets/models/library/Unused_in_level_test.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Unused_in_level_test.glb rename to examples/demo/assets/models/library/Unused_in_level_test.glb diff --git a/examples/blenvy/demo/assets/models/library/Wall.glb b/examples/demo/assets/models/library/Wall.glb similarity index 100% rename from examples/blenvy/demo/assets/models/library/Wall.glb rename to examples/demo/assets/models/library/Wall.glb diff --git a/examples/blenvy/demo/src/core/audio/mod.rs b/examples/demo/src/core/audio/mod.rs similarity index 100% rename from examples/blenvy/demo/src/core/audio/mod.rs rename to examples/demo/src/core/audio/mod.rs diff --git a/examples/blenvy/demo/src/core/camera/camera_replace_proxies.rs b/examples/demo/src/core/camera/camera_replace_proxies.rs similarity index 100% rename from examples/blenvy/demo/src/core/camera/camera_replace_proxies.rs rename to examples/demo/src/core/camera/camera_replace_proxies.rs diff --git a/examples/blenvy/demo/src/core/camera/camera_tracking.rs b/examples/demo/src/core/camera/camera_tracking.rs similarity index 100% rename from examples/blenvy/demo/src/core/camera/camera_tracking.rs rename to examples/demo/src/core/camera/camera_tracking.rs diff --git a/examples/blenvy/demo/src/core/camera/mod.rs b/examples/demo/src/core/camera/mod.rs similarity index 100% rename from examples/blenvy/demo/src/core/camera/mod.rs rename to examples/demo/src/core/camera/mod.rs diff --git a/examples/blenvy/demo/src/core/mod.rs b/examples/demo/src/core/mod.rs similarity index 100% rename from examples/blenvy/demo/src/core/mod.rs rename to examples/demo/src/core/mod.rs diff --git a/examples/blenvy/demo/src/core/physics_rapier/controls.rs b/examples/demo/src/core/physics_rapier/controls.rs similarity index 100% rename from examples/blenvy/demo/src/core/physics_rapier/controls.rs rename to examples/demo/src/core/physics_rapier/controls.rs diff --git a/examples/blenvy/demo/src/core/physics_rapier/mod.rs b/examples/demo/src/core/physics_rapier/mod.rs similarity index 100% rename from examples/blenvy/demo/src/core/physics_rapier/mod.rs rename to examples/demo/src/core/physics_rapier/mod.rs diff --git a/examples/blenvy/demo/src/core/physics_rapier/physics_replace_proxies.rs b/examples/demo/src/core/physics_rapier/physics_replace_proxies.rs similarity index 100% rename from examples/blenvy/demo/src/core/physics_rapier/physics_replace_proxies.rs rename to examples/demo/src/core/physics_rapier/physics_replace_proxies.rs diff --git a/examples/blenvy/demo/src/core/physics_rapier/utils.rs b/examples/demo/src/core/physics_rapier/utils.rs similarity index 100% rename from examples/blenvy/demo/src/core/physics_rapier/utils.rs rename to examples/demo/src/core/physics_rapier/utils.rs diff --git a/examples/blenvy/demo/src/core/physics_xpbd/controls.rs b/examples/demo/src/core/physics_xpbd/controls.rs similarity index 100% rename from examples/blenvy/demo/src/core/physics_xpbd/controls.rs rename to examples/demo/src/core/physics_xpbd/controls.rs diff --git a/examples/blenvy/demo/src/core/physics_xpbd/mod.rs b/examples/demo/src/core/physics_xpbd/mod.rs similarity index 100% rename from examples/blenvy/demo/src/core/physics_xpbd/mod.rs rename to examples/demo/src/core/physics_xpbd/mod.rs diff --git a/examples/blenvy/demo/src/core/physics_xpbd/physics_replace_proxies.rs b/examples/demo/src/core/physics_xpbd/physics_replace_proxies.rs similarity index 100% rename from examples/blenvy/demo/src/core/physics_xpbd/physics_replace_proxies.rs rename to examples/demo/src/core/physics_xpbd/physics_replace_proxies.rs diff --git a/examples/blenvy/demo/src/core/physics_xpbd/utils.rs b/examples/demo/src/core/physics_xpbd/utils.rs similarity index 100% rename from examples/blenvy/demo/src/core/physics_xpbd/utils.rs rename to examples/demo/src/core/physics_xpbd/utils.rs diff --git a/examples/blenvy/demo/src/core/relationships/mod.rs b/examples/demo/src/core/relationships/mod.rs similarity index 100% rename from examples/blenvy/demo/src/core/relationships/mod.rs rename to examples/demo/src/core/relationships/mod.rs diff --git a/examples/blenvy/demo/src/core/relationships/relationships_insert_dependant_components.rs b/examples/demo/src/core/relationships/relationships_insert_dependant_components.rs similarity index 100% rename from examples/blenvy/demo/src/core/relationships/relationships_insert_dependant_components.rs rename to examples/demo/src/core/relationships/relationships_insert_dependant_components.rs diff --git a/examples/blenvy/demo/src/game/in_game.rs b/examples/demo/src/game/in_game.rs similarity index 100% rename from examples/blenvy/demo/src/game/in_game.rs rename to examples/demo/src/game/in_game.rs diff --git a/examples/blenvy/demo/src/game/in_main_menu.rs b/examples/demo/src/game/in_main_menu.rs similarity index 100% rename from examples/blenvy/demo/src/game/in_main_menu.rs rename to examples/demo/src/game/in_main_menu.rs diff --git a/examples/blenvy/demo/src/game/interactions/mod.rs b/examples/demo/src/game/interactions/mod.rs similarity index 100% rename from examples/blenvy/demo/src/game/interactions/mod.rs rename to examples/demo/src/game/interactions/mod.rs diff --git a/examples/blenvy/demo/src/game/level_transitions.rs b/examples/demo/src/game/level_transitions.rs similarity index 100% rename from examples/blenvy/demo/src/game/level_transitions.rs rename to examples/demo/src/game/level_transitions.rs diff --git a/examples/blenvy/demo/src/game/mod.rs b/examples/demo/src/game/mod.rs similarity index 100% rename from examples/blenvy/demo/src/game/mod.rs rename to examples/demo/src/game/mod.rs diff --git a/examples/blenvy/demo/src/game/picking/mod.rs b/examples/demo/src/game/picking/mod.rs similarity index 100% rename from examples/blenvy/demo/src/game/picking/mod.rs rename to examples/demo/src/game/picking/mod.rs diff --git a/examples/blenvy/demo/src/game/player/mod.rs b/examples/demo/src/game/player/mod.rs similarity index 100% rename from examples/blenvy/demo/src/game/player/mod.rs rename to examples/demo/src/game/player/mod.rs diff --git a/examples/blenvy/demo/src/main.rs b/examples/demo/src/main.rs similarity index 100% rename from examples/blenvy/demo/src/main.rs rename to examples/demo/src/main.rs diff --git a/examples/blenvy/demo/src/state.rs b/examples/demo/src/state.rs similarity index 100% rename from examples/blenvy/demo/src/state.rs rename to examples/demo/src/state.rs diff --git a/examples/blenvy/demo/src/test_components.rs b/examples/demo/src/test_components.rs similarity index 100% rename from examples/blenvy/demo/src/test_components.rs rename to examples/demo/src/test_components.rs diff --git a/examples/blenvy/save_load/Cargo.toml b/examples/save_load/Cargo.toml similarity index 100% rename from examples/blenvy/save_load/Cargo.toml rename to examples/save_load/Cargo.toml diff --git a/examples/blenvy/save_load/README.md b/examples/save_load/README.md similarity index 100% rename from examples/blenvy/save_load/README.md rename to examples/save_load/README.md diff --git a/examples/blenvy/save_load/assets/assets_core.assets.ron b/examples/save_load/assets/assets_core.assets.ron similarity index 100% rename from examples/blenvy/save_load/assets/assets_core.assets.ron rename to examples/save_load/assets/assets_core.assets.ron diff --git a/examples/blenvy/save_load/assets/assets_game.assets.ron b/examples/save_load/assets/assets_game.assets.ron similarity index 100% rename from examples/blenvy/save_load/assets/assets_game.assets.ron rename to examples/save_load/assets/assets_game.assets.ron diff --git a/examples/blenvy/save_load/assets/basic.blend b/examples/save_load/assets/basic.blend similarity index 100% rename from examples/blenvy/save_load/assets/basic.blend rename to examples/save_load/assets/basic.blend diff --git a/examples/blenvy/save_load/assets/models/World.glb b/examples/save_load/assets/models/World.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/World.glb rename to examples/save_load/assets/models/World.glb diff --git a/examples/blenvy/save_load/assets/models/World_dynamic.glb b/examples/save_load/assets/models/World_dynamic.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/World_dynamic.glb rename to examples/save_load/assets/models/World_dynamic.glb diff --git a/examples/blenvy/save_load/assets/models/library/Container.glb b/examples/save_load/assets/models/library/Container.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/library/Container.glb rename to examples/save_load/assets/models/library/Container.glb diff --git a/examples/blenvy/save_load/assets/models/library/Ground.glb b/examples/save_load/assets/models/library/Ground.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/library/Ground.glb rename to examples/save_load/assets/models/library/Ground.glb diff --git a/examples/blenvy/save_load/assets/models/library/Health_Pickup.glb b/examples/save_load/assets/models/library/Health_Pickup.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/library/Health_Pickup.glb rename to examples/save_load/assets/models/library/Health_Pickup.glb diff --git a/examples/blenvy/save_load/assets/models/library/MagicTeapot.glb b/examples/save_load/assets/models/library/MagicTeapot.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/library/MagicTeapot.glb rename to examples/save_load/assets/models/library/MagicTeapot.glb diff --git a/examples/blenvy/save_load/assets/models/library/Pillar.glb b/examples/save_load/assets/models/library/Pillar.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/library/Pillar.glb rename to examples/save_load/assets/models/library/Pillar.glb diff --git a/examples/blenvy/save_load/assets/models/library/Player.glb b/examples/save_load/assets/models/library/Player.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/library/Player.glb rename to examples/save_load/assets/models/library/Player.glb diff --git a/examples/blenvy/save_load/assets/models/library/Sphero.glb b/examples/save_load/assets/models/library/Sphero.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/library/Sphero.glb rename to examples/save_load/assets/models/library/Sphero.glb diff --git a/examples/blenvy/save_load/assets/models/library/Unused_in_level_test.glb b/examples/save_load/assets/models/library/Unused_in_level_test.glb similarity index 100% rename from examples/blenvy/save_load/assets/models/library/Unused_in_level_test.glb rename to examples/save_load/assets/models/library/Unused_in_level_test.glb diff --git a/examples/blenvy/save_load/assets/scenes/save.scn.ron b/examples/save_load/assets/scenes/save.scn.ron similarity index 100% rename from examples/blenvy/save_load/assets/scenes/save.scn.ron rename to examples/save_load/assets/scenes/save.scn.ron diff --git a/examples/blenvy/save_load/src/component_examples.rs b/examples/save_load/src/component_examples.rs similarity index 100% rename from examples/blenvy/save_load/src/component_examples.rs rename to examples/save_load/src/component_examples.rs diff --git a/examples/blenvy/save_load/src/game/in_game.rs b/examples/save_load/src/game/in_game.rs similarity index 100% rename from examples/blenvy/save_load/src/game/in_game.rs rename to examples/save_load/src/game/in_game.rs diff --git a/examples/blenvy/save_load/src/game/in_game_loading.rs b/examples/save_load/src/game/in_game_loading.rs similarity index 100% rename from examples/blenvy/save_load/src/game/in_game_loading.rs rename to examples/save_load/src/game/in_game_loading.rs diff --git a/examples/blenvy/save_load/src/game/in_game_saving.rs b/examples/save_load/src/game/in_game_saving.rs similarity index 100% rename from examples/blenvy/save_load/src/game/in_game_saving.rs rename to examples/save_load/src/game/in_game_saving.rs diff --git a/examples/blenvy/save_load/src/game/in_main_menu.rs b/examples/save_load/src/game/in_main_menu.rs similarity index 100% rename from examples/blenvy/save_load/src/game/in_main_menu.rs rename to examples/save_load/src/game/in_main_menu.rs diff --git a/examples/blenvy/save_load/src/game/mod.rs b/examples/save_load/src/game/mod.rs similarity index 100% rename from examples/blenvy/save_load/src/game/mod.rs rename to examples/save_load/src/game/mod.rs diff --git a/examples/blenvy/save_load/src/main.rs b/examples/save_load/src/main.rs similarity index 100% rename from examples/blenvy/save_load/src/main.rs rename to examples/save_load/src/main.rs diff --git a/tools/blenvy/README-blueprints.md b/tools/blenvy/README-blueprints.md index e4df25c..915d503 100644 --- a/tools/blenvy/README-blueprints.md +++ b/tools/blenvy/README-blueprints.md @@ -57,3 +57,9 @@ If you want to view all of your blueprints, navigate to the Blueprints tab * those blueprints will be exported on every save * this option is disabled for external blueprints + +## Adding assets to blueprints + +- you can add references to any external file to be used as assets +- the paths to these assets will be passed on to the Bevy side +- the Blenvy crate will load the assets and they will be available at the same time as your blueprint instance is ready diff --git a/tools/blenvy/README-components.md b/tools/blenvy/README-components.md index 26b0a9f..dbe2f6f 100644 --- a/tools/blenvy/README-components.md +++ b/tools/blenvy/README-components.md @@ -1,5 +1,29 @@ # Components +## Configuration + +The second tab in the settings contains the component settings: + +![blenvy component settings](./docs/blenvy_configuration_components.png) + + +> you normally do not need to do anything, as the defaults are already pre-set to match those on the Bevy side for the location of the ```registry.json``` file, unless you want to store it somewhere other than ```assets/registry.json``` + +###### registry file (default: assets/registry.json) + +- click on the button to select your registry.json file (in the "configuration" panel) + +###### reload registry + +- click on the button to force refresh the list of components from the registry.json file + + +##### registry file polling + +* by default, the add-on will check for changes in your registry file every second, and refresh the UI accordingly +* you can set the polling frequency or turn it off if you do not want auto-refresh + + ## Supported components - normally (minus any bugs, please report those!) all components using **registered** types should be useable and editable diff --git a/tools/blenvy/README-export.md b/tools/blenvy/README-export.md index 977545b..2728307 100644 --- a/tools/blenvy/README-export.md +++ b/tools/blenvy/README-export.md @@ -1,5 +1,87 @@ # Export +## Configuration + +Settings are available in the export/ auto-export settings tab + +![blenvy export settings](./docs/blenvy_configuration_export.png) + + +### Auto export (default: True) + +- toggle this to turn the whole auto-export system on or off : + when enabled, **every time you save your blend file** Blenvy will automatically export a set of gltf files , for levels, blueprints, materials etc depending on your settings, see below. + +### Gltf settings + +- click on this button to open Blender's standard gltf exporter settings **specific to Blenvy** : ie you have access to all of the normal gltf settings, but there is additional boilerplate +to gather these settings for Blenvy only, so it does not impact your normal export settings +- you *must* keep the "remember export settings" checkbox checked in order for the settings to be useable by Blenvy + +> Important ! Do not use Blender's default gltf exporter (under file => export => gltf), as it does not impact Blenvy's settings + +### Export scene settings (default: True) + +- toggle this to export additional settings like ambient color, bloom, ao, etc from Blender to Bevy: this automatically generates additional components at the scene level that get processed by the Blenvy crate + +### Use change detection (default: True) + +- toggle this to enable change detection: ie, to make sure that only the blueprints , levels or materials that have actually **changed since your last save** get exported to gltf files, a sort of "incremental export". + +> Under the hood, Blenvy serializes your whole Blender project to a simplified representation, to be able to tell the differents between successive changes + +### Detailed materials scan (default: True) + +- this options enables more detailed materials scanning & thus detecting smaller changes, even **changes in material nodes** . This comes at a potential additional processing cost, so if you notice performance issues in projects with complex materials +you can turn this off + +### Detailed modifiers scan (default: True) + +- similar to the one above but for modifiers, this options enables more finer grained change detection in modifiers, even **changes in geometry nodes** . This comes at a potential additional processing cost, so if you notice performance issues in projects with complex modifiers +you can turn this off + +### Export blueprints (default: True) + +- check this if you want to automatically export blueprints + +### Collection instances (default: split) + +select which option you want to use to deal with collection instances (aka combine mode) (both inside blueprint collections & main collections) + + * split (default, highly recomended) : the addon will 'split out' any nested collections/ blueprints & export them + * embed: choose this option if you want to keep everything inside a gltf file (less efficient, not recomended) + * embedExternal: this will embed ONLY collection instances whose collections have not been found inside the current blend file + + These options can also be **overridden** on a per collection instance basis: (if you want to split out most collection instances, but keep a few specific ones embeded + inside your gltf file) + + ![combine override](./docs/combine_override.png) + + - simply add a custom property called **_combine** to the collection instance, and set it to one of the options above + +### Export dynamic and static objects seperatly (default: False) + + +For levels scenes only, toggle this to generate 2 files per level: + + - one with all dynamic data: collections or instances marked as dynamic (aka saveable) + - one with all static data: anything else that is NOT marked as dynamic, the file name will have the suffix **_dynamic** + + Ie if you add a **Dynamic** custom/ component to either your collection instances or your blueprint, you get a clean seperation between + + - your static level data (anything that will never change during the lifetime of your Bevy app) + - your dynamic objects (anything that will change during the lifetime of your Bevy app, that can be saved & reloaded in save files for example) + +### export materials library (default: True) + +check this if you want to automatically export material libraries +please read the dedicated [section](./README-export.md#materials) below for more information + +### Additional export settings + +- you can also force per level or per blueprint systematic export (regardless of change detection), see the relevant sections in the levels & blueprint documentation + + ## Materials You can enable this option to automatically generate a **material library** files that combines all the materials in use in your blueprints. diff --git a/tools/blenvy/README.md b/tools/blenvy/README.md index ba49da8..e603ee9 100644 --- a/tools/blenvy/README.md +++ b/tools/blenvy/README.md @@ -13,9 +13,6 @@ by the registry export part of the [Blenvy](https://crates.io/crates/blenvy) cra - change detection, so that only the levels & blueprints you have changed get exported when you save your blend file - export of material librairies - -If you want to know more about the technical details , see [here]() - > IMPORTANT !! if you have previously used the "old" add-ons (*gltf_auto_export* & *bevy_components*), please see the [migration guide](../../Migration_guide.md) If you can I would generally recommend starting fresh, but a lot of effort has been put to make transitioning easier @@ -27,22 +24,19 @@ If you can I would generally recommend starting fresh, but a lot of effort has b ![blender addon install](./docs/blender_addon_install_zip.png) +* up to Blender 4.1 go to edit => preferences => add-ons, click on install and choose the path where ```blenvy.zip``` is stored -* in Blender go to edit => preferences => install + ![blender addon install](./docs/blender_addon_install.png) -![blender addon install](./docs/blender_addon_install.png) - -* choose the path where ```blenvy.zip``` is stored - -![blender addon install](./docs/blender_addon_install2.png) - - * up to Blender 4.1 - * for Blender 4.2 , just drag & drop the zip file onto Blender to start the installation process +* for Blender 4.2 , just drag & drop the zip file onto Blender to start the installation process ## Quickstart -* set your level & library scenes (the only things that are not pre-configured) +* create your Bevy project +* setup the Blenvy crate +* create a Blender project +* set your level & library scenes (the **only** things that are not pre-configured) ![blenvy common settings](./docs/blenvy_configuration_common.png) @@ -116,108 +110,11 @@ Blenvy is opinionated ! ![recomended folder structure assets](./docs/blenvy_recommended_folder_structure_assets.png) -#### Components +##### Components & export settings: -The second tab contains the component settings: +- for components please see [here](./README-components.md#configuration) +- for export please see [here](./README-export.md#configuration) -![blenvy component settings](./docs/blenvy_configuration_components.png) - - -> you normally do not need to do anything, as the defaults are already pre-set to match those on the Bevy side for the location of the ```registry.json``` file, unless you want to store it somewhere other than ```assets/registry.json``` - -###### registry file (default: assets/registry.json) - -- click on the button to select your registry.json file (in the "configuration" panel) - -###### reload registry - -- click on the button to force refresh the list of components from the registry.json file - - -##### registry file polling - -* by default, the add-on will check for changes in your registry file every second, and refresh the UI accordingly -* you can set the polling frequency or turn it off if you do not want auto-refresh - -#### Export - -Last but not least, the export/ auto-export settings tab - -![blenvy export settings](./docs/blenvy_configuration_export.png) - -##### Auto export (default: True) - -- toggle this to turn the whole auto-export system on or off : - when enabled, **every time you save your blend file** Blenvy will automatically export a set of gltf files , for levels, blueprints, materials etc depending on your settings, see below. - -##### Gltf settings - -- click on this button to open Blender's standard gltf exporter settings **specific to Blenvy** : ie you have access to all of the normal gltf settings, but there is additional boilerplate -to gather these settings for Blenvy only, so it does not impact your normal export settings -- you *must* keep the "remember export settings" checkbox checked in order for the settings to be useable by Blenvy - -> Important ! Do not use Blender's default gltf exporter (under file => export => gltf), as it does not impact Blenvy's settings - -##### Export scene settings (default: True) - -- toggle this to export additional settings like ambient color, bloom, ao, etc from Blender to Bevy: this automatically generates additional components at the scene level that get processed by the Blenvy crate - -##### Use change detection (default: True) - -- toggle this to enable change detection: ie, to make sure that only the blueprints , levels or materials that have actually **changed since your last save** get exported to gltf files, a sort of "incremental export". - -> Under the hood, Blenvy serializes your whole Blender project to a simplified representation, to be able to tell the differents between successive changes - -##### Detailed materials scan (default: True) - -- this options enables more detailed materials scanning & thus detecting smaller changes, even **changes in material nodes** . This comes at a potential additional processing cost, so if you notice performance issues in projects with complex materials -you can turn this off - -##### Detailed modifiers scan (default: True) - -- similar to the one above but for modifiers, this options enables more finer grained change detection in modifiers, even **changes in geometry nodes** . This comes at a potential additional processing cost, so if you notice performance issues in projects with complex modifiers -you can turn this off - -##### Export blueprints (default: True) - -- check this if you want to automatically export blueprints - -##### Collection instances (default: split) - -select which option you want to use to deal with collection instances (aka combine mode) (both inside blueprint collections & main collections) - - * split (default, highly recomended) : the addon will 'split out' any nested collections/ blueprints & export them - * embed: choose this option if you want to keep everything inside a gltf file (less efficient, not recomended) - * embedExternal: this will embed ONLY collection instances whose collections have not been found inside the current blend file - - These options can also be **overridden** on a per collection instance basis: (if you want to split out most collection instances, but keep a few specific ones embeded - inside your gltf file) - - ![combine override](./docs/combine_override.png) - - - simply add a custom property called **_combine** to the collection instance, and set it to one of the options above - -##### Export dynamic and static objects seperatly (default: False) - - -For levels scenes only, toggle this to generate 2 files per level: - - - one with all dynamic data: collections or instances marked as dynamic (aka saveable) - - one with all static data: anything else that is NOT marked as dynamic, the file name will have the suffix **_dynamic** - - Ie if you add a **Dynamic** custom/ component to either your collection instances or your blueprint, you get a clean seperation between - - - your static level data (anything that will never change during the lifetime of your Bevy app) - - your dynamic objects (anything that will change during the lifetime of your Bevy app, that can be saved & reloaded in save files for example) - -##### export materials library (default: True) - -check this if you want to automatically export material libraries -please read the dedicated [section](./README-export.md#materials) below for more information - -#### Additional export settings - -- you can also force per level or per blueprint systematic export (regardless of change detection), see the relevant sections in the levels & blueprint documentation ### Multiple blend file workflow @@ -257,7 +154,6 @@ Take a look at the [relevant](../../examples/demo/) example for more [details](. - for a detailed overview of blueprints please see [here](./README-levels.md) - ### Blueprints - for a detailed overview of blueprints please see [here](./README-blueprints.md) diff --git a/tools/blenvy/docs/auto_export/blender_addon_materials.png b/tools/blenvy/docs/blender_addon_materials.png similarity index 100% rename from tools/blenvy/docs/auto_export/blender_addon_materials.png rename to tools/blenvy/docs/blender_addon_materials.png diff --git a/tools/blenvy/docs/auto_export/blender_addon_materials2.png b/tools/blenvy/docs/blender_addon_materials2.png similarity index 100% rename from tools/blenvy/docs/auto_export/blender_addon_materials2.png rename to tools/blenvy/docs/blender_addon_materials2.png diff --git a/tools/blenvy/docs/auto_export/combine_override.png b/tools/blenvy/docs/combine_override.png similarity index 100% rename from tools/blenvy/docs/auto_export/combine_override.png rename to tools/blenvy/docs/combine_override.png diff --git a/tools/blenvy/docs/auto_export/process.svg b/tools/blenvy/docs/process.svg similarity index 100% rename from tools/blenvy/docs/auto_export/process.svg rename to tools/blenvy/docs/process.svg