Version 0.6

This release corresponds with the OSVR-Core v0.6 update.

Recent changes include retrieving the output of the computational display model (viewport, projection matrices) from the OSVR-Core API, automatic camera rig creation via a DisplayController class, and support for eye tracking.

For a more detailed description of recent changes, see CHANGES.

Upgrade instructions

Projects upgrading to the new version may want to remove the entire OSVRUnity folder before importing the updated package, to ensure any outdated files are removed.

The VRDisplayTracked prefab should be updated. If one exists in your scene and the prefab link has been broken, you will want to replace it with the new prefab. If the prefab link has not been broken, no manual changes should be necessary.

Tested Unity Versions

There have not been any reports of incompatibility with a specific version of Unity, but this release has been tested on the following versions:

• 4.6.1f1
  • Windows 32-bit editor
  • Windows 32-bit and 64-bit built projects
• 4.6.6f2
  • Windows 32-bit editor
  • Windows 32-bit and 64-bit built projects
• 5.0.3f2
  • Windows 64-bit editor
  • Windows 32-bit and 64-bit built projects
• 5.2.1f1
  • Windows 32-bit editor
  • Windows 32-bit and 64-bit built projects

Version 0.2

The Unity plugin now uses the external Managed-OSVR project and assembly, providing improved reliability, development progress, and 64-bit support. Yes, this means you can now use OSVR-Unity with the default Windows version of Unity 5.x (which is 64-bit unless you seek out otherwise).

Automated CI builds will always include the latest successful build of OSVR-Core libraries for 32- and 64-bit Windows, and the latest successful build of Managed-OSVR for .NET 2.0, and can be used on both 32-bit and 64-bit editors and builds.

The files accessible from this "Release Note" are GitHub-generated snapshots of the Git repository, and not directly usable. To download a built version of the package for use or upgrade, please see the OSVR Developer Portal, as always.

Upgrade instructions

Projects upgrading to the new version should remove all copies of ClientKit.dll from their Assets (including subdirectories) before importing the updated package, as the file has been renamed to OSVR.ClientKit.dll to match .NET conventions.

Projects upgrading to the new version may want to also remove the entire OSVRUnity folder before importing the updated package, to ensure any outdated files are removed. A particularly notable case: if you were using a version that had JSON display descriptors, these files are no longer used/included in the Unity plugin (since v0.1.78-ge7ad2a0 at the end of May 2015), so this process will ensure that references to bundled JSON display descriptor files are removed.

Tested Unity Versions

• 4.6.1f1
  • Windows 32-bit editor
  • Windows 32-bit and 64-bit built projects
• 4.6.6f2
  • Windows 32-bit editor
  • Windows 32-bit and 64-bit built projects
• 5.0.0f4
  • Windows 64-bit editor
  • Windows 32-bit and 64-bit built projects
• 5.0.1f1
  • Windows 32-bit editor
  • Windows 32-bit and 64-bit built projects
• 5.0.2f1
  • Windows 32-bit editor
  • Windows 32-bit and 64-bit built projects
• 5.0.3f2
  • Windows 64-bit editor
  • Windows 32-bit and 64-bit built projects

Other changes since v0.1

We doubt anybody is upgrading from that long ago, given the continuous deployment/release philosophy we follow, but just in case, and/or as a highlight reel:

Adapted from CHANGES.md, with superceded changes elided and some clarifications added.

• Displays Folder Removed (31-May-2015) - Unity developers no longer need to assign a JSON display descriptor in the Unity editor. The OSVR server sends the display descriptor to Unity, so switching HMDs requires changing the server config file to use a different display, not recompiling your Unity project.
• DLL Search Path (31-March-2015) - The built executable will now find the plugins it needs in the _Data folder. Previously, the executable had to be in the same directory with Assets/Plugins. That is no longer necessary. (Basically, don't worry about copying DLLs - it should always work correctly on its own, whether you're in the editor or a build.)
• Substantially Reduced Latency - We're now handling OSVR messages more frequently (in more steps of the Unity run loop) so rendering, among other interactions, has much fresher data.
• Unity 5 Support - Automated CI binaries are still built with 4.6.1, but should be seamlessly usable in Unity 5.x as well.
• Distortion Shader - For HMDs that require it, the plugin can turn on a customized distortion shader. This works with Unity 4 Pro or Unity 5. If you're using Unity 4 Free, you might see an error or warning, and there won't be distortion (due to render to texture pass required), but everything else will still work fine.
• Fixed Timestep - was changed from 0.2 to 0.01667. This is how often FixedUpdate() gets called. The change should result in a more comfortable VR experience, but make sure it doesn't break any physics in your game.
• Defaults - Changed the default quality settings. Turned on 4x AA and disabled shadows.
• Display Descriptor Usage - The display descriptor JSON data (now transmitted from the osvr_server based on configuration) is now being parsed and used to set up the cameras automatically.
• Public release under Apache License, Version 2.0

Initial Release

This is the initial functional release of the plugin pre-CES2015, and correspondingly was used in most of those demos, though crucial updates followed.