nuclear@0: WHAT SETUP IS REQUIRED?
nuclear@0: 
nuclear@0:   * Appropriate permissions for Oculus hidraw devices. See
nuclear@0:     LibOVR/90-oculus.rules and ConfigureDebian.sh.
nuclear@0:   * Use a multihead setup with one X screen spanning both displays (such as
nuclear@0:     NVidia TwinView) or place the rift on an independent X screen.
nuclear@0:   * Ensure oculusd is running when using the rift.
nuclear@0: 
nuclear@0: BUILD INSTRUCTIONS
nuclear@0: 
nuclear@0:   After installing the appropriate packages issue 'make' in the root of
nuclear@0:   the SDK directory. This will build a release version of Oculus World Demo
nuclear@0:   (OWD). To generate debug symbols use 'make DEBUG=1'.
nuclear@0: 
nuclear@0: HOW DO I RUN OCULUS WORLD DEMO (OWD)?
nuclear@0: 
nuclear@0:   Either run the binary directly from the output directory, or use 'make run'.
nuclear@0: 
nuclear@0: SHOULD I ROTATE MY DEVICE'S SCREEN?
nuclear@0: 
nuclear@0:   Manual screen rotation is not recommended. If your window is fullscreen on a
nuclear@0:   rift device, set the ovrDistortionCap_LinuxDevFullscreen distortion cap to
nuclear@0:   have the SDK automatically rotate the distortion mesh on appropriate devices.
nuclear@0:   Be aware you will have to account for window size. You can use
nuclear@0:   OVR::SDKWindow::findDevScreenForHMD (Displays/OVR_Linux_SDKWindow.h) to
nuclear@0:   return the screen offset and dimensions necessary to size your Linux window.
nuclear@0:   See Samples/CommonSrc/Platform/Linux_Platform.cpp for an example.
nuclear@0: 
nuclear@0: TWINVIEW
nuclear@0: 
nuclear@0:   You must sync to the Rift's display device for a smooth experience when using
nuclear@0:   TwinView. To consistently sync to the rift with TwinView setups, set the
nuclear@0:   __GL_SYNC_DISPLAY_DEVICE environment variable to the appropriate display
nuclear@0:   device before X starts. For example in your /etc/profile you could place the
nuclear@0:   following:
nuclear@0: 
nuclear@0:     export __GL_SYNC_DISPLAY_DEVICE="DFP-1"
nuclear@0: 
nuclear@0:   if your rift corresponds to DFP-1.
nuclear@0: 
nuclear@0: STARTING THE TRACKING SERVICE AUTOMATICALLY
nuclear@0: 
nuclear@0:   Start the tracking service when a user is logged in using Xsession files.
nuclear@0: 
nuclear@0: UBUNTU USERS
nuclear@0: 
nuclear@0:   There was a ubuntu-specific kernel bug which affected HID devices in 14.04.
nuclear@0:   If you are receiving feature report failures try upgrading your distro
nuclear@0:   (dist-upgrade).
nuclear@0: 
nuclear@0: KNOWN ISSUES
nuclear@0: 
nuclear@0:   * OWD vsync initially disabled on Radeon proprietary.
nuclear@0:   * Frame loss on NVidia TwinView setups. Use an independent X screen for an
nuclear@0:     optimal experience.
nuclear@0:   * Mesa DK2 latency tester does not function properly in OWD.
nuclear@0: