render_movie
Render frames or a video of a Godot project or scene in a separate movie-writer run to check for blank output and motion, keep PNGs, or write an AVI/OGV file.
Instructions
Render frames frames of the project (or scene) in a separate movie-writer run: no bridge, session or input (to interact: run_project, simulate_input). mode check (default): stats, likelyBlank, motion, inline frames, files deleted. frames: keeps PNGs. video: .avi/.ogv, no stats. Returns: frameCount, likelyBlank, anyMotion, samples, paths, bytesWritten; warnings leads if unmeasured or unconfirmed. Needs a display; asks the user once per project. Errors on timeout, failed run or live session.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"projectPath": "<projectPath>"
},
"name": "render_movie"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fps | No | Fixed simulation and capture rate (default 30, max 120). Game time covered is frames / fps seconds, whatever the wall-clock speed. | |
| mode | No | "check" (default) measures a sample of frames, returns a few inline, and deletes every file. "frames" keeps the PNG sequence (and frame.wav) under .mcp/godot-runtime/movies/ and returns paths plus stats for a sample. "video" writes one movie file and returns its path; it has no pixel stats. | |
| scene | No | Scene to render (path relative to project, e.g. "scenes/main.tscn"). Omit to use the project's main scene. Must end in .tscn, .scn, .escn, .tres or .res. | |
| format | No | [video] Movie container (default "avi"). "ogv" needs an engine that can write it; the error names the format and engine version when it cannot. Rejected in other modes. | |
| frames | No | Frames to render before Godot quits (default 30, max 600). The first frames can be blank while the scene loads; likelyBlank is judged on the last one. The run is budgeted at 30s plus 250ms per frame, and a run that overruns it takes up to 10s more to stop. A run of 77 to 80 frames is refused, with nothing run, because its answer would not fit a client's 60s request timeout; above that a client may cut the call off before this server can report a timeout. | |
| projectPath | Yes | Path to the Godot project directory | |
| inlineFrames | No | [check] Inline images to return, evenly spaced and ending at the last frame (default 3, max 6; 0 for none). Each is downscaled to fit 960x540; stats are measured at full size. Rejected in other modes. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fps | Yes | ||
| mode | Yes | ||
| path | No | ||
| scene | No | ||
| format | No | ||
| motion | No | Largest mean RGB difference between consecutive measured frames, over every pixel, 0 to 1. A small mover reads near 0 here; anyMotion is decided by the changed pixel count, not by this mean. | |
| samples | No | ||
| byteSize | No | ||
| warnings | No | ||
| anyMotion | No | True when some pair of consecutive measured frames had at least its motionThreshold of pixels whose R, G or B changed by more than 8 of 255; every pixel is compared. Null when no measured pair moved and a pair was not measured, or fewer than two frames were measured. motionPairs has the counts behind it. | |
| audioPath | No | ||
| directory | No | ||
| statsNote | No | ||
| frameCount | No | PNG frames found on disk after the run. | |
| framePaths | No | Omitted above 60 frames; use framePattern and frameCount. | |
| framesKept | No | ||
| likelyBlank | No | Judged on every pixel of the last frame: true when it is one flat colour (no channel varies by more than 8 of 255 across it). Null when it was not measured. | |
| motionPairs | No | ||
| projectPath | Yes | ||
| bytesWritten | No | Total size in bytes of every file this run wrote under .mcp/godot-runtime/movies/. In check mode the files are deleted again (framesKept false); in frames and video mode they stay on disk until removed by hand. Null when the run directory could not be read. | |
| framePattern | No | ||
| inlineFrames | No | ||
| measuredFrames | No | Sampled frames whose stats were measured. | |
| statsAvailable | Yes | False in video mode: stats need PNG frames. | |
| framesRequested | Yes |