From f13ba509986f55e22e55a9ad430a7e715476d9c8 Mon Sep 17 00:00:00 2001
From: mob-sakai <12690315+mob-sakai@users.noreply.github.com>
Date: Mon, 30 Sep 2024 02:49:57 +0900
Subject: [PATCH] docs: update documents
---
Packages/src/README.md | 15 ++++++++++++++-
Packages/src/package.json | 2 +-
2 files changed, 15 insertions(+), 2 deletions(-)
diff --git a/Packages/src/README.md b/Packages/src/README.md
index beb1a63..737a2cb 100644
--- a/Packages/src/README.md
+++ b/Packages/src/README.md
@@ -11,7 +11,7 @@
[](https://github.com/mob-sakai/ParticleEffectForUGUI/subscription)
[](https://twitter.com/intent/follow?screen_name=mob_sakai)
-<< [📝 Description](#-description-) | [📌 Key Features](#-key-features) | [🎮 Demo](#-demo) | [⚙ Installation](#-installation) | [🚀 Usage](#-usage) | [🛠 Development Note](#-development-note) | [🤝 Contributing](#-contributing) >>
+<< [📝 Description](#-description-) | [📌 Key Features](#-key-features) | [🎮 Demo](#-demo) | [⚙ Installation](#-installation) | [🔄 Upgrading to 5.x](#-upgrading-from-3x4x-to-5x) | [🚀 Usage](#-usage) | [🛠 Development Note](#-development-note) | [🤝 Contributing](#-contributing) >>
## 📝 Description
@@ -27,6 +27,8 @@ You can render, mask, and sort your `ParticleSystems` for UI without the need fo
- [Install via UPM (with Package Manager UI)](#install-via-upm-with-package-manager-ui)
- [Install via UPM (Manually)](#install-via-upm-manually)
- [Install as Embedded Package](#install-as-embedded-package)
+- [🔄 Upgrading from 3.x/4.x to 5.x](#-upgrading-from-3x4x-to-5x)
+ - [Breaking Changes](#breaking-changes)
- [🚀 Usage](#-usage)
- [Component: UIParticle](#component-uiparticle)
- [Basic Usage](#basic-usage)
@@ -152,6 +154,17 @@ _This package requires **Unity 2018.3 or later**._
+## 🔄 Upgrading from 3.x/4.x to 5.x
+
+### Breaking Changes
+
+- The default value of `UIParticle.scale` has been changed from `10` to `1`.
+- `UIParticle` no longer inherits from `MaskableGraphic`.
+- Add project settings for UIParticle
+ - enableLinearToGamma: Enables LinearToGamma during mesh baking
+
+
+
## 🚀 Usage
### Component: UIParticle
diff --git a/Packages/src/package.json b/Packages/src/package.json
index 5ad7782..b425b1f 100644
--- a/Packages/src/package.json
+++ b/Packages/src/package.json
@@ -2,7 +2,7 @@
"name": "com.coffee.ui-particle",
"displayName": "UI Particle",
"description": "This package provides a component to render particle effects for uGUI.\nThe particle rendering is maskable and sortable, without the need for an extra Camera, RenderTexture, or Canvas.",
- "version": "4.10.1",
+ "version": "5.0.0-preview.5",
"unity": "2018.2",
"license": "MIT",
"repository": {