You've already forked ParticleEffectForUGUI
mirror of
https://github.com/mob-sakai/ParticleEffectForUGUI.git
synced 2026-05-14 12:10:08 +00:00
3.0.0-preview.23
# [3.0.0-preview.23](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/v3.0.0-preview.22...v3.0.0-preview.23) (2020-08-31)
### Bug Fixes
* the default value of IgnoreCanvasScaler is true ([966fae1](966fae1d22))
This commit is contained in:
semantic-release-bot
114
README.md
114
README.md
@@ -6,22 +6,19 @@ The particle rendering is maskable and sortable, without Camera, RenderTexture o
|
||||
|
||||
[](https://openupm.com/packages/com.coffee.ui-particle/)
|
||||
[](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
|
||||
[](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
|
||||
|
||||
[](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/upm/LICENSE.md)
|
||||
[](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
|
||||
|
||||
[](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/upm/LICENSE.txt)
|
||||
[](http://makeapullrequest.com)
|
||||
[](https://twitter.com/intent/follow?screen_name=mob_sakai)
|
||||
|
||||
|
||||
|
||||
<< [Description](#Description) | [WebGL Demo](#demo) | [Installation](#installation) | [Usage](#usage) | [Development Note](#development-note) | [Change log](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/upm/CHANGELOG.md) >>
|
||||
|
||||
### What's new? Please see [See changelog ](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/upm/CHANGELOG.md)
|
||||
### Do you want to receive notifications for new releases? [Watch this repo ](https://github.com/mob-sakai/ParticleEffectForUGUI/subscription)
|
||||
<< [Description](#Description) | [Demo](#demo) | [Installation](#installation) | [Usage](#usage) | [Development Note](#development-note) | [Change log](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/upm/CHANGELOG.md) >>
|
||||
|
||||
|
||||
|
||||
<br><br><br><br>
|
||||
|
||||
## Description
|
||||
|
||||
|
||||
@@ -44,39 +41,43 @@ Compares this "Baking mesh" approach with the conventional approach:
|
||||
#### Features
|
||||
|
||||
* Easy to use: the package is out-of-the-box
|
||||
* Sort particle effects with uGUI
|
||||
* Sort particle effects with UI
|
||||
* No Camera, RenderTexture or Canvas are required
|
||||
* Masking with Mask or RectMask2D
|
||||
* Support Trail module
|
||||
* Change alpha with CanvasGroup
|
||||
* Scaling independent of Transform
|
||||
* No heavy allocation every frame
|
||||
* All ParticleSystem.ScalingModes and all Canvas.RenderModes are supported. They look almost the same in all modes.
|
||||
|
||||
* Scaled gizmo
|
||||
|
||||
* Animatable material property
|
||||
* Support overlay, camera space and world space
|
||||
* Support changing material property with AnimationClip (AnimatableProperty)
|
||||
|
||||
|
||||
|
||||
|
||||
<br><br><br><br>
|
||||
|
||||
## Demo
|
||||
|
||||
[WebGL Demo](http://mob-sakai.github.io/ParticleEffectForUGUI)
|
||||
* [WebGL Demo](http://mob-sakai.github.io/ParticleEffectForUGUI)
|
||||
* [WebGL Demo (Cartoon FX & War FX)](https://mob-sakai.github.io/Demos/ParticleEffectForUGUI_CFX)
|
||||
* [Cartoon FX Free][CFX] & [War FX][WFX] (by [Jean Moreno (JMO)][JMO]) with UIParticle
|
||||
|
||||
[CFX]: https://assetstore.unity.com/packages/vfx/particles/cartoon-fx-free-109565
|
||||
[WFX]: https://assetstore.unity.com/packages/vfx/particles/war-fx-5669
|
||||
[JMO]: https://assetstore.unity.com/publishers/1669
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<br><br><br><br>
|
||||
## System Requirements
|
||||
|
||||
Unity 2018.2 or later versions.
|
||||
|
||||
|
||||
<br><br><br><br>
|
||||
## Installation
|
||||
|
||||
#### For Unity 2018.3 or later (Using OpenUPM)
|
||||
### Requirement
|
||||
|
||||
* Unity 2018.2 or later
|
||||
|
||||
### Using OpenUPM
|
||||
|
||||
This package is available on [OpenUPM](https://openupm.com).
|
||||
You can install it via [openupm-cli](https://github.com/openupm/openupm-cli).
|
||||
@@ -84,8 +85,7 @@ You can install it via [openupm-cli](https://github.com/openupm/openupm-cli).
|
||||
openupm add com.coffee.ui-particle
|
||||
```
|
||||
|
||||
|
||||
#### For Unity 2018.3 or later (Using Unity Package Manager)
|
||||
### Using Git
|
||||
|
||||
Find the manifest.json file in the Packages folder of your project and edit it to look like this:
|
||||
```js
|
||||
@@ -103,7 +103,7 @@ To update the package, change suffix `#{version}` to the target version.
|
||||
|
||||
Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to install and update the package.
|
||||
|
||||
#### For Unity 2018.2
|
||||
### For Unity 2018.2
|
||||
|
||||
Unity 2018.2 supports embedded packages.
|
||||
|
||||
@@ -114,9 +114,10 @@ Unity 2018.2 supports embedded packages.
|
||||
|
||||
|
||||
<br><br><br><br>
|
||||
|
||||
## How to play demo
|
||||
|
||||
#### For Unity 2019.1 or later
|
||||
### For Unity 2019.1 or later
|
||||
|
||||
1. Open `Package Manager` window
|
||||
2. Select `UI Particle` package in package list
|
||||
@@ -124,7 +125,7 @@ Unity 2018.2 supports embedded packages.
|
||||
4. The demo project is imported into `Assets/Samples/UI Particle/{version}/Demo`
|
||||
5. Open `UIParticle_Demo` scene and play it
|
||||
|
||||
#### For Unity 2018.4 or earlier
|
||||
### For Unity 2018.4 or earlier
|
||||
|
||||
1. Select `Assets/Samples/UI Particle Demo` from menu
|
||||
2. The demo project is imported into `Assets/Samples/UI Particle/{version}/Demo`
|
||||
@@ -133,25 +134,31 @@ Unity 2018.2 supports embedded packages.
|
||||
|
||||
|
||||
<br><br><br><br>
|
||||
|
||||
## Usage
|
||||
|
||||
1. Add your particle effect to canvas.
|
||||
### Basically usage
|
||||
|
||||
1. Select `Game Object/UI/ParticleSystem` to create UIParticle.
|
||||
2. (Option) If you want to mask particles, set **a UI shader** such as `UI/UIAdditive` to material for ParticleSystem.
|
||||
|
||||
3. Add `UIParticle` component to root particle system of your effect from `Add Component` in inspector.
|
||||
|
||||
4. If your effect consists of multiple ParticleSystems, click "Fix".
|
||||
|
||||
5. Adjust the Scale property to change the size of the effect.
|
||||
3. Adjust the Scale property to change the size of the effect.
|
||||
|
||||
6. Enjoy!
|
||||
|
||||
### With VFX assets
|
||||
|
||||
1. Select `Game Object/UI/ParticleSystem (Empty)` to create UIParticle.
|
||||
2. Drag & drop VFX asset on UIParticle.
|
||||
3. Click `Refresh` to setup.
|
||||
4. Adjust the Scale property to change the size of the effect.
|
||||
|
||||
|
||||
|
||||
<br><br><br><br>
|
||||
|
||||
## Development Note
|
||||
|
||||
#### Animatable material property
|
||||
### Animatable material property
|
||||
|
||||
|
||||
|
||||
@@ -170,28 +177,45 @@ To prevent this, Use "Animatable Material Property".
|
||||
|
||||
|
||||
<br><br><br><br>
|
||||
## License
|
||||
|
||||
* MIT
|
||||
* © UTJ/UCL
|
||||
## Contributing
|
||||
|
||||
### Issues
|
||||
|
||||
Issues are very valuable to this project.
|
||||
|
||||
- Ideas are a valuable source of contributions others can make
|
||||
- Problems show where this project is lacking
|
||||
- With a question you show where contributors can improve the user experience
|
||||
|
||||
### Pull Requests
|
||||
|
||||
Pull requests are, a great way to get your ideas into this repository.
|
||||
See [CONTRIBUTING.md](/../../blob/develop/CONTRIBUTING.md).
|
||||
|
||||
### Support
|
||||
|
||||
This is an open source project that I am developing in my spare time.
|
||||
If you like it, please support me.
|
||||
With your support, I can spend more time on development. :)
|
||||
|
||||
[](https://www.patreon.com/join/mob_sakai?)
|
||||
[](https://github.com/users/mob-sakai/sponsorship)
|
||||
|
||||
|
||||
|
||||
<br><br><br><br>
|
||||
## Support
|
||||
|
||||
This is an open-source project that I am developing in my free time.
|
||||
If you like it, you can support me.
|
||||
By supporting, you let me spend more time working on better tools that you can use for free. :)
|
||||
## License
|
||||
|
||||
* MIT
|
||||
|
||||
[](https://www.patreon.com/join/2343451?)
|
||||
[](https://github.com/users/mob-sakai/sponsorship)
|
||||
|
||||
|
||||
## Author
|
||||
|
||||
[mob-sakai](https://github.com/mob-sakai)
|
||||
[](https://twitter.com/intent/follow?screen_name=mob_sakai)
|
||||
[](https://twitter.com/intent/follow?screen_name=mob_sakai)
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user