Skip to content
OpenVR bindings to nodejs
C++ JavaScript Python
Branch: master
Clone or download
Pull request Compare This branch is 40 commits ahead of modulesio:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
samples
src/binding
tests
.gitattributes
.gitignore
.gitmodules
LICENSE
README.md
VROverlay.js
binding.gyp
build-headers.js
headers.js
index.js
math.js
package.json
yarn.lock

README.md

OpenVR for Node.js

This fork is built around overlays; however, there is an ongoing goal to make this the defacto OpenVR for Node.js fork.

Installing

This package is not published to NPM, however will be closer to API completeness. Please use GitHub package imports for now.

yarn add kayteh/node-openvr

# OR

npm i kayteh/node-openvr

Using

See samples/ for working examples and tests used for developing this module.

Overlay

This repo has a helper class for overlays, however you may just use the overlay system directly. This requires passing the overlay handle around, so the class just abstracts over that for you.

const { math: { Vector3 } } = require('node-openvr')
const VROverlay = require('node-openvr/untyped/VROverlay')

Instead of using this helper class, you may also use thr C++ binding directly, see the following links.

You can’t perform that action at this time.