Closed SimonDarksideJ closed 2 years ago
This is by design. The samples are standalone snapshots, including all dependencies. Whereas the main repo must be able to accept a wide range of versions of dependencies, the samples are intended to show a single working configuration. They are not intended to be redundant with the main repo as a source for installing WLT.
By the way, it sounds like the samples included in the main repo might be more what you are looking for. I would especially recommend the WorldLockedPhysicsSample as a general intro, and the SpacePins sample as an introduction to the space pin concept.
They are available through the MR FeatureTool, and compatible with a wide range of Unity and MRTK versions.
The sample I'm having issue with is the ASA sample, simply downloading it causes several errors and is not deployable:
P.S. it's fine saying this method is "by design" but then the samples documentation should reflect this in its writing, as all a user has to go on is the "setup guides for WLT" and a one line paragraph in the sample itself.
The instructions for cloning and running the projects as is, including any additional steps to import external assets should be included. In other words, someone trying to use the sample shouldn't have to go looking elsewhere to get the sample running.
P.S. Samples need updating and aligning with the main WLT repo.
https://microsoft.github.io/MixedReality-WorldLockingTools-Samples/Advanced/ASA/ASA.html
I would actually recommend the ASA sample from the main repo. However note that there are extra steps there, since WLT obviously can't ship with every package that every sample might use. All of the steps called out in the documentation are required unless explicitly labeled optional.
Taking in to account your notes above, I followed the instructions step by step, except it fails when you need to install the frozen engine, as the project has script errors due to the frozen engine not being available you are unable to install and actually use the "NuGet for Unity" because the scipts cannot compile because the Frozen Engine is missing. Hence you cannot then use NuGet for Unity to install the Frozen engine.
A Catch 22
NuGet for Unity is deprecated since Unity 2020. Use the manual install instructions. https://microsoft.github.io/MixedReality-WorldLockingTools-Unity/DocGen/Documentation/HowTos/InitialSetup.html#manual-frozen-world-engine-dll-installation
Again, then the docs and instructions should reflect this so a reader has a clear indication for how to get the sample up and running (sorry if that sounds passive-aggressive, it's not meant to), it's just trying to find a clear point to help improve the docs.
This method is simply adding unnecessary friction to get users up and running, surely as the Frozen Engine is also available through the Mixed Reality Feature tool, would it not be easier to provide it that way to avoid confusion?
In attempting to clone and setup the samples to run on device, the current samples repo has several issues:
In short, the samples need a serious update and upgrade to the latest versions / patterns.