Use the XRAn umbrella term encompassing Virtual Reality (VR), Augmented Reality (AR) and Mixed Reality (MR) applications. Devices supporting these forms of interactive applications can be referred to as XR devices. More info
See in Glossary Plug-inA set of code created outside of Unity that creates functionality in Unity. There are two kinds of plug-ins you can use in Unity: Managed plug-ins (managed .NET assemblies created with tools like Visual Studio) and Native plug-ins (platform-specific native code libraries). More info
See in Glossary Management settings to configure XR support in a Unity project.
These settings let you choose which platforms and devices the project can target. After you have enabled an XR plug-in, you can find settings for that plug-in in its own section underneath XR Plug-in Management.
The XR Plug-in Management section of the Project Settings
The XR Plug-in Management settings:
Label | Setting | Purpose |
---|---|---|
Build target tabs | A tab is shown for each platform build target installed for the current Unity Editor. You can add additional platform support modules with the Unity Hub. | |
Initialize XR on Startup | Whether the game or application should start in XR mode immediately. If disabled, then your application logic is responsible for initializing XR at the appropriate time. For example, your app could start with a normal desktop display and then switch to XR on demand. Refer to Load XR plug-ins for more information. | |
Plug-in Providers | The list of known XR provider plug-ins. This list contains the plug-ins officially supported by Unity or its strategic partners as well as any third-party provider plug-ins you have installed with the Package Manager. When you enable a provider plug-in, Unity adds the associated package to the project if it is not already installed. Disabling a plug-in does not remove the package. (You can remove packages with the Package Manager.) |
|
Provider plug-in settings | The settings for each installed XR provider plug-in appear in their own pages within the XR Plug-in Management section. For information about the available settings for a specific plug-in refer to that plug-in’s documentation. You can find a list of plug-ins and links to their documentation in Provider plug-ins. | |
Project Validation | Displays the results of project validation checks for the plug-ins you have enabled. To view the checks, select the Project Validation page inside the XR Plug-in Management section of your Project Settings. | |
XR Simulation settings | The AR Foundation package provides an XR Simulation feature, which lets you test AR Scenes in the Unity Editor. Visit XR Simulation project settings for a description of these settings and options. |
The project validation system helps you avoid common scene and project configuration issues for the XR packages you have installed. The XR packages you have installed can include rules for the validation system. The system evaluates these rules when you make a build and whenever you have the Project Validation window open. To open the window, go to your project settings (menu: Edit > Project Settings) and then select Project Validation in the XR Plug-in Management section. The rules are checked per platform build target. Some rules may examine the current scene to verify that the project settings support features used in that scene.
The Project Validation section of the XR Plug-in Management settings
Property | Description |
---|---|
Platform tabs | The validation checks for each platform are grouped by platform. You can select a platform tab to view the validation checks for that platform. |
Issue list | The list of issues found in the project when evaluating the rules. Each issue has a severity level, description, and action button. |
Show all | Select to show all issues, regardless of severity. Issues marked with a green check indicate validation checks that passed and do not require any action. Successful checks are only displayed when you enable Show all. |
Ignore build errors | Select to ignore build errors. This option can sometimes be useful when debugging build problems. |
Fix all | Click to correct all issues that have a fix available. |
Tip: If the issue has sceneA Scene contains the environments and menus of your game. Think of each unique Scene file as a unique level. In each Scene, you place your environments, obstacles, and decorations, essentially designing and building your game in pieces. More info
See in Glossary objects associated with it, you can click on the message to select or highlight these objects in the Unity Editor.
The status icons to the left of an individual validation issue indicate the status and severity of the issue.
Status | info |
---|---|
Validation passed because the project and scene are either set up correctly, or the rule is not applicable. Successful checks are hidden in the project validation issue list unless you enable the Show all option. | |
Validation failed, but does not block building the project. You can safely ignore these if you have set up your project differently than recommended. | |
Validation failed and will block building the project. These issues cannot be ignored. You must fix them in order to build the project. |
The Fix button automatically fixes the issue in your project or Scene. The Edit button takes you to the appropriate place in the Unity Editor where you can correct the issue in your project. Both the Fix and Edit buttons provide a tooltip explaining the steps to manually correct the issue.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.