Install and first project

Five minutes from nothing to an editor with your own animation in it.

Want to skip installing? Everything in the guide also works in the playground. Come back here when you want to render videos on your machine.

1. Install the tools

You need Rust and, to make videos, ffmpeg.

# Rust (skip if you have it)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# ffmpeg
sudo apt install ffmpeg        # Linux
brew install ffmpeg            # macOS
winget install Gyan.FFmpeg     # Windows

# the oxframe command
cargo install oxframe-cli

2. Create a project

oxframe init hello
cd hello
oxframe dev --open

The first build takes a minute or two — Rust compiles the engine once. Then your browser opens the editor: the animation in the middle, the timeline at the bottom. Press Space to play.

3. Change something

Open src/main.rs, find color!("#68abdf") and change it to color!("#2ecc71"). Save. About a second later the editor shows the new color — and stays on the same frame. That loop, edit → save → look, is how you will work.

4. Make a video

oxframe render        # writes out/hello.mp4

What is in the project

`src/main.rs`	Your scene. Everything you write goes here.
`src/intro.meta.json`	Timing values you adjust in the editor (lesson 7). Commit it.
`oxframe.toml`	Settings for `oxframe dev` and `render`.
`assets/`	Images and audio.
`AGENTS.md`, `.claude/`	Instructions for AI coding assistants (see Working with AI agents).

Next, lesson 1 walks through that first scene line by line.