Author XR in XR - Initial public release was on December 15, 2016 via blogpost
It’s important to note that EditorXR is an experimental feature. As such, there is no formal support (e.g. FogBugz, firstname.lastname@example.org, Premium Support, etc.) offered, so please do not use these channels. Instead, take your questions, suggestions, comments to our dedicated forum.
To help ensure you have a good experience, and to help us answer your questions (hey, we’re a small team!), we encourage you to try it out first with a small VR-ready scene. Please use life-sized objects, nothing too big or small. Dive in and have fun just playing around, instead of trying to use your existing project.
As with any experimental/preview/alpha/beta build, it is always a good idea to make a backup of your project before using the build.
Experimental means this:
- We're still adding features!
- The current menus, tools, workspaces, actions, etc. are not the end-all-be-all. Each of these have individual designs that will change as we experiment with what works best for UX. EditorXR was designed in such a way that we plan on you being able to replace all of these defaults, too, if you so desire.
- Namespaces, classes, software architecture, prefabs, etc. can change at any point. If you are writing your own tools, then you might need to update them as these things change.
- There won’t always be an upgrade path from one release to the next, so you might need to fix things manually, which leads to the next point...
- Stuff can and will break (!)
- There’s no guarantee that this project will move out of experimental status within any specific timeframe.
- As such, there is no guarantee that this will remain an actively supported project.
If you've made it here, but aren't accustomed to using GitHub, cloning repositories, etc. and are simply looking to give EditorXR a spin, then take a look at the Getting Started Guide. Once you're up and running we recommend you join the discussion on the EditorXR forum.
For Software Developers
If you're a developer, we recommend that you take a look at the Getting Started Guide and the companion document Extending EditorXR. You'll need to clone the repository into an existing project using the instructions below.
Project Package Dependencies
- Create a new Unity project or use an existing one
- From the command line change directory to your project's
git lfs clone --recursive -b development https://github.com/Unity-Technologies/EditorXR(Use HTTPS!)
Because this project uses git-submodule, you'll need to execute
git submodule update after pulling whenever a submodule is updated. You could execute this command always just to be safe or if you notice that a submodule is showing as modified after pulling changes.
Optionally, you could add a git hook for post-checkout or use a GUI (e.g. SourceTree) that does this automatically for you.
If you plan on making changes to EditorXR and/or contributing back, then you'll need to set the
Asset Serialization property under Edit->Project Settings->Editor to
In order to support a variety of platform configurations, and to optionally strip its code out of player builds, EditorXR uses assembly definitions. Some of EditorXR's dependencies do not include assembly definitions in their current forms, so after importing EditorXR (in Unity 2018.4), you must add them.
For easy set-up when cloning the repository, EditorXR includes two
.unitypackage files (
Patches/SpatialTracking_2018.4.unitypackage) containing assembly definitions for the Google Poly Toolkit and UnityEngine.SpatialTracking, which are referenced by EditorXR. Simply import them via Assets > Import Package > Custom Package...
- For all Unity versions: import the
PolyToolkit_asmdefpackage to add assembly definitions to the PolyToolkit folder if you wish to integrate the PolyToolkit from the Asset Store
- For Unity 2018.4: Import both the
SpatialTracking_2018.4packages to fix compile errors that occur due to missing package dependencies
If you are using the release package, you will need to delete the
UnityEngine.SpatialTracking assembly definition to prevent it from conflicting with the assembly definiton from the
Legacy Input Helpers package, which will be automatically imported when you import EditorXR.
By making a pull request, you are confirming agreement to the terms and conditions of the UCA, including that your Contributions are your original creation and that you have complete right and authority to make your Contributions.