UI Tutorial Mask is a component for highlighting specific objects over darkened background for Unity UI (uGUI)
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2025-08-25 13:37:24 +03:00
Runtime Add option to block raycasts outside enabled tutorial objects 2025-08-25 13:37:24 +03:00
.editorconfig Initial package 2024-05-25 19:14:33 +03:00
.gitignore Initial package 2024-05-25 19:14:33 +03:00
LICENSE.md Initial package 2024-05-25 19:14:33 +03:00
LICENSE.md.meta Initial package 2024-05-25 19:14:33 +03:00
package.json Initial package 2024-05-25 19:14:33 +03:00
package.json.meta Initial package 2024-05-25 19:14:33 +03:00
README.md Initial package 2024-05-25 19:14:33 +03:00
README.md.meta Initial package 2024-05-25 19:14:33 +03:00
Runtime.meta Initial package 2024-05-25 19:14:33 +03:00

TutorialMaskForUGUI Github license Unity 2021.3 GitHub package.json version

UI Tutorial Mask is a component for highlighting specific objects over darkened background for Unity UI (uGUI)

Demo

🚀 How to use?

  • Create an Image that will cover the entire visible area, add a TutorialMask script to it
  • Add a TutorialObject script to each object that should be visible on top of the image
  • If you want to use TutorialObject with Mask, you need to add MaskFixForTutorial script on each mask object. It's necessary due to a bug in the mask component that overwrites all bit (even which it does not use) in stencil buffer

📖 How to Install

Minimal Unity Version is 2021.3.

Library distributed as git package (How to install package from git URL)
Git URL: https://github.com/codewriter-packages/TutorialMaskForUGUI.git

📗 License

TutorialMaskForUGUI is MIT licensed.