[Ready for Merge] Hdrp template iet #5286
Conversation
…up branch. There seems to be an error in the TutorialCallbacks.cs.
…nteractiveTutorials namespace to Unity.Tutorials.Core.Editor because of the 2.0.0 IET framework
…, fixed punctuation that had a space after </b> or </i>
…al defaults" folder
…alcallback scrpit
|
It appears that you made a non-draft PR! |
| @@ -0,0 +1,61 @@ | |||
| using UnityEngine; | |||
There was a problem hiding this comment.
I dont get the purpose of this script. Callbacks are never called anywhere. There is a ScriptableObject created from it but its GUID is nowhere which means it is used in no scene/prefab/assets. Is it some dead code to remove ?
There was a problem hiding this comment.
@mikaisomaa, is this TutorialCallbacks file absolutely necessary?
I did re-generate it, because upgrading from the preview version of the IET package to the new one created errors on this script. However, it doesn't indeed seem to be necessary at all.
Is it safe to remove?
There was a problem hiding this comment.
By the way, the scroll bar is a bug that the IET team will investigate.
removed the iet authoring framework (not needed) updated input system (autoupdates regardless) removed initcodemarker created a tutorial layout to ensure correct display of the tutorial window
|
I've added a default layout for tutorial, to make sure that the tutorial window is docked on the very right, rather than floating around (users will most likely be annoyed at it an close it as a result...). It should look like this: |
There was a problem hiding this comment.
Testing status: Complete
Issues:
- FIXED No Welcome page error. We can create the welcome page and assign it to the tutorial or not use it at all ?
DMuZYrGIXt.mp4
- KNOWN CANT BE FIXED IN PR Memory leak error
Reproduction:
- Go through the fist tutorial
- Open the second
- Error
MitxIM32kI.mp4
- FIXED Light Cookies tutorial is broken, file needs updating. Cant proceed to the end.
1xnJOq9epZ.mp4
- DOESNT REPRODUCE Light layer names are lost
Suggestions:
- Add among the tutorials a link to feedback. Can be a quiz or forum page. To know what people liked it, what they disliked etc. Data for improvement
- FIXED Add a step mentioning that you need to also go to Lighting tab and select the Static Lighting Sky or use Dynamic mode. This is arguably the most confusing part of HDRP and users often bump into it. Maybe worth explaining how to "get" the ambient lighting
- Do we want this on to increase performance?
|
New Welcome Page was added:
|
- removed callback script asset to avoid memory leaks - added more information about ambient modes in the sky section
Thanks, yes these errors will popup at random times. The IET team is working on them, or trying to find out at least. It's a known issue with the IET package. |
- fixed a guid issue with "before you start" tutorial - reflection probes wants a new guid apparently...
|
Added a section for frame settings as well:
And polished some bits regarding the global ambient probe:
|
Purpose of this PR
This PR adds a brand new In-Editor Tutorial (IET) to the HDRP Scene Template.
More than a dozen tutorials cover a wide range of HDRP basics and features, from Sky to Fog, as well as Light Baking and Decals.
The tutorials are meant to be fairly short. Additional resources are linked at the end of each section, for users to dive deeper. Again, it's not meant to be an in-depth tutorial.
Other noticeable changes:
Comments to reviewers
To access the tutorials, in case the window doesn't already show up, go to the main toolbar at the top of Unity and pick Tutorials > Show Tutorials.
To recreate a first experience for the user, choose Tutorials > Debug > ClearInitCodeMarker. This should ensure the tutorial window is loading properly (as a popup).
Check that the instructions are clear enough, easy to follow.
Check that all the links provided are pointing to the right place. (I did notice that the "latest" manual links often points to HDRP 11 doc pages, I suppose that's normal, as HDRP 12 is still in beta)
Each section should be taking no less than a couple of minutes to complete.
Something important, is to make sure that the template window shows up when opening the tutorial for the first time. I do not know exactly how this works for this scene however (startup code?).
Check as well the tutorial on both Windows and Mac (or other Unix platforms), because the parser used for the text may result in slightly different results. So it you see odd spacing, or strange line returns, this might be a bug due to some hidden Unix characters that are not interpreted correctly on Windows, such as "\r".