Skip to content

Latest commit

 

History

History

README.md

reeln Examples

Step-by-step walkthroughs for common reeln workflows. Each example is self-contained — start from the top or jump to whatever fits your use case.

Getting Started

# Example Description
01 Getting Started Install Python, ffmpeg, and reeln from scratch
02 Configuration & OBS Setup Configure reeln and connect it to your OBS replay buffer

Game Workflow

# Example Description
03 Starting a Game Initialize a game workspace with teams and sport
04 Segments & Events Process game segments and tag events
05 Rendering Shorts Turn clips into vertical or square short-form video
06 Highlights & Reels Merge segments into highlight reels
07 Profiles & Iterations Reusable render profiles and multi-pass rendering
08 Game Finish & Cleanup Finalize games and clean up artifacts

Plugins & Advanced

# Example Description
09 Plugins Discover, install, and manage plugins
10 Smart Zoom AI-powered tracking that follows the action

Prerequisites

  • Python 3.11+ — see Getting Started for install options
  • ffmpeg 5.0+ — with libx264, aac, and libass support
  • reelnpip install reeln or uv tool install reeln

If you're a livestreamer using OBS, start with Configuration & OBS Setup to connect reeln to your replay buffer output.