Skip to content

DisplayXR/displayxr-installer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

displayxr-installer

End-user meta-installer for DisplayXR — a single .exe / .pkg bundle that chains the OpenXR runtime, Shell, Leia SR plug-in, and MCP Tools into one guided install.

Tracks issue DisplayXR/displayxr-runtime#284.

Download

Platform Download
macOS 13+ latest .pkg
Windows 10/11 latest .exe

One-time install warning (unsigned)

Version 1 of the bundle ships unsigned. SmartScreen / Gatekeeper show a one-time prompt on the bundle itself, then everything inside installs silently.

  • macOS: right-click the downloaded .pkgOpen → click Open in the dialog. Apple requires this for unsigned installers — notarization is tracked in DisplayXR/displayxr-runtime#280.
  • Windows: if SmartScreen shows "Windows protected your PC", click More infoRun anyway. Authenticode signing is tracked in DisplayXR/displayxr-runtime#281.

What gets installed

Component macOS Windows
DisplayXR Runtime
DisplayXR Shell — (Windows-only today)
Leia SR Plug-in — (Windows-only, vendor SDK)
MCP Tools — (Windows-only today)

macOS users get a runtime-only install today; additional components join the bundle as they publish .pkg artifacts.

The exact version pins for each release live in versions.json at the tagged commit.

Developer install

Building DisplayXR from source or running a dev box? Use the runtime repo's orchestrator instead:

# macOS / Linux
git clone https://github.com/DisplayXR/displayxr-runtime
cd displayxr-runtime
./scripts/setup-displayxr.sh
:: Windows (elevated)
git clone https://github.com/DisplayXR/displayxr-runtime
cd displayxr-runtime
scripts\setup-displayxr.bat

The end-user bundle in this repo is a thin wrapper that chains the same per-component installers via NSIS / productbuild.

Building the bundle locally

# macOS
./scripts/build-bundle.sh --version v0.1.0-rc1
# → _out/DisplayXRBundle-0.1.0-rc1.pkg

# Windows
scripts\build-bundle.bat --version v0.1.0-rc1
:: → _out\DisplayXRBundle-0.1.0-rc1.exe

Both scripts read versions.json, fetch the per-component asset table from the runtime repo at the pinned runtime tag, download each component's installer from its GitHub Release, and assemble the bundle.

Release flow

Releases are cut by manual workflow_dispatch on .github/workflows/publish-bundle.yml:

  1. Bump versions.json in a PR (pinning each component to a specific tag).
  2. Merge.
  3. Run Publish bundle → enter the bundle tag (e.g. v0.1.0) → workflow builds both platforms in parallel and attaches .exe + .pkg to a new GitHub Release.

Not auto-triggered on component releases — that would be brittle (e.g., a runtime patch release shouldn't republish a bundle that wasn't compat-tested against the latest Shell).

License

Boost Software License 1.0 — same as the runtime.

About

End-user meta-installer for DisplayXR — single .exe / .pkg bundle that chains runtime + Shell + Leia plug-in + MCP Tools. Tracks issue DisplayXR/displayxr-runtime#284.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors