Skip to content
explainroo

Docs

Documentation

How to set up explainroo, how it makes a video, and every setting, command and scene element.

explainroo is a free, open source tool. A coding agent uses it to make explainer videos with a voice. Most of the time you ask your agent for a video. The agent runs npx --yes explainroo docs and follows what it prints, the same text as AGENTS.md in the repo. These pages are for you. They explain what explainroo does, how to set it up, and how to change a video yourself.

  • Getting started: What you need, how to run explainroo with npx, and how to get your first video.
  • How it works: What happens on your computer between your request and the finished MP4.
  • Formats: How to start a video from a format, and how to install a format or publish your own.
  • Writing the script: How script.md works, how to fix words the voice gets wrong, and how to write narration that sounds like a person.
  • Drawing scenes: How scenes.js works, how pictures appear on the right word, and where to put things on the screen.
  • Scene reference: Every element and option you can use in scenes.js, with examples.
  • Looks, sound and captions: How to change the look and the sound of a video, and how the camera and the captions work.
  • Voices and languages: How to pick a voice or use your own recording, and how to make a video in German and other languages.
  • Images and clips: How to use your own pictures and AI-made images and clips, and how to put a presenter next to your product.
  • Product demos: How to show an app by recording the real app, by rebuilding its screens with s.ui, or with a screen recording of your own.
  • Checking a video: How an agent that can't watch a video still sees it, and what each check looks for.
  • Cutting your own recording: How to cut a video you recorded yourself by deleting its words and pauses in a text file.
  • Publishing a video: How to get a finished video onto a platform, by uploading it yourself or by posting it from explainroo.
  • Settings: Every setting in video.json, what you can set for one scene in script.md, and the environment variables.
  • Commands: Every explainroo command and its options.
  • Questions and answers: Short answers about agents, costs, languages, licenses and the watermark.
  • What's new: What each explainroo release added, with links to the pages that explain each feature.