godot-visual-smoke-test-kit 0.1.2

Screenshot diff and baseline helpers for Godot visual smoke tests.

Godot Visual Smoke Test Kit

Screenshot diff and baseline helpers for Godot visual smoke tests. It reads scene/viewport config, compares PNG screenshots, writes diff images, approves baselines, and prints planned Godot capture commands.

The first release keeps Godot execution out of unit tests, so the package is easy to run in CI and safe to develop without a specific engine install.

Install

python -m pip install -e .

When published:

python -m pip install godot-visual-smoke-test-kit

Quick Start

godot-visual-smoke plan visual-smoke.toml --project . --godot C:\Tools\Godot.exe
godot-visual-smoke plan visual-smoke.toml --project . --format json
godot-visual-smoke plan visual-smoke.toml --project . --viewport-manifest viewports.toml --format json
godot-visual-smoke compare baselines\menu.png current\menu.png --diff diffs\menu.png
godot-visual-smoke approve current\menu.png baselines\menu.png
godot-visual-smoke compare baselines\menu.png current\menu.png --format json --output visual-report.json

What It Does

• Parses visual-smoke.toml.
• Supports named viewport presets.
• Reuses viewport manifests across multiple smoke-test configs.
• Compares baseline and current PNG screenshots.
• Applies per-channel pixel tolerance.
• Fails when changed pixel percentage exceeds the configured threshold.
• Writes red diff images.
• Copies approved screenshots into baseline paths.
• Prints Godot capture commands for a project-owned helper script.
• Adds report metadata and readable failure explanations to JSON and text output.

Documentation

• Configuration
• Baseline workflow
• Godot capture integration
• CI usage
• Troubleshooting

Development

python -m pip install -e .
python -m unittest discover -s tests -v
godot-visual-smoke plan examples\visual-smoke.toml --project examples\tiny-godot-project

Examples are generic. Do not publish screenshots from private projects unless they have been reviewed.