13 releases

0.0.13 Jul 18, 2024
0.0.12 Mar 19, 2024
0.0.6 Jan 22, 2024
0.0.3 Nov 17, 2023

#815 in Game dev

Download history 6/week @ 2024-06-20 17/week @ 2024-06-27 55/week @ 2024-07-04 128/week @ 2024-07-18 20/week @ 2024-07-25 25/week @ 2024-08-01 67/week @ 2024-08-08 30/week @ 2024-08-15 8/week @ 2024-08-22 9/week @ 2024-08-29 7/week @ 2024-09-05 44/week @ 2024-09-12 39/week @ 2024-09-19 41/week @ 2024-09-26 16/week @ 2024-10-03

142 downloads per month
Used in 2 crates (via bevy_vrm)

MIT/Apache

365KB
10K SLoC

bevy_gltf_kun

Bevy gltf_kun plugin.

Features

  • glTF extension processing via hooks
  • glTF import / export
  • glXF import / export

Usage

Add [GltfKunPlugin] to your app:

use bevy::prelude::*;
use bevy_gltf_kun::GltfKunPlugin;

App::new().add_plugins((DefaultPlugins, GltfKunPlugin::default()));

Export

Export scenes to glTF using GltfExportEvent.

The resulting GltfExportResult will contain a flexible GltfDocument that can be exported to various file types. See [gltf_kun] for more information on how to do so.

use bevy::prelude::*;
use bevy_gltf_kun::{
    extensions::DefaultExtensions,
    export::gltf::{GltfExportEvent, GltfExportResult}
};
use gltf_kun::io::format::glb::GlbExport;

fn export_scene(
    scenes: Query<&Handle<Scene>>,
    mut export: EventWriter<GltfExportEvent<DefaultExtensions>>,
    mut results: ResMut<Events<GltfExportResult>>,
    mut did_export: Local<bool>,
) {
    // Send an export event once.
    if !*did_export {
        if let Some(handle) = scenes.iter().next() {
            export.send(GltfExportEvent::new(handle.clone()));
            *did_export = true;
        }
    }

    // Listen for the result.
    for mut event in results.drain() {
        let doc = event.result.unwrap();
        let bytes = GlbExport::<DefaultExtensions>::export(&mut event.graph, &doc);
    }
}

App::new().add_systems(Update, export_scene);

Import

Import glTFs using the GltfKun asset.

use bevy::prelude::*;
use bevy_gltf_kun::import::gltf::{GltfKun, scene::GltfScene};

fn import_gltf(
    asset_server: Res<AssetServer>,
    gltf_kun_assets: Res<Assets<GltfKun>>,
    gltf_scene_assets: Res<Assets<GltfScene>>,
    mut commands: Commands,
    mut handle: Local<Option<Handle<GltfKun>>>,
    mut did_import: Local<bool>,
) {
    if *did_import {
        return;
    }

    // Load the asset.
    if handle.is_none() {
        *handle = Some(asset_server.load::<GltfKun>("model.gltf"));
    }

    let handle = handle.as_ref().unwrap();

    let gltf = match gltf_kun_assets.get(handle) {
        Some(a) => a,
        None => return,
    };

    // Spawn the first scene.
    let gltf_scene = gltf_scene_assets.get(&gltf.scenes[0]).unwrap();
    commands.spawn(SceneBundle { scene: gltf_scene.scene.clone(), ..default() });

    *did_import = true;
}

App::new().add_systems(Update, import_gltf);

Dependencies

~40–77MB
~1.5M SLoC