37 lines
2.3 KiB
Markdown
37 lines
2.3 KiB
Markdown
# About Tutorial Framework
|
|
|
|
|
|
|
|
This package is used to display interactive in-Editor tutorials (IET) in tutorial projects and project templates.
|
|
|
|
## Installation
|
|
|
|
Simply search for "Tutorial Framework" in the Package Manager.
|
|
|
|
Make sure to update to the latest version of the package whose major version is the closest one to the one you're currently using.
|
|
I.E: if you're using version 1 of the package and the latest available is version 3, be sure to update to version 2 first, and then to version 3.
|
|
This ensures that existing tutorials are properly converted and updated without any data loss.
|
|
|
|
## Requirements
|
|
|
|
This version of Tutorial Framework is compatible with the following versions of the Unity Editor:
|
|
|
|
* 2021.3 and newer (LTS versions recommended)
|
|
|
|
Note however that is is only discoverable in the package manager for Unity 6 and above as it is only supported for those version.
|
|
|
|
## Known issues
|
|
- A benign "BuildStartedCriterion must be instantiated using the ScriptableObject.CreateInstance method..." warning in the Console when making a build.
|
|
- The save dialog does not appear if Play mode is active when exiting the tutorial.
|
|
- `SceneViewCameraMovedCriterion` has no ability to distinguish different types of camera movements.
|
|
- A misconfiguration of masking settings is likely to occur when upgrading a tutorial project between major Unity versions due to changes in the Unity Engine/Editor:
|
|
- When upgrading to 2020.1 and newer, certain UI elements, for example, `SceneView` and `Toolbar`, wre moved from `UnityEngine` assembly to `UnityEngine.CoreModule`.
|
|
This issue can addressed by following the instructions [here](framework-documentation.md#assembly-differences-between-unity-versions).
|
|
- When upgrading to 2021.1 and newer, the implementation of many common UI elements has changed from IMGUI to UI Toolkit.
|
|
This issue can addressed by following the instructions [here](framework-documentation.md#ui-implementation-differences-between-unity-versions).
|
|
|
|
# Using Tutorial Framework
|
|
To actually develop any tutorials, the Tutorial Authoring Tools package is needed. Install it by adding the following line to `Packages/manifest.json`:
|
|
`"com.unity.learn.iet-framework.authoring": "1.2.1"`
|
|
Make sure to update to the latest version of the package. After the installation, refer to the Tutorial Authoring Tools' documentation for more information.
|