Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

node-oculus

floored64Apache-2.01.0.1

A simple node.js addon for interfacing with the Oculus Rift.

oculus, node, vr, floored

readme

node-oculus is a simple node.js addon for interfacing with the Oculus Rift DK2.

Goals: Create a simple node interface to the Oculus Rift. Provide a clean start point from which complex node-based oculus projects can evolve.

Based on: Minimal Oculus Application - node-hmd

Dependencies: node-gyp if not already availible in your distribution.

Installation:

1. npm install node-oculus

Usage:

// 1. Create oculus object:
var oculus = nodeOculus.createOculus();

// 2. Discover sensor:
oculus.discoverSensor();

// 3. Get device info:
var deviceInfo = oculus.getDeviceInfo();

// 4. Poll orientation data:
var quat = oculus.getOrientationQuat();

// 5. Poll positional tracking data:
var transl = oculus.getPositionDeltas();

// 5. Feel responsibility to make something cool:
...

// 6. Cleanup
oculus.destroyResources();

Notes: The Oculus user guide, best practices guide, developer guide, and health and safety warnings can be found here: https://developer.oculus.com/documentation/.