Get started¶

Installation¶

$ pip install fairyflow

Create project¶

$ fairyflow init <project_name>

This creates an initial project layout. See Project Structure for details. These files are created:

• fairyflow.toml - Configuration file
• prologue.py - Python file included into every scene
• scenes/scene1.ffpy - A scene file
• sequences/sequence1.ffsq - A sequence file (a sequence of scenes)

Start development environment¶

$ fairyflow open <project_name>

It starts a local web server. Click the printed URL to open the interactive environment.

First code & render¶

Open scenes/scene1.ffpy, it will contain the following code; press Ctrl+Enter to evaluate.

with Scene():
    stext("Hello world!").fade_out(dur=1)

Output video

Next steps¶

• Project Structure — scenes, groups, and files
• Shapes — Rect, Ellipse, Path, Polygon/Star, gradients
• Text — Text and font styling
• Code — syntax-highlighted code blocks
• Images — raster images and layered SVG/ORA
• Positioning — coordinates, alignment, and cross-group positioning
• Layout — column, row, and grid layouts
• Table — tabular data as an animatable node
• Animations — transitions, fades, rotation/scale, camera
• Cues — interactive presentations and speaker notes
• Exports — video, PDF, and player packages
• Examples — a full worked-through animation