Skip to main content

Validate Godot save-game fixtures and catch compatibility drift before release.

Project description

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 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}"

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.
  • Migration command failures.

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 details


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.1.tar.gz (9.0 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.1-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: godot_save_schema_guard-0.1.1.tar.gz
  • Upload date:
  • Size: 9.0 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.1.tar.gz
Algorithm Hash digest
SHA256 18599db9cc7bbe90d7593f9a1e331efe6dd23fe0bce6080a4f1f7f59436a75bc
MD5 fb4441165288a687f775757b1feb74db
BLAKE2b-256 6856c35a3de11b3b3653ac01b00d6999ea901a77a7d6b4a0da54de17c9b01574

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_save_schema_guard-0.1.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for godot_save_schema_guard-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 558894b99cea820727bc89cb54c89fec6aed57b3362fdcd328d250d511d803ea
MD5 1c852c8d7293e6d63d4ce5bd695680dd
BLAKE2b-256 6a5299c522e34faa7f77a0e0bb2caddb8e053ac10be105cb6edac34f274d720d

See more details on using hashes here.

Provenance

The following attestation bundles were made for godot_save_schema_guard-0.1.1-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