Godot Save Schema Guard

Validate Godot save-game fixtures against explicit schemas and catch incompatible save format changes before release.

The first release focuses on JSON saves because they are deterministic to validate outside the engine. It is meant to be a release gate: do not break player saves.

Install

python -m pip install -e .

When published:

python -m pip install godot-save-schema-guard

Quick Start

godot-save-guard generate-fixture --schema schemas\save.schema.json --fixture-output saves\fixtures\generated_v3.json --set 'player.id="pilot-1"' --format markdown
godot-save-guard validate saves\fixtures --schema schemas\save.schema.json
godot-save-guard validate examples\fixtures --schema examples\schema\save.schema.json --format markdown --output SAVE_COMPATIBILITY.md
godot-save-guard migrate saves\v1 --output-dir migrated\v2 --command "godot --headless --script tools/migrate_save.gd --input {input} --output {output}"
godot-save-guard migrate-chain saves\v1 --chain migrations.toml --output-dir migrated --schema schemas\save.schema.json --compare-original --format json --output reports\migration-chain.json
godot-save-guard migration-graph --chain migrations.toml --current 3 --supported 1 --supported 2 --format markdown
godot-save-guard redact saves\fixtures --path player.name --path players.*.email --output-dir sanitized\saves --dry-run

What It Checks

  • Invalid JSON fixtures.
  • Missing top-level version.
  • Missing required schema properties.
  • Numeric type drift such as "100" where a number is expected.
  • Type mismatches.
  • Unexpected properties when additionalProperties is false.
  • Generated fixture samples from required schema fields, defaults, enum values, and optional JSON overrides.
  • Migration command failures.
  • Ordered migration chains from older save versions to the current format.
  • Final migrated fixture validation after a migration chain succeeds.
  • Before-and-after summaries that compare original fixtures with final migrated outputs.
  • Missing migration paths from supported save versions to the current format.
  • Selected-field redaction for sanitized fixture copies.
  • Report metadata and plain-language rule explanations for compatibility findings.

Redaction is path-based. It only changes paths you list with --path, so review sanitized fixtures before attaching them to issues, documentation, or reports.

Documentation

Development

python -m pip install -e .
python -m unittest discover -s tests -v
godot-save-guard validate examples\fixtures --schema examples\schema\save.schema.json --fail-on none

Fixtures are generic and intentionally small so the repository is safe to publish.

Project links

Data verified by PyPI on
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.8)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for NonniGB from gravatar.com NonniGB

Credits

Author: Godot Save Schema Guard contributors

GitHub Statistics

Data verified by PyPI on 
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.11

Tags

godot save schema json migration fixtures ci gamedev

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

godot_save_schema_guard-0.1.6.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

godot_save_schema_guard-0.1.6-py3-none-any.whl (17.7 kB view details)

Uploaded Python 3

File details

Details for the file godot_save_schema_guard-0.1.6.tar.gz.

File metadata

  • Download URL: godot_save_schema_guard-0.1.6.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for godot_save_schema_guard-0.1.6.tar.gz
Algorithm Hash digest
SHA256 fd307dbdf7ce61d44867efd297f5018eb326c66ee83957f9256e268e84eb6f73
MD5 0804f8c18b3ccd383496e2105130f284
BLAKE2b-256 0e4fba232a1a13299f272bd5187b6da0ac49a72c84cc965a98175b77d28098a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_save_schema_guard-0.1.6.tar.gz:

Publisher: publish-save-schema-guard.yml on NonniGB/godot-production-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file godot_save_schema_guard-0.1.6-py3-none-any.whl.

File metadata

File hashes

Hashes for godot_save_schema_guard-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 1e09dd880be691922e576f674403aa53bd46aef614795a33b0d93ba16f405560
MD5 e38d2da10aec6919282abf7c84dcf02c
BLAKE2b-256 13976c489c3389e98908efb38c4538af00d721d4ca6c069c0dee383037ef7e6e

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_save_schema_guard-0.1.6-py3-none-any.whl:

Publisher: publish-save-schema-guard.yml on NonniGB/godot-production-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page