{"id":29010990,"url":"https://github.com/nyabsi/steamvr_overlay_vulkan","last_synced_at":"2025-06-25T17:10:26.566Z","repository":{"id":299800478,"uuid":"1003965259","full_name":"Nyabsi/steamvr_overlay_vulkan","owner":"Nyabsi","description":"barebone template for creating SteamVR overlays with SDL3, Vulkan and ImGui","archived":false,"fork":false,"pushed_at":"2025-06-18T11:21:23.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-18T11:32:10.243Z","etag":null,"topics":["openvr","openvr-api","openvr-overlay","openvr-samples"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nyabsi.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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-17T23:13:48.000Z","updated_at":"2025-06-18T11:21:26.000Z","dependencies_parsed_at":"2025-06-18T11:43:57.043Z","dependency_job_id":null,"html_url":"https://github.com/Nyabsi/steamvr_overlay_vulkan","commit_stats":null,"previous_names":["nyabsi/steamvr_overlay_vulkan"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Nyabsi/steamvr_overlay_vulkan","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nyabsi%2Fsteamvr_overlay_vulkan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nyabsi%2Fsteamvr_overlay_vulkan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nyabsi%2Fsteamvr_overlay_vulkan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nyabsi%2Fsteamvr_overlay_vulkan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nyabsi","download_url":"https://codeload.github.com/Nyabsi/steamvr_overlay_vulkan/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nyabsi%2Fsteamvr_overlay_vulkan/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261917439,"owners_count":23229919,"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":["openvr","openvr-api","openvr-overlay","openvr-samples"],"created_at":"2025-06-25T17:10:25.880Z","updated_at":"2025-06-25T17:10:26.514Z","avatar_url":"https://github.com/Nyabsi.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SteamVR Overlay Example\n\nOpenVR overlay template project written in C++23 to create OpenVR overlays with ImGui utilizing modern and cross-platform graphic libraries\n\n## Purpose\n\nThe purpose and goal of this project is to provide high quality, fully feature complete template for writing cross-platform and performant OpenVR overlays utilizing the best practises.\n\nThis project is intended for developers, not users. If your goal is not to create an OpenVR overlay then this project is not for you.\n\n\u003e [!WARNING]\n\u003e This project is made with Vulkan 1.3+ in mind, this code will not run on your GTX 7xx even if it is capable of running SteamVR\n\n## Features\n\n- Vulkan Rendering\n\t- Uses sRGB colour profile\n \t- Dynamic Rendering\n  \t- HMD Refresh Rate synchronization\n- ImGui multiple platform backends\n\t- Custom OpenVR backend built for OpenVR exclusively\n \t- Optional SDL3 backend if your application requires an representable Window\n- First class OpenVR support\n\t- Text Input\n\t- Mouse Emulation\n\t\t- Left, Right and Middle\n\t\t- Scroll Wheel\n    \t- Virtual Keyboard\n    - Overlays\n\t\t- Dashboard\n\t\t- World\n\t\t\t- You can create overlays relative to Origin (World Space) or Tracked Devices (ie. Head, etc...)\n    - Useful high-level OpenVR API wrappers\n- Written cross-platform in mind\n\t- Supports both Linux and Windows\n\t- Full support for AMD, NVIDIA and Intel GPUs\n\n## Building\n\n\u003e [!IMPORTANT]\n\u003e You need [Vulkan SDK](https://vulkan.lunarg.com/) to build this project, make sure you have it downloaded before proceeding\n\nMake sure you have the required libraries fetched through `git submodule`\n\n```sh\ngit submodule init \u0026\u0026 git submodule update\n```\n\nBuild it through Visual Studio on Windows or if you're using an Unix-like system\n\n```sh\ncmake -B build .\ncmake --build build\n```\n\n## Running\n\n\u003e [!IMPORTANT]\n\u003e This project uses CMake to copy all the required resources from `resources` to the build directory, if you're using custom build environment you need to copy them manually\n\nRun `steamvr_overlay_vulkan.exe` (*or* `steamvr_overlay_vulkan` on Unix-like systems) from the build directory\n\n## License\n\nThis project is licensed under `Mozilla Public License 2.0` which can be found from the root of this project named `LICENSE`\n\nit comes with the following legal obligations:\n\n- credit the project author (Nyabsi)\n- disclose any changes done to files in scope of this project\n- ship the license visibly in your project, such as `licenses` folder\n\n### Exceptions\n\nYou may additionally license files that start with `imgui_` under `src/backends/` with `MIT` license while preserving copyright and credit\n\n**NOTE: This is not legal advice, talk to your laywer or other legal representatives if you're uncertain**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnyabsi%2Fsteamvr_overlay_vulkan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnyabsi%2Fsteamvr_overlay_vulkan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnyabsi%2Fsteamvr_overlay_vulkan/lists"}