Scene and music

Every command that builds, checks and draws a 3D scene, and every command that checks, plays and measures an episode's music.

A 3D scene and a song are both files your agent writes. The CLI checks them, then draws the scene or plays the song on your computer. These commands send nothing to a model.

Every command on this page needs a signed-in computer. Signed out, each one prints You are not signed in. Ask your agent to run minicut login. and exits with code 10. See Account.

minicut scene api

Prints the import line for a scene script that you run yourself with Node.js.

Usage

minicut scene api

Details

Put the printed line at the top of your script. The script then has the scene composer's own operations and a save that checks the scene before it writes. MiniCut never runs your script. You run it, so your agent app's permission check sees every run.

Global options: see Global options.

Examples

Get the import line

minicut scene api

You see one import line to copy into your script.

See also

minicut scene build, minicut scene check

minicut scene build

Applies a list of scene operations to a fresh scene, checks it, and writes the scene file.

Usage

minicut scene build NAME.scene.ops.json [--out FILE]

Replace the following:

• NAME.scene.ops.json: a data file that lists the scene operations and their arguments.
• FILE: the scene file to write.

Details

An operations file is data only. A file that holds code is refused. Without --out, the command writes NAME.scene.json beside the operations file and raises its revision number by one. If the scene has problems, nothing is written.

Options

Global options: see Global options.

Examples

Build a scene from an operations file

minicut scene build episodes/ep01/scenes/c03.scene.ops.json

You see Wrote with the scene file, its revision and a short summary of the scene.

Output

See also

minicut scene check

Checks a scene file against the composer's own rules and limits.

Usage

minicut scene check FILE [--loose]

Replace the following:

• FILE: the scene file to check.

Details

The check reads the scene's structure and limits first. Then it checks every body against every prop and the floor, at every frame. It prints one line for each problem.

Options

Global options: see Global options.

Examples

Check a shot's scene

minicut scene check episodes/ep01/scenes/c03.scene.json

You see OK with a summary of the scene, or the number of problems and one line for each.

Output

See also

minicut scene render, Checks and loops

minicut scene render

Draws a scene as a still or a clip on your computer.

Usage

minicut scene render FILE [--camera CAMERA] {--still SECOND|--still middle|--clip} [--project PROJECT --episode EPISODE --clip CLIP] [--id LIBRARY_ID] [--draft | --size WIDTH] [--force]
minicut scene render FILE FILE ... {--still SECOND|--clip} [--draft] [--force]
minicut scene render --project PROJECT --episode EPISODE {--still SECOND|--clip} [--draft] [--force]

Replace the following:

• FILE: the scene file to draw.
• CAMERA: the id of a camera in the scene.
• SECOND: the second of the scene to draw as a still.
• PROJECT, EPISODE, CLIP: where to save a clip, for example night-market, ep01, c03.
• LIBRARY_ID: the library entry to save a still into.
• WIDTH: the frame width in pixels.

Details

A clip is saved as the next take of the named shot. A still goes into your library with --project or --id. Without them, it goes into the cache/stills folder of your MiniCut home folder, and the path is printed. Every render keeps two copies: the clean picture, and a copy in labeled/ with a name tag on every asset, for people to read.

The render is refused while a body goes through a prop or the floor in the frames it would draw. A clip whose scene, camera and size are unchanged since its newest take is not drawn again.

With several files, or with --project and --episode alone, the command draws many scenes in one run. With --project and --episode alone, it draws every shot scene of the episode, in shot order.

Options

Global options: see Global options.

Examples

Draw a still from the middle of a scene

minicut scene render episodes/ep01/scenes/c03.scene.json --still middle --draft

Draw every shot scene of an episode as clips

minicut scene render --project night-market --episode ep01 --clip

You see each scene as it is drawn, then one line with how many were drawn, unchanged and not drawn.

Output

See also

minicut scene check, Generate

minicut scene undo

Puts back the version of a scene before its last write.

Usage

minicut scene undo FILE

Replace the following:

• FILE: the scene file.

Details

It undoes the last write from the MiniCut app or from an agent. The last 20 versions are kept.

Global options: see Global options.

See also

minicut scene panorama

Sets or clears the panorama picture of a scene.

Usage

minicut scene panorama FILE {--image PICTURE|--box BOX_ID|--clear}

Replace the following:

• FILE: the scene file.
• PICTURE: a picture on your computer. It is also put on the episode's board.
• BOX_ID: the id of a picture box on the episode's board.

Options

Global options: see Global options.

See also

minicut scene to-board

Copies a picture or clip next to the scene and adds it as a box on the episode's board.

Usage

minicut scene to-board FILE MEDIA [--label WORDS]

Replace the following:

• FILE: a scene file inside an episode, <project>/episodes/epNN/scenes/NAME.scene.json.
• MEDIA: the picture or clip to send to the board.
• WORDS: the label for the new box.

Details

The episode needs a board first. Make one with minicut board new --project PROJECT --episode EPISODE.

Options

Global options: see Global options.

See also

minicut scene panorama, Generate

minicut music

Gives your own music script what it needs, then checks, plays and measures the song file it writes.

Usage

minicut music api [--json]
minicut music instruments [--json]
minicut music cuts EPISODE_FOLDER [--json]
minicut music check SONG
minicut music render SONG [--from SECONDS --to SECONDS] [--stems] [--no-mp3]
minicut music measure WAV [--episode EPISODE_FOLDER]
minicut music from-midi MIDI --map MAP [--out SONG]

Replace the following:

• EPISODE_FOLDER: the episode folder, for example episodes/ep01.
• SONG: a song file, NAME.song.json.
• SECONDS: a time in the song, in seconds.
• WAV: a .wav file that minicut music render made.
• MIDI: a .mid file from any music tool.
• MAP: a .json file that maps the MIDI tracks to instruments.

Details

Your agent writes its own music script in Python 3.9 or newer and runs it itself. The script writes a song file. A song file is data only: instruments by catalog id, synths by preset id, no paths and no code. MiniCut never runs your script, and the music commands open no network connection. Your agent runs these commands in the Mock loop.

render writes NAME.wav, NAME.mp3, NAME.beats.json, NAME-waveform.png and NAME.report.json beside the song. It needs the instrument samples that minicut setup installs once, about 396 MB.

Options

Global options: see Global options.

Examples

Read the timing of an episode

minicut music cuts episodes/ep01 --json

Check and play a song

minicut music check episodes/ep01/music/score.song.json
minicut music render episodes/ep01/music/score.song.json

You see the problems in the song file, if any, then the files that render wrote.

Measure the result against the episode

minicut music measure episodes/ep01/music/score.wav --episode episodes/ep01

Output

Limits

See also

Setup, Checks and loops

Errors

Next