godot-save-schema-guard 0.1.2

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

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}"
godot-save-guard migrate-chain saves\v1 --chain migrations.toml --output-dir migrated --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.
• Migration command failures.
• Ordered migration chains from older save versions to the current format.
• Report metadata and plain-language rule explanations for compatibility findings.

Documentation

• Schema guide
• Migration workflow
• Godot JSON caveats
• Rule reference
• CI usage

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.