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
| Field | Type / required | Meaning / rules |
|---|
Schema · Capability
{
"type": "string",
"pattern": "^[a-z][a-z0-9.-]*$",
"title": "Capability"
}
ContentAsset
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
mediaType | string · required | MIME type of the media content. |
relativePath | RelativePath · required | Validated relative asset path; never use as a filesystem path without checks. |
contentHash | Hash · required | SHA-256 of the referenced media bytes. |
displayName | string · required | Human-readable asset display name. |
licenseNote | string | Asset license note; not automatically legally verified. |
width | integer | See type and schema for structure and valid values.
{"minimum":0,"maximum":2147483647} |
height | integer | See type and schema for structure and valid values.
{"minimum":0,"maximum":2147483647} |
byteSize | integer | See type and schema for structure and valid values.
{"minimum":0,"maximum":2147483647} |
originalName | string | See 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
key | Key · required | Stable readable key; IDs remain the technical references. |
nameTextRef | Id · required | Text ID for the localized name. |
color | string · required | Character display color, not a logic value.
{"pattern":"^#[0-9a-fA-F]{6}$"} |
defaultPortraitRef | Id | Default character portrait asset; omitted from generic export. |
emotions | object · required | Emotion ID → emotion definition.
{"additionalProperties":{"$ref":"#/$defs/Emotion"}} |
emotions[key] | Emotion | See 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
key | Key · required | Stable readable key; IDs remain the technical references. |
category | string · required | Catalog category used to organize the definition. |
inputs | Array<ParameterDefinition> · required | Named typed signature inputs. |
outcomes | Array<OutcomeDefinition> · required | Named possible command outcomes and their contracts/bindings.
{"minItems":1} |
description | string | Authored 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
key | Key · required | Stable readable key; IDs remain the technical references. |
nameTextRef | Id · required | Text ID for the localized name. |
descriptionTextRef | Id | Text ID for the localized description. |
iconAssetRef | Id | Asset 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
key | Key · required | Stable readable key; IDs remain the technical references. |
nameTextRef | Id · required | Text ID for the localized name. |
descriptionTextRef | Id | Text ID for the localized description. |
previewAssetRef | Id | Asset 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
key | Key · required | Stable readable key; IDs remain the technical references. |
nameTextRef | Id | Text ID for the localized name. |
commandRef | Id · required | ID 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
key | Key · required | Stable readable key; IDs remain the technical references. |
titleTextRef | Id · required | Text ID of a localized title. |
descriptionTextRef | Id | Text ID for the localized description. |
objectiveDefinitions | Array<QuestObjective> · required | Quest 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
key | Key | Stable readable key; IDs remain the technical references. |
category | string · required | Catalog category used to organize the definition. |
sourceMessage | Message · required | Source message made from text and placeholder segments. |
placeholders | object · required | Placeholder key → type/format definition.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderDefinition"}} |
placeholders[key] | PlaceholderDefinition | See type and schema for structure and valid values. |
externalUse | boolean · required | Marks 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
key | Key · required | Stable readable key; IDs remain the technical references. |
valueType | ScalarType · required | Expected value contract, including possible entity types. |
defaultValue | ScalarValue · required | Typed initial/default value. |
description | string | Authored 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
portraitRef | Id | Portrait 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
| Field | Type / required | Meaning / rules |
|---|
Schema · EntityType
{
"type": "string",
"enum": [
"item",
"quest",
"location",
"minigame",
"asset"
],
"title": "EntityType"
}
EntryRef
| Field | Type / required | Meaning / rules |
|---|
flowRef | Id · required | Scene/substory ID. |
entryRef | Id · required | Entry 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
text | ExecutableTextUse · required | For text segments: literal content. For text uses: textRef and bindings. |
condition | ExecutableCondition | Condition evaluated before branching or enabling an option. |
effects | Array<ExecutableEffect> · required | Ordered state effects applied by the action node. |
continuation | ExecutableContinuation · required | Continuation 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
| Field | Type / required | Meaning / rules |
|---|
[oneOf 1].kind | "compare" · required | Discriminator selecting the valid variant. |
[oneOf 1].left | ExecutableOperand · required | Left typed comparison operand. |
[oneOf 1].operator | "eq" | "ne" | "lt" | "lte" | "gt" | "gte" · required | Comparison/logical operator; allowed values appear in variants. |
[oneOf 1].right | ExecutableOperand · required | Right typed comparison operand. |
[oneOf 2].kind | "all" · required | Discriminator selecting the valid variant. |
[oneOf 2].children | Array<ExecutableCondition> · required | Child conditions in a compound expression. |
[oneOf 3].kind | "any" · required | Discriminator selecting the valid variant. |
[oneOf 3].children | Array<ExecutableCondition> · required | Child conditions in a compound expression. |
[oneOf 4].kind | "not" · required | Discriminator selecting the valid variant. |
[oneOf 4].child | ExecutableCondition · required | Child 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
| Field | Type / required | Meaning / rules |
|---|
[oneOf 1].kind | "node" · required | Discriminator selecting the valid variant. |
[oneOf 1].nodeRef | Id · required | Next executable node ID. |
[oneOf 2].kind | "end" · required | Discriminator 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
| Field | Type / required | Meaning / rules |
|---|
[oneOf 1].kind | "set" · required | Discriminator selecting the valid variant. |
[oneOf 1].variableRef | Id · required | ID of the variable to read or write. |
[oneOf 1].value | ExecutableOperand · required | Literal value; must match the declared type. |
[oneOf 2].kind | "add" · required | Discriminator selecting the valid variant. |
[oneOf 2].variableRef | Id · required | ID of the variable to read or write. |
[oneOf 2].value | ExecutableOperand · required | Literal value; must match the declared type. |
[oneOf 3].kind | "subtract" · required | Discriminator selecting the valid variant. |
[oneOf 3].variableRef | Id · required | ID of the variable to read or write. |
[oneOf 3].value | ExecutableOperand · required | Literal 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
| Field | Type / required | Meaning / rules |
|---|
[oneOf 1].kind | "continue" · required | Discriminator selecting the valid variant. |
[oneOf 1].continuation | ExecutableContinuation · required | Continuation after the node completes. |
[oneOf 2].kind | "fault" · required | Discriminator 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
| Field | Type / required | Meaning / rules |
|---|
[oneOf 1].id | Id · required | Stable ID; display names are not keys. |
[oneOf 1].flowRef | Id · required | Scene/substory ID. |
[oneOf 1].kind | "dialogue" · required | Discriminator selecting the valid variant. |
[oneOf 1].text | ExecutableTextUse · required | For text segments: literal content. For text uses: textRef and bindings. |
[oneOf 1].speakerRef | Id | Speaker character ID; absent means no assigned speaker. |
[oneOf 1].emotionRef | Id | Selected character emotion for this dialogue. |
[oneOf 1].continuation | ExecutableContinuation · required | Continuation after the node completes. |
[oneOf 2].id | Id · required | Stable ID; display names are not keys. |
[oneOf 2].flowRef | Id · required | Scene/substory ID. |
[oneOf 2].kind | "choice" · required | Discriminator selecting the valid variant. |
[oneOf 2].optionOrder | Array<Id> · required | Ordered option IDs for presentation. |
[oneOf 2].options | object · required | Option ID → option with text, condition and continuation.
{"additionalProperties":{"$ref":"#/$defs/ExecutableChoiceOption"}} |
[oneOf 2].options[key] | ExecutableChoiceOption | See type and schema for structure and valid values. |
[oneOf 2].whenEmpty | ExecutableEmptyChoice · required | Behavior when no choice option is available. |
[oneOf 3].id | Id · required | Stable ID; display names are not keys. |
[oneOf 3].flowRef | Id · required | Scene/substory ID. |
[oneOf 3].kind | "branch" · required | Discriminator selecting the valid variant. |
[oneOf 3].condition | ExecutableCondition · required | Condition evaluated before branching or enabling an option. |
[oneOf 3].whenTrue | ExecutableContinuation · required | Continuation when the condition is true. |
[oneOf 3].whenFalse | ExecutableContinuation · required | Continuation when the condition is false. |
[oneOf 4].id | Id · required | Stable ID; display names are not keys. |
[oneOf 4].flowRef | Id · required | Scene/substory ID. |
[oneOf 4].kind | "action" · required | Discriminator selecting the valid variant. |
[oneOf 4].effects | Array<ExecutableEffect> · required | Ordered state effects applied by the action node. |
[oneOf 4].continuation | ExecutableContinuation · required | Continuation after the node completes. |
[oneOf 5].id | Id · required | Stable ID; display names are not keys. |
[oneOf 5].flowRef | Id · required | Scene/substory ID. |
[oneOf 5].kind | "command" · required | Discriminator selecting the valid variant. |
[oneOf 5].commandRef | Id · required | ID of the game command to execute. |
[oneOf 5].arguments | object · required | Named argument values passed to the call.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}} |
[oneOf 5].arguments[key] | ExecutableOperand | See type and schema for structure and valid values. |
[oneOf 5].outcomes | object · required | Named possible command outcomes and their contracts/bindings.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOutcomeBinding"}} |
[oneOf 5].outcomes[key] | ExecutableOutcomeBinding | See type and schema for structure and valid values. |
[oneOf 6].id | Id · required | Stable ID; display names are not keys. |
[oneOf 6].flowRef | Id · required | Scene/substory ID. |
[oneOf 6].kind | "jump" · required | Discriminator selecting the valid variant. |
[oneOf 6].target | EntryRef · required | Typed target reference, such as variable or entry; see the variant for its exact shape. |
[oneOf 7].id | Id · required | Stable ID; display names are not keys. |
[oneOf 7].flowRef | Id · required | Scene/substory ID. |
[oneOf 7].kind | "end" · required | Discriminator selecting the valid variant. |
[oneOf 8].id | Id · required | Stable ID; display names are not keys. |
[oneOf 8].flowRef | Id · required | Scene/substory ID. |
[oneOf 8].kind | "call" · required | Discriminator selecting the valid variant. |
[oneOf 8].target | EntryRef · required | Typed target reference, such as variable or entry; see the variant for its exact shape. |
[oneOf 8].continuation | ExecutableContinuation · required | Continuation after the node completes. |
[oneOf 9].id | Id · required | Stable ID; display names are not keys. |
[oneOf 9].flowRef | Id · required | Scene/substory ID. |
[oneOf 9].kind | "return" · required | Discriminator 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
| Field | Type / required | Meaning / rules |
|---|
[oneOf 1].kind | "literal" · required | Discriminator selecting the valid variant. |
[oneOf 1].value | TypedValue · required | Literal value; must match the declared type. |
[oneOf 2].kind | "variable" · required | Discriminator selecting the valid variant. |
[oneOf 2].variableRef | Id · required | ID 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
| Field | Type / required | Meaning / rules |
|---|
resultBindings | object · required | Command result name → destination variable for the returned value.
{"additionalProperties":{"$ref":"#/$defs/Id"}} |
resultBindings[key] | Id | See type and schema for structure and valid values. |
continuation | ExecutableContinuation · required | Continuation 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
| Field | Type / required | Meaning / rules |
|---|
format | "vnle.story" · required | Exact format identifier for this data container. |
containerVersion | 1 · required | Story container integer version; currently 1. |
storyBuildId | Hash · required | SHA-256 of canonical execution data; content-only changes do not change it. |
execution | ExecutionContract · required | Typed execution contract. |
content | object · required | Language and catalog data separate from execution.
{"additionalProperties":false} |
content.sourceLocale | Locale · required | Source locale for texts and fallback. |
content.locales | Array<Locale> · required | Declared export locales including the source locale.
{"minItems":1} |
content.fallbackPolicy | FallbackPolicy · required | Currently source: missing translations use source text. |
content.texts | object · required | Text ID → source message, placeholders and metadata.
{"additionalProperties":{"$ref":"#/$defs/ContentTextEntry"}} |
content.texts[key] | ContentTextEntry | See type and schema for structure and valid values. |
content.translations | object · required | Locale → 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] | object | See type and schema for structure and valid values. |
content.characters | object · required | Character ID → character with localized names and emotions.
{"additionalProperties":{"$ref":"#/$defs/ContentCharacter"}} |
content.characters[key] | ContentCharacter | See type and schema for structure and valid values. |
content.quests | object · required | Quest ID → quest definition with objectives.
{"additionalProperties":{"$ref":"#/$defs/ContentQuestDefinition"}} |
content.quests[key] | ContentQuestDefinition | See type and schema for structure and valid values. |
content.items | object · required | Item ID → item definition.
{"additionalProperties":{"$ref":"#/$defs/ContentItemDefinition"}} |
content.items[key] | ContentItemDefinition | See type and schema for structure and valid values. |
content.locations | object · required | Location ID → location definition.
{"additionalProperties":{"$ref":"#/$defs/ContentLocationDefinition"}} |
content.locations[key] | ContentLocationDefinition | See type and schema for structure and valid values. |
content.minigames | object · required | Minigame ID → definition; gameplay is implemented by the host.
{"additionalProperties":{"$ref":"#/$defs/ContentMinigameDefinition"}} |
content.minigames[key] | ContentMinigameDefinition | See type and schema for structure and valid values. |
content.assets | object · required | Asset ID → media definition; generic export currently provides no resolved engine assets.
{"additionalProperties":{"$ref":"#/$defs/ContentAsset"}} |
content.assets[key] | ContentAsset | See type and schema for structure and valid values. |
content.variableDefinitions | object · required | Authored variable definitions with names and text references.
{"additionalProperties":{"$ref":"#/$defs/ContentVariableDefinition"}} |
content.variableDefinitions[key] | ContentVariableDefinition | See type and schema for structure and valid values. |
content.commandDefinitions | object · required | Authored command definitions including text references.
{"additionalProperties":{"$ref":"#/$defs/ContentCommandDefinition"}} |
content.commandDefinitions[key] | ContentCommandDefinition | See 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
| Field | Type / required | Meaning / rules |
|---|
textRef | Id · required | Reference to content.texts and its text contract. |
bindings | object · required | Placeholder/parameter name → typed operand.
{"additionalProperties":{"$ref":"#/$defs/ExecutableOperand"}} |
bindings[key] | ExecutableOperand | See 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
| Field | Type / required | Meaning / rules |
|---|
format | "vnle.execution" · required | Exact format identifier for this data container. |
contractVersion | RuntimeVersion · required | Execution compatibility version: major and minor. |
projectId | Id · required | Stable ID of the source project. |
requiredCapabilities | Array<Capability> · required | Capabilities a full runtime adapter must check before starting. |
limits | object · required | Limits for automatic execution and recursion.
{"additionalProperties":false} |
limits.maxAutomaticTransitions | 1000 · required | Maximum automatic transitions without user input. |
limits.maxConditionDepth | 32 · required | Maximum condition nesting depth. |
limits.maxConditionTerms | 1024 · required | Maximum number of condition terms. |
limits.maxCallDepth | 32 · required | Maximum nested substory call depth. |
entries | object · required | Entry ID → flow and node reference.
{"additionalProperties":{"$ref":"#/$defs/RuntimeEntry"}} |
entries[key] | RuntimeEntry | See type and schema for structure and valid values. |
nodes | object · required | Node ID → executable node; kind determines its fields.
{"additionalProperties":{"$ref":"#/$defs/ExecutableNode"}} |
nodes[key] | ExecutableNode | See type and schema for structure and valid values. |
variables | object · required | Variable ID → typed runtime variable definition.
{"additionalProperties":{"$ref":"#/$defs/RuntimeVariable"}} |
variables[key] | RuntimeVariable | See type and schema for structure and valid values. |
commands | object · required | Command ID → typed runtime signature.
{"additionalProperties":{"$ref":"#/$defs/RuntimeSignature"}} |
commands[key] | RuntimeSignature | See type and schema for structure and valid values. |
textContracts | object · required | Text ID → placeholder contracts required by execution.
{"additionalProperties":{"$ref":"#/$defs/PlaceholderContract"}} |
textContracts[key] | PlaceholderContract | See 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
| Field | Type / required | Meaning / rules |
|---|
Schema · FallbackPolicy
{
"type": "string",
"enum": [
"block",
"source"
],
"title": "FallbackPolicy"
}
Hash
| Field | Type / required | Meaning / rules |
|---|
Schema · Hash
{
"type": "string",
"pattern": "^sha256:[0-9a-f]{64}$",
"title": "Hash"
}
Id
| Field | Type / required | Meaning / 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
| Field | Type / required | Meaning / rules |
|---|
Schema · Key
{
"type": "string",
"pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,127}$",
"title": "Key"
}
Locale
| Field | Type / required | Meaning / rules |
|---|
Schema · Locale
{
"type": "string",
"pattern": "^[A-Za-z]{2,8}(-[A-Za-z0-9]{1,8})*$",
"title": "Locale"
}
Message
| Field | Type / required | Meaning / rules |
|---|
kind | "segments" · required | Discriminator selecting the valid variant. |
segments | Array<object | object> · required | Ordered 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
results | Array<ResultDefinition> · required | Named 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
valueType | ValueType · required | Expected value contract, including possible entity types. |
defaultValue | TypedValue | Typed 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
| Field | Type / required | Meaning / rules |
|---|
map[key] | ScalarType | See 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
displayName | string · required | Human-readable asset display name. |
valueType | ScalarType · required | Expected 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
labelTextRef | Id · required | Text ID of the localized label. |
descriptionTextRef | Id | Text 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
| Field | Type / required | Meaning / rules |
|---|
Schema · RelativePath
{
"type": "string",
"minLength": 1,
"maxLength": 1024,
"title": "RelativePath"
}
ResultDefinition
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
name | string · required | Authored name; do not use as a reference key. |
valueType | ValueType · required | Expected 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
flowRef | Id · required | Scene/substory ID. |
nodeRef | Id · required | Next 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
inputs | Array<object> · required | Named typed signature inputs. |
outcomes | Array<object> · required | Named 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
| Field | Type / required | Meaning / rules |
|---|
id | Id · required | Stable ID; display names are not keys. |
valueType | ScalarType · required | Expected value contract, including possible entity types. |
defaultValue | ScalarValue · required | Typed 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
| Field | Type / required | Meaning / rules |
|---|
major | 1 · required | Incompatible major version; reject unsupported versions. |
minor | 1 · required | Extension version within the major version. |
Schema · RuntimeVersion
{
"type": "object",
"properties": {
"major": {
"const": 1
},
"minor": {
"const": 1
}
},
"required": [
"major",
"minor"
],
"additionalProperties": false,
"title": "RuntimeVersion"
}
ScalarType
| Field | Type / required | Meaning / rules |
|---|
Schema · ScalarType
{
"type": "string",
"enum": [
"boolean",
"integer",
"string"
],
"title": "ScalarType"
}
ScalarValue
| Field | Type / required | Meaning / rules |
|---|
[oneOf 1].type | "boolean" · required | Type discriminator; allowed values depend on the surrounding schema. |
[oneOf 1].value | boolean · required | Literal value; must match the declared type. |
[oneOf 2].type | "integer" · required | Type discriminator; allowed values depend on the surrounding schema. |
[oneOf 2].value | integer · required | Literal value; must match the declared type.
{"minimum":-2147483648,"maximum":2147483647} |
[oneOf 3].type | "string" · required | Type discriminator; allowed values depend on the surrounding schema. |
[oneOf 3].value | string · required | Literal 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
| Field | Type / required | Meaning / rules |
|---|
textRef | Id · required | Reference to content.texts and its text contract. |
locale | Locale · required | Locale code for this translation entry. |
message | Message · required | Translated message respecting the placeholder contract. |
allowEmpty | boolean · required | Permit an intentionally empty translation. |
workflowStatus | "draft" | "translated" | "reviewed" · required | Translation workflow status, not a runtime branch. |
basedOnSourceFingerprint | Hash · required | Source basis used by this translation; a mismatch means stale. |
reviewedContextFingerprint | Hash | Context 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
| Field | Type / required | Meaning / rules |
|---|
[oneOf 2].type | "reference" · required | Type discriminator; allowed values depend on the surrounding schema. |
[oneOf 2].entityType | EntityType · required | Catalog type for an entity reference. |
[oneOf 2].value | Id · required | Literal 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
| Field | Type / required | Meaning / rules |
|---|
[oneOf 2].kind | "reference" · required | Discriminator selecting the valid variant. |
[oneOf 2].entityType | EntityType · required | Catalog 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"
}