Update readme
parent
b2ceddeff9
commit
17d338b2f7
39
README.md
39
README.md
|
@ -10,11 +10,13 @@ Soft masking for uGUI elements in Unity.
|
||||||

|

|
||||||
[](https://github.com/mob-sakai/SoftMaskForUGUI/blob/master/LICENSE.txt)
|
[](https://github.com/mob-sakai/SoftMaskForUGUI/blob/master/LICENSE.txt)
|
||||||
[](http://makeapullrequest.com)
|
[](http://makeapullrequest.com)
|
||||||
|
[](https://twitter.com/intent/follow?screen_name=mob_sakai)
|
||||||
|
|
||||||
<< [Description](#Description) | [WebGL Demo](#demo) | [Download](https://github.com/mob-sakai/SoftMaskForUGUI/releases) | [Usage](#usage) | [Development Note](#development-note) >>
|
<< [Description](#Description) | [WebGL Demo](#demo) | [Download](https://github.com/mob-sakai/SoftMaskForUGUI/releases) | [Usage](#usage) | [Development Note](#development-note) >>
|
||||||
|
|
||||||
### What's new? [See changelog ](https://github.com/mob-sakai/SoftMaskForUGUI/blob/develop/CHANGELOG.md)
|
### What's new? [See changelog ](https://github.com/mob-sakai/SoftMaskForUGUI/blob/develop/CHANGELOG.md)
|
||||||
### Do you want to receive notifications for new releases? [Watch this repo ](https://github.com/mob-sakai/SoftMaskForUGUI/subscription)
|
### Do you want to receive notifications for new releases? [Watch this repo ](https://github.com/mob-sakai/SoftMaskForUGUI/subscription)
|
||||||
|
### Support me on Patreon! [](https://www.patreon.com/join/2343451?)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
@ -76,21 +78,42 @@ By using SoftMask instead of default Mask, rounded edges of UI elements can be e
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<br><br><br><br>
|
||||||
|
## Install
|
||||||
|
|
||||||
|
#### Using UnityPackageManager (for Unity 2018.3+)
|
||||||
|
|
||||||
|
Find the manifest.json file in the Packages folder of your project and edit it to look like this:
|
||||||
|
```js
|
||||||
|
{
|
||||||
|
"dependencies": {
|
||||||
|
"com.coffee.softmask-for-ugui": "https://github.com/mob-sakai/SoftMaskForUGUI.git#0.4.0",
|
||||||
|
...
|
||||||
|
},
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Using .unitypackage file (for Unity 2017.1+)
|
||||||
|
|
||||||
|
Download `*.unitypackage` from [Releases](https://github.com/mob-sakai/SoftMaskForUGUI/releases) and import the package into your Unity project.
|
||||||
|
Select `Assets > Import Package > Custom Package` from the menu.
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<br><br><br><br>
|
<br><br><br><br>
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
1. Download `*.unitypackage` from [Releases](https://github.com/mob-sakai/SoftMaskForUGUI/releases).
|
1. Add SoftMask component instead of Mask component.
|
||||||
2. Import the package into your Unity project. Select `Import Package > Custom Package` from the `Assets` menu.
|
Or, convert existing Mask component to SoftMask component from the context menu.
|
||||||

|
|
||||||
3. Add SoftMask component instead of Mask component. Or, convert existing Mask component to SoftMask component from the context menu.
|
|
||||||

|

|
||||||
4. Add SoftMaskable components to the child UI elements of SoftMask component.
|
2. Add SoftMaskable components to the child UI elements of SoftMask component.
|
||||||

|

|
||||||
Or, add SoftMaskable components from the inspector of SoftMask component.
|
Or, add SoftMaskable components from the inspector of SoftMask component.
|
||||||

|

|
||||||
5. Adjust softness of SoftMask.
|
3. Adjust softness of SoftMask.
|
||||||

|

|
||||||
6. Enjoy!
|
4. Enjoy!
|
||||||
|
|
||||||
|
|
||||||
##### Requirement
|
##### Requirement
|
||||||
|
@ -288,6 +311,8 @@ UnityEditor.EditorApplication.update += ()
|
||||||
## Author
|
## Author
|
||||||
|
|
||||||
[mob-sakai](https://github.com/mob-sakai)
|
[mob-sakai](https://github.com/mob-sakai)
|
||||||
|
[](https://twitter.com/intent/follow?screen_name=mob_sakai)
|
||||||
|
[](https://www.patreon.com/join/2343451?)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue