THE SIM RACING XR TOOLKIT by Dan Suzuki
Build and test · Contributing · LMU rendering · Telemetry API · Overlay guide · Credits
Source-available Windows toolkit for iRacing and Le Mans Ultimate, free for noncommercial use under PolyForm Noncommercial 1.0.0. Version 0.4.0 is a development preview with integrated LMU quad views and stereo VRS, native crop/capture/output, 2D helmet overlays, headset frame generation and performance overlay, sharpening, read-only telemetry, spatial URL/window overlays, and an OpenXR layer editor. Validation is specific to the tested game, provider and headset configuration; see the LMU rig checks and remaining limits.
AI assistance notice: OpenAI Codex assisted with code, documentation, debugging and development iterations. AI assistance is not evidence of correctness or compatibility: automated checks and the documented rig tests describe what has actually been validated. Third-party authorship and licenses remain as credited below and in the third-party notices.
Install the Windows setup package from GitHub Releases. The installed app checks stable releases at startup and every six hours. A notification offers Download update, Later, and Skip this version. Downloading never installs automatically: use Install and restart when ready. Save your profile and close both sims and Clean Output first. Profiles and backups are preserved. After restarting, use Setup → Update runtime layer to update the separately registered native files.
Setup → Check for updates checks manually, including a previously skipped version. Source builds and unpacked development builds do not self-update. After building from source, use npm start, or run release/0.4.0/win-unpacked/OpenGrid XR.exe after packaging; keep that entire directory together. The build is unsigned; signing can be performed externally.
- Select iRacing or Le Mans Ultimate, then a profile.
- In View & crop, set rectangular crop and render scale. Enable the custom visibility mask only if wanted. Edit its control points, use arrow keys for fine adjustment, or start from a Formula/GT/Open contour.
- Choose Driving or Streaming, then Save profile. Saving writes only OpenGrid XR's own files.
- Close both sims and Clean Output. Use Setup → Install runtime layer when ready. This explicitly registers only OpenGrid XR's own current-user 64-bit OpenXR entry; it does not switch runtimes or remove other layers.
- Start the sim through OpenXR. A native OpenVR path will not load this layer. Refresh status in Setup to see whether an actual session has connected.
Start from neutral settings. Overlapping FOV/visibility modifications from another layer can interact with OpenGrid XR; use one crop mechanism while validating a setup. Registration is configuration, not proof that a running game loaded it.
Open Setup → Modules to choose available features globally. Core only keeps Session, View & crop, Profiles, OpenXR layers and Setup. Driving essentials adds helmet, HUD, input bindings and sharpening; All modules restores every feature page. Apply the selection after saving or discarding profile edits. Existing installs start with all modules available, preserving their current behavior.
The selection lives in module-settings.json beside the profiles. It does not rewrite profile preferences or exported profiles: disabled features and their controller assignments return with the same settings when re-enabled. Optional pages load on first visit. Disabling modules closes their telemetry, recording, capture and input services; previously loaded JavaScript remains cached until app restart. An enabled module makes its controls available; its per-profile enable switch still determines actual use.
Restart the sim after changing modules. Disabled Clean Output also makes the effective runtime mode Driving, preserving the saved Streaming preference. Benchmark requires Telemetry and a native engine session, for example an enabled Performance HUD profile; availability of Benchmark alone does not load the engine.
OpenGrid still registers one OpenXR layer. The private enhancements DLL loads only for enabled native engine features. Disabled helmet and spatial renderers defer graphics resources and reference spaces until needed; inactive image processing skips projection-region collection. Without a Clean Output viewer, connection probes are bounded to four per second, so opening output can take up to 250 ms to attach. Quad stream copies pause while the viewer still holds its last frame. Full-image single-slice processing skips an unnecessary preservation copy; partial images, arrays, mip chains and MSAA keep it. These reduce unused work, not a promised in-game FPS increase.
Driving: rectangular crop adjusts the OpenXR projection and recommended render dimensions together. Render scale controls pixel density. A freeform contour can add a conservative exterior hidden-area mesh, with padding. The game must query and use the hidden-triangle visibility mask for that optimization to have an effect. A polygon is not a guarantee of GPU savings. The runtime must permit mutable FOV for rectangular crop.
Streaming: the native layer preserves the full source and can expand its horizontal projection. The saved custom contour is inactive. Rectangular crop becomes output framing; it does not reduce headset rendering in this mode. Both eyes currently receive the requested expansion. This reserves source content for smoothing and horizon stabilization. Larger render dimensions are recommendations; the game may ignore them.
Render/contour changes are snapshots at game session startup: restart the game to apply them. Clean Output reads its settings when launched; close and reopen it after changing output/framing settings. No live geometry resizing occurs underneath the game.
Disable crop, available in both View & crop and LMU rendering, bypasses rectangular crop and contour masking without clearing their saved values. Helmet rendering remains independent. Save and restart the sim to apply it; turning it off restores the saved crop and mask behavior. Stream offsets, expansion and stabilization remain configured.
For LMU quad views, the integrated adapter coordinates outer and focus projections. Streaming keeps the provider's full outer view; extra stream FOV expansion is unsupported for this path. Clean Output combines the current frame's outer and high-resolution focus image before normal framing and stabilization, falling back to the current outer image if a usable focus image is unavailable. See the LMU projection and processing contract.
- Connect a gaming-PC GPU output to the capture card on the stream PC. Configure it as an extended Windows display.
- In Stream, select that output display, set the internal canvas resolution/FPS, and enable Start fullscreen.
- Save the Streaming profile, install the connection if needed, and start/restart the OpenXR game.
- Select Open clean output. It opens a separate native window on the selected monitor, in borderless fullscreen. The settings app stays separate from the captured image.
- F11 toggles fullscreen. Esc returns to windowed mode; a second Esc closes the window. If the monitor is disconnected, choose a connected output before launching.
- In Spatial overlays, use Show in stream per enabled source. Selected overlays retain their VR placement in the streamed camera view. Sources are VR-only by default. The additional stream texture ring runs only while Clean Output is active.
Set the Windows display mode to the capture card's supported resolution and refresh rate; selecting a canvas/FPS in OpenGrid XR does not reconfigure Windows or the capture card. Game audio is configured separately. On one PC, OBS can capture the Clean Output window. A direct OpenGrid XR OBS source plugin is not included.
Symmetric extra area links both expansion sliders. Turning it on sets both to the larger existing side; turning it off keeps the values for independent editing. The choice is stored in each profile.
Stabilization reserve sets all four margins together. Expand the individual controls to fine-tune left, right, top and bottom. With different margins, the global value shows their average; moving it sets every margin to the new value.
The output uses D3D11 shared textures, so its graphics adapter must be compatible with the game's. Supported stereo D3D11 projection capture is the initial path. Unsupported capture formats/view modes should remain pass-through for the game and must not be represented as working capture. No automatic game launch or runtime switch is performed.
The helmet editor uses original Formula, GT and Open interiors rendered in Blender as a single flat 2D composition shared by both eyes. The helmet sits above the game image and below the HUD and other overlays, without stereo helmet depth or a real-time helmet mesh. Helmets remain visible in Driving and Streaming, while Clean Output excludes them. Optional damped head movement and acceleration-driven movement default to off. See the helmet guide for appearance controls and editable Blender sources.
The adjustable visor feature was inspired by Williem3's Sim-QVFR. OpenGrid XR's implementation is independent; no Sim-QVFR code or assets are included. This inspiration credit does not change either project's licensing.
Fit crop to visor opening explicitly updates the saved per-eye visibility mask and rectangular crop from the opaque helmet border, with padding and movement allowance. Tint and translucent lettering never count as hidden scenery. Crop and masks can reduce rendering only when the game/runtime honors them; painting a helmet over a full frame alone does not save scene rendering. Streaming preserves the full source and disables the driving mask.
Telemetry reads the native iRacing SDK and LMU shared-memory interfaces. Enable it in a game profile, save, and open the telemetry page. It displays source freshness, speed, RPM, pedals, fuel, laps and supported flags; unknown or stale values are not shown as live. Collection defaults to 20 Hz, is capped at 30 Hz, and pauses without a consumer. Current supported LMU builds use their built-in interface, with no external shared-memory plugin. See the telemetry API for the standalone read-only JSON Lines interface and source requirements.
Spatial overlays supports up to 15 URL/window sources with head-following or local placement, presets, individual opacity/size and a combined frame-transport budget. Drag sources in the Top · X/Z or Front · X/Y placement map to adjust position, or use the numeric controls. Save settings and restart the sim when enabling the engine for the first time. Select capture windows again after restarting OpenGrid. Recenter overlays aligns their local anchors; Center VR in game sends your explicitly configured in-game recenter shortcut after a delay. Wheel / joystick centering can learn a button or POV direction for that same action. See the overlay guide for placement, resource controls and GPU/runtime limits.
Lap benchmark records application frame intervals together with lap boundaries, weather, temperatures and nearby traffic. Compare complete laps, inspect partial segments and export offline HTML reports or CSV samples. Successful generated-frame submissions are counted separately from real application frames and repeats; CPU/GPU render duration and actual headset display counts remain unavailable unless a source supplies them. See the benchmark guide for definitions, recording limits and the different traffic-distance methods used by the sims.
Profiles and exact-file backups live in the app's data directory (Setup → Open data folder). The runtime lives under %LOCALAPPDATA%/OpenGridXR/runtime. The last saved profile for each game is selected for its next session. Imports are validated drafts until saved. Exported profiles contain the contour and all local settings; no executable code or asset paths are imported.
Stale saves are rejected. A damaged profile file is preserved; the app can show its backups and restore a valid prior file. Restore also preserves the displaced file. Setup → Remove layer removes only this application's current-user registration and keeps files/profiles for recovery.
The optional native engine adapts frame generation from VectorXR 0.20.0 by DienerTech's VectorXR, credited and linked directly in the Frame generation page. No VectorXR desktop app or second layer installation is needed. OpenGrid privately loads OpenGridXR-Enhancements.dll downstream of its crop/capture layer. Source and modifications are included with MPL-2.0 notices and corresponding source links in Third-party notices. Existing VectorXR settings are not used or changed. The explanatory preview changes with interpolation or extrapolation; it is not a live benchmark.
In Frame generation, enable the feature, select interpolation or extrapolation, choose Dynamic/Auto/2×/3×/4× and adjust quality/artifact controls. Shader motion estimation is the portable default; NVIDIA hardware estimation uses the optical-flow component in the installed graphics driver and can fall back where unavailable. Enabling frame generation requires a game restart. Disable the runtime's own motion smoothing while using it. Frame generation is experimental: generated frames can exhibit artifacts and interpolation adds latency. The streaming window continues to show captured real game frames.
In Performance HUD, select compact or expanded layout, position, distance, scale, opacity, colors, update rate and displayed information. The real head-following panel can show application FPS/frame intervals, a timing graph, performance metrics and actual frame-generation state. The toolkit summary is labelled Configured: a saved setting is not proof that a running session has applied a restart-required change. This is a configurable status panel, not an interactive in-headset settings menu. Desktop previews use placeholders, not invented live metrics.
Default shortcuts are Ctrl+Alt+F9 for the frame-generation A/B toggle, Ctrl+Alt+F10 for overlay visibility and Ctrl+Alt+F11 for overlay layout. Keys are configurable or can be unbound; duplicate assignments are rejected. Both features default to off. After upgrading from 0.1.0, close the sims/output and use Setup → Install/update runtime layer to deploy the added engine.
Enable Show render resolution & scale in the HUD to show both the actual submitted left/right projection dimensions and OpenGrid's configured scaling percentage. Pixel dimensions come from the application's submitted eye rectangles, not an estimate from the scale slider. Before a valid frame, dimensions are unavailable. The configured percentage is separate because a game may ignore resolution recommendations.
The frame-generation HUD also shows cumulative generated frames, generated frames per second and their share of successful submissions. Counts reflect actual successful synthetic submissions, not the configured multiplier. The lap recorder retains separate application, generated, repeated and submitted totals.
View & crop → Supersampling / render scale sets OpenGrid's per-axis resolution recommendation, from 50 to 200%. At 200%, width and height double, so pixel count quadruples. Game and runtime supersampling multipliers combine with this setting; a game may ignore recommendations.
LMU quad views and stereo VRS are configured on the dedicated LMU rendering page. The integrated adapter comes from LMU Quad View Mod v0.2.1 and offers Native, external QVFR and embedded VectorXR quad providers; stereo VRS is a separate mode. Dynamic focus FOV is excluded. Save the profile and use Check launch before launching offline. See LMU rendering for providers, executable checks and validation limits. iRacing graphics settings remain managed in iRacing itself; OpenGrid does not edit its renderer INI.
Headset sharpening provides Luma Sharpen (strength, clamp, radius and sample pattern) and AMD FidelityFX CAS. It processes supported D3D11 projection images before frame generation; the status overlay remains separate and clean stream capture precedes headset sharpening. The original MIT-licensed LumaSharpen algorithm also underlies the Sboys3 implementation. Lens correction belongs to the headset driver/runtime and must not be applied twice as a generic application warp.
Included: profile editor and backup/import/export, per-eye contour editor, supersampling/crop with a crop bypass, integrated LMU quad views and stereo VRS, symmetric stereo stream expansion, own OpenXR layer, layer registration editor, D3D11 capture with LMU focus composition, smoothing/horizon stabilization, fullscreen clean output, integrated experimental headset frame generation, configurable VR overlay, Luma/CAS sharpening, read-only iRacing/LMU telemetry, up to 15 spatial URL/window overlays with top/front placement maps, and keyboard/controller centering controls.
OpenXR layers lists current-user and all-user implicit/explicit registrations, their manifests and libraries, and registration health. Close the sim before enabling or disabling an entry. Current-user changes require no administrator approval and apply to the shared 32/64-bit registration view. All-user changes require Allow administrator changes and a Windows approval prompt for each change.
Each change is backed up and verified. Change history → Restore restores the exact previous value only while the registration still matches the change made by OpenGrid. Registration state does not prove that a game loaded a layer, and list order is not loading order. Explicit layers still need an application request. Changes apply on the application's next launch; the browser preview is read-only.
Controller bindings offer quick driving actions: performance HUD visibility/layout, frame generation on/off, spatial overlay visibility, and Center VR in game using the saved game shortcut. Setup and geometry settings are not bindable. The controller icon beside a supported action learns a button or POV direction. Save the profile after learning. The Controller bindings page lists assignments and supports removing or relearning them. Bindings are per profile and use device instance IDs rather than enumeration order; reconnecting through a different device instance can require relearning.
The native DirectInput reader supports up to 128 buttons and four POV hats per device, uses background nonexclusive acquisition, and sends press transitions only. Holding a button does not repeatedly toggle. Initial and reacquired device states establish a baseline without firing actions. The helper starts only for enabled saved bindings or learning, and stops when unused. No force-feedback or keyboard injection is used for toggle bindings.
Actions work on the saved selected profile while the app remains open, including when a sim is in the foreground. They pause while the editor is dirty, busy or learning a binding. HUD and frame-generation bindings send acknowledged commands to the matching live game session; the feature must be enabled when that session starts. They do not rewrite startup preferences. Obsolete setup bindings from older profiles remain import-compatible but cannot execute. Physical wheel/buttonbox validation on the game PC is still required.
In Setup, use Test offline in LMU after saving the profile and installing
the runtime layer. Select Le Mans Ultimate.exe or LeMansUltimate.exe in your
game installation. OpenGrid XR starts that executable directly with the game
folder as its working directory, following the official no-EAC launch instructions.
The launcher passes +XR for native OpenXR, as documented in the LMU OpenXR hotfix notes,
because direct launches do not inherit Steam's VR launch selection.
Keep Steam and your VR runtime running. This is for offline Race
Weekend tests with unsigned DLLs; DLL loading still depends on the selected VR
runtime. The launcher does not modify game files or uninstall EAC. Close LMU and
start it normally through Steam with EAC for online racing. Already-running sims
block the test launch. Canceling the executable picker starts nothing.
Requires Node.js 24 or newer, npm, CMake 3.24+ and Visual Studio 2022 with Desktop C++ tools/Windows SDK.
npm ci
npm test
powershell -ExecutionPolicy Bypass -File scripts/build-native.ps1
npm run build
npm run test:desktop
npm run packagenpm run dev opens a browser-only interface with local browser storage. Native installation and output require the desktop app. Tests use isolated user data; OPENGRIDXR_TEST_MODE=1 disables layer installation/removal. Native tests load the actual DLL through a fake runtime and use local D3D11 hardware/shared texture fixtures without registering it globally.
Starting with version 0.3.12, original OpenGrid XR code and assets are offered under PolyForm Noncommercial 1.0.0, except where a file or dependency carries separate terms. This is a source-available license with noncommercial restrictions. Third-party code, fonts and modifications to MPL-covered VectorXR files retain their respective licenses; see THIRD-PARTY-NOTICES.md and native details. Earlier releases remain available under the licenses granted with those releases, including GPL-2.0; this change does not revoke those rights. No expiry, account or paid feature gates.
Optional support links are available at the bottom of the sidebar, above Quick start & about: Buy me a coffee and affiliate discounts. Affiliate purchases may earn Dan a commission. Support is optional and does not unlock features.
OpenGrid XR is developed by Dan Suzuki and contributors, with the AI assistance disclosed above. The toolkit builds on the following projects and references:
| Project / author | Contribution and license context |
|---|---|
| VectorXR by DienerTech LLC | Adapted native engine from v0.20.0, including frame generation and the embedded quad provider. Covered source and modifications remain MPL-2.0. |
| LMU Quad View Mod by Dan Suzuki | Integrated LMU adapter from v0.2.1 for quad rendering and stereo VRS. Original code is PolyForm Noncommercial 1.0.0; bundled dependencies retain their own terms. |
| Horizonlock VR / SteadyXR by Dan Suzuki | Stabilization math, with the explicit additional PolyForm grant for the included copies; prior GPL-2.0 grants remain effective. |
| Sim-QVFR by Williem3 | Inspiration for the adjustable visor. No Sim-QVFR code or assets are included. |
| SweetFX / LumaSharpen by CeeJay.dk | Original LumaSharpen algorithm by Christian Cann Schuldt Jensen, MIT. |
| FidelityFX CAS by AMD GPUOpen | Contrast Adaptive Sharpening, MIT. |
| iRacing SDK and TinyPedal/pyLMUSharedMemory | Telemetry ABI and field-layout references, with the retained BSD and MIT notices respectively. |
The optional external QVFR provider is mbucchia's Quad-Views-Foveated, installed separately; selecting it does not redistribute it or change its license. OpenXR headers, MinHook, NVIDIA interface headers, Electron/Chromium, React, Lucide and the Archivo, Inter and DM Mono fonts also retain their respective notices. See THIRD-PARTY-NOTICES.md for full attributions, pinned revisions, license texts and corresponding source. Credits do not imply endorsement by upstream authors.