bevy-atlas-loader

Crates.iobevy-atlas-loader
lib.rsbevy-atlas-loader
version0.1.0
sourcesrc
created_at2022-06-05 13:00:58.461199
updated_at2022-06-05 13:00:58.461199
descriptionBevy plugin for defining and loading 2D TextureAtlas images.
homepage
repositoryhttps://github.com/taurr/bevy-atlas-loader
max_upload_size
id600172
size140,690
Johnny T. Vestergaard (taurr)

documentation

https://docs.rs/bevy-atlas-loader

README

Bevy-atlas-loader

Build Status Latest version Documentation

This crate enables the developer to define a number of TextureAtlas for use as sprites in Bevy.

The atlas definition supports several styles of atlas':

  1. The atlas may be specified as a grid from a texture.
  2. Atlas can use random manually specified positions inside a texture.
  3. An atlas can be made from a folder of textures - note this style is not supported via web.
  4. (TBD) The atlas can be specified from a list of files.

If loading the atlas definition as an asset using e.g. bevy_common_assets, the developer can define atlas' in a file like this:

({
    "Pacman": (
        texture: "Pac-Man.png",
        width: 19,
        height: 19,
        positions: [
            (65, 86),
            (86, 86),
            (107, 86),
        ]
    )
})

And utilizing Bevy's hot-reloading capability we can experiment and adjust without recompiling.

Requirements

In order to use this crate, you need to add a few crates to you Cargo.toml: bevy-atlas-loader and strum.

[dependencies]
bevy-atlas-loader = "<insert version>"
strum = "<insert version>"

Optional

For defining a custom asset loader and thus loading definitions as assets, it's recommended to use e.g. bevy_common_assets:

[dependencies]
bevy_common_assets = "<insert version>"

Usage

Please have a look at the examples, and even the tests.

License

Licensed under either of


This project uses Bevy, and was bootstrapped using bevy-template.rs.

Commit count: 12

cargo fmt