/bevy_ecs_tilemap

A tilemap rendering crate for bevy which is more ECS friendly.

Primary LanguageRustMIT LicenseMIT

bevy_ecs_tilemap

Crates.io docs license Crates.io

A tilemap rendering plugin for bevy. It is more ECS friendly as it makes tiles entities.

Features

  • A tile per entity.
  • Fast rendering using a chunked approach.
  • Layers and sparse tile maps.
  • GPU powered animations.
  • Isometric and Hexagonal tile maps.
  • Initial support for Tiled file exports.

Upcoming Features

  • Support for isometric and hexagon rendering.
  • Built in animation support – see animation example.
  • Texture array support.

Screenshots

iso hex

How Does This Work?

Quite simple there is a tile per entity. Behind the scenes the tiles are split into chunks that each have their own mesh which is sent to the GPU in an optimal way.

Why Use This Instead of X?

Because each tile is an entity of its own editing tiles is super easy and convenient. This allows you to tag entities for updating and makes stuff like animation easier. Want to have a mining simulation where damage is applied to tiles? That’s easy with this plugin:

struct Damage {
    amount: u32,
}

fn update_damage(
    mut query: Query<(&mut Tile, &Damage), Changed<Damage>>,
) {
    for (mut tile, damage) in query.iter_mut() {
        tile.texture_index = TILE_DAMAGE_OFFSET + damage.amount;
    }
}

Examples

  • accessing_tiles – An example showing how one can access tiles from the map object by using tile map coordinates.
  • animation – Basic CPU animation example.
  • basic - The simplest example of how to create a tile map.
  • bench - A stress test of the map rendering system. Takes a while to load.
  • chunking - A simple example showing how to implement an infinite tilemap by spawning multiple chunks.
  • colors - Showcases how each tile can have an individual color.
  • game_of_life - A game of life simulator.
  • hex_column - A map that is meshed using “pointy” hexagons.
  • hex_row - A map that is meshed using flat hexagons.
  • iso_diamond - An isometric meshed map using diamond ordering.
  • iso_staggered - An isometric meshed map using staggered ordering.
  • layers - An example of how you can use multiple map entities/components for “layers”.
  • ldtk - An example of loading and rendering of a LDTK map. Use: cargo run --example ldtk. We recommend checking out: bevy_ecs_ldtk.
  • random_map - A bench of editing all of the tiles every 100 ms.
  • remove_tiles - An example showing how you can remove tiles by using map_query
  • tiled_rotate - An example of loading and rendering of a tiled map editor map with flipping and rotation.requires the tiled_map feature. Use: cargo run --example tiled_rotate
  • tiled - An example of loading and rendering of a tiled map editor map. Use: cargo run --example tiled
  • visibility - An example showcasing visibility of tiles and chunks.

Running Examples

cargo run --release --example basic

Running examples on web!

cargo build --target wasm32-unknown-unknown --example animation --release --features atlas
wasm-server-runner .\target\wasm32-unknown-unknown\release\examples\animation.wasm

Known Issues

  • Tile flipping by x, y and d, should work for all maps, however "d" (anti diagonal) flipping is not implemented for non-square maps.
  • Besides the above no known issues.

Bevy Compatibility

bevy bevy_ecs_tilemap
0.8 0.7
0.7 0.6
0.6 0.5

Asset credits