CineCode
How-to Guides

Create a project

Scaffold a new CineCode project and understand each part of its layout.

Goal

Start a new video project with a working scene you can render immediately.

Scaffold it

cinecode new my-video

This creates:

my-video/
β”œβ”€β”€ assets/              # images, audio, and other media
β”œβ”€β”€ codescene.toml      # manifest: scenes, theme, output settings
β”œβ”€β”€ scenes/
β”‚   └── intro.ccs       # a starter scene (Rhai script)
β”œβ”€β”€ shaders/             # optional WGSL effects
└── src/
    └── main.rs         # sample source code shown in the scene

What each part is for

Prop

Type

Add a scene

Create and register a scene in one command:

cinecode add scene outro --project my-video

Choose a starter with --template blank, code-walkthrough, or before-after-diff:

cinecode add scene refactor --project my-video --template before-after-diff

The command creates scenes/<name>.ccs, appends its path to the manifest while preserving comments, validates the whole project, and rolls back on failure. Scenes remain ordered by their entries in the manifest:

codescene.toml
scenes = ["scenes/intro.ccs", "scenes/outro.ccs"]

Only scenes listed in scenes = [...] are rendered, and they play in the order you list them. A .ccs file that isn't listed is ignored.

Validate before rendering

cinecode check my-video

check parses the manifest and every scene script and reports errors without rendering β€” fast feedback while you write.

Next

On this page