VNLEWIKIBuild stories. Connect worlds.Deutsch
VNLE Handbook

JSON field reference

Execution and content

format and containerVersion identify the container. execution contains entries and nodes; content contains texts, translations and catalogs. UUIDs connect tables. Do not resolve by display names. JSON does not allow comments: explanations are separate so the sample remains valid JSON.

// Explanation only — not a JSON file
// execution.entries[entryId].nodeRef -> execution.nodes[nodeId]
// node.text.textRef -> content.texts[textId].sourceMessage
// content.translations[locale][textId].message -> translated segments
// dialogue.continuation.nodeRef -> next node
// end -> stop; never keep advancing

story.json

Language switching and missing translations

Store language separately from the current node. On switching, resolve the same textRef again: use the translation for locale if present, otherwise sourceMessage. An absent language table means missing translations. allowEmpty supports intentionally blank text. Evaluate placeholder segments with typed formatting; do not stringify the JSON. Source fingerprints identify stale translations; workflowStatus alone does not establish freshness.

Every definition reachable from the current story export schema. All properties, variants and constraints are included below; “Schema” exposes nested rules too. Extra fields are rejected where additionalProperties is false.

JSON Schema · Draft 2020-12

Capability

FieldType / requiredMeaning / rules
Schema · Capability
{
  "type": "string",
  "pattern": "^[a-z][a-z0-9.-]*$",
  "title": "Capability"
}

ContentAsset

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
mediaTypestring · requiredMIME type of the media content.
relativePathRelativePath · requiredValidated relative asset path; never use as a filesystem path without checks.
contentHashHash · requiredSHA-256 of the referenced media bytes.
displayNamestring · requiredHuman-readable asset display name.
licenseNotestringAsset license note; not automatically legally verified.
widthintegerSee type and schema for structure and valid values.
{"minimum":0,"maximum":2147483647}
heightintegerSee type and schema for structure and valid values.
{"minimum":0,"maximum":2147483647}
byteSizeintegerSee type and schema for structure and valid values.
{"minimum":0,"maximum":2147483647}
originalNamestringSee type and schema for structure and valid values.
Schema · ContentAsset
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "mediaType": {
      "type": "string"
    },
    "relativePath": {
      "$ref": "#/$defs/RelativePath"
    },
    "contentHash": {
      "$ref": "#/$defs/Hash"
    },
    "displayName": {
      "type": "string"
    },
    "licenseNote": {
      "type": "string"
    },
    "width": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "height": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "byteSize": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "originalName": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "mediaType",
    "relativePath",
    "contentHash",
    "displayName"
  ],
  "additionalProperties": false,
  "title": "ContentAsset"
}

ContentCharacter

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
keyKey · requiredStable readable key; IDs remain the technical references.
nameTextRefId · requiredText ID for the localized name.
colorstring · requiredCharacter display color, not a logic value.
{"pattern":"^#[0-9a-fA-F]{6}$"}
defaultPortraitRefIdDefault character portrait asset; omitted from generic export.
emotionsobject · requiredEmotion ID → emotion definition.
{"additionalProperties":{"$ref":"#/$defs/Emotion"}}
emotions[key]EmotionSee type and schema for structure and valid values.
Schema · ContentCharacter
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "key": {
      "$ref": "#/$defs/Key"
    },
    "nameTextRef": {
      "$ref": "#/$defs/Id"
    },
    "color": {
      "type": "string",
      "pattern": "^#[0-9a-fA-F]{6}$"
    },
    "defaultPortraitRef": {
      "$ref": "#/$defs/Id"
    },
    "emotions": {
      "type": "object",
      "propertyNames": {
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "$ref": "#/$defs/Emotion"
      }
    }
  },
  "required": [
    "id",
    "name",
    "key",
    "nameTextRef",
    "color",
    "emotions"
  ],
  "additionalProperties": false,
  "title": "ContentCharacter"
}

ContentCommandDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
keyKey · requiredStable readable key; IDs remain the technical references.
categorystring · requiredCatalog category used to organize the definition.
inputsArray<ParameterDefinition> · requiredNamed typed signature inputs.
outcomesArray<OutcomeDefinition> · requiredNamed possible command outcomes and their contracts/bindings.
{"minItems":1}
descriptionstringAuthored description; not an executable instruction.
Schema · ContentCommandDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "key": {
      "$ref": "#/$defs/Key"
    },
    "category": {
      "type": "string"
    },
    "inputs": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ParameterDefinition"
      }
    },
    "outcomes": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OutcomeDefinition"
      },
      "minItems": 1
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "key",
    "category",
    "inputs",
    "outcomes"
  ],
  "additionalProperties": false,
  "title": "ContentCommandDefinition"
}

ContentItemDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
keyKey · requiredStable readable key; IDs remain the technical references.
nameTextRefId · requiredText ID for the localized name.
descriptionTextRefIdText ID for the localized description.
iconAssetRefIdAsset ID for a catalog icon.
Schema · ContentItemDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "key": {
      "$ref": "#/$defs/Key"
    },
    "nameTextRef": {
      "$ref": "#/$defs/Id"
    },
    "descriptionTextRef": {
      "$ref": "#/$defs/Id"
    },
    "iconAssetRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "id",
    "name",
    "key",
    "nameTextRef"
  ],
  "additionalProperties": false,
  "title": "ContentItemDefinition"
}

ContentLocationDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
keyKey · requiredStable readable key; IDs remain the technical references.
nameTextRefId · requiredText ID for the localized name.
descriptionTextRefIdText ID for the localized description.
previewAssetRefIdAsset ID of a preview resource.
Schema · ContentLocationDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "key": {
      "$ref": "#/$defs/Key"
    },
    "nameTextRef": {
      "$ref": "#/$defs/Id"
    },
    "descriptionTextRef": {
      "$ref": "#/$defs/Id"
    },
    "previewAssetRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "id",
    "name",
    "key",
    "nameTextRef"
  ],
  "additionalProperties": false,
  "title": "ContentLocationDefinition"
}

ContentMinigameDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
keyKey · requiredStable readable key; IDs remain the technical references.
nameTextRefIdText ID for the localized name.
commandRefId · requiredID of the game command to execute.
Schema · ContentMinigameDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "key": {
      "$ref": "#/$defs/Key"
    },
    "nameTextRef": {
      "$ref": "#/$defs/Id"
    },
    "commandRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "id",
    "name",
    "key",
    "commandRef"
  ],
  "additionalProperties": false,
  "title": "ContentMinigameDefinition"
}

ContentQuestDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
keyKey · requiredStable readable key; IDs remain the technical references.
titleTextRefId · requiredText ID of a localized title.
descriptionTextRefIdText ID for the localized description.
objectiveDefinitionsArray<QuestObjective> · requiredQuest objective ID → objective definition.
Schema · ContentQuestDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "key": {
      "$ref": "#/$defs/Key"
    },
    "titleTextRef": {
      "$ref": "#/$defs/Id"
    },
    "descriptionTextRef": {
      "$ref": "#/$defs/Id"
    },
    "objectiveDefinitions": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/QuestObjective"
      }
    }
  },
  "required": [
    "id",
    "name",
    "key",
    "titleTextRef",
    "objectiveDefinitions"
  ],
  "additionalProperties": false,
  "title": "ContentQuestDefinition"
}

ContentTextEntry

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
keyKeyStable readable key; IDs remain the technical references.
categorystring · requiredCatalog category used to organize the definition.
sourceMessageMessage · requiredSource message made from text and placeholder segments.
placeholdersobject · requiredPlaceholder key → type/format definition.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderDefinition"}}
placeholders[key]PlaceholderDefinitionSee type and schema for structure and valid values.
externalUseboolean · requiredMarks text used outside the node graph.
Schema · ContentTextEntry
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "key": {
      "$ref": "#/$defs/Key"
    },
    "category": {
      "type": "string"
    },
    "sourceMessage": {
      "$ref": "#/$defs/Message"
    },
    "placeholders": {
      "type": "object",
      "propertyNames": {
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "$ref": "#/$defs/PlaceholderDefinition"
      }
    },
    "externalUse": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "category",
    "sourceMessage",
    "placeholders",
    "externalUse"
  ],
  "additionalProperties": false,
  "title": "ContentTextEntry"
}

ContentVariableDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
keyKey · requiredStable readable key; IDs remain the technical references.
valueTypeScalarType · requiredExpected value contract, including possible entity types.
defaultValueScalarValue · requiredTyped initial/default value.
descriptionstringAuthored description; not an executable instruction.
Schema · ContentVariableDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "key": {
      "$ref": "#/$defs/Key"
    },
    "valueType": {
      "$ref": "#/$defs/ScalarType"
    },
    "defaultValue": {
      "$ref": "#/$defs/ScalarValue"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "key",
    "valueType",
    "defaultValue"
  ],
  "additionalProperties": false,
  "title": "ContentVariableDefinition"
}

Emotion

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
portraitRefIdPortrait asset for an emotion; omitted from generic export.
Schema · Emotion
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "portraitRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "id",
    "name"
  ],
  "additionalProperties": false,
  "title": "Emotion"
}

EntityType

FieldType / requiredMeaning / rules
Schema · EntityType
{
  "type": "string",
  "enum": [
    "item",
    "quest",
    "location",
    "minigame",
    "asset"
  ],
  "title": "EntityType"
}

EntryRef

FieldType / requiredMeaning / rules
flowRefId · requiredScene/substory ID.
entryRefId · requiredEntry ID inside the specified flow.
Schema · EntryRef
{
  "type": "object",
  "properties": {
    "flowRef": {
      "$ref": "#/$defs/Id"
    },
    "entryRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "flowRef",
    "entryRef"
  ],
  "additionalProperties": false,
  "title": "EntryRef"
}

ExecutableChoiceOption

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
textExecutableTextUse · requiredFor text segments: literal content. For text uses: textRef and bindings.
conditionExecutableConditionCondition evaluated before branching or enabling an option.
effectsArray<ExecutableEffect> · requiredOrdered state effects applied by the action node.
continuationExecutableContinuation · requiredContinuation after the node completes.
Schema · ExecutableChoiceOption
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "text": {
      "$ref": "#/$defs/ExecutableTextUse"
    },
    "condition": {
      "$ref": "#/$defs/ExecutableCondition"
    },
    "effects": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ExecutableEffect"
      }
    },
    "continuation": {
      "$ref": "#/$defs/ExecutableContinuation"
    }
  },
  "required": [
    "id",
    "text",
    "effects",
    "continuation"
  ],
  "additionalProperties": false,
  "title": "ExecutableChoiceOption"
}

ExecutableCondition

FieldType / requiredMeaning / rules
[oneOf 1].kind"compare" · requiredDiscriminator selecting the valid variant.
[oneOf 1].leftExecutableOperand · requiredLeft typed comparison operand.
[oneOf 1].operator"eq" | "ne" | "lt" | "lte" | "gt" | "gte" · requiredComparison/logical operator; allowed values appear in variants.
[oneOf 1].rightExecutableOperand · requiredRight typed comparison operand.
[oneOf 2].kind"all" · requiredDiscriminator selecting the valid variant.
[oneOf 2].childrenArray<ExecutableCondition> · requiredChild conditions in a compound expression.
[oneOf 3].kind"any" · requiredDiscriminator selecting the valid variant.
[oneOf 3].childrenArray<ExecutableCondition> · requiredChild conditions in a compound expression.
[oneOf 4].kind"not" · requiredDiscriminator selecting the valid variant.
[oneOf 4].childExecutableCondition · requiredChild condition for a unary operator.
Schema · ExecutableCondition
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "compare"
        },
        "left": {
          "$ref": "#/$defs/ExecutableOperand"
        },
        "operator": {
          "type": "string",
          "enum": [
            "eq",
            "ne",
            "lt",
            "lte",
            "gt",
            "gte"
          ]
        },
        "right": {
          "$ref": "#/$defs/ExecutableOperand"
        }
      },
      "required": [
        "kind",
        "left",
        "operator",
        "right"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "all"
        },
        "children": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ExecutableCondition"
          }
        }
      },
      "required": [
        "kind",
        "children"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "any"
        },
        "children": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ExecutableCondition"
          }
        }
      },
      "required": [
        "kind",
        "children"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "not"
        },
        "child": {
          "$ref": "#/$defs/ExecutableCondition"
        }
      },
      "required": [
        "kind",
        "child"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ExecutableCondition"
}

ExecutableContinuation

FieldType / requiredMeaning / rules
[oneOf 1].kind"node" · requiredDiscriminator selecting the valid variant.
[oneOf 1].nodeRefId · requiredNext executable node ID.
[oneOf 2].kind"end" · requiredDiscriminator selecting the valid variant.
Schema · ExecutableContinuation
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "node"
        },
        "nodeRef": {
          "$ref": "#/$defs/Id"
        }
      },
      "required": [
        "kind",
        "nodeRef"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "end"
        }
      },
      "required": [
        "kind"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ExecutableContinuation"
}

ExecutableEffect

FieldType / requiredMeaning / rules
[oneOf 1].kind"set" · requiredDiscriminator selecting the valid variant.
[oneOf 1].variableRefId · requiredID of the variable to read or write.
[oneOf 1].valueExecutableOperand · requiredLiteral value; must match the declared type.
[oneOf 2].kind"add" · requiredDiscriminator selecting the valid variant.
[oneOf 2].variableRefId · requiredID of the variable to read or write.
[oneOf 2].valueExecutableOperand · requiredLiteral value; must match the declared type.
[oneOf 3].kind"subtract" · requiredDiscriminator selecting the valid variant.
[oneOf 3].variableRefId · requiredID of the variable to read or write.
[oneOf 3].valueExecutableOperand · requiredLiteral value; must match the declared type.
Schema · ExecutableEffect
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "set"
        },
        "variableRef": {
          "$ref": "#/$defs/Id"
        },
        "value": {
          "$ref": "#/$defs/ExecutableOperand"
        }
      },
      "required": [
        "kind",
        "variableRef",
        "value"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "add"
        },
        "variableRef": {
          "$ref": "#/$defs/Id"
        },
        "value": {
          "$ref": "#/$defs/ExecutableOperand"
        }
      },
      "required": [
        "kind",
        "variableRef",
        "value"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "subtract"
        },
        "variableRef": {
          "$ref": "#/$defs/Id"
        },
        "value": {
          "$ref": "#/$defs/ExecutableOperand"
        }
      },
      "required": [
        "kind",
        "variableRef",
        "value"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ExecutableEffect"
}

ExecutableEmptyChoice

FieldType / requiredMeaning / rules
[oneOf 1].kind"continue" · requiredDiscriminator selecting the valid variant.
[oneOf 1].continuationExecutableContinuation · requiredContinuation after the node completes.
[oneOf 2].kind"fault" · requiredDiscriminator selecting the valid variant.
Schema · ExecutableEmptyChoice
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "continue"
        },
        "continuation": {
          "$ref": "#/$defs/ExecutableContinuation"
        }
      },
      "required": [
        "kind",
        "continuation"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "fault"
        }
      },
      "required": [
        "kind"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ExecutableEmptyChoice"
}

ExecutableNode

FieldType / requiredMeaning / rules
[oneOf 1].idId · requiredStable ID; display names are not keys.
[oneOf 1].flowRefId · requiredScene/substory ID.
[oneOf 1].kind"dialogue" · requiredDiscriminator selecting the valid variant.
[oneOf 1].textExecutableTextUse · requiredFor text segments: literal content. For text uses: textRef and bindings.
[oneOf 1].speakerRefIdSpeaker character ID; absent means no assigned speaker.
[oneOf 1].emotionRefIdSelected character emotion for this dialogue.
[oneOf 1].continuationExecutableContinuation · requiredContinuation after the node completes.
[oneOf 2].idId · requiredStable ID; display names are not keys.
[oneOf 2].flowRefId · requiredScene/substory ID.
[oneOf 2].kind"choice" · requiredDiscriminator selecting the valid variant.
[oneOf 2].optionOrderArray<Id> · requiredOrdered option IDs for presentation.
[oneOf 2].optionsobject · requiredOption ID → option with text, condition and continuation.
{"additionalProperties":{"$ref":"#/$defs/ExecutableChoiceOption"}}
[oneOf 2].options[key]ExecutableChoiceOptionSee type and schema for structure and valid values.
[oneOf 2].whenEmptyExecutableEmptyChoice · requiredBehavior when no choice option is available.
[oneOf 3].idId · requiredStable ID; display names are not keys.
[oneOf 3].flowRefId · requiredScene/substory ID.
[oneOf 3].kind"branch" · requiredDiscriminator selecting the valid variant.
[oneOf 3].conditionExecutableCondition · requiredCondition evaluated before branching or enabling an option.
[oneOf 3].whenTrueExecutableContinuation · requiredContinuation when the condition is true.
[oneOf 3].whenFalseExecutableContinuation · requiredContinuation when the condition is false.
[oneOf 4].idId · requiredStable ID; display names are not keys.
[oneOf 4].flowRefId · requiredScene/substory ID.
[oneOf 4].kind"action" · requiredDiscriminator selecting the valid variant.
[oneOf 4].effectsArray<ExecutableEffect> · requiredOrdered state effects applied by the action node.
[oneOf 4].continuationExecutableContinuation · requiredContinuation after the node completes.
[oneOf 5].idId · requiredStable ID; display names are not keys.
[oneOf 5].flowRefId · requiredScene/substory ID.
[oneOf 5].kind"command" · requiredDiscriminator selecting the valid variant.
[oneOf 5].commandRefId · requiredID of the game command to execute.
[oneOf 5].argumentsobject · requiredNamed argument values passed to the call.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}}
[oneOf 5].arguments[key]ExecutableOperandSee type and schema for structure and valid values.
[oneOf 5].outcomesobject · requiredNamed possible command outcomes and their contracts/bindings.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOutcomeBinding"}}
[oneOf 5].outcomes[key]ExecutableOutcomeBindingSee type and schema for structure and valid values.
[oneOf 6].idId · requiredStable ID; display names are not keys.
[oneOf 6].flowRefId · requiredScene/substory ID.
[oneOf 6].kind"jump" · requiredDiscriminator selecting the valid variant.
[oneOf 6].targetEntryRef · requiredTyped target reference, such as variable or entry; see the variant for its exact shape.
[oneOf 7].idId · requiredStable ID; display names are not keys.
[oneOf 7].flowRefId · requiredScene/substory ID.
[oneOf 7].kind"end" · requiredDiscriminator selecting the valid variant.
[oneOf 8].idId · requiredStable ID; display names are not keys.
[oneOf 8].flowRefId · requiredScene/substory ID.
[oneOf 8].kind"call" · requiredDiscriminator selecting the valid variant.
[oneOf 8].targetEntryRef · requiredTyped target reference, such as variable or entry; see the variant for its exact shape.
[oneOf 8].continuationExecutableContinuation · requiredContinuation after the node completes.
[oneOf 9].idId · requiredStable ID; display names are not keys.
[oneOf 9].flowRefId · requiredScene/substory ID.
[oneOf 9].kind"return" · requiredDiscriminator selecting the valid variant.
Schema · ExecutableNode
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/Id"
        },
        "flowRef": {
          "$ref": "#/$defs/Id"
        },
        "kind": {
          "const": "dialogue"
        },
        "text": {
          "$ref": "#/$defs/ExecutableTextUse"
        },
        "speakerRef": {
          "$ref": "#/$defs/Id"
        },
        "emotionRef": {
          "$ref": "#/$defs/Id"
        },
        "continuation": {
          "$ref": "#/$defs/ExecutableContinuation"
        }
      },
      "required": [
        "id",
        "flowRef",
        "kind",
        "text",
        "continuation"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/Id"
        },
        "flowRef": {
          "$ref": "#/$defs/Id"
        },
        "kind": {
          "const": "choice"
        },
        "optionOrder": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Id"
          },
          "uniqueItems": true
        },
        "options": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ExecutableChoiceOption"
          }
        },
        "whenEmpty": {
          "$ref": "#/$defs/ExecutableEmptyChoice"
        }
      },
      "required": [
        "id",
        "flowRef",
        "kind",
        "optionOrder",
        "options",
        "whenEmpty"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/Id"
        },
        "flowRef": {
          "$ref": "#/$defs/Id"
        },
        "kind": {
          "const": "branch"
        },
        "condition": {
          "$ref": "#/$defs/ExecutableCondition"
        },
        "whenTrue": {
          "$ref": "#/$defs/ExecutableContinuation"
        },
        "whenFalse": {
          "$ref": "#/$defs/ExecutableContinuation"
        }
      },
      "required": [
        "id",
        "flowRef",
        "kind",
        "condition",
        "whenTrue",
        "whenFalse"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/Id"
        },
        "flowRef": {
          "$ref": "#/$defs/Id"
        },
        "kind": {
          "const": "action"
        },
        "effects": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ExecutableEffect"
          }
        },
        "continuation": {
          "$ref": "#/$defs/ExecutableContinuation"
        }
      },
      "required": [
        "id",
        "flowRef",
        "kind",
        "effects",
        "continuation"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/Id"
        },
        "flowRef": {
          "$ref": "#/$defs/Id"
        },
        "kind": {
          "const": "command"
        },
        "commandRef": {
          "$ref": "#/$defs/Id"
        },
        "arguments": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ExecutableOperand"
          }
        },
        "outcomes": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ExecutableOutcomeBinding"
          }
        }
      },
      "required": [
        "id",
        "flowRef",
        "kind",
        "commandRef",
        "arguments",
        "outcomes"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/Id"
        },
        "flowRef": {
          "$ref": "#/$defs/Id"
        },
        "kind": {
          "const": "jump"
        },
        "target": {
          "$ref": "#/$defs/EntryRef"
        }
      },
      "required": [
        "id",
        "flowRef",
        "kind",
        "target"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/Id"
        },
        "flowRef": {
          "$ref": "#/$defs/Id"
        },
        "kind": {
          "const": "end"
        }
      },
      "required": [
        "id",
        "flowRef",
        "kind"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/Id"
        },
        "flowRef": {
          "$ref": "#/$defs/Id"
        },
        "kind": {
          "const": "call"
        },
        "target": {
          "$ref": "#/$defs/EntryRef"
        },
        "continuation": {
          "$ref": "#/$defs/ExecutableContinuation"
        }
      },
      "required": [
        "id",
        "flowRef",
        "kind",
        "target",
        "continuation"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/$defs/Id"
        },
        "flowRef": {
          "$ref": "#/$defs/Id"
        },
        "kind": {
          "const": "return"
        }
      },
      "required": [
        "id",
        "flowRef",
        "kind"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ExecutableNode"
}

ExecutableOperand

FieldType / requiredMeaning / rules
[oneOf 1].kind"literal" · requiredDiscriminator selecting the valid variant.
[oneOf 1].valueTypedValue · requiredLiteral value; must match the declared type.
[oneOf 2].kind"variable" · requiredDiscriminator selecting the valid variant.
[oneOf 2].variableRefId · requiredID of the variable to read or write.
Schema · ExecutableOperand
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "literal"
        },
        "value": {
          "$ref": "#/$defs/TypedValue"
        }
      },
      "required": [
        "kind",
        "value"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "variable"
        },
        "variableRef": {
          "$ref": "#/$defs/Id"
        }
      },
      "required": [
        "kind",
        "variableRef"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ExecutableOperand"
}

ExecutableOutcomeBinding

FieldType / requiredMeaning / rules
resultBindingsobject · requiredCommand result name → destination variable for the returned value.
{"additionalProperties":{"$ref":"#/$defs/Id"}}
resultBindings[key]IdSee type and schema for structure and valid values.
continuationExecutableContinuation · requiredContinuation after the node completes.
Schema · ExecutableOutcomeBinding
{
  "type": "object",
  "properties": {
    "resultBindings": {
      "type": "object",
      "propertyNames": {
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "$ref": "#/$defs/Id"
      }
    },
    "continuation": {
      "$ref": "#/$defs/ExecutableContinuation"
    }
  },
  "required": [
    "resultBindings",
    "continuation"
  ],
  "additionalProperties": false,
  "title": "ExecutableOutcomeBinding"
}

ExecutableStory

FieldType / requiredMeaning / rules
format"vnle.story" · requiredExact format identifier for this data container.
containerVersion1 · requiredStory container integer version; currently 1.
storyBuildIdHash · requiredSHA-256 of canonical execution data; content-only changes do not change it.
executionExecutionContract · requiredTyped execution contract.
contentobject · requiredLanguage and catalog data separate from execution.
{"additionalProperties":false}
content.sourceLocaleLocale · requiredSource locale for texts and fallback.
content.localesArray<Locale> · requiredDeclared export locales including the source locale.
{"minItems":1}
content.fallbackPolicyFallbackPolicy · requiredCurrently source: missing translations use source text.
content.textsobject · requiredText ID → source message, placeholders and metadata.
{"additionalProperties":{"$ref":"#/$defs/ContentTextEntry"}}
content.texts[key]ContentTextEntrySee type and schema for structure and valid values.
content.translationsobject · requiredLocale → text ID → translation; missing entries trigger source fallback.
{"additionalProperties":{"type":"object","propertyNames":{"pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"},"additionalProperties":{"$ref":"#/$defs/Translation"},"minProperties":1}}
content.translations[key]objectSee type and schema for structure and valid values.
content.charactersobject · requiredCharacter ID → character with localized names and emotions.
{"additionalProperties":{"$ref":"#/$defs/ContentCharacter"}}
content.characters[key]ContentCharacterSee type and schema for structure and valid values.
content.questsobject · requiredQuest ID → quest definition with objectives.
{"additionalProperties":{"$ref":"#/$defs/ContentQuestDefinition"}}
content.quests[key]ContentQuestDefinitionSee type and schema for structure and valid values.
content.itemsobject · requiredItem ID → item definition.
{"additionalProperties":{"$ref":"#/$defs/ContentItemDefinition"}}
content.items[key]ContentItemDefinitionSee type and schema for structure and valid values.
content.locationsobject · requiredLocation ID → location definition.
{"additionalProperties":{"$ref":"#/$defs/ContentLocationDefinition"}}
content.locations[key]ContentLocationDefinitionSee type and schema for structure and valid values.
content.minigamesobject · requiredMinigame ID → definition; gameplay is implemented by the host.
{"additionalProperties":{"$ref":"#/$defs/ContentMinigameDefinition"}}
content.minigames[key]ContentMinigameDefinitionSee type and schema for structure and valid values.
content.assetsobject · requiredAsset ID → media definition; generic export currently provides no resolved engine assets.
{"additionalProperties":{"$ref":"#/$defs/ContentAsset"}}
content.assets[key]ContentAssetSee type and schema for structure and valid values.
content.variableDefinitionsobject · requiredAuthored variable definitions with names and text references.
{"additionalProperties":{"$ref":"#/$defs/ContentVariableDefinition"}}
content.variableDefinitions[key]ContentVariableDefinitionSee type and schema for structure and valid values.
content.commandDefinitionsobject · requiredAuthored command definitions including text references.
{"additionalProperties":{"$ref":"#/$defs/ContentCommandDefinition"}}
content.commandDefinitions[key]ContentCommandDefinitionSee type and schema for structure and valid values.
Schema · ExecutableStory
{
  "type": "object",
  "properties": {
    "format": {
      "const": "vnle.story"
    },
    "containerVersion": {
      "const": 1
    },
    "storyBuildId": {
      "$ref": "#/$defs/Hash"
    },
    "execution": {
      "$ref": "#/$defs/ExecutionContract"
    },
    "content": {
      "type": "object",
      "properties": {
        "sourceLocale": {
          "$ref": "#/$defs/Locale"
        },
        "locales": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Locale"
          },
          "minItems": 1,
          "uniqueItems": true
        },
        "fallbackPolicy": {
          "$ref": "#/$defs/FallbackPolicy"
        },
        "texts": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ContentTextEntry"
          }
        },
        "translations": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$"
          },
          "additionalProperties": {
            "type": "object",
            "propertyNames": {
              "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
            },
            "additionalProperties": {
              "$ref": "#/$defs/Translation"
            },
            "minProperties": 1
          }
        },
        "characters": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ContentCharacter"
          }
        },
        "quests": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ContentQuestDefinition"
          }
        },
        "items": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ContentItemDefinition"
          }
        },
        "locations": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ContentLocationDefinition"
          }
        },
        "minigames": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ContentMinigameDefinition"
          }
        },
        "assets": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ContentAsset"
          }
        },
        "variableDefinitions": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ContentVariableDefinition"
          }
        },
        "commandDefinitions": {
          "type": "object",
          "propertyNames": {
            "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
          },
          "additionalProperties": {
            "$ref": "#/$defs/ContentCommandDefinition"
          }
        }
      },
      "required": [
        "sourceLocale",
        "locales",
        "fallbackPolicy",
        "texts",
        "translations",
        "characters",
        "quests",
        "items",
        "locations",
        "minigames",
        "assets",
        "variableDefinitions",
        "commandDefinitions"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "format",
    "containerVersion",
    "storyBuildId",
    "execution",
    "content"
  ],
  "additionalProperties": false,
  "title": "ExecutableStory"
}

ExecutableTextUse

FieldType / requiredMeaning / rules
textRefId · requiredReference to content.texts and its text contract.
bindingsobject · requiredPlaceholder/parameter name → typed operand.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}}
bindings[key]ExecutableOperandSee type and schema for structure and valid values.
Schema · ExecutableTextUse
{
  "type": "object",
  "properties": {
    "textRef": {
      "$ref": "#/$defs/Id"
    },
    "bindings": {
      "type": "object",
      "propertyNames": {
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "$ref": "#/$defs/ExecutableOperand"
      }
    }
  },
  "required": [
    "textRef",
    "bindings"
  ],
  "additionalProperties": false,
  "title": "ExecutableTextUse"
}

ExecutionContract

FieldType / requiredMeaning / rules
format"vnle.execution" · requiredExact format identifier for this data container.
contractVersionRuntimeVersion · requiredExecution compatibility version: major and minor.
projectIdId · requiredStable ID of the source project.
requiredCapabilitiesArray<Capability> · requiredCapabilities a full runtime adapter must check before starting.
limitsobject · requiredLimits for automatic execution and recursion.
{"additionalProperties":false}
limits.maxAutomaticTransitions1000 · requiredMaximum automatic transitions without user input.
limits.maxConditionDepth32 · requiredMaximum condition nesting depth.
limits.maxConditionTerms1024 · requiredMaximum number of condition terms.
limits.maxCallDepth32 · requiredMaximum nested substory call depth.
entriesobject · requiredEntry ID → flow and node reference.
{"additionalProperties":{"$ref":"#/$defs/RuntimeEntry"}}
entries[key]RuntimeEntrySee type and schema for structure and valid values.
nodesobject · requiredNode ID → executable node; kind determines its fields.
{"additionalProperties":{"$ref":"#/$defs/ExecutableNode"}}
nodes[key]ExecutableNodeSee type and schema for structure and valid values.
variablesobject · requiredVariable ID → typed runtime variable definition.
{"additionalProperties":{"$ref":"#/$defs/RuntimeVariable"}}
variables[key]RuntimeVariableSee type and schema for structure and valid values.
commandsobject · requiredCommand ID → typed runtime signature.
{"additionalProperties":{"$ref":"#/$defs/RuntimeSignature"}}
commands[key]RuntimeSignatureSee type and schema for structure and valid values.
textContractsobject · requiredText ID → placeholder contracts required by execution.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderContract"}}
textContracts[key]PlaceholderContractSee type and schema for structure and valid values.
Schema · ExecutionContract
{
  "type": "object",
  "properties": {
    "format": {
      "const": "vnle.execution"
    },
    "contractVersion": {
      "$ref": "#/$defs/RuntimeVersion"
    },
    "projectId": {
      "$ref": "#/$defs/Id"
    },
    "requiredCapabilities": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Capability"
      },
      "uniqueItems": true
    },
    "limits": {
      "type": "object",
      "properties": {
        "maxAutomaticTransitions": {
          "const": 1000
        },
        "maxConditionDepth": {
          "const": 32
        },
        "maxConditionTerms": {
          "const": 1024
        },
        "maxCallDepth": {
          "const": 32
        }
      },
      "required": [
        "maxAutomaticTransitions",
        "maxConditionDepth",
        "maxConditionTerms",
        "maxCallDepth"
      ],
      "additionalProperties": false
    },
    "entries": {
      "type": "object",
      "propertyNames": {
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "$ref": "#/$defs/RuntimeEntry"
      }
    },
    "nodes": {
      "type": "object",
      "propertyNames": {
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "$ref": "#/$defs/ExecutableNode"
      }
    },
    "variables": {
      "type": "object",
      "propertyNames": {
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "$ref": "#/$defs/RuntimeVariable"
      }
    },
    "commands": {
      "type": "object",
      "propertyNames": {
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "$ref": "#/$defs/RuntimeSignature"
      }
    },
    "textContracts": {
      "type": "object",
      "propertyNames": {
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "additionalProperties": {
        "$ref": "#/$defs/PlaceholderContract"
      }
    }
  },
  "required": [
    "format",
    "contractVersion",
    "projectId",
    "requiredCapabilities",
    "limits",
    "entries",
    "nodes",
    "variables",
    "commands",
    "textContracts"
  ],
  "additionalProperties": false,
  "title": "ExecutionContract"
}

FallbackPolicy

FieldType / requiredMeaning / rules
Schema · FallbackPolicy
{
  "type": "string",
  "enum": [
    "block",
    "source"
  ],
  "title": "FallbackPolicy"
}

Hash

FieldType / requiredMeaning / rules
Schema · Hash
{
  "type": "string",
  "pattern": "^sha256:[0-9a-f]{64}$",
  "title": "Hash"
}

Id

FieldType / requiredMeaning / rules
Schema · Id
{
  "type": "string",
  "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
  "title": "Id"
}

Key

FieldType / requiredMeaning / rules
Schema · Key
{
  "type": "string",
  "pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,127}$",
  "title": "Key"
}

Locale

FieldType / requiredMeaning / rules
Schema · Locale
{
  "type": "string",
  "pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$",
  "title": "Locale"
}

Message

FieldType / requiredMeaning / rules
kind"segments" · requiredDiscriminator selecting the valid variant.
segmentsArray<object | object> · requiredOrdered text and placeholder message segments.
Schema · Message
{
  "type": "object",
  "properties": {
    "kind": {
      "const": "segments"
    },
    "segments": {
      "type": "array",
      "items": {
        "oneOf": [
          {
            "type": "object",
            "properties": {
              "kind": {
                "const": "text"
              },
              "text": {
                "type": "string"
              }
            },
            "required": [
              "kind",
              "text"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "kind": {
                "const": "placeholder"
              },
              "placeholderRef": {
                "$ref": "#/$defs/Id"
              }
            },
            "required": [
              "kind",
              "placeholderRef"
            ],
            "additionalProperties": false
          }
        ]
      }
    }
  },
  "required": [
    "kind",
    "segments"
  ],
  "additionalProperties": false,
  "title": "Message"
}

OutcomeDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
resultsArray<ResultDefinition> · requiredNamed typed result values of an outcome.
Schema · OutcomeDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ResultDefinition"
      }
    }
  },
  "required": [
    "id",
    "name",
    "results"
  ],
  "additionalProperties": false,
  "title": "OutcomeDefinition"
}

ParameterDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
valueTypeValueType · requiredExpected value contract, including possible entity types.
defaultValueTypedValueTyped initial/default value.
Schema · ParameterDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "valueType": {
      "$ref": "#/$defs/ValueType"
    },
    "defaultValue": {
      "$ref": "#/$defs/TypedValue"
    }
  },
  "required": [
    "id",
    "name",
    "valueType"
  ],
  "additionalProperties": false,
  "title": "ParameterDefinition"
}

PlaceholderContract

FieldType / requiredMeaning / rules
map[key]ScalarTypeSee type and schema for structure and valid values.
Schema · PlaceholderContract
{
  "type": "object",
  "propertyNames": {
    "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
  },
  "additionalProperties": {
    "$ref": "#/$defs/ScalarType"
  },
  "title": "PlaceholderContract"
}

PlaceholderDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
displayNamestring · requiredHuman-readable asset display name.
valueTypeScalarType · requiredExpected value contract, including possible entity types.
Schema · PlaceholderDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "displayName": {
      "type": "string"
    },
    "valueType": {
      "$ref": "#/$defs/ScalarType"
    }
  },
  "required": [
    "id",
    "displayName",
    "valueType"
  ],
  "additionalProperties": false,
  "title": "PlaceholderDefinition"
}

QuestObjective

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
labelTextRefId · requiredText ID of the localized label.
descriptionTextRefIdText ID for the localized description.
Schema · QuestObjective
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "labelTextRef": {
      "$ref": "#/$defs/Id"
    },
    "descriptionTextRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "id",
    "labelTextRef"
  ],
  "additionalProperties": false,
  "title": "QuestObjective"
}

RelativePath

FieldType / requiredMeaning / rules
Schema · RelativePath
{
  "type": "string",
  "minLength": 1,
  "maxLength": 1024,
  "title": "RelativePath"
}

ResultDefinition

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
namestring · requiredAuthored name; do not use as a reference key.
valueTypeValueType · requiredExpected value contract, including possible entity types.
Schema · ResultDefinition
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "name": {
      "type": "string"
    },
    "valueType": {
      "$ref": "#/$defs/ValueType"
    }
  },
  "required": [
    "id",
    "name",
    "valueType"
  ],
  "additionalProperties": false,
  "title": "ResultDefinition"
}

RuntimeEntry

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
flowRefId · requiredScene/substory ID.
nodeRefId · requiredNext executable node ID.
Schema · RuntimeEntry
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "flowRef": {
      "$ref": "#/$defs/Id"
    },
    "nodeRef": {
      "$ref": "#/$defs/Id"
    }
  },
  "required": [
    "id",
    "flowRef",
    "nodeRef"
  ],
  "additionalProperties": false,
  "title": "RuntimeEntry"
}

RuntimeSignature

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
inputsArray<object> · requiredNamed typed signature inputs.
outcomesArray<object> · requiredNamed possible command outcomes and their contracts/bindings.
{"minItems":1}
Schema · RuntimeSignature
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "inputs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/$defs/Id"
          },
          "valueType": {
            "$ref": "#/$defs/ValueType"
          },
          "defaultValue": {
            "$ref": "#/$defs/TypedValue"
          }
        },
        "required": [
          "id",
          "valueType"
        ],
        "additionalProperties": false
      }
    },
    "outcomes": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "$ref": "#/$defs/Id"
          },
          "results": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "$ref": "#/$defs/Id"
                },
                "valueType": {
                  "$ref": "#/$defs/ValueType"
                }
              },
              "required": [
                "id",
                "valueType"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "id",
          "results"
        ],
        "additionalProperties": false
      },
      "minItems": 1
    }
  },
  "required": [
    "id",
    "inputs",
    "outcomes"
  ],
  "additionalProperties": false,
  "title": "RuntimeSignature"
}

RuntimeVariable

FieldType / requiredMeaning / rules
idId · requiredStable ID; display names are not keys.
valueTypeScalarType · requiredExpected value contract, including possible entity types.
defaultValueScalarValue · requiredTyped initial/default value.
Schema · RuntimeVariable
{
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/$defs/Id"
    },
    "valueType": {
      "$ref": "#/$defs/ScalarType"
    },
    "defaultValue": {
      "$ref": "#/$defs/ScalarValue"
    }
  },
  "required": [
    "id",
    "valueType",
    "defaultValue"
  ],
  "additionalProperties": false,
  "title": "RuntimeVariable"
}

RuntimeVersion

FieldType / requiredMeaning / rules
major1 · requiredIncompatible major version; reject unsupported versions.
minor1 · requiredExtension version within the major version.
Schema · RuntimeVersion
{
  "type": "object",
  "properties": {
    "major": {
      "const": 1
    },
    "minor": {
      "const": 1
    }
  },
  "required": [
    "major",
    "minor"
  ],
  "additionalProperties": false,
  "title": "RuntimeVersion"
}

ScalarType

FieldType / requiredMeaning / rules
Schema · ScalarType
{
  "type": "string",
  "enum": [
    "boolean",
    "integer",
    "string"
  ],
  "title": "ScalarType"
}

ScalarValue

FieldType / requiredMeaning / rules
[oneOf 1].type"boolean" · requiredType discriminator; allowed values depend on the surrounding schema.
[oneOf 1].valueboolean · requiredLiteral value; must match the declared type.
[oneOf 2].type"integer" · requiredType discriminator; allowed values depend on the surrounding schema.
[oneOf 2].valueinteger · requiredLiteral value; must match the declared type.
{"minimum":-2147483648,"maximum":2147483647}
[oneOf 3].type"string" · requiredType discriminator; allowed values depend on the surrounding schema.
[oneOf 3].valuestring · requiredLiteral value; must match the declared type.
Schema · ScalarValue
{
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "type": {
          "const": "boolean"
        },
        "value": {
          "type": "boolean"
        }
      },
      "required": [
        "type",
        "value"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "const": "integer"
        },
        "value": {
          "type": "integer",
          "minimum": -2147483648,
          "maximum": 2147483647
        }
      },
      "required": [
        "type",
        "value"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "const": "string"
        },
        "value": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "value"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ScalarValue"
}

Translation

FieldType / requiredMeaning / rules
textRefId · requiredReference to content.texts and its text contract.
localeLocale · requiredLocale code for this translation entry.
messageMessage · requiredTranslated message respecting the placeholder contract.
allowEmptyboolean · requiredPermit an intentionally empty translation.
workflowStatus"draft" | "translated" | "reviewed" · requiredTranslation workflow status, not a runtime branch.
basedOnSourceFingerprintHash · requiredSource basis used by this translation; a mismatch means stale.
reviewedContextFingerprintHashContext fingerprint for the reviewed translation state.
Schema · Translation
{
  "type": "object",
  "properties": {
    "textRef": {
      "$ref": "#/$defs/Id"
    },
    "locale": {
      "$ref": "#/$defs/Locale"
    },
    "message": {
      "$ref": "#/$defs/Message"
    },
    "allowEmpty": {
      "type": "boolean"
    },
    "workflowStatus": {
      "type": "string",
      "enum": [
        "draft",
        "translated",
        "reviewed"
      ]
    },
    "basedOnSourceFingerprint": {
      "$ref": "#/$defs/Hash"
    },
    "reviewedContextFingerprint": {
      "$ref": "#/$defs/Hash"
    }
  },
  "required": [
    "textRef",
    "locale",
    "message",
    "allowEmpty",
    "workflowStatus",
    "basedOnSourceFingerprint"
  ],
  "additionalProperties": false,
  "title": "Translation"
}

TypedValue

FieldType / requiredMeaning / rules
[oneOf 2].type"reference" · requiredType discriminator; allowed values depend on the surrounding schema.
[oneOf 2].entityTypeEntityType · requiredCatalog type for an entity reference.
[oneOf 2].valueId · requiredLiteral value; must match the declared type.
Schema · TypedValue
{
  "oneOf": [
    {
      "$ref": "#/$defs/ScalarValue"
    },
    {
      "type": "object",
      "properties": {
        "type": {
          "const": "reference"
        },
        "entityType": {
          "$ref": "#/$defs/EntityType"
        },
        "value": {
          "$ref": "#/$defs/Id"
        }
      },
      "required": [
        "type",
        "entityType",
        "value"
      ],
      "additionalProperties": false
    }
  ],
  "title": "TypedValue"
}

ValueType

FieldType / requiredMeaning / rules
[oneOf 2].kind"reference" · requiredDiscriminator selecting the valid variant.
[oneOf 2].entityTypeEntityType · requiredCatalog type for an entity reference.
Schema · ValueType
{
  "oneOf": [
    {
      "$ref": "#/$defs/ScalarType"
    },
    {
      "type": "object",
      "properties": {
        "kind": {
          "const": "reference"
        },
        "entityType": {
          "$ref": "#/$defs/EntityType"
        }
      },
      "required": [
        "kind",
        "entityType"
      ],
      "additionalProperties": false
    }
  ],
  "title": "ValueType"
}