Scenario for Godot

Install · Sign in · Lanes · Spending rules · User guide · Website · Changelog

Generate images, 3D models, PBR materials, skyboxes and sound effects with Scenario from a dock inside the Godot editor. You see the exact price in Creative Units (CU) before you spend, and the result lands in the open scene as a native Godot asset.

Version 0.2.1. Tested on Godot 4.7.2 (standard build, macOS). GDScript only, so it also loads in the .NET build. MIT license.

1. Download scenario-godot-plugin-0.2.1.zip from godot.scenario.com, or copy addons/scenario/ from this repository.
2. Unzip it at the root of your Godot project, so you get res://addons/scenario/plugin.cfg.
3. In Godot, open Project > Project Settings > Plugins and enable Scenario. The Scenario dock opens in its own column, right of the Inspector.

Create an API key and secret in the Scenario web app (app.scenario.com), then paste both into the dock and press Connect.

The secret never goes into your project folder, so it cannot end up in git:

• macOS: the secret is stored in your login Keychain (service "Scenario Godot Plugin"). Only the key id is written to the editor settings folder.
• Other systems: key and secret are written to scenario/credentials.json in the Godot editor settings folder, readable by your user only.
• SCENARIO_API_KEY and SCENARIO_API_SECRET environment variables take precedence over both, which suits CI and shared machines.

Generations are billed to the Scenario project that owns the key.

More (Image, 3D and Sound lanes) adds Scenario's recommendations for your prompt to the picker. The form is built from each model's live schema; settings that change the price are marked "affects price".

Prices measured on 2026-10-04, as examples: Flare at low quality 1024x1024, 2 CU; Rodin Extreme-Low PBR, 80 CU; PATINA 512x512, 6 CU; Skybox GPT at low quality, 2 CU; Sonilo 2 s, 1 CU. Scenario sets the prices; the dock always shows the current one.

• Price first. Every change to the form triggers a free price check; the button reads Generate · N CU. Generate stays disabled until the price matches the form as it is now.
• One click, one paid request. Each price is used once. A paid request is never retried automatically.
• Uncertain means Unknown. If the connection drops while a request is being sent, the job is marked Unknown and the same request is blocked until you press Check Scenario, so a network glitch cannot charge you twice.
• Confirmation above a threshold. Requests above 100 CU ask first (Editor Settings > Scenario > Confirm Above CU).
• Spending switch. Launch Godot with SCENARIO_NO_SPEND=1 and every paid request (and every upload) is refused before it leaves the editor. Price checks, cancels and imports still work.
• Blocked jobs (moderation) are shown as such and never resent.

Results are saved under res://scenario/<lane>/, named <date>-<prompt>-<asset>[-<map>].<ext>, for example res://scenario/material/2026-10-04-mossy-cobblestone-floor-p2mgtx-normal.png. Normal maps are imported as normal maps. Next to each result, a .scenario.json file records the job, model, prompt, parameters and CU charged, so you can trace every asset back to its generation.

The job list lives in res://.godot/scenario/jobs.json. It survives editor restarts and stays on your machine (.godot/ is not committed).

Every placement is one undo step (Ctrl+Z, Cmd+Z on macOS).

• User guide: each lane step by step, references, job states, troubleshooting. Also published as a website.
• Changelog, known issues, roadmap and issues.
• Design notes: proposals and open questions for 0.2 and later.
• AGENTS.md: the code map and the rules, for contributors and coding agents.

The repository root is a small Godot demo project that hosts the addon and its tests. Requirements: Godot 4.7 ($GODOT, or godot on the PATH), Python 3, and the scenario-godot-expert toolkit the test runners drive Godot with: make toolkit fetches the commit pinned in tools/toolkit.py (GODOT_EXPERT_SCRIPTS overrides it).

make toolkit  # the pinned toolkit into .toolkit/ (git), checked against addons/agentkit
make test     # unit tests (GUT, 85) and the headless editor test (69 checks, fake backend, 0 CU)
make zip      # dist/scenario-godot-plugin-<version>.zip, then a clean install into a blank project
make dock     # re-render docs/images/dock-<version>.png (fake backend, opens a small window)
make lint     # gdlint and ruff (uv), the same as CI

CI runs the toolkit check, the tests, the zip check and the linters on every pull request. PR titles follow Conventional Commits, checked by commitlint.config.mjs (pnpm install, then pnpm exec commitlint); see AGENTS.md.

With SCENARIO_API_KEY and SCENARIO_API_SECRET set:

python3 tools/contract_check.py      # free: every listed model loads and prices, no-spend switch holds
python3 tools/smoke.py               # PAID: one run per lane, ledger in tests/smoke/LEDGER.md

SUPPORT.md says where to look and whom to ask: the issue chooser for bugs and change requests, support@scenario.com or Scenario's in-app support for account, billing and API-key questions. Never post your API key or secret in a public issue. Report vulnerabilities privately as described in SECURITY.md.

Contributions are welcome: read CONTRIBUTING.md and follow the Code of Conduct.

• Scenario for Blender (GPL-3.0-or-later).
• Scenario for Unity (MIT).
• Scenario skills for agents (MIT).
• The Scenario MCP server brings Scenario tools to coding agents outside the editor.

MIT, see LICENSE. "Scenario" and the Scenario logo belong to Scenario Inc. Godot is a trademark of the Godot Foundation; this plugin is not affiliated with or endorsed by it.