ranim

examples/hello_ranim

examples/ranim_logo

Ranim is an animation engine crate implemented in pure rust, inspired heavily by Manim and jkjkil4/JAnim.

[!WARNING] Ranim is now WIP. It only supports some basic items and animations, the apis are unstable and may change frequently, the documentation is also not complete.

Related:

• AzurIce/ranim-doc: rustdoc for main
• AzurIce/ranim-book: ranim book
• AzurIce/ranim-one-shot: one-shot attempts with ranim
• AzurIce/ranim-bench: benchmarks for ranim

Dependencies

Runtime dependencies:

• ffmpeg: encode videos Ranim will try to use ffmpeg from system's path environment variable first, if no ffmpeg is found, ranim will automatic download ffmpeg to the current working dir.

Installation

Currently, it is experimental on crates.io:

[dependencies]
ranim = "0.2.1"

You can also use from git for the latest updates:

[dependencies]
ranim = { git = "https://github.com/azurice/ranim" }

For the usage, check out the examples folder. You can run the examples with:

cargo run -p ranim-cli --release -- preview --example  # run a preview app for the example
cargo run -p ranim-cli --release -- output --example  # render every declared output of the example

See Ranim Cli for more.

Ranim Cli

Ranim cli is a command line tool to help you build the animation. It enables animation previewing with hot reload through dylib.

Please notice that you can use ranim without ranim-cli, the previewing and rendering process can be achieved by simply invoking apis provided by ranim, but it may enhance your experience.

You can install it with:

cargo install ranim-cli

Or install from git:

cargo install --git https://github.com/azurice/ranim ranim-cli --locked

Or you can create a bin, and run cli from ranim_cli directly (this can make sure the version of ranim matches ranim_cli):

fn main() {
    ranim_cli::main();
}

Basic Usage:

• ranim preview[ ]: Launch a preview app and invoke cargo to build your library automatically when the source code is changed, then reload it through libloading and show it in the preview app.
• ranim output[ ...]: Render every #[output(...)] declared by the selected scenes, including capture marks. When no scene name is specified, render all scenes.
• ranim render : Render one scene once with default output settings (1920x1080, 60 fps, mp4). This is the low-level/ad-hoc render command, ignores #[output(...)], and does not process capture marks.
• ranim inspect scenes [--format text|json]: List available scenes and their output summaries.
• ranim inspect tree [] [--format text|json]: Build a scene and print its animation tree. The scene name can be omitted when there is only one scene.
• ranim inspect frame --at [--format text|json] [--verbose]: Sample a scene at a time and print the evaluated frame items.

You can specify the package with --package and --example (just like cargo, note that your anim target should have crate-type of dylib or cdylib), and other aditional arguments you want to pass to cargo build can be passed after --.

For example:

ranim output -p render scene_a scene_b -- --release
ranim render -p render scene_a -- --release

Feature Flags

• Default features

  • anims: re-export ranim-anims, default on.

  • items: re-export ranim-items, default on.

• render: enable render api in cmd module

  use render_scene or render_scene_output to render scene to output

• preview: enbale preview api in cmd module

  use preview_scene api to launch an preview app on a scene https://github.com/user-attachments/assets/5bf287e2-b06f-42f8-83b6-76f3775e298e

• audio-decode: enable audio file decoding (AudioClip::from_file / from_bytes)

  pure-Rust decoding via symphonia (WAV, MP3, FLAC, AAC/M4A, Ogg Vorbis) with rubato resampling to the 48 kHz master rate — no ffmpeg binary required

• profiling: enable GPU timer scopes (wgpu-profiler) for the preview profiler panel

The preview app has a built-in profiler panel (top bar Profiler button): a progress-axis chart of GPU pass times / CPU spans / buffer-upload stats with click-to-seek. GPU timer scopes (wgpu-profiler) are runtime-toggled in the panel or via RANIM_PROFILE_GPU=1; upload tracking via RANIM_PROFILE_UPLOAD=1. While GPU timers are enabled, each frame pays a device poll.

Contributing

See CONTRIBUTING.md for guidelines.

Design

Once the design is stablized, I may write about it.

For now, you can check out the code.

Aknowledgements

• 3b1b/manim
• ManimCommunity/manim
• jkjkil4/JAnim

Star History