Schemas

A schema describes the structure of a data file so tools can check it. OpenGDD uses JSON Schema, a standard format for these definitions.

These downloads are for people who build or configure tools. If you use OpenGDD's authoring tool, you do not need them. The tool already includes the checks.

A schema checks one file. OpenGDD's validator also checks the connections between files and the numeric rules. A person reviews the written design.

Schema files

The schema files are v0.8. Use the definitions and validator that match the package you check.

Schema fileWhat the data file contains
manifest.schema.json Identifies the game, its designer and its target platform.
clocks.schema.json Optional. How game time advances, when it pauses, and how that affects values that change over time.
direction.schema.json Optional. Art direction: colors, mood, visual priorities and measurable requirements.
tuning.schema.json Shared gameplay numbers, the ranges they may take, and the calculation rules.
personalization.schema.json Optional. Questions each build answers, with defaults and the gameplay numbers they change.
collection.schema.json Optional. The _collection.json file, which sets the structure of items such as enemies or cards.
opengdd-build.schema.json The builder's report: game identity, choices, final numbers, test results and evidence.

Versioned addresses

Each schema has a versioned web address. The schema records that address in its $id field, which identifies the definition:

https://opengdd.org/schema/<layer>/v<minor>/<file>.schema.json

The current schema group is core. A published address keeps its original version. A change that alters which files pass needs a new versioned address. A correction at an existing address must not change validation results.

Earlier versions

OpenGDD core v0.7 remains available at its permanent URLs: manifest.schema.json, tuning.schema.json, clocks.schema.json, personalization.schema.json, direction.schema.json, collection.schema.json, and opengdd-build.schema.json.

OpenGDD core v0.6 remains available at its permanent URLs: manifest.schema.json, tuning.schema.json, personalization.schema.json, direction.schema.json, collection.schema.json, and opengdd-build.schema.json.

OpenGDD core v0.5 remains available at its permanent URLs: manifest.schema.json, direction.schema.json, and opengdd-build.schema.json.

OpenGDD core v0.4 remains available at its permanent URLs: manifest.schema.json, direction.schema.json, and opengdd-build.schema.json.