Skip to content

IPC protocol 0.21

Schema reference / IPC protocol / 0.21

JSON-RPC 2.0 frames between core and shells, SDK clients and tools: every method’s params and result, notifications, state and errors.

Status
Frozen · latest is 0.28
Published
2026-10-12
Title
“Hyprune IPC 0.21: markers, personal quests and focus sessions”
Dialect
JSON Schema 2020-12 · unknown fields rejected unless marked
Raw schemaipc.schema.json · 15,726 lines · 353 KB
DownloadOpen rawsha256 6f5ff8089934…
Loading ipc.schema.json…

Changes since 0.20

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.json 0.9 and the 0.10 draft), library and library release-record schemas.

Structural diff against 0.20: 46 entries added, 10 entries changed. Descriptions and $id changes are ignored.

56 changes
  • addedactiveQuest
  • addedfocusInterval
  • addedfocusOverrides
  • addedfocusState
  • addedfocusTarget
  • addedfocusTargetInput
  • addedguidanceConfig
  • addedguidanceMarker
  • addedguidanceOverrides
  • addedguidancePatch
  • addedguidanceSettings
  • addedmarkerSource
  • addedmarkersState
  • addedmethod focus.history
  • addedmethod focus.pause
  • addedmethod focus.resume
  • addedmethod focus.skip
  • addedmethod focus.start
  • addedmethod focus.stop
  • addedmethod guidance.get
  • addedmethod guidance.set
  • addedmethod markers.reveal
  • addedmethod quests.abandon
  • addedmethod quests.accept
  • addedmethod quests.create
  • addedmethod quests.delete
  • addedmethod quests.get
  • addedmethod quests.list
  • addedmethod quests.mark
  • addedmethod quests.resume
  • addedmethod quests.track
  • addedmethod quests.update
  • addednotification focus.phase
  • addednotification quest.progress
  • addedobjectiveInput
  • addedpersonalQuestInput
  • addedquestDetail
  • addedquestObjective
  • addedquestProgress
  • addedquestRef
  • addedquestSlug
  • addedquestsState
  • addedquestStep
  • addedquestSummary
  • addedquestTarget
  • addedstepInput
  • changedinputConfig
    • + modes.world.markers.reveal string[] (required) · items ≤ 3 · unique items · each length 1–96
  • changedmarker
    • + markerId string · length 1–160
  • changedmethod session.hello
    • ~ params.capabilities adds "camera.author", "quest.control")[]; removes "camera.author")[]
    • ~ result.protocol "0.20" (required) → "0.21" (required)
    • ~ result.capabilities adds "camera.author", "quest.control")[]; removes "camera.author")[]
    • ~ result.methods adds … (84 values))[]; removes … (65 values))[]
    • ~ result.events adds … (18 values))[]; removes … (16 values))[]
  • changednotification
    • ~ (definition) :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 → :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
  • changednotification state.delta
    • + params.changes.markers markersState
    • + params.changes.quests questsState
    • + params.changes.focus focusState
  • changedoverlayStyle
    • + questColor number[3] (required) · each ≥ 0 · each ≤ 1
  • changedoverlayStylePatch
    • + questColor number[3] · each ≥ 0 · each ≤ 1
  • changedrequest
    • ~ (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 → :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
  • changedresponse
    • ~ (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 → :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
  • changedstate
    • + markers markersState (required)
    • + quests questsState (required)
    • + focus focusState (required)

Methods

Each method is a JSON-RPC 2.0 request {jsonrpc, id, method, params} answered by {jsonrpc, id, result} or an error. Params and results are listed below.

session.hello#

params · object

FieldTypeConstraints
protocolsrequiredstring[]items ≥ 1 · unique items · each length 1–256
clientrequiredobject
idrequiredid
namerequiredstringlength 1–256
capabilitiesrequired("state.read" | "world.control" | "surface.control" | "movement.control" | "shell.control" | "runtime.control" | "data.publish" | "input.control" | "camera.author" | "quest.control")[]items ≥ 0 · unique items
tokenstringlength 64 · pattern ^[a-f0-9]{64}$

result · object

FieldTypeConstraints
protocolrequired"0.21"
sessionIdrequiredstringlength 1–128
capabilitiesrequired("state.read" | "world.control" | "surface.control" | "movement.control" | "shell.control" | "runtime.control" | "data.publish" | "input.control" | "camera.author" | "quest.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" | … (84 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

session.ping#

params · {} (no fields)

result · object

FieldTypeConstraints
monotonicMsrequiredrevision

state.subscribe#

params · object

FieldTypeConstraints
topicsrequired["state"]

result · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–128
snapshotrequiredsnapshot

state.snapshot#

params · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–128

result · object

FieldTypeConstraints
snapshotrequiredsnapshot

state.unsubscribe#

params · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–128

result · object

FieldTypeConstraints
okrequiredtrue

world.load#

params · object

FieldTypeConstraints
worldIdrequiredid
spawnIdslug

result · object

FieldTypeConstraints
revisionrequiredrevision

surface.focus#

params · object

FieldTypeConstraints
surfaceIdrequiredstringlength 1–128
intentrequired"pointer" | "keyboard"

result · object

FieldTypeConstraints
revisionrequiredrevision

movement.set#

params · object

FieldTypeConstraints
modeIdrequiredid

result · object

FieldTypeConstraints
revisionrequiredrevision

shell.claim#

params · object

FieldTypeConstraints
outputsrequiredstring[]items ≥ 1 · unique items · each length 1–128

result · object

FieldTypeConstraints
leaseIdrequiredstringlength 1–128
revisionrequiredrevision

shell.release#

params · object

FieldTypeConstraints
leaseIdrequiredstringlength 1–128

result · object

FieldTypeConstraints
revisionrequiredrevision

shell.overlay#

params · object

FieldTypeConstraints
leaseIdrequiredstringlength 1–128
outputIdrequiredstringlength 1–128
visiblerequiredboolean
exclusiveInputrequiredboolean

result · object

FieldTypeConstraints
revisionrequiredrevision

runtime.exit#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredrevision

camera.get#

params · {} (no fields)

result · object

FieldTypeConstraints
positionrequirednumber[3]each ≥ -100000 · each ≤ 100000
orientationrequirednumber[4]
rollrequirednumber≥ -3.141593 · ≤ 3.141593
fovrequirednumber≥ 3 · ≤ 140
lensShiftrequirednumber[2]each ≥ -2 · each ≤ 2
heldrequiredboolean
renderScalerequirednumber | null

camera.set#

params · object

FieldTypeConstraints
positionrequirednumber[3]each ≥ -100000 · each ≤ 100000
orientationrequirednumber[4]

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

waypoint.set#

params · one of 2

FieldTypeConstraints
variant 1object
idrequiredstringlength 1–128
labelrequiredstringlength 1–256
targetrequiredtarget
variant 2object
idrequiredstringlength 1–128
labelrequiredstringlength 1–256
positionrequirednumber[3]each ≥ -100000 · each ≤ 100000

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

waypoint.clear#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

route.set#

params · object

FieldTypeConstraints
pointsrequiredtarget[]items 1–64

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

route.clear#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

travel.start#

params · object

FieldTypeConstraints
torequiredtarget
durationMsinteger≥ 0 · ≤ 10000

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

travel.cancel#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

autodrive.start#

params · object

FieldTypeConstraints
speednumber≥ 0.1 · ≤ 10

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

autodrive.stop#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

ui.open#

params · object

FieldTypeConstraints
leaseIdrequiredstringlength 1–128
outputIdrequiredstringlength 1–128
panelrequiredstringlength 1–128

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

ui.close#

params · object

FieldTypeConstraints
leaseIdrequiredstringlength 1–128
outputIdrequiredstringlength 1–128

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

data.publish#

params · object

FieldTypeConstraints
sourceIdrequiredid
valuesrequiredmap → number | boolean | stringentries ≤ 32 · keys: length ≤ 128
sequencerequiredinteger≥ 0 · ≤ 2⁵³−1
ttlMsinteger≥ 100 · ≤ 60000

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

data.remove#

params · object

FieldTypeConstraints
sourceIdrequiredid

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

shell.bind#

params · object

FieldTypeConstraints
leaseIdrequiredstringlength 1–128
pidrequiredinteger≥ 1 · ≤ 2147483647

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

workspace.activate#

params · object

FieldTypeConstraints
idrequiredinteger≥ 1 · ≤ 2147483647

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

workspace.bind#

params · object

FieldTypeConstraints
idrequiredinteger≥ 1 · ≤ 2147483647
worldIdrequiredid
areaIdrequiredslug

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

workspace.focus#

params · object

FieldTypeConstraints
idrequiredinteger≥ 1 · ≤ 2147483647

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

workspace.unfocus#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

surface.pull#

params · object

FieldTypeConstraints
surfaceIdrequiredstringlength 1–256

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

surface.place#

params · object

FieldTypeConstraints
surfaceIdrequiredstringlength 1–256
anchorIdslug

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

surface.return#

params · object

FieldTypeConstraints
surfaceIdrequiredstringlength 1–256

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

placements.list#

params · {} (no fields)

result · object

FieldTypeConstraints
placementsrequiredany of 2[]items ≤ 128
variant 1object
worldIdrequiredid
areaIdrequiredslug
anchorIdrequiredslug
rulerequiredobject
appClassrequiredstringlength 1–256
titlerequiredstringlength ≤ 256
contentplacementContent
when anchorId = ""object
worldIdrequiredid
areaIdrequiredslug
anchorIdrequired""
rulerequiredobject
appClassrequiredstringlength 1–256
titlerequiredstringlength ≤ 256
poserequiredpose
sizerequiredsize2
contentplacementContent

placements.remove#

params · object

FieldTypeConstraints
worldIdrequiredid
areaIdrequiredslug
rulerequiredobject
appClassrequiredstringlength 1–256
titlerequiredstringlength ≤ 256

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

data.object.bind#

params · object

FieldTypeConstraints
objectIdrequiredslug
sourceIdrequiredid

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

atmosphere.get#

params · {} (no fields)

result · object

FieldTypeConstraints
profilerequirednull | authorAtmosphere
qualityrequired"high" | "intel"

atmosphere.set#

params · object

FieldTypeConstraints
profilerequiredauthorAtmosphere

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

camera.fov#

params · object

FieldTypeConstraints
degreesrequirednumber≥ 30 · ≤ 110

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

surfaces.recall#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

input.get#

params · {} (no fields)

result · object

FieldTypeConstraints
configrequiredinputConfig
conflictsrequiredinputConflicts
stealsrequiredinputSteals
pathrequiredstringlength ≤ 4096

input.preview#

params · object

FieldTypeConstraints
configrequiredinputConfig

result · object

FieldTypeConstraints
configrequiredinputConfig
conflictsrequiredinputConflicts
stealsrequiredinputSteals

input.set#

params · object

FieldTypeConstraints
configrequiredinputConfig

result · object

FieldTypeConstraints
revisionrequiredrevision

input.capture#

params · object

FieldTypeConstraints
leaseIdrequiredstringlength ≤ 128
moderequired"world" | "interactive" | "focus" | "menu"
actionrequiredstringlength ≤ 128
slotrequiredinteger≥ 0 · ≤ 2

result · object

FieldTypeConstraints
revisionrequiredrevision

input.capture.cancel#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredrevision

overlay.style#

params · object

FieldTypeConstraints
leaseIdrequiredstringlength 1–128
stylerequiredoverlayStylePatch

result · object

FieldTypeConstraints
stylerequiredoverlayStyle

graphics.get#

params · {} (no fields)

result · object

FieldTypeConstraints
configrequiredgraphicsConfig
effectiverequiredgraphicsConfig
overridesrequiredgraphicsPatch
pathrequiredstringlength ≤ 4096
errorrequiredstring
presetsrequiredmap → graphicsPatch
optionsrequiredmap → any[]
unsupportedrequired("ssr" | "runtime_shadows" | "contact_shadows")[]
timingsrequiredobject

Extensible diagnostic measurements; GPU timings can be null when unavailable.

performancerequiredperformance

graphics.set#

params · object

FieldTypeConstraints
patchrequiredgraphicsPatch

result · graphics.get.result

hud.subscribe#

params · object

FieldTypeConstraints
topicsrequired("hud.frame" | "hud.pose" | "zone.entered" | "zone.exited" | "tool.changed")[]items 1–5 · unique items

result · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–256

hud.unsubscribe#

params · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–256

result · object

FieldTypeConstraints
okrequiredtrue

recording.start#

params · object

FieldTypeConstraints
includeAppKeysboolean

result · recordingStatus

recording.stop#

params · {} (no fields)

result · recordingStatus

recording.mark#

params · object

FieldTypeConstraints
namerequiredstringlength 1–64

result · recordingStatus

recording.status#

params · {} (no fields)

result · recordingStatus

replay.start#

params · object

FieldTypeConstraints
pathrequiredstringlength 1–4096
mode"input" | "camera"
smoothingMsnumber≥ 0 · ≤ 1000
assertionsreplayAssertions

result · recordingStatus

replay.stop#

params · {} (no fields)

result · recordingStatus

replay.status#

params · {} (no fields)

result · recordingStatus

camera.photo#

params · object

FieldTypeConstraints
positionrequirednumber[3]each ≥ -100000 · each ≤ 100000
orientationrequirednumber[4]
fovrequirednumber≥ 5 · ≤ 140
renderScalerequirednumber≥ 0.25 · ≤ 1
lensShiftnumber[2]each ≥ -2 · each ≤ 2

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

camera.release#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

capture.annotate#

params · object

FieldTypeConstraints
captureIdrequiredcaptureId
noterequiredstringlength ≤ 1000 · pattern ^[^\u0000-\u001f\u007f-\u009f]*$

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

player.get#

params · {} (no fields)

result · playerSettings

player.set#

params · object

FieldTypeConstraints
patchrequiredplayerPatch

result · playerSettings

surface.pocket#

params · object

FieldTypeConstraints
surfaceIdrequiredstringlength 1–256

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

surface.unpocket#

params · object

FieldTypeConstraints
surfaceIdrequiredstringlength 1–256

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1
placedrequiredboolean

markers.reveal#

params · object

FieldTypeConstraints
durationMsinteger≥ 1000 · ≤ 15000

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

guidance.get#

params · {} (no fields)

result · guidanceSettings

guidance.set#

params · object

FieldTypeConstraints
patchrequiredguidancePatch

result · guidanceSettings

quests.list#

params · object

FieldTypeConstraints
states("available" | "active" | "completed" | "failed" | "abandoned")[]items 1–5 · unique items
sourcesstring[]items 1–64 · unique items · each length 1–128

result · object

FieldTypeConstraints
questsrequiredquestSummary[]items ≤ 256

quests.get#

params · object

FieldTypeConstraints
questRefrequiredquestRef

result · object

FieldTypeConstraints
questrequiredquestDetail

quests.track#

params · object

FieldTypeConstraints
questRefrequirednull | questRef

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

quests.accept#

params · object

FieldTypeConstraints
questRefrequiredquestRef

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

quests.abandon#

params · object

FieldTypeConstraints
questRefrequiredquestRef

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

quests.resume#

params · object

FieldTypeConstraints
questRefrequiredquestRef

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

quests.create#

params · object

FieldTypeConstraints
questrequiredpersonalQuestInput

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1
questRefrequiredquestRef

quests.update#

params · object

FieldTypeConstraints
questRefrequiredquestRef
questrequiredpersonalQuestInput

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

quests.delete#

params · object

FieldTypeConstraints
questRefrequiredquestRef

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

quests.mark#

params · object

FieldTypeConstraints
questRefrequiredquestRef
stepIdrequiredquestSlug
objectiveIdrequiredquestSlug

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

focus.start#

params · object

FieldTypeConstraints
targetfocusTargetInput
questRefquestRef
objectiveIdquestSlug
overridesfocusOverrides

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1
sessionIdrequiredstringlength 1–64 · pattern ^focus-[0-9a-f]{1,58}$

focus.pause#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

focus.resume#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

focus.skip#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

focus.stop#

params · {} (no fields)

result · object

FieldTypeConstraints
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

focus.history#

params · object

FieldTypeConstraints
daysinteger≥ 1 · ≤ 365

result · object

FieldTypeConstraints
intervalsrequiredfocusInterval[]items ≤ 512

Notifications

state.delta#

params · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–128
sessionIdrequiredstringlength 1–128
baseRevisionrequiredrevision
revisionrequiredrevision
changesrequiredobjectentries ≥ 1
runtimeobject
activerequiredboolean
outputsrequiredstring[]items ≥ 0 · unique items · each length 1–128
worldany of 2
variant 1null
variant 2object
idrequiredid
spawnIdrequiredslug
surfacesobject[]items ≥ 0
idrequiredstringlength 1–128
kindrequired"window" | "workspace" | "layer" | "web" | "custom"
titlerequiredstringlength 0–512
logicalSizerequirednumber[2]each > 0
focusedrequiredboolean
movementobject
modeIdrequiredid
positionrequirednumber[3]
orientationrequirednumber[4]
staterequired"walking" | "flying" | "climbing"
ladderIdrequirednull | string
promptrequiredstringlength ≤ 256
shellobject
leasesrequiredobject[]items ≥ 0
idrequiredstringlength 1–128
outputsrequiredstring[]items ≥ 1 · unique items · each length 1–128
overlaysrequiredobject[]items ≥ 0
outputIdrequiredstringlength 1–128
visiblerequiredboolean
exclusiveInputrequiredboolean
locationlocation
integrationsintegrations
spatialspatial
workspacesworkspaces
mountsmounts
presentationpresentation
appsapps
interactioninteraction
keymapkeymap
editoreditor
markersmarkersState
questsquestsState
focusfocusState

runtime.notice#

params · object

FieldTypeConstraints
levelrequired"info" | "warning" | "error"
coderequiredstringlength 1–256
messagerequiredstringlength 1–4096

session.revoked#

params · object

FieldTypeConstraints
reasonrequiredstringlength 1–4096

location.transition#

params · object

FieldTypeConstraints
phaserequired"departing" | "travelling" | "arrived" | "cancelled" | "loading" | "failed"
progressrequirednull | number
torequireddestination
sessionIdrequiredstringlength 1–128
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1
idrequiredstringlength 1–128
outputIdrequirednull | string
monotonicMsrequiredinteger≥ 0 · ≤ 2⁵³−1

ui.opened#

params · object

FieldTypeConstraints
leaseIdrequiredstringlength 1–128
outputIdrequiredstringlength 1–128
panelrequired"director" | "overview" | "map"
sessionIdrequiredstringlength 1–128
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

ui.closed#

params · object

FieldTypeConstraints
leaseIdrequiredstringlength 1–128
outputIdrequiredstringlength 1–128
sessionIdrequiredstringlength 1–128
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

data.updated#

params · object

FieldTypeConstraints
sourceIdrequiredid
valuesrequiredmap → number | boolean | stringentries ≤ 32 · keys: length ≤ 128
sequencerequiredinteger≥ 0 · ≤ 2⁵³−1
monotonicMsrequiredinteger≥ 0 · ≤ 2⁵³−1
ttlMsrequiredinteger≥ 100 · ≤ 60000
sessionIdrequiredstringlength 1–128
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

mounts.changed#

params · object

FieldTypeConstraints
sessionIdrequiredstringlength 1–256
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1
mountsrequiredmounts

presentation.changed#

params · object

FieldTypeConstraints
sessionIdrequiredstringlength 1–256
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1
presentationrequiredpresentation

hud.frame#

params · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–256
sessionIdrequiredstringlength 1–256
revisionrequiredinteger≥ 0
monotonicMsrequiredinteger≥ 0
fpsrequirednumber≥ 0
frameMsrequirednumber≥ 0
cpuMsrequirednumber≥ 0
gpuMsrequirednumber | null
renderScalerequirednumber≥ 0 · ≤ 1
presetrequired"auto" | "low" | "medium" | "high" | "ultra"

hud.pose#

params · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–256
sessionIdrequiredstringlength 1–256
revisionrequiredinteger≥ 0
monotonicMsrequiredinteger≥ 0
outputIdrequiredstringlength 1–256
worldIdrequiredstringlength 1–256
worldNamerequiredstringlength 1–256
positionrequirednumber[3]
headingrequirednumber
pitchrequirednumber
zonerequiredhudZone | null
toolrequiredinteger≥ 1 · ≤ 5
subtyperequiredstringlength 1–256

zone.entered#

params · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–256
sessionIdrequiredstringlength 1–256
revisionrequiredinteger≥ 0
monotonicMsrequiredinteger≥ 0
zonerequiredhudZone

zone.exited#

params · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–256
sessionIdrequiredstringlength 1–256
revisionrequiredinteger≥ 0
monotonicMsrequiredinteger≥ 0
zonerequiredhudZone

tool.changed#

params · object

FieldTypeConstraints
subscriptionIdrequiredstringlength 1–256
sessionIdrequiredstringlength 1–256
revisionrequiredinteger≥ 0
monotonicMsrequiredinteger≥ 0
slotrequiredinteger≥ 1 · ≤ 5
namerequiredstringlength 1–256
subtyperequiredstringlength 1–256

ui.hud.cycle#

params · object

FieldTypeConstraints
sessionIdrequiredstringlength 1–256
revisionrequiredinteger≥ 0
monotonicMsrequiredinteger≥ 0
leaseIdrequiredstringlength 1–256
outputIdrequiredstringlength 1–256
sequencerequiredinteger≥ 0

capture.taken#

params · object

FieldTypeConstraints
captureIdrequiredcaptureId
timestampMsrequiredinteger≥ 0 · ≤ 2⁵³−1
moderequired"world" | "interactive" | "focus" | "cursor" | "menu"
sessionIdrequiredstringlength 1–128
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

quest.progress#

params · object

FieldTypeConstraints
questRefrequiredquestRef
kindrequired"objective" | "step" | "completed" | "available" | "failed"
titlerequiredstringlength 1–64
stepIdquestSlug
stepTitlestringlength 1–64
nextStepTitlestringlength 1–64
objectiveIdquestSlug
progressquestProgress
sessionIdrequiredstringlength 1–128
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

focus.phase#

params · object

FieldTypeConstraints
focusSessionIdrequiredstringlength 1–64 · pattern ^focus-[0-9a-f]{1,58}$
phaserequired"work" | "break" | "ready" | "paused" | "ended"
cyclerequiredinteger≥ 0 · ≤ 12
cyclesrequiredinteger≥ 1 · ≤ 12
creditedMsrequiredinteger≥ 0 · ≤ 2⁵³−1
breakKind"short" | "long"
outcome"completed" | "skipped" | "stopped"
countedboolean
suggestionobject
markerIdrequiredstringlength 1–160
labelrequiredstringlength 0–48
sessionIdrequiredstringlength 1–128
revisionrequiredinteger≥ 0 · ≤ 2⁵³−1

Types

state#

object

FieldTypeConstraints
runtimerequiredobject
activerequiredboolean
outputsrequiredstring[]items ≥ 0 · unique items · each length 1–128
worldrequiredany of 2
variant 1null
variant 2object
idrequiredid
spawnIdrequiredslug
surfacesrequiredobject[]items ≥ 0
idrequiredstringlength 1–128
kindrequired"window" | "workspace" | "layer" | "web" | "custom"
titlerequiredstringlength 0–512
logicalSizerequirednumber[2]each > 0
focusedrequiredboolean
movementrequiredobject
modeIdrequiredid
positionrequirednumber[3]
orientationrequirednumber[4]
staterequired"walking" | "flying" | "climbing"
ladderIdrequirednull | string
promptrequiredstringlength ≤ 256
shellrequiredobject
leasesrequiredobject[]items ≥ 0
idrequiredstringlength 1–128
outputsrequiredstring[]items ≥ 1 · unique items · each length 1–128
overlaysrequiredobject[]items ≥ 0
outputIdrequiredstringlength 1–128
visiblerequiredboolean
exclusiveInputrequiredboolean
locationrequiredlocation
integrationsrequiredintegrations
spatialrequiredspatial
workspacesrequiredworkspaces
mountsrequiredmounts
presentationrequiredpresentation
interactionrequiredinteraction
appsrequiredapps
keymaprequiredkeymap
editorrequirededitor
markersrequiredmarkersState
questsrequiredquestsState
focusrequiredfocusState

snapshot#

object

FieldTypeConstraints
sessionIdrequiredstringlength 1–128
revisionrequiredrevision
staterequiredstate

target#

one of 2

FieldTypeConstraints
variant 1object
positionrequirednumber[3]each ≥ -100000 · each ≤ 100000
variant 2object
zoneIdrequiredstringlength 1–128

transition#

object

FieldTypeConstraints
phaserequired"departing" | "travelling" | "arrived" | "cancelled" | "loading" | "failed"
progressrequirednull | number
torequireddestination
idrequiredstringlength 1–128
outputIdrequirednull | string
monotonicMsrequiredinteger≥ 0 · ≤ 2⁵³−1

waypoint#

object

FieldTypeConstraints
idrequiredstringlength 1–128
labelrequiredstringlength 1–256
targetrequiredtarget
positionrequirednumber[3]each ≥ -100000 · each ≤ 100000

routePoint#

object

FieldTypeConstraints
targetrequiredtarget
positionrequirednumber[3]each ≥ -100000 · each ≤ 100000

source#

object

FieldTypeConstraints
sourceIdrequiredid
valuesrequiredmap → number | boolean | stringentries ≤ 32 · keys: length ≤ 128
sequencerequiredinteger≥ 0 · ≤ 2⁵³−1
monotonicMsrequiredinteger≥ 0 · ≤ 2⁵³−1
ttlMsrequiredinteger≥ 100 · ≤ 60000

location#

object

FieldTypeConstraints
zonesrequiredWorld zones
waypointrequirednull | waypoint
routerequiredroutePoint[]items 0–64
autodriverequiredboolean
transitionrequirednull | transition

integrations#

object

FieldTypeConstraints
sourcesrequiredsource[]items 0–32

destination#

one of 2

FieldTypeConstraints
variant 1target
variant 2object
worldIdrequiredid
spawnIdslug

map#

object

FieldTypeConstraints
svgrequiredstringlength 1–65536
sha256requiredstringpattern ^[a-f0-9]{64}$
boundsrequirednumber[4]
worldToMaprequirednumber[6]
levelsobject[]items 1–6
idrequiredstringpattern ^[a-z][a-z0-9-]{0,31}$
namerequiredstringlength 1–64
minYrequirednumber
maxYrequirednumber
svgrequiredstringlength 1–65536
sha256requiredstringpattern ^[a-f0-9]{64}$

marker#

object

FieldTypeConstraints
idrequiredstringlength 1–128
labelrequiredstringlength ≤ 256
xrequirednumber≥ 0 · ≤ 1
yrequirednumber≥ 0 · ≤ 1
distancerequirednumber≥ 0
occludedrequiredboolean
markerIdstringlength 1–160

spatial#

object

FieldTypeConstraints
worldrequiredany of 2
variant 1null
variant 2object
idrequiredid
namerequiredstringlength ≤ 256
placesrequiredobject[]items ≤ 64
idrequiredstringlength 1–128
namerequiredstringlength ≤ 256
positionrequirednumber[3]
maprequirednull | map
outputrequiredany of 2
variant 1null
variant 2object
idrequiredstringlength 1–128
namerequiredstringlength 1–128
widthrequiredinteger≥ 1
heightrequiredinteger≥ 1
scalerequirednumber> 0
projectionrequiredany of 2
variant 1null
variant 2object
outputIdrequiredstringlength 1–128
worldIdrequiredid
monotonicMsrequiredinteger≥ 0
markersrequiredmarker[]items ≤ 64

workspaces#

object

FieldTypeConstraints
currentIdrequirednull | integer
locationsrequiredobject[]items ≤ 32
idrequiredinteger≥ 1 · ≤ 2147483647
labelrequiredstringlength ≤ 256
worldIdrequiredid
spawnIdrequiredslug

mounts#

object

FieldTypeConstraints
areasrequiredarea[]items ≤ 32
anchorsrequiredobject[]items ≤ 128
idrequiredslug
poserequiredpose
sizerequiredsize2
mountrequiredmount
areaIdrequiredslug
bindingsrequiredobject[]items ≤ 32
idrequiredinteger≥ 1 · ≤ 2147483647
worldIdrequiredid
areaIdrequiredslug
placementsrequiredany of 2[]items ≤ 128
variant 1object
worldIdrequiredid
areaIdrequiredslug
anchorIdrequiredslug
rulerequiredobject
appClassrequiredstringlength 1–256
titlerequiredstringlength ≤ 256
contentplacementContent
when anchorId = ""object
worldIdrequiredid
areaIdrequiredslug
anchorIdrequired""
rulerequiredobject
appClassrequiredstringlength 1–256
titlerequiredstringlength ≤ 256
poserequiredpose
sizerequiredsize2
contentplacementContent
objectsrequiredobject[]items ≤ 128
idrequiredslug
areaIdrequiredslug
poserequiredpose
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"
sourceIdrequirednull | id
carriedSurfaceIdrequirednull | string
desktopWorkspaceIdrequirednull | integer
placementZonesrequiredplacementZone[]items ≤ 32
instancesrequiredobject[]items ≤ 16
surfaceIdrequiredstringlength 1–128
workspaceIdrequiredinteger≥ 1
areaIdslug
anchorIdrequiredstringlength ≤ 128
statusrequired"carried" | "placed" | "recalled"

presentation#

object

FieldTypeConstraints
profilerequirednull | authorAtmosphere
fovrequirednumber≥ 3 · ≤ 140
qualityrequired"high" | "intel"

interaction#

object

FieldTypeConstraints
moderequired"movement" | "typing" | "workspace" | "fullscreen" | "cursor"
toolrequiredinteger≥ 1 · ≤ 5
toolsrequired("pointer" | "mount" | "path" | "position" | "placement")[5]
nocliprequiredboolean
cursorrequired"desktop" | "workspace" | "fullscreen" | "director" | "virtual" | "reticle"
taggedSurfaceIdrequirednull | string
reticlerequiredreticle

apps#

object[] · items ≤ 128

FieldTypeConstraints
surfaceIdrequiredstringlength 1–128
workspaceIdrequiredinteger≥ 0
titlerequiredstringlength ≤ 512
appClassrequiredstringlength ≤ 256
iconrequiredstringlength ≤ 256

inputConfig#

object

FieldTypeConstraints
versionrequired2
longHoldMsrequiredinteger≥ 100 · ≤ 5000
scopeVignetterequiredboolean
useDistancerequirednumber≥ 0.2 · ≤ 30
useTolerancerequirednumber≥ 0 · ≤ 0.5
captureInputLimitrequiredinteger≥ 16 · ≤ 1024
modesrequiredobject
worldrequiredobject
lookrequiredstring[]items ≤ 3 · unique items · each length 1–96
forwardrequiredstring[]items ≤ 3 · unique items · each length 1–96
backrequiredstring[]items ≤ 3 · unique items · each length 1–96
leftrequiredstring[]items ≤ 3 · unique items · each length 1–96
rightrequiredstring[]items ≤ 3 · unique items · each length 1–96
menurequiredstring[]items ≤ 3 · unique items · each length 1–96
sprintrequiredstring[]items ≤ 3 · unique items · each length 1–96
uprequiredstring[]items ≤ 3 · unique items · each length 1–96
downrequiredstring[]items ≤ 3 · unique items · each length 1–96
userequiredstring[]items ≤ 3 · unique items · each length 1–96
focusrequiredstring[]items ≤ 3 · unique items · each length 1–96
nocliprequiredstring[]items ≤ 3 · unique items · each length 1–96
scoperequiredstring[]items ≤ 3 · unique items · each length 1–96
debugrequiredstring[]items ≤ 3 · unique items · each length 1–96
capturerequiredstring[]items ≤ 3 · unique items · each length 1–96
carryrequiredstring[]items ≤ 3 · unique items · each length 1–96
resizerequiredstring[]items ≤ 3 · unique items · each length 1–96
distancerequiredstring[]items ≤ 3 · unique items · each length 1–96
rotaterequiredstring[]items ≤ 3 · unique items · each length 1–96
tool1requiredstring[]items ≤ 3 · unique items · each length 1–96
tool2requiredstring[]items ≤ 3 · unique items · each length 1–96
tool3requiredstring[]items ≤ 3 · unique items · each length 1–96
tool4requiredstring[]items ≤ 3 · unique items · each length 1–96
hud.cyclerequiredstring[]items ≤ 3 · unique items · each length 1–96
transportrequiredstring[]items ≤ 3 · unique items · each length 1–96
autopilotrequiredstring[]items ≤ 3 · unique items · each length 1–96
primaryrequiredstring[]items ≤ 3 · unique items · each length 1–96
secondaryrequiredstring[]items ≤ 3 · unique items · each length 1–96
flyrequiredstring[]items ≤ 3 · unique items · each length 1–96
record.togglerequiredstring[]items ≤ 3 · unique items · each length 1–96
exitrequiredstring[]items ≤ 3 · unique items · each length 1–96
tool5requiredstring[]items ≤ 3 · unique items · each length 1–96
carry.facingrequiredstring[]items ≤ 3 · unique items · each length 1–96
content.scalerequiredstring[]items ≤ 3 · unique items · each length 1–96
window.resetrequiredstring[]items ≤ 3 · unique items · each length 1–96
cyclerequiredstring[]items ≤ 3 · unique items · each length 1–96
alternaterequiredstring[]items ≤ 3 · unique items · each length 1–96
markers.revealrequiredstring[]items ≤ 3 · unique items · each length 1–96
interactiverequiredobject
exitrequiredstring[]items ≤ 3 · unique items · each length 1–96
debugstring[]items ≤ 3 · unique items · each length 1–96
capturestring[]items ≤ 3 · unique items · each length 1–96
record.togglerequiredstring[]items ≤ 3 · unique items · each length 1–96
focusrequiredobject
exitrequiredstring[]items ≤ 3 · unique items · each length 1–96
debugstring[]items ≤ 3 · unique items · each length 1–96
capturestring[]items ≤ 3 · unique items · each length 1–96
record.togglerequiredstring[]items ≤ 3 · unique items · each length 1–96
menurequiredobject
exitrequiredstring[]items ≤ 3 · unique items · each length 1–96
debugstring[]items ≤ 3 · unique items · each length 1–96
capturestring[]items ≤ 3 · unique items · each length 1–96
record.togglerequiredstring[]items ≤ 3 · unique items · each length 1–96
invert_yboolean

Invert vertical mouse look; default false.

show_area_markersboolean

Render optional place/area labels in core; default false.

inputSteals#

object[] · items ≤ 512

FieldTypeConstraints
moderequired"world" | "interactive" | "focus" | "menu"
actionrequiredstringlength ≤ 128
bindingrequiredstringlength ≤ 96
descriptionrequiredstringlength ≤ 1024
submaprequiredstringlength ≤ 256

inputConflicts#

object[] · items ≤ 128

FieldTypeConstraints
moderequired"world" | "interactive" | "focus" | "menu"
bindingrequiredstringlength ≤ 96
actionsrequiredstring[2]each length ≤ 128

inputCapture#

any of 2

FieldTypeConstraints
variant 1null
variant 2object
moderequired"world" | "interactive" | "focus" | "menu"
actionrequiredstringlength ≤ 128
slotrequiredinteger≥ 0 · ≤ 2
statusrequired"waiting" | "captured"
bindingrequirednull | stringlength ≤ 96

keymap#

object

FieldTypeConstraints
configrequiredinputConfig
pathrequiredstringlength ≤ 4096
stealsrequiredinputSteals
conflictsrequiredinputConflicts
capturerequiredinputCapture
errorrequiredstringlength ≤ 4096
holdsrequiredinputHolds

editorPath#

object

FieldTypeConstraints
idrequiredstringlength ≤ 128
worldIdrequiredstringlength ≤ 128
areaIdrequiredstringlength ≤ 128
closedrequiredboolean
pointsrequiredobject[]items ≤ 256
positionrequirednumber[3]each ≥ -100000 · each ≤ 100000
typerequired"line" | "curve" | "arc"

editorObject#

object

FieldTypeConstraints
worldIdrequiredstringlength ≤ 128
areaIdrequiredstringlength ≤ 128
objectIdrequiredstringlength ≤ 128
positionrequirednumber[3]each ≥ -100000 · each ≤ 100000
rotationrequirednumber[4]each ≥ -1 · each ≤ 1
scalerequirednumber[3]each ≥ 0.01 · each ≤ 100

editor#

object

FieldTypeConstraints
moderequired"world" | "interactive" | "focus" | "menu" | "cursor"
toolrequiredinteger≥ 1 · ≤ 5
submoderequired"normal" | "place" | "lock" | "open line" | "open curve" | "open arc" | "closed line" | "closed curve" | "closed arc" | "move" | "rotate" | "scale" | "reserved" | "placement"
selectedIdrequirednull | stringlength ≤ 128
selectedKindrequired"" | "window" | "object"
pathsrequirededitorPath[]items ≤ 128
objectsrequirededitorObject[]items ≤ 128
lockedrequiredstring[]items ≤ 1024 · each length ≤ 128
debugrequiredboolean
unplacedrequiredunplaced
carryFacingrequiredboolean | null
contentScalerequiredcontentScaleFeedback | null
toolSlotsrequiredtoolSlots
toolDefinitionsrequiredtoolDefinition[5]
toolInputrequiredtoolInput

overlayStylePatch#

object

FieldTypeConstraints
waypointColornumber[3]each ≥ 0 · each ≤ 1
routeColornumber[3]each ≥ 0 · each ≤ 1
labelColornumber[3]each ≥ 0 · each ≤ 1
promptColornumber[3]each ≥ 0 · each ≤ 1
fontFamilystringlength 1–96 · pattern ^[^\u0000-\u001f\u007f]+$
iconAtlasone of 2
variant 1null
variant 2object
pathrequiredstringlength ≤ 4096 · pattern ^/[^\u0000]*$
cellSizerequiredinteger≥ 16 · ≤ 128
waypointIndexrequiredinteger≥ 0 · ≤ 255
promptIndexrequiredinteger≥ 0 · ≤ 255
reticleColornumber[3]each ≥ 0 · each ≤ 1
validColornumber[3]each ≥ 0 · each ≤ 1
invalidColornumber[3]each ≥ 0 · each ≤ 1
questColornumber[3]each ≥ 0 · each ≤ 1

overlayStyle#

object

FieldTypeConstraints
waypointColorrequirednumber[3]each ≥ 0 · each ≤ 1
routeColorrequirednumber[3]each ≥ 0 · each ≤ 1
labelColorrequirednumber[3]each ≥ 0 · each ≤ 1
promptColorrequirednumber[3]each ≥ 0 · each ≤ 1
fontFamilyrequiredstringlength 1–96 · pattern ^[^\u0000-\u001f\u007f]+$
iconAtlasrequiredone of 2
variant 1null
variant 2object
pathrequiredstringlength ≤ 4096 · pattern ^/[^\u0000]*$
cellSizerequiredinteger≥ 16 · ≤ 128
waypointIndexrequiredinteger≥ 0 · ≤ 255
promptIndexrequiredinteger≥ 0 · ≤ 255
reticleColorrequirednumber[3]each ≥ 0 · each ≤ 1
validColorrequirednumber[3]each ≥ 0 · each ≤ 1
invalidColorrequirednumber[3]each ≥ 0 · each ≤ 1
questColorrequirednumber[3]each ≥ 0 · each ≤ 1

graphicsConfig#

object

FieldTypeConstraints
qualityrequired"auto" | "low" | "medium" | "high" | "ultra" | "intel"
msaarequired1 | 2 | 4 | null
bloomrequired"off" | "low" | "high" | null
fogrequired"off" | "linear" | "height" | null
skyrequired"off" | "gradient" | "environment" | null
anisotropyrequired1 | 2 | 4 | 8 | 16 | null
reflectionsrequiredboolean | null
normal_mapsrequiredboolean | null
specularrequiredboolean | null
ambient_occlusionrequiredboolean | null
alpha_hazerequiredboolean | null
dynamic_resolutionrequiredboolean
reduced_motionrequiredboolean
render_scalerequired"auto" | number
target_fpsrequiredinteger≥ 30 · ≤ 240
fovrequirednumber≥ 30 · ≤ 120
exposurerequirednumber≥ 0.01 · ≤ 16
bloom_strengthrequirednumber≥ 0 · ≤ 4
sharpenrequirednumber≥ 0 · ≤ 1
offloadrequired"off" | "auto" | "on"
offload_power_cap_wrequirednumber | 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_devicestringpattern ^(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_minrequirednumber≥ 0.375 · ≤ 1
scale_maxrequirednumber≥ 0.375 · ≤ 1
outlinerequiredboolean | null
visibility_cullingrequiredboolean
outline_qualityrequired"fast" | "smooth" | null
outline_width_pxrequirednull | number
outline_colourrequirednull | 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

FieldTypeConstraints
quality"auto" | "low" | "medium" | "high" | "ultra" | "intel"
msaa1 | 2 | 4 | null
bloom"off" | "low" | "high" | null
fog"off" | "linear" | "height" | null
sky"off" | "gradient" | "environment" | null
anisotropy1 | 2 | 4 | 8 | 16 | null
reflectionsboolean | null
normal_mapsboolean | null
specularboolean | null
ambient_occlusionboolean | null
alpha_hazeboolean | null
dynamic_resolutionboolean
reduced_motionboolean
render_scale"auto" | number
target_fpsinteger≥ 30 · ≤ 240
fovnumber≥ 30 · ≤ 120
exposurenumber≥ 0.01 · ≤ 16
bloom_strengthnumber≥ 0 · ≤ 4
sharpennumber≥ 0 · ≤ 1
offload"off" | "auto" | "on"
offload_power_cap_wnumber | 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_devicestringpattern ^(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_minnumber≥ 0.375 · ≤ 1
scale_maxnumber≥ 0.375 · ≤ 1
outlineboolean | null
visibility_cullingboolean
outline_quality"fast" | "smooth" | null
outline_width_pxnull | number
outline_colournull | 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

FieldTypeConstraints
actionrequiredstringlength 1–128
bindingrequiredstringlength 1–128
startedAtMsrequiredinteger≥ 0 · ≤ 2⁵³−1
durationMsrequiredinteger≥ 100 · ≤ 5000

hudZone#

object

FieldTypeConstraints
idrequiredstringlength 1–256
homeNamerequiredstringlength 1–256
worldIdrequiredstringlength 1–256
worldNamerequiredstringlength 1–256

performanceControl#

object

FieldTypeConstraints
requestedrequirednumber | boolean | string | null | number[3]
effectiverequirednumber | boolean | string | null | number[3]
gpuMsrequirednumber | null
sharedPassrequiredstring | null
passGpuMsrequirednumber | null

performance#

object

FieldTypeConstraints
profilerequired"unknown" | "battery" | "usb-c" | "limited-ac" | "full-ac"
powerWrequirednumber | null
capWrequirednumber≥ 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).

devicerequiredany 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 1null
variant 2object
pcirequiredstringpattern ^[0-9a-f]{4}:[0-9a-f]{2}:[0-9a-f]{2}\.[0-7]$
noderequiredstringpattern ^renderD[0-9]+$
namerequiredstring | null
enforcedLimitWrequirednumber | null
selectionrequired"auto" | "explicit"
drivesCompositorrequiredboolean
targetFPSrequiredinteger≥ 0 · ≤ 60
reasonrequiredstring
pidrequiredinteger | null
generationrequiredinteger≥ 0
moderequired"off" | "auto" | "on"
activeRendererrequired"in-process" | "offload"
statusrequired"active" | "warming" | "local"
presetrequired"auto" | "low" | "medium" | "high" | "ultra" | "custom" | "intel"
requestedrequiredgraphicsConfig
effectiverequiredgraphicsConfig
costsMsrequiredmap → number | null
workerTimingsrequiredobject | null
controlsrequiredmap → performanceControl

replayAssertions#

object

FieldTypeConstraints
recordedboolean
tolerancenumber≥ 0 · ≤ 100
marksmap → objectentries ≤ 128
cameraobject
positionnumber[3]
yawnumber
pitchnumber
fovnumber
mode"world" | "interactive" | "focus" | "menu" | "cursor"
toolinteger≥ 1 · ≤ 4
subtypestringlength ≤ 64
scopeboolean
noclipboolean
movement"walk" | "fly"
tolerancenumber≥ 0 · ≤ 100

recordingStatus#

object

FieldTypeConstraints
recordingrequiredboolean
playingrequiredboolean
pathrequiredstring | nulllength ≤ 4096
framerequiredinteger≥ 0 · ≤ 36001
moderequired"input" | "camera"
failuresrequiredstring[]items ≤ 128 · each length ≤ 512
errorrequiredstring | nulllength ≤ 256

authorAtmosphere#

object

FieldTypeConstraints
fogrequiredobject
colorrequiredvec3
densityrequirednumber≥ 0 · ≤ 1
heightFalloffrequirednumber≥ 0 · ≤ 10
baseHeightrequirednumber≥ -10000 · ≤ 10000
excludeUnlitrequiredboolean
skyrequiredobject
zenithrequiredvec3
horizonrequiredvec3
groundrequiredvec3
sunrequiredobject
directionrequiredvec3
colorrequiredvec3
intensityrequirednumber≥ 0 · ≤ 10000
angularRadiusrequirednumber≥ 0.001 · ≤ 1
environmentobject
facesrequiredpath[6]
encodingrequired"srgb" | "linear"
intensityrequirednumber≥ 0 · ≤ 10000
rotationrequirednumber≥ -6.283186 · ≤ 6.283186
maxResolutionrequiredinteger≥ 16 · ≤ 512
exposurerequirednumber≥ 0.01 · ≤ 100
toneMappingrequired"aces" | "reinhard" | "linear"
bloomrequiredobject
strengthrequirednumber≥ 0 · ≤ 2
thresholdrequirednumber≥ 0 · ≤ 100
radiusrequirednumber≥ 1 · ≤ 8
outlineobject
enabledrequiredboolean
colourrequirednumber[3]each ≥ 0 · each ≤ 1
widthPxrequirednumber≥ 1 · ≤ 4
depthThresholdrequirednumber≥ 0.0001 · ≤ 1
normalThresholdrequirednumber≥ 0.001 · ≤ 2

placementContent#

object

FieldTypeConstraints
logicalSizerequiredinteger[2]each ≥ 1 · each ≤ 32768
baseSizerequiredinteger[2]each ≥ 1 · each ≤ 32768
worldSizerequirednumber[2]each ≥ 0.001 · each ≤ 32768

unplaced#

object

FieldTypeConstraints
countrequiredinteger≥ 0 · ≤ 16
windowsrequiredobject[]items ≤ 16
surfaceIdrequiredstringlength 1–256
titlerequiredstringlength ≤ 4096
appClassrequiredstringlength ≤ 256
logicalSizerequiredinteger[2]each ≥ 1 · each ≤ 32768
selectedIdrequiredstring | null
previewrequiredboolean

contentScaleFeedback#

object

FieldTypeConstraints
surfaceIdrequiredstringlength 1–256
scalerequirednumber> 0 · ≤ 32768
logicalSizerequiredinteger[2]each ≥ 1 · each ≤ 32768
sequencerequiredinteger≥ 0 · ≤ 2⁵³−1
resetrequiredboolean

toolSlot#

object

FieldTypeConstraints
actionrequiredstringlength 1–128
labelrequiredstringlength 1–128

toolSlots#

object

FieldTypeConstraints
primaryrequiredtoolSlot | null
secondaryrequiredtoolSlot | null
alternaterequiredtoolSlot | null
cyclerequiredtoolSlot | null

toolDefinition#

object

FieldTypeConstraints
slotrequiredinteger≥ 1 · ≤ 5
namerequiredstringlength 1–128
slotsrequiredtoolSlots

toolInput#

object

FieldTypeConstraints
modifiersrequiredinteger≥ 0 · ≤ 255
overriderequiredboolean
gesturesrequiredobject[]items ≤ 7
actionrequiredstringlength ≤ 128
labelrequiredstringlength ≤ 128
bindingsrequiredstring[]items ≤ 3 · each length ≤ 96

captureId#

string · length ≤ 27 · pattern ^capture-[0-9]{1,19}$

reticle#

object

FieldTypeConstraints
staterequired"hidden" | "neutral" | "typing" | "target" | "valid" | "out_of_range" | "invalid" | "holding"
actionrequired"" | "click" | "grab" | "pocket" | "place" | "mount" | "select" | "path" | "drop"

playerConfig#

object

FieldTypeConstraints
walk_speedrequirednumber≥ 0.5 · ≤ 20
run_speedrequirednumber≥ 0.5 · ≤ 30
view_bobrequired"off" | "subtle" | "normal"
reticle_stylerequired"cross_dot" | "t_dot" | "circle_dot" | "dot" | "cross" | "chevron"
reticle_sizerequirednumber≥ 6 · ≤ 64
reticle_thicknessrequirednumber≥ 1 · ≤ 6
reticle_gaprequirednumber≥ 0 · ≤ 20
reticle_opacityrequirednumber≥ 0.2 · ≤ 1
reticle_outlinerequiredboolean
reticle_colourrequired"theme" | number[3]
reticle_dynamicrequiredboolean
reach_grabrequirednumber≥ 1 · ≤ 100
reach_mountrequirednumber≥ 1 · ≤ 100
reach_placementrequirednumber≥ 1 · ≤ 100

playerPatch#

Changed keys only; null removes the persisted override (back to the default).

object · entries ≥ 1

FieldTypeConstraints
walk_speednull | number
run_speednull | number
view_bobnull | "off" | "subtle" | "normal"
reticle_stylenull | "cross_dot" | "t_dot" | "circle_dot" | "dot" | "cross" | "chevron"
reticle_sizenull | number
reticle_thicknessnull | number
reticle_gapnull | number
reticle_opacitynull | number
reticle_outlinenull | boolean
reticle_colournull | "theme" | number[3]
reticle_dynamicnull | boolean
reach_grabnull | number
reach_mountnull | number
reach_placementnull | number

playerOverrides#

Persisted player overrides (never null; may be empty).

object

FieldTypeConstraints
walk_speednumber≥ 0.5 · ≤ 20
run_speednumber≥ 0.5 · ≤ 30
view_bob"off" | "subtle" | "normal"
reticle_style"cross_dot" | "t_dot" | "circle_dot" | "dot" | "cross" | "chevron"
reticle_sizenumber≥ 6 · ≤ 64
reticle_thicknessnumber≥ 1 · ≤ 6
reticle_gapnumber≥ 0 · ≤ 20
reticle_opacitynumber≥ 0.2 · ≤ 1
reticle_outlineboolean
reticle_colour"theme" | number[3]
reticle_dynamicboolean
reach_grabnumber≥ 1 · ≤ 100
reach_mountnumber≥ 1 · ≤ 100
reach_placementnumber≥ 1 · ≤ 100

playerSettings#

object

FieldTypeConstraints
configrequiredplayerConfig
defaultsrequiredplayerConfig
overridesrequiredplayerOverrides
optionsrequiredobject
view_bobrequired("off" | "subtle" | "normal")[]items ≥ 1 · unique items
reticle_stylerequired("cross_dot" | "t_dot" | "circle_dot" | "dot" | "cross" | "chevron")[]items ≥ 1 · unique items
rangesrequiredobject
walk_speedrequirednumber[2]
run_speedrequirednumber[2]
reticle_sizerequirednumber[2]
reticle_thicknessrequirednumber[2]
reticle_gaprequirednumber[2]
reticle_opacityrequirednumber[2]
reach_grabrequirednumber[2]
reach_mountrequirednumber[2]
reach_placementrequirednumber[2]
pathrequiredstringlength ≤ 4096
errorrequiredstringlength ≤ 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

FieldTypeConstraints
sourcerequiredstringlength 1–128
idrequiredquestSlug

questProgress#

[done, of].

integer[2] · each ≥ 0 · each ≤ 10000

questTarget#

Exactly one of position (optionally with worldId), zoneId, areaId, placeId or workspaceId.

one of 5

FieldTypeConstraints
variant 1object
positionrequirednumber[3]
worldIdstringlength 1–128
variant 2object
zoneIdrequiredstringlength 1–128
variant 3object
areaIdrequiredstringlength 1–128
variant 4object
placeIdrequiredstringlength 1–128
variant 5object
workspaceIdrequiredinteger≥ 1 · ≤ 2147483647

markerSource#

Where a marker comes from ("open in Quests"); questId is "<source>/<id>".

object

FieldTypeConstraints
questIdstringlength 3–200 · pattern ^[^/]{1,128}/[a-z0-9][a-z0-9-]{0,63}$
stepIdquestSlug
objectiveIdquestSlug
areaIdstringlength 1–128
zoneIdstringlength 1–128
placeIdstringlength 1–128
workspaceIdinteger≥ 1 · ≤ 2147483647
waypointtrue
routetrue
focustrue
breaktrue

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

FieldTypeConstraints
idrequiredstringlength 1–160
kindrequired"quest" | "offer" | "waypoint" | "route" | "home" | "workspace" | "place" | "vista" | "discover" | "machine" | "focus" | "break"
tierrequiredinteger≥ 1 · ≤ 4
labelrequiredstringlength 0–48
iconrequired"quest" | "quest-optional" | "offer" | "turn-in" | "waypoint" | "route" | "home" | "workspace" | "place" | "vista" | "discover" | "door" | "stairs" | "lift" | … (18 values)
targetrequiredquestTarget
positionrequirednull | number[3]
areaIdrequirednull | string
rangerequirednumber[2]each ≥ 0 · each ≤ 10000
labelRangerequirednumber≥ 0 · ≤ 10000
occlusionrequired"through" | "edge" | "visible"
trackedrequiredboolean
sourcerequiredmarkerSource

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

FieldTypeConstraints
revealrequiredany of 2
variant 1null
variant 2object
startedAtMsrequiredinteger≥ 0 · ≤ 2⁵³−1
holdMsrequired0 | any
fadeMsrequiredinteger≥ 0 · ≤ 600
reasonrequired"tap" | "request"
persistentrequired"off" | "edge" | "always"
calmrequiredboolean
coreDrawrequiredboolean
listrequiredguidanceMarker[]items ≤ 64

activeQuest#

object

FieldTypeConstraints
idrequiredquestSlug
sourcerequiredstringlength 1–128
titlerequiredstringlength 1–64
steprequiredany of 2
variant 1null
variant 2object
idrequiredquestSlug
titlerequiredstringlength 1–64
progressrequiredquestProgress
progressrequiredquestProgress

questsState#

Active quests (tracked first) and counts. world is reserved and always null in this version.

object

FieldTypeConstraints
enabledrequiredboolean
trackedrequirednull | questRef
activerequiredactiveQuest[]items ≤ 16
countsrequiredobject
availablerequiredinteger≥ 0 · ≤ 10000
activerequiredinteger≥ 0 · ≤ 10000
completedrequiredinteger≥ 0 · ≤ 10000
worldrequirednull

focusTarget#

object

FieldTypeConstraints
kindrequired"any" | "workspace" | "window" | "app"
labelrequiredstringlength 0–64
workspaceIdinteger≥ 1 · ≤ 2147483647
appClassstringlength 0–128
questRefquestRef

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

FieldTypeConstraints
staterequired"idle" | "work" | "break" | "ready" | "paused"
pausedStaterequirednull | "work" | "break" | "ready"
sessionIdrequirednull | string
phaseStartedAtMsrequirednull | integer
phaseEndsAtMsrequirednull | integer
phaseMsrequiredinteger≥ 0 · ≤ 2⁵³−1
remainingMsrequiredinteger≥ 0 · ≤ 2⁵³−1
creditedMsrequiredinteger≥ 0 · ≤ 2⁵³−1
creditingrequiredboolean
cyclerequiredinteger≥ 0 · ≤ 12
cyclesrequiredinteger≥ 1 · ≤ 12
breakKindrequirednull | "short" | "long"
countModerequired"focus" | "wall"
targetrequirednull | focusTarget
calmrequiredboolean

guidanceConfig#

Every guidance setting (effective values or defaults).

object

FieldTypeConstraints
markers.reveal_msrequiredinteger≥ 1000 · ≤ 15000
markers.reveal_moderequired"timer" | "toggle"
markers.max_revealedrequiredinteger≥ 4 · ≤ 16
markers.labelsrequiredinteger≥ 2 · ≤ 8
markers.persistentrequired"off" | "edge" | "always"
markers.core_drawrequiredboolean
quests.notificationsrequired"all" | "important" | "off"
focus.work_minrequiredinteger≥ 5 · ≤ 120
focus.short_break_minrequiredinteger≥ 1 · ≤ 30
focus.long_break_minrequiredinteger≥ 5 · ≤ 60
focus.long_break_everyrequiredinteger≥ 2 · ≤ 12
focus.cyclesrequiredinteger≥ 1 · ≤ 12
focus.auto_start_breaksrequiredboolean
focus.auto_start_workrequiredboolean
focus.count_moderequired"focus" | "wall"
focus.idle_srequiredinteger≥ 60 · ≤ 900
focus.grace_srequiredinteger≥ 0 · ≤ 120
focus.calmrequiredboolean
focus.calm_npc_distancerequirednumber≥ 2 · ≤ 20
focus.desktop_chiprequiredboolean
focus.history_daysrequiredinteger≥ 0 · ≤ 365

guidanceOverrides#

Persisted guidance overrides (never null; may be empty).

object

FieldTypeConstraints
markers.reveal_msinteger≥ 1000 · ≤ 15000
markers.reveal_mode"timer" | "toggle"
markers.max_revealedinteger≥ 4 · ≤ 16
markers.labelsinteger≥ 2 · ≤ 8
markers.persistent"off" | "edge" | "always"
markers.core_drawboolean
quests.notifications"all" | "important" | "off"
focus.work_mininteger≥ 5 · ≤ 120
focus.short_break_mininteger≥ 1 · ≤ 30
focus.long_break_mininteger≥ 5 · ≤ 60
focus.long_break_everyinteger≥ 2 · ≤ 12
focus.cyclesinteger≥ 1 · ≤ 12
focus.auto_start_breaksboolean
focus.auto_start_workboolean
focus.count_mode"focus" | "wall"
focus.idle_sinteger≥ 60 · ≤ 900
focus.grace_sinteger≥ 0 · ≤ 120
focus.calmboolean
focus.calm_npc_distancenumber≥ 2 · ≤ 20
focus.desktop_chipboolean
focus.history_daysinteger≥ 0 · ≤ 365

guidancePatch#

Changed keys only; null removes the persisted override (back to the default).

object · entries ≥ 1

FieldTypeConstraints
markers.reveal_msnull | integer
markers.reveal_modenull | "timer" | "toggle"
markers.max_revealednull | integer
markers.labelsnull | integer
markers.persistentnull | "off" | "edge" | "always"
markers.core_drawnull | boolean
quests.notificationsnull | "all" | "important" | "off"
focus.work_minnull | integer
focus.short_break_minnull | integer
focus.long_break_minnull | integer
focus.long_break_everynull | integer
focus.cyclesnull | integer
focus.auto_start_breaksnull | boolean
focus.auto_start_worknull | boolean
focus.count_modenull | "focus" | "wall"
focus.idle_snull | integer
focus.grace_snull | integer
focus.calmnull | boolean
focus.calm_npc_distancenull | number
focus.desktop_chipnull | boolean
focus.history_daysnull | integer

guidanceSettings#

object

FieldTypeConstraints
configrequiredguidanceConfig
defaultsrequiredguidanceConfig
overridesrequiredguidanceOverrides
rangesrequiredobject
markers.reveal_msrequirednumber[2]
markers.max_revealedrequirednumber[2]
markers.labelsrequirednumber[2]
focus.work_minrequirednumber[2]
focus.short_break_minrequirednumber[2]
focus.long_break_minrequirednumber[2]
focus.long_break_everyrequirednumber[2]
focus.cyclesrequirednumber[2]
focus.idle_srequirednumber[2]
focus.grace_srequirednumber[2]
focus.calm_npc_distancerequirednumber[2]
focus.history_daysrequirednumber[2]
optionsrequiredobject
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
pathrequiredstringlength ≤ 4096
errorrequiredstringlength ≤ 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

FieldTypeConstraints
when type = "manual"object
idrequiredquestSlug
typerequired"manual"
countinteger≥ 1 · ≤ 100
labelstringlength 0–64
when type = "reach"object
idrequiredquestSlug
typerequired"reach"
countinteger≥ 1 · ≤ 100
labelstringlength 0–64
targetquestTarget
radiusnumber≥ 0.5 · ≤ 100
when type = "focus"object
idrequiredquestSlug
typerequired"focus"
countinteger≥ 1 · ≤ 100
labelstringlength 0–64
sessionsrequiredinteger≥ 1 · ≤ 12
minutesnumber≥ 1 · ≤ 120
focusTarget"quest" | "any"

stepInput#

id defaults to step-N; objectives default to [{"id": "done", "type": "manual"}].

object

FieldTypeConstraints
idquestSlug
titlerequiredstringlength 1–64
optionalboolean
anyboolean
targetquestTarget
objectivesobjectiveInput[]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

FieldTypeConstraints
idquestSlug
titlerequiredstringlength 1–64
summarystringlength 0–1000
sequentialboolean
expiresstringlength 16 · pattern ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}$
stepsrequiredstepInput[]items 1–16

questSummary#

object

FieldTypeConstraints
questRefrequiredquestRef
titlerequiredstringlength 1–64
categoryrequired"main" | "side" | "discovery" | "personal" | "work"
staterequired"available" | "active" | "completed" | "failed" | "abandoned"
trackedrequiredboolean
steprequiredany of 2
variant 1null
variant 2object
idrequiredquestSlug
titlerequiredstringlength 1–64
progressrequiredquestProgress
progressrequiredquestProgress
offWorldrequiredboolean
updatedAtrequiredstringlength 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

FieldTypeConstraints
idrequiredquestSlug
typerequired"manual" | "reach" | "focus"
labelrequiredstringlength 0–64
countrequiredinteger≥ 1 · ≤ 100
donerequiredinteger≥ 0 · ≤ 100
targetquestTarget
radiusnumber≥ 0.5 · ≤ 100
sessionsinteger≥ 1 · ≤ 12
minutesnumber≥ 1 · ≤ 120
focusTarget"quest" | "any"
creditedMinutesnumber≥ 0 · ≤ 1000000

questStep#

object

FieldTypeConstraints
idrequiredquestSlug
titlerequiredstringlength 1–64
optionalrequiredboolean
anyrequiredboolean
staterequired"pending" | "current" | "done"
targetrequirednull | questTarget
objectivesrequiredquestObjective[]items 1–8

questDetail#

object

FieldTypeConstraints
questRefrequiredquestRef
titlerequiredstringlength 1–64
summaryrequiredstringlength 0–1000
categoryrequired"main" | "side" | "discovery" | "personal" | "work"
staterequired"available" | "active" | "completed" | "failed" | "abandoned"
trackedrequiredboolean
sequentialrequiredboolean
expiresrequirednull | string
createdAtrequiredstringlength 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})?$
updatedAtrequiredstringlength 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})?$
completedAtrequirednull | string
personalrequiredboolean
stepsrequiredquestStep[]items 1–16

focusTargetInput#

What credits work time; default {"kind": "any"}.

one of 4

FieldTypeConstraints
when kind = "any"object
kindrequired"any"
labelstringlength 0–64
when kind = "workspace"object
kindrequired"workspace"
workspaceIdrequiredinteger≥ 1 · ≤ 2147483647
labelstringlength 0–64
when kind = "window"object
kindrequired"window"
appClassrequiredstringlength 1–128
workspaceIdrequiredinteger≥ 1 · ≤ 2147483647
labelstringlength 0–64
when kind = "app"object
kindrequired"app"
appClassrequiredstringlength 1–128
labelstringlength 0–64

focusOverrides#

One-off values for this session (work_min may go below the 5-minute setting floor).

object

FieldTypeConstraints
work_mininteger≥ 1 · ≤ 120
short_break_mininteger≥ 1 · ≤ 30
long_break_mininteger≥ 1 · ≤ 60
long_break_everyinteger≥ 2 · ≤ 12
cyclesinteger≥ 1 · ≤ 12
count_mode"focus" | "wall"
idle_sinteger≥ 60 · ≤ 900
grace_sinteger≥ 0 · ≤ 120
calmboolean
auto_start_breaksboolean
auto_start_workboolean

focusInterval#

One finished interval (also one line of focus/history.jsonl). Never titles.

object

FieldTypeConstraints
startrequiredstringlength 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})?$
endrequiredstringlength 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"
plannedMinrequirednumber≥ 0 · ≤ 120
creditedMinrequirednumber≥ 0 · ≤ 120
targetKindrequiredstringlength 1–32 · pattern ^[a-z]+$
appClassstringlength 0–128
workspaceIdinteger≥ 1 · ≤ 2147483647
questIdstringlength 3–200 · pattern ^[^/]{1,128}/[a-z0-9][a-z0-9-]{0,63}$
outcomerequired"completed" | "skipped" | "stopped"

Frame envelopes

error#

object

FieldTypeConstraints
jsonrpcrequired"2.0"
idrequiredstring | null
errorrequiredobject
coderequired-32700 | -32600 | -32601 | -32602 | -32603 | -32008 | -32007 | -32006 | -32005 | -32004 | -32003 | -32002 | -32001
messagerequiredstringlength 1–4096
dataobject
retryablerequiredboolean

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

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

Mirrored byte-for-byte from hyprune/schema at 34849da45183 (2026-10-15). SHA-256 6f5ff8089934a6cb4ce86f8c39a81cb6801a457a79ee58d9539e3b33305cef5c.