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
First successful path:
- Run
planand capture current screenshots with your project-owned Godot helper. - Run
comparewith--format json --output visual-report.jsonand upload the current image, diff image, and JSON report as CI artifacts. - Review the current and diff images.
- Run
approveonly for an intentional visual update.
If either the baseline or current screenshot is missing, compare returns a normal text or JSON finding that names the missing file and the next step.
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.
- Reports missing baseline or current screenshots with next-step guidance.
- 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
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
godot-visual-smoke compare baselines\menu.png current\menu.png --diff diffs\menu.png --format json --output visual-report.json
Examples are generic. Do not publish screenshots from private projects unless they have been reviewed.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file godot_visual_smoke_test_kit-0.1.3.tar.gz.
File metadata
- Download URL: godot_visual_smoke_test_kit-0.1.3.tar.gz
- Upload date:
- Size: 11.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8ef36b601772315efbb48f88f1050d4b3e96b65b638928426314e77189d5e01e
|
|
| MD5 |
42b67733a8927a55576451cc44508764
|
|
| BLAKE2b-256 |
dfc7dd0d7e9eaccfa8323674edf067a485522ee75d5b998dce7ec3ce75a71b2a
|
Provenance
The following attestation bundles were made for godot_visual_smoke_test_kit-0.1.3.tar.gz:
Publisher:
publish-visual-smoke-test-kit.yml on NonniGB/godot-production-toolkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
godot_visual_smoke_test_kit-0.1.3.tar.gz -
Subject digest:
8ef36b601772315efbb48f88f1050d4b3e96b65b638928426314e77189d5e01e - Sigstore transparency entry: 2159834487
- Sigstore integration time:
-
Permalink:
NonniGB/godot-production-toolkit@9550491d477d4166469bd8ab46826912bb5ea500 -
Branch / Tag:
refs/tags/godot-visual-smoke-test-kit-v0.1.3 - Owner: https://github.com/NonniGB
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-visual-smoke-test-kit.yml@9550491d477d4166469bd8ab46826912bb5ea500 -
Trigger Event:
push
-
Statement type:
File details
Details for the file godot_visual_smoke_test_kit-0.1.3-py3-none-any.whl.
File metadata
- Download URL: godot_visual_smoke_test_kit-0.1.3-py3-none-any.whl
- Upload date:
- Size: 11.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
acc6c9b562be253f7f774715e27493e51e754a9aec333f313b5440bf5bcac0e5
|
|
| MD5 |
b32e0dbcf144b3e9322429b2acd50a74
|
|
| BLAKE2b-256 |
fe96629d359f03449179cccfa3bc53225e95278c764f36334f7754acc169e1c1
|
Provenance
The following attestation bundles were made for godot_visual_smoke_test_kit-0.1.3-py3-none-any.whl:
Publisher:
publish-visual-smoke-test-kit.yml on NonniGB/godot-production-toolkit
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
godot_visual_smoke_test_kit-0.1.3-py3-none-any.whl -
Subject digest:
acc6c9b562be253f7f774715e27493e51e754a9aec333f313b5440bf5bcac0e5 - Sigstore transparency entry: 2159835196
- Sigstore integration time:
-
Permalink:
NonniGB/godot-production-toolkit@9550491d477d4166469bd8ab46826912bb5ea500 -
Branch / Tag:
refs/tags/godot-visual-smoke-test-kit-v0.1.3 - Owner: https://github.com/NonniGB
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-visual-smoke-test-kit.yml@9550491d477d4166469bd8ab46826912bb5ea500 -
Trigger Event:
push
-
Statement type:
