From b6a23ecb10ce593d63405ced898f9ac7c5927c5e Mon Sep 17 00:00:00 2001 From: mob-sakai <sakai@mobcast.jp> Date: Fri, 22 Jun 2018 18:09:16 +0900 Subject: [PATCH] Update readme --- README.md | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 105 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6019f92..3db0944 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,106 @@ ParticleForUGUI -=== \ No newline at end of file +=== + +This plugin provide a component to render particle effect for uGUI in Unity 2018.2+. +The particle rendering is maskable and sortable, without Camera, RenderTexture or Canvas. + +[](https://github.com/mob-sakai/ParticleForUGUI/releases) +[](https://github.com/mob-sakai/ParticleForUGUI/releases) + +[](https://github.com/mob-sakai/ParticleForUGUI/blob/master/LICENSE.txt) +[](https://github.com/mob-sakai/ParticleForUGUI/commits/develop) +[](https://github.com/mob-sakai/ParticleForUGUI/issues) + + + +<< [Description](#Description) | [WebGL Demo](#demo) | [Download](https://github.com/mob-sakai/ParticleForUGUI/releases) | [Usage](#usage) | [Development Note](#development-note) | [Change log](https://github.com/mob-sakai/ParticleForUGUI/blob/master/CHANGELOG.md) >> + +### What's new? Please see [RELEASE NOTE ](https://github.com/mob-sakai/ParticleForUGUI/blob/master/CHANGELOG.md) + + + + +<br><br><br><br> +## Description + + + +This plugin uses new APIs `MeshBake/MashTrailBake` (added with Unity 2018.2) to render particles by CanvasRenderer. +You can mask and sort particles for uGUI without Camera, RenderTexture, Canvas. + +Compares this "Baking mesh" approach with the conventional approach: +(This scene is included in the package.) + +|Approach|Good|Bad|Screenshot| +|-|-|-|-| +|Baking mesh<br>**\(UIParticle\)**|Rendered as is.<br>Maskable.<br>Sortable.<br>Less objects.|**Requires Unity 2018.2+.**<br>Requires UI shaders.|<img src="https://user-images.githubusercontent.com/12690315/41765089-0302b9a2-763e-11e8-88b3-b6ffa306bbb0.gif" width="500px">| +|Do nothing|Rendered as is.|**Looks like a glitch.**<br>Not maskable.<br>Not sortable.|<img src="https://user-images.githubusercontent.com/12690315/41765090-0329828a-763e-11e8-8d8a-f1d269ea3bc7.gif" width="500px">| +|Convert particle to UIVertex<br>[\(UIParticleSystem\)](https://forum.unity.com/threads/free-script-particle-systems-in-ui-screen-space-overlay.406862/)|Maskable.<br>Sortable.<br>Less objects.|**Adjustment is difficult.**<br>Requires UI shaders.<br>Difficult to adjust scale.<br>Force hierarchy scalling.<br>Simulation results are incorrect.<br>Trail, rotation of transform, time scaling are not supported.|<img src="https://user-images.githubusercontent.com/12690315/41765088-02deb9c6-763e-11e8-98d0-9e0c1766ef39.gif" width="500px">| +|Use Canvas to sort|Rendered as is.<br>Sortable.|**You must to manage sorting orders.**<br>Not maskable.<br>More batches.|<img src="https://user-images.githubusercontent.com/12690315/41765087-02b866ea-763e-11e8-8c33-081c9ad852f8.gif" width="500px">| +|Use RenderTexture|Maskable.<br>Sortable.|**Requires Camera and RenderTexture.**<br>Difficult to adjust position and size.<br>Quality depends on the RenderTexture's setting.|<img src="https://user-images.githubusercontent.com/12690315/41765085-0291b3e2-763e-11e8-827b-72e5ee9bc556.gif" width="500px">| + + + + +<br><br><br><br> +## Demo + +[WebGL Demo](http://mob-sakai.github.io/ParticleForUGUI) + + + +<br><br><br><br> +## Usage + +1. Download ParticleForUGUI.unitypackage from [Releases](https://github.com/mob-sakai/ParticleForUGUI/releases). +1. Import the package into your Unity project. Select `Import Package > Custom Package` from the `Assets` menu. +1. Add particle system to canvas. +1. If you want to mask particles, set the "UI/UIAdditive" shader to material. +1. Add `UIParticle` component to particle system from `Add Component` in inspector. + +1. Enjoy! + + +##### Requirement + +* Unity 2018.2+ (Tested in Unity 2018.2b9) +* No other SDK are required + + + + +<br><br><br><br> +## Development Note + +#### BakeMesh API has a issue! + +See [this issue](https://issuetracker.unity3d.com/issues/bakemesh-slash-baketrailsmesh-crashes-if-update-jobs-are-running). + +`UIParticle` avoids the issue, but the rendering result lags one frame. + +Please vote the issue to improve `UIParticle`! + + + + +<br><br><br><br> +## License + +* MIT +* © UTJ/UCL + + + +## Author + +[mob-sakai](https://github.com/mob-sakai) + + + +## See Also + +* GitHub page : https://github.com/mob-sakai/ParticleForUGUI +* Releases : https://github.com/mob-sakai/ParticleForUGUI/releases +* Issue tracker : https://github.com/mob-sakai/ParticleForUGUI/issues +* Current project : https://github.com/mob-sakai/ParticleForUGUI/projects/1 +* Change log : https://github.com/mob-sakai/ParticleForUGUI/blob/master/CHANGELOG.md