Run project
run_projectLaunch a Godot project's main scene or a specific scene, run it for a set time, and capture its output logs. Use it to quickly test gameplay or debug with logged output.
Instructions
Launch the game and capture its output. Runs the main scene, or one specific scene. Use wait_seconds for a quick check that returns the log; omit it to leave the game running and poll with get_output.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| args | No | Extra arguments passed to the game after --. | |
| scene | No | Run just this scene (like F6). Omit for the main scene. | |
| project | No | Godot project folder (the one with project.godot). Optional if the server was started with --project. | |
| replace | No | Restart if something is already running. | |
| headless | No | Run with no window. Faster and CI-safe, but nothing renders — screenshots will not work. | |
| wait_seconds | No | Run for this long, stop, and return the output. 0 leaves it running in the background. | |
| always_on_top | No | Keep the game window above others. Default on: an occluded window is throttled by the OS and stops drawing, which makes screenshot(source='game') return stale frames or time out. |