Skip to content

IPC protocol 0.13

Schema reference / IPC protocol / 0.13

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-09
Title
“Hyprune IPC 0.13: authoring camera and ink”
Dialect
JSON Schema 2020-12 · unknown fields rejected unless marked
Raw schemaipc.schema.json · 10,032 lines · 226 KB
DownloadOpen rawsha256 221ba19d7eeb…
Loading ipc.schema.json…

Changes since 0.12

Structural diff against 0.12: 3 entries added, 7 entries changed. Descriptions and $id changes are ignored.

10 changes
  • addedauthorAtmosphere
  • addedmethod camera.photo
  • addedmethod camera.release
  • changedgraphicsConfig
    • + outline boolean | null (required)
    • + visibility_culling boolean (required)
  • changedgraphicsPatch
    • + outline boolean | null
    • + visibility_culling boolean
  • changedmethod atmosphere.get
    • ~ result.profile adds authorAtmosphere; removes atmosphere
  • changedmethod atmosphere.set
    • ~ params.profile atmosphere (required) → authorAtmosphere (required)
  • changedmethod camera.get
    • + result.roll number (required) · ≥ -3.141593 · ≤ 3.141593
    • + result.fov number (required) · ≥ 3 · ≤ 140
    • + result.lensShift number[2] (required) · each ≥ -2 · each ≤ 2
    • + result.held boolean (required)
    • + result.renderScale number | null (required)
  • changedmethod session.hello
    • ~ params.capabilities capability[] (required) · items ≥ 0 · unique items → ("state.read" | "world.control" | "surface.control" | "movement.control" | "shell.control" | "runtime.control" | "data.publish" | "input.control" | "camera.author")[] (required) · items ≥ 0 · unique items
    • ~ result.protocol "0.12" (required) → "0.13" (required)
    • ~ result.capabilities capability[] (required) · items ≥ 0 · unique items → ("state.read" | "world.control" | "surface.control" | "movement.control" | "shell.control" | "runtime.control" | "data.publish" | "input.control" | "camera.author")[] (required) · items ≥ 0 · unique items
    • ~ result.methods adds … (60 values))[]; removes … (58 values))[]
  • changedpresentation
    • ~ profile adds authorAtmosphere; removes atmosphere
    • ~ fov number (required) · ≥ 3 · ≤ 110 → number (required) · ≥ 3 · ≤ 140

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")[]items ≥ 0 · unique items
tokenstringlength 64 · pattern ^[a-f0-9]{64}$

result · object

FieldTypeConstraints
protocolrequired"0.13"
sessionIdrequiredstringlength 1–128
capabilitiesrequired("state.read" | "world.control" | "surface.control" | "movement.control" | "shell.control" | "runtime.control" | "data.publish" | "input.control" | "camera.author")[]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" | … (60 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" | … (15 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
when anchorId = ""object
worldIdrequiredid
areaIdrequiredslug
anchorIdrequired""
rulerequiredobject
appClassrequiredstringlength 1–256
titlerequiredstringlength ≤ 256
poserequiredpose
sizerequiredsize2

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

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

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 · ≤ 4
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 · ≤ 4
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

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

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]

marker#

object

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

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
when anchorId = ""object
worldIdrequiredid
areaIdrequiredslug
anchorIdrequired""
rulerequiredobject
appClassrequiredstringlength 1–256
titlerequiredstringlength ≤ 256
poserequiredpose
sizerequiredsize2
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
areaIdrequiredslug
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")[5]
nocliprequiredboolean
cursorrequired"desktop" | "workspace" | "fullscreen" | "director" | "virtual" | "reticle"
taggedSurfaceIdrequirednull | string

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
wheelrequiredstring[]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
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"
selectedIdrequirednull | stringlength ≤ 128
selectedKindrequired"" | "window" | "object"
pathsrequirededitorPath[]items ≤ 128
objectsrequirededitorObject[]items ≤ 128
lockedrequiredstring[]items ≤ 1024 · each length ≤ 128
debugrequiredboolean

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

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

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 · ≤ 110
exposurerequirednumber≥ 0.01 · ≤ 16
bloom_strengthrequirednumber≥ 0 · ≤ 4
sharpenrequirednumber≥ 0 · ≤ 1
offloadrequired"off" | "auto" | "on"
offload_power_cap_wrequirednumber≥ 20 · ≤ 100
scale_minrequirednumber≥ 0.375 · ≤ 1
scale_maxrequirednumber≥ 0.375 · ≤ 1
outlinerequiredboolean | null
visibility_cullingrequiredboolean

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 · ≤ 110
exposurenumber≥ 0.01 · ≤ 16
bloom_strengthnumber≥ 0 · ≤ 4
sharpennumber≥ 0 · ≤ 1
offload"off" | "auto" | "on"
offload_power_cap_wnumber≥ 20 · ≤ 100
scale_minnumber≥ 0.375 · ≤ 1
scale_maxnumber≥ 0.375 · ≤ 1
outlineboolean | null
visibility_cullingboolean

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
effectiverequirednumber | boolean | string | null
gpuMsrequirednumber | null
sharedPassrequiredstring | null
passGpuMsrequirednumber | null

performance#

object

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

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

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