Skip to content

Commit 2bbd773

Browse files
judubumfe
andauthored
Update doc and changelog about .NET4 requirement (#252)
* Update doc and changelog about .NET4 requirement * Update export doc * Update .NET 4 requirement section * Update USD.md * Last update from PR Co-authored-by: Marie Fetiveau <marief@unity3d.com>
1 parent 4b0682e commit 2bbd773

File tree

2 files changed

+63
-30
lines changed

2 files changed

+63
-30
lines changed

README.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,9 @@ settings under Edit > Project Settings > Quality:
3131
## Requirements
3232

3333
* Windows / OSX
34-
* Unity version: 2018.3 (2018.3.4f1 and up) and 2019.1 (2019.1.0b2 and up)
35-
See ["2017 users" section](#unity-2017-users) if you want to use the plugin in Unity 2017.4
36-
* To build a standalone, Api Compatibility Level needs to be set to .NET 4.x
37-
In Edit > Project Settings > Player :
34+
* Unity version: 2019.4 and up
35+
* API Compatibility Level .NET 4.x is no longer required but still provides better performances than .NET 2
36+
In Edit > Project Settings > Player :
3837
![USD .NET version](Images/USD_.NET_version.png)
3938

4039
## Limitations
@@ -44,17 +43,12 @@ See ["2017 users" section](#unity-2017-users) if you want to use the plugin in U
4443
## Samples
4544

4645
The USD package also includes samples to help you get started.
47-
Please note, the way to get them varies depending on the Unity version you are using. See below.
48-
49-
### Unity 2019.1 and Later
5046

5147
Use Package Manager to import the samples into your Assets folder :
5248

5349
![USD .NET version](Images/USD_samples_import.png)
5450

55-
### Previous versions
5651

57-
Samples package can be downloaded from [Unity film-tv-toolbox repository](https://github.com/Unity-Technologies/film-tv-toolbox/tree/master/UsdSamples).
5852

5953
# Features
6054

@@ -101,14 +95,39 @@ Timeline playback is multi-threaded using the C# Job System.
10195
Access to variant selection, model details, and payload state are all accessible via
10296
the inspector on the game object at which these features were authored.
10397

104-
# Unity 2017 Users
98+
## Exporting USD files
99+
100+
### Exporting via Recorder
101+
102+
> **Prerequisite:** You need to install the [Recorder package](https://docs.unity3d.com/Packages/com.unity.recorder@latest/index.html).
103+
104+
To export a USD composition via Recorder, you can either use the Recorder Window :
105+
* From the Editor main menu, select **Window > General > Recorder > Recorder Window**,
106+
* Then click on **+ Add Recorder**,
107+
* And select **USD Clip**.
108+
109+
Or add a Recorder track :
110+
* From the Timeline window, right-click and select **UnityEditor.Recorder.Timeline > Recorder Track**,
111+
* Then right-click on the track and **add Recorder Clip**,
112+
* And in the **selected recorder**, choose **USD Clip**.
113+
114+
Using Recorder is the recommended option *when compatibility with runtime is not required*.
115+
116+
### Exporting via Usd Recorder Track (Legacy)
117+
118+
When compatibility with runtime is required (i.e for a standalone build), the recommended option is to use the USD package Recorder Track :
119+
* From the Timeline window, right-click and select **Unity.Formats.USD > Usd Recorder Track**,
120+
* Then right-click on the track and **add USD Recorder Clip**.
121+
122+
> **Note:** This feature has no dependency to and is not based on the Recorder package.
123+
124+
### Exporting via USD menu (Legacy)
125+
126+
A last option to export a USD Composition is to use the legacy export via the Editor main menu :
127+
* Select **USD > Export Selected**.
105128

106-
The official package is not compatible with 2017.4 but a separate branch is maintained to allow 2017 users to benefit from the last developments.
129+
Note that this option is not recommended as it doesn't offer any export options.
107130

108-
Here's how to install the plugin from this branch:
109-
* Checkout [2017.4 branch](https://github.com/Unity-Technologies/usd-unity-sdk/tree/2017.4) from the GitHub repository.
110-
* Copy UsdUnitySdk in your Assets folder.
111-
* Do not rename this folder.
112131

113132
# License
114133

package/com.unity.formats.usd/Documentation~/USD.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,8 @@ settings under Edit > Project Settings > Quality:
3131
## Requirements
3232

3333
* Windows / OSX
34-
* Unity version: 2018.3 (2018.3.4f1 and up) and 2019.1 (2019.1.0b2 and up)
35-
See ["2017 users" section](#unity-2017-users) if you want to use the plugin in Unity 2017.4
36-
* To build a standalone, Api Compatibility Level needs to be set to .NET 4.x
34+
* Unity version: 2019.4 and up
35+
* API Compatibility Level .NET 4.x is no longer required but still provides better performances than .NET 2
3736
In Edit > Project Settings > Player :
3837
![USD .NET version](Images/USD_.NET_version.png)
3938

@@ -44,17 +43,12 @@ See ["2017 users" section](#unity-2017-users) if you want to use the plugin in U
4443
## Samples
4544

4645
The USD package also includes samples to help you get started.
47-
Please note, the way to get them varies depending on the Unity version you are using. See below.
48-
49-
### Unity 2019.1 and Later
5046

5147
Use Package Manager to import the samples into your Assets folder :
5248

5349
![USD .NET version](Images/USD_samples_import.png)
5450

55-
### Previous versions
5651

57-
Samples package can be downloaded from [Unity film-tv-toolbox repository](https://github.com/Unity-Technologies/film-tv-toolbox/tree/master/UsdSamples).
5852

5953
# Features
6054

@@ -103,13 +97,33 @@ the inspector on the game object at which these features were authored.
10397

10498
## Exporting USD files
10599

106-
You can export USD files in 3 ways according to your needs:
100+
### Exporting via Recorder
101+
102+
> **Prerequisite:** You need to install the [Recorder package](https://docs.unity3d.com/Packages/com.unity.recorder@latest/index.html).
103+
104+
To export a USD composition via Recorder, you can either use the Recorder Window :
105+
* From the Editor main menu, select **Window > General > Recorder > Recorder Window**,
106+
* Then click on **+ Add Recorder**,
107+
* And select **USD Clip**.
108+
109+
Or add a Recorder track :
110+
* From the Timeline window, right-click and select **UnityEditor.Recorder.Timeline > Recorder Track**,
111+
* Then right-click on the track and **add Recorder Clip**,
112+
* And in the **selected recorder**, choose **USD Clip**.
113+
114+
Using Recorder is the recommended option *when compatibility with runtime is not required*.
115+
116+
### Exporting via Usd Recorder Track (Legacy)
117+
118+
When compatibility with runtime is required (i.e for a standalone build), the recommended option is to use the USD package Recorder Track :
119+
* From the Timeline window, right-click and select **Unity.Formats.USD > Usd Recorder Track**,
120+
* Then right-click on the track and **add USD Recorder Clip**.
121+
122+
> **Note:** This feature has no dependency to and is not based on the Recorder package.
107123
108-
* To export a USD composition that does not change over time, use the USD export options available from the Editor main menu: select **USD > Export Selected**.
124+
### Exporting via USD menu (Legacy)
109125

110-
* To export a USD composition that changes over time, use the USD Recorder.
111-
**Note:** You need to install the [Recorder package](https://docs.unity3d.com/Packages/com.unity.recorder@latest/index.html) for this.
112-
You can either use the Recorder Window (from the Editor main menu, select **Window > General > Recorder > Recorder Window**) or a Recorder track (from the Timeline window, right-click and select **UnityEditor.Recorder.Timeline > Recorder Track**).
126+
A last option to export a USD Composition is to use the legacy export via the Editor main menu :
127+
* Select **USD > Export Selected**.
113128

114-
* To export compositions that change over time _from a standalone build_, use the USD Recorder Track in Timeline (from the Timeline window, right-click and select **Unity.Formats.USD > Usd Recorder Track**).
115-
**Note:** This feature has no dependency on to the Recorder package.
129+
Note that this option is not recommended as it doesn't offer any export options.

0 commit comments

Comments
 (0)