bevy_sprite3d

Use 2d sprites in a 3d bevy scene.

This is a pretty common setup in other engines (unity, godot, etc). Useful for:

• 2d games using bevy's lighting (orthographic camera, 3d sprites)
• 2d games with easier parallax and scale (perspective camera, 3d sprites)
• 2d games in a 3d world (perspective camera, both 3d sprites and meshes)
• 3d games with billboard sprites (a la Delver)

Both meshes and materials are internally cached, so this crate can be used for things like tilemaps without issue.

Examples

Example using bevy_sprite3d:

A more complicated scene: examples/dungeon.rs. Try this one with cargo run --example dungeon.

bevy_sprite3d.cutout.shadows.mp4

Some more examples. These don't use bevy, but demonstrate the effect style:

Usage

Check out the examples for details. Tl;dr initialize the plugin with

app.add_plugin(Sprite3dPlugin)

and spawn sprites with

fn setup(
    mut commands: Commands,
    images: Res<ImageAssets>, // this is your custom resource populated with asset handles
) {

    // ----------------------- Single Static Sprite ----------------------------

    commands.spawn((
        Sprite {
            image: images.sprite.clone(),
            ..default()
        },
        Sprite3d {
            pixels_per_metre: 400.,

            partial_alpha: true,

            unlit: true,

            ..default()

            // pivot: Some(Vec2::new(0.5, 0.5)),
            // double_sided: true,
        }
    ));

    // ------------------- Texture Atlas (Sprite Sheet) ------------------------

    let texture_atlas = TextureAtlas {
        layout: images.layout.clone(),
        index: 3,
    };

    commands.spawn((
        Sprite {
            image: images.sprite_sheet.clone(),
            texture_atlas: Some(texture_atlas),
            ..default()
        },
        Sprite3d {
            pixels_per_metre: 32.,
            partial_alpha: true,
            unlit: true,

            ..default()

            // pivot: Some(Vec2::new(0.5, 0.5)),
            // double_sided: true,
        }
    ));
}

Versioning

bevy_sprite3d version	bevy version
10.0 - 10.1	0.20
9.0	0.19
8.0	0.18
7.0	0.17
7.0.0-rc	0.17.0-rc
5.0 - 6.0	0.16
5.0.0-rc	0.16.0-rc
4.0	0.15
3.0	0.14
2.8	0.13
2.7	0.12
2.5 - 2.6	0.11
2.4	0.10
2.1 - 2.3	0.9
1.1 - 2.0	0.8
1.0	0.7