Release Announcements and Notes

Unity Engine
1

This thread will be updated each time a new release of the com.unity.learn.iet-framework and com.unity.learn.iet-framework.authoring packages becomes available.

For more information about the com.unity.learn.iet-framework and com.unity.learn.iet-framework.authoring packages, please have a look at this thread .

1 Like
2

com.unity.learn.iet-framework@2.0.0-pre.4 and
com.unity.learn.iet-framework.authoring@1.0.0-pre.4 are now available

Release notes are available at:
https://docs.unity3d.com/Packages/com.unity.learn.iet-framework@2.0/manual/index.html
https://docs.unity3d.com/Packages/com.unity.learn.iet-framework.authoring@1.0/manual/index.html

3

Hi! We’ve just released Tutorial Framework 2.0.0-pre.5 and Tutorial Authoring Tools 1.0.0-pre.5. First of, I’d like to thank the feedback and bug reports we’ve received from you! We will continue addressing the reported issues still but will be prioritising bug fixes, and some of the improvements and new features will have to wait for the 2.1 release later this year.

The pre.5 releases focus mostly on cleanup, refactoring, bug fixes and solidifying the public APIs of the packages but there are a couple of things I want to highlight:

  • Added support for multiple TutorialContainer assets within a project, allowing multiple set of tutorials (“tutorial projects”) for the user to choose from.
  • Checkbox to enable progress tracking in tutorials. Enabling progress tracking generates a GUID for the tutorial’s Lesson Id automatically. Tutorial cards do not have completion markers unless progress tracking is enabled.

You can find the full changelogs here:

The next pre.6 versions will most likely turn out the final and official 2.0.0 and 1.0.0 versions of the packages. Tutorial Framework 2.0.0 and 1.0.0 will include support for tutorial categories, essentially nested tutorial containers, but it should be noted that the UI Toolkit masking and highlighting will be postponed for the 2.1 release.

1 Like
4

Here is a demonstration how the support for multiple tutorial containers looks in practice:
7159243--857104--upload_2021-5-20_16-3-7.png

And here’s a sneak peek how the tutorial categories will look:
7159243--857107--upload_2021-5-20_16-4-26.png

5

Tutorial Framework 2.0.0-pre.6 and Tutorial Authoring Tools 1.0.0-pre.6 are in production!

https://docs.unity3d.com/Packages/com.unity.learn.iet-framework@2.0/changelog/CHANGELOG.html
https://docs.unity3d.com/Packages/com.unity.learn.iet-framework.authoring@1.0/changelog/CHANGELOG.html

These should be be last pre-releases before the final versions of the packages. For the final versions only minor fixes/tweaks are expected, if anything at all.

We have also began planning the IET 2.1 release which will include support for UI Toolkit masking and highlighting.

6

Tutorial Framework 2.0.0 and Tutorial Authoring Tools 1.0.0 are in production! (the -pre.6 suffix has been removed and they’re considered stable versions)

7

Tutorial Framework 2.1.0 has been promoted to production! The 2.1.0 release focuses on Unity 2021/2022 fixes, including a support for masking and highlighting UI Toolkit elements. Here’s the combined changelog of 2.1.0 and 2.1.0-pre.1 (the final 2.1.0 documentation seems not to be yet uploaded):
Added

  • Added support for UI Toolkit masking and highlighting. Pick Visual Element functionality can be used to easily pick the wanted visual elements.
  • Added multiple scene support for tutorials: the first element of Scenes list is considered to be the main scene and the rest of scenes are loaded additively.
  • Added tutorial start-up scene management options: as a new option, it’s possible to reuse the currently active scene(s).
  • Tutorial: Added getters and setters for all serialized fields.
  • Added unit tests back to the package.
  • Rich text parser: Added tag support, making it possible to set a text block to any style class.
  • Warn user about TutorialProjectSettings.RestoreDefaultAssetsOnTutorialReload behavior in all tutorial asset editors if authoring tools are not present.
  • Added sanitization for tutorial assets’ text content so that unprintable control characters, for example, a carriage return, are removed automatically.
  • Scripting API: Made TutorialModalWindow part of the public API of the package. This class can be used to implement welcome/closing dialogs for the tutorial project.

Fixed

  • Fixed auto-completion of SceneViewCameraMovedCriterion not working.
  • Fixed unresolved SerializedType values being shown incorrectly as None. These values are now shown as Not Found with a red background in the Inspector.
  • Fixed SerializedType values that were resolved but the resolved type had a different assembly-qualified type name than the original name being shown incorrectly as None. These values are now shown with a yellow background in the Inspector.
  • Fixed NRE when auto-advancing a tutorial page with video on Unity 2021 and newer.
  • Fixed misplaced unmasking of UI controls in floating editor windows on Unity 2021.2.0.
  • UI: Disabled horizontal scrollbars in all windows.
  • UI: Fixed unwanted offset in the interactable area of Back to previous view button.
  • Fixed original scenes not being restored correctly when exiting a tutorial which contained multiple scenes.
  • Fixed original scenes not being restored correctly when exiting a tutorial, when its original state contained multiple scenes.
  • Fixed memory leak errors (“A Native Collection has not been disposed…”) that occurred on Unity 2021.
  • Fixed undo/redo of tutorial and tutorial page editing not being reflected in the Inspector and Tutorials window immediately.
  • Fixed editing of active tutorial not being reflected in Tutorials window after an assembly reload.

Changed

  • When traversing back to an already completed tutorial page, the masking settings of the page are reapplied if the page doesn’t have completion criteria set.

This new behavior improves the tutorial authoring experience and allows a tutorial user to reobserve pages in “a tour of the UI” type of tutorials.

  • When applying masking, do not not throw an exception if unmasked view’s Editor Window Type or View Type is explicitly set to None, meaning, the masking is likely not fully configured yet.

Note that there will be no Tutorial Authoring Tools release this time and 1.0.0 is still the latest version of it. For the rest of the year the team will be focusing on other initiatives and there will be no new releases in the coming months, unless there will be a need for a bugfix release.

8

com.unity.learn.iet-framework@2.2.1 and
com.unity.learn.iet-framework.authoring@1.0.2 are now available

Release notes are available at:
https://docs.unity3d.com/Packages/com.unity.learn.iet-framework@2.2/changelog/CHANGELOG.html
https://docs.unity3d.com/Packages/com.unity.learn.iet-framework.authoring@1.0/changelog/CHANGELOG.html

9

com.unity.learn.iet-framework@3.1.1 and
com.unity.learn.iet-framework.authoring@1.2.1 are now available

Important: before upgrading to this Framework version, please upgrade to the closest major version to the one you’re currently using, and repeat so until you get to the latest v2 available.

This ensures that existing tutorials are properly converted and updated without any data loss.

Even though this is a new major version, you do not need to take any actions to upgrade your project to this package version. If you used some of the APIs deprecated in this version, please refer to the warning logs in your project to see what public APIs you should use instead. If you generated your tutorial layouts in Unity versions prior to 2020.3 LTS, which introduced many editor UI changes, it is recommended to check that all tutorial layouts are still working as expected, and to recreate them using the authoring tools if they don’t.

Highlights:

  • This version can only be used in Unity 2020.3 LTS and higher editors versions
  • New feature: Completion Dialog that can be displayed at the end of a Tutorial
  • New feature: It is now possible to repeat previous steps of a tutorial when going back. Masking/highlighting will be re-applied accordingly.
  • Extended live authoring capabilities to more elements of the windows of this package
  • Relevant performance optimisations (especially for tutorials that run in PlayMode)
  • Some public APIs are now obsolete (warnings will be displayed in the console)
  • Bugfixes

Given the major improvements and stability fixes, we recommend to upgrade to this version of the package if you intend to use IET in production projects

Full Release notes are available at:
https://docs.unity3d.com/Packages/com.unity.learn.iet-framework@3.1/changelog/CHANGELOG.html
https://docs.unity3d.com/Packages/c…mework.authoring@1.0/changelog/CHANGELOG.html

10

com.unity.learn.iet-framework@2.2.3 and
com.unity.learn.iet-framework.authoring@1.0.4 are now available

Highlights:

  • Relevant performance optimisations (especially for tutorials that run in PlayMode)
  • Bugfixes

Unless critical bugs arise, this will be the last IET version that can be used on Unity 2019.4 LTS. Future versions will be available only on Unity 2020.3 LTS and higher. Unless you really can’t switch to IET 3, we recommend to upgrade to that version of the package if you intend to use IET in production projects

Full Release notes are available at:

Changelog | Tutorial Framework | 2.2.3 (unity3d.com)
Changelog | Tutorial Authoring Tools | 1.0.4 (unity3d.com)

1 Like