Skip to content

Commit 7456b5d

Browse files
mob-sakaimob-sakai
committed
docs: update documents
1 parent 9955eef commit 7456b5d

File tree

11 files changed

+204
-83
lines changed

11 files changed

+204
-83
lines changed

‎.github/CODEOWNERS‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# This is a comment.
2+
# Each line is a file pattern followed by one or more owners.
3+
# https://docs.github.com/ja/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
4+
5+
# Default owners
6+
* @mob-sakai

‎.github/FUNDING.yml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# These are supported funding model platforms
2+
3+
github: mob-sakai # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4+
patreon: mob_sakai # Replace with a single Patreon username
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9+
liberapay: # Replace with a single Liberapay username
10+
issuehunt: # Replace with a single IssueHunt username
11+
otechie: # Replace with a single Otechie username
12+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: mob-sakai
7+
8+
---
9+
10+
NOTE: Your issue may already be reported! Please search on the [issue tracker](../) before creating one.
11+
12+
**Describe the bug**
13+
A clear and concise description of what the bug is.
14+
15+
**To Reproduce**
16+
Steps to reproduce the behavior:
17+
1. Go to '...'
18+
2. Click on '....'
19+
3. Scroll down to '....'
20+
4. See error
21+
22+
**Expected behavior**
23+
A clear and concise description of what you expected to happen.
24+
25+
**Screenshots**
26+
If applicable, add screenshots to help explain your problem.
27+
28+
**Environment (please complete the following information):**
29+
- Version [e.g. 1.0.0]
30+
- Platform: [e.g. Editor(Windows/Mac), Standalone(Windows/Mac), iOS, Android, WebGL]
31+
- Unity version: [e.g. 2018.2.8f1]
32+
- Build options: [e.g. IL2CPP, .Net 4.x, LWRP]
33+
34+
**Additional context**
35+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: mob-sakai
7+
8+
---
9+
10+
NOTE: Your issue may already be reported! Please search on the [issue tracker](../) before creating one.
11+
12+
**Is your feature request related to a problem? Please describe.**
13+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
14+
15+
**Describe the solution you'd like**
16+
A clear and concise description of what you want to happen.
17+
18+
**Describe alternatives you've considered**
19+
A clear and concise description of any alternative solutions or features you've considered.
20+
21+
**Additional context**
22+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Question
3+
about: Ask a question about this project
4+
title: ''
5+
labels: question
6+
assignees: mob-sakai
7+
8+
---
9+
10+
NOTE: Your issue may already be reported! Please search on the [issue tracker](../) before creating one.
11+
12+
**Describe what help do you need**
13+
A description of the question.
14+
15+
**Additional context**
16+
Add any other context or screenshots about the question here.

‎.github/pull_request_template.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
2+
# Pull Request Template
3+
4+
## Description
5+
6+
- Please include a summary of the change and which issue is fixed.
7+
- Please also include relevant motivation and context.
8+
- List any dependencies that are required for this change.
9+
10+
Fixes #{issue_number}
11+
12+
## Type of change
13+
14+
Please write the commit message in the format corresponding to the change type.
15+
Please see [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for more information.
16+
17+
- [ ] Bug fix (non-breaking change which fixes an issue)
18+
- [ ] New feature (non-breaking change which adds functionality)
19+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
20+
- [ ] Update documentations
21+
- [ ] Others (refactoring, style changes, etc.)
22+
23+
## Test environment
24+
25+
- Platform: [e.g. Editor(Windows/Mac), Standalone(Windows/Mac), iOS, Android, WebGL]
26+
- Unity version: [e.g. 2022.2.0f1]
27+
- Build options: [e.g. IL2CPP, .Net 4.x, URP/HDRP]
28+
29+
## Checklist
30+
31+
- [ ] This pull request is for merging into the `develop` branch
32+
- [ ] My code follows the style guidelines of this project
33+
- [ ] I have performed a self-review of my own code
34+
- [ ] I have commented my code, particularly in hard-to-understand areas
35+
- [ ] I have made corresponding changes to the documentation
36+
- [ ] My changes generate no new warnings
37+
- [ ] I have checked my code and corrected any misspellings

‎.github/workflows/deploy.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: 🚀 Deploy with Zip
2+
3+
on:
4+
workflow_dispatch:
5+
inputs:
6+
zip:
7+
description: "The url to the zip file"
8+
required: true
9+
10+
jobs:
11+
deploy:
12+
name: 🚀 Deploy
13+
runs-on: ubuntu-latest
14+
permissions:
15+
pages: write
16+
id-token: write
17+
steps:
18+
- name: 📦 Download zip file To '_site'
19+
run: |
20+
curl -L ${{ github.event.inputs.zip }} -o _site.zip
21+
unzip _site.zip -d _site
22+
find _site -name __MACOSX | xargs rm -rf
23+
24+
- name: 📦 Upload '_site'
25+
uses: actions/upload-pages-artifact@v3
26+
27+
- name: 🚀 Deploy To GitHub Pages
28+
uses: actions/deploy-pages@v4

‎.github/workflows/release.yml‎

Lines changed: 4 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ on:
55
workflow_dispatch:
66
push:
77
branches:
8-
- release
9-
- release-*
8+
- preview
9+
- main
10+
- v*.x
1011
tags-ignore:
1112
- "**"
1213

@@ -22,9 +23,6 @@ jobs:
2223
channel: ${{ steps.release.outputs.new_release_channel }}
2324
released: ${{ steps.release.outputs.new_release_published }}
2425
tag: ${{ steps.release.outputs.new_release_git_tag }}
25-
version: ${{ steps.release.outputs.new_release_version }}
26-
merge_to: ${{ steps.summary.outputs.merge_to }}
27-
split_to: ${{ steps.summary.outputs.split_to }}
2826
steps:
2927
- name: 🚚 Checkout (${{ github.ref_name }})
3028
uses: actions/checkout@v4
@@ -40,62 +38,7 @@ jobs:
4038
env:
4139
GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
4240

43-
- id: summary
44-
run: |
41+
- run: |
4542
echo "🔖 New release published: '${{ steps.release.outputs.new_release_published }}'" | tee -a $GITHUB_STEP_SUMMARY
46-
echo "🔖 New release version: '${{ steps.release.outputs.new_release_version }}'" | tee -a $GITHUB_STEP_SUMMARY
4743
echo "🔖 New release channel: '${{ steps.release.outputs.new_release_channel }}'" | tee -a $GITHUB_STEP_SUMMARY
4844
echo "🔖 New release git tag: '${{ steps.release.outputs.new_release_git_tag }}'" | tee -a $GITHUB_STEP_SUMMARY
49-
50-
if [ '${{ steps.release.outputs.new_release_published }}' = 'false' ]; then
51-
echo "No new release published." | tee -a $GITHUB_STEP_SUMMARY
52-
elif [ '${{ github.ref_name }}' = 'release' ]; then
53-
echo "merge_to=develop" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
54-
echo "split_to=main" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
55-
else
56-
channel=$(echo ${{ github.ref_name }} | sed 's/^release-//')
57-
echo "merge_to=develop-${channel}" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
58-
echo "split_to=${channel}" | tee -a $GITHUB_OUTPUT $GITHUB_STEP_SUMMARY
59-
fi
60-
61-
merge-to:
62-
if: needs.release.outputs.merge_to != ''
63-
needs: release
64-
name: 🔀 Merge to ${{ needs.release.outputs.merge_to }}
65-
runs-on: ubuntu-latest
66-
permissions:
67-
contents: write
68-
steps:
69-
- name: 🚚 Checkout (${{ needs.release.outputs.merge_to }})
70-
uses: actions/checkout@v4
71-
with:
72-
ref: ${{ needs.release.outputs.merge_to }}
73-
fetch-depth: 0
74-
- name: 🔀 Merge '${{ needs.release.outputs.tag }}' into '${{ needs.release.outputs.merge_to }}'
75-
run: |
76-
git config --local user.email "github-actions[bot]@users.noreply.github.com"
77-
git config --local user.name "github-actions[bot]"
78-
79-
git merge ${{ needs.release.outputs.tag }}
80-
git push origin ${{ needs.release.outputs.merge_to }}
81-
82-
split-to:
83-
if: needs.release.outputs.split_to != ''
84-
needs: release
85-
name: 🔀 Split package to ${{ needs.release.outputs.split_to }}
86-
runs-on: ubuntu-latest
87-
permissions:
88-
contents: write
89-
steps:
90-
- name: 🚚 Checkout (${{ needs.release.outputs.tag }})
91-
uses: actions/checkout@v4
92-
with:
93-
ref: ${{ needs.release.outputs.tag }}
94-
fetch-depth: 0
95-
- name: 🔀 Split subtree 'Packages/src' to '${{ needs.release.outputs.split_to }}'
96-
run: |
97-
split_to=${{ needs.release.outputs.split_to }}
98-
git branch $split_to origin/$split_to
99-
git subtree split --prefix=Packages/src --branch $split_to
100-
git tag ${{ needs.release.outputs.version }} $split_to
101-
git push origin ${{ needs.release.outputs.version }} $split_to:$split_to

‎Packages/src/.releaserc.json‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
{
22
"branches": [
3-
"release",
4-
"release-4.x",
3+
"main",
4+
"[0-9]+.x",
55
{
6-
"name": "release-preview",
7-
"prerelease": "preview"
6+
"name": "preview",
7+
"prerelease": true
88
}
99
],
10+
"tagFormat": "${version}",
1011
"plugins": [
1112
"@semantic-release/commit-analyzer",
1213
"@semantic-release/release-notes-generator",

‎Packages/src/README.md‎

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# <img alt="UIParticleIcon" src="https://github.com/mob-sakai/ParticleEffectForUGUI/assets/12690315/d76e105e-a840-4f61-a1f6-8cf311c0812d" width="26"/> Particle Effect For UGUI (UI Particle) <!-- omit in toc -->
1+
# <img alt="UIParticleIcon" src="https://github.com/mob-sakai/ParticleEffectForUGUI/assets/12690315/d76e105e-a840-4f61-a1f6-8cf311c0812d" width="26"/> UI Particle v5 <!-- omit in toc -->
22

33
[![](https://img.shields.io/npm/v/com.coffee.ui-particle?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.coffee.ui-particle/)
44
[![](https://img.shields.io/github/v/release/mob-sakai/ParticleEffectForUGUI)](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
55
[![](https://img.shields.io/github/license/mob-sakai/ParticleEffectForUGUI.svg)](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/main/LICENSE.md)
6-
![](https://img.shields.io/badge/Unity-2018.2+-57b9d3.svg?style=flat&logo=unity)
6+
![](https://img.shields.io/badge/Unity-2019.3+-57b9d3.svg?style=flat&logo=unity)
77
![](https://img.shields.io/badge/uGUI_2.0_Ready-57b9d3.svg?style=flat)
88
![](https://img.shields.io/badge/UPR%2FHDPR_Ready-57b9d3.svg?style=flat)
99
![](https://github.com/mob-sakai/ParticleEffectForUGUI/actions/workflows/test.yml/badge.svg?branch=develop)
1010
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](http://makeapullrequest.com)
1111
[![](https://img.shields.io/github/watchers/mob-sakai/ParticleEffectForUGUI.svg?style=social&label=Watch)](https://github.com/mob-sakai/ParticleEffectForUGUI/subscription)
1212
[![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai)
1313

14-
<< [📝 Description](#-description-) | [📌 Key Features](#-key-features) | [🎮 Demo](#-demo) | [⚙ Installation](#-installation) | [🚀 Usage](#-usage) | [🛠 Development Note](#-development-note) | [🤝 Contributing](#-contributing) >>
14+
<< [📝 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) >>
1515

1616
## 📝 Description <!-- omit in toc -->
1717

@@ -26,7 +26,9 @@ You can render, mask, and sort your `ParticleSystems` for UI without the need fo
2626
- [Install via OpenUPM](#install-via-openupm)
2727
- [Install via UPM (with Package Manager UI)](#install-via-upm-with-package-manager-ui)
2828
- [Install via UPM (Manually)](#install-via-upm-manually)
29-
- [Install as Embedded Package](#install-as-embedded-package)
29+
- [Install as Embedded Package](#install-as-embedded-package)
30+
- [🔄 Upgrading from v3/v4 to v5](#-upgrading-from-v3v4-to-v5)
31+
- [Breaking Changes](#breaking-changes)
3032
- [🚀 Usage](#-usage)
3133
- [Component: UIParticle](#component-uiparticle)
3234
- [Basic Usage](#basic-usage)
@@ -104,7 +106,7 @@ You can render, mask, and sort your `ParticleSystems` for UI without the need fo
104106

105107
## ⚙ Installation
106108

107-
_This package requires **Unity 2018.3 or later**._
109+
_This package requires **Unity 2019.3 or later**._
108110

109111
#### Install via OpenUPM
110112

@@ -116,39 +118,58 @@ _This package requires **Unity 2018.3 or later**._
116118
```
117119
- To update the package, use Package Manager UI (`Window > Package Manager`) or run the following command with `@{version}`:
118120
```
119-
openupm add com.coffee.ui-particle@4.9.0
121+
openupm add com.coffee.ui-particle@5.0.0
120122
```
121123

122124
#### Install via UPM (with Package Manager UI)
123125

124126
- Click `Window > Package Manager` to open Package Manager UI.
125-
- Click `+ > Add package from git URL...` and input the repository URL: `https://github.com/mob-sakai/ParticleEffectForUGUI.git`
127+
- Click `+ > Add package from git URL...` and input the repository URL: `https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src`
126128
![](https://github.com/user-attachments/assets/f88f47ad-c606-44bd-9e86-ee3f72eac548)
127129
- To update the package, change suffix `#{version}` to the target version.
128-
- e.g. `https://github.com/mob-sakai/ParticleEffectForUGUI.git#4.9.0`
130+
- e.g. `https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src#5.0.0`
129131

130132
#### Install via UPM (Manually)
131133

132134
- Open the `Packages/manifest.json` file in your project. Then add this package somewhere in the `dependencies` block:
133135
```json
134136
{
135137
"dependencies": {
136-
"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git",
138+
"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src",
137139
...
138140
}
139141
}
140142
```
141143

142144
- To update the package, change suffix `#{version}` to the target version.
143-
- e.g. `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#4.9.0",`
145+
- e.g. `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src#5.0.0",`
144146

145-
#### Install as Embedded Package
147+
### Install as Embedded Package
146148

147-
1. Download a source code zip file from [Releases](https://github.com/mob-sakai/ParticleEffectForUGUI.git/releases) and extract it.
148-
2. Place it in your project's `Packages` directory.
149-
![](https://github.com/mob-sakai/mob-sakai/assets/12690315/0b7484b4-5fca-43b0-a9ef-e5dbd99bcdb4)
150-
- If you want to fix bugs or add features, install it as an embedded package.
151-
- To update the package, you need to re-download it and replace the contents.
149+
1. Download the `Source code (zip)` file from [Releases](https://github.com/mob-sakai/SoftMaskForUGUI/releases) and
150+
extract it.
151+
2. Move the `<extracted_dir>/Packages/src` directory into your project's `Packages` directory.
152+
![](https://github.com/user-attachments/assets/187cbcbe-5922-4ed5-acec-cf19aa17d208)
153+
- You can rename the `src` directory if needed.
154+
- If you intend to fix bugs or add features, installing it as an embedded package is recommended.
155+
- To update the package, re-download it and replace the existing contents.
156+
157+
<br><br>
158+
159+
## 🔄 Upgrading from v3/v4 to v5
160+
161+
### Breaking Changes
162+
163+
- The default value of `UIParticle.scale` has been changed from `10` to `1`.
164+
- `UIParticle` no longer inherits from `MaskableGraphic`.
165+
- If you are installing via git URL, add `?path=Packages/src`.
166+
```json
167+
// v3/v4
168+
"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git",
169+
170+
// v5
171+
"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git?path=Packages/src",
172+
```
152173

153174
<br><br>
154175

0 commit comments

Comments
 (0)