Install via UPM

Add to Unity Package Manager using this URL

https://www.pkglnk.dev/tutorial-mask.git

README Markdown

Copy this to your project's README.md

Style

Preview

## Installation

Add **UI Tutorial Mask** to your Unity project via Package Manager:

1. Open **Window > Package Manager**
2. Click **+** > **Add package from git URL**
3. Enter:
```
https://www.pkglnk.dev/tutorial-mask.git
```

[![pkglnk](https://www.pkglnk.dev/badge/tutorial-mask.svg?style=pkglnk)](https://www.pkglnk.dev/pkg/tutorial-mask)

README

TutorialMaskForUGUI

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

Demo

:rocket: 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

:open_book: 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

:green_book: License

TutorialMaskForUGUI is MIT licensed.

Comments

No comments yet. Be the first!

UI Tutorial Mask