Text Display SteamVR Overlay

Warning

Work in progress, not ready for use.

Warning

This project is made with Vulkan 1.3+ in mind, thus it couldn't run on pre-2016 GPU like GTX 7xx, even if the GPU is supported by SteamVR.

An OpenVR overlay that displays text sent from other software.

Build

Important

You need Vulkan SDK and a C++ compiler like GCC, Clang, MSVC, etc. to build this project, make sure you have them installed.

Important

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.

Fetch dependencies through scripts/update_third_libs.sh:

scripts/update_third_libs.sh y

Directly build it in Visual Studio or JetBrains Clion with CMake presets. If you prefer to build it in the command line without a preset or an IDE:

cmake -B build
cmake --build build

Run the binary file from the build directory.

Credit

• This project is based on Nyabsi's SteamVR Overlay Example, which is licensed under Mozilla Public License Version 2.0.
• The rest of the project is licensed under Mozilla Public License Version 2.0.
• Libraries and resources that this project depends on:
  • OpenVR is licensed under BSD 3-Clause License.
  • spdlog is licensed under MIT License.
  • ImGui is licensed under MIT License.
  • SDL is licensed under zlib License.
  • glm is licensed under The Happy Bunny License or MIT License.
  • Noto Sans font family is licensed under SIL Open Font License, Version 1.1.