0 Fork 0

mirror of https://github.com/InstanceBrick/nightcap.git synced 2026-10-24 00:01:08 +02:00

Files

T

dim-ghub 228121157b vr: drop test hooks and dead code, document every VR variable

- Remove the MOCKTAIL_VR_TEST_SESSION_LOSS_AFTER fault injection; nothing
  used it.
- The scripted head pose and the eye evidence dumper only work in builds
  configured with -DMOCKTAIL_VR_DIAGNOSTICS=ON (default OFF); release
  builds ignore their environment variables.
- Remove FindFmodInputCaptureProfile and HasExpectedFmodInputCaptureVtable
  (only their own tests called them) and the never-defined
  PrepareCaptureLocked declaration; the audio bridge files match upstream
  again.
- docs/VR.md lists every MOCKTAIL_VR_* variable with its default, linked
  from the README.

2026-10-13 00:28:26 -05:00

3.0 KiB

Raw Blame History

VR settings

Experimental OpenXR VR is opt-in: launch with --vr, or set vr.enabled: true in config.yaml. These environment variables tune it. Everything here only applies while VR is active.

Runtime and display

Variable	Default	Effect
`MOCKTAIL_VR_ENABLED`	`0`	Same as `--vr` (`1`) or `--no-vr` (`0`).
`MOCKTAIL_VR_RUNTIME`	`auto`	OpenXR runtime: `auto`, `system`, `wivrn`, `steamvr` or `alvr`. `XR_RUNTIME_JSON` overrides it.
`MOCKTAIL_VR_BACKEND`	`xr`	`native` keeps Roblox's stereo rendering without an OpenXR runtime, for debugging.
`MOCKTAIL_VR_FRAME_RATE_LIMIT`	`unlimited`	Frame-rate cap in VR, same values as `graphics.frame_rate_limit` (also `vr.frame_rate_limit`). With `unlimited` the headset's refresh rate paces frames.
`MOCKTAIL_VR_RENDER_SCALE`	`1.0`	Scales each axis of the runtime's recommended eye size, `0.25` to `2.0`.
`MOCKTAIL_VR_UNPACED`	`0`	`1` stops waiting for the headset between frames, to measure the maximum frame rate. Frames past the headset refresh are not shown. Not for playing.
`MOCKTAIL_VR_DESKTOP_MIRROR`	`1`	`0` stops copying the left eye to the desktop window.
`MOCKTAIL_VR_MIRROR_SHM`	unset	A shared-memory name such as `/nightcap-mirror` publishes both eyes for an external viewer. The segment is private to your user.
`MOCKTAIL_VR_KEYBOARD`	`1`	`0` turns off the in-headset keyboard.

Hands and scale

Variable	Default	Effect
`MOCKTAIL_VR_HAND_POSE_SOURCE`	`aim`	`grip` orients hands from the controller grip pose instead of the aim pose.
`MOCKTAIL_VR_HAND_PITCH_OFFSET`	`-20`	Degrees added to Roblox's own hand pitch.
`MOCKTAIL_VR_HAND_PITCH`	unset	Replaces the total hand pitch, in degrees.
`MOCKTAIL_VR_WORLD_SCALE`	`1.0`	Scales head, hand and eye offsets. `MOCKTAIL_VR_EYE_OFFSET_SCALE` is an older name for it.

Performance tracing

Variable	Default	Effect
`MOCKTAIL_VR_PERF`	unset	`1` logs per-stage frame timings and counters once a second.
`MOCKTAIL_VR_MEASURE_START_NS`, `MOCKTAIL_VR_MEASURE_END_NS`	unset	Limit `MOCKTAIL_VR_PERF` to a `CLOCK_MONOTONIC` window.
`MOCKTAIL_VR_POSE_LOG_INTERVAL`	`240`	Frames between head-pose log lines.

Diagnostics builds

These only work in builds configured with -DMOCKTAIL_VR_DIAGNOSTICS=ON. Release builds ignore them.

Variable	Default	Effect
`MOCKTAIL_VR_POSE_SOURCE`	`runtime`	`script` drives the head from a scripted motion instead of the headset, for testing without wearing it.
`MOCKTAIL_VR_POSE_AMPLITUDE_POSITION`, `_YAW`, `_PITCH`	`0.25`, `0.5`, `0.17`	Scripted motion size, in metres and radians.
`MOCKTAIL_VR_POSE_PERIOD_POSITION`, `_ROTATION`	`240`, `360`	Scripted motion period, in frames.
`MOCKTAIL_VR_XR_EVIDENCE_DIR`	unset	Writes submitted eye images to this directory.
`MOCKTAIL_VR_XR_EVIDENCE_INTERVAL`	`20`	Frames between evidence images.

3.0 KiB Raw Blame History