A small C99 library I use across my Steam Frame VR ports. It keeps the common controls and settings consistent, so switching games doesn't mean relearning how to recentre, turn or adjust the camera.

EXPERIMENTAL. This is a support library, not a game or an OpenXR runtime. It has no game-data requirement and no OpenXR, graphics or SDL dependency. The game ports handle their own rendering, controller bindings and file storage.

Prebuilt Steam Frame SDK: Download the ARM64 package from the v0.1.0 prerelease. It includes the compiled library and headers for use in other ports.

What's in it

Short-press and hold timing for View, including recentring and height calibration.
Live camera adjustment with grip + stick, with a neutral-stick check before returning to gameplay.
Camera distance and height offsets, world scale, snap turning and smooth turning.
Room-scale movement and leaning helpers.
Haptic events, strength settings and a shared pulse queue.
Common settings names, ranges and environment overrides.
A consistent performance log with frame rate and CPU/GPU timings.

The standard explains the controls and conventions. Each header documents its own API. Vice City, San Andreas and several other ports use it.

Build and test

Build and test on macOS, Linux (including Frame Desktop), or Windows. This library has no platform SDK requirement. You'll need a C99 compiler and a C++17 compiler for the header checks. The tests run on the build machine and need no headset or game files.

The CMake route works with a C/C++ toolchain and CMake:

git clone https://github.com/astromaddie/sfvr.git
cd sfvr
cmake -S . -B build-cmake
cmake --build build-cmake --config Release
ctest --test-dir build-cmake -C Release --output-on-failure

On Windows, install Visual Studio's Desktop development with C++ workload and run these commands in its developer terminal, or use WSL2 Ubuntu with the Linux toolchain. On Ubuntu, install build-essential and cmake; on macOS, use Xcode Command Line Tools and CMake. On Frame Desktop, use an environment with those build tools available.

With Make installed on macOS or Linux, you can also run the full header checks:

git clone https://github.com/astromaddie/sfvr.git
cd sfvr
make test

make test runs the nine unit suites, compiles the headers individually as C and C++, and checks C++ linkage. make sanitize runs the tests with AddressSanitizer and UndefinedBehaviorSanitizer where supported. The PR0 test record identifies the checked source revision.

Use it in a port

Copy include/ and src/ into your port, add include/ to the compiler's include path, and build the C files with -lm. Include sfvr/sfvr.h for everything, or just the header you need.

Keep a VERSION file with the sfvr commit you copied, and keep the MIT license with it. Port copies can have local changes, so check their version and diff before replacing them. Prefer fixing shared behavior here, then updating the copies.

License

sfvr is my shared port-support code, licensed under MIT. That license covers this library; it doesn't give permission to redistribute any commercial game or its data. The changelog lists library changes.