All notable changes to this package will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
- Fixed compile errors on Unity versions [2023.1.0f1 - 2023.2.6f1] caused by missing
BuildTargetGroup.VisionOSenum value.
- Added Android manifest support for applications that use Game Activity entry point. Note that Game Activities are only supported in projects made with Unity versions 2023.1 onwards.
- Added Apple visionOS XR provider to the list of known packages.
- Created
AndroidManifestProcessoras an Android manifest management system for XR packages and providers that target platforms based on Android.
- AndroidManifest.xml is no longer deleted after each Android build.
- Settings and Loader names with numbers will now keep the numbers for the generated asset names.
- Incompatibility with
com.unity.testframework.graphics
- Clean up AndroidManifest.xml every XR build to prevent conflicts with other configurations.
- Remove a spurious error when no XR providers were selected
- Removed dependency on
com.unity.subsystemregistrationpackage for supported editors (2022.2+)
- Related Bug: FB 1378643.
Fixed an issue where packages that contained XRGeneralSettingsPerBuildTarget assets could potentially fail to reimport.
- Fixed an issue where
m_RegisteredLoaderslist would not get populated onAwakeat runtime in a built player.
- Updated documentation with new sections
Manual Lifecycle Handling,Initializing a Specific Loader,Changing the Loader List, and add examples for the new documentation sections.
- Resolve FB 1378643 by enforcing creation of
XRGeneralSettingsPerBuildTargetusing a new APIXRGeneralSettingsPerBuildTarget.GetOrCreate()
- Resolve FB 1369638 by adding five new APIs to
XRGeneralSettingsPerBuildTargetfor scripting settings checking and creation :HasSettingsForBuildTargetCreateDefaultSettingsForBuildTargetHasManagerSettingsForBuildTargetCreateDefaultManagerSettingsForBuildTargetManagerSettingsForBuildTarget
- Resolve FB 1346567 by updating docs around initialization timing, especially around manual initialization.
- Ensure cached package setting editors are destroyed when the management window is closed.
- Fix 1348587 and 1357482 by changing the package initialization to be loaded ondemand instead of loading on static initialization.
- Messaging and removing the Lumin platform in 2021.1+. Support is still maintained for Unity 2020 LTS and 2019 LTS.
- Fix 1343655 by adding an API for getting all package metadata so that users can use the correct information when dealing with package metadata store.
- More public API changes for 1343655.
- Fix 1343655 by adding an API for getting all package metadata so that users can use the correct information when dealing with package metadata store.
- Fixed an issue where object from deleted asset got reused, when upgrading setting asset
- Fixed an issue where the ProjectSettings folder may not have been created prior to Initialization of settings.
Initial test release to Candidates
- Fix issue where XR was not being started when entering play mode if the settings UI was never displayed.
- Fixed an issue where custom XR packages would not get registered when running the Unity Editor using the -batchmode argument.
- Added additional documentation explaining that manual XR Initialization should only be called from Start or later as calling it from Awake or OnEnable can cause issues if graphics initialization hasn't finished yet.
- Fix issue with changelog.
- Fix issue with analytics on some platforms.
- Minor fix to deprecation messaging for Windows Mixed Reality.
- When using
XRLoaderHelper, Subsystems are now correctly removed from the cached subsystems map once they are destroyed. - Fixed an issue where a
NullReferenceExceptioncould be thrown if a Package Manager query failed but returned completed when updating known packages. - Fixed an issue where
Plug-in Provideruser interface documentation link redirected to an old version of the documentation. - Fixed an issue where
TryAddLoadercould ignore the safety checks when modifying the registered loaders in the editor during playmode. - Fixed an issue where
TryRemoveLoadercould remove a registered loader even if the loader is still in the list ofcurrentLoaders.
- Add
Open XRto the list of known plug-in providers when on Unity version 2020.3 and above. - Added additional safety checks to the behaviour of
TryAddLoaderandTryRemoveLoaderin the editor. Both now userEditorApplication.isPlayinginstead ofApplication.IsPlayingwhen determining whether the editor is in play mode.
- Changed
activeLoadersto instead of returning a shallow copy, it will now just return a read only list to prevent additional garbage collection. - Changed the behavior of
TryRemoveLoaderto returntrueif the loader is no longer present in the list even if it wasn't present to begin with.
- Added API for surfacing package information notification icons in the XR Plug-in Management editor window.
- Fix issue that enabled users to ask for loaders to be assigned/removed during Play mode.
- Update dependency on
com.unity.xr.legacyinputhelpersto version2.1.7. - Fix issue where the internal list of loaders could modified at runtime in an invalid way. Now, the list of loaders returns a shallow copy of the list at runtime and any modifications using the new
TryAddLoader,TryRemoveLoader, andTrySetLoadersmethods will be validated to ensure the incoming modifications are legal modifications for the internal loader list before applying them. - Fix issue where
XRGeneralSettingswould be included in a build when it held no loaders. - Fix issue involving attempts to modify the loader list while in play mode. That should no longer be actionable and should report an error on attempt.
- Fix documentation validation issues.
- Update Legacy Input Helpers dependency.
- Package pre-release for OpenXR.
- OpenXR specific UI prototype work
- Change how startup settings are written on build.
- Fix issue with domain reload during play that caused a crash on next play.
- Immediately persist created assets when initializing packages.
- CI changes to expand testing.
- Fix issue that was causing the UI to gray out with the "Querying Package Manager for currently installed packages..." message.
- Add documentation to clarify the differences and requirements around plug-in packages and Unity packages.
- Clarify some issues around loader and initialization.
- Fix issue with file being included in built package that shouldn't be there.
- Document link underlining is correct.
- Fix an issue where, after Play In Editor completed, settings were reset to default.
- Clear subsystem instance map on de-initialize so that stale instances aren't being retrieved on restarts.
- Fix and issue where invalid package IDs were not being handled when attempting package installs.
- Package installation is only for verified packages now.
- Removed progress dialogs and reduced the number of blocking API calls required over lifetime.
- Fix stacking calls to Client.List that was causing incorrect error reporting about API timeout.
- Auto create settings for plug in packages if missing.
- Fix testing definitions to allows us to remove tests as separate packages.
- Documentation updates for clarity and correctness.
- Block use of deprecated APIs on 2020.2 and later.
- Fix FB 1242581 : Fix a number of issue around cache rebuilding and persistent UI display of cache rebuilding even though nothing was happening.
- Fix FB 1245181 : Fix null deref access of settings manager instance.
- Release 3.2.10
- Fix Unity Frame Debugger by not stopping loaders on Pause / Stop.
- Don't stop loaders when XRGeneralSettings is disabled.
- Fix UI issue where third party providers would sometimes disappear from the provider selection UI.
- Fix Linux tests in CI.
- Fix double click to un-toggle Magic Leap bug.
- Fix name of Magic Leap Zero Iteration entry for standalone.
- Fix issue where the wrong time value was being used to test for a timeout.
- Add log message to clarify the error when dealing with the un-bundled AR packages.
- Fixes LIH version
- Fixes linked LIH documentation version
- Add documentation related to re-ordering loaders.
- Pick up updated Legacy Input Handlers.
- Re-enable Mac automation testing
- Add force removal of legacy LIH package to deal with package management resolution issue.
- CI issues causing an update to LIH, which mean we need to spin an update for that as well.
- Release of new management workflow.
- Disable legacy vr if we install XR Management. This doesn't lock the UI out but it at least keeps it from being activated at the same time as XR.
- Stop nagging users to uninstall if not a plugin is unassigned. Instead just add text to the above the fold copy to point out users need to use Pack Man UI instead.
- Cleanup of the uninstaller code. Will eventually do the same thing for the package metadata code as well.
- Add utility for requesting uninstall of the currently installed built in VR packages.
- Add callbacks to XRLoaderHelper to allow clients to handle assignment/unassigment of their loader to a build target in the Editor.
- Make documentation link color differentiate between Personal and Professional editor themes.
- More UI tweaks
- Fix state management for queue processing.
- Add ability for users to remove plug-ins that are no longer actively referenced.
- Add documentation link to management pane in Player Settings.
- Further Documentation review changes.
- Fix bug allowing user to enable/disable loaders at play time.
- Fix bug with compilation errors causing progress bar to hang around.
- Modify metadata store to hold packages and not just metadatas. This allows us to call the settings instance initializer function even after initialization.
- Fixed some minor known package naming issues.
- Add in Mock HMD package to known packages.
- Fix up some asynchronous issues with checking for installable packages.
- Change UI a little to try to differentiate installable from installed packages.
- Correct documentation after review.
- Modify sorted list to make Mock HMD last item always.
- Modify assignment to make sure that the order of the items is always the same order as in the UI.
- Entire re-write of the UI and backing data store to provide a better user experience more inline with the previous Built In XR Settings UI.
- Removed the Legacy Input Helpers sub pane and replaced with a more integrated set of menu options in the Assets menu (provided by the Legacy Input Helpers package).
- Preparation for verification release.
- Fix FB 1206103: Serialized loader list is not saved correctly when a new loader asset is created as part of the add operation.
- Fix package checking system to also look at installed packages and not just remotely registered packages. This allows us to see packages the user has locally installed on disk that may not be registered in the package registry.
- Add check to make sure we pick up any class in the project that derives from XRLoader and not just those in packages. This allows a developer to create a loader in their assets folder and use that regardless of installed packages.
- Fixes an issue where subsystems could not be initialized before awake in the editor
- Fixes an issue where subsystems were not re-started after a pause in the editor
- Re-add build target filtering into management.
- Documentation copy review and edit.
- Adds generic gfx capabilities method to XRLoader class
- Fix package validation errors.
- Release for verification.
- Release for verification.
- Remove build target filtering support. Will be added back into 3.1.0.
- Correct Samples code to make sure that it compiles correctly.
- Make some documentation fixes for inline code.
- Replace XR SDK text with just XR or other appropriate messaging.
- New attribute was incorrectly placed into Runtime instead of Editor. Moved to Editor where it belongs.
- UI rework to provide for simpler installation and management of XR Plug-in Providers.
- Reworked the underlying data handling and maintenance to be more streamlines and less coupled.
- Release package for verification.
- Update minimum compatible Editor version to 2019.3.0b9
- Fixes an issue where subsystems could not be initialized before awake in the editor
- Fixes an issue where subsystems were not re-started after a pause in the editor
- Removes dialog boxes for creating Loaders and initializing settings.
- Modifies wording of LIH inclusion page from "required" to recommended.
- Public API InitializeLoaderAsync was erroneously made internal. Move back to being publicly accessible.
- Fix editor application perf issue due to not unhooking update callback.
- Fix package dependency version for subsystem registration package.
- Release package for verification.
- Update to reflect changes in downstream subsystem definitions in 19.3+.
- Change legacy input helpers version to 1.*
- Fix documentation validation errors.
- Allow 3.x to work with Unity 2019.2.
- This package will not work with 2019.3a1 - a11.
- Remove asset menu creation entry for XR Settings as it is unsupported now.
- Fix an issue with downloading packages that could allow PackMan to get corrupted, forcing the user to reload Unity.
- Update base Unity release version after namespace changes.
- Update docs to add more information around correct usage.
- add useful names to sub objects of general settings.
- Add Magic Leap to curated packages list.
- Pick up 2019.2 preview changes that are applicable to 2019.3.
- Fix up the code after Experimental namespace change.
- Update package to support 2019.3+ only.
- Update package to support 2019.3+ only.
- Rev version to almost 3. This is to make space for 2019.2 preview versions and in acknowledgement of the breaking changes that will happen soon.
- Tie version to 2019.2 exclusively for preview.
- Strip document revision history.
- Remove third party notice as unneeded.
- Add promotion pipeline yaml file to get promotion to production working again.
- Revert Legacy Input Helpers dependency to newly pushed 1.3.2 production version.
- Downgrade Legacy Input Helpers dependency to correct production version.
- Downgrade Legacy Input Helpers dependency to help get package to production.
- Fix package name and description.
- Minor corrections in samples header file.
- Remove Windows from log message.
- Remove tutorial UI and unsupported data.
- Fix issue where no settings object would cause an error to be logged at build time incorrectly.
- Add helper method to get XRGeneralSettings instance for a specific build target.
- Move PR template to correct location.
- Fix the readme help page to only appear once on initial add of package.
- Fix up test namespaces to use correct namespace naming
- updating number for Yamato, adds dependency to com.unity.xr.legacyinputhelpers
- Fix more output logging for Yamato.
- Add support for Yamato
- Fix unit tests broken with streamlined workflow changes.
- Add ability for users to disable auto initialize at start. This should allow for hybrid applications that want to start in non-XR mode and manually switch.
- Fix play mode initialization so that we can guarantee that XR has been initialized (or at least attempted initialization) by the time the Start method is called on MonoBehaviours.
- Documentation updated to cover the above.
- Fixed a bug in the new Readme script code that caused a crash in headless mode. Seems the code was launching an Editor window and causing UIElements to crash on an attempt to repaint. We have a workaround to make sure we don't load the window if in headless mode and a bug is filed with the responsible team to correct the crash.
- Fix package validation console errors.
- Fix package validation compilation errors.
- Remove .github folder from npm packaging.
- Streamlining of the management system. Move XR Manager to a singleton instance on XRGeneralSettings that is populated by an XRManagerSettings instance that the user can switch in and out. NOTE: This removes the ability to use XRManagement for per scene situations. For hybrid or manual scenes the user will be responsible for instantiating/loading the XRManagerSettings instance they want and dealing with lifecycle themselves.
- Fix up package repo information for rel mgmt.
- Split documentation into separate audience files for End Users and Providers.
- Update package target Unity version to Unity 2019.1.
- Fix an issue with with an NRE in the build processor.
- Add missing repo url to package json file
- Fix NRE issue in build processor
- Fix error in general build processor due to a potential null deref.
- Fix missing check for unity version when referencing UIElements.
- Fix package validation issues.
- Fix bug due to preinit code that would cause a null ref exception.
- Updated to support loading integrated and standalone subsystems.
- Add support for pre-init framework to allow for setting handling things like LUID setup pre-gfx setup.
- Add ability for general settings to be set per platform and not just globally.
- Tagged with release preview build. This should be the base on which we move to release for 2019.1
- Fixed some issues with boot time and general setting.
- Fix an API breaking change to UnifiedSettings api
- Fix a NRE in XRGeneralSettings if the user has set an XRManager Component on a scene game object and didn't setup general settings.
- Hopefully all CI issues are resolved now.
- Merged in general settings support. Initial implementation allows for ability to assign an XR Manager instance for loading XR SDK at boot launch time.
- Merged in Unified Settings dependent changes.
- Add missing .npmignore file
- Updated UI for XR Manager to allow for adding, removing and reordering loaders. No more need for CreateAssetMenu attributes on loaders.
- Updated code to match formatting and code standards.
- Fix issue #3: Add ASMDEFs for sample code to get it to compile. No longer need to keep copy in project.
- Fix Issue #4: Update documentation to reflect API changes and to expand information and API documentation.
- Fix Issue #5: Move boilerplate loader code to a common helper base class that can be used if an implementer wants to.
Since we are 2018.3 and later only we can take advantage of the new PlayerSettings Preloaded Assets API. This API allows us to stash assets in PLayerSettings that are preloaded at runtime. Now, instead of figuring out where to write a file for which build target we just use the standard Unity engine and code access to get the settings we need when we need them.
This change adds a full fledged sample base that shows how to work with XR Management from start to finish, across run and build. This includes serializing and de-serializing the settings.
Changed XRBuildData from a class to an attribute. This allows providers to use simpler SO classes for build data and not foreach them to subclass anything. Added a SettingsProvider subclass that wraps each of these attribute tagged classes. We use the display name from the attribute to populate the path in Unified Settings. The key in the attribute is used to store a single instance of the build settings SO in EditorBuildSettings as a single point to manage the instance. Added code to auto create the first SO settings instance using a file panel since the Editor build settings container requires stored instances be backed in the Asset DB. There is no UI for creating the settings (unless added by the Provider) so this should allow us to maintain the singleton settings. Even if a user duplicates the settings instance, since it won't be in the Editor build settings container we won't honor it.