Installation
Fluvie turns a Flutter widget tree into a real MP4. You write the video as code, preview it like an app, and render it with the Fluvie CLI and FFmpeg.
In a hurry? fluvie init scaffolds a project for you: a composition file, an
assets/ folder, and a pubspec. See Start a project. To
set it up by hand, read on.
Add the package to your pubspec.yaml:
dependencies: fluvie: ^0.3.0Then fetch it:
flutter pub getWhat you need
Section titled “What you need”- Flutter 3.44 or newer.
- FFmpeg, for rendering (previews do not need it). You do not have to install
it: the first render downloads a pinned FFmpeg build and caches it. Run
fluvie ffmpeg installto fetch it ahead of time, or point--ffmpeg/FLUVIE_FFMPEGat your own. See Managing FFmpeg.
Check Flutter:
flutter --versionWorking inside this repository
Section titled “Working inside this repository”The repo is a Melos workspace. Bootstrap it once:
melos bootstrapThe gallery example app in examples/gallery/ is the lesson gallery and inspector. Run it
from the repo root so its render button can find the CLI.
Previewing on the desktop
Section titled “Previewing on the desktop”fluvie preview runs a composition live, with hot reload:
fluvie preview ./lib/my_video.dartIt runs on your desktop by default, not the browser: a desktop preview decodes
any clip through FFmpeg, while a browser can only decode what WebCodecs supports.
Pass -d chrome for the browser, or -d <device> for a phone or an emulator.
Rendering to a file does not need a preview. The headless render pipeline (the CLI, the API, and the Docker image) produces the final frames correctly on its own, including loading the real fonts so text never falls back to the boxy test font.
Where to next
Section titled “Where to next”- Start a project: scaffold a project with
fluvie init. - Your first video: build and render lesson 01.
- Core concepts: the ideas behind every Fluvie video.
- Managing FFmpeg: how Fluvie finds, downloads, and pins FFmpeg.