Skip to content

Commit 158993f

Browse files
Andrew Kimfacebook-github-bot
authored andcommitted
docs: Update README
Summary: Update README. Reviewed By: sohailshafiiWk Differential Revision: D76156143 fbshipit-source-id: 50d494a9fff381899b4c56be195d7669d3a675bf
1 parent ef48264 commit 158993f

1 file changed

Lines changed: 7 additions & 10 deletions

File tree

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22
Unity-Movement is a package that uses OpenXR’s tracking layer APIs to expose Body Tracking (BT), Eye Tracking (ET), and Face Tracking (FT) capabilities. With this package, developers can leverage tracking to populate VR environments with custom avatars that bring the expressiveness of users into the virtual environments that they create.
33

44
### License
5-
The Unity-Movement package is released under the [Oculus License](https://github.com/oculus-samples/Unity-Movement/blob/main/LICENSE). The MIT License applies to only certain, clearly marked documents. If an individual file does not indicate which license it is subject to, then the Oculus License applies.
5+
The Unity-Movement package is released under the [Oculus License](https://github.com/oculus-samples/Unity-Movement/blob/main/LICENSE.md). The MIT License applies to only certain, clearly marked documents. If an individual file does not indicate which license it is subject to, then the Oculus License applies.
66

77
### Requirements
88
- Unity 2022.3.15f1 or newer.
9-
- v76.0 or newer of the Meta XR SDK. You will need the [Meta XR Core SDK](https://assetstore.unity.com/packages/tools/integration/meta-xr-core-sdk-269169) and the [Meta XR Interaction SDK](https://assetstore.unity.com/packages/tools/integration/meta-xr-interaction-sdk-265014) packages found [on this page](https://assetstore.unity.com/publishers/25353).
9+
- v77.0 or newer of the Meta XR SDK. You will need the [Meta XR Core SDK](https://assetstore.unity.com/packages/tools/integration/meta-xr-core-sdk-269169) and the [Meta XR Interaction SDK](https://assetstore.unity.com/packages/tools/integration/meta-xr-interaction-sdk-265014) packages found [on this page](https://assetstore.unity.com/publishers/25353).
1010
- A project set up with these [steps](https://developer.oculus.com/documentation/unity/move-overview/#unity-project-setup).
1111

1212
## Getting Started
1313
First, ensure that all of the [requirements](#requirements) are met.
1414

1515
Then, bring this package into the project.
1616
- In Package Manager, click on the add button below the window title and select **Add package from git URL…**, using this URL: https://github.com/oculus-samples/Unity-Movement.git
17-
- To grab a specific version of the package, append the version number with a # to the git URL (i.e. https://github.com/oculus-samples/Unity-Movement.git#1.2.0)
17+
- To grab a specific version of the package, append the version number with a # to the git URL (i.e. https://github.com/oculus-samples/Unity-Movement.git#v74.0.0)
1818
- Alternatively, in package manager, click on the add button below the window title and select **Add package from disk...**, using the package.json located after unzipping one of the releases here: https://github.com/oculus-samples/Unity-Movement/releases
1919

20-
The sample scenes are located under the **Samples/Scenes** folder.
20+
The sample scenes are located under the **Samples~/Scenes** folder. For detailed information, please visit the [related page](https://developers.meta.com/horizon/documentation/unity/move-unity-getting-started).
2121

2222
## Unity Setup
2323

@@ -56,18 +56,14 @@ nearby without experiencing poor quality.
5656
## Samples
5757

5858
The project contains several sample scenes. To test the samples, they must be imported into the project's Assets folder:
59-
- Select the "Meta Movement" package in the package manager. Once selected, expand the Samples section and import the desired sample scenes.
59+
- Select the "Meta XR Movement SDK" package in the package manager. Once selected, expand the Samples section and import the desired sample scenes.
6060
<br>
6161

6262

6363
For more information about body tracking, please refer to [this page](https://developer.oculus.com/documentation/unity/move-body-tracking/).
6464

6565
For more information about the samples, please refer to the [body samples page](https://developers.meta.com/horizon/documentation/unity/body-tracking-samples) and [face samples page](https://developers.meta.com/horizon/documentation/unity/face-tracking-samples).
6666

67-
## Player Settings
68-
69-
Make sure that the color space is set to Linear.
70-
7167
## Build Settings
7268

7369
In order for the SceneSelectMenu buttons to work, add imported scenes in the [Samples](#samples) step to the Build Settings.
@@ -77,4 +73,5 @@ The documentation for this package can be found [here](https://developer.oculus.
7773
The API reference for this package can be found [here](https://oculus-samples.github.io/Unity-Movement/).
7874

7975
## License
80-
Unity-Movement is subject to the [Oculus SDK License Agreement](https://developer.oculus.com/licenses/oculussdk/), as found in the LICENSE file.
76+
Copyright (c) Meta Platforms, Inc. and affiliates. All rights reserved. Your use of this SDK or tool is subject to the Oculus SDK License Agreement, available at https://developer.oculus.com/licenses/oculussdk/
77+
Files from [Unity]{https://unity.com/legal/licenses/unity-companion-license} and [SchemingDeveloper]{https://github.com/oculus-samples/Unity-Movement/blob/main/Runtime/Tracking/ThirdParty/SchemingDeveloper/LICENSE.txt} are licensed under their respective licensing terms.

0 commit comments

Comments
 (0)