From 688e0d85cb80ce7ba67cb6b5145450cf15880347 Mon Sep 17 00:00:00 2001 From: galister <3123227-galister@users.noreply.gitlab.com> Date: Fri, 16 Feb 2024 11:31:22 +0000 Subject: [PATCH] add wlxoverlay-s --- content/docs/fossvr/wlxoverlay-s.md | 18 +++++++++++++++++ content/docs/fossvr/wlxoverlay-x.md | 24 ----------------------- content/docs/steamvr/wlxoverlay.md | 30 ++++++++++++++++++++++++----- 3 files changed, 43 insertions(+), 29 deletions(-) create mode 100644 content/docs/fossvr/wlxoverlay-s.md delete mode 100644 content/docs/fossvr/wlxoverlay-x.md diff --git a/content/docs/fossvr/wlxoverlay-s.md b/content/docs/fossvr/wlxoverlay-s.md new file mode 100644 index 0000000..10e179b --- /dev/null +++ b/content/docs/fossvr/wlxoverlay-s.md @@ -0,0 +1,18 @@ +--- +weight: 300 +title: WlxOverlay-S +--- + +# WlxOverlay-S + +- [WlxOverlay-S GitHub repository](https://github.com/galister/wlx-overlay-s) + +WlxOverlay-S is a tool that lets users interact with their X11 or Wayland desktop from inside VR. + +It supports a vast variety of desktop environments, and comes with a fully customizable keyboard and watch. + +Please take a look at the GitHub Readme for a comprehensive guide. + +## Support + +Reach out in the `wlxoverlay` room in Discord or Matrix. \ No newline at end of file diff --git a/content/docs/fossvr/wlxoverlay-x.md b/content/docs/fossvr/wlxoverlay-x.md deleted file mode 100644 index 76ecce9..0000000 --- a/content/docs/fossvr/wlxoverlay-x.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -weight: 300 -title: WlxOverlay-X ---- - -# WlxOverlay-X - -- [WlxOverlay-X GitHub repository](https://github.com/galister/wlx-overlay-x) - -{{< hint danger >}} -**Warning** - -WlxOverlay-X is still to be considered alpha-quality and highly experimental. -{{< /hint >}} - -WlxOverlay-X is the OpenXR edition of WlxOverlay, the tool that lets users interact with their X11 or Wayland desktop from inside VR. - -It supports a vast variety of desktop environments, and comes with a fully customizable keyboard. - -WlxOverlay-X works on any runtime that implements EXTX_OVERLAY. Currently this is limited to Monado-based runtimes. - -WiVRn users: while WiVRn supports EXTX_OVERLAY, it does no frame composition on the server side, so overlay apps can have ghosting issues. - -If you are looking for an overlay for SteamVR, see [WlxOverlay](/docs/steamvr/wlxoverlay/). diff --git a/content/docs/steamvr/wlxoverlay.md b/content/docs/steamvr/wlxoverlay.md index d1de2da..3e9e73d 100644 --- a/content/docs/steamvr/wlxoverlay.md +++ b/content/docs/steamvr/wlxoverlay.md @@ -5,12 +5,32 @@ title: WlxOverlay # WlxOverlay -- [WlxOverlay GitHub repository](https://github.com/galister/WlxOverlay) -- [Getting Started Wiki](https://github.com/galister/WlxOverlay/wiki/Getting-Started) -- [Troubleshooting Wiki](https://github.com/galister/WlxOverlay/wiki/Troubleshooting) - WlxOverlay is a tool that lets users interact with their X11 or Wayland desktop from inside VR. It supports a vast variety of desktop environments, and comes with a fully customizable keyboard. -If you are looking for an overlay for Monado / WiVRn, see [WlxOverlay-X](/docs/fossvr/wlxoverlay-x/). +There are currently two editions of WlxOverlay. + +## WlxOverlay-S + +- [WlxOverlay-S GitHub repository](https://github.com/galister/wlx-overlay-s) + +WlxOverlay-S is the newer iteration of the software with major performance improvements. We recommend trying this first. + +The S edition supports both Monado and SteamVR, and avoids many of the pitfalls of the previous iterations by using Vulkan instead of EGL. + +## WlxOverlay Classic + +- [WlxOverlay GitHub repository](https://github.com/galister/WlxOverlay) +- [Getting Started Wiki](https://github.com/galister/WlxOverlay/wiki/Getting-Started) +- [Troubleshooting Wiki](https://github.com/galister/WlxOverlay/wiki/Troubleshooting) + +WlxOverlay Classic is recommended if WlxOverlay-S is not working for you. + +It works well once you get it working, but the lengthy troubleshooting page speaks for itself. + +It is prone to run into issues with NVidia's EGL driver, as well as GLFW specifically. + +## Support + +Reach out in the `wlxoverlay` room in Discord or Matrix. \ No newline at end of file