flutter_open_xr

English | 日本語

Build Flutter UI into a Windows OpenXR runtime host with one command.

Why this project

flutter_open_xr provides:

• A reproducible build CLI for Windows OpenXR host output.
• A Flutter-side background control channel for the OpenXR runtime.

What the build command does

dart run flutter_open_xr build runs these steps:

1. flutter pub get
2. flutter build bundle --debug --target-platform=windows-x64
3. Download the Flutter embedder ZIP pinned to your local Flutter engineRevision
4. Use OpenXR-SDK release-1.1.57 (or your own checkout via --openxr-sdk-dir)
5. Build native/windows via CMake + MSBuild and copy runtime files to output

Install

flutter pub add flutter_open_xr

Or in pubspec.yaml:

dependencies:
  flutter_open_xr: ^0.1.1

Quick start

From your Flutter project root:

dart run flutter_open_xr build

Show all options:

dart run flutter_open_xr build --help

Dry-run to verify commands without executing:

dart run flutter_open_xr build --dry-run

Runtime background control

Import the runtime API from Flutter:

import "package:flutter_open_xr/background.dart";

Supported commands:

• XrBackgroundController.setNone()
• XrBackgroundController.setGroundGrid() (default mode)
• XrBackgroundController.setDdsFile(path) (.dds only)
• XrBackgroundController.setGlbFile(path) (currently returns "not supported yet")

Background command format between Flutter and host is stable and text-based:

• none
• grid
• dds|<path>
• glb|<path>

Build options

--project-dir <path>      Flutter project directory (default: current directory)
--output-dir <path>       Output directory for runtime artifacts
--openxr-sdk-dir <path>   Existing OpenXR-SDK directory to use (skip clone)
--cmake <path>            CMake executable path (default: cmake)
--flutter <path>          Flutter executable path (default: flutter)
--git <path>              Git executable path (default: git)
--configuration <name>    Debug / Release / RelWithDebInfo / MinSizeRel (default: Release)
--dry-run                 Print commands only

Requirements

• Windows 10/11
• Visual Studio 2022 Build Tools (C++ toolchain)
• CMake
• Flutter SDK
• OpenXR Runtime (for example Quest Link or SteamVR)

Output

Default output directory:

<project>/build/flutter_open_xr/windows/Release

Main executable:

flutter_open_xr_runner.exe

Local example

This repository includes a sample app in example/. It uses a local path dependency:

dependencies:
  flutter_open_xr:
    path: ..

Run:

cd example
flutter pub get
dart run flutter_open_xr build --dry-run