search

MicrosoftDocs / mixed-reality

Mixed Reality documentation
Creative Commons Attribution 4.0 International
173 stars 181 forks source link

[BUG] Following MRTK Documentation for Cloned Examples Results in Unity Crash #766

Closed AMollis closed 5 months ago

AMollis commented 5 months ago

Originally

Describe the bug

I'm following the MRTK3 documentation hub pre-requisites checklists and cloning the main branch (or most recent release branch) of MRTK3 from this repository. I open the project in Unity Hub and attempt to run the scenes provided, but Unity crashes on start.

The template projects setup instructions are vague, instead recommending configuring a new project to use the toolkit. However I would like to drop into a demo environment first.

I would like to incorporate MRTK3 into our current project, but until I've interfaced with some examples and know how it works better, I am hesitant to do so. I would like to use the example scenes for reference which means being able to run the example project.

To reproduce

Steps to reproduce the behavior:

  1. Follow this checklist: https://learn.microsoft.com/en-us/windows/mixed-reality/develop/install-the-tools?tabs=unity
  2. Install the correct version of Unity editor with the support modules for UWP https://learn.microsoft.com/en-us/windows/mixed-reality/mrtk-unity/mrtk3-overview/getting-started/setting-up/setup-dev-env
  3. Check this page, which recommends cloning from a branch which no longer exists: https://learn.microsoft.com/en-us/windows/mixed-reality/mrtk-unity/mrtk3-overview/getting-started/setting-up/setup-template
  4. Instead clone from the main branch of this repo.
  5. Open project in Unity
  6. Switch to UWP Build Target
  7. Open the Empty Demo Scene
  8. Run, Unity Crashes

Expected behavior

  1. Follow this checklist: https://learn.microsoft.com/en-us/windows/mixed-reality/develop/install-the-tools?tabs=unity
  2. Install the correct version of Unity editor with the support modules for UWP https://learn.microsoft.com/en-us/windows/mixed-reality/mrtk-unity/mrtk3-overview/getting-started/setting-up/setup-dev-env
  3. Clone the main or a release tagged MRTK3 source
  4. Open the demo project
  5. Set build target to UWP
  6. Run a demo scene
  7. the demo scene opens with either the MRTK Input Simulator or Holographic Remoting (Hololens2)

Your setup (please complete the following information)

Target platform (please complete the following information)

AMollis commented 5 months ago

If documentation update is needed....using this bug to track this

AMollis commented 5 months ago

Fixed the branches in documentation. Fix in