Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codewriter-packages/tutorialmaskforugui

UI Tutorial Mask is a component for highlighting specific objects over darkened background for Unity UI (uGUI)
https://github.com/codewriter-packages/tutorialmaskforugui

component effects mask ugui ui unity unity3d

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/codewriter-packages/tutorialmaskforugui
Owner: codewriter-packages
License: mit
Created: 2024-05-25T12:07:33.000Z (9 months ago)
Default Branch: main
Last Pushed: 2024-05-29T13:24:55.000Z (9 months ago)
Last Synced: 2024-05-30T03:25:55.191Z (9 months ago)
Topics: component, effects, mask, ugui, ui, unity, unity3d
Language: C#
Homepage:
Size: 15.6 KB
Stars: 8
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # TutorialMaskForUGUI [![Github license](https://img.shields.io/github/license/codewriter-packages/TutorialMaskForUGUI.svg?style=flat-square)](#) [![Unity 2021.3](https://img.shields.io/badge/Unity-2021.3+-2296F3.svg?style=flat-square)](#) ![GitHub package.json version](https://img.shields.io/github/package-json/v/codewriter-packages/TutorialMaskForUGUI?style=flat-square)

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

![Demo](https://github.com/codewriter-packages/TutorialMaskForUGUI/assets/26966368/4b31beed-3324-42d8-ad7c-62edcafb1bdc)

## :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](https://docs.unity3d.com/Manual/upm-ui-giturl.html))


Git URL: `https://github.com/codewriter-packages/TutorialMaskForUGUI.git`

## :green_book: License

TutorialMaskForUGUI is [MIT licensed](./LICENSE.md).