diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 9dc9464..6a3495e 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -34,6 +34,7 @@ jobs:
working_directory: Packages/src
extra_plugins: |
@semantic-release/changelog
+ @semantic-release/exec
@semantic-release/git
env:
GITHUB_TOKEN: ${{ github.token }}
diff --git a/Packages/src/.releaserc.json b/Packages/src/.releaserc.json
index 5095173..a5f25e1 100644
--- a/Packages/src/.releaserc.json
+++ b/Packages/src/.releaserc.json
@@ -12,13 +12,28 @@
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/changelog",
+ [
+ "@semantic-release/exec",
+ {
+ "prepareCmd": "node ./Samples~/sync-sample-package-versions.js ${nextRelease.version}"
+ }
+ ],
[
"@semantic-release/npm",
{
"npmPublish": false
}
],
- "@semantic-release/git",
+ [
+ "@semantic-release/git",
+ {
+ "assets": [
+ "CHANGELOG.md",
+ "package.json",
+ "Samples~/**/package.json"
+ ]
+ }
+ ],
"@semantic-release/github"
]
}
diff --git a/Packages/src/README.md b/Packages/src/README.md
index 0006802..7c17ae2 100644
--- a/Packages/src/README.md
+++ b/Packages/src/README.md
@@ -123,7 +123,7 @@ _This package requires **Unity 2020.3 or later**._
```
- To update the package, use Package Manager UI (`Window > Package Manager`) or run the following command with `@{version}`:
```
- openupm add com.coffee.ui-effect@5.9.0
+ openupm add com.coffee.ui-effect@5.12.0
```
### Install via UPM (with Package Manager UI)
@@ -132,7 +132,7 @@ _This package requires **Unity 2020.3 or later**._
- Click `+ > Add package from git URL...` and input the repository URL: `https://github.com/mob-sakai/UIEffect.git?path=Packages/src`

- To update the package, change suffix `#{version}` to the target version.
- - e.g. `https://github.com/mob-sakai/UIEffect.git?path=Packages/src#5.9.0`
+ - e.g. `https://github.com/mob-sakai/UIEffect.git?path=Packages/src#5.12.0`
### Install via UPM (Manually)
@@ -147,7 +147,7 @@ _This package requires **Unity 2020.3 or later**._
```
- To update the package, change suffix `#{version}` to the target version.
- - e.g. `"com.coffee.ui-effect": "https://github.com/mob-sakai/UIEffect.git?path=Packages/src#5.9.0",`
+ - e.g. `"com.coffee.ui-effect": "https://github.com/mob-sakai/UIEffect.git?path=Packages/src#5.12.0",`
### Install as Embedded Package
@@ -167,6 +167,53 @@ Additional resources can be imported to extend functionality.
- [Usage with TextMeshPro](#usage-with-textmeshpro)
- [Usage with ShaderGraph](#usage-with-shadergraph)
+#### Install Additional Resources as Packages
+
+Starting with v5.12.0, you can install optional resources as separate UPM packages instead of importing them as samples.
+This lets you use the features you need without adding their assets to your project's `Assets/Samples` directory.
+
+> [!TIP]
+> Use the **same version as the UIEffect package**.
+> If you have already imported a resource as a sample, delete its corresponding sample from `Assets/Samples/UI Effect/{version}` before installing the package.
+
+The following optional packages are available from the OpenUPM registry.
+Choose the package that matches your Unity version and render pipeline, then replace `5.12.0` with your UIEffect package version if needed.
+
+```sh
+# TextMeshPro support (Unity 2023.2 or earlier)
+openupm add com.coffee.ui-effect.textmeshpro-legacy@5.12.0
+# TextMeshPro support (Unity 2023.3 or later)
+openupm add com.coffee.ui-effect.textmeshpro@5.12.0
+# ShaderGraph support (Unity 6, Built-in Render Pipeline)
+openupm add com.coffee.ui-effect.shadergraph-builtin@5.12.0
+# ShaderGraph support (Unity 6, URP)
+openupm add com.coffee.ui-effect.shadergraph-urp@5.12.0
+# v4 compatible components
+openupm add com.coffee.ui-effect.v4-compatible-components@5.12.0
+```
+
+For manual installation, add the desired package entries to your `Packages/manifest.json` file, install the package through Package Manager, or embed the package in your project.
+The following is a valid `manifest.json` dependencies example; remove entries for resources you do not need.
+Use only one TextMeshPro support package, and select the ShaderGraph package for your render pipeline.
+
+```json
+{
+ "dependencies": {
+ // TextMeshPro Support (2023.2 or earlier):
+ "com.coffee.ui-effect.textmeshpro-legacy": "https://github.com/mob-sakai/UIEffect.git?path=Packages/src/Samples~/com.coffee.ui-effect.textmeshpro-legacy#5.12.0",
+ // TextMeshPro Support (2023.3, 6000.0 or later):
+ "com.coffee.ui-effect.textmeshpro": "https://github.com/mob-sakai/UIEffect.git?path=Packages/src/Samples~/com.coffee.ui-effect.textmeshpro#5.12.0",
+ // ShaderGraph Support (Unity 6, Builtin):
+ "com.coffee.ui-effect.shadergraph-builtin": "https://github.com/mob-sakai/UIEffect.git?path=Packages/src/Samples~/com.coffee.ui-effect.shadergraph-builtin#5.12.0",
+ // ShaderGraph Support (Unity 6, URP):
+ "com.coffee.ui-effect.shadergraph-urp": "https://github.com/mob-sakai/UIEffect.git?path=Packages/src/Samples~/com.coffee.ui-effect.shadergraph-urp#5.12.0",
+ // v4 Compatible Components:
+ "com.coffee.ui-effect.v4-compatible-components": "https://github.com/mob-sakai/UIEffect.git?path=Packages/src/Samples~/com.coffee.ui-effect.v4-compatible-components#5.12.0",
+ ...
+ }
+}
+```
+
## 🔄 Upgrading from v4 to v5
@@ -185,6 +232,10 @@ If upgrading from UIEffect v4 to v5, note the following breaking changes:
```
2. Import the `v4 Compatible Components` sample from the Package Manager window.
+ > [!TIP]
+ > "Additional Resources" can be installed as a package from v5.12.0 or later.
+ > For more information, please refer to the [Install Additional Resources](#import-additional-resources) section.
+
3. All v4 components are obsolete.
- v4 `UIEffect` component is now `UIEffectV4` component. Change the reference in the code.
@@ -472,6 +523,10 @@ The `UIEffectReplica` component applies visual effects to UI elements by replica
### Usage with TextMeshPro
+> [!TIP]
+> "Additional Resources" can be installed as a package from v5.12.0 or later.
+> For more information, please refer to the [Install Additional Resources](#import-additional-resources) section.
+
To use UIEffect with TextMeshPro, you need to import additional resources.
When a shader included in the samples is requested, an import dialog will automatically appear.
Click the `Import` button.
@@ -516,6 +571,10 @@ Click the `Import` button.
### Usage with ShaderGraph
+> [!TIP]
+> "Additional Resources" can be installed as a package from v5.12.0 or later.
+> For more information, please refer to the [Install Additional Resources](#import-additional-resources) section.
+
⚠️ ShaderGraph support is available only in Unity 2023.2/6.0 or later.

diff --git a/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-builtin/package.json b/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-builtin/package.json
new file mode 100644
index 0000000..68aabea
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-builtin/package.json
@@ -0,0 +1,24 @@
+{
+ "name": "com.coffee.ui-effect.shadergraph-builtin",
+ "displayName": "UI Effect - ShaderGraph Support (Unity 6 BuiltIn)",
+ "description": "An extension for UI Effect that adds ShaderGraph support (Unity 6 BuiltIn).",
+ "version": "5.11.9",
+ "unity": "2020.3",
+ "license": "MIT",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/mob-sakai/UIEffect.git"
+ },
+ "author": {
+ "name": "mob-sakai",
+ "email": "sakai861104@gmail.com",
+ "url": "https://github.com/mob-sakai"
+ },
+ "dependencies": {
+ "com.coffee.ui-effect": "5.11.9"
+ },
+ "keywords": [
+ "ui",
+ "effect"
+ ]
+}
diff --git a/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-builtin/package.json.meta b/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-builtin/package.json.meta
new file mode 100644
index 0000000..95a032a
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-builtin/package.json.meta
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 2243ea0ee3ea34ea096e46b623d926bd
+TextScriptImporter:
+ externalObjects: {}
+ userData:
+ assetBundleName:
+ assetBundleVariant:
diff --git a/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-urp/package.json b/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-urp/package.json
new file mode 100644
index 0000000..c319893
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-urp/package.json
@@ -0,0 +1,25 @@
+{
+ "name": "com.coffee.ui-effect.shadergraph-urp",
+ "displayName": "UI Effect - ShaderGraph Support (Unity 6 URP)",
+ "description": "An extension for UI Effect that adds ShaderGraph support (Unity 6 URP).",
+ "version": "5.11.9",
+ "unity": "2020.3",
+ "license": "MIT",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/mob-sakai/UIEffect.git"
+ },
+ "author": {
+ "name": "mob-sakai",
+ "email": "sakai861104@gmail.com",
+ "url": "https://github.com/mob-sakai"
+ },
+ "dependencies": {
+ "com.coffee.ui-effect": "5.11.9",
+ "com.coffee.ui-effect-shadergraph-builtin": "5.11.9"
+ },
+ "keywords": [
+ "ui",
+ "effect"
+ ]
+}
diff --git a/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-urp/package.json.meta b/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-urp/package.json.meta
new file mode 100644
index 0000000..6f28be9
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.shadergraph-urp/package.json.meta
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: c3e0358c9a5534ade85d2ae0f2847c55
+TextScriptImporter:
+ externalObjects: {}
+ userData:
+ assetBundleName:
+ assetBundleVariant:
diff --git a/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro-legacy/package.json b/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro-legacy/package.json
new file mode 100644
index 0000000..69f496c
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro-legacy/package.json
@@ -0,0 +1,24 @@
+{
+ "name": "com.coffee.ui-effect.textmeshpro-legacy",
+ "displayName": "UI Effect - TextMeshPro Support",
+ "description": "An extension for UI Effect that adds TextMeshPro support.",
+ "version": "5.11.9",
+ "unity": "2020.3",
+ "license": "MIT",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/mob-sakai/UIEffect.git"
+ },
+ "author": {
+ "name": "mob-sakai",
+ "email": "sakai861104@gmail.com",
+ "url": "https://github.com/mob-sakai"
+ },
+ "dependencies": {
+ "com.coffee.ui-effect": "5.11.9"
+ },
+ "keywords": [
+ "ui",
+ "effect"
+ ]
+}
diff --git a/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro-legacy/package.json.meta b/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro-legacy/package.json.meta
new file mode 100644
index 0000000..4345dcf
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro-legacy/package.json.meta
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 469383fe0c8fd46bda3985c672997f1c
+TextScriptImporter:
+ externalObjects: {}
+ userData:
+ assetBundleName:
+ assetBundleVariant:
diff --git a/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro/package.json b/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro/package.json
new file mode 100644
index 0000000..da094fc
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro/package.json
@@ -0,0 +1,24 @@
+{
+ "name": "com.coffee.ui-effect.textmeshpro",
+ "displayName": "UI Effect - TextMeshPro Support (Unity 6)",
+ "description": "An extension for UI Effect that adds TextMeshPro support (Unity 6).",
+ "version": "5.11.9",
+ "unity": "2020.3",
+ "license": "MIT",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/mob-sakai/UIEffect.git"
+ },
+ "author": {
+ "name": "mob-sakai",
+ "email": "sakai861104@gmail.com",
+ "url": "https://github.com/mob-sakai"
+ },
+ "dependencies": {
+ "com.coffee.ui-effect": "5.11.9"
+ },
+ "keywords": [
+ "ui",
+ "effect"
+ ]
+}
diff --git a/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro/package.json.meta b/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro/package.json.meta
new file mode 100644
index 0000000..3f3540a
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.textmeshpro/package.json.meta
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 7a74c4045f8ba4e64bd8696c864268bb
+TextScriptImporter:
+ externalObjects: {}
+ userData:
+ assetBundleName:
+ assetBundleVariant:
diff --git a/Packages/src/Samples~/com.coffee.ui-effect.v4-compatible-components/package.json b/Packages/src/Samples~/com.coffee.ui-effect.v4-compatible-components/package.json
new file mode 100644
index 0000000..4ba5149
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.v4-compatible-components/package.json
@@ -0,0 +1,25 @@
+{
+ "name": "com.coffee.ui-effect.v4-compatible-components",
+ "displayName": "UI Effect - v4 Compatible Components",
+ "description": "An extension for UI Effect that adds v4 compatible components.",
+ "version": "5.11.9",
+ "unity": "2020.3",
+ "license": "MIT",
+ "repository": {
+ "type": "git",
+ "url": "git+https://github.com/mob-sakai/UIEffect.git"
+ },
+ "author": {
+ "name": "mob-sakai",
+ "email": "sakai861104@gmail.com",
+ "url": "https://github.com/mob-sakai"
+ },
+ "dependencies": {
+ "com.coffee.ui-effect": "5.11.9",
+ "com.unity.modules.animation": "1.0.0"
+ },
+ "keywords": [
+ "ui",
+ "effect"
+ ]
+}
diff --git a/Packages/src/Samples~/com.coffee.ui-effect.v4-compatible-components/package.json.meta b/Packages/src/Samples~/com.coffee.ui-effect.v4-compatible-components/package.json.meta
new file mode 100644
index 0000000..d12198a
--- /dev/null
+++ b/Packages/src/Samples~/com.coffee.ui-effect.v4-compatible-components/package.json.meta
@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: ba5e37d9f990b4856ad9e2d940318ec9
+TextScriptImporter:
+ externalObjects: {}
+ userData:
+ assetBundleName:
+ assetBundleVariant:
diff --git a/Packages/src/Samples~/sync-sample-package-versions.js b/Packages/src/Samples~/sync-sample-package-versions.js
new file mode 100644
index 0000000..fd203c2
--- /dev/null
+++ b/Packages/src/Samples~/sync-sample-package-versions.js
@@ -0,0 +1,38 @@
+const fs = require("node:fs");
+const path = require("node:path");
+const version = process.argv[2];
+
+if (!version) {
+ throw new Error("Release version must be specified.");
+}
+
+// Find package.json files in each sample directory.
+const packageFiles = fs
+ .readdirSync("Samples~", { withFileTypes: true })
+ .filter((entry) => entry.isDirectory())
+ .map((entry) => path.join("Samples~", entry.name, "package.json"))
+ .filter((filePath) => fs.existsSync(filePath));
+
+// Update each sample package version and internal package dependencies to the release version.
+for (const filePath of packageFiles) {
+ const packageJson = JSON.parse(fs.readFileSync(filePath, "utf8"));
+
+ // Update the package version to the release version.
+ let changed = packageJson.version !== version;
+ packageJson.version = version;
+
+ // Update internal package dependencies to the same release version.
+ if (packageJson.dependencies !== undefined) {
+ for (const dependencyName of Object.keys(packageJson.dependencies)) {
+ if (dependencyName.startsWith("com.coffee.ui-effect") && packageJson.dependencies[dependencyName] !== version) {
+ packageJson.dependencies[dependencyName] = version;
+ changed = true;
+ }
+ }
+ }
+
+ // Write only when the package version or an internal dependency changed.
+ if (changed) {
+ fs.writeFileSync(filePath, `${JSON.stringify(packageJson, null, 2)}\n`);
+ }
+}