IPC protocol 0.8
Schema reference / IPC protocol / 0.8
JSON-RPC 2.0 frames between core and shells, SDK clients and tools: every method’s params and result, notifications, state and errors.
Raw schema
Loading ipc.schema.json…Changes since 0.7
Changelog · 0.5.0 (M3A)
IPC 0.7 publishes the exact shell graphics handoff: discoverable presets/effects, validated sparse
graphics.set, effective settings and asynchronous GPU timings. IPC 0.8 addskeymap.holds(monotonic start time and configured duration) for shell-owned hold animation. Protocols through 0.7 retain their exact shapes; world format remains 0.3. No compositor config reload is involved.
Changelog · World 0.8: placed world objects
- World format 0.8 adds
objectAssets(at most 32) andobjects(at most 256). An asset is a package-relative glTF (scene, same extension rules as the world’s scene.gltf; never lightmapped) with optional declarative node animation (at most 16:spinororbitaboutpivot/axisin asset space, orbobalongaxisbyamplitudemetres;period0.5–3600 s, optionalphase), an optional staticcollisionproxy node andlighting.mode(probedefault, orunlit). Nodes are referenced by unique glTF node name.library(id@version) is reserved for shared object libraries and rejected in 0.8. An object places an asset with apose, uniformscale(0.01–100), animationspeed(0–10, default 1),phase(0–1) and an optionalambientRGB override (0–16).validate('world')(from 0.8): unique asset and object ids, known asset references, normalised poses, unit axes, per-type fields (spin/orbit need a pivot and take no amplitude; bob the reverse), one animation per node, collision node not animated, library references rejected.validate('scene', gltf, undefined, '0.8', {world, asset: id})checks an asset’s glTF: extension rules, referenced node names exist exactly once, no animated node inside another animated subtree, the collision node has a mesh and is outside every animated subtree.v0.8/common.schema.jsonis the 0.7 common definitions under the 0.8$id(the directory already held IPC 0.8, which keeps its own references). Everything else is inherited from 0.7 unchanged. Inheritance test included.
Structural diff against 0.7: 1 entry added, 2 entries changed. Descriptions and $id changes are ignored.
3 changes
- added
inputHolds - changed
keymap- +
holdsinputHolds (required)
- +
- changed
method session.hello- ~
result.protocol"0.7" (required) → "0.8" (required)
- ~
Methods
Each method is a JSON-RPC 2.0 request {jsonrpc, id, method, params} answered by {jsonrpc, id, result} or an error. Params and results are listed below.
session.hellosession.pingstate.subscribestate.snapshotstate.unsubscribeworld.loadsurface.focusmovement.setshell.claimshell.releaseshell.overlayruntime.exitcamera.getcamera.setwaypoint.setwaypoint.clearroute.setroute.cleartravel.starttravel.cancelautodrive.startautodrive.stopui.openui.closedata.publishdata.removeshell.bindworkspace.activateworkspace.bindworkspace.focusworkspace.unfocussurface.pullsurface.placesurface.returnplacements.listplacements.removedata.object.bindatmosphere.getatmosphere.setcamera.fovsurfaces.recallinput.getinput.previewinput.setinput.captureinput.capture.canceloverlay.stylegraphics.getgraphics.set
session.hello#
params · object
| Field | Type | Constraints |
|---|---|---|
protocolsrequired | string[] | items ≥ 1 · unique items · each length 1–256 |
clientrequired | object | |
idrequired | id | |
namerequired | string | length 1–256 |
capabilitiesrequired | capability[] | items ≥ 0 · unique items |
token | string | length 64 · pattern ^[a-f0-9]{64}$ |
result · object
| Field | Type | Constraints |
|---|---|---|
protocolrequired | "0.8" | |
sessionIdrequired | string | length 1–128 |
capabilitiesrequired | capability[] | items ≥ 0 · unique items |
methodsrequired | ("session.hello" | "session.ping" | "state.subscribe" | "state.snapshot" | "state.unsubscribe" | "world.load" | "surface.focus" | "movement.set" | "shell.claim" | "shell.release" | "shell.overlay" | "runtime.exit" | "camera.get" | "camera.set" | … (49 values))[] | items ≥ 0 · unique items |
eventsrequired | ("state.delta" | "runtime.notice" | "session.revoked" | "location.transition" | "ui.opened" | "ui.closed" | "data.updated" | "mounts.changed" | "presentation.changed")[] | items ≥ 0 · unique items |
state.subscribe#
params · object
| Field | Type | Constraints |
|---|---|---|
topicsrequired | ["state"] |
result · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–128 |
snapshotrequired | snapshot |
state.snapshot#
params · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–128 |
result · object
| Field | Type | Constraints |
|---|---|---|
snapshotrequired | snapshot |
state.unsubscribe#
params · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–128 |
result · object
| Field | Type | Constraints |
|---|---|---|
okrequired | true |
surface.focus#
params · object
| Field | Type | Constraints |
|---|---|---|
surfaceIdrequired | string | length 1–128 |
intentrequired | "pointer" | "keyboard" |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | revision |
movement.set#
params · object
| Field | Type | Constraints |
|---|---|---|
modeIdrequired | id |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | revision |
shell.claim#
params · object
| Field | Type | Constraints |
|---|---|---|
outputsrequired | string[] | items ≥ 1 · unique items · each length 1–128 |
result · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length 1–128 |
revisionrequired | revision |
shell.release#
params · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length 1–128 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | revision |
shell.overlay#
params · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length 1–128 |
outputIdrequired | string | length 1–128 |
visiblerequired | boolean | |
exclusiveInputrequired | boolean |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | revision |
camera.get#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
orientationrequired | number[4] |
camera.set#
params · object
| Field | Type | Constraints |
|---|---|---|
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
orientationrequired | number[4] |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
waypoint.set#
params · one of 2
| Field | Type | Constraints |
|---|---|---|
variant 1 | object | |
idrequired | string | length 1–128 |
labelrequired | string | length 1–256 |
targetrequired | target | |
variant 2 | object | |
idrequired | string | length 1–128 |
labelrequired | string | length 1–256 |
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
waypoint.clear#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
route.set#
params · object
| Field | Type | Constraints |
|---|---|---|
pointsrequired | target[] | items 1–64 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
route.clear#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
travel.start#
params · object
| Field | Type | Constraints |
|---|---|---|
torequired | target | |
durationMs | integer | ≥ 0 · ≤ 10000 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
travel.cancel#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
autodrive.start#
params · object
| Field | Type | Constraints |
|---|---|---|
speed | number | ≥ 0.1 · ≤ 10 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
autodrive.stop#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
ui.open#
params · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length 1–128 |
outputIdrequired | string | length 1–128 |
panelrequired | string | length 1–128 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
ui.close#
params · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length 1–128 |
outputIdrequired | string | length 1–128 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
data.publish#
params · object
| Field | Type | Constraints |
|---|---|---|
sourceIdrequired | id | |
valuesrequired | map → number | boolean | string | entries ≤ 32 · keys: length ≤ 128 |
sequencerequired | integer | ≥ 0 · ≤ 2⁵³−1 |
ttlMs | integer | ≥ 100 · ≤ 60000 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
data.remove#
params · object
| Field | Type | Constraints |
|---|---|---|
sourceIdrequired | id |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
shell.bind#
params · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length 1–128 |
pidrequired | integer | ≥ 1 · ≤ 2147483647 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
workspace.activate#
params · object
| Field | Type | Constraints |
|---|---|---|
idrequired | integer | ≥ 1 · ≤ 2147483647 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
workspace.bind#
params · object
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
workspace.focus#
params · object
| Field | Type | Constraints |
|---|---|---|
idrequired | integer | ≥ 1 · ≤ 2147483647 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
workspace.unfocus#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
surface.pull#
params · object
| Field | Type | Constraints |
|---|---|---|
surfaceIdrequired | string | length 1–256 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
surface.place#
params · object
| Field | Type | Constraints |
|---|---|---|
surfaceIdrequired | string | length 1–256 |
anchorId | slug |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
surface.return#
params · object
| Field | Type | Constraints |
|---|---|---|
surfaceIdrequired | string | length 1–256 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
placements.list#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
placementsrequired | any of 2[] | items ≤ 128 |
variant 1 | object | |
worldIdrequired | id | |
areaIdrequired | slug | |
anchorIdrequired | slug | |
rulerequired | object | |
appClassrequired | string | length 1–256 |
titlerequired | string | length ≤ 256 |
when anchorId = "" | object | |
worldIdrequired | id | |
areaIdrequired | slug | |
anchorIdrequired | "" | |
rulerequired | object | |
appClassrequired | string | length 1–256 |
titlerequired | string | length ≤ 256 |
poserequired | pose | |
sizerequired | size2 |
placements.remove#
params · object
| Field | Type | Constraints |
|---|---|---|
worldIdrequired | id | |
areaIdrequired | slug | |
rulerequired | object | |
appClassrequired | string | length 1–256 |
titlerequired | string | length ≤ 256 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
data.object.bind#
params · object
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
atmosphere.get#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
profilerequired | null | atmosphere | |
qualityrequired | "high" | "intel" |
atmosphere.set#
params · object
| Field | Type | Constraints |
|---|---|---|
profilerequired | atmosphere |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
camera.fov#
params · object
| Field | Type | Constraints |
|---|---|---|
degreesrequired | number | ≥ 30 · ≤ 110 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
surfaces.recall#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
input.get#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
configrequired | inputConfig | |
conflictsrequired | inputConflicts | |
stealsrequired | inputSteals | |
pathrequired | string | length ≤ 4096 |
input.preview#
params · object
| Field | Type | Constraints |
|---|---|---|
configrequired | inputConfig |
result · object
| Field | Type | Constraints |
|---|---|---|
configrequired | inputConfig | |
conflictsrequired | inputConflicts | |
stealsrequired | inputSteals |
input.set#
params · object
| Field | Type | Constraints |
|---|---|---|
configrequired | inputConfig |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | revision |
input.capture#
params · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length ≤ 128 |
moderequired | "world" | "interactive" | "focus" | "menu" | |
actionrequired | string | length ≤ 128 |
slotrequired | integer | ≥ 0 · ≤ 2 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | revision |
input.capture.cancel#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | revision |
overlay.style#
params · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length 1–128 |
stylerequired | overlayStylePatch |
result · object
| Field | Type | Constraints |
|---|---|---|
stylerequired | overlayStyle |
graphics.get#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
configrequired | graphicsConfig | |
effectiverequired | graphicsConfig | |
overridesrequired | graphicsPatch | |
pathrequired | string | length ≤ 4096 |
errorrequired | string | |
presetsrequired | map → graphicsPatch | |
optionsrequired | map → any[] | |
unsupportedrequired | ("ssr" | "runtime_shadows" | "contact_shadows")[] | |
timingsrequired | object | Extensible diagnostic measurements; GPU timings can be null when unavailable. |
graphics.set#
params · object
| Field | Type | Constraints |
|---|---|---|
patchrequired | graphicsPatch |
result · object
| Field | Type | Constraints |
|---|---|---|
configrequired | graphicsConfig | |
effectiverequired | graphicsConfig | |
overridesrequired | graphicsPatch | |
pathrequired | string | length ≤ 4096 |
errorrequired | string | |
presetsrequired | map → graphicsPatch | |
optionsrequired | map → any[] | |
unsupportedrequired | ("ssr" | "runtime_shadows" | "contact_shadows")[] | |
timingsrequired | object | Extensible diagnostic measurements; GPU timings can be null when unavailable. |
Notifications
state.deltaruntime.noticesession.revokedlocation.transitionui.openedui.closeddata.updatedmounts.changedpresentation.changed
state.delta#
params · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–128 |
sessionIdrequired | string | length 1–128 |
baseRevisionrequired | revision | |
revisionrequired | revision | |
changesrequired | object | entries ≥ 1 |
runtime | object | |
activerequired | boolean | |
outputsrequired | string[] | items ≥ 0 · unique items · each length 1–128 |
world | any of 2 | |
variant 1 | null | |
variant 2 | object | |
idrequired | id | |
spawnIdrequired | slug | |
surfaces | object[] | items ≥ 0 |
idrequired | string | length 1–128 |
kindrequired | "window" | "workspace" | "layer" | "web" | "custom" | |
titlerequired | string | length 0–512 |
logicalSizerequired | number[2] | each > 0 |
focusedrequired | boolean | |
movement | object | |
modeIdrequired | id | |
positionrequired | number[3] | |
orientationrequired | number[4] | |
shell | object | |
leasesrequired | object[] | items ≥ 0 |
idrequired | string | length 1–128 |
outputsrequired | string[] | items ≥ 1 · unique items · each length 1–128 |
overlaysrequired | object[] | items ≥ 0 |
outputIdrequired | string | length 1–128 |
visiblerequired | boolean | |
exclusiveInputrequired | boolean | |
location | location | |
integrations | integrations | |
spatial | spatial | |
workspaces | workspaces | |
mounts | mounts | |
presentation | presentation | |
apps | apps | |
interaction | interaction | |
keymap | keymap | |
editor | editor |
runtime.notice#
params · object
| Field | Type | Constraints |
|---|---|---|
levelrequired | "info" | "warning" | "error" | |
coderequired | string | length 1–256 |
messagerequired | string | length 1–4096 |
location.transition#
params · object
| Field | Type | Constraints |
|---|---|---|
phaserequired | "departing" | "travelling" | "arrived" | "cancelled" | "loading" | "failed" | |
progressrequired | null | number | |
torequired | destination | |
sessionIdrequired | string | length 1–128 |
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
idrequired | string | length 1–128 |
outputIdrequired | null | string | |
monotonicMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
ui.opened#
params · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length 1–128 |
outputIdrequired | string | length 1–128 |
panelrequired | "director" | "overview" | "map" | |
sessionIdrequired | string | length 1–128 |
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
ui.closed#
params · object
| Field | Type | Constraints |
|---|---|---|
leaseIdrequired | string | length 1–128 |
outputIdrequired | string | length 1–128 |
sessionIdrequired | string | length 1–128 |
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
data.updated#
params · object
| Field | Type | Constraints |
|---|---|---|
sourceIdrequired | id | |
valuesrequired | map → number | boolean | string | entries ≤ 32 · keys: length ≤ 128 |
sequencerequired | integer | ≥ 0 · ≤ 2⁵³−1 |
monotonicMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
ttlMsrequired | integer | ≥ 100 · ≤ 60000 |
sessionIdrequired | string | length 1–128 |
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
mounts.changed#
params · object
| Field | Type | Constraints |
|---|---|---|
sessionIdrequired | string | length 1–256 |
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
mountsrequired | mounts |
presentation.changed#
params · object
| Field | Type | Constraints |
|---|---|---|
sessionIdrequired | string | length 1–256 |
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
presentationrequired | presentation |
Types
statesnapshottargettransitionwaypointroutePointsourcelocationintegrationsdestinationmapmarkerspatialworkspacesmountspresentationinteractionappsinputConfiginputStealsinputConflictsinputCapturekeymapeditorPatheditorObjecteditoroverlayStylePatchoverlayStylegraphicsConfiggraphicsPatchinputHolds
state#
object
| Field | Type | Constraints |
|---|---|---|
runtimerequired | object | |
activerequired | boolean | |
outputsrequired | string[] | items ≥ 0 · unique items · each length 1–128 |
worldrequired | any of 2 | |
variant 1 | null | |
variant 2 | object | |
idrequired | id | |
spawnIdrequired | slug | |
surfacesrequired | object[] | items ≥ 0 |
idrequired | string | length 1–128 |
kindrequired | "window" | "workspace" | "layer" | "web" | "custom" | |
titlerequired | string | length 0–512 |
logicalSizerequired | number[2] | each > 0 |
focusedrequired | boolean | |
movementrequired | object | |
modeIdrequired | id | |
positionrequired | number[3] | |
orientationrequired | number[4] | |
shellrequired | object | |
leasesrequired | object[] | items ≥ 0 |
idrequired | string | length 1–128 |
outputsrequired | string[] | items ≥ 1 · unique items · each length 1–128 |
overlaysrequired | object[] | items ≥ 0 |
outputIdrequired | string | length 1–128 |
visiblerequired | boolean | |
exclusiveInputrequired | boolean | |
locationrequired | location | |
integrationsrequired | integrations | |
spatialrequired | spatial | |
workspacesrequired | workspaces | |
mountsrequired | mounts | |
presentationrequired | presentation | |
interactionrequired | interaction | |
appsrequired | apps | |
keymaprequired | keymap | |
editorrequired | editor |
snapshot#
object
target#
one of 2
| Field | Type | Constraints |
|---|---|---|
variant 1 | object | |
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
variant 2 | object | |
zoneIdrequired | string | length 1–128 |
transition#
object
| Field | Type | Constraints |
|---|---|---|
phaserequired | "departing" | "travelling" | "arrived" | "cancelled" | "loading" | "failed" | |
progressrequired | null | number | |
torequired | destination | |
idrequired | string | length 1–128 |
outputIdrequired | null | string | |
monotonicMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
waypoint#
object
| Field | Type | Constraints |
|---|---|---|
idrequired | string | length 1–128 |
labelrequired | string | length 1–256 |
targetrequired | target | |
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
routePoint#
object
| Field | Type | Constraints |
|---|---|---|
targetrequired | target | |
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
source#
object
| Field | Type | Constraints |
|---|---|---|
sourceIdrequired | id | |
valuesrequired | map → number | boolean | string | entries ≤ 32 · keys: length ≤ 128 |
sequencerequired | integer | ≥ 0 · ≤ 2⁵³−1 |
monotonicMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
ttlMsrequired | integer | ≥ 100 · ≤ 60000 |
location#
object
| Field | Type | Constraints |
|---|---|---|
zonesrequired | World zones | |
waypointrequired | null | waypoint | |
routerequired | routePoint[] | items 0–64 |
autodriverequired | boolean | |
transitionrequired | null | transition |
map#
object
| Field | Type | Constraints |
|---|---|---|
svgrequired | string | length 1–65536 |
sha256required | string | pattern ^[a-f0-9]{64}$ |
boundsrequired | number[4] | |
worldToMaprequired | number[6] |
marker#
object
| Field | Type | Constraints |
|---|---|---|
idrequired | string | length 1–128 |
labelrequired | string | length ≤ 256 |
xrequired | number | ≥ 0 · ≤ 1 |
yrequired | number | ≥ 0 · ≤ 1 |
distancerequired | number | ≥ 0 |
occludedrequired | boolean |
spatial#
object
| Field | Type | Constraints |
|---|---|---|
worldrequired | any of 2 | |
variant 1 | null | |
variant 2 | object | |
idrequired | id | |
namerequired | string | length ≤ 256 |
placesrequired | object[] | items ≤ 64 |
idrequired | string | length 1–128 |
namerequired | string | length ≤ 256 |
positionrequired | number[3] | |
maprequired | null | map | |
outputrequired | any of 2 | |
variant 1 | null | |
variant 2 | object | |
idrequired | string | length 1–128 |
namerequired | string | length 1–128 |
widthrequired | integer | ≥ 1 |
heightrequired | integer | ≥ 1 |
scalerequired | number | > 0 |
projectionrequired | any of 2 | |
variant 1 | null | |
variant 2 | object | |
outputIdrequired | string | length 1–128 |
worldIdrequired | id | |
monotonicMsrequired | integer | ≥ 0 |
markersrequired | marker[] | items ≤ 64 |
workspaces#
object
mounts#
object
| Field | Type | Constraints |
|---|---|---|
areasrequired | area[] | items ≤ 32 |
anchorsrequired | object[] | items ≤ 128 |
idrequired | slug | |
poserequired | pose | |
sizerequired | size2 | |
mountrequired | mount | |
areaIdrequired | slug | |
bindingsrequired | object[] | items ≤ 32 |
idrequired | integer | ≥ 1 · ≤ 2147483647 |
worldIdrequired | id | |
areaIdrequired | slug | |
placementsrequired | any of 2[] | items ≤ 128 |
variant 1 | object | |
worldIdrequired | id | |
areaIdrequired | slug | |
anchorIdrequired | slug | |
rulerequired | object | |
appClassrequired | string | length 1–256 |
titlerequired | string | length ≤ 256 |
when anchorId = "" | object | |
worldIdrequired | id | |
areaIdrequired | slug | |
anchorIdrequired | "" | |
rulerequired | object | |
appClassrequired | string | length 1–256 |
titlerequired | string | length ≤ 256 |
poserequired | pose | |
sizerequired | size2 | |
objectsrequired | object[] | items ≤ 128 |
idrequired | slug | |
areaIdrequired | slug | |
poserequired | pose | |
mountTyperequired | "facade-wall" | "hanging-wall" | "wall-inset-console" | "banner" | "lectern" | "operator-desk" | "field-rig" | "kiosk-pillar" | "globe" | "crate" | "blast-door-screen" | "terminal-bench" | "radar-dish" | |
sourceIdrequired | null | id | |
carriedSurfaceIdrequired | null | string | |
desktopWorkspaceIdrequired | null | integer | |
placementZonesrequired | placementZone[] | items ≤ 32 |
instancesrequired | object[] | items ≤ 16 |
surfaceIdrequired | string | length 1–128 |
workspaceIdrequired | integer | ≥ 1 |
areaIdrequired | slug | |
anchorIdrequired | string | length ≤ 128 |
statusrequired | "carried" | "placed" | "recalled" |
presentation#
object
| Field | Type | Constraints |
|---|---|---|
profilerequired | null | atmosphere | |
fovrequired | number | ≥ 3 · ≤ 110 |
qualityrequired | "high" | "intel" |
interaction#
object
| Field | Type | Constraints |
|---|---|---|
moderequired | "movement" | "typing" | "workspace" | "fullscreen" | |
toolrequired | integer | ≥ 1 · ≤ 5 |
toolsrequired | ("pointer" | "mount" | "path")[5] | |
nocliprequired | boolean | |
cursorrequired | "desktop" | "workspace" | "fullscreen" | "director" | "virtual" | "reticle" | |
taggedSurfaceIdrequired | null | string |
apps#
object[] · items ≤ 128
| Field | Type | Constraints |
|---|---|---|
surfaceIdrequired | string | length 1–128 |
workspaceIdrequired | integer | ≥ 0 |
titlerequired | string | length ≤ 512 |
appClassrequired | string | length ≤ 256 |
iconrequired | string | length ≤ 256 |
inputConfig#
object
| Field | Type | Constraints |
|---|---|---|
versionrequired | 2 | |
longHoldMsrequired | integer | ≥ 100 · ≤ 5000 |
scopeVignetterequired | boolean | |
useDistancerequired | number | ≥ 0.2 · ≤ 30 |
useTolerancerequired | number | ≥ 0 · ≤ 0.5 |
captureInputLimitrequired | integer | ≥ 16 · ≤ 1024 |
modesrequired | object | |
worldrequired | object | |
lookrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
forwardrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
backrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
leftrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
rightrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
menurequired | string[] | items ≤ 3 · unique items · each length 1–96 |
sprintrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
uprequired | string[] | items ≤ 3 · unique items · each length 1–96 |
downrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
userequired | string[] | items ≤ 3 · unique items · each length 1–96 |
focusrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
nocliprequired | string[] | items ≤ 3 · unique items · each length 1–96 |
scoperequired | string[] | items ≤ 3 · unique items · each length 1–96 |
debugrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
capturerequired | string[] | items ≤ 3 · unique items · each length 1–96 |
carryrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
resizerequired | string[] | items ≤ 3 · unique items · each length 1–96 |
distancerequired | string[] | items ≤ 3 · unique items · each length 1–96 |
rotaterequired | string[] | items ≤ 3 · unique items · each length 1–96 |
tool1required | string[] | items ≤ 3 · unique items · each length 1–96 |
tool2required | string[] | items ≤ 3 · unique items · each length 1–96 |
tool3required | string[] | items ≤ 3 · unique items · each length 1–96 |
tool4required | string[] | items ≤ 3 · unique items · each length 1–96 |
tool5required | string[] | items ≤ 3 · unique items · each length 1–96 |
transportrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
autopilotrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
primaryrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
secondaryrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
wheelrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
flyrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
interactiverequired | object | |
exitrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
debug | string[] | items ≤ 3 · unique items · each length 1–96 |
capture | string[] | items ≤ 3 · unique items · each length 1–96 |
focusrequired | object | |
exitrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
debug | string[] | items ≤ 3 · unique items · each length 1–96 |
capture | string[] | items ≤ 3 · unique items · each length 1–96 |
menurequired | object | |
exitrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
debug | string[] | items ≤ 3 · unique items · each length 1–96 |
capture | string[] | items ≤ 3 · unique items · each length 1–96 |
invert_y | boolean | Invert vertical mouse look; default false. |
show_area_markers | boolean | Render optional place/area labels in core; default false. |
inputSteals#
object[] · items ≤ 512
| Field | Type | Constraints |
|---|---|---|
moderequired | "world" | "interactive" | "focus" | "menu" | |
actionrequired | string | length ≤ 128 |
bindingrequired | string | length ≤ 96 |
descriptionrequired | string | length ≤ 1024 |
submaprequired | string | length ≤ 256 |
inputConflicts#
object[] · items ≤ 128
| Field | Type | Constraints |
|---|---|---|
moderequired | "world" | "interactive" | "focus" | "menu" | |
bindingrequired | string | length ≤ 96 |
actionsrequired | string[2] | each length ≤ 128 |
inputCapture#
any of 2
| Field | Type | Constraints |
|---|---|---|
variant 1 | null | |
variant 2 | object | |
moderequired | "world" | "interactive" | "focus" | "menu" | |
actionrequired | string | length ≤ 128 |
slotrequired | integer | ≥ 0 · ≤ 2 |
statusrequired | "waiting" | "captured" | |
bindingrequired | null | string | length ≤ 96 |
keymap#
object
| Field | Type | Constraints |
|---|---|---|
configrequired | inputConfig | |
pathrequired | string | length ≤ 4096 |
stealsrequired | inputSteals | |
conflictsrequired | inputConflicts | |
capturerequired | inputCapture | |
errorrequired | string | length ≤ 4096 |
holdsrequired | inputHolds |
editorPath#
object
| Field | Type | Constraints |
|---|---|---|
idrequired | string | length ≤ 128 |
worldIdrequired | string | length ≤ 128 |
areaIdrequired | string | length ≤ 128 |
closedrequired | boolean | |
pointsrequired | object[] | items ≤ 256 |
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
typerequired | "line" | "curve" | "arc" |
editorObject#
object
| Field | Type | Constraints |
|---|---|---|
worldIdrequired | string | length ≤ 128 |
areaIdrequired | string | length ≤ 128 |
objectIdrequired | string | length ≤ 128 |
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
rotationrequired | number[4] | each ≥ -1 · each ≤ 1 |
scalerequired | number[3] | each ≥ 0.01 · each ≤ 100 |
editor#
object
| Field | Type | Constraints |
|---|---|---|
moderequired | "world" | "interactive" | "focus" | "menu" | |
toolrequired | integer | ≥ 1 · ≤ 5 |
submoderequired | "normal" | "place" | "lock" | "open line" | "open curve" | "open arc" | "closed line" | "closed curve" | "closed arc" | "move" | "rotate" | "scale" | "reserved" | |
selectedIdrequired | null | string | length ≤ 128 |
selectedKindrequired | "" | "window" | "object" | |
pathsrequired | editorPath[] | items ≤ 128 |
objectsrequired | editorObject[] | items ≤ 128 |
lockedrequired | string[] | items ≤ 1024 · each length ≤ 128 |
debugrequired | boolean |
overlayStylePatch#
object
| Field | Type | Constraints |
|---|---|---|
waypointColor | number[3] | each ≥ 0 · each ≤ 1 |
routeColor | number[3] | each ≥ 0 · each ≤ 1 |
labelColor | number[3] | each ≥ 0 · each ≤ 1 |
promptColor | number[3] | each ≥ 0 · each ≤ 1 |
fontFamily | string | length 1–96 · pattern ^[^\u0000-\u001f\u007f]+$ |
iconAtlas | one of 2 | |
variant 1 | null | |
variant 2 | object | |
pathrequired | string | length ≤ 4096 · pattern ^/[^\u0000]*$ |
cellSizerequired | integer | ≥ 16 · ≤ 128 |
waypointIndexrequired | integer | ≥ 0 · ≤ 255 |
promptIndexrequired | integer | ≥ 0 · ≤ 255 |
overlayStyle#
object
| Field | Type | Constraints |
|---|---|---|
waypointColorrequired | number[3] | each ≥ 0 · each ≤ 1 |
routeColorrequired | number[3] | each ≥ 0 · each ≤ 1 |
labelColorrequired | number[3] | each ≥ 0 · each ≤ 1 |
promptColorrequired | number[3] | each ≥ 0 · each ≤ 1 |
fontFamilyrequired | string | length 1–96 · pattern ^[^\u0000-\u001f\u007f]+$ |
iconAtlasrequired | one of 2 | |
variant 1 | null | |
variant 2 | object | |
pathrequired | string | length ≤ 4096 · pattern ^/[^\u0000]*$ |
cellSizerequired | integer | ≥ 16 · ≤ 128 |
waypointIndexrequired | integer | ≥ 0 · ≤ 255 |
promptIndexrequired | integer | ≥ 0 · ≤ 255 |
graphicsConfig#
object
| Field | Type | Constraints |
|---|---|---|
qualityrequired | "auto" | "low" | "medium" | "high" | "ultra" | "intel" | |
msaarequired | 1 | 2 | 4 | null | |
bloomrequired | "off" | "low" | "high" | null | |
fogrequired | "off" | "linear" | "height" | null | |
skyrequired | "off" | "gradient" | "environment" | null | |
anisotropyrequired | 1 | 2 | 4 | 8 | 16 | null | |
reflectionsrequired | boolean | null | |
normal_mapsrequired | boolean | null | |
specularrequired | boolean | null | |
ambient_occlusionrequired | boolean | null | |
alpha_hazerequired | boolean | null | |
dynamic_resolutionrequired | boolean | |
reduced_motionrequired | boolean | |
render_scalerequired | "auto" | number | |
target_fpsrequired | integer | ≥ 30 · ≤ 240 |
fovrequired | number | ≥ 30 · ≤ 110 |
exposurerequired | number | ≥ 0.01 · ≤ 16 |
bloom_strengthrequired | number | ≥ 0 · ≤ 4 |
sharpenrequired | number | ≥ 0 · ≤ 1 |
graphicsPatch#
object
| Field | Type | Constraints |
|---|---|---|
quality | "auto" | "low" | "medium" | "high" | "ultra" | "intel" | |
msaa | 1 | 2 | 4 | null | |
bloom | "off" | "low" | "high" | null | |
fog | "off" | "linear" | "height" | null | |
sky | "off" | "gradient" | "environment" | null | |
anisotropy | 1 | 2 | 4 | 8 | 16 | null | |
reflections | boolean | null | |
normal_maps | boolean | null | |
specular | boolean | null | |
ambient_occlusion | boolean | null | |
alpha_haze | boolean | null | |
dynamic_resolution | boolean | |
reduced_motion | boolean | |
render_scale | "auto" | number | |
target_fps | integer | ≥ 30 · ≤ 240 |
fov | number | ≥ 30 · ≤ 110 |
exposure | number | ≥ 0.01 · ≤ 16 |
bloom_strength | number | ≥ 0 · ≤ 4 |
sharpen | number | ≥ 0 · ≤ 1 |
inputHolds#
object[] · items ≤ 64
| Field | Type | Constraints |
|---|---|---|
actionrequired | string | length 1–128 |
bindingrequired | string | length 1–128 |
startedAtMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
durationMsrequired | integer | ≥ 100 · ≤ 5000 |
Frame envelopes
error#
object
| Field | Type | Constraints |
|---|---|---|
jsonrpcrequired | "2.0" | |
idrequired | string | null | |
errorrequired | object | |
coderequired | -32700 | -32600 | -32601 | -32602 | -32603 | -32008 | -32007 | -32006 | -32005 | -32004 | -32003 | -32002 | -32001 | |
messagerequired | string | length 1–4096 |
data | object | |
retryablerequired | boolean |
request#
session.hello.request | session.ping.request | state.subscribe.request | state.snapshot.request | state.unsubscribe.request | world.load.request | surface.focus.request | movement.set.request | shell.claim.request | shell.release.request | shell.overlay.request | runtime.exit.request | camera.get.request | camera.set.request | waypoint.set.request | waypoint.clear.request | route.set.request | route.clear.request | travel.start.request | travel.cancel.request | autodrive.start.request | autodrive.stop.request | ui.open.request | ui.close.request | data.publish.request | data.remove.request | shell.bind.request | workspace.activate.request | workspace.bind.request | workspace.focus.request | workspace.unfocus.request | surface.pull.request | surface.place.request | surface.return.request | placements.list.request | placements.remove.request | data.object.bind.request | atmosphere.get.request | atmosphere.set.request | camera.fov.request | surfaces.recall.request | input.get.request | input.preview.request | input.set.request | input.capture.request | input.capture.cancel.request | overlay.style.request | graphics.get.request | graphics.set.request
response#
session.hello.response | session.ping.response | state.subscribe.response | state.snapshot.response | state.unsubscribe.response | world.load.response | surface.focus.response | movement.set.response | shell.release.response | shell.overlay.response | runtime.exit.response | shell.claim.response | camera.get.response | camera.set.response | waypoint.set.response | waypoint.clear.response | route.set.response | route.clear.response | travel.start.response | travel.cancel.response | autodrive.start.response | autodrive.stop.response | ui.open.response | ui.close.response | data.publish.response | data.remove.response | shell.bind.response | workspace.activate.response | workspace.bind.response | workspace.focus.response | workspace.unfocus.response | surface.pull.response | surface.place.response | surface.return.response | placements.list.response | placements.remove.response | data.object.bind.response | atmosphere.get.response | atmosphere.set.response | camera.fov.response | surfaces.recall.response | input.get.response | input.preview.response | input.set.response | input.capture.response | input.capture.cancel.response | overlay.style.response | graphics.get.response | graphics.set.response
Mirrored byte-for-byte from hyprune/schema at 34849da45183 (2026-10-15). SHA-256 72d5e186214cff598300cc8b4ef294e6042ecb5f089afd772be4e8c3ac5eea71.