Unified documentation for the OSVR projects.
JeroMiya Merge pull request #123 from OSVR/moverio
Updated link to moverio server configuration to point to the master branch.
Latest commit 5aa9ce8 Dec 15, 2017

README.md

OSVR Developer Documentation

Introduction to OSVR

Using OSVR

Getting Started

Installing OSVR

Note : It can be used in earlier versions but might require compilation and tweaking.

Running the OSVR Server

Setting the OSVR_SERVER_ROOT environment variable

OSVR server auto-start functionality in ClientKit (Windows only for now) currently relies on the OSVR_SERVER_ROOT environment variable to find the server you would like to have launch. Install the OSVR Runtime, then set the OSVR_SERVER_ROOT environment variable to C:/Program Files/OSVR/Runtime/Server (for 64-bit) or C:/Program Files (x86)/OSVR/Runtime/Server (for 32-bit).

Server parameters

Running the OSVR server just requires passing it a configuration file. For example: osvr_server osvr_server_config.json

if no parameter is specified, a default file is used.

Configuring OSVR

Utilities

Troubleshooting

Developing with OSVR

Game Engines and OSVR

Extending OSVR

Roadmap

Hacking the Hardware

Getting Support

Search

Custom Google Search for the OSVR project

Free support

Paid support

Some companies such as Sensics provide premium support services for OSVR including phone support, system engineering, authoring drivers or integration help. If you require support beyond the free support options, consider contacting the premium providers.

Participate

A list of OSVR developer chat rooms is here

Some existing rooms:

Combined OSVR issue tracker

Map of OSVR projects

Useful Links

Contributed from the OSVR community

For Vive Controller Emulation:

Additional Information

Sample third-party projects that integrate OSVR into them