chore(main): release 0.11.0 (#332)

Trouv · web-flow · commit b09d10b9ab74 · 2024-12-22T23:24:22.000-07:00
🤖 I have created a release *beep* *boop* --- ## [0.11.0](v0.10.0...v0.11.0) (2024-12-23) ### ⚠ BREAKING CHANGES * upgrade to bevy and bevy_ecs_tilemap 0.15 ([#340](#340)) ### Features * upgrade to bevy and bevy_ecs_tilemap 0.15 ([#340](#340)) ([f44a281](f44a281)) ### Documentation Changes * refactor platformer example by topic ([#329](#329)) ([f59e5e5](f59e5e5)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,21 @@
 # Changelog
 
+## [0.11.0](https://github.com/Trouv/bevy_ecs_ldtk/compare/v0.10.0...v0.11.0) (2024-12-23)
+
+
+### ⚠ BREAKING CHANGES
+
+* upgrade to bevy and bevy_ecs_tilemap 0.15 ([#340](https://github.com/Trouv/bevy_ecs_ldtk/issues/340))
+
+### Features
+
+* upgrade to bevy and bevy_ecs_tilemap 0.15 ([#340](https://github.com/Trouv/bevy_ecs_ldtk/issues/340)) ([f44a281](https://github.com/Trouv/bevy_ecs_ldtk/commit/f44a2814faf3f200232800aeb9e67f7c85f7278e))
+
+
+### Documentation Changes
+
+* refactor platformer example by topic ([#329](https://github.com/Trouv/bevy_ecs_ldtk/issues/329)) ([f59e5e5](https://github.com/Trouv/bevy_ecs_ldtk/commit/f59e5e588026922620c1981108828e1e3ae6153f))
+
 ## [0.10.0](https://github.com/Trouv/bevy_ecs_ldtk/compare/v0.9.0...v0.10.0) (2024-07-20)
 
 
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "bevy_ecs_ldtk"
 description = "An ECS-friendly ldtk plugin for bevy."
-version = "0.10.0"
+version = "0.11.0"
 edition = "2021"
 authors = ["Trevor Lovell <trevorlovelldesign@gmail.com>"]
 repository = "https://github.com/Trouv/bevy_ecs_ldtk"
@@ -14,7 +14,7 @@ exclude = ["assets/*", "repo/*", "scripts/*"]
 members = ["macros"]
 
 [dependencies]
-bevy_ecs_ldtk_macros = { version = "0.10.0", optional = true, path = "macros" }
+bevy_ecs_ldtk_macros = { version = "0.11.0", optional = true, path = "macros" }
 bevy_ecs_tilemap = { version = "0.15.0", default-features = false }
 bevy = { version = "0.15", default-features = false, features = [
     "bevy_sprite",
diff --git a/README.md b/README.md
@@ -30,13 +30,13 @@ For less common use cases, strategies that leverage this plugin's ECS constructs
 
 ## Documentation
 Documentation for this plugin is available in two main places.
-- API reference on [docs.rs](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/) <!-- x-release-please-version -->
-- Tutorials, Explanation, and Guides in the [`bevy_ecs_ldtk` book](https://trouv.github.io/bevy_ecs_ldtk/v0.10.0/index.html) <!-- x-release-please-version -->
+- API reference on [docs.rs](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/) <!-- x-release-please-version -->
+- Tutorials, Explanation, and Guides in the [`bevy_ecs_ldtk` book](https://trouv.github.io/bevy_ecs_ldtk/v0.11.0/index.html) <!-- x-release-please-version -->
 
 In the book, the following chapters are good jumping-off points for beginners:
-- [*Tile-based Game* tutorial](https://trouv.github.io/bevy_ecs_ldtk/v0.10.0/tutorials/tile-based-game/index.html) <!-- x-release-please-version -->
-- [*Level Selection* explanation](https://trouv.github.io/bevy_ecs_ldtk/v0.10.0/explanation/level-selection.html) <!-- x-release-please-version -->
-- [*Game Logic Integration* explanation](https://trouv.github.io/bevy_ecs_ldtk/v0.10.0/explanation/game-logic-integration.html) <!-- x-release-please-version -->
+- [*Tile-based Game* tutorial](https://trouv.github.io/bevy_ecs_ldtk/v0.11.0/tutorials/tile-based-game/index.html) <!-- x-release-please-version -->
+- [*Level Selection* explanation](https://trouv.github.io/bevy_ecs_ldtk/v0.11.0/explanation/level-selection.html) <!-- x-release-please-version -->
+- [*Game Logic Integration* explanation](https://trouv.github.io/bevy_ecs_ldtk/v0.11.0/explanation/game-logic-integration.html) <!-- x-release-please-version -->
 
 Cargo examples are also available in this repository:
 ```sh
diff --git a/book/src/README.md b/book/src/README.md
@@ -32,7 +32,7 @@ Some resources for learning Bevy include those listed on the [Bevy website](http
 LDtk also provides documentation on [its website](https://ldtk.io/docs/).
 
 `bevy_ecs_ldtk`'s [source code](https://github.com/Trouv/bevy_ecs_ldtk) is available on github.
-This repository also contains [cargo examples](https://github.com/Trouv/bevy_ecs_ldtk/tree/v0.10.0/examples), which can be run after cloning the repository using `$ cargo run --example example-name`. <!-- x-release-please-version -->
+This repository also contains [cargo examples](https://github.com/Trouv/bevy_ecs_ldtk/tree/v0.11.0/examples), which can be run after cloning the repository using `$ cargo run --example example-name`. <!-- x-release-please-version -->
 These examples may be difficult to follow on their own, and many of their strategies are described in this book.
 When viewing these examples, be careful to checkout the correct git tag for the version of the plugin you are using.
 Some changes may have been made to the plugin or to the examples on the `main` branch that are not released yet, and trying to apply these to the version of the plugin you are using can lead to errors.
diff --git a/book/src/explanation/anatomy-of-the-world.md b/book/src/explanation/anatomy-of-the-world.md
@@ -1,5 +1,5 @@
 # Anatomy of the World
-Once an [`LdtkWorldBundle`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LdtkWorldBundle.html) is spawned, [levels are selected](level-selection.md), and the associated assets finish loading, the level spawning process begins. <!-- x-release-please-version -->
+Once an [`LdtkWorldBundle`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LdtkWorldBundle.html) is spawned, [levels are selected](level-selection.md), and the associated assets finish loading, the level spawning process begins. <!-- x-release-please-version -->
 The result is a deeply nested hierarchy of entities which can be difficult to navigate, but predictable.
 It can be useful to write code that makes assumptions about the relationships between `bevy_ecs_ldtk` entities.
 To assist with this, this chapter will explain the anatomy of a `bevy_ecs_ldtk` world.
@@ -8,16 +8,16 @@ To assist with this, this chapter will explain the anatomy of a `bevy_ecs_ldtk`
 The basic hierarchy of spawned entities and their identifying components/bundles are as follows.
 This does exclude some special cases which are explained in more detail below.
 Each bullet indent indicates a parent/child relationship.
-- The world entity, with an [`LdtkWorldBundle`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LdtkWorldBundle.html) bundle. <!-- x-release-please-version -->
-  - The level entities, with a [`LevelIid`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LevelIid.html) component. <!-- x-release-please-version -->
-    - For Entity layers - a layer entity with just a [`LayerMetadata`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LayerMetadata.html) component. <!-- x-release-please-version -->
-      - LDtk Entity entities, with an [`EntityInstance`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/ldtk/struct.EntityInstance.html) component, or possibly others if you're using [`LdtkEntity` registration](game-logic-integration.html#ldtkentity-and-ldtkintcell-registration). <!-- x-release-please-version --> 
-    - For Tile/AutoTile/IntGrid layers: `bevy_ecs_tilemap` tilemap entities, with a [`TilemapBundle`](https://docs.rs/bevy_ecs_tilemap/latest/bevy_ecs_tilemap/type.TilemapBundle.html) **and** a [`LayerMetadata`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LayerMetadata.html) component. <!-- x-release-please-version -->
-      - For IntGrid layers - tile entities with an [`IntGridCell`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.IntGridCell.html) component, or possibly others if you're using [`LdtkIntCell` registration](game-logic-integration.html#ldtkentity-and-ldtkintcell-registration). <!-- x-release-please-version -->
+- The world entity, with an [`LdtkWorldBundle`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LdtkWorldBundle.html) bundle. <!-- x-release-please-version -->
+  - The level entities, with a [`LevelIid`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LevelIid.html) component. <!-- x-release-please-version -->
+    - For Entity layers - a layer entity with just a [`LayerMetadata`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LayerMetadata.html) component. <!-- x-release-please-version -->
+      - LDtk Entity entities, with an [`EntityInstance`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/ldtk/struct.EntityInstance.html) component, or possibly others if you're using [`LdtkEntity` registration](game-logic-integration.html#ldtkentity-and-ldtkintcell-registration). <!-- x-release-please-version --> 
+    - For Tile/AutoTile/IntGrid layers: `bevy_ecs_tilemap` tilemap entities, with a [`TilemapBundle`](https://docs.rs/bevy_ecs_tilemap/latest/bevy_ecs_tilemap/type.TilemapBundle.html) **and** a [`LayerMetadata`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LayerMetadata.html) component. <!-- x-release-please-version -->
+      - For IntGrid layers - tile entities with an [`IntGridCell`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.IntGridCell.html) component, or possibly others if you're using [`LdtkIntCell` registration](game-logic-integration.html#ldtkentity-and-ldtkintcell-registration). <!-- x-release-please-version -->
       - For Tile/AutoTile layers (or IntGrid layers with AutoTile functionality) - `bevy_ecs_tilemap` tile entities, with a [`TileBundle`](https://docs.rs/bevy_ecs_tilemap/latest/bevy_ecs_tilemap/tiles/struct.TileBundle.html) bundle.
 
 ## Worldly Entities
-The [`LdtkEntity` derive macro](game-logic-integration.html#ldtkentity-and-ldtkintcell-registration) allows you to define entities as ["worldly"](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/app/trait.LdtkEntity.html#worldly). <!-- x-release-please-version -->
+The [`LdtkEntity` derive macro](game-logic-integration.html#ldtkentity-and-ldtkintcell-registration) allows you to define entities as ["worldly"](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/app/trait.LdtkEntity.html#worldly). <!-- x-release-please-version -->
 The intention of this feature is to support entities that are allowed to persist and traverse between levels, like a player in a GridVania layout.
 
 One consequence of an entity being worldly is a change in its placement in the above hierarchy.
@@ -32,8 +32,8 @@ For example, if the worldly player entity traverses far enough away that their o
 LDtk allows you to associate metadata with particular tiles in a tileset.
 `bevy_ecs_ldtk` responds to this by adding additional components to tiles that have metadata *in addition to* those described in the [hierarchy](#hierarchy):
 
-- [`TileMetadata`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.TileMetadata.html) <!-- x-release-please-version -->
-- [`TileEnumTags`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.TileEnumTags.html) <!-- x-release-please-version -->
+- [`TileMetadata`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.TileMetadata.html) <!-- x-release-please-version -->
+- [`TileEnumTags`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.TileEnumTags.html) <!-- x-release-please-version -->
 
 Naturally, this can only occur in Tile/AutoTile layers (or IntGrid layers with AutoTile functionality), since the metadata is defined on tilesets.
 
@@ -43,7 +43,7 @@ LDtk allows you to supply a background color and a background image for individu
 The background color is spawned as a normal bevy [`Sprite`](https://docs.rs/bevy/latest/bevy/prelude/struct.Sprite.html), as a child of the level entity.
 The background image, if it exists, is also spawned as a `Sprite`.
 
-These background sprites can be disabled (not spawned) using the settings resource [`LdtkSettings`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LdtkSettings.html): <!-- x-release-please-version -->
+These background sprites can be disabled (not spawned) using the settings resource [`LdtkSettings`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LdtkSettings.html): <!-- x-release-please-version -->
 ```rust,no_run
 use bevy::prelude::*;
 use bevy_ecs_ldtk::prelude::*;
@@ -65,7 +65,7 @@ In other words, a single layer can have more than one tile in the same location.
 
 `bevy_ecs_tilemap` tilemaps only allow one tile per position.
 So, `bevy_ecs_ldtk` supports layers with colliding tiles by spawning multiple tilemaps.
-Each of them will have the same [`LayerMetadata`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LayerMetadata.html) component. <!-- x-release-please-version -->
+Each of them will have the same [`LayerMetadata`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LayerMetadata.html) component. <!-- x-release-please-version -->
 This means that users cannot assume that there will be only one `LayerMetadata` entity per layer.
 
 
diff --git a/book/src/explanation/game-logic-integration.md b/book/src/explanation/game-logic-integration.md
@@ -37,8 +37,8 @@ Without any intervention, the bundle's fields are constructed using the bundle's
 However, various attributes are available to override this behavior, like `#[sprite]` in the above example.
 This attribute gives the entity a sprite using the tileset in its LDtk editor visual.
 For documentation about all the available attributes, check out the API reference for these traits:
-- [`LdtkEntity`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/app/trait.LdtkEntity.html) <!-- x-release-please-version -->
-- [`LdtkIntCell`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/app/trait.LdtkIntCell.html) <!-- x-release-please-version -->
+- [`LdtkEntity`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/app/trait.LdtkEntity.html) <!-- x-release-please-version -->
+- [`LdtkIntCell`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/app/trait.LdtkIntCell.html) <!-- x-release-please-version -->
 
 This approach is suitable for many common, simple use cases.
 There's also room for more granular, component-level customization within some of the attributes, like `#[with(...)]` or `#[from_entity_instance]`.
diff --git a/book/src/explanation/level-selection.md b/book/src/explanation/level-selection.md
@@ -1,14 +1,14 @@
 # Level Selection
-Once you have spawned an [`LdtkWorldBundle`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LdtkWorldBundle.html) with a handle pointing to your LDtk project file, the levels you have selected will spawn as children of the world bundle. <!-- x-release-please-version -->
+Once you have spawned an [`LdtkWorldBundle`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LdtkWorldBundle.html) with a handle pointing to your LDtk project file, the levels you have selected will spawn as children of the world bundle. <!-- x-release-please-version -->
 You have a couple options for selecting levels, which will be discussed in this chapter.
 
 ## `LevelSelection` resource
-The highest-level option for selecting a level to spawn is using the [`LevelSelection`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/enum.LevelSelection.html) resource. <!-- x-release-please-version -->
+The highest-level option for selecting a level to spawn is using the [`LevelSelection`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/enum.LevelSelection.html) resource. <!-- x-release-please-version -->
 This resource allows you to specify a particular level either by its indices in the project/world, its identifier, its iid, or its uid.
 Once this resource is added or changed, levels will be spawned/despawned in order to match your selection.
 
 One additional feature worth pointing out is loading level neighbors.
-You can enable this with the settings resource [`LdtkSettings`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LdtkSettings.html): <!-- x-release-please-version -->
+You can enable this with the settings resource [`LdtkSettings`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LdtkSettings.html): <!-- x-release-please-version -->
 
 ```rust,no_run
 use bevy::prelude::*;
@@ -33,7 +33,7 @@ This can be especially useful for GridVania/Free-style worlds where it's importa
 Note: this *only* works if you are using the `LevelSelection` resource.
 
 ## `LevelSet` component
-One component in the `LdtkWorldBundle` is [`LevelSet`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.LevelSet.html). <!-- x-release-please-version -->
+One component in the `LdtkWorldBundle` is [`LevelSet`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.LevelSet.html). <!-- x-release-please-version -->
 This component can be used for lower-level level selection.
 Instead of selecting one level globally with a `LevelSelection` resource, you can select a specific set of levels by their iids.
 From the `level_set` cargo example:
diff --git a/book/src/how-to-guides/respawn-levels-and-worlds.md b/book/src/how-to-guides/respawn-levels-and-worlds.md
@@ -1,5 +1,5 @@
 # Respawn Levels and Worlds
-Internally, `bevy_ecs_ldtk` uses a [`Respawn`](https://docs.rs/bevy_ecs_ldtk/0.10.0/bevy_ecs_ldtk/prelude/struct.Respawn.html) component on worlds and levels to assist in the spawning process. <!-- x-release-please-version -->
+Internally, `bevy_ecs_ldtk` uses a [`Respawn`](https://docs.rs/bevy_ecs_ldtk/0.11.0/bevy_ecs_ldtk/prelude/struct.Respawn.html) component on worlds and levels to assist in the spawning process. <!-- x-release-please-version -->
 This can be leveraged by users to implement a simple level restart feature, or an even more heavy-handed world restart feature.
 
 This code is from the `collectathon` cargo example.
diff --git a/macros/Cargo.toml b/macros/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "bevy_ecs_ldtk_macros"
 description = "Derive macros for bevy_ecs_ldtk."
-version = "0.10.0"
+version = "0.11.0"
 edition = "2021"
 authors = ["Trevor Lovell <trevorlovelldesign@gmail.com>"]
 license = "MIT OR Apache-2.0"
diff --git a/src/app/ldtk_entity.rs b/src/app/ldtk_entity.rs
@@ -139,7 +139,7 @@ use std::{collections::HashMap, marker::PhantomData};
 /// [Worldly] entities don't despawn when their birth level despawns, and they don't respawn when
 /// their birth level respawns.
 /// For a more detailed explanation, please see the
-/// [*Worldly Entities*](https://trouv.github.io/bevy_ecs_ldtk/v0.10.0/explanation/anatomy-of-the-world.html#worldly-entities) <!-- x-release-please-version -->
+/// [*Worldly Entities*](https://trouv.github.io/bevy_ecs_ldtk/v0.11.0/explanation/anatomy-of-the-world.html#worldly-entities) <!-- x-release-please-version -->
 /// section of the `bevy_ecs_ldtk` book.
 /// ```
 /// # use bevy::prelude::*;
diff --git a/src/components/level_set.rs b/src/components/level_set.rs
@@ -6,7 +6,7 @@ use crate::LevelIid;
 /// [`Component`] that determines the desired levels to be spawned in an [`LdtkWorldBundle`].
 ///
 /// For more explanation and comparison of options for selecting levels to spawn, see the
-/// [*Level Selection*](https://trouv.github.io/bevy_ecs_ldtk/v0.10.0/explanation/level-selection.html) <!-- x-release-please-version -->
+/// [*Level Selection*](https://trouv.github.io/bevy_ecs_ldtk/v0.11.0/explanation/level-selection.html) <!-- x-release-please-version -->
 /// chapter of the `bevy_ecs_ldtk` book.
 ///
 /// [`Component`]: https://docs.rs/bevy/latest/bevy/ecs/prelude/trait.Component.html
diff --git a/src/components/mod.rs b/src/components/mod.rs
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/src/resources/level_selection.rs b/src/resources/level_selection.rs
