Changelog
All notable changes to this package will be documented in this file.
The format is based on Keep a Changelog, and this package adheres to Semantic Versioning.
[1.2.3] - 2021-03-04
Fixed
- Fixed null reference exception on Unity 2020.2.6 and newer (2021 does not have the problem) when editing the Type of Completion Criteria.
[1.2.2] - 2021-01-15
Fixed
- Null reference exception when starting a project which shows the Tutorials window by using the new window docking mechanism.
- Don't show Tutorials window when starting a project if there are no tutorials configured to be ran in the project (no
TutorialContainer
asset). - Tutorial not auto-advancing when a tutorial instruction involved exiting Play Mode.
- Null reference exception upon returning to a tutorial page with video when the same tutorial page was exited earlier by choosing Show Tutorials menu item.
[1.2.1] - 2020-11-17
Fixed
- Tutorial pages without completion criteria were auto-advanced even if not configured to do so if the previous page was set to auto-advance.
- UI: Fix the layout to make cards 100% wide when used with less content.
Added
- Localization: added translations for CJK languages.
[1.2.0] - 2020-11-10
Added
- Localization: Finalize localization support for CJK languages. No translations provided yet.
- Localization: Changes to IET project translations are applied automatically, Translate Current Project menu item removed as unnecessary.
- Localization: Made the UI strings of
Tutorial
,TutorialPage
andTutorialParagraph
localizable. - Tutorials window can be shown by anchoring and docking next to the Inspector (new default behavior) in addition of loading a window layout containing the window (old behavior).
- Provide static
Modified
events forTutorialWelcomePage
,Tutorial
andTutorialContainer
. - Tutorial authors can now define callbacks for
OnTutorialPageStay
(called each Editor update) andOnBeforeTutorialQuit
(called right before a user force-quits a tutorial). - Added Enable Masking and Highlighting Preference, can be found under Preferences > In-Editor Tutorials.
- Exposed
SceneViewCameraSettings
class and enums. - Documentation: Known Issues section added.
Changed
- TutorialWindow no longer has hardcoded "TUTORIALS" text, instead
TutorialContainer.Subtitle
shown here. - Deprecated
TutorialContainer.Description
, renamedTitle
toSubtitle
,ProjectName
will be renamed most likely toTitle
in 2.0. TutorialProjectSettings.RestoreDefaultAssetsOnTutorialReload
madefalse
by default.- deprecated
TutorialContainer.Section.AuthorizedUrl
; the Unity authentication need is detected automatically from the URL. - UI: Updated Link Card styling.
- UI: Enable word wrapping for Tutorial Card title.
- UI: Enable word wrapping for
TutorialContainer
's header title and subtitle.
Fixed
- Hyperlinks in tutorial pages support also to non-Unity URLs and work when the user was is not logged in.
[1.1.0] - 2020-09-22
Added
- Support for both Personal/Light & Professional/Dark style sheets. The styles can be customized on a per-project basis using
TutorialStyles
. - Rich text parser: validate input, create a clickable error label for invalid input.
- It is now possible to highlight/unmask Unity Object specific UI element by referencing the object properly instead of relying solely to a name matching logic.
Changed
- Raised the required Unity version to 2019.4.
- Hide the tutorial media header if the page has no media set.
- Unit tests are omitted from the package. Also renamed the unit test assembly in order to prevent name clashes with other internal Unity projects if the package is used as a local file package.
Fixed
- Fixed masking and highlighting for Unity 2020.1 and newer.
- Fixed overwhelming memory usage of
VideoPlaybackManager
. - Fixed all UI textures use the correct (GUI) texture type for better visual quality.
TutorialPage
: fixed null reference exception if selecting None as Media while having Video as Media Type.- Cleaned up PO files from dummy test translations.
- Fixed null reference exception spam when rerunning a newly created tutorial.
[1.0.3] - 2020-08-26
Fixed
- Fixed potential problems with copying of the layouts during the initial import of a project.
- Removed a duplicate error print if window layout loading fails.
- UI: Fix stretched header image and improve styling of next tutorial button.
[1.0.2] - 2020-08-06
Added
- Blink the Start tutorial -button on the first page.
Fixed
- Fixed highlighting of views not working if an Instructive paragraph was present in the current TutorialPage
- Header image stretching disabled
Changed
- Step completion checkmark (green color) only shown on steps with criteria.
- Lightened the tutorial background for better contrast
- Ensured long title texts wrap, and not overflow out of the screen
- Made instruction boxes look less like a button
- Ensured tutorial videos are not stretched
- Bold button labels
- Reduced margin between cards
[1.0.1] - 2020-07-24
Fixed
- Rich text hyperlinks: supporting only hyperlinks to Unity's websites. The user needs to be logged in in order for the hyperlinks to work.
- Next button was not disabled on a new tutorial page when the previous page was auto-completed.
[1.0.0] - 2020-07-16
Fixed
- Scene view camera's state is restored properly when exiting a tutorial after an assembly reload.
- If clicking a Switch Tutorial button while having unmodified changes in the scene, and choosing to cancel, do not return to the tutorial selection page, instead keep the current tutorial page.
- Prevent showing of Close Tutorials dialog when Play Mode is changing
- Fix tutorial window layouts not functioning after a tutorial project is restarted.
- Hide the instruction title element when it has no content.
- Fixed loading the tutorial scene twice when starting a tutorial, improving the tutorial start-up time.
[0.5.1] - 2020-07-06
Added
ArbitraryCriterion
: allows tutorial author to specify arbitrary completion criterion.- "Force default Inspector" checkmark state in
TutorialPageEditor
is now remembered when you click on another asset. TutorialPage
has nowOnBeforePageShown
andOnAfterPageShown
events to which tutorial author can subscribe to in order perform custom code.
Changed
- The package is now known as Tutorial Framework instead of Interactive Tutorial Core.
Fixed
BuildStartedCriterion
is evaluated properly also in cases where a build is not started from default Build Settings window.- Null reference exception when trying to view
TutorialPage
without paragraphs in the Inspector.
[0.5.0] - 2020-06-23
Added
TutorialWelcomePage
/TutorialModalWindow
:- can be authored at real-time,
- added a simple
TutorialWelcomePageEditor
with "Show Welcome Dialog" functionality, - rich text support, and
- fully configurable button row.
LocalizableTextArea
support forLocalizableString
s, similar toTextArea
forstring
s.- Allow specifying
InitialCameraSettings
inTutorialProjectSettings
.
Changed
- Masking is not assumed and enforced for every tutorial page, allowing to mix masked and unmasked pages in the same tutorial.
- Breaking change:
TutorialWelcomePage
asset refactored without backward-compatibility. TutorialProjectSettings
:- the welcome page for the project needs to be set explicitly,
StartupTutorial
is not started automatically, andUseLegacyStartupBehavior
false by default.
- Authoring: single line breaks rendered as expected instead of new paragraphs.
- Refactored and combined all the styles, removed
WelcomeDialog.uss
. - Updated the style of the welcome dialog.
- Improvement:
SceneViewCameraSettingsDrawer
shows rotation as Euler angles instead of raw Quaternion components. - Improvement: Save and restore SceneView's state (i.e. camera's state) when entering and exiting tutorials.
- Dependencies: update Editor Coroutines to 1.0.0.
Fixed
- Single line breaks now make a line break and two line breaks make a paragraph.
TutorialModalWindow
: Fixed hiding ofHeaderContainer
if none/null image set.- Instead of modifying the original window layout files in the project, a working copy is created and modified.
- Fixed null reference exceptions when starting a Tutorial which has no pages.
[0.4.0] - 2020-06-02
Changed
- Refactor
TutorialWindow
to use UI Toolkit instead of IMGUI. - Breaking change:
TutorialContainer
andTutorialParagraph
assets refactored without backward-compatibility. - Analytics: using
EditorAnalytics
instead ofUsabilityAnalytics
as the API for all events. TutorialPage
: instead of arbitrary set ofTutorialParagraph
s, the page has a fixed set of fields.TutorialParagraph
will be deprecated in the near future. ### AddedTutorialPageEditor
: a new simplified authoring view.- Preliminary localization support.
- Analytics: added an event for external reference (e.g. link cards) impressions
[0.3.0] - 2020-03-25
Changed
- Raised the required Unity version to 2019.3.
- Removed flexible spaces surrounding a video paragraph. ### Fixed
- UI flickering on macOS and Unity 2019.3 when a tutorial page had a video.
[0.2.3] - 2020-02-26
Added
- Analytics event for clicking external references/URLs.
[0.2.2] - 2020-02-14
Added
- Support for authorized URLs (Unity Connect auto-login).
[0.2.1] - 2019-11-11
Fixed
- Do not show the Welcome dialog and load the IET window layout every time an IET project is started.
- Fixed IET initialization when a Microgame is loaded from the Asset Store.
Changed
- Do not clear the description of a tutorial card when a tutorial is marked as completed.
[0.2.0] - 2019-10-21
Changed
Readme
class renamed to more suitableTutorialContainer
.
[0.1.18] - 2019-10-21
Changed
- New single-panel approach, Readme and Tutorials are shown in the same window which is always visible.
- Ability to save the Project window's state for the end-user when saving layouts for tutorials.
Readme
class moved intoUnity.InteractiveTutorials
namespace.
[0.1.17] - 2019-07-19
Changed
- Updated UI styles.
[0.1.16] - 2019-05-15
Changed
- Updated warning message when the user is about to exit the tutorial.
[0.1.15] - 2019-03-04
Added
- Adding the ability to unmask elements based on the name of the GUIStyle used to draw them.
- Warning message when the user is about to exit the tutorial.
Changed
- When clicking on Help > Template Walkthroughs if the inspector window is not visible, the Inspector window will be shown
[0.1.14] - 2019-02-12
Fixed
- If the user opens an Undocked window, that is not part of the tutorial, the window tabs are unmasked, so they can close or move the window.
- Improved compatibility with old content.
[0.1.13] - 2019-02-04
Added
- Add support for specifying alternate EditorWindow types when configuring unmasked views
- Expand unmask region to include foldout arrow when unmasking property that is collapsed
Removed
- Remove "Couldn't find a readme" message when there is no Readme asset in project
[0.1.12] - 2019-01-24
Fixed
- Fix editor entering and exiting play mode on project load
- Fix unmasked property unmasking entire window when ancestor property is collapsed
[0.1.11] - 2019-01-17
Fixed
- Fix 2019.1 compilation errors
- Improve invalid ScriptableObject reference workaround to always exit play mode after project load
[0.1.10] - 2019-01-11
Fixed
- Fix invalid CHANGELOG formatting.
[0.1.9] - 2019-01-11
Changed
- SceneViewCameraMovedCriterion will also complete if the user changes the camera orientation.
Fixed
- Added work around for issue where tutorial is not loaded initial project load
[0.1.8] - 2018-12-11
Fixed
- Fixed build script
[0.1.7] - 2018-12-10
Fixed
- Fixed authoring of scene object references. ### Removed
- Remove Window > Tutorials menu item.
[0.1.6] - 2018-12-06
Fixed
- Fix AudioClip import errors.
- Fix compilation errors at build time due to incorrectly configured Assembly Definition asset.
- Fix inconsistent line endings.
- Fix CS0649 warnings.
- Fix Help > Template Walkthroughs menu item not finding Readme asset.
[0.1.5] - 2018-12-04
Fixed
- Fixed ReflectionTypeLoadException when inspecting TutorialPage
- Fixed GUI layout errors when starting tutorial from Readme asset
[0.1.4] - 2018-12-03
Added
- Integrated the readme asset with the Tutorials
- Ability to have more than a single Tutorial in a project
- Proper flow for users to go into and out of a tutorial
- Ability to add Images, Video to a tutorial
- New Color type added to PropertyModificaitonCriterion
- PropertyModificationCriterion has a new mode where it will complete if the user changes a property to a different value than initial
- Added option to the masking system to prevent interactions to the unmasked area
- New Criterions: FrameSelectedCriterion, MaterialPropertyChanged, ActiveToolCriterion, SceneCameraViewMovedCritertion
- Ability for Tutorials to reference each other
- "Home/Skip" button have 2 modes. Legacy will open the Hub, and CloseWindow will close the Tutorial window
- Ability to choose the name of the Tutorial Window
Fixed
- Updated usages of obsolete APIs
Changed
- Initial version of the in editor tutorial framework as a package.
- Contained the use of internals to a single folder.