Contribute

DisplayXR is open source and vendor-neutral. Whether you want to add a feature, an extension, or a new platform, here's how the project is laid out and where to start.

Understand the design first

Architecture

The runtime stack, the native-compositor model, and the display-processor boundary — start here before changing the pipeline.

Roadmap

What's done, in progress, and planned — so your work lands where it's needed and doesn't duplicate effort.

Where the code lives

DisplayXR is a multi-repo project under the DisplayXR org. External contributors PR directly against the relevant repo.

Core

displayxr-runtime

Core OpenXR runtime with native compositors for D3D11, D3D12, Vulkan, Metal, and OpenGL.

displayxr-extensions

OpenXR extension specs and headers for tracked spatial display capabilities.

Engine plugins

displayxr-unity

Unity engine plugin (UPM package) with eye-tracked stereo rendering, sample scenes, and standalone editor preview.

displayxr-unreal

Unreal Engine plugin (UE 5.3+) with eye-tracked Kooima stereo, camera- and display-centric rigs, Blueprint components, material expression nodes, and zero-copy atlas handoff. Windows, macOS, Android.

Libraries & tools

kooima-projection

Off-axis frustum projection math library for spatial display rendering.

displayxr-mcp

Tiny embeddable Model Context Protocol server framework, plus the DisplayXR MCP Tools installer that end users download to opt in to AI-agent / voice control. The framework lets the runtime, the reference shell, and any third-party workspace controller expose live spatial state and control to AI agents (Claude Code, voice CLIs, custom drivers); the installer writes a registry capability flag the runtime and shell read at startup.

Demo apps

displayxr-demo-gaussiansplat

Real-time 3D Gaussian Splatting viewer (.spz / .ply) for spatial displays. macOS + Windows.

displayxr-demo-modelviewer

Glasses-free 3D glTF 2.0 PBR model viewer (OpenXR + Vulkan). Drag-and-drop a .glb / .gltf model.

Workspace controllers

displayxr-shell-releases

Reference spatial workspace controller — a 3D window manager with multi-app compositing, 2D window capture, dynamic layouts, and focus-adaptive rendering. Ships as a standalone installer; build your own controller for verticals, kiosks, or OEM-branded workspaces using the same extension surface.

Key decisions (ADRs)

Architecture Decision Records capture why the runtime is built the way it is. A few you'll want before touching the pipeline — the full set is in docs/adr.

ADR-001Native compositors per graphics API ADR-007The compositor never weaves (that's the display processor's job)ADR-019Vendor plug-in / aux boundary

Add a feature, extension, or platform

The deep guides live in the runtime repo; these are the entry points. (Writing a plug-in for a 3D-display panel instead? See the Display Vendors guide.)

Add an OpenXR extension

Wire a new XR_EXT_* through the loader, state tracker, and compositors.

Write a device driver

Add input or device support inside the runtime.

Build & CI

Build on Windows/macOS, the MinGW compile-check, and the headless displayxr-cli selftest gate.

Pick up an issue

Runtime dev issues live in the runtime repo; external contributors open a PR directly against it. New here? Filter for good first issue.

Open issues Good first issues