@ue-shed/protocol 0.5.0 → 0.6.0

package/contracts/niagara/preview/v1/common.schema.json

@@ -9,18 +9,69 @@
 		"systemObjectPath": {
 			"type": "string",
 			"maxLength": 1024,
-			"pattern": "^/[A-Za-z0-9_]+/[A-Za-z0-9_./-]+\\.[A-Za-z0-9_]+$"
+			"pattern": "^/[A-Za-z0-9_]+/[A-Za-z0-9_./-]+\\.[A-Za-z0-9_-]+$"
 		},
 		"settings": {
 			"type": "object",
 			"properties": {
-				"captureMode": { "enum": ["component_only", "full_scene"] },
-				"durationSeconds": { "type": "number", "minimum": 0.001, "maximum": 600 },
-				"frameCount": { "type": "integer", "minimum": 1, "maximum": 512 },
-				"height": { "type": "integer", "minimum": 1, "maximum": 4096 },
-				"simulationFramesPerSecond": { "type": "integer", "minimum": 1, "maximum": 480 },
-				"startSeconds": { "type": "number", "minimum": 0, "maximum": 3600 },
-				"width": { "type": "integer", "minimum": 1, "maximum": 4096 }
+				"captureMode": {
+					"enum": ["component_only", "full_scene"]
+				},
+				"durationSeconds": {
+					"type": "number",
+					"minimum": 0.001,
+					"maximum": 600
+				},
+				"frameCount": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 512
+				},
+				"height": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 4096
+				},
+				"simulationFramesPerSecond": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 480
+				},
+				"startSeconds": {
+					"type": "number",
+					"minimum": 0,
+					"maximum": 3600
+				},
+				"width": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 4096
+				},
+				"renderMode": {
+					"enum": ["transparent", "scene"]
+				},
+				"cameraMode": {
+					"enum": ["saved", "auto_fit"]
+				},
+				"sceneProfile": {
+					"enum": ["ground_impact", "projectile", "aura", "environment"]
+				},
+				"exposureCompensation": {
+					"type": "number",
+					"minimum": -8,
+					"maximum": 8
+				},
+				"cameraPadding": {
+					"type": "number",
+					"minimum": 1.05,
+					"maximum": 3
+				},
+				"background": {
+					"enum": ["default", "dark", "light"]
+				},
+				"cameraOverride": {
+					"$ref": "#/$defs/cameraOverride"
+				}
 			},
 			"additionalProperties": false
 		},
@@ -38,15 +89,72 @@
 				"width"
 			],
 			"properties": {
-				"captureMode": { "enum": ["component_only", "full_scene"] },
-				"durationSeconds": { "type": "number", "minimum": 0.001, "maximum": 600 },
-				"frameCount": { "type": "integer", "minimum": 1, "maximum": 512 },
-				"frameIntervalSeconds": { "type": "number", "exclusiveMinimum": 0 },
-				"height": { "type": "integer", "minimum": 1, "maximum": 4096 },
-				"playbackFramesPerSecond": { "type": "number", "exclusiveMinimum": 0 },
-				"simulationFramesPerSecond": { "type": "integer", "minimum": 1, "maximum": 480 },
-				"startSeconds": { "type": "number", "minimum": 0, "maximum": 3600 },
-				"width": { "type": "integer", "minimum": 1, "maximum": 4096 }
+				"captureMode": {
+					"enum": ["component_only", "full_scene"]
+				},
+				"durationSeconds": {
+					"type": "number",
+					"minimum": 0.001,
+					"maximum": 600
+				},
+				"frameCount": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 512
+				},
+				"frameIntervalSeconds": {
+					"type": "number",
+					"exclusiveMinimum": 0
+				},
+				"height": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 4096
+				},
+				"playbackFramesPerSecond": {
+					"type": "number",
+					"exclusiveMinimum": 0
+				},
+				"simulationFramesPerSecond": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 480
+				},
+				"startSeconds": {
+					"type": "number",
+					"minimum": 0,
+					"maximum": 3600
+				},
+				"width": {
+					"type": "integer",
+					"minimum": 1,
+					"maximum": 4096
+				},
+				"renderMode": {
+					"enum": ["transparent", "scene"]
+				},
+				"cameraMode": {
+					"enum": ["saved", "auto_fit"]
+				},
+				"sceneProfile": {
+					"enum": ["ground_impact", "projectile", "aura", "environment"]
+				},
+				"exposureCompensation": {
+					"type": "number",
+					"minimum": -8,
+					"maximum": 8
+				},
+				"cameraPadding": {
+					"type": "number",
+					"minimum": 1.05,
+					"maximum": 3
+				},
+				"background": {
+					"enum": ["default", "dark", "light"]
+				},
+				"cameraOverride": {
+					"$ref": "#/$defs/cameraOverride"
+				}
 			},
 			"additionalProperties": false
 		},
@@ -62,13 +170,31 @@
 				"usesCustomAspectRatio"
 			],
 			"properties": {
-				"aspectRatio": { "type": "number", "exclusiveMinimum": 0 },
-				"fieldOfViewDegrees": { "type": "number", "minimum": 0, "maximum": 180 },
-				"location": { "$ref": "#/$defs/vector" },
-				"orthoWidth": { "type": "number", "minimum": 0 },
-				"projection": { "enum": ["orthographic", "perspective"] },
-				"rotation": { "$ref": "#/$defs/rotator" },
-				"usesCustomAspectRatio": { "type": "boolean" }
+				"aspectRatio": {
+					"type": "number",
+					"exclusiveMinimum": 0
+				},
+				"fieldOfViewDegrees": {
+					"type": "number",
+					"minimum": 0,
+					"maximum": 180
+				},
+				"location": {
+					"$ref": "#/$defs/vector"
+				},
+				"orthoWidth": {
+					"type": "number",
+					"minimum": 0
+				},
+				"projection": {
+					"enum": ["orthographic", "perspective"]
+				},
+				"rotation": {
+					"$ref": "#/$defs/rotator"
+				},
+				"usesCustomAspectRatio": {
+					"type": "boolean"
+				}
 			},
 			"additionalProperties": false
 		},
@@ -76,9 +202,15 @@
 			"type": "object",
 			"required": ["x", "y", "z"],
 			"properties": {
-				"x": { "type": "number" },
-				"y": { "type": "number" },
-				"z": { "type": "number" }
+				"x": {
+					"type": "number"
+				},
+				"y": {
+					"type": "number"
+				},
+				"z": {
+					"type": "number"
+				}
 			},
 			"additionalProperties": false
 		},
@@ -86,9 +218,71 @@
 			"type": "object",
 			"required": ["pitch", "roll", "yaw"],
 			"properties": {
-				"pitch": { "type": "number" },
-				"roll": { "type": "number" },
-				"yaw": { "type": "number" }
+				"pitch": {
+					"type": "number"
+				},
+				"roll": {
+					"type": "number"
+				},
+				"yaw": {
+					"type": "number"
+				}
+			},
+			"additionalProperties": false
+		},
+		"cameraOverride": {
+			"type": "object",
+			"required": ["location", "rotation", "fieldOfViewDegrees"],
+			"properties": {
+				"location": {
+					"type": "object",
+					"required": ["x", "y", "z"],
+					"properties": {
+						"x": {
+							"type": "number",
+							"minimum": -1000000000000,
+							"maximum": 1000000000000
+						},
+						"y": {
+							"type": "number",
+							"minimum": -1000000000000,
+							"maximum": 1000000000000
+						},
+						"z": {
+							"type": "number",
+							"minimum": -1000000000000,
+							"maximum": 1000000000000
+						}
+					},
+					"additionalProperties": false
+				},
+				"rotation": {
+					"type": "object",
+					"required": ["pitch", "yaw", "roll"],
+					"properties": {
+						"pitch": {
+							"type": "number",
+							"minimum": -1000000000000,
+							"maximum": 1000000000000
+						},
+						"yaw": {
+							"type": "number",
+							"minimum": -1000000000000,
+							"maximum": 1000000000000
+						},
+						"roll": {
+							"type": "number",
+							"minimum": -1000000000000,
+							"maximum": 1000000000000
+						}
+					},
+					"additionalProperties": false
+				},
+				"fieldOfViewDegrees": {
+					"type": "number",
+					"minimum": 1,
+					"maximum": 179
+				}
 			},
 			"additionalProperties": false
 		}

package/contracts/niagara/preview/v1/fixtures/background-manifest.json

@@ -0,0 +1,136 @@
+{
+	"alphaPolicy": "opaque_scene_v1",
+	"artifacts": [
+		{
+			"bytes": 128,
+			"height": 64,
+			"index": 0,
+			"maximumRgb": 1,
+			"mimeType": "image/png",
+			"nonTransparentPixelFraction": 1,
+			"relativePath": "frames/frame_0000.png",
+			"sha256": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+			"timeSeconds": 0,
+			"width": 64,
+			"activityScore": 0.1,
+			"edgePixelFraction": 0
+		},
+		{
+			"bytes": 144,
+			"height": 64,
+			"index": 1,
+			"maximumRgb": 0.8,
+			"mimeType": "image/png",
+			"nonTransparentPixelFraction": 1,
+			"relativePath": "frames/frame_0001.png",
+			"sha256": "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+			"timeSeconds": 0.5,
+			"width": 64,
+			"activityScore": 0.1,
+			"edgePixelFraction": 0
+		}
+	],
+	"camera": {
+		"aspectRatio": 1,
+		"fieldOfViewDegrees": 90,
+		"location": {
+			"x": 0,
+			"y": -200,
+			"z": 0
+		},
+		"orthoWidth": 512,
+		"projection": "perspective",
+		"rotation": {
+			"pitch": 0,
+			"roll": 0,
+			"yaw": 0
+		},
+		"usesCustomAspectRatio": false
+	},
+	"colorSpace": "srgb",
+	"contract": {
+		"name": "ue-shed-niagara-preview-run",
+		"version": {
+			"major": 1,
+			"minor": 2
+		}
+	},
+	"diagnostics": [
+		{
+			"code": "missing_material",
+			"message": "2 renderer material slots were unbound at initialization. Inspect renderer assignments and user parameters."
+		}
+	],
+	"effectiveSettings": {
+		"captureMode": "full_scene",
+		"durationSeconds": 1,
+		"frameCount": 2,
+		"frameIntervalSeconds": 0.5,
+		"height": 64,
+		"playbackFramesPerSecond": 2,
+		"simulationFramesPerSecond": 60,
+		"startSeconds": 0,
+		"width": 64,
+		"renderMode": "scene",
+		"cameraMode": "saved",
+		"sceneProfile": "ground_impact",
+		"exposureCompensation": 1,
+		"cameraPadding": 1.2,
+		"background": "light",
+		"cameraOverride": {
+			"location": {
+				"x": 0,
+				"y": -200,
+				"z": 0
+			},
+			"rotation": {
+				"pitch": 0,
+				"roll": 0,
+				"yaw": 0
+			},
+			"fieldOfViewDegrees": 90
+		}
+	},
+	"generatedAtUtc": "2026-08-20T00:00:01.000Z",
+	"producer": {
+		"engineVersion": "5.7.2-0+++UE5+Release-5.7",
+		"receiptContract": {
+			"name": "ue-shed-niagara-preview-receipt",
+			"version": {
+				"major": 1,
+				"minor": 2
+			}
+		}
+	},
+	"requestedSettings": {
+		"captureMode": "full_scene",
+		"durationSeconds": 1,
+		"frameCount": 2,
+		"height": 64,
+		"simulationFramesPerSecond": 60,
+		"startSeconds": 0,
+		"width": 64,
+		"renderMode": "scene",
+		"cameraMode": "saved",
+		"sceneProfile": "ground_impact",
+		"exposureCompensation": 1,
+		"cameraPadding": 1.2,
+		"background": "light",
+		"cameraOverride": {
+			"location": {
+				"x": 0,
+				"y": -200,
+				"z": 0
+			},
+			"rotation": {
+				"pitch": 0,
+				"roll": 0,
+				"yaw": 0
+			},
+			"fieldOfViewDegrees": 90
+		}
+	},
+	"runId": "11111111-1111-4111-8111-111111111111",
+	"status": "complete",
+	"systemObjectPath": "/Game/Fixture/Niagara/NS_Preview.NS_Preview"
+}

package/contracts/niagara/preview/v1/fixtures/background-receipt.json

@@ -0,0 +1,112 @@
+{
+	"missingMaterialCount": 2,
+	"alphaPolicy": "opaque_scene_v1",
+	"camera": {
+		"aspectRatio": 1,
+		"fieldOfViewDegrees": 90,
+		"location": {
+			"x": 0,
+			"y": -200,
+			"z": 0
+		},
+		"orthoWidth": 512,
+		"projection": "perspective",
+		"rotation": {
+			"pitch": 0,
+			"roll": 0,
+			"yaw": 0
+		},
+		"usesCustomAspectRatio": false
+	},
+	"colorSpace": "srgb",
+	"contract": {
+		"name": "ue-shed-niagara-preview-receipt",
+		"version": {
+			"major": 1,
+			"minor": 2
+		}
+	},
+	"effectiveSettings": {
+		"captureMode": "full_scene",
+		"durationSeconds": 1,
+		"frameCount": 2,
+		"frameIntervalSeconds": 0.5,
+		"height": 64,
+		"playbackFramesPerSecond": 2,
+		"simulationFramesPerSecond": 60,
+		"startSeconds": 0,
+		"width": 64,
+		"renderMode": "scene",
+		"cameraMode": "saved",
+		"sceneProfile": "ground_impact",
+		"exposureCompensation": 1,
+		"cameraPadding": 1.2,
+		"background": "light",
+		"cameraOverride": {
+			"location": {
+				"x": 0,
+				"y": -200,
+				"z": 0
+			},
+			"rotation": {
+				"pitch": 0,
+				"roll": 0,
+				"yaw": 0
+			},
+			"fieldOfViewDegrees": 90
+		}
+	},
+	"engineVersion": "5.7.2-0+++UE5+Release-5.7",
+	"frames": [
+		{
+			"index": 0,
+			"maximumRgb": 1,
+			"nonTransparentPixelFraction": 1,
+			"relativePath": "frames/frame_0000.png",
+			"timeSeconds": 0,
+			"activityScore": 0.1,
+			"edgePixelFraction": 0
+		},
+		{
+			"index": 1,
+			"maximumRgb": 0.8,
+			"nonTransparentPixelFraction": 1,
+			"relativePath": "frames/frame_0001.png",
+			"timeSeconds": 0.5,
+			"activityScore": 0.1,
+			"edgePixelFraction": 0
+		}
+	],
+	"generatedAtUtc": "2026-08-20T00:00:00.000Z",
+	"requestedSettings": {
+		"captureMode": "full_scene",
+		"durationSeconds": 1,
+		"frameCount": 2,
+		"height": 64,
+		"simulationFramesPerSecond": 60,
+		"startSeconds": 0,
+		"width": 64,
+		"renderMode": "scene",
+		"cameraMode": "saved",
+		"sceneProfile": "ground_impact",
+		"exposureCompensation": 1,
+		"cameraPadding": 1.2,
+		"background": "light",
+		"cameraOverride": {
+			"location": {
+				"x": 0,
+				"y": -200,
+				"z": 0
+			},
+			"rotation": {
+				"pitch": 0,
+				"roll": 0,
+				"yaw": 0
+			},
+			"fieldOfViewDegrees": 90
+		}
+	},
+	"runId": "11111111-1111-4111-8111-111111111111",
+	"status": "complete",
+	"systemObjectPath": "/Game/Fixture/Niagara/NS_Preview.NS_Preview"
+}

package/contracts/niagara/preview/v1/fixtures/background-request.json

@@ -0,0 +1,39 @@
+{
+	"contract": {
+		"name": "ue-shed-niagara-preview-request",
+		"version": {
+			"major": 1,
+			"minor": 2
+		}
+	},
+	"runId": "11111111-1111-4111-8111-111111111111",
+	"settings": {
+		"captureMode": "full_scene",
+		"durationSeconds": 1,
+		"frameCount": 2,
+		"height": 64,
+		"simulationFramesPerSecond": 60,
+		"startSeconds": 0,
+		"width": 64,
+		"renderMode": "scene",
+		"cameraMode": "saved",
+		"sceneProfile": "ground_impact",
+		"exposureCompensation": 1,
+		"cameraPadding": 1.2,
+		"background": "light",
+		"cameraOverride": {
+			"location": {
+				"x": 0,
+				"y": -200,
+				"z": 0
+			},
+			"rotation": {
+				"pitch": 0,
+				"roll": 0,
+				"yaw": 0
+			},
+			"fieldOfViewDegrees": 90
+		}
+	},
+	"systemObjectPath": "/Game/Fixture/Niagara/NS_Preview.NS_Preview"
+}

package/contracts/niagara/preview/v1/fixtures/progress.json

@@ -0,0 +1,8 @@
+{
+	"schemaVersion": 1,
+	"runId": "00000000-0000-0000-0000-000000000001",
+	"phase": "capturing",
+	"completedFrames": 1,
+	"totalFrames": 4,
+	"elapsedMs": 150
+}

package/contracts/niagara/preview/v1/fixtures/scene-manifest.json

@@ -0,0 +1,108 @@
+{
+	"alphaPolicy": "opaque_scene_v1",
+	"artifacts": [
+		{
+			"bytes": 128,
+			"height": 64,
+			"index": 0,
+			"maximumRgb": 1,
+			"mimeType": "image/png",
+			"nonTransparentPixelFraction": 1,
+			"relativePath": "frames/frame_0000.png",
+			"sha256": "sha256:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
+			"timeSeconds": 0,
+			"width": 64,
+			"activityScore": 0.1,
+			"edgePixelFraction": 0
+		},
+		{
+			"bytes": 144,
+			"height": 64,
+			"index": 1,
+			"maximumRgb": 0.8,
+			"mimeType": "image/png",
+			"nonTransparentPixelFraction": 1,
+			"relativePath": "frames/frame_0001.png",
+			"sha256": "sha256:bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb",
+			"timeSeconds": 0.5,
+			"width": 64,
+			"activityScore": 0.1,
+			"edgePixelFraction": 0
+		}
+	],
+	"camera": {
+		"aspectRatio": 1,
+		"fieldOfViewDegrees": 90,
+		"location": {
+			"x": 0,
+			"y": -200,
+			"z": 0
+		},
+		"orthoWidth": 512,
+		"projection": "perspective",
+		"rotation": {
+			"pitch": 0,
+			"roll": 0,
+			"yaw": 0
+		},
+		"usesCustomAspectRatio": false
+	},
+	"colorSpace": "srgb",
+	"contract": {
+		"name": "ue-shed-niagara-preview-run",
+		"version": {
+			"major": 1,
+			"minor": 1
+		}
+	},
+	"diagnostics": [
+		{
+			"code": "missing_material",
+			"message": "2 renderer material slots were unbound at initialization. Inspect renderer assignments and user parameters."
+		}
+	],
+	"effectiveSettings": {
+		"captureMode": "full_scene",
+		"durationSeconds": 1,
+		"frameCount": 2,
+		"frameIntervalSeconds": 0.5,
+		"height": 64,
+		"playbackFramesPerSecond": 2,
+		"simulationFramesPerSecond": 60,
+		"startSeconds": 0,
+		"width": 64,
+		"renderMode": "scene",
+		"cameraMode": "auto_fit",
+		"sceneProfile": "ground_impact",
+		"exposureCompensation": 1,
+		"cameraPadding": 1.2
+	},
+	"generatedAtUtc": "2026-08-20T00:00:01.000Z",
+	"producer": {
+		"engineVersion": "5.7.2-0+++UE5+Release-5.7",
+		"receiptContract": {
+			"name": "ue-shed-niagara-preview-receipt",
+			"version": {
+				"major": 1,
+				"minor": 1
+			}
+		}
+	},
+	"requestedSettings": {
+		"captureMode": "full_scene",
+		"durationSeconds": 1,
+		"frameCount": 2,
+		"height": 64,
+		"simulationFramesPerSecond": 60,
+		"startSeconds": 0,
+		"width": 64,
+		"renderMode": "scene",
+		"cameraMode": "auto_fit",
+		"sceneProfile": "ground_impact",
+		"exposureCompensation": 1,
+		"cameraPadding": 1.2
+	},
+	"runId": "11111111-1111-4111-8111-111111111111",
+	"status": "complete",
+	"systemObjectPath": "/Game/Fixture/Niagara/NS_Preview.NS_Preview"
+}