Skip to content

Commit 4f86844

Browse files
author
davidkline-ms
committed
doc updates re: scene system resources
1 parent 89a7dd7 commit 4f86844

File tree

5 files changed

+41
-0
lines changed

5 files changed

+41
-0
lines changed
7.14 KB
Loading
35.4 KB
Loading
102 KB
Loading

Documentation/Packaging/MRTK_Packages.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ The MRTK Foundation package contains the following.
6969
| | Features | Functionality that builds upon the Foundation package. |
7070
| | Profiles | Default profiles for the Microsoft Mixed Reality Toolkit systems and services. |
7171
| | StandardAssets | Common assets; models, textures, materials, etc. |
72+
| MRTK/SceneSystemResources | | Assets and resources used by the Scene System |
7273
| MRTK/Services | | |
7374
| | [BoundarySystem](../Boundary/BoundarySystemGettingStarted.md) | System implementing VR boundary support. |
7475
| | [CameraSystem](../CameraSystem/CameraSystemOverview.md) | System implementing camera configuration and management. |

Documentation/SceneSystem/SceneSystemGettingStarted.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,46 @@ If your project consists of a single scene, the Scene System probably isn't nece
1010
- You want a simple way to keep track of load operations in progress or a simple way to control scene activation for multiple scenes being loaded at once.
1111
- You want to keep lighting consistent and predictable across all your scenes.
1212

13+
## Scene System Resources
14+
15+
By default, the Scene System utilizes a pair of scene objects (DefaultManagerScene and DefaultLighting scene). If either of these scenes cannot be located,
16+
a message will appear in the Scene System profile inspector.
17+
18+
![Default resources message](../Images/SceneSystem/DefaultResourcesMessage.png)
19+
20+
>![Note]
21+
> If the project is using custom manager and lighting scenes, this message can be safely ignored.
22+
23+
The following sections describe now to resolve this message, based on which method was used to import the Mixed Reality Toolkit.
24+
25+
### Unity Package Manager (UPM)
26+
27+
In the Mixed Reality Toolkit UPM packages, the scene system resources are packaged as a sample. Due to UPM packages being immutable, Unity
28+
is unable to open the necessary scene file unless they are explicitly imported into the project.
29+
30+
To import use the following steps:
31+
32+
- Select **Window** > **Package Manager**
33+
- Select **Mixed Reality Toolkit Foundation**
34+
- Locate **Scene System Resources** in the **Samples** section
35+
36+
![Import scene system resources](../Images/SceneSystem/UpmImportSceneSystemResources.png)
37+
38+
- Select **Import**
39+
40+
41+
### Asset (.unitypackage) files
42+
43+
If the SceneSystemResources folder has been deleted, or was deselected during import, it can be recovered using the following steps:
44+
45+
- Select **Assets** > **Import Package** > **Custom Package**
46+
- Open the **Microsoft.MixedReality.Toolkit.Foundation** package
47+
- Ensure that **SceneSystemResources** and all child options are selected
48+
49+
![Reimport scene system resources](../Images/SceneSystem/ReimportSceneSystemResources.png)
50+
51+
- Select **Import**
52+
1353
## How to use the scene system
1454

1555
- [Scene Types](SceneSystemSceneTypes.md)

0 commit comments

Comments
 (0)