Unity Plugin Releases

Article last updated:

NOTE: Unity 5.4 has removed the OpenGL 2.1 pipeline, and the zSpace Unity Plugin has uncovered a bug in the OpenGL 4.5 pipeline, so it does not work with Unity 5.4. We are working with Unity to resolve the issue, but for now, the zSpace Unity Plugin does not work with Unity 5.4 and above.

With the release of Unity 4.5, Unity no longer requires a patch to use zSpace with Unity. zSpace required changes have been added to the Unity source. zSpace still requires OpenGL and Stereo to be enabled by setting using command line arguments. Please see release notes below.

The following Unity packages are currently available to assist developers:

zCore

Enables stereo with head tracking and provides access to all APIs corresponding to the zSpace Core SDK

Download

zCore downloads can be found on the zSpace developer portal.

 

Install/Update zCore Unity Plugin

Updating from earlier versions:

  • Remove the ZSCore prefab from the Hierarchy and Save Scene.
  • Close Unity and remove the zSpaceUnity.dll and its meta file from the Plugins directory of the Project.
  • Remove the entire zSpace folder from Unity's Project view or from the Assets directory in Windows Explorer.

Installing the plugin:

  • Open Unity Editor, go to Assets/Import Package/Custom Package and find the latest ZSpace 3.2.0 plugin and import it.
  • Drag the ZSCore prefab into the Hierarchy and then drag the Main Camera into ZSCore prefab's Current Camera.
  • Put on glasses, press play in Game window and verify 3D is displayed.

Release Notes:

zCore 4.0.0

Name change from ZSCore to zCore.

Please find the documentation on the zSpace developer portal.

ZSCore 3.2.0

New Features:

  • The ZSCore Unity Plugin now fully supports Unity 4 and Unity 5 in both 32 and 64-bit modes.
  • Added support for automatic transitions between stereo and mono
  • Added support for mouse auto-hide
  • Added support for borderless window mode via new -always-windowed flag
  • Added support for triggering additional L/R sync requests when running on AMD Radeon cards Fixed deprecated ZSCore.GetViewportOffset()
  • Added optimizations to improve tracking latency
  • Updated ZSFinalCamera to use the center eye view and projection matrices

 Known Issues:

  • Unity 4 Editor will not show 3D when you press "Play" button if you have installed Jing (a screen capture application from TechSmith)

ZSCore 3.0.1

  • Supports Unity 4.1.3, 4.3, or 4.5 and above.
  • IMPORTANT: The previous command line arguments to use stereo have been updated. To enable stereo you must now use: -force-opengl -enable-stereoscopic3d. These flags must be used to launch the Unity editor as well as the your zSpace enabled application.
  • ZSCore is now being identified by using an independent from Unity version number. The version number will be based on the version of zSpace SDK the ZSCore is based on.
  • Migrating from a previous version of ZSCore to version 3.0.1 will require a migration. Please see our migration guide.
  • The coordinate spaces used by the zSpace for Unity SDK has changed. Please refer to zSpace Coordinate Systems for additional details about changes to the coordinate spaces.
  • Added additional support for AMD Radeon cards. zSpace now supports a AMD Radeon graphics cards which support OpenGL and Quad Buffer Stereo. Note, AMD only supports OpenGL in full screen mode only.

Unity Patch 4.3.0

  • IMPORTANT: The -enable-stereo flag when running Unity applications has been changed to -enablestereoscopic3d
  • Introducing support for Windows 8.
  • To use Stereo 3D and OpenGL, run Unity.bat (included in zip with zSpace Unity patch) instead of directly calling Unity.exe. You can create a shortcut on the start menu and even associate ".unity" files with it in Windows. The .bat file simply calls Unity.exe with the -force-opengl and -enablestereoscopic3d, which are required for zSpace Stereo.
  • When you build your applications, the shortcuts to launch your applications will also need to include -force-opengl and -enablestereoscopic3d to properly use OpenGL and Stereo.
  • Unity no longer requires being installed in the default location but when installing the zSpace Unity patch, you must select the Unity installation location for the patch to be installed correctly.

Unity patch 4.1.3

  • To use Stereo 3D and OpenGL, run Unity.bat (included in zip with zSpace Unity patch) instead of directly calling Unity.exe. You can create a shortcut on the start menu and even associate ".unity" files with it in Windows. The .bat file simply calls Unity.exe with the -force-opengl and -enable-stereo options, which are required for zSpace Stereo.
  • When you build your applications, the shortcuts to launch your applications will also need to include -force-opengl and -enable-stereo options to properly use OpenGL and Stereo.
  • Unity no longer requires being installed in the default location but when installing the zSpace Unity patch, you must select the Unity installation location for the patch to be installed correctly.

 

Archived releases

ZSCore

Download

zSpace ZSCore 3.2.0 - Enables stereo with head tracking and provides access to all APIs corresponding to the zSpace Core SDK. Only supported in Unity 4.

zSpace ZSCore 3.0.1 Unity Package - Enables stereo with head tracking and provides access to all APIs corresponding to the zSpace Core SDK.

Documentation

ZSCore 3.0.1 documentation offline version

ZSCore 3.0.1 migration guide

zSpace Unity patch

Depending on the version of Unity you are using, one of the following files are required to run Unity. Note, Unity 4.5 and beyond does not require a patch.

zSpace Unity Patch for 4.3.0

zSpace Unity Patch for 4.1.3

For previous versions please contact zSpace Support.

For Unity 4.1.3 and 4.3.0

All Unity 3.5.x links have been removed. Please contact zSpace Support for access.

zSpace ZSCore Unity Package for Unity 4.1.3 - Enables stereo with head tracking and provides access to all APIs corresponding to the zSpace Core SDK. Includes the ZSCoreTest.

zSpace ZSUtility Unity Package for Unity 4.1.3 - Enable stylus tracking and manipulation. Be sure to set your .Net optimization to .NET 2.0 (Not the subset).

For Unity 3.5.x

All Unity 3.5.x links have been removed. Please contact zSpace Support for access.

zSpace ZSCore Unity Package for Unity 3.5.x - Enables stereo with head tracking and provides access to all APIs corresponding to the zSpace Core SDK.

zSpace ZSUtility Unity Package for Unity 3.5.x - Enable stylus tracking and manipulation.

zSpace ZSCoreTest for Unity 3.5.x - Diagnostic tool to test every API of the ZSCore prefab. Allows user to adjust various stereo parameters dynamically in the ZSCore. Next release this will be integrated into ZSUtilty.

Documentation:

Installable versionUnity for zSpace Documentation for Unity 4.3

Was this article helpful?
8 out of 8 found this helpful
Have more questions? Submit a request

Comments

  • Avatar
    Keith Payne

    the zSpace ZSCoreTest 2.7.0 link is broken

  • Avatar
    James Reeves

    Thank you - Link has been fixed.

  • Avatar
    Scott Almes

    Is there a future for the free version of unity? Or will you only support unity pro?

  • Avatar
    Asmo Jussila

    can we get a patch for unity 4 please?

  • Avatar
    James Reeves

    Hi Asmo - A unity 4.0 Patch is in QA and should be released in a few days.

  • Avatar
    Rahul Gupta

    Great News.

  • Avatar
    Rahul Gupta

    finally it is out for 4.0.

    If you do not mind Mr. James, may I ask why unity did not included this patch inside their regular build?

  • Avatar
    James Reeves

    Hi Rahul - We are working with Unity to incorporate the patch directly into their future builds.

    James

  • Avatar
    Rahul Gupta

    Hope to have it inbuilt soon :)

  • Avatar
    Rahul Gupta

    is there a zSpace solution for MAC?

  • Avatar
    James Reeves

    Hi Rahul - No, sorry we dont have a solution for Mac at this time.

    James

  • Avatar
    Rahul Gupta

    Hi is the unity 4.0 version is still in beta? I have crashing issues again. Any idea when the final release will come out?

    Rahul

  • Avatar
    Rahul Gupta

    "Please note, zSpace System Installer 2.8.0 or greater is required for using Unity 4.0.1."

    Do I need to install this on all system wherever I want to check my unity 3d final builds? or I just need it on a system where I work on unity and zSpace?

    Rahul

  • Avatar
    Majid Al-Kader

    Hi,

    Where can I find FreeZx demo folder.

    Thanks

    Skills2Learn

  • Avatar
    Rahul Gupta

       Hi Unity is updated to 4.1.2 and may be in now every 2 month there will be new unity version. How zSpace is going to provide new builds?

    We really need to know this before planning our product development for zSpace platform.

    Rahul

  • Avatar
    Scott Whitacre

    At this moment we have not made a plan to go to Unity 4.1.x. Unity is supposed to be incorporating our code into their source code but that was originally supposed to happen in Unity 3.5.6. It is more them then us limiting this.

  • Avatar
    Eriks Strals

    The ZSCoreTest doesn't seem to be included in the Unity 4.0.1 core package. in the documentation it says it is... Am I missing something?

  • Avatar
    Rahul Gupta

    If you will not go to Unity 4.1.x how will we benefit from the upcoming new features of unity.  Please release the latest build as soon as unity release new version. This will keep all zSpace user in sync with unity 3D. If it is hard for your developer to provide time on this why not go for something like **Open Source project, **so that any good programmer can go ahead with the development. Though I am not that good :-)

    Rahul

     

     

  • Avatar
    Scott Whitacre

    Eriks,

    ZSCoreDiagnostics is not available from the menu bar,  Window -> zSpace -ZSCoreDiagnostic

     

    Rahul,

    We used to use OGRE. The problem we are currently having with Unity is we have to wait for Unity to incorporate our needs into there release (reason we are using zSpace Unity patch). That was supposed to be a while ago, a long while ago. Once they do make the changes then there will be no more waiting. Each time there is a release and they do not include our changes, as they say they are, then it is a slow process of getting the source, making a patch, testing it, updating, and releasing.

  • Avatar
    Rahul Gupta

     

    Hi Scott,

    Is there any specific reason why they do not incorporate your required changes?

    And how much time it takes for your developer to update patch for new release. Like as I said earlier Unity is planning to release every 2 month so can't you manage to release your patch withing 15 days of each release? This way you never need to depend on unity changes you just need to patch the unity files and done. I understand it is not that easy as I am saying, but I am confident that it is not an impossible thing.

    Rahul

  • Avatar
    Scott Whitacre

    It is really nothing like that. In Theory it should only take a few days. That is on Unity and not us. In actuality it takes a month. I have no idea why Unity has not incorporated our changes. They were supposed to 9 months ago.  Again, that is on Unity and not us.

  • Avatar
    Rahul Gupta

     So is there any chance of having updated zSpace plugin for unity , or we should stop thinking about it?

    We use Unity 3D only and can not switch to OGRE, do not have any other option.

    Rahul

     

     

     

     

     

     

     

  • Avatar
    Scott Whitacre

    All, we have been able to update to Unity 4.1.3. The zSpace Unity patch for Unity 4.1.3 and ZSCore.unitypackage have been posted. The ZSUtility and ZSCore documentation will be available shortly.

  • Avatar
    Rahul Gupta

    Again looks like you people have stopped building patch for unity. Unity reach to 4.3 with plenty of new features and many improvements.

    Common people update the patch for 4.3.

    We all want to use zSpace with latest version of Unity3D.

    Rahul

  • Avatar
    James Reeves

    Hi Rahul - Sorry for your frustrations. We are working with Unity to make the patch available. 

  • Avatar
    Rahul Gupta

    Thanks for the very promising update sir James.

    Thanks you very much.

    Rahul

  • Avatar
    Scott Whitacre

    We are pleased to have available a zSpace patch for Unity 4.3.0. Please see release notes for important changes in regards to launching zSpace enabled apps.

  • Avatar
    Rahul Gupta

    When to expect zSpace patch update for unity 4.3.4?

    techdm81

  • Avatar
    Scott Whitacre

    With the release of Unity 4.5, Unity no longer requires a patch before being used with zSpace. Yes, Unity has added our required changes to their source. We have also released an updated version of the ZSCore (3.0.1).