Quickstart

By the end of this guide you will:

All videos are generated using Rustimate!


1 · Install Rustimate

brew install rustimate
curl -fsSL https://rustimate.com/install.sh | bash
scoop install rustimate

Verify:

rustimate --version
# rustimate 0.1.0

2. Run the demo

To get started , run the demo command.


rustimate --demo

# use shorthand
rustimate -d

Rustimate Guide

Open your current folder and you should be able to see a mp4 rustimate-demo.mp4

3. Help

You can use help command to know more about the arguments available.


rustimate --help

or

rustimate -h

Rustimate Guide

4 · Create your first script

Create a file called hello.rsl and add the following snippet.

This script defines a simple scene with a text element.

scene "scene1" {
  mode: presentation
  text  "Hello World"
  text  "Welcome to Rustimate Guide"
}
Note

I use Neovim but you can use any editor of your choice to add the following snippet

Rustimate Guide

To run this .rsl file, run the following command to see the frames and ETA.

Rustimate will now:

  1. Parse the RSL script
  2. Generate frames
  3. Encode the video
  4. Generate firstrsl.mp4 in your current folder
Tip

You can avoid adding .mp4 extension

rustimate -i hello.rs -o firstrsl

Rustimate Guide

That’s it!

You just created your first Rustimate visualization.

From here, RSL scripts can power code walk through and do much more.

I am excited to see what you create.

Note

See License tiers for what each tier unlocks.

Next steps