Bevy Tilemap

Chunk based tilemap for Bevy game engine.

Bevy Tilemap allows for Bevy native batch-rendered tiles in maps to be constructed with chunk based loading, efficiently.

Simple yet refined in its implementation, it is meant to attach to other extensible plugins that can enhance its functionality further. Hand-crafted tilemaps with an attentive focus on performance, and low data usage.

WARNING

This project is still experimental and the API will likely break often before the first release. It uses an experimental game engine which too may break the API. Semantic versioning will be followed as much as possible and the contributors will as much as they possibly can try to keep the API stable.

If you have API suggestions, now is the time to do it.

Features

• Perfect for game jams.
• Easy to use and mostly stable API with thorough documentation.
• Endless or constrained dimension tilemaps.
• Batched rendering of many tiles.
• Square and hex tiles.

Build Features

• Serde support
• Extra types

Design

This is not intended to be just another Tilemap. It is meant to be a framework and extensible by design, like Bevy. As well as work done to keep it as close to Bevy API as possible while keeping in mind of Rust API best practices. It is not meant to be complicated and created to be simple to use but give enough functionality to advanced users.

Less time fiddling, more time building

Usage

Add to your Cargo.toml file:

[dependencies]
bevy = "0.5"
bevy_tilemap = "0.4"

Simple tilemap construction

At the most basic implementation, there is not a whole lot that is required to get the tilemap going as shown below.

use bevy_tilemap::prelude::*;
use bevy::asset::HandleId;
use bevy::prelude::*;

// Build a default Tilemap with 32x32 pixel tiles.
let mut tilemap = Tilemap::default();

// We need a Asset<TextureAtlas>. For this example we get a random one as a placeholder.
let texture_atlas_handle = Handle::weak(HandleId::random::<TextureAtlas>());

// Set the texture atlas for the Tilemap
tilemap.set_texture_atlas(texture_atlas_handle);

// Create tile data
let tile = Tile {
    // 2D location x,y (units are in tiles)
    point: (16,16),
    
    // Which tile from the TextureAtlas
    sprite_index: 0,
    
    // Which z-layer in the Tilemap (0-up)
    sprite_order: 0,
    
    // Give the tile an optional green tint
    tint: bevy::render::color::Color::GREEN,
    };

// Insert a single tile
tilemap.insert_tile( tile);

Of course, using the Tilemap::builder() this can be constructed with many more advanced features.

• 3D and 2D tilemaps.
• Texture atlas.
• Dimensions of the tilemap.
• Dimensions of a chunk.
• Dimensions of a tile.
• Adding Z render layers
• Automated chunk creation.
• Auto-spawning of tiles based on view.

With many more features planned for future updates to bring it up to par with other tilemap implementations for other projects.

Future plans

There is still a lot to do but the API is now stable and should be fine for a while now. The next release is focused on added automated methods and system.

• Auto-tile: Picks the right tile based around the neighbours of the tile.
• Tile import: Imports tiles from a file from multiple formats.

Building

bevy_tilemap is only guaranteed to work from stable Rust toolchain and up. This is to be inline with the rest of Bevy engine.

Once you have a development environment, Bevy Tilemap can be fetched using git:

$ git clone --recursive https://github.com/joshuajbouw/bevy_tilemap/

and then built using cargo:

$ cargo build --example random_dungeon

cargo can also be used to run tests:

$ cargo test