Skip to content

VRStat v1.0

Choose a tag to compare

@alpaisley alpaisley released this 10 Mar 12:56
· 6 commits to main since this release

VRStat.html

========================================
VRStat -- X-Plane 12 VR Performance Monitor
Windows Only | VR Only | SDK 4.2.0

WHAT IS VRSTAT?

VRStat is a lightweight X-Plane 12 plugin that displays a configurable
heads-up overlay showing your PC's key performance metrics inside your
VR headset. Built for VR pilots who need to monitor system health without
leaving the cockpit.

The overlay appears automatically when you enter VR and hides when you
leave. Every metric can be toggled on or off and reordered to suit your
workflow via an in-headset setup panel.

METRICS

NIC Name Friendly name of your selected network adapter
Upload Mbps Live upload speed -- useful for monitoring your VR streaming link
FPS Smoothed frame rate (30-sample rolling average)
Colour coded: green >= 40fps / yellow >= 25fps / orange below 25fps
Frame Time Raw milliseconds per frame -- more precise than FPS for VR tuning
VRAM Used GPU video memory in use (GB). Automatically targets your discrete GPU
CPU Usage % Total processor load across all cores via Windows PDH

PERFORMANCE IMPACT

All data is collected on a 0.5 second flight loop timer -- not every frame.
There is zero per-frame cost beyond drawing a few lines of text.

Measured overhead: ~82 microseconds / 0.33% CPU alongside A319 + Traffic
Global + AirbusFBW.

INSTALLATION

  1. Download and unzip VRStat.zip

  2. Copy the VRStat/ folder into your plugins directory:
    X-Plane 12/Resources/plugins/

    The final path should read:
    X-Plane 12/Resources/plugins/VRStat/win_x64/VRStat.xpl

  3. Start X-Plane 12 and enter VR -- the overlay appears automatically.

  4. Go to Plugins > VRStat > Select NIC...
    Click your network adapter (typically Ethernet or Wi-Fi).
    Your selection is saved to vrstat_nic.txt for next time.

  5. Go to Plugins > VRStat > Setup...
    Toggle metrics on/off using the [X] / [ ] checkboxes.
    Reorder them using the [^] and [v] arrows.
    Click [ Save ] to apply or [ Cancel ] to discard.

  6. Use Plugins > VRStat > Toggle Overlay to show or hide the overlay.

NOTE: The overlay is VR-only and will not appear in 2D mode.
The Setup and Select NIC panels are accessible from inside the
headset using your VR controller ray.

CONFIGURATION FILE

Settings are saved to vrstat_cfg.txt in the plugin folder alongside
VRStat.xpl. You can edit this file by hand or use the in-headset Setup
panel. Your NIC selection is stored separately in vrstat_nic.txt.

Example vrstat_cfg.txt:

Metric toggles (1=enabled, 0=disabled)

NIC=1
UPLOAD=1
FPS=1
FRAMETIME=0
VRAM=1
CPU=0

Display order (comma separated)

ORDER=NIC,UPLOAD,FPS,FRAMETIME,VRAM,CPU

CPU is disabled by default as Windows PDH requires a short warm-up period
after X-Plane loads. Enable it in Setup once the sim is running.

ROLLBACK / UNINSTALL

To temporarily disable VRStat without uninstalling, rename VRStat.xpl to
VRStat.xpl.disabled -- X-Plane ignores files without the .xpl extension.

To uninstall, delete the VRStat/ folder from Resources/plugins/.

REQUIREMENTS

Sim X-Plane 12 (tested on 12.4.0)
SDK X-Plane SDK 4.2.0
OS Windows 10 / 11 (64-bit)
GPU Any DirectX 11/12 adapter. VRAM auto-selects discrete GPU.
VR Any OpenXR or SteamVR headset supported by X-Plane 12

Linux and Mac are not supported. VRStat uses Win32 APIs (DXGI, PDH,
WinSock) that have no cross-platform equivalent.

========================================
alanpaisley.vrstat