{"id":19266583,"url":"https://github.com/codewriter-packages/tutorialmaskforugui","last_synced_at":"2025-10-13T13:36:33.252Z","repository":{"id":241779306,"uuid":"805769891","full_name":"codewriter-packages/TutorialMaskForUGUI","owner":"codewriter-packages","description":"UI Tutorial Mask is a component for highlighting specific objects over darkened background for Unity UI (uGUI)","archived":false,"fork":false,"pushed_at":"2024-05-29T13:24:55.000Z","size":16,"stargazers_count":23,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-21T19:45:08.286Z","etag":null,"topics":["component","effects","mask","ugui","ui","unity","unity3d"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codewriter-packages.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-25T12:07:33.000Z","updated_at":"2025-03-27T03:20:32.000Z","dependencies_parsed_at":"2024-05-30T03:25:58.842Z","dependency_job_id":"5682e787-62a7-4145-bc42-2d0a43266def","html_url":"https://github.com/codewriter-packages/TutorialMaskForUGUI","commit_stats":null,"previous_names":["codewriter-packages/tutorialmaskforugui"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/codewriter-packages/TutorialMaskForUGUI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewriter-packages%2FTutorialMaskForUGUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewriter-packages%2FTutorialMaskForUGUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewriter-packages%2FTutorialMaskForUGUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewriter-packages%2FTutorialMaskForUGUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codewriter-packages","download_url":"https://codeload.github.com/codewriter-packages/TutorialMaskForUGUI/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codewriter-packages%2FTutorialMaskForUGUI/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263975720,"owners_count":23538380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["component","effects","mask","ugui","ui","unity","unity3d"],"created_at":"2024-11-09T20:05:54.955Z","updated_at":"2025-10-13T13:36:28.194Z","avatar_url":"https://github.com/codewriter-packages.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"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)\n\nUI Tutorial Mask is a component for highlighting specific objects over darkened background for Unity UI (uGUI)\n\n![Demo](https://github.com/codewriter-packages/TutorialMaskForUGUI/assets/26966368/4b31beed-3324-42d8-ad7c-62edcafb1bdc)\n\n## :rocket: How to use?\n\n- Create an `Image` that will cover the entire visible area, add a `TutorialMask` script to it\n- Add a `TutorialObject` script to each object that should be visible on top of the image\n- 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\n\n## :open_book: How to Install\nMinimal Unity Version is 2021.3.\n\nLibrary distributed as git package ([How to install package from git URL](https://docs.unity3d.com/Manual/upm-ui-giturl.html))\n\u003cbr\u003eGit URL: `https://github.com/codewriter-packages/TutorialMaskForUGUI.git`\n\n## :green_book: License\n\nTutorialMaskForUGUI is [MIT licensed](./LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewriter-packages%2Ftutorialmaskforugui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodewriter-packages%2Ftutorialmaskforugui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewriter-packages%2Ftutorialmaskforugui/lists"}