diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
new file mode 100644
index 0000000..2ecc390
--- /dev/null
+++ b/.github/CODEOWNERS
@@ -0,0 +1,6 @@
+# This is a comment.
+# Each line is a file pattern followed by one or more owners.
+# https://docs.github.com/ja/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+
+# Default owners
+* @mob-sakai
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
new file mode 100644
index 0000000..b8d0037
--- /dev/null
+++ b/.github/FUNDING.yml
@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: mob-sakai # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: mob_sakai # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..6e2802e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: mob-sakai
+
+---
+
+NOTE: Your issue may already be reported! Please search on the [issue tracker](../) before creating one.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - Version [e.g. 1.0.0]
+ - Platform: [e.g. Editor(Windows/Mac), Standalone(Windows/Mac), iOS, Android, WebGL]
+ - Unity version: [e.g. 2018.2.8f1]
+ - Build options: [e.g. IL2CPP, .Net 4.x, LWRP]
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..e55417e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: mob-sakai
+
+---
+
+NOTE: Your issue may already be reported! Please search on the [issue tracker](../) before creating one.
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 0000000..8fa7151
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,16 @@
+---
+name: Question
+about: Ask a question about this project
+title: ''
+labels: question
+assignees: mob-sakai
+
+---
+
+NOTE: Your issue may already be reported! Please search on the [issue tracker](../) before creating one.
+
+**Describe what help do you need**
+A description of the question.
+
+**Additional context**
+Add any other context or screenshots about the question here.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..381c56f
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,37 @@
+
+# Pull Request Template
+
+## Description
+
+- Please include a summary of the change and which issue is fixed.
+- Please also include relevant motivation and context.
+- List any dependencies that are required for this change.
+
+Fixes #{issue_number}
+
+## Type of change
+
+Please write the commit message in the format corresponding to the change type.
+Please see [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more information.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Update documentations
+- [ ] Others (refactoring, style changes, etc.)
+
+## Test environment
+
+- Platform: [e.g. Editor(Windows/Mac), Standalone(Windows/Mac), iOS, Android, WebGL]
+- Unity version: [e.g. 2022.2.0f1]
+- Build options: [e.g. IL2CPP, .Net 4.x, URP/HDRP]
+
+## Checklist
+
+- [ ] This pull request is for merging into the `develop` branch
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have checked my code and corrected any misspellings
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
new file mode 100644
index 0000000..4602417
--- /dev/null
+++ b/.github/workflows/deploy.yml
@@ -0,0 +1,28 @@
+name: 🚀 Deploy with Zip
+
+on:
+ workflow_dispatch:
+ inputs:
+ zip:
+ description: "The url to the zip file"
+ required: true
+
+jobs:
+ deploy:
+ name: 🚀 Deploy
+ runs-on: ubuntu-latest
+ permissions:
+ pages: write
+ id-token: write
+ steps:
+ - name: 📦 Download zip file To '_site'
+ run: |
+ curl -L ${{ github.event.inputs.zip }} -o _site.zip
+ unzip _site.zip -d _site
+ find _site -name __MACOSX | xargs rm -rf
+
+ - name: 📦 Upload '_site'
+ uses: actions/upload-pages-artifact@v3
+
+ - name: 🚀 Deploy To GitHub Pages
+ uses: actions/deploy-pages@v4
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index b823378..8b97d60 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -5,8 +5,9 @@ on:
workflow_dispatch:
push:
branches:
- - release
- - release-*
+ - preview
+ - main
+ - v*.x
tags-ignore:
- "**"
@@ -22,9 +23,6 @@ jobs:
channel: ${{ steps.release.outputs.new_release_channel }}
released: ${{ steps.release.outputs.new_release_published }}
tag: ${{ steps.release.outputs.new_release_git_tag }}
- version: ${{ steps.release.outputs.new_release_version }}
- merge_to: ${{ steps.summary.outputs.merge_to }}
- split_to: ${{ steps.summary.outputs.split_to }}
steps:
- name: 🚚 Checkout (${{ github.ref_name }})
uses: actions/checkout@v4
@@ -40,62 +38,7 @@ jobs:
env:
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
- - id: summary
- run: |
+ - run: |
echo "🔖 New release published: '${{ steps.release.outputs.new_release_published }}'" | tee -a $GITHUB_STEP_SUMMARY
- echo "🔖 New release version: '${{ steps.release.outputs.new_release_version }}'" | tee -a $GITHUB_STEP_SUMMARY
echo "🔖 New release channel: '${{ steps.release.outputs.new_release_channel }}'" | tee -a $GITHUB_STEP_SUMMARY
echo "🔖 New release git tag: '${{ steps.release.outputs.new_release_git_tag }}'" | tee -a $GITHUB_STEP_SUMMARY
-
- if [ '${{ steps.release.outputs.new_release_published }}' = 'false' ]; then
- echo "No new release published." | tee -a $GITHUB_STEP_SUMMARY
- elif [ '${{ github.ref_name }}' = 'release' ]; then
- echo "merge_to=develop" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
- echo "split_to=main" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
- else
- channel=$(echo ${{ github.ref_name }} | sed 's/^release-//')
- echo "merge_to=develop-${channel}" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
- echo "split_to=${channel}" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
- fi
-
- merge-to:
- if: needs.release.outputs.merge_to != ''
- needs: release
- name: 🔀 Merge to ${{ needs.release.outputs.merge_to }}
- runs-on: ubuntu-latest
- permissions:
- contents: write
- steps:
- - name: 🚚 Checkout (${{ needs.release.outputs.merge_to }})
- uses: actions/checkout@v4
- with:
- ref: ${{ needs.release.outputs.merge_to }}
- fetch-depth: 0
- - name: 🔀 Merge '${{ needs.release.outputs.tag }}' into '${{ needs.release.outputs.merge_to }}'
- run: |
- git config --local user.email "github-actions[bot]@users.noreply.github.com"
- git config --local user.name "github-actions[bot]"
-
- git merge ${{ needs.release.outputs.tag }}
- git push origin ${{ needs.release.outputs.merge_to }}
-
- split-to:
- if: needs.release.outputs.split_to != ''
- needs: release
- name: 🔀 Split package to ${{ needs.release.outputs.split_to }}
- runs-on: ubuntu-latest
- permissions:
- contents: write
- steps:
- - name: 🚚 Checkout (${{ needs.release.outputs.tag }})
- uses: actions/checkout@v4
- with:
- ref: ${{ needs.release.outputs.tag }}
- fetch-depth: 0
- - name: 🔀 Split subtree 'Packages/src' to '${{ needs.release.outputs.split_to }}'
- run: |
- split_to=${{ needs.release.outputs.split_to }}
- git branch $split_to origin/$split_to
- git subtree split --prefix=Packages/src --branch $split_to
- git tag ${{ needs.release.outputs.version }} $split_to
- git push origin ${{ needs.release.outputs.version }} $split_to:$split_to
diff --git a/Packages/src/.releaserc.json b/Packages/src/.releaserc.json
index 7ea04ae..5095173 100644
--- a/Packages/src/.releaserc.json
+++ b/Packages/src/.releaserc.json
@@ -1,12 +1,13 @@
{
"branches": [
- "release",
- "release-4.x",
+ "main",
+ "[0-9]+.x",
{
- "name": "release-preview",
- "prerelease": "preview"
+ "name": "preview",
+ "prerelease": true
}
],
+ "tagFormat": "${version}",
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
diff --git a/Packages/src/README.md b/Packages/src/README.md
index beb1a63..4a6081d 100644
--- a/Packages/src/README.md
+++ b/Packages/src/README.md
@@ -1,9 +1,9 @@
-# 
Particle Effect For UGUI (UI Particle)
+# UI Particle v5
[](https://openupm.com/packages/com.coffee.ui-particle/)
[](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
[](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/main/LICENSE.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
@@ -26,7 +26,9 @@ You can render, mask, and sort your `ParticleSystems` for UI without the need fo
- [Install via OpenUPM](#install-via-openupm)
- [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)
+ - [Install as Embedded Package](#install-as-embedded-package)
+- [🔄 Upgrading from v3/v4 to v5](#-upgrading-from-v3v4-to-v5)
+ - [Breaking Changes](#breaking-changes)
- [🚀 Usage](#-usage)
- [Component: UIParticle](#component-uiparticle)
- [Basic Usage](#basic-usage)
@@ -104,7 +106,7 @@ You can render, mask, and sort your `ParticleSystems` for UI without the need fo
## ⚙ Installation
-_This package requires **Unity 2018.3 or later**._
+_This package requires **Unity 2019.3 or later**._
#### Install via OpenUPM
@@ -116,16 +118,16 @@ _This package requires **Unity 2018.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-particle@4.9.0
+ openupm add com.coffee.ui-particle@5.0.0
```
#### Install via UPM (with Package Manager UI)
- Click `Window > Package Manager` to open Package Manager UI.
-- Click `+ > Add package from git URL...` and input the repository URL: `https://github.com/mob-sakai/ParticleEffectForUGUI.git`
+- Click `+ > Add package from git URL...` and input the repository URL: `https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src`
- To update the package, change suffix `#{version}` to the target version.
- - e.g. `https://github.com/mob-sakai/ParticleEffectForUGUI.git#4.9.0`
+ - e.g. `https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src#5.0.0`
#### Install via UPM (Manually)
@@ -133,22 +135,41 @@ _This package requires **Unity 2018.3 or later**._
```json
{
"dependencies": {
- "com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git",
+ "com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src",
...
}
}
```
- To update the package, change suffix `#{version}` to the target version.
- - e.g. `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#4.9.0",`
+ - e.g. `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src#5.0.0",`
-#### Install as Embedded Package
+### Install as Embedded Package
-1. Download a source code zip file from [Releases](https://github.com/mob-sakai/ParticleEffectForUGUI.git/releases) and extract it.
-2. Place it in your project's `Packages` directory.
- 
-- If you want to fix bugs or add features, install it as an embedded package.
-- To update the package, you need to re-download it and replace the contents.
+1. Download the `Source code (zip)` file from [Releases](https://github.com/mob-sakai/SoftMaskForUGUI/releases) and
+ extract it.
+2. Move the `/Packages/src` directory into your project's `Packages` directory.
+ 
+ - You can rename the `src` directory if needed.
+ - If you intend to fix bugs or add features, installing it as an embedded package is recommended.
+ - To update the package, re-download it and replace the existing contents.
+
+
+
+## 🔄 Upgrading from v3/v4 to v5
+
+### Breaking Changes
+
+- The default value of `UIParticle.scale` has been changed from `10` to `1`.
+- `UIParticle` no longer inherits from `MaskableGraphic`.
+- If you are installing via git URL, add `?path=Packages/src`.
+ ```json
+ // v3/v4
+ "com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git",
+
+ // v5
+ "com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src",
+ ```
diff --git a/Packages/src/package.json b/Packages/src/package.json
index d062142..ba7336f 100644
--- a/Packages/src/package.json
+++ b/Packages/src/package.json
@@ -2,8 +2,8 @@
"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.5",
- "unity": "2018.2",
+ "version": "5.0.0-preview.0",
+ "unity": "2019.3",
"license": "MIT",
"repository": {
"type": "git",