{"id":14960634,"url":"https://github.com/mob-sakai/unmaskforugui","last_synced_at":"2025-05-15T04:04:24.753Z","repository":{"id":37450740,"uuid":"152969433","full_name":"mob-sakai/UnmaskForUGUI","owner":"mob-sakai","description":"A reverse masking solution for uGUI element in Unity.","archived":false,"fork":false,"pushed_at":"2025-01-31T04:37:46.000Z","size":12415,"stargazers_count":899,"open_issues_count":0,"forks_count":83,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-05-15T04:04:00.554Z","etag":null,"topics":["component","mask","ugui","uguicomponent","ui","unity","unity-component","unity-plugin","unity3d","unmask"],"latest_commit_sha":null,"homepage":"https://github.com/mob-sakai/UnmaskForUGUI","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/mob-sakai.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","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},"funding":{"github":"mob-sakai","patreon":"mob_sakai","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-10-14T12:03:58.000Z","updated_at":"2025-05-14T07:03:04.000Z","dependencies_parsed_at":"2023-01-21T10:17:50.094Z","dependency_job_id":"ae81d9d2-628a-4928-a713-a46beb6dd8f1","html_url":"https://github.com/mob-sakai/UnmaskForUGUI","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mob-sakai%2FUnmaskForUGUI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mob-sakai%2FUnmaskForUGUI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mob-sakai%2FUnmaskForUGUI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mob-sakai%2FUnmaskForUGUI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mob-sakai","download_url":"https://codeload.github.com/mob-sakai/UnmaskForUGUI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254270641,"owners_count":22042858,"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","mask","ugui","uguicomponent","ui","unity","unity-component","unity-plugin","unity3d","unmask"],"created_at":"2024-09-24T13:22:38.840Z","updated_at":"2025-05-15T04:04:24.677Z","avatar_url":"https://github.com/mob-sakai.png","language":"C#","funding_links":["https://github.com/sponsors/mob-sakai","https://patreon.com/mob_sakai","https://www.patreon.com/join/2343451?"],"categories":[],"sub_categories":[],"readme":"Unmask For UGUI\n===\n\nReverse mask for uGUI element in Unity.\n\n![](https://user-images.githubusercontent.com/12690315/51747120-e1d8dc80-20eb-11e9-952e-a67915af1294.png)\n\n[![](https://img.shields.io/npm/v/com.coffee.unmask?label=openupm\u0026registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.coffee.unmask/)\n[![](https://img.shields.io/github/v/release/mob-sakai/UnmaskForUGUI?include_prereleases)](https://github.com/mob-sakai/UnmaskForUGUI/releases)\n[![](https://img.shields.io/github/release-date/mob-sakai/UnmaskForUGUI.svg)](https://github.com/mob-sakai/UnmaskForUGUI/releases)\n[![](https://img.shields.io/github/license/mob-sakai/UnmaskForUGUI.svg)](https://github.com/mob-sakai/UnmaskForUGUI/blob/main/LICENSE.txt)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](http://makeapullrequest.com)\n[![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow\u0026style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai)\n\n![](https://img.shields.io/badge/Unity%205.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202017.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202018.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202019.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202020.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202021.x-supported-blue.svg)\n\n![](https://img.shields.io/badge/Universal%20RP-supported-blue.svg)  \n\n\u003c\u003c [Description](#description) | [WebGL Demo](#demo) | [Installation](#installation) | [Usage](#usage) | [Contributing](#contributing) \u003e\u003e\n\n\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n## Description\n\nUnmask provides the following features:\n1. Reverse mask\n2. Ray through the unmasked rectangle\n3. Following another object\n4. Support nesting\n\n| Component | Features | Screenshot |\n|-|-|-|\n|**Unmask**|Reverse masking for parent Mask component.\u003cbr\u003e\u003cbr\u003e**Fit Target / Fit On Late Update:** Fit graphic's transform to target transform on LateUpdate.\u003cbr\u003e**Only For Children:** Unmask affects only for children.\u003cbr\u003e**Show Unmask Graphic:** Show the graphic that is associated with the unmask render area.|\u003cimg src=\"https://user-images.githubusercontent.com/12690315/51745704-0e3e2a00-20e7-11e9-8da8-5abb1c5193bc.png\" width=\"600px\"\u003e|\n|**UnmaskRaycastFilter**|The ray Passes through the unmasked rectangle.\u003cbr\u003eYou can click on the unmasked button on the back side.|\u003cimg src=\"https://user-images.githubusercontent.com/12690315/51745958-ebf8dc00-20e7-11e9-8cfc-8174e6ab2b7c.png\" width=\"600px\"\u003e|\n\n\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n## Demo\n\n[WebGL Demo](http://mob-sakai.github.io/UnmaskForUGUI)\n\n![demo](https://user-images.githubusercontent.com/12690315/46986251-4e296480-d129-11e8-8e3a-2bb0e5fbe533.gif)\n\n\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n## Installation\n\n### Requirement\n\n![](https://img.shields.io/badge/Unity%205.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202017.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202018.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202019.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202020.x-supported-blue.svg)\n![](https://img.shields.io/badge/Unity%202021.x-supported-blue.svg)\n\n![](https://img.shields.io/badge/Universal%20RP-supported-blue.svg)\n\n### Using OpenUPM\n\nThis package is available on [OpenUPM](https://openupm.com).  \nYou can install it via [openupm-cli](https://github.com/openupm/openupm-cli).\n```\nopenupm add com.coffee.unmask\n```\n\n### Using Git\n\nFind the manifest.json file in the Packages folder of your project and edit it to look like this:\n```\n{\n  \"dependencies\": {\n    \"com.coffee.unmask\": \"https://github.com/mob-sakai/UnmaskForUGUI.git\",\n    ...\n  },\n}\n```\n\nTo update the package, change suffix `#{version}` to the target version.\n\n* e.g. `\"com.coffee.unmask\": \"https://github.com/mob-sakai/UnmaskForUGUI.git#2.0.0\",`\n\nOr, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to install and update the package.\n\n### For Unity 2018.2 or earlier\n\n1. Download a source code zip file from [Releases](https://github.com/mob-sakai/UnmaskForUGUI/releases) page\n2. Extract it\n3. Import it into the following directory in your Unity project\n   - `Packages` (It works as an embedded package. For Unity 2018.1 or later)\n   - `Assets` (Legacy way. For Unity 2017.1 or later)\n\n\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n## How to play demo\n\n- For Unity 2019.1 or later\n  - Open `Package Manager` window and select `UI Unmask` package in package list and click `Demo \u003e Import in project` button\n- For Unity 2018.4 or earlier\n  - Click `Assets/Samples/UI Unmask/Import Demo` from menu\n\nThe assets will be imported into `Assets/Samples/UI Unmask/{version}/Demo`.  \nOpen `UIUnmask_Demo` scene and play it.\n\n\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n## Usage\n\nCreate Object From Menu (`GameObject \u003e UI \u003e Unmask \u003e ***`)\n\n|Menu|Screenshot|\n|--|--|\n|Tutorial Button|![](https://user-images.githubusercontent.com/12690315/123756826-4a00fd80-d8f8-11eb-8fb4-5d4399a3f907.png)|\n|Iris Shot|![](https://user-images.githubusercontent.com/12690315/123756809-45d4e000-d8f8-11eb-8bc9-767b81b8da42.png)|\n\n\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n## Example of using\n\n| Case | Description |Screenshot |\n|-|-|-|\n|Unmasked text|Black screen is cut out with unmasked text.|![](https://user-images.githubusercontent.com/12690315/46914021-c6c9dd00-cfd2-11e8-9698-6332bac8fef5.png)|\n|Hole|Black screen is cut out with unmasked Image.|![](https://user-images.githubusercontent.com/12690315/46985696-9b580700-d126-11e8-9b4a-3d66180c9562.png)|\n|Tutorial button|In tutorial, only specific button can be pressed.|![](https://user-images.githubusercontent.com/12690315/46983810-30560280-d11d-11e8-86d5-b25117740df4.png)|\n|Iris in/out|Transition effect with iris in/out.|![](https://user-images.githubusercontent.com/12690315/46983811-30560280-d11d-11e8-8d81-b38679cf9970.gif)|\n\n\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n## Contributing\n\n### Issues\n\nIssues are very valuable to this project.\n\n- Ideas are a valuable source of contributions others can make\n- Problems show where this project is lacking\n- With a question you show where contributors can improve the user experience\n\n### Pull Requests\n\nPull requests are, a great way to get your ideas into this repository.  \nSee [CONTRIBUTING.md](/../../blob/main/CONTRIBUTING.md) and [develop](https://github.com/mob-sakai/UnmaskForUGUI/tree/develop) branch..\n\n### Support\n\nThis is an open source project that I am developing in my spare time.  \nIf you like it, please support me.  \nWith your support, I can spend more time on development. :)\n\n[![](https://user-images.githubusercontent.com/12690315/50731629-3b18b480-11ad-11e9-8fad-4b13f27969c1.png)](https://www.patreon.com/join/2343451?)  \n[![](https://user-images.githubusercontent.com/12690315/66942881-03686280-f085-11e9-9586-fc0b6011029f.png)](https://github.com/users/mob-sakai/sponsorship)\n\n\n\n\n\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\u003cbr\u003e\n\n## License\n\n* MIT\n* © UTJ/UCL\n\n\n\n## Author\n\n[mob-sakai](https://github.com/mob-sakai)\n[![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow\u0026style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai) \n\n\n\n## See Also\n\n* GitHub page : https://github.com/mob-sakai/UnmaskForUGUI\n* Releases : https://github.com/mob-sakai/UnmaskForUGUI/releases\n* Issue tracker : https://github.com/mob-sakai/UnmaskForUGUI/issues\n* Change log : https://github.com/mob-sakai/UnmaskForUGUI/blob/main/CHANGELOG.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmob-sakai%2Funmaskforugui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmob-sakai%2Funmaskforugui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmob-sakai%2Funmaskforugui/lists"}