{"id":17206857,"url":"https://github.com/galister/wlx-overlay-x","last_synced_at":"2026-07-05T06:30:25.346Z","repository":{"id":189598654,"uuid":"680934906","full_name":"galister/wlx-overlay-x","owner":"galister","description":"WlxOverlay for OpenXR, written in Rust.","archived":true,"fork":false,"pushed_at":"2024-02-01T22:35:20.000Z","size":301,"stargazers_count":18,"open_issues_count":5,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-12T12:34:10.633Z","etag":null,"topics":["linux","openxr","openxr-overlay","vr-overlay","wayland"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/galister.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-08-20T21:51:44.000Z","updated_at":"2025-02-01T11:59:00.000Z","dependencies_parsed_at":"2024-02-02T00:07:40.135Z","dependency_job_id":null,"html_url":"https://github.com/galister/wlx-overlay-x","commit_stats":null,"previous_names":["galister/wlx-overlay-x"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galister%2Fwlx-overlay-x","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galister%2Fwlx-overlay-x/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galister%2Fwlx-overlay-x/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/galister%2Fwlx-overlay-x/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/galister","download_url":"https://codeload.github.com/galister/wlx-overlay-x/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240425412,"owners_count":19799327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linux","openxr","openxr-overlay","vr-overlay","wayland"],"created_at":"2024-10-15T02:44:09.951Z","updated_at":"2026-07-05T06:30:25.267Z","avatar_url":"https://github.com/galister.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WlxOverlay X\n\nA lightweight OpenXR overlay for Wayland desktops, inspired by XSOverlay.\n\nThis is a rewrite of [WlxOverlay](https://github.com/galister/WlxOverlay) (That one is for OpenVR).\n\n# Superceded by WlxOverlay-S\n\nPlease check out [WlxOverlay-S](https://github.com/galister/wlx-overlay-s), the next generation of this software, written using OpenXR, OpenVR and Vulkan in Rust. It provides the same functionality without the performance drawbacks of StereoKit and the NVidia compatibility issues of EGL.\n\n# Highly Experimental\nFeel free to reach out in case you run into issues.\n\n- Discord: https://discord.gg/gHwJ2vwSWV\n- Matrix Space: `#linux-vr-adventures:matrix.org`\n\n# Usage\n\nRecommend grabbing [rustup](https://rustup.rs/) if you don't have it yet.\n\nStart Monado or any other OpenXR runtime. \n\nRequired extensions are `EXTX_overlay` and `MND_egl_enable`.\n\n```sh\ncargo run\n```\n\nYou'll see a screen and keyboard. You can turn these on and off using the watch on your left wrist.\n\nRight click: turn your controller so that your backhand is facing your hmd. You'll get a yellow laser. Pull trigger for right-click.\n\nMove screen: Grab using grip. Adjust distace using stick up/down while gripping.\n\nResize screen: Same as Move screen but turn your controller to get the yellow laser.\n\n## Nix Flake\n\nA Nix Flake is availabe as `github:galister/wlx-overlay-x`. Cached builds are available using [garnix](https://garnix.io/). See [garnix docs](https://garnix.io/docs/caching) to see how to utilize this binary cache.\n\nRun `nix flake show github:galister/wlx-overlay-x` to see all outputs of this flake.\n\n# Known Issues\n\nStereoKit fails to build with OpenXR version 1.0.29. You can downgrade your OpenXR syetem package to fix this.\n\n# Reporting Issues\n\nMake sure to:\n- set `RUST_LOG=debug`\n- use a debug build to see GL assertion messages\n\n# Works Used\n- [freesound](https://freesound.org/), CC0 sound effects (find the sounds by searching for their number)\n- [StereoKit](https://stereokit.net/), MIT\n- [SimulaVR TextShader](https://github.com/SimulaVR/Simula/blob/82256ba4c9c933e85f41c3e0aa429314d7275228/addons/godot-haskell-plugin/TextShader.tres), MIT - StereoKit port from [StardustXR](https://github.com/StardustXR/server/blob/main/src/wayland/shaders/shader_unlit_simula.sks), GPL-2\n- See [Cargo.toml](https://github.com/galister/wlx-overlay-x/blob/main/Cargo.toml) for full list.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalister%2Fwlx-overlay-x","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgalister%2Fwlx-overlay-x","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalister%2Fwlx-overlay-x/lists"}