Balderick/OSVR-Docs-base

Unified documentation for the OSVR projects.

OSVR Developer Documentation

Introduction to OSVR

• Introduction to OSVR
• OSVR feature list
  • Notes on Android support
  • Notes on Linux support
  • Notes on OSX support
• List of supported devices, engines and operating systems
• List of OSVR partners
• OSVR presentations and speaker notes

Using OSVR

Getting Started

• HDK Unboxing and Getting Started
• HDK Unboxing and Getting Started (SPANISH)

Installing OSVR

• Windows
  • Minimum recommended version : Windows Vista SP1 or later
  • Download pre-compiled binaries and drivers
  • Install and test RenderManager
• Linux
  • Minimum recommended version : Debian Jessie or equivalent ( Ubuntu 15.04+ for example )
  • Very generic instructions
• Android
• OS X
  • Minimum recommended version : El Capitan

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

• Using the OSVR-Config utility
• Calibrating the video-based tracker
• Local and distributed client/server configurations
• Device-specific configuration
  • OSVR HDK
  • HTC Vive
  • Oculus Rift
• Integrating with VRPN devices

Utilities

• Bundled with OSVR-Core binary snapshots/included in the OSVR-Core source tree:
  • osvr_reset_yaw (e.g. "recenter")
  • osvr_print_tree
  • PathTreeExport
  • osvr_list_usbserial
• TrackerViewer
  • Additional Tracker Viewer documentation
• OSVR Control
• Updating HDK Firmware from Linux
• Distortionizer helps measure distortion parameters for HMDs
• Latency tester. Open-source Arduino-based latency tester
• OSVR HDK Video Status Tool - Find out what video signal the HDK is receiving.
  • HDK Video Status Tool Windows Binaries - On the Releases page - often a good place to check.

Troubleshooting

• OSVR server
• Render Manager
• Device-specific information
  • See also the HDK video status tool above in Utilities.
• Performance optimization using Event Tracing for Windows

Developing with OSVR

• Setting up the development environment
  • Windows
• Directory of projects
• Doxygen-generated developer documentation of OSVR-Core
• Doxygen-generated internal documentation of OSVR-Core
• Creating an OSVR project
• OSVR interfaces
• Useful resources and tools
• Device-specific information
  • OSVR HDK HID report interface

Integrating with Game Engines

• Unity
  • Tutorial video
  • Unity VR demos are OSVR versions of the standard VR demos that ship with Unity 5.3
  • Palace demo is a Unity demo illustrating how to use the Unity OSVR plugin
  • Unity version of Palace demo including APK and compilation notes
  • Palace demo and other Unity binaries
  • Migrating Oculus Unity apps to OSVR
• Unreal
  • Tutorial Video (Unreal Engine 4.12+)
  • Tutorial video (Unreal Engine 4.11 or building from source)
  • Additional Documentation
• OpenVR/SteamVR
• Blender
• WebVR
• CryEngine
• Monogame: video
• OpenGL

Extending OSVR

• Adding a New HMD
• Adding a new Device
  • Best practices for device descriptor
• Writing an OSVR Plugin
• Writing an OSVR Client
• Porting to a New Operating System

Roadmap

• In September 2015, RoadToVR published an article by Yuval Boger of Sensics about the OSVR roadmap. It is an excellent starting point to understand the OSVR big picture and roadmap. The article can be found here.
• The OSVR Waffle Board contains an overview of issues currently in GitHub issue trackers for all OSVR framework projects.
• Additional development priorities suggested by the core OSVR team can be found here.

Getting Support

Search

Custom Google Search for the OSVR project

Free support

• Post an issue on the OSVR Github projects to be addressed by the OSVR community
• Open a support ticket on the support portal (or email "support at osvr.org") to be addressed by core developers
• Visit the OSVR development chat rooms

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:

• General subjects
• Unity
• Unreal
• SteamVR
• OSVR Core

Combined OSVR issue tracker

Map of OSVR projects

Additional information

• OSVR mailing lists and newsletters
• OSVR marketing Web site
• VR Knowledge Nuggets
  • Tracking
  • Displays
• The VRGuy's blog often covers OSVR-related topics and includes tutorials such as:
  • What is geometric distortion (and why should you care)?
  • Converting diagonal FOV and aspect ratio to horizontal and vertical FOV
  • TV screen size vs. goggle field of view
  • How things work: the dual-elements optics of the OSVR HDK
  • What is binocular overlap and why should you care?
  • What you should know about head trackers
  • An overview of positional tracking technologies for VR

Sample third-party projects that integrate OSVR into them

• OSVR plugin for FreePie