WlxOverlay

A lightweight OpenVR overlay for Wayland and X11 desktops, inspired by XSOverlay.

Primarily made this because I couldn't find a proper desktop overlay for Linux.

Formerly known as X11Overlay

For the OpenXR overlay, see WlxOverlay X.

Features:

• Access your screens from within OpenVR / SteamVR
• Works with a huge variety of setups, including tiling window managers.
• Mouse pointer that supports left/right/middle click
• Customizable keyboard with 2-hand typing
• Watch panel that shows:
  • Local time + 2 customizable time zones
  • Battery states of SteamVR controllers + all connected trackers
  • Volume rocker (customizable)
  • Toggles for screens / keyboard
• Notifications system with support for VRCX and Dbus (Desktop) notifications

Getting Started

Check out the Wiki here!

Join the discussion!

• Discord: https://discord.gg/gHwJ2vwSWV
• Matrix Space: #linux-vr-adventures:matrix.org

Known Issues

• Dragging curved displays very close may make them disappear. Long click the toggle on the watch to force respawn.
• Wayland: It's possible that your compositor does not implement some of the required protocols. Please create a ticket to let us know in that case.
• Wayland: screencopy can crash, especially with multiple screens up. this is being investigated, recommend wrapping in a restart loop for practical use in the meantime.

Works Used

• freesound, CC0 sound effects (find the sounds by searching for their number)
• FreeTypeSharp, MIT License
• Godot Engine, MIT License
• Liberation Fonts, SIL Open Font License v1.1
• Newtonsoft.Json, MIT License
• OBS Studio, GPLv2 License
• OpenVR SDK, BSD-3-Clause license
• OVRSharp, MIT License
• Silk.NET, MIT License
• SixLabors.ImageSharp, Apache v2 License
• Tmds.DBus, MIT License
• Tdms.LibC, MIT License
• bendahl/uinput, MIT License
• WaylandSharp, MIT License
• YamlDotNet, MIT License