Skip to content

Getting started ​

Formercial runs on your own machine: a small web app for editing, and a command line for scripting and rendering. There are no accounts and no cloud services to set up.

What you need ​

ToolWhyInstall
Node 22+ and pnpmRuns the appnodejs.org, then npm i -g pnpm
ffmpeg and ffprobeEncodes the video, reads clip lengthsapt install ffmpeg, brew install ffmpeg, or ffmpeg.org
ChromiumDraws each frame of a rendernpx playwright install chromium-headless-shell, or set CHROME
edge-tts (optional)Generated voicepipx install edge-tts

Without edge-tts you can still record your own voice in the editor. Generated voice sends the spoken lines to Microsoft's speech service.

Run it ​

bash
git clone https://github.com/forinda/formercial.git
cd formercial
pnpm install
pnpm dev

Open the address it prints (http://localhost:3000 by default). Then check what can render on this machine:

bash
pnpm kick formercial drivers
chromium-ffmpeg      ready

If something's missing, the line says what to install.

Open the example ​

The repository includes projects/kickjs-db, a two-minute spot. Open it from the projects page, press Play, then switch the preview between 16:9, 9:16 and 1:1.

To render it from the command line:

bash
pnpm kick formercial render kickjs-db --format 16:9 --seconds 10

That renders the first 10 seconds to projects/kickjs-db/renders/. Leave out --seconds for the whole spot, and use --format all for all three shapes.

Make your own ​

Start blank, or from a preset. The showcase tours every feature, so you can keep what suits you and delete the rest. Each lesson teaches one thing, using the lesson pattern, so you can reword it for your own topic:

PresetWhat it is
showcaseEverything: every block, every code language, stamps that come and go, a silent scene, a scene with no caption, and a custom scene. Each caption says what the scene shows.
doodle-light-bulbA hand-drawn lesson on why a bulb glows. See Doodle videos.
typescript-typesA lesson on using types to catch a real bug before the code runs
javascript-const-letA lesson on choosing between const and let
python-objectsA lesson that mixes doodles and code: what an object is, drawn in plain words, then a wallet class
bash
pnpm kick formercial new "My Product"
pnpm kick formercial new "Learn TypeScript" --preset typescript-types

Creating a project from a preset downloads its fonts from Google Fonts into the project, so it looks the same on any machine. If that fails, the project is still made, and you can press Download under Project → Fonts later.

Or open New from a template on the projects page, pick a preset, name it and press New commercial. The language and doodle presets are ready to render as-is. showcase has a custom scene, so trust it first or delete that scene. Change the text, code and colors to make it yours, then press Download next to each font under Project so renders look the same everywhere.

The Projects tab lists what you've made. Search by name or folder, and switch between Cards and Table. A card shows a still from the project's latest render, made the first time it's shown and kept in the project's thumbs/ folder. Before a project is rendered, its card shows its name in its own colors.

Then read Making a commercial.

Released under the Apache License 2.0.