MicrosoftDocs / mixed-reality

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

what are the minimal packages needed for MRTK3 preview? #617

Closed wfleming801 closed 1 year ago

wfleming801 commented 2 years ago

I see 13 packages under MRTK3, and I am not sure which ones to load. I want to load the very minimal to follow along the examples. For instance, which package provides the "MRTK3" menu option to appear in step 4-- "Edit Project Settings". Some combinations of packages are giving errors when loading, would be nice to know which packages play well for the preview. Could you add a recommended list of packages to start out with? thanks for your time.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

MaxWang-MS commented 2 years ago

Hi @wfleming801, please refer to the package overview page for information on packages and then select the ones that fit your needs. When importing packages via the Mixed Reality Feature Tool, dependency management is automatically performed so you should not see errors. Please let us know what packages you selected when you saw the errors.

MaxWang-MS commented 2 years ago

We don't really have a recommended set of packages because we are going down the route of modularization and allowing you to choose. The menu item you mentioned is from Core Definitions, but by just importing that package alone there will not be a lot you can do. Most people would want the Input package and likely the UX packages, but again ultimately it depends on your needs.

wfleming801 commented 2 years ago

I chose all. Got errors. Then I Tried a few subsets, got errors. Once I noticed the MRTK3 showed up in the project settings but I had errors, so it's unclear which package provides that text in the settings; I'm just wanting to get started and try out things, frustrating and time consuming to hunt and peck which packages work together to accomplish minimal preview.

wfleming801 commented 2 years ago

I'll add that even reading through the package descriptions, I don't know what I want. I want to be able to build a minimal project, I think it's great that there's modularity, but some guidance on a minimal set of packages would help me get to deployment faster.

MaxWang-MS commented 2 years ago

@wfleming801 Can you let us know what errors you got? Maybe share a screenshot with us if possible.

MaxWang-MS commented 2 years ago

Also can you clarify your definition of "a minimal project"? For example, deploying a scene with a static cube and no interaction needed has different packages requirements then deploying a scene with our ux components and interaction support.

wfleming801 commented 2 years ago

I'm wanting to try out "MRTK3" preview but am failing with selecting which of the 13(under MRTK3 heading) and/or other packages to load using the feature tool. I don't know what is needed; other than one of those packages puts "MRTK3" into the project settings -- would be nice to know which one does this, so that I can complete step 4. However, it would seem in order to go further, I will need additional packages. I don't know what packages are necessary for any of the demos-- even the simplest one of say "sample buttons"? I'd like to deploy the simplest demo, to understand full path from feature selection tool to on device deployment in order to demo 'MRTK3 features'. Seems there's a gap in docs; that kinda drops you off at "here's all our packages, now go play" I'm spending a lot of my "off the clock" time revisiting this and trying to get the packages figured out. Would be nice to have a somewhat guided path to follow. I'll post the errors I've received along with package combinations; but there may be a delay in getting this detail.

MaxWang-MS commented 2 years ago

Hi @wfleming801, on the package overview page there is a table showing which package contains what - for example if you need button prefabs, you should get the UX components package. Additionally if you are trying to deploy to an MR device then you would also need the input package. But by selecting those two (and the MROpenXR plugin as mentioned in the setup doc) you should have all you need (the feature tool will automatically include the dependencies of the packages you selected). I was not able to reproduce the errors you mentioned (I chose all MRTK3 packages and imported them into a new project). Please share the ones you encountered at your earliest convenience so that we can look into it.

cheles commented 2 years ago

@wfleming801 on top of what Max already mentioned, you'll probably need MRTK Input for object manipulation if that's what you want for step 4. Upon dragging MRTKProfile in Profile section, Unity will warn that you are missing some subsystems, and that is MRTK Input image Per package dependency MRTK Input has some dependencies like Core Definitions and Graphics Tools. MR Feature Toolkit will automatically add these upon import.

MaxWang-MS commented 1 year ago

Closing this issue as on the setup page we now provide recommendations for packages first-time users should choose.