kayteh/node-openvr

OpenVR bindings to nodejs

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.

• Direct Binding Example
• Another VROverlay Example

node-openvr's Issues

Usage with NodeJS 14

Hello,

Thank you very much for this repo. I was looking at using this for a personal project but I seem to be running into build errors when trying to build it, which I think are due to using a newer version of node (14).

It would be great if it was possible to use this with later versions of node if possible. If not, what would be needed to go about upgrading it to node 14?

Thank you very much in advance.