Adding `bevy_motiongfx` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add bevy_motiongfx

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

bevy_motiongfx = "0.1.0-rc.2"

The bevy_motiongfx library will be automatically available globally. Read the bevy_motiongfx library documentation.

Back to the crate overview.

Readme

Bevy MotionGfx

An integration of the MotionGfx crate for the Bevy game engine.

Usage

Initialization

The BevyMotionGfxPlugin must be added for timeline and controllers to work.

use bevy::prelude::*;
use bevy_motiongfx::BevyMotionGfxPlugin;
use bevy_motiongfx::prelude::*;

App::new()
    .add_plugins((DefaultPlugins, BevyMotionGfxPlugin))
    // Add systems here...
    .run();

Create Animations

For a more thorough walkthrough on the Timeline API, read the MotionGfx docs.

This example demonstrates how to animate an Entity.

use bevy::prelude::*;
use bevy_motiongfx::prelude::*;

fn build_timeline(mut commands: Commands) {
    // Spawn the Entity.
    let entity = commands
        .spawn(Transform::from_xyz(-3.0, 0.0, 0.0))
        .id();

    // Build the timeline.
    let mut b = TimelineBuilder::new();
    let track = b
        .act_interp(entity, field!(<Transform>::translation::x), |x| {
            x + 6.0
        })
        .play(1.0)
        .compile();

    b.add_tracks(track);
    let timeline = b.compile();

    // Spawn the timeline.
    commands.spawn(timeline);
}

This example demonstrates how to animate an Asset.

use bevy::prelude::*;
use bevy_motiongfx::prelude::*;

fn build_timeline(
    mut commands: Commands,
    mut materials: ResMut<Assets<StandardMaterial>>
) {
    // Create the asset.
    let material =
        materials.add(StandardMaterial::from_color(Srgba::BLUE));
    // Spawn an entity to prevent the asset from dropping.
    commands.spawn(MeshMaterial3d(material.clone()));

    // Build the timeline.
    let mut b = TimelineBuilder::new();
    let track = b
        .act_interp(
          // AssetIds must be type-erased.
          material.untyped().id(),
          field!(<StandardMaterial>::base_color),
          |_| Srgba::RED.into(),
        )
        .play(1.0)
        .compile();

    b.add_tracks(track);
    let timeline = b.compile();

    // Spawn the timeline.
    commands.spawn(timeline);
}

Controllers

Controllers are helper components for automating the target time and target track of a Timeline.

use bevy::prelude::*;
use bevy_motiongfx::prelude::*;

fn build_timeline(mut commands: Commands) {
    // Build the timeline.
    let mut b = TimelineBuilder::new();
    // Add tracks here...
    let timeline = b.compile();

    // Spawn the timeline with a controller.
    commands
        .spawn((timeline, RealtimePlayer::new().with_playing(true)));
}

Version Matrix

Bevy	MotionGfx	Bevy MotionGfx
0.17	0.1	0.1

Adding bevy_motiongfx library as a dependency

Adding `bevy_motiongfx` library as a dependency