IPC protocol 0.22
Schema reference / IPC protocol / 0.22
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.21
Changelog · @hyprune/schema 0.7.0 (2026-10-12)
Publishes IPC 0.21 (markers, personal quests, focus sessions) and IPC 0.22 (object catalog, user placements, libraries), plus the object manifest (
object.json0.9 and the 0.10 draft), library and library release-record schemas.
Structural diff against 0.21: 23 entries added, 8 entries changed. Descriptions and $id changes are ignored.
31 changes
- added
catalogEntry - added
libraryRecord - added
method libraries.install - added
method libraries.list - added
method libraries.remove - added
method objects.catalog - added
method objects.configure - added
method objects.hide - added
method objects.place - added
method objects.pocket - added
method objects.remove - added
method objects.reset - added
method objects.transform - added
objectBounds - added
objectId - added
objectInstance - added
objectPocketItem - added
objectPose - added
objectRef - added
objectRule - added
objectScale - added
objectsState - added
objectTraitName - changed
editor- ~
submodeadds … (15 values) - ~
selectedKindadds "node" - +
gizmoobject (required) - +
gizmo.space"world" | "local" (required) - +
gizmo.pivot"centre" | "base" (required) - +
gizmo.snapboolean (required)
- ~
- changed
error- +
error.data.rulestring · length 1–64
- +
- changed
method session.hello- ~
params.capabilitiesadds "quest.control", "objects.control")[]; removes "quest.control")[] - ~
result.protocol"0.21" (required) → "0.22" (required) - ~
result.capabilitiesadds "quest.control", "objects.control")[]; removes "quest.control")[] - ~
result.methodsadds … (95 values))[]; removes … (84 values))[]
- ~
- changed
notification state.delta- +
params.changes.objectsobjectsState
- +
- changed
request- ~
(definition):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 | hud.subscribe.request | hud.unsubscribe.request | recording.start.request | recording.stop.request | recording.mark.request | recording.status.request | replay.start.request | replay.stop.request | replay.status.request | capture.annotate.request | player.get.request | player.set.request | surface.pocket.request | surface.unpocket.request | markers.reveal.request | guidance.get.request | guidance.set.request | quests.list.request | quests.get.request | quests.track.request | quests.accept.request | quests.abandon.request | quests.resume.request | quests.create.request | quests.update.request | quests.delete.request | quests.mark.request | focus.start.request | focus.pause.request | focus.resume.request | focus.skip.request | focus.stop.request | focus.history.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 | hud.subscribe.request | hud.unsubscribe.request | recording.start.request | recording.stop.request | recording.mark.request | recording.status.request | replay.start.request | replay.stop.request | replay.status.request | capture.annotate.request | player.get.request | player.set.request | surface.pocket.request | surface.unpocket.request | markers.reveal.request | guidance.get.request | guidance.set.request | quests.list.request | quests.get.request | quests.track.request | quests.accept.request | quests.abandon.request | quests.resume.request | quests.create.request | quests.update.request | quests.delete.request | quests.mark.request | focus.start.request | focus.pause.request | focus.resume.request | focus.skip.request | focus.stop.request | focus.history.request | objects.catalog.request | objects.pocket.request | objects.place.request | objects.transform.request | objects.remove.request | objects.hide.request | objects.reset.request | objects.configure.request | libraries.list.request | libraries.install.request | libraries.remove.request
- ~
- changed
response- ~
(definition):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 | hud.subscribe.response | hud.unsubscribe.response | recording.start.response | recording.stop.response | recording.mark.response | recording.status.response | replay.start.response | replay.stop.response | replay.status.response | capture.annotate.response | player.get.response | player.set.response | surface.pocket.response | surface.unpocket.response | markers.reveal.response | guidance.get.response | guidance.set.response | quests.list.response | quests.get.response | quests.track.response | quests.accept.response | quests.abandon.response | quests.resume.response | quests.create.response | quests.update.response | quests.delete.response | quests.mark.response | focus.start.response | focus.pause.response | focus.resume.response | focus.skip.response | focus.stop.response | focus.history.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 | hud.subscribe.response | hud.unsubscribe.response | recording.start.response | recording.stop.response | recording.mark.response | recording.status.response | replay.start.response | replay.stop.response | replay.status.response | capture.annotate.response | player.get.response | player.set.response | surface.pocket.response | surface.unpocket.response | markers.reveal.response | guidance.get.response | guidance.set.response | quests.list.response | quests.get.response | quests.track.response | quests.accept.response | quests.abandon.response | quests.resume.response | quests.create.response | quests.update.response | quests.delete.response | quests.mark.response | focus.start.response | focus.pause.response | focus.resume.response | focus.skip.response | focus.stop.response | focus.history.response | objects.catalog.response | objects.pocket.response | objects.place.response | objects.transform.response | objects.remove.response | objects.hide.response | objects.reset.response | objects.configure.response | libraries.list.response | libraries.install.response | libraries.remove.response
- ~
- changed
state- +
objectsobjectsState (required)
- +
- changed
unplaced- ~
countinteger (required) · ≥ 0 · ≤ 16 → integer (required) · ≥ 0 · ≤ 32 - +
objectsobjectPocketItem[] (required) · items ≤ 16
- ~
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.sethud.subscribehud.unsubscriberecording.startrecording.stoprecording.markrecording.statusreplay.startreplay.stopreplay.statuscamera.photocamera.releasecapture.annotateplayer.getplayer.setsurface.pocketsurface.unpocketmarkers.revealguidance.getguidance.setquests.listquests.getquests.trackquests.acceptquests.abandonquests.resumequests.createquests.updatequests.deletequests.markfocus.startfocus.pausefocus.resumefocus.skipfocus.stopfocus.historyobjects.catalogobjects.pocketobjects.placeobjects.transformobjects.removeobjects.hideobjects.resetobjects.configurelibraries.listlibraries.installlibraries.remove
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 | ("state.read" | "world.control" | "surface.control" | "movement.control" | "shell.control" | "runtime.control" | "data.publish" | "input.control" | "camera.author" | "quest.control" | "objects.control")[] | items ≥ 0 · unique items |
token | string | length 64 · pattern ^[a-f0-9]{64}$ |
result · object
| Field | Type | Constraints |
|---|---|---|
protocolrequired | "0.22" | |
sessionIdrequired | string | length 1–128 |
capabilitiesrequired | ("state.read" | "world.control" | "surface.control" | "movement.control" | "shell.control" | "runtime.control" | "data.publish" | "input.control" | "camera.author" | "quest.control" | "objects.control")[] | 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" | … (95 values))[] | items ≥ 0 · unique items |
eventsrequired | ("state.delta" | "runtime.notice" | "session.revoked" | "location.transition" | "ui.opened" | "ui.closed" | "data.updated" | "mounts.changed" | "presentation.changed" | "hud.frame" | "hud.pose" | "zone.entered" | "zone.exited" | "tool.changed" | … (18 values))[] | 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] | |
rollrequired | number | ≥ -3.141593 · ≤ 3.141593 |
fovrequired | number | ≥ 3 · ≤ 140 |
lensShiftrequired | number[2] | each ≥ -2 · each ≤ 2 |
heldrequired | boolean | |
renderScalerequired | number | null |
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 |
content | placementContent | |
when anchorId = "" | object | |
worldIdrequired | id | |
areaIdrequired | slug | |
anchorIdrequired | "" | |
rulerequired | object | |
appClassrequired | string | length 1–256 |
titlerequired | string | length ≤ 256 |
poserequired | pose | |
sizerequired | size2 | |
content | placementContent |
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 | authorAtmosphere | |
qualityrequired | "high" | "intel" |
atmosphere.set#
params · object
| Field | Type | Constraints |
|---|---|---|
profilerequired | authorAtmosphere |
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. |
performancerequired | performance |
graphics.set#
params · object
| Field | Type | Constraints |
|---|---|---|
patchrequired | graphicsPatch |
result · graphics.get.result
hud.subscribe#
params · object
| Field | Type | Constraints |
|---|---|---|
topicsrequired | ("hud.frame" | "hud.pose" | "zone.entered" | "zone.exited" | "tool.changed")[] | items 1–5 · unique items |
result · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–256 |
hud.unsubscribe#
params · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–256 |
result · object
| Field | Type | Constraints |
|---|---|---|
okrequired | true |
recording.mark#
params · object
| Field | Type | Constraints |
|---|---|---|
namerequired | string | length 1–64 |
result · recordingStatus
replay.start#
params · object
| Field | Type | Constraints |
|---|---|---|
pathrequired | string | length 1–4096 |
mode | "input" | "camera" | |
smoothingMs | number | ≥ 0 · ≤ 1000 |
assertions | replayAssertions |
result · recordingStatus
camera.photo#
params · object
| Field | Type | Constraints |
|---|---|---|
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
orientationrequired | number[4] | |
fovrequired | number | ≥ 5 · ≤ 140 |
renderScalerequired | number | ≥ 0.25 · ≤ 1 |
lensShift | number[2] | each ≥ -2 · each ≤ 2 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
camera.release#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
capture.annotate#
params · object
| Field | Type | Constraints |
|---|---|---|
captureIdrequired | captureId | |
noterequired | string | length ≤ 1000 · pattern ^[^\u0000-\u001f\u007f-\u009f]*$ |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
surface.pocket#
params · object
| Field | Type | Constraints |
|---|---|---|
surfaceIdrequired | string | length 1–256 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
surface.unpocket#
params · object
| Field | Type | Constraints |
|---|---|---|
surfaceIdrequired | string | length 1–256 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
placedrequired | boolean |
markers.reveal#
params · object
| Field | Type | Constraints |
|---|---|---|
durationMs | integer | ≥ 1000 · ≤ 15000 |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
quests.list#
params · object
| Field | Type | Constraints |
|---|---|---|
states | ("available" | "active" | "completed" | "failed" | "abandoned")[] | items 1–5 · unique items |
sources | string[] | items 1–64 · unique items · each length 1–128 |
result · object
| Field | Type | Constraints |
|---|---|---|
questsrequired | questSummary[] | items ≤ 256 |
quests.get#
params · object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | questRef |
result · object
| Field | Type | Constraints |
|---|---|---|
questrequired | questDetail |
quests.track#
params · object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | null | questRef |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
quests.accept#
params · object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | questRef |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
quests.abandon#
params · object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | questRef |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
quests.resume#
params · object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | questRef |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
quests.create#
params · object
| Field | Type | Constraints |
|---|---|---|
questrequired | personalQuestInput |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
questRefrequired | questRef |
quests.update#
params · object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | questRef | |
questrequired | personalQuestInput |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
quests.delete#
params · object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | questRef |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
focus.start#
params · object
| Field | Type | Constraints |
|---|---|---|
target | focusTargetInput | |
questRef | questRef | |
objectiveId | questSlug | |
overrides | focusOverrides |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
sessionIdrequired | string | length 1–64 · pattern ^focus-[0-9a-f]{1,58}$ |
focus.pause#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
focus.resume#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
focus.skip#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
focus.stop#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
focus.history#
params · object
| Field | Type | Constraints |
|---|---|---|
days | integer | ≥ 1 · ≤ 365 |
result · object
| Field | Type | Constraints |
|---|---|---|
intervalsrequired | focusInterval[] | items ≤ 512 |
objects.catalog#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
entriesrequired | catalogEntry[] | items ≤ 1024 |
objects.pocket#
params · object
| Field | Type | Constraints |
|---|---|---|
refrequired | objectRef |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
itemIdrequired | string | length 1–64 · pattern ^pocket-[0-9]+$ |
objects.place#
params · object
| Field | Type | Constraints |
|---|---|---|
refrequired | objectRef | |
pose | objectPose | |
scale | objectScale |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
idrequired | objectId |
objects.transform#
params · object
| Field | Type | Constraints |
|---|---|---|
idrequired | objectId | |
poserequired | objectPose | |
scale | objectScale |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
objects.remove#
params · one of 2
| Field | Type | Constraints |
|---|---|---|
variant 1 | object | |
idrequired | objectId | |
when all = true | object | |
allrequired | true |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
objects.hide#
params · object
| Field | Type | Constraints |
|---|---|---|
idrequired | objectId |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
objects.reset#
params · one of 2
| Field | Type | Constraints |
|---|---|---|
variant 1 | object | |
idrequired | objectId | |
when all = true | object | |
allrequired | true |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
objects.configure#
params · object
| Field | Type | Constraints |
|---|---|---|
idrequired | objectId | |
patchrequired | object | entries ≥ 1 |
locked | boolean |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
libraries.list#
params · {} (no fields)
result · object
| Field | Type | Constraints |
|---|---|---|
librariesrequired | libraryRecord[] | items ≤ 256 |
libraries.install#
params · object
| Field | Type | Constraints |
|---|---|---|
archiverequired | string | length 2–4096 · pattern ^/.*\.tar\.zst$ |
sha256required | string | length 64 · pattern ^[0-9a-f]{64}$ |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
idrequired | string | length 1–128 · pattern ^[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)+$ |
versionrequired | string | length 1–256 · pattern ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$ |
libraries.remove#
params · object
| Field | Type | Constraints |
|---|---|---|
idrequired | string | length 1–128 · pattern ^[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)+$ |
versionrequired | string | length 1–256 · pattern ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$ |
result · object
| Field | Type | Constraints |
|---|---|---|
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
Notifications
state.deltaruntime.noticesession.revokedlocation.transitionui.openedui.closeddata.updatedmounts.changedpresentation.changedhud.framehud.posezone.enteredzone.exitedtool.changedui.hud.cyclecapture.takenquest.progressfocus.phase
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] | |
staterequired | "walking" | "flying" | "climbing" | |
ladderIdrequired | null | string | |
promptrequired | string | length ≤ 256 |
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 | |
markers | markersState | |
quests | questsState | |
focus | focusState | |
objects | objectsState |
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 |
hud.frame#
params · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–256 |
sessionIdrequired | string | length 1–256 |
revisionrequired | integer | ≥ 0 |
monotonicMsrequired | integer | ≥ 0 |
fpsrequired | number | ≥ 0 |
frameMsrequired | number | ≥ 0 |
cpuMsrequired | number | ≥ 0 |
gpuMsrequired | number | null | |
renderScalerequired | number | ≥ 0 · ≤ 1 |
presetrequired | "auto" | "low" | "medium" | "high" | "ultra" |
hud.pose#
params · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–256 |
sessionIdrequired | string | length 1–256 |
revisionrequired | integer | ≥ 0 |
monotonicMsrequired | integer | ≥ 0 |
outputIdrequired | string | length 1–256 |
worldIdrequired | string | length 1–256 |
worldNamerequired | string | length 1–256 |
positionrequired | number[3] | |
headingrequired | number | |
pitchrequired | number | |
zonerequired | hudZone | null | |
toolrequired | integer | ≥ 1 · ≤ 5 |
subtyperequired | string | length 1–256 |
zone.entered#
params · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–256 |
sessionIdrequired | string | length 1–256 |
revisionrequired | integer | ≥ 0 |
monotonicMsrequired | integer | ≥ 0 |
zonerequired | hudZone |
zone.exited#
params · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–256 |
sessionIdrequired | string | length 1–256 |
revisionrequired | integer | ≥ 0 |
monotonicMsrequired | integer | ≥ 0 |
zonerequired | hudZone |
tool.changed#
params · object
| Field | Type | Constraints |
|---|---|---|
subscriptionIdrequired | string | length 1–256 |
sessionIdrequired | string | length 1–256 |
revisionrequired | integer | ≥ 0 |
monotonicMsrequired | integer | ≥ 0 |
slotrequired | integer | ≥ 1 · ≤ 5 |
namerequired | string | length 1–256 |
subtyperequired | string | length 1–256 |
ui.hud.cycle#
params · object
| Field | Type | Constraints |
|---|---|---|
sessionIdrequired | string | length 1–256 |
revisionrequired | integer | ≥ 0 |
monotonicMsrequired | integer | ≥ 0 |
leaseIdrequired | string | length 1–256 |
outputIdrequired | string | length 1–256 |
sequencerequired | integer | ≥ 0 |
capture.taken#
params · object
| Field | Type | Constraints |
|---|---|---|
captureIdrequired | captureId | |
timestampMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
moderequired | "world" | "interactive" | "focus" | "cursor" | "menu" | |
sessionIdrequired | string | length 1–128 |
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
quest.progress#
params · object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | questRef | |
kindrequired | "objective" | "step" | "completed" | "available" | "failed" | |
titlerequired | string | length 1–64 |
stepId | questSlug | |
stepTitle | string | length 1–64 |
nextStepTitle | string | length 1–64 |
objectiveId | questSlug | |
progress | questProgress | |
sessionIdrequired | string | length 1–128 |
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
focus.phase#
params · object
| Field | Type | Constraints |
|---|---|---|
focusSessionIdrequired | string | length 1–64 · pattern ^focus-[0-9a-f]{1,58}$ |
phaserequired | "work" | "break" | "ready" | "paused" | "ended" | |
cyclerequired | integer | ≥ 0 · ≤ 12 |
cyclesrequired | integer | ≥ 1 · ≤ 12 |
creditedMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
breakKind | "short" | "long" | |
outcome | "completed" | "skipped" | "stopped" | |
counted | boolean | |
suggestion | object | |
markerIdrequired | string | length 1–160 |
labelrequired | string | length 0–48 |
sessionIdrequired | string | length 1–128 |
revisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
Types
statesnapshottargettransitionwaypointroutePointsourcelocationintegrationsdestinationmapmarkerspatialworkspacesmountspresentationinteractionappsinputConfiginputStealsinputConflictsinputCapturekeymapeditorPatheditorObjecteditoroverlayStylePatchoverlayStylegraphicsConfiggraphicsPatchinputHoldshudZoneperformanceControlperformancereplayAssertionsrecordingStatusauthorAtmosphereplacementContentunplacedcontentScaleFeedbacktoolSlottoolSlotstoolDefinitiontoolInputcaptureIdreticleplayerConfigplayerPatchplayerOverridesplayerSettingsquestSlugquestRefquestProgressquestTargetmarkerSourceguidanceMarkermarkersStateactiveQuestquestsStatefocusTargetfocusStateguidanceConfigguidanceOverridesguidancePatchguidanceSettingsobjectiveInputstepInputpersonalQuestInputquestSummaryquestObjectivequestStepquestDetailfocusTargetInputfocusOverridesfocusIntervalobjectRefobjectIdobjectPoseobjectScaleobjectRuleobjectTraitNameobjectBoundsobjectPocketItemobjectInstanceobjectsStatecatalogEntrylibraryRecord
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] | |
staterequired | "walking" | "flying" | "climbing" | |
ladderIdrequired | null | string | |
promptrequired | string | length ≤ 256 |
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 | |
markersrequired | markersState | |
questsrequired | questsState | |
focusrequired | focusState | |
objectsrequired | objectsState |
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] | |
levels | object[] | items 1–6 |
idrequired | string | pattern ^[a-z][a-z0-9-]{0,31}$ |
namerequired | string | length 1–64 |
minYrequired | number | |
maxYrequired | number | |
svgrequired | string | length 1–65536 |
sha256required | string | pattern ^[a-f0-9]{64}$ |
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 | |
markerId | string | length 1–160 |
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 |
content | placementContent | |
when anchorId = "" | object | |
worldIdrequired | id | |
areaIdrequired | slug | |
anchorIdrequired | "" | |
rulerequired | object | |
appClassrequired | string | length 1–256 |
titlerequired | string | length ≤ 256 |
poserequired | pose | |
sizerequired | size2 | |
content | placementContent | |
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 |
areaId | slug | |
anchorIdrequired | string | length ≤ 128 |
statusrequired | "carried" | "placed" | "recalled" |
presentation#
object
| Field | Type | Constraints |
|---|---|---|
profilerequired | null | authorAtmosphere | |
fovrequired | number | ≥ 3 · ≤ 140 |
qualityrequired | "high" | "intel" |
interaction#
object
| Field | Type | Constraints |
|---|---|---|
moderequired | "movement" | "typing" | "workspace" | "fullscreen" | "cursor" | |
toolrequired | integer | ≥ 1 · ≤ 5 |
toolsrequired | ("pointer" | "mount" | "path" | "position" | "placement")[5] | |
nocliprequired | boolean | |
cursorrequired | "desktop" | "workspace" | "fullscreen" | "director" | "virtual" | "reticle" | |
taggedSurfaceIdrequired | null | string | |
reticlerequired | reticle |
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 |
hud.cyclerequired | 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 |
flyrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
record.togglerequired | string[] | items ≤ 3 · unique items · each length 1–96 |
exitrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
tool5required | string[] | items ≤ 3 · unique items · each length 1–96 |
carry.facingrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
content.scalerequired | string[] | items ≤ 3 · unique items · each length 1–96 |
window.resetrequired | string[] | items ≤ 3 · unique items · each length 1–96 |
cyclerequired | string[] | items ≤ 3 · unique items · each length 1–96 |
alternaterequired | string[] | items ≤ 3 · unique items · each length 1–96 |
markers.revealrequired | 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 |
record.togglerequired | 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 |
record.togglerequired | 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 |
record.togglerequired | 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" | "cursor" | |
toolrequired | integer | ≥ 1 · ≤ 5 |
submoderequired | "normal" | "place" | "lock" | "open line" | "open curve" | "open arc" | "closed line" | "closed curve" | "closed arc" | "move" | "rotate" | "scale" | "reserved" | "placement" | … (15 values) | |
selectedIdrequired | null | string | length ≤ 128 |
selectedKindrequired | "" | "window" | "object" | "node" | |
pathsrequired | editorPath[] | items ≤ 128 |
objectsrequired | editorObject[] | items ≤ 128 |
lockedrequired | string[] | items ≤ 1024 · each length ≤ 128 |
debugrequired | boolean | |
unplacedrequired | unplaced | |
carryFacingrequired | boolean | null | |
contentScalerequired | contentScaleFeedback | null | |
toolSlotsrequired | toolSlots | |
toolDefinitionsrequired | toolDefinition[5] | |
toolInputrequired | toolInput | |
gizmorequired | object | |
spacerequired | "world" | "local" | |
pivotrequired | "centre" | "base" | |
snaprequired | 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 |
reticleColor | number[3] | each ≥ 0 · each ≤ 1 |
validColor | number[3] | each ≥ 0 · each ≤ 1 |
invalidColor | number[3] | each ≥ 0 · each ≤ 1 |
questColor | number[3] | each ≥ 0 · each ≤ 1 |
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 |
reticleColorrequired | number[3] | each ≥ 0 · each ≤ 1 |
validColorrequired | number[3] | each ≥ 0 · each ≤ 1 |
invalidColorrequired | number[3] | each ≥ 0 · each ≤ 1 |
questColorrequired | number[3] | each ≥ 0 · each ≤ 1 |
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 · ≤ 120 |
exposurerequired | number | ≥ 0.01 · ≤ 16 |
bloom_strengthrequired | number | ≥ 0 · ≤ 4 |
sharpenrequired | number | ≥ 0 · ≤ 1 |
offloadrequired | "off" | "auto" | "on" | |
offload_power_cap_wrequired | number | null | Offload renderer power cap in watts. Null (the default) is automatic: the battery profile ceiling on systems with a battery, otherwise 75 % of the offload GPU's enforced power limit (80 W when unknown). A number can only lower the profile ceiling with a battery and is clamped to the GPU's enforced limit without one. |
offload_device | string | pattern ^(auto|[0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}\.[0-7])$"auto" (the default) or the lowercase PCI address (domain:bus:device.function) of the GPU that runs the offload renderer. Auto prefers an NVIDIA render node that is not the compositor's GPU, then the least utilised; an unavailable explicit address stops offload with reason "offload device unavailable". |
scale_minrequired | number | ≥ 0.375 · ≤ 1 |
scale_maxrequired | number | ≥ 0.375 · ≤ 1 |
outlinerequired | boolean | null | |
visibility_cullingrequired | boolean | |
outline_qualityrequired | "fast" | "smooth" | null | |
outline_width_pxrequired | null | number | |
outline_colourrequired | null | number[3] | |
upscaler | "fsr1" | "bilinear" | null | Reconstruction when the world renders below output size: AMD FidelityFX FSR 1 (EASU + RCAS) or bilinear + bounded unsharp mask. Null inherits the preset; bilinear is also used when the GPU lacks GLSL ES 3.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 · ≤ 120 |
exposure | number | ≥ 0.01 · ≤ 16 |
bloom_strength | number | ≥ 0 · ≤ 4 |
sharpen | number | ≥ 0 · ≤ 1 |
offload | "off" | "auto" | "on" | |
offload_power_cap_w | number | null | Offload renderer power cap in watts. Null (the default) is automatic: the battery profile ceiling on systems with a battery, otherwise 75 % of the offload GPU's enforced power limit (80 W when unknown). A number can only lower the profile ceiling with a battery and is clamped to the GPU's enforced limit without one. |
offload_device | string | pattern ^(auto|[0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}\.[0-7])$"auto" (the default) or the lowercase PCI address (domain:bus:device.function) of the GPU that runs the offload renderer. Auto prefers an NVIDIA render node that is not the compositor's GPU, then the least utilised; an unavailable explicit address stops offload with reason "offload device unavailable". |
scale_min | number | ≥ 0.375 · ≤ 1 |
scale_max | number | ≥ 0.375 · ≤ 1 |
outline | boolean | null | |
visibility_culling | boolean | |
outline_quality | "fast" | "smooth" | null | |
outline_width_px | null | number | |
outline_colour | null | number[3] | |
upscaler | "fsr1" | "bilinear" | null | Reconstruction when the world renders below output size: AMD FidelityFX FSR 1 (EASU + RCAS) or bilinear + bounded unsharp mask. Null inherits the preset; bilinear is also used when the GPU lacks GLSL ES 3.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 |
hudZone#
object
| Field | Type | Constraints |
|---|---|---|
idrequired | string | length 1–256 |
homeNamerequired | string | length 1–256 |
worldIdrequired | string | length 1–256 |
worldNamerequired | string | length 1–256 |
performanceControl#
object
| Field | Type | Constraints |
|---|---|---|
requestedrequired | number | boolean | string | null | number[3] | |
effectiverequired | number | boolean | string | null | number[3] | |
gpuMsrequired | number | null | |
sharedPassrequired | string | null | |
passGpuMsrequired | number | null |
performance#
object
| Field | Type | Constraints |
|---|---|---|
profilerequired | "unknown" | "battery" | "usb-c" | "limited-ac" | "full-ac" | |
powerWrequired | number | null | |
capWrequired | number | ≥ 0 |
capSourcerequired | "profile" | "device" | "configured" | "fallback" | Where capW comes from: profile = battery-present laptop rules; device = no battery, 75 % of the GPU's enforced power limit; configured = offload_power_cap_w (clamped to the profile ceiling with a battery, or to the GPU's enforced limit without one); fallback = no battery and the limit is unknown (80 W). |
devicerequired | any of 2 | The GPU chosen for the offload renderer, or null when none is chosen yet or none is available. drivesCompositor is true when it is the GPU the compositor renders with. |
variant 1 | null | |
variant 2 | object | |
pcirequired | string | pattern ^[0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}\.[0-7]$ |
noderequired | string | pattern ^renderD[0-9]+$ |
namerequired | string | null | |
enforcedLimitWrequired | number | null | |
selectionrequired | "auto" | "explicit" | |
drivesCompositorrequired | boolean | |
targetFPSrequired | integer | ≥ 0 · ≤ 60 |
reasonrequired | string | |
pidrequired | integer | null | |
generationrequired | integer | ≥ 0 |
moderequired | "off" | "auto" | "on" | |
activeRendererrequired | "in-process" | "offload" | |
statusrequired | "active" | "warming" | "local" | |
presetrequired | "auto" | "low" | "medium" | "high" | "ultra" | "custom" | "intel" | |
requestedrequired | graphicsConfig | |
effectiverequired | graphicsConfig | |
costsMsrequired | map → number | null | |
workerTimingsrequired | object | null | |
controlsrequired | map → performanceControl |
replayAssertions#
object
| Field | Type | Constraints |
|---|---|---|
recorded | boolean | |
tolerance | number | ≥ 0 · ≤ 100 |
marks | map → object | entries ≤ 128 |
camera | object | |
position | number[3] | |
yaw | number | |
pitch | number | |
fov | number | |
mode | "world" | "interactive" | "focus" | "menu" | "cursor" | |
tool | integer | ≥ 1 · ≤ 4 |
subtype | string | length ≤ 64 |
scope | boolean | |
noclip | boolean | |
movement | "walk" | "fly" | |
tolerance | number | ≥ 0 · ≤ 100 |
recordingStatus#
object
| Field | Type | Constraints |
|---|---|---|
recordingrequired | boolean | |
playingrequired | boolean | |
pathrequired | string | null | length ≤ 4096 |
framerequired | integer | ≥ 0 · ≤ 36001 |
moderequired | "input" | "camera" | |
failuresrequired | string[] | items ≤ 128 · each length ≤ 512 |
errorrequired | string | null | length ≤ 256 |
authorAtmosphere#
object
| Field | Type | Constraints |
|---|---|---|
fogrequired | object | |
colorrequired | vec3 | |
densityrequired | number | ≥ 0 · ≤ 1 |
heightFalloffrequired | number | ≥ 0 · ≤ 10 |
baseHeightrequired | number | ≥ -10000 · ≤ 10000 |
excludeUnlitrequired | boolean | |
skyrequired | object | |
zenithrequired | vec3 | |
horizonrequired | vec3 | |
groundrequired | vec3 | |
sunrequired | object | |
directionrequired | vec3 | |
colorrequired | vec3 | |
intensityrequired | number | ≥ 0 · ≤ 10000 |
angularRadiusrequired | number | ≥ 0.001 · ≤ 1 |
environment | object | |
facesrequired | path[6] | |
encodingrequired | "srgb" | "linear" | |
intensityrequired | number | ≥ 0 · ≤ 10000 |
rotationrequired | number | ≥ -6.283186 · ≤ 6.283186 |
maxResolutionrequired | integer | ≥ 16 · ≤ 512 |
exposurerequired | number | ≥ 0.01 · ≤ 100 |
toneMappingrequired | "aces" | "reinhard" | "linear" | |
bloomrequired | object | |
strengthrequired | number | ≥ 0 · ≤ 2 |
thresholdrequired | number | ≥ 0 · ≤ 100 |
radiusrequired | number | ≥ 1 · ≤ 8 |
outline | object | |
enabledrequired | boolean | |
colourrequired | number[3] | each ≥ 0 · each ≤ 1 |
widthPxrequired | number | ≥ 1 · ≤ 4 |
depthThresholdrequired | number | ≥ 0.0001 · ≤ 1 |
normalThresholdrequired | number | ≥ 0.001 · ≤ 2 |
placementContent#
object
| Field | Type | Constraints |
|---|---|---|
logicalSizerequired | integer[2] | each ≥ 1 · each ≤ 32768 |
baseSizerequired | integer[2] | each ≥ 1 · each ≤ 32768 |
worldSizerequired | number[2] | each ≥ 0.001 · each ≤ 32768 |
unplaced#
object
| Field | Type | Constraints |
|---|---|---|
countrequired | integer | ≥ 0 · ≤ 32 |
windowsrequired | object[] | items ≤ 16 |
surfaceIdrequired | string | length 1–256 |
titlerequired | string | length ≤ 4096 |
appClassrequired | string | length ≤ 256 |
logicalSizerequired | integer[2] | each ≥ 1 · each ≤ 32768 |
selectedIdrequired | string | null | |
previewrequired | boolean | |
objectsrequired | objectPocketItem[] | items ≤ 16 |
contentScaleFeedback#
object
| Field | Type | Constraints |
|---|---|---|
surfaceIdrequired | string | length 1–256 |
scalerequired | number | > 0 · ≤ 32768 |
logicalSizerequired | integer[2] | each ≥ 1 · each ≤ 32768 |
sequencerequired | integer | ≥ 0 · ≤ 2⁵³−1 |
resetrequired | boolean |
toolSlots#
object
toolDefinition#
object
| Field | Type | Constraints |
|---|---|---|
slotrequired | integer | ≥ 1 · ≤ 5 |
namerequired | string | length 1–128 |
slotsrequired | toolSlots |
toolInput#
object
| Field | Type | Constraints |
|---|---|---|
modifiersrequired | integer | ≥ 0 · ≤ 255 |
overriderequired | boolean | |
gesturesrequired | object[] | items ≤ 7 |
actionrequired | string | length ≤ 128 |
labelrequired | string | length ≤ 128 |
bindingsrequired | string[] | items ≤ 3 · each length ≤ 96 |
captureId#
string · length ≤ 27 · pattern ^capture-[0-9]{1,19}$
reticle#
object
| Field | Type | Constraints |
|---|---|---|
staterequired | "hidden" | "neutral" | "typing" | "target" | "valid" | "out_of_range" | "invalid" | "holding" | |
actionrequired | "" | "click" | "grab" | "pocket" | "place" | "mount" | "select" | "path" | "drop" |
playerConfig#
object
| Field | Type | Constraints |
|---|---|---|
walk_speedrequired | number | ≥ 0.5 · ≤ 20 |
run_speedrequired | number | ≥ 0.5 · ≤ 30 |
view_bobrequired | "off" | "subtle" | "normal" | |
reticle_stylerequired | "cross_dot" | "t_dot" | "circle_dot" | "dot" | "cross" | "chevron" | |
reticle_sizerequired | number | ≥ 6 · ≤ 64 |
reticle_thicknessrequired | number | ≥ 1 · ≤ 6 |
reticle_gaprequired | number | ≥ 0 · ≤ 20 |
reticle_opacityrequired | number | ≥ 0.2 · ≤ 1 |
reticle_outlinerequired | boolean | |
reticle_colourrequired | "theme" | number[3] | |
reticle_dynamicrequired | boolean | |
reach_grabrequired | number | ≥ 1 · ≤ 100 |
reach_mountrequired | number | ≥ 1 · ≤ 100 |
reach_placementrequired | number | ≥ 1 · ≤ 100 |
playerPatch#
Changed keys only; null removes the persisted override (back to the default).
object · entries ≥ 1
| Field | Type | Constraints |
|---|---|---|
walk_speed | null | number | |
run_speed | null | number | |
view_bob | null | "off" | "subtle" | "normal" | |
reticle_style | null | "cross_dot" | "t_dot" | "circle_dot" | "dot" | "cross" | "chevron" | |
reticle_size | null | number | |
reticle_thickness | null | number | |
reticle_gap | null | number | |
reticle_opacity | null | number | |
reticle_outline | null | boolean | |
reticle_colour | null | "theme" | number[3] | |
reticle_dynamic | null | boolean | |
reach_grab | null | number | |
reach_mount | null | number | |
reach_placement | null | number |
playerOverrides#
Persisted player overrides (never null; may be empty).
object
| Field | Type | Constraints |
|---|---|---|
walk_speed | number | ≥ 0.5 · ≤ 20 |
run_speed | number | ≥ 0.5 · ≤ 30 |
view_bob | "off" | "subtle" | "normal" | |
reticle_style | "cross_dot" | "t_dot" | "circle_dot" | "dot" | "cross" | "chevron" | |
reticle_size | number | ≥ 6 · ≤ 64 |
reticle_thickness | number | ≥ 1 · ≤ 6 |
reticle_gap | number | ≥ 0 · ≤ 20 |
reticle_opacity | number | ≥ 0.2 · ≤ 1 |
reticle_outline | boolean | |
reticle_colour | "theme" | number[3] | |
reticle_dynamic | boolean | |
reach_grab | number | ≥ 1 · ≤ 100 |
reach_mount | number | ≥ 1 · ≤ 100 |
reach_placement | number | ≥ 1 · ≤ 100 |
playerSettings#
object
| Field | Type | Constraints |
|---|---|---|
configrequired | playerConfig | |
defaultsrequired | playerConfig | |
overridesrequired | playerOverrides | |
optionsrequired | object | |
view_bobrequired | ("off" | "subtle" | "normal")[] | items ≥ 1 · unique items |
reticle_stylerequired | ("cross_dot" | "t_dot" | "circle_dot" | "dot" | "cross" | "chevron")[] | items ≥ 1 · unique items |
rangesrequired | object | |
walk_speedrequired | number[2] | |
run_speedrequired | number[2] | |
reticle_sizerequired | number[2] | |
reticle_thicknessrequired | number[2] | |
reticle_gaprequired | number[2] | |
reticle_opacityrequired | number[2] | |
reach_grabrequired | number[2] | |
reach_mountrequired | number[2] | |
reach_placementrequired | number[2] | |
pathrequired | string | length ≤ 4096 |
errorrequired | string | length ≤ 4096 |
questSlug#
string · length 1–64 · pattern ^[a-z0-9][a-z0-9-]{0,63}$
questRef#
A quest reference: source ("personal", a world ID or a provider ID) and the quest slug.
object
| Field | Type | Constraints |
|---|---|---|
sourcerequired | string | length 1–128 |
idrequired | questSlug |
questTarget#
Exactly one of position (optionally with worldId), zoneId, areaId, placeId or workspaceId.
one of 5
| Field | Type | Constraints |
|---|---|---|
variant 1 | object | |
positionrequired | number[3] | |
worldId | string | length 1–128 |
variant 2 | object | |
zoneIdrequired | string | length 1–128 |
variant 3 | object | |
areaIdrequired | string | length 1–128 |
variant 4 | object | |
placeIdrequired | string | length 1–128 |
variant 5 | object | |
workspaceIdrequired | integer | ≥ 1 · ≤ 2147483647 |
guidanceMarker#
A resolved marker (RFC-0012). id is "<kind>:<source id>" (at most 160 bytes); position is null when the target is not in the loaded world; range is [min, max] metres with min < max. Kinds and icons beyond quest, waypoint, route, home, workspace, place, focus and break (plus quest-optional and vista icons) are reserved for later quest sources.
object
| Field | Type | Constraints |
|---|---|---|
idrequired | string | length 1–160 |
kindrequired | "quest" | "offer" | "waypoint" | "route" | "home" | "workspace" | "place" | "vista" | "discover" | "machine" | "focus" | "break" | |
tierrequired | integer | ≥ 1 · ≤ 4 |
labelrequired | string | length 0–48 |
iconrequired | "quest" | "quest-optional" | "offer" | "turn-in" | "waypoint" | "route" | "home" | "workspace" | "place" | "vista" | "discover" | "door" | "stairs" | "lift" | … (18 values) | |
targetrequired | questTarget | |
positionrequired | null | number[3] | |
areaIdrequired | null | string | |
rangerequired | number[2] | each ≥ 0 · each ≤ 10000 |
labelRangerequired | number | ≥ 0 · ≤ 10000 |
occlusionrequired | "through" | "edge" | "visible" | |
trackedrequired | boolean | |
sourcerequired | markerSource |
markersState#
Marker reveal and the resolved marker list (sorted by tier, then id). reveal.holdMs 0 is toggle mode; *AtMs are CLOCK_MONOTONIC milliseconds.
object
| Field | Type | Constraints |
|---|---|---|
revealrequired | any of 2 | |
variant 1 | null | |
variant 2 | object | |
startedAtMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
holdMsrequired | 0 | any | |
fadeMsrequired | integer | ≥ 0 · ≤ 600 |
reasonrequired | "tap" | "request" | |
persistentrequired | "off" | "edge" | "always" | |
calmrequired | boolean | |
coreDrawrequired | boolean | |
listrequired | guidanceMarker[] | items ≤ 64 |
activeQuest#
object
| Field | Type | Constraints |
|---|---|---|
idrequired | questSlug | |
sourcerequired | string | length 1–128 |
titlerequired | string | length 1–64 |
steprequired | any of 2 | |
variant 1 | null | |
variant 2 | object | |
idrequired | questSlug | |
titlerequired | string | length 1–64 |
progressrequired | questProgress | |
progressrequired | questProgress |
questsState#
Active quests (tracked first) and counts. world is reserved and always null in this version.
object
| Field | Type | Constraints |
|---|---|---|
enabledrequired | boolean | |
trackedrequired | null | questRef | |
activerequired | activeQuest[] | items ≤ 16 |
countsrequired | object | |
availablerequired | integer | ≥ 0 · ≤ 10000 |
activerequired | integer | ≥ 0 · ≤ 10000 |
completedrequired | integer | ≥ 0 · ≤ 10000 |
worldrequired | null |
focusTarget#
object
| Field | Type | Constraints |
|---|---|---|
kindrequired | "any" | "workspace" | "window" | "app" | |
labelrequired | string | length 0–64 |
workspaceId | integer | ≥ 1 · ≤ 2147483647 |
appClass | string | length 0–128 |
questRef | questRef |
focusState#
The focus session. Phase times are CLOCK_MONOTONIC milliseconds (null when idle, ready or paused); remainingMs is at publication time; creditedMs and crediting are sampled at most every 10 s and on every phase change.
object
| Field | Type | Constraints |
|---|---|---|
staterequired | "idle" | "work" | "break" | "ready" | "paused" | |
pausedStaterequired | null | "work" | "break" | "ready" | |
sessionIdrequired | null | string | |
phaseStartedAtMsrequired | null | integer | |
phaseEndsAtMsrequired | null | integer | |
phaseMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
remainingMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
creditedMsrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
creditingrequired | boolean | |
cyclerequired | integer | ≥ 0 · ≤ 12 |
cyclesrequired | integer | ≥ 1 · ≤ 12 |
breakKindrequired | null | "short" | "long" | |
countModerequired | "focus" | "wall" | |
targetrequired | null | focusTarget | |
calmrequired | boolean |
guidanceConfig#
Every guidance setting (effective values or defaults).
object
| Field | Type | Constraints |
|---|---|---|
markers.reveal_msrequired | integer | ≥ 1000 · ≤ 15000 |
markers.reveal_moderequired | "timer" | "toggle" | |
markers.max_revealedrequired | integer | ≥ 4 · ≤ 16 |
markers.labelsrequired | integer | ≥ 2 · ≤ 8 |
markers.persistentrequired | "off" | "edge" | "always" | |
markers.core_drawrequired | boolean | |
quests.notificationsrequired | "all" | "important" | "off" | |
focus.work_minrequired | integer | ≥ 5 · ≤ 120 |
focus.short_break_minrequired | integer | ≥ 1 · ≤ 30 |
focus.long_break_minrequired | integer | ≥ 5 · ≤ 60 |
focus.long_break_everyrequired | integer | ≥ 2 · ≤ 12 |
focus.cyclesrequired | integer | ≥ 1 · ≤ 12 |
focus.auto_start_breaksrequired | boolean | |
focus.auto_start_workrequired | boolean | |
focus.count_moderequired | "focus" | "wall" | |
focus.idle_srequired | integer | ≥ 60 · ≤ 900 |
focus.grace_srequired | integer | ≥ 0 · ≤ 120 |
focus.calmrequired | boolean | |
focus.calm_npc_distancerequired | number | ≥ 2 · ≤ 20 |
focus.desktop_chiprequired | boolean | |
focus.history_daysrequired | integer | ≥ 0 · ≤ 365 |
guidanceOverrides#
Persisted guidance overrides (never null; may be empty).
object
| Field | Type | Constraints |
|---|---|---|
markers.reveal_ms | integer | ≥ 1000 · ≤ 15000 |
markers.reveal_mode | "timer" | "toggle" | |
markers.max_revealed | integer | ≥ 4 · ≤ 16 |
markers.labels | integer | ≥ 2 · ≤ 8 |
markers.persistent | "off" | "edge" | "always" | |
markers.core_draw | boolean | |
quests.notifications | "all" | "important" | "off" | |
focus.work_min | integer | ≥ 5 · ≤ 120 |
focus.short_break_min | integer | ≥ 1 · ≤ 30 |
focus.long_break_min | integer | ≥ 5 · ≤ 60 |
focus.long_break_every | integer | ≥ 2 · ≤ 12 |
focus.cycles | integer | ≥ 1 · ≤ 12 |
focus.auto_start_breaks | boolean | |
focus.auto_start_work | boolean | |
focus.count_mode | "focus" | "wall" | |
focus.idle_s | integer | ≥ 60 · ≤ 900 |
focus.grace_s | integer | ≥ 0 · ≤ 120 |
focus.calm | boolean | |
focus.calm_npc_distance | number | ≥ 2 · ≤ 20 |
focus.desktop_chip | boolean | |
focus.history_days | integer | ≥ 0 · ≤ 365 |
guidancePatch#
Changed keys only; null removes the persisted override (back to the default).
object · entries ≥ 1
| Field | Type | Constraints |
|---|---|---|
markers.reveal_ms | null | integer | |
markers.reveal_mode | null | "timer" | "toggle" | |
markers.max_revealed | null | integer | |
markers.labels | null | integer | |
markers.persistent | null | "off" | "edge" | "always" | |
markers.core_draw | null | boolean | |
quests.notifications | null | "all" | "important" | "off" | |
focus.work_min | null | integer | |
focus.short_break_min | null | integer | |
focus.long_break_min | null | integer | |
focus.long_break_every | null | integer | |
focus.cycles | null | integer | |
focus.auto_start_breaks | null | boolean | |
focus.auto_start_work | null | boolean | |
focus.count_mode | null | "focus" | "wall" | |
focus.idle_s | null | integer | |
focus.grace_s | null | integer | |
focus.calm | null | boolean | |
focus.calm_npc_distance | null | number | |
focus.desktop_chip | null | boolean | |
focus.history_days | null | integer |
guidanceSettings#
object
| Field | Type | Constraints |
|---|---|---|
configrequired | guidanceConfig | |
defaultsrequired | guidanceConfig | |
overridesrequired | guidanceOverrides | |
rangesrequired | object | |
markers.reveal_msrequired | number[2] | |
markers.max_revealedrequired | number[2] | |
markers.labelsrequired | number[2] | |
focus.work_minrequired | number[2] | |
focus.short_break_minrequired | number[2] | |
focus.long_break_minrequired | number[2] | |
focus.long_break_everyrequired | number[2] | |
focus.cyclesrequired | number[2] | |
focus.idle_srequired | number[2] | |
focus.grace_srequired | number[2] | |
focus.calm_npc_distancerequired | number[2] | |
focus.history_daysrequired | number[2] | |
optionsrequired | object | |
markers.reveal_moderequired | ("timer" | "toggle")[] | items ≥ 1 · unique items |
markers.persistentrequired | ("off" | "edge" | "always")[] | items ≥ 1 · unique items |
quests.notificationsrequired | ("all" | "important" | "off")[] | items ≥ 1 · unique items |
focus.count_moderequired | ("focus" | "wall")[] | items ≥ 1 · unique items |
pathrequired | string | length ≤ 4096 |
errorrequired | string | length ≤ 4096 |
objectiveInput#
manual: the user marks it done. reach: target (default the step target; one of them must exist), radius in metres (default 4; area/zone bounds for area and zone targets). focus: sessions, minutes per session (default 0.8 x focus.work_min), focusTarget (default quest: only sessions started from this quest count).
one of 3
| Field | Type | Constraints |
|---|---|---|
when type = "manual" | object | |
idrequired | questSlug | |
typerequired | "manual" | |
count | integer | ≥ 1 · ≤ 100 |
label | string | length 0–64 |
when type = "reach" | object | |
idrequired | questSlug | |
typerequired | "reach" | |
count | integer | ≥ 1 · ≤ 100 |
label | string | length 0–64 |
target | questTarget | |
radius | number | ≥ 0.5 · ≤ 100 |
when type = "focus" | object | |
idrequired | questSlug | |
typerequired | "focus" | |
count | integer | ≥ 1 · ≤ 100 |
label | string | length 0–64 |
sessionsrequired | integer | ≥ 1 · ≤ 12 |
minutes | number | ≥ 1 · ≤ 120 |
focusTarget | "quest" | "any" |
stepInput#
id defaults to step-N; objectives default to [{"id": "done", "type": "manual"}].
object
| Field | Type | Constraints |
|---|---|---|
id | questSlug | |
titlerequired | string | length 1–64 |
optional | boolean | |
any | boolean | |
target | questTarget | |
objectives | objectiveInput[] | items 1–8 |
personalQuestInput#
A personal quest definition. On create, id is derived from the title when absent; on update it is ignored (questRef wins). expires is a local date-time YYYY-MM-DDTHH:MM.
object
questSummary#
object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | questRef | |
titlerequired | string | length 1–64 |
categoryrequired | "main" | "side" | "discovery" | "personal" | "work" | |
staterequired | "available" | "active" | "completed" | "failed" | "abandoned" | |
trackedrequired | boolean | |
steprequired | any of 2 | |
variant 1 | null | |
variant 2 | object | |
idrequired | questSlug | |
titlerequired | string | length 1–64 |
progressrequired | questProgress | |
progressrequired | questProgress | |
offWorldrequired | boolean | |
updatedAtrequired | string | length 16–40 · pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}(:[0-9]{2}(\.[0-9]{1,9})?)?(Z|[+-][0-9]{2}:[0-9]{2})?$ |
questObjective#
object
| Field | Type | Constraints |
|---|---|---|
idrequired | questSlug | |
typerequired | "manual" | "reach" | "focus" | |
labelrequired | string | length 0–64 |
countrequired | integer | ≥ 1 · ≤ 100 |
donerequired | integer | ≥ 0 · ≤ 100 |
target | questTarget | |
radius | number | ≥ 0.5 · ≤ 100 |
sessions | integer | ≥ 1 · ≤ 12 |
minutes | number | ≥ 1 · ≤ 120 |
focusTarget | "quest" | "any" | |
creditedMinutes | number | ≥ 0 · ≤ 1000000 |
questStep#
object
| Field | Type | Constraints |
|---|---|---|
idrequired | questSlug | |
titlerequired | string | length 1–64 |
optionalrequired | boolean | |
anyrequired | boolean | |
staterequired | "pending" | "current" | "done" | |
targetrequired | null | questTarget | |
objectivesrequired | questObjective[] | items 1–8 |
questDetail#
object
| Field | Type | Constraints |
|---|---|---|
questRefrequired | questRef | |
titlerequired | string | length 1–64 |
summaryrequired | string | length 0–1000 |
categoryrequired | "main" | "side" | "discovery" | "personal" | "work" | |
staterequired | "available" | "active" | "completed" | "failed" | "abandoned" | |
trackedrequired | boolean | |
sequentialrequired | boolean | |
expiresrequired | null | string | |
createdAtrequired | string | length 16–40 · pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}(:[0-9]{2}(\.[0-9]{1,9})?)?(Z|[+-][0-9]{2}:[0-9]{2})?$ |
updatedAtrequired | string | length 16–40 · pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}(:[0-9]{2}(\.[0-9]{1,9})?)?(Z|[+-][0-9]{2}:[0-9]{2})?$ |
completedAtrequired | null | string | |
personalrequired | boolean | |
stepsrequired | questStep[] | items 1–16 |
focusTargetInput#
What credits work time; default {"kind": "any"}.
one of 4
| Field | Type | Constraints |
|---|---|---|
when kind = "any" | object | |
kindrequired | "any" | |
label | string | length 0–64 |
when kind = "workspace" | object | |
kindrequired | "workspace" | |
workspaceIdrequired | integer | ≥ 1 · ≤ 2147483647 |
label | string | length 0–64 |
when kind = "window" | object | |
kindrequired | "window" | |
appClassrequired | string | length 1–128 |
workspaceIdrequired | integer | ≥ 1 · ≤ 2147483647 |
label | string | length 0–64 |
when kind = "app" | object | |
kindrequired | "app" | |
appClassrequired | string | length 1–128 |
label | string | length 0–64 |
focusOverrides#
One-off values for this session (work_min may go below the 5-minute setting floor).
object
| Field | Type | Constraints |
|---|---|---|
work_min | integer | ≥ 1 · ≤ 120 |
short_break_min | integer | ≥ 1 · ≤ 30 |
long_break_min | integer | ≥ 1 · ≤ 60 |
long_break_every | integer | ≥ 2 · ≤ 12 |
cycles | integer | ≥ 1 · ≤ 12 |
count_mode | "focus" | "wall" | |
idle_s | integer | ≥ 60 · ≤ 900 |
grace_s | integer | ≥ 0 · ≤ 120 |
calm | boolean | |
auto_start_breaks | boolean | |
auto_start_work | boolean |
focusInterval#
One finished interval (also one line of focus/history.jsonl). Never titles.
object
| Field | Type | Constraints |
|---|---|---|
startrequired | string | length 16–40 · pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}(:[0-9]{2}(\.[0-9]{1,9})?)?(Z|[+-][0-9]{2}:[0-9]{2})?$ |
endrequired | string | length 16–40 · pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}(:[0-9]{2}(\.[0-9]{1,9})?)?(Z|[+-][0-9]{2}:[0-9]{2})?$ |
phaserequired | "work" | "break" | |
plannedMinrequired | number | ≥ 0 · ≤ 120 |
creditedMinrequired | number | ≥ 0 · ≤ 120 |
targetKindrequired | string | length 1–32 · pattern ^[a-z]+$ |
appClass | string | length 0–128 |
workspaceId | integer | ≥ 1 · ≤ 2147483647 |
questId | string | length 3–200 · pattern ^[^/]{1,128}/[a-z0-9][a-z0-9-]{0,63}$ |
outcomerequired | "completed" | "skipped" | "stopped" |
objectRef#
string · length 1–256 · pattern ^(package/[a-z0-9]([a-z0-9-]{0,62}[a-z0-9])?|library/[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)+@(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?/[a-z][a-z0-9-]*|user/[a-z][a-z0-9-]*)$
objectId#
string · length 1–128 · pattern ^[a-z0-9]([a-z0-9-]{0,62}[a-z0-9])?$
objectPose#
object
| Field | Type | Constraints |
|---|---|---|
positionrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
rotationrequired | number[4] | each ≥ -1 · each ≤ 1 |
objectScale#
number · ≥ 0.25 · ≤ 4
objectRule#
"playable" | "walls" | "support" | "window" | "approach" | "zone" | "keep-clear" | "player" | "reach"
objectTraitName#
"decorative" | "collidable" | "movable" | "character" | "mover" | "seat" | "mount" | "machine" | "interactive"
objectBounds#
object
| Field | Type | Constraints |
|---|---|---|
minrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
maxrequired | number[3] | each ≥ -100000 · each ≤ 100000 |
objectPocketItem#
object
| Field | Type | Constraints |
|---|---|---|
itemIdrequired | string | length 1–64 · pattern ^pocket-[0-9]+$ |
refrequired | objectRef | |
namerequired | string | length 1–64 |
objectInstance#
object
| Field | Type | Constraints |
|---|---|---|
idrequired | objectId | |
sourcerequired | "authored" | "user" | |
refrequired | null | objectRef | |
namerequired | string | length 1–64 |
areaIdrequired | string | length 0–128 |
poserequired | objectPose | |
scalerequired | number | ≥ 0.01 · ≤ 100 |
staterequired | "active" | "hidden" | "missing" | "blocked" | "loading" | "suspended" | |
movablerequired | boolean | |
lockedrequired | boolean | |
rulerequired | null | objectRule | |
pathrequired | null | |
activityrequired | null | |
seatrequired | null |
objectsState#
object
| Field | Type | Constraints |
|---|---|---|
catalogRevisionrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
instancesrequired | objectInstance[] | items ≤ 512 |
pocketrequired | objectPocketItem[] | items ≤ 16 |
usagerequired | object | |
placementsrequired | integer | ≥ 0 · ≤ 1024 |
assetsrequired | integer | ≥ 0 · ≤ 1024 |
trianglesrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
gpuBytesrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
collisionTrianglesrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
limitsrequired | object | |
placementsrequired | integer | ≥ 0 · ≤ 1024 |
assetsrequired | integer | ≥ 0 · ≤ 1024 |
trianglesrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
gpuBytesrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
collisionTrianglesrequired | integer | ≥ 0 · ≤ 2⁵³−1 |
catalogEntry#
object
| Field | Type | Constraints |
|---|---|---|
refrequired | objectRef | |
sourcerequired | "package" | "library" | "user" | |
idrequired | string | length 1–64 |
versionrequired | null | string | |
formatVersionrequired | null | string | |
namerequired | string | length 1–64 |
descriptionrequired | null | string | |
categoryrequired | "furniture" | "lighting" | "plants" | "signage" | "machines" | "decor" | "characters" | "vehicles" | "other" | |
tagsrequired | string[] | items ≤ 8 · each length 1–64 |
traitsrequired | objectTraitName[] | items ≤ 9 · unique items |
surfacesrequired | null | ("floor" | "wall" | "ceiling" | "any")[] | |
scalerequired | null | number[2] | |
boundsrequired | null | objectBounds | |
trianglesrequired | null | integer | |
gpuBytesrequired | null | integer | |
collisionTrianglesrequired | null | integer | |
thumbnailrequired | null | string | |
licenserequired | null | string | |
libraryrequired | null | string | |
versionsrequired | string[] | items ≤ 16 · each length 1–256 |
staterequired | "ready" | "invalid" | |
placeablerequired | boolean | |
reasonrequired | null | string | |
errorsrequired | string[] | items ≤ 8 · each length 1–512 |
libraryRecord#
object
| Field | Type | Constraints |
|---|---|---|
idrequired | string | length 1–128 · pattern ^[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)+$ |
versionrequired | string | length 1–256 · pattern ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$ |
namerequired | string | length 0–64 |
formatVersionrequired | null | string | |
objectsrequired | integer | ≥ 0 · ≤ 256 |
rootrequired | "user" | "system" | |
staterequired | "ready" | "invalid" | "conflict" | |
errorsrequired | string[] | items ≤ 8 · each length 1–512 |
digestrequired | null | string |
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 | |
rule | string | length 1–64 |
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 | hud.subscribe.request | hud.unsubscribe.request | recording.start.request | recording.stop.request | recording.mark.request | recording.status.request | replay.start.request | replay.stop.request | replay.status.request | capture.annotate.request | player.get.request | player.set.request | surface.pocket.request | surface.unpocket.request | markers.reveal.request | guidance.get.request | guidance.set.request | quests.list.request | quests.get.request | quests.track.request | quests.accept.request | quests.abandon.request | quests.resume.request | quests.create.request | quests.update.request | quests.delete.request | quests.mark.request | focus.start.request | focus.pause.request | focus.resume.request | focus.skip.request | focus.stop.request | focus.history.request | objects.catalog.request | objects.pocket.request | objects.place.request | objects.transform.request | objects.remove.request | objects.hide.request | objects.reset.request | objects.configure.request | libraries.list.request | libraries.install.request | libraries.remove.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 | hud.subscribe.response | hud.unsubscribe.response | recording.start.response | recording.stop.response | recording.mark.response | recording.status.response | replay.start.response | replay.stop.response | replay.status.response | capture.annotate.response | player.get.response | player.set.response | surface.pocket.response | surface.unpocket.response | markers.reveal.response | guidance.get.response | guidance.set.response | quests.list.response | quests.get.response | quests.track.response | quests.accept.response | quests.abandon.response | quests.resume.response | quests.create.response | quests.update.response | quests.delete.response | quests.mark.response | focus.start.response | focus.pause.response | focus.resume.response | focus.skip.response | focus.stop.response | focus.history.response | objects.catalog.response | objects.pocket.response | objects.place.response | objects.transform.response | objects.remove.response | objects.hide.response | objects.reset.response | objects.configure.response | libraries.list.response | libraries.install.response | libraries.remove.response
notification#
state.delta.notification | runtime.notice.notification | session.revoked.notification | location.transition.notification | ui.opened.notification | ui.closed.notification | data.updated.notification | mounts.changed.notification | presentation.changed.notification | hud.frame.notification | hud.pose.notification | zone.entered.notification | zone.exited.notification | tool.changed.notification | ui.hud.cycle.notification | capture.taken.notification | quest.progress.notification | focus.phase.notification
Mirrored byte-for-byte from hyprune/schema at 34849da45183 (2026-10-15). SHA-256 ac0cb5e1eaecc8ec61e2a793b45e710f2b6cda45f98af42549dc929f22cca0f8.