#3d #bevy #2d-3d #sprite #gamedev #bevy-plugin #game-engine

bevy_sprite3d

Bevy Plugin to allow using 2d sprites in a 3d scene

12 stable releases

2.8.0 Feb 26, 2024
2.7.0 Nov 5, 2023
2.6.0 Sep 18, 2023
2.5.0 Jul 10, 2023
0.1.0 Jul 29, 2022

#102 in Game dev

Download history 16/week @ 2024-01-01 2/week @ 2024-01-08 8/week @ 2024-01-15 25/week @ 2024-01-22 6/week @ 2024-01-29 15/week @ 2024-02-05 29/week @ 2024-02-12 81/week @ 2024-02-19 252/week @ 2024-02-26 60/week @ 2024-03-04 65/week @ 2024-03-11 16/week @ 2024-03-18 14/week @ 2024-03-25 104/week @ 2024-04-01 22/week @ 2024-04-08 40/week @ 2024-04-15

182 downloads per month
Used in 3 crates

MIT license

2.5MB
317 lines

bevy_sprite3d

Crates.io MIT

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:

chaos

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

https://github.com/FraserLee/bevy_sprite3d/assets/30442265/1821b13c-9770-4f4e-a889-f67e06a3cda6

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

the last night

the last night

hollow knight

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>,
    mut sprite_params: Sprite3dParams
) {

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

    commands.spawn_bundle(Sprite3d {
            image: images.sprite.clone(),

            pixels_per_metre: 400.,

            partial_alpha: true,

            unlit: true,

            ..default()

            // transform: Transform::from_xyz(0., 0., 0.),
            // pivot: Some(Vec2::new(0.5, 0.5)),
            // double_sided: true,

    }.bundle(&mut sprite_params));

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

    commands.spawn_bundle(AtlasSprite3d {
            atlas: images.sprite_sheet.clone(),

            pixels_per_metre: 32.,
            partial_alpha: true,
            unlit: true,

            index: 3,

            ..default()

            // transform: Transform::from_xyz(0., 0., 0.),
            // pivot: Some(Vec2::new(0.5, 0.5)),
            // double_sided: true,

    }.bundle(&mut sprite_params));
}

One small complication: your image assets should be loaded prior to spawning, as bevy_sprite3d uses some properties of the image (such as size and aspect ratio) in constructing the 3d mesh. Examples show how to do this with Bevy's States.

Versioning

bevy_sprite3d version bevy version
2.8 0.13
2.7 0.12
2.5 - 2.6 0.11
2.4 0.10
2.1 - 2.4 0.9
1.1 - 2.0 0.8
1.0 0.7

Dependencies

~41–79MB
~1M SLoC