kinetograph.
Terminology

Project layout

The folders of a new project, made by kinetograph init, and where generated files go.

npx kinetograph init makes a project with the folders below. Keep them.

npx kinetograph init my-video
my-video/
  src/
    index.tsx       registerRoot and the compositions
    scenes/         one component per scene
    components/     pieces used by more than one scene
    lib/            helpers
  public/
    images/  fonts/  audio/  video/
  out/              everything generated
  package.json  tsconfig.json  .gitignore

public/ holds the files staticFile('images/logo.png') reads. out/ holds what the commands write when you leave out -o: out/stills/, out/sheets/ for strip and onion, and out/renders/. out/ is in .gitignore.

The project folder is the one with the nearest package.json, or the entry's folder if there is none. init never overwrites a file and does not run npm install.

A project that already exists keeps its own layout. Only generated files go in out/.

Coming from Remotion: public/ is the same folder, read with the same staticFile.

See also

Entry point

The file you give to a command, which loads the project.

Root

The component you pass to registerRoot, which lists the compositions of a project.

On this page

See also