13 releases (breaking)

0.13.0 Mar 13, 2024
0.12.0 Dec 3, 2023
0.11.0 Jul 9, 2023
0.8.0 Mar 23, 2023
0.2.0 Dec 26, 2020

#119 in Game dev

Download history 412/week @ 2024-01-31 207/week @ 2024-02-07 388/week @ 2024-02-14 486/week @ 2024-02-21 286/week @ 2024-02-28 397/week @ 2024-03-06 436/week @ 2024-03-13 378/week @ 2024-03-20 435/week @ 2024-03-27 441/week @ 2024-04-03 809/week @ 2024-04-10 344/week @ 2024-04-17 535/week @ 2024-04-24 293/week @ 2024-05-01 664/week @ 2024-05-08 326/week @ 2024-05-15

1,906 downloads per month
Used in optima

MIT license

1.5MB
107 lines

bevy_stl

Crate version

Crate license

A STL loader for bevy.

STL is a very simple format, which supports only triangular geometry (positions + normals), without any color / uv / texture information.

It is supported as an output format by most CAD software.

Alternatives

  • by default bevy can load glTF scenes, which is a much better choice if you are looking for a way to load more complex models / scenes, including materials, animations, etc.
  • bevy_obj can load Wavefront .obj files, which can carry more information than STL (such as color, material, UV coordinates)

Usage

  1. Add bevy_stl to your Cargo.toml
  2. Add bevy_stl::StlPlugin plugin to the bevy App
  3. Load STL assets by passing paths with ".stl" extension to asset_server.load(..)

Example

fn main() {
    App::new()
        .add_plugins(bevy_stl::StlPlugin)
        .add_systems(Startup, setup)
        // ...
        .run();
}

fn setup(commands: &mut Commands, asset_server: Res<AssetServer>, mut materials: ResMut<Assets<StandardMaterial>>) {
    commands
        .spawn(PbrBundle {
            mesh: asset_server.load("disc.stl"),
            material: materials.add(Color::rgb(0.9, 0.4, 0.3).into()),
            ..Default::default()
        })
        // ...
}

You can find a more complete example in examples/spinning_disc.rs - use cargo run --example spinning_disc --release to run it.

Optional Features

Wireframe

By default bevy_stl produces a triangle mesh (PrimitiveTopology::TriangleList). When the optional wireframe feature is enabled, an additional line mesh is produced (PrimitiveTopology::LineList).

The feature can be enabled via Cargo.toml:

[dependencies.bevy_stl]
features = ["wireframe"]

When enabled, the mesh can be accessed by appending the wireframe label to the path passed to the asset loader:

  // This returns the triangle mesh (the default):
  asset_server.load("disc.stl")

  // This returns the wireframe mesh:
  asset_server.load("disc.stl#wireframe")

Dependencies

~40–78MB
~1M SLoC