Add 'Packages/src/' from commit '32b93d3eeb52c6471244c324d0a6572b756c561a'

git-subtree-dir: Packages/src
git-subtree-mainline: 2aa8d41950
git-subtree-split: 32b93d3eeb

.editorconfig

@@ -0,0 +1,208 @@
+root = true
+
+[*.json]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.asmdef]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+# C# files
+[*.cs]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+csharp_style_implicit_object_creation_when_type_is_apparent = false
+resharper_object_creation_when_type_evident = explicitly_typed
+
+# Keep
+csharp_keep_existing_attribute_arrangement = true
+csharp_keep_existing_embedded_arrangement = true
+csharp_keep_user_linebreaks = true
+csharp_keep_existing_linebreaks = true
+csharp_place_simple_embedded_statement_on_same_line = false
+csharp_place_simple_blocks_on_single_line = false
+csharp_keep_existing_initializer_arrangement = true
+csharp_keep_existing_arrangement = true
+
+# Standard properties
+end_of_line = lf
+insert_final_newline = true
+
+# Brace preferences
+csharp_brace_style = next_line
+csharp_braces_for_ifelse = required_for_multiline_statement
+csharp_braces_for_for = required
+csharp_braces_for_foreach = required
+csharp_braces_for_while = required
+csharp_braces_for_dowhile = required
+csharp_braces_for_using = required
+csharp_case_block_braces = next_line
+csharp_initializer_braces = next_line
+
+# New line preferences
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = false
+csharp_indent_switch_labels = true
+csharp_indent_labels = one_less_than_current
+
+# Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+
+# avoid this. unless absolutely necessary
+dotnet_style_qualification_for_field = false:suggestion
+dotnet_style_qualification_for_property = false:suggestion
+dotnet_style_qualification_for_method = false:suggestion
+dotnet_style_qualification_for_event = false:suggestion
+
+# Types: use keywords instead of BCL types, and permit var only when the type is clear
+csharp_style_var_for_built_in_types = true:suggestion
+csharp_style_var_when_type_is_apparent = true:none
+csharp_style_var_elsewhere = true:suggestion
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
+dotnet_style_predefined_type_for_member_access = true:suggestion
+
+# Arguments
+csharp_arguments_literal = named:suggestion
+csharp_arguments_string_literal = named:suggestion
+
+# Naming: public and protected fields -> camelCase
+dotnet_naming_rule.protected_public_fields.severity = suggestion
+dotnet_naming_rule.protected_public_fields.symbols = protected_public_fields
+dotnet_naming_rule.protected_public_fields.style = camel_case
+dotnet_naming_symbols.protected_public_fields.applicable_kinds = field, event
+dotnet_naming_symbols.protected_public_fields.applicable_accessibilities = public, protected
+dotnet_naming_style.camel_case.capitalization = camel_case
+
+# Naming: properties -> camelCase
+dotnet_naming_rule.properties.severity = suggestion
+dotnet_naming_rule.properties.symbols = properties
+dotnet_naming_rule.properties.style = camel_case
+dotnet_naming_symbols.properties.applicable_kinds = property
+
+# Naming: constant fields -> k_PascalCase
+dotnet_naming_rule.constant_fields.severity = suggestion
+dotnet_naming_rule.constant_fields.symbols = constant_fields
+dotnet_naming_rule.constant_fields.style = k_pascal_case
+dotnet_naming_symbols.constant_fields.applicable_kinds = field
+dotnet_naming_symbols.constant_fields.required_modifiers = const
+dotnet_naming_style.k_pascal_case.required_prefix = k_
+dotnet_naming_style.k_pascal_case.capitalization = pascal_case
+
+# Naming: static fields -> s_PascalCase
+dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
+dotnet_naming_rule.static_fields_should_have_prefix.symbols = static_fields
+dotnet_naming_rule.static_fields_should_have_prefix.style = s_pascal_case
+dotnet_naming_symbols.static_fields.applicable_kinds = field, property
+dotnet_naming_symbols.static_fields.required_modifiers = static
+dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
+dotnet_naming_style.s_pascal_case.required_prefix = s_
+dotnet_naming_style.s_pascal_case.capitalization = pascal_case
+
+# Naming: internal and private fields -> _camelCase
+dotnet_naming_rule.private_internal_fields.severity = suggestion
+dotnet_naming_rule.private_internal_fields.symbols = private_internal_fields
+dotnet_naming_rule.private_internal_fields.style = _camel_case
+dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
+dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
+dotnet_naming_style._camel_case.required_prefix = _
+dotnet_naming_style._camel_case.capitalization = camel_case
+
+# Code style defaults
+dotnet_sort_system_directives_first = true
+csharp_preserve_single_line_statements = false:none
+csharp_prefer_static_local_function = true:suggestion
+csharp_prefer_simple_using_statement = false:none
+csharp_style_prefer_switch_expression = true:suggestion
+dotnet_style_readonly_field = true:suggestion
+
+# Expression-level preferences
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+csharp_prefer_simple_default_expression = true:suggestion
+
+# Expression-bodied members
+csharp_style_expression_bodied_accessors = when_on_single_line:suggestion
+csharp_style_expression_bodied_methods = false:suggestion
+csharp_style_expression_bodied_constructors = false:suggestion
+csharp_style_expression_bodied_operators = false:suggestion
+csharp_style_expression_bodied_properties = when_on_single_line:suggestion
+csharp_style_expression_bodied_indexers = false:suggestion
+csharp_style_expression_bodied_lambdas = when_on_single_line:silent
+csharp_style_expression_bodied_local_functions = false:suggestion
+
+# Pattern matching
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+
+# Null checking preferences
+csharp_style_throw_expression = true:suggestion
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Other features
+csharp_style_prefer_index_operator = false:none
+csharp_style_prefer_range_operator = false:none
+csharp_style_pattern_local_over_anonymous_function = false:none
+
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = do_not_ignore
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+# ReSharper inspection severities
+resharper_check_namespace_highlighting = none
+resharper_for_can_be_converted_to_foreach_highlighting = none
+resharper_xmldoc_indent_text = ZeroIndent

.github/ISSUE_TEMPLATE/bug_report.md

@@ -10,39 +10,26 @@ 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)**
-
-- Package version [e.g. 4.2.0, 3.3.14]
-- Platform: [e.g. Editor(Windows/Mac), Standalone(Windows/Mac), iOS, Android, WebGL]
-- Unity version: [e.g. 2021.3.7f1]
-- Project options: [e.g. Mono/IL2CPP, .Net Standard 2.1/.Net 4.x, URP/HDRP, GraphicAPIs]
+**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**
-
-Please add any other context about the issue here.
-It will help us resolve the issue.
-
-- Error messages and crash dump
-- Screenshots, gif animations and movie files
-- Reproducible minimal project
-    - The entire project (zipped Assets, Packages, ProjectSettings) is preferred over `.unitypackage`
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -10,17 +10,13 @@ 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 issue is. (e.g. I'm always frustrated when [...])
+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.

.github/pull_request_template.md

@@ -0,0 +1,9 @@
+---
+name: Pull Request
+about: Create a pull request
+title: ''
+assignees: mob-sakai
+
+---
+
+**NOTE: Create a pull request to merge into `develop` branch**

.gitignore

@@ -0,0 +1,30 @@
+# Windows
+Thumbs.db
+Desktop.ini
+/*.csproj
+/*.sln
+
+# macOS
+.DS_Store
+
+# Vim
+*.swp
+
+# Unity
+/Logs
+/Library
+/Temp
+Assets/Plugins.meta
+Assets/JMO Assets.meta
+Assets/JMO Assets
+Assets/EffectExamples/
+Assets/EffectExamples.meta
+Assets/Plugins/
+
+# VS
+.vs/
+.vscode/
+.idea/
+obj/
+bin/
+UserSettings/

Assets/Samples

@@ -0,0 +1 @@
+../Packages/src/Samples~

Assets/Samples.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 2132c9464acf94912a959f8cc6a68fa6
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/Tests.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: 57d832714402a4bc5a0ed550741823ad
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/Tests/Coffee.UIParticle.Tests.asmdef

@@ -0,0 +1,16 @@
+{
+    "name": "Coffee.UIParticle.Tests",
+    "references": [
+        "Coffee.UIParticle"
+    ],
+    "optionalUnityReferences": [
+        "TestAssemblies"
+    ],
+    "includePlatforms": [],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": false,
+    "defineConstraints": []
+}

Assets/Tests/Coffee.UIParticle.Tests.asmdef.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 0253956e76ec342d49f1377578eb86be
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/Tests/Editor.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2
+guid: c49dbc815ad044a919bd5b7d4e6c59cf
+folderAsset: yes
+DefaultImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/Tests/Editor/Coffee.UIParticle.Editor.Tests.asmdef

@@ -0,0 +1,19 @@
+{
+    "name": "Coffee.UIParticle.Editor.Tests",
+    "references": [
+        "Coffee.UIParticle",
+        "Coffee.UIParticle.Editor"
+    ],
+    "optionalUnityReferences": [
+        "TestAssemblies"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": false,
+    "defineConstraints": []
+}

Assets/Tests/Editor/Coffee.UIParticle.Editor.Tests.asmdef.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 78daa55fa55814a33a3377d6ede8c43d
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/Tests/Editor/NewTestScript.cs

@@ -0,0 +1,26 @@
+using System.Collections;
+using NUnit.Framework;
+using UnityEngine.TestTools;
+
+namespace Coffee.UIParticle.Editor.Tests
+{
+    public class NewTestScript
+    {
+        // A Test behaves as an ordinary method
+        [Test]
+        public void NewTestScriptSimplePasses()
+        {
+            // Use the Assert class to test conditions
+        }
+
+        // A UnityTest behaves like a coroutine in Play Mode. In Edit Mode you can use
+        // `yield return null;` to skip a frame.
+        [UnityTest]
+        public IEnumerator NewTestScriptWithEnumeratorPasses()
+        {
+            // Use the Assert class to test conditions.
+            // Use yield to skip a frame.
+            yield return null;
+        }
+    }
+}

Assets/Tests/Editor/NewTestScript.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 5623180b85e024006b9a6772c3f241c5
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Assets/Tests/NewTestScript.cs

@@ -0,0 +1,26 @@
+using System.Collections;
+using NUnit.Framework;
+using UnityEngine.TestTools;
+
+namespace Coffee.UIParticle.Tests
+{
+    public class NewTestScript
+    {
+        // A Test behaves as an ordinary method
+        [Test]
+        public void NewTestScriptSimplePasses()
+        {
+            // Use the Assert class to test conditions
+        }
+
+        // A UnityTest behaves like a coroutine in Play Mode. In Edit Mode you can use
+        // `yield return null;` to skip a frame.
+        [UnityTest]
+        public IEnumerator NewTestScriptWithEnumeratorPasses()
+        {
+            // Use the Assert class to test conditions.
+            // Use yield to skip a frame.
+            yield return null;
+        }
+    }
+}

Assets/Tests/NewTestScript.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: d52f7d64d782c421284267dd1c197210
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

Packages/manifest.json

@@ -0,0 +1,8 @@
+{
+  "dependencies": {
+    "com.unity.ide.rider": "3.0.27",
+    "com.unity.test-framework": "1.1.33",
+    "com.unity.modules.animation": "1.0.0",
+    "com.unity.modules.physics": "1.0.0"
+  }
+}

Packages/packages-lock.json

@@ -0,0 +1,85 @@
+{
+  "dependencies": {
+    "com.coffee.ui-particle": {
+      "version": "file:src",
+      "depth": 0,
+      "source": "embedded",
+      "dependencies": {
+        "com.unity.ugui": "1.0.0",
+        "com.unity.modules.particlesystem": "1.0.0"
+      }
+    },
+    "com.unity.ext.nunit": {
+      "version": "1.0.6",
+      "depth": 1,
+      "source": "registry",
+      "dependencies": {},
+      "url": "https://packages.unity.com"
+    },
+    "com.unity.ide.rider": {
+      "version": "3.0.27",
+      "depth": 0,
+      "source": "registry",
+      "dependencies": {
+        "com.unity.ext.nunit": "1.0.6"
+      },
+      "url": "https://packages.unity.com"
+    },
+    "com.unity.test-framework": {
+      "version": "1.1.33",
+      "depth": 0,
+      "source": "registry",
+      "dependencies": {
+        "com.unity.ext.nunit": "1.0.6",
+        "com.unity.modules.imgui": "1.0.0",
+        "com.unity.modules.jsonserialize": "1.0.0"
+      },
+      "url": "https://packages.unity.com"
+    },
+    "com.unity.ugui": {
+      "version": "1.0.0",
+      "depth": 1,
+      "source": "builtin",
+      "dependencies": {
+        "com.unity.modules.ui": "1.0.0",
+        "com.unity.modules.imgui": "1.0.0"
+      }
+    },
+    "com.unity.modules.animation": {
+      "version": "1.0.0",
+      "depth": 0,
+      "source": "builtin",
+      "dependencies": {}
+    },
+    "com.unity.modules.imgui": {
+      "version": "1.0.0",
+      "depth": 1,
+      "source": "builtin",
+      "dependencies": {}
+    },
+    "com.unity.modules.jsonserialize": {
+      "version": "1.0.0",
+      "depth": 1,
+      "source": "builtin",
+      "dependencies": {}
+    },
+    "com.unity.modules.particlesystem": {
+      "version": "1.0.0",
+      "depth": 1,
+      "source": "builtin",
+      "dependencies": {}
+    },
+    "com.unity.modules.physics": {
+      "version": "1.0.0",
+      "depth": 0,
+      "source": "builtin",
+      "dependencies": {}
+    },
+    "com.unity.modules.ui": {
+      "version": "1.0.0",
+      "depth": 2,
+      "source": "builtin",
+      "dependencies": {}
+    }
+  }
+}

Packages/src/.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']

Packages/src/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,48 @@
+---
+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)**
+
+- Package version [e.g. 4.2.0, 3.3.14]
+- Platform: [e.g. Editor(Windows/Mac), Standalone(Windows/Mac), iOS, Android, WebGL]
+- Unity version: [e.g. 2021.3.7f1]
+- Project options: [e.g. Mono/IL2CPP, .Net Standard 2.1/.Net 4.x, URP/HDRP, GraphicAPIs]
+
+**Additional context**
+
+Please add any other context about the issue here.
+It will help us resolve the issue.
+
+- Error messages and crash dump
+- Screenshots, gif animations and movie files
+- Reproducible minimal project
+    - The entire project (zipped Assets, Packages, ProjectSettings) is preferred over `.unitypackage`

Packages/src/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,26 @@
+---
+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 issue is. (e.g. 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.

Packages/src/.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.

Packages/src/CHANGELOG.md

@@ -1,3 +1,32 @@
+## [4.5.2](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.5.1...4.5.2) (2024-01-18)
+
+
+### Bug Fixes
+
+* (editor) sometimes crashes when entering play mode ([b80c3e6](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/b80c3e6c9fdd2a8fb72ff233edb85df2e3dbba3d))
+
+## [4.5.1](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.5.0...4.5.1) (2023-12-23)
+
+
+### Bug Fixes
+
+* fix material for mesh sharing group ([6126af9](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/6126af9f376dd4c100a1b9d19d9499bdef7d5566))
+* the changes made to the material used by the ParticleSystem are not immediately reflected ([3184ba9](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/3184ba94ae08264223c0c71443ad70acc1a1ccb2)), closes [#280](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/280)
+
+# [4.5.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.4.0...4.5.0) (2023-12-23)
+
+
+### Bug Fixes
+
+* incorrect rendering of world-space simulated particles while animating scale ([ac58475](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/ac584755393d87bda2e80d9653370b7e4c68912f)), closes [#285](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/285)
+* remove obsolete warning ([5d5eb34](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/5d5eb34590b7cefb0e4ac26c0441e104176ce522))
+
+
+### Features
+
+* Automatically generated objects are no longer editable (NotEditable). ([5607dc4](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/5607dc4eed0c086b4651941953df6c7d535712e0))
+* support IMeshModifier ([5c3232f](https://github.com/mob-sakai/ParticleEffectForUGUI/commit/5c3232faf3d2cfad1e3e1a9349b8346c7982a608)), closes [#282](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/282)
+
 # [4.4.0](https://github.com/mob-sakai/ParticleEffectForUGUI/compare/4.3.0...4.4.0) (2023-11-08)
 
 

Packages/src/README.md

@@ -0,0 +1,455 @@
+Particle Effect For UGUI (UI Particle)
+===
+
+This plugin provide a component to render particle effect for uGUI in Unity 2018.2 or later.  
+The particle rendering is maskable and sortable, without Camera, RenderTexture or Canvas.  
+
+![](https://img.shields.io/badge/Editor-2018.2+-4796F2?logo=unity)
+[![](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/)
+[![](https://img.shields.io/github/v/release/mob-sakai/ParticleEffectForUGUI?include_prereleases&sort=semver)](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
+[![](https://img.shields.io/github/v/release/mob-sakai/ParticleEffectForUGUI?include_prereleases&sort=semver&filter=3.%2A&label=release(3.x))](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)
+[![](https://img.shields.io/github/release-date/mob-sakai/ParticleEffectForUGUI.svg)](https://github.com/mob-sakai/ParticleEffectForUGUI/releases)  [![](https://img.shields.io/github/license/mob-sakai/ParticleEffectForUGUI.svg)](https://github.com/mob-sakai/ParticleEffectForUGUI/blob/master/LICENSE.txt)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](http://makeapullrequest.com)
+
+
+<< [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
+
+![](https://user-images.githubusercontent.com/12690315/41771577-8da4b968-7650-11e8-9524-cd162c422d9d.gif)
+
+This plugin uses new APIs `MeshBake/MashTrailBake` (added with Unity 2018.2) to render particles by CanvasRenderer.
+You can mask and sort particles for uGUI without Camera, RenderTexture, Canvas.
+
+Compares this "Baking mesh" approach with the conventional approach:  
+[Performance test results](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/193#issuecomment-1160028374)
+
+|Approach|Good|Bad|Screenshot|
+|-|-|-|-|
+|Baking mesh<br>**\(UIParticle\)**|Rendered as is.<br>Maskable.<br>Sortable.<br>Less objects.|[Not support `TEXCOORD*.zw` components for custom vertex stream](https://github.com/mob-sakai/ParticleEffectForUGUI/issues/191#issuecomment-1043409186)|<img src="https://user-images.githubusercontent.com/12690315/41765089-0302b9a2-763e-11e8-88b3-b6ffa306bbb0.gif" width="500px">|
+|Do nothing|Rendered as is.|**Looks like a glitch.**<br>Not maskable.<br>Not sortable.|<img src="https://user-images.githubusercontent.com/12690315/41765090-0329828a-763e-11e8-8d8a-f1d269ea3bc7.gif" width="500px">|
+|Convert particle to UIVertex<br>[\(UIParticleSystem\)](https://forum.unity.com/threads/free-script-particle-systems-in-ui-screen-space-overlay.406862/)|Maskable.<br>Sortable.<br>Less objects.|**Adjustment is difficult.**<br>Requires UI shaders.<br>Difficult to adjust scale.<br>Force hierarchy scalling.<br>Simulation results are incorrect.<br>Trail, rotation of transform, time scaling are not supported.<br>Generate heavy GC every frame.|<img src="https://user-images.githubusercontent.com/12690315/41765088-02deb9c6-763e-11e8-98d0-9e0c1766ef39.gif" width="500px">|
+|Use Canvas to sort|Rendered as is.<br>Sortable.|**You must to manage sorting orders.**<br>Not maskable.<br>More batches.|<img src="https://user-images.githubusercontent.com/12690315/41765087-02b866ea-763e-11e8-8c33-081c9ad852f8.gif" width="500px">|
+|Use RenderTexture|Maskable.<br>Sortable.|**Requires Camera and RenderTexture.**<br>Difficult to adjust position and size.<br>Quality depends on the RenderTexture's setting.|<img src="https://user-images.githubusercontent.com/12690315/41765085-0291b3e2-763e-11e8-827b-72e5ee9bc556.gif" width="500px">|
+
+|Approach|FPS on Editor|FPS on iPhone6|FPS on Xperia XZ|
+|--|--|--|--|
+|Particle System|43|57|22|
+|UIParticleSystem|4|3|0 (unmeasurable)|
+|Sorting By Canvas|43|44|18|
+|UIParticle|17|12|4|
+|UIParticle with MeshSharing|44|45|30|
+
+<br><br>
+
+#### Features
+
+* Easy to use: the package is out-of-the-box
+* Sort particle effects and UI by sibling index
+* No Camera, RenderTexture or Canvas are required
+* Masking by Mask or RectMask2D
+* Support Trail module
+* Support CanvasGroup alpha
+* No allocations
+* Support overlay, camera space and world space
+* Support Universal Render Pipeline (URP) and High Definition Render Pipeline (HDRP)
+* Support disabling `Enter Play Mode Options > Reload Domain`
+* Support changing material property with AnimationClip (AnimatableProperty)  
+![](https://user-images.githubusercontent.com/12690315/53286323-2d94a980-37b0-11e9-8afb-c4a207805ff2.gif)
+* [4.0.0+] Support 8+ materials
+* [4.0.0+] Correct world space particle position when changing window size for standalone platforms (Windows, MacOSX and Linux)
+* [4.0.0+] Adaptive scaling for UI
+* [4.0.0+] Mesh sharing group to improve performance  
+![](https://user-images.githubusercontent.com/12690315/174311048-c882df81-6c34-4eba-b0aa-5645457692f1.gif)
+* [4.0.0+] Particle attractor component  
+![](https://user-images.githubusercontent.com/12690315/174311027-462929a4-13f0-4ec4-86ea-9c832f2eecf1.gif)
+* [4.1.0+] Relative/Absolute particle position mode  
+![](https://user-images.githubusercontent.com/12690315/175751579-5a2357e8-2ecf-4afd-83c8-66e9771bde39.gif)
+
+
+<br><br><br><br>
+
+## Demo
+
+* [WebGL Demo](https://mob-sakai.github.io/demos/UIParticle_Demo/index.html)  
+> ![](https://user-images.githubusercontent.com/12690315/174311768-1843a5f2-f776-491b-aaa8-2a131a8b6a16.gif)
+* [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
+> ![](https://user-images.githubusercontent.com/12690315/91664766-3e07ac00-eb2c-11ea-978b-ef723be80619.gif)
+
+[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>
+
+## Installation
+
+### Requirement
+
+Unity 2018.2 or later
+
+### Install via OpenUPM
+
+This package is available on [OpenUPM](https://openupm.com).
+It's recommended to install it via [openupm-cli](https://github.com/openupm/openupm-cli).
+```
+openupm add com.coffee.ui-particle
+```
+
+### Install via Package Manager Window (using Git URL)
+
+1. Select `Window/Package Manager` menu to open `Package Manager` window.
+2. Click `+` and `Install package from git URL...`  
+![](https://github.com/mob-sakai/ParticleEffectForUGUI/assets/12690315/57317aa4-e55c-4568-b2aa-2ee2a78ddc02)
+3. Input `https://github.com/mob-sakai/ParticleEffectForUGUI.git` and click `Install`  
+![](https://github.com/mob-sakai/ParticleEffectForUGUI/assets/12690315/72cc38b5-cb32-4c85-8209-c85f7bb931ea)
+
+
+Or, use [UpmGitExtension](https://github.com/mob-sakai/UpmGitExtension) to install and update the package.
+
+### Install via manifest.json (using Git URL)
+
+1. Open `Packages/manifest.json` in your project.
+2. Add this line below `"dependencies": {`
+  * `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git",`  
+  ![](https://github.com/mob-sakai/ParticleEffectForUGUI/assets/12690315/fe1cad9c-8d09-4e17-b6f5-9eac0d267921)
+3. To update the package, change suffix `#{version}`.
+  * `"com.coffee.ui-particle": "https://github.com/mob-sakai/ParticleEffectForUGUI.git#4.2.0",`
+
+### Install as an embed package
+
+1. Download a source code zip file from [Releases](https://github.com/mob-sakai/ParticleEffectForUGUI/releases) page
+2. Extract it and place it under `Packages` directory in your project.  
+![](https://github.com/mob-sakai/ParticleEffectForUGUI/assets/12690315/4c3d3439-5bb0-4e87-a917-ebe328ef89a8)
+
+
+<br><br><br><br>
+
+## How to play demo
+
+### For Unity 2019.1 or later
+
+1. Open `Package Manager` window
+2. Select `UI Particle` package in package list
+3. Click `Import Sample` button  
+![demo](https://user-images.githubusercontent.com/12690315/95017806-83bd1480-0696-11eb-8c24-c56f45ab1ac2.png)
+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
+
+1. Select `Assets/Samples/UI Particle Demo` from menu
+2. The demo project is imported into `Assets/Samples/UI Particle/{version}/Demo`
+3. Open `UIParticle_Demo` scene and play it
+
+### About `Cartoon FX & War Fx Demo`
+
+* It requires free assets ([Cartoon FX Free][CFX] & [War FX][WFX])
+  * by [Jean Moreno (JMO)][JMO]
+
+
+
+<br><br><br><br>
+
+## Usage
+
+### UIParticle component
+
+`UIParticle` controls the ParticleSystems that is attached to its own game objects and child game objects.
+
+![](https://github.com/mob-sakai/ParticleEffectForUGUI/assets/12690315/3559df45-63e7-4c4c-9233-f455779efa29)
+
+| Properties | Description |
+| -- | -- |
+| Maskable | Does this graphic allow masking. |
+| Scale | Scale the rendering.<br>When the `3D` toggle is enabled, 3D scale (x,y,z) is supported. |
+| Animatable Properties | If you want update material properties (e.g. `_MainTex_ST`, `_Color`) in AnimationClip, use this to mark the changes. |
+| Mesh Sharing | Particle simulation results are shared within the same group.<br>A large number of the same effects can be displayed with a small load.<br>When the `Random` toggle is enabled, it will be grouped randomaly. |
+| Position Mode | **Absolute:** Emit from the world position of the `ParticleSystem`.<br>**Relative:** Emit from the scaled position of the `ParticleSystem`. |
+| Auto Scaling | Transform.lossyScale (=world scale) will be set to `(1, 1, 1)` on update.<br>It prevents the root-Canvas scale from affecting the hierarchy-scaled `ParticleSystem`. |
+| Rendering Order | The ParticleSystem list to be rendered.<br>You can change the order and the materials. |
+
+NOTE: Press `Refresh` button to reconstruct rendering order based on children ParticleSystem's sorting order and z position.
+
+<br><br>
+
+### Basically usage
+
+1. Select `Game Object/UI/ParticleSystem` to create UIParticle with a ParticleSystem.  
+![particle](https://user-images.githubusercontent.com/12690315/95007361-cad0e880-0649-11eb-8835-f145d62c5977.png)
+2. Adjust the ParticleSystem as you like.  
+![particle1](https://user-images.githubusercontent.com/12690315/95007359-ca385200-0649-11eb-8383-627c9750bda8.png)
+
+<br><br>
+
+### With your existing ParticleSystem prefab
+
+1. Select `Game Object/UI/ParticleSystem (Empty)` to create UIParticle.  
+![empty](https://user-images.githubusercontent.com/12690315/95007362-cb697f00-0649-11eb-8a09-29b0a13791e4.png)
+2. Drag & drop your ParticleSystem prefab on UIParticle.  
+![particle3](https://user-images.githubusercontent.com/12690315/95007356-c6a4cb00-0649-11eb-9316-562f4bce3f31.png)
+
+<br><br>
+
+### With `Mask` or `RectMask2D` component
+
+If you want to mask particles, set a stencil supported shader (such as `UI/UIAdditive`) to material for ParticleSystem.
+If you use some custom shaders, see [How to make a custom shader to support Mask/RectMask2D component](#how-to-make-a-custom-shader-to-support-maskrectmask2d-component) section.
+
+![](https://user-images.githubusercontent.com/12690315/95017591-3b512700-0695-11eb-864e-04166ea1809a.png)
+
+
+<br><br>
+
+### Script usage
+
+```cs
+// Instant ParticleSystem prefab with UIParticle on runtime.
+var go = GameObject.Instantiate(prefab);
+var uiParticle = go.AddComponent<UIParticle>();
+
+// Control by ParticleSystem.
+particleSystem.Play();
+particleSystem.Emit(10);
+
+// Control by UIParticle.
+uiParticle.Play();
+uiParticle.Stop();
+```
+
+<br><br>
+
+### UIParticleAttractor component
+
+`UIParticleAttractor` attracts particles generated by the specified ParticleSystem.
+
+![](https://github.com/mob-sakai/ParticleEffectForUGUI/assets/12690315/ea6ae0ed-f9a8-437c-8baa-47526303391e)  
+![](https://user-images.githubusercontent.com/12690315/174311027-462929a4-13f0-4ec4-86ea-9c832f2eecf1.gif)
+
+| Properties | Description |
+| -- | -- |
+| Particle System | Attracts particles generated by the specified particle system. |
+| Distination Radius | Once the particle is within the radius, the particle lifetime will become 0 and `OnAttracted` will be called. |
+| Delay Rate | Delay to start attracting.<br>It is a percentage of the particle's start lifetime. |
+| Max Speed | Maximum speed of attracting.<br> If this value is too small, attracting may not be completed by the end of the lifetime and `OnAttracted` may not be called. |
+| Movement | Attracting movement type. (Linear, Smooth, Sphere) |
+| Update Mode | **Normal:** Update with scaled delta time.<br>**Unscaled Time:** Update with unscaled delta time. |
+| OnAttracted | An event called when attracting is complete (per particle). |
+
+<br><br><br><br>
+
+## Development Note
+
+### FAQ: Why are my particle effects not displayed correctly?
+
+If `ParticleSystem` alone displays particles correctly but `UIParticle` does not, please check the following points:
+
+* [Shader Limitation](https://github.com/mob-sakai/ParticleEffectForUGUI#shader-limitation)
+  * Most cases can be solved by using `UI/Additive` or `UI/Default`.
+* Particles are masked
+  * `UIParticle` is maskable.
+  * Set `Mask` or `RectMask2D` component properly.
+* Particles are too small
+  * If particles are small enough, they will not appear on the screen.
+  * Increase the `Scale` value.
+  * If you don't want to change the apparent size depending on the resolution, try `Auto Scaling` option.
+* Particles are too many
+  * No more than 65535 vertices can be displayed (for mesh combination limitations).
+  * Please set `Emission` module and `Max Particles` of ParticleSystem properly.
+* Particles are emitted off-screen.
+  * When `Position Mode = Relative`, particles are emitted from scaled position of the ParticleSystem, not from the screen point of the ParticleSystem.
+  * Place the ParticleSystem in the proper position or try `Position Mode = Absolute`.
+* Attaching `UIParticle` to the same object as `ParticleSystem`
+  * `Transform.localScale` will be overridden by `Auto Scaling` option.
+  * It is recommended to place `ParticleSystem` under `UIParticle`.
+
+
+<br>
+
+### Shader Limitation
+
+The use of UI shaders is recommended.
+
+- If you need a simple Additive shader, use the `UI/Additive` shader instead.
+- If you need a simple alpha-blend shader, use the `UI/Default` shader instead.
+- If your custom shader does not work properly with UIParticle, consider creating a custom UI shader.
+
+#### Built-in shaders are not supported
+
+UIParticle does not support all built-in shaders except for `UI/Default`.  
+If their use is detected, an error is displayed in the inspector.  
+Use UI shaders instead.
+
+#### (2019.4 or earlier) UV.zw components will be discarded
+
+UIParticleRenderer renders the particles based on UIVertex.  
+Therefore, only xy components is available for each UV in the shader. (zw components will be discarded).  
+So unfortunately UIParticles will not work well with some shaders.  
+
+#### (2019.4 or earlier) Custom vertex streams
+
+When using custom vertex streams, you can fill zw components with "unnecessary" data.  
+https://github.com/mob-sakai/ParticleEffectForUGUI/issues/191
+
+
+<br>
+
+### Overheads
+
+UIParticle has some overheads and the batching depends on uGUI.  
+When improving performance, keep the following in mind:
+- If you are displaying a large number of the same effect, consider `Mesh Sharing` feature in [UIParticle Component](#uiparticle-component).
+  - If you don't like the uniform output, consider `Random Group` feature.  
+![](https://user-images.githubusercontent.com/12690315/174311048-c882df81-6c34-4eba-b0aa-5645457692f1.gif)
+- If you are using multiple materials, you will have more draw calls.
+  - Consider single material, atlasing the sprites, and using `Sprite` mode in the `Texture Sheet Animation` module in ParticleSystem.
+
+### How to make a custom shader to support Mask/RectMask2D component
+
+<details>
+<summary>Shader tips</summary>
+
+```ShaderLab
+Shader "Your/Custom/Shader"
+{
+    Properties
+    {
+        // ...
+        // #### required for Mask ####
+        _StencilComp ("Stencil Comparison", Float) = 8
+        _Stencil ("Stencil ID", Float) = 0
+        _StencilOp ("Stencil Operation", Float) = 0
+        _StencilWriteMask ("Stencil Write Mask", Float) = 255
+        _StencilReadMask ("Stencil Read Mask", Float) = 255
+        _ColorMask ("Color Mask", Float) = 15
+        [Toggle(UNITY_UI_ALPHACLIP)] _UseUIAlphaClip ("Use Alpha Clip", Float) = 0
+    }
+
+    SubShader
+    {
+        Tags
+        {
+            // ...
+        }
+
+        // #### required for Mask ####
+        Stencil
+        {
+            Ref [_Stencil]
+            Comp [_StencilComp]
+            Pass [_StencilOp]
+            ReadMask [_StencilReadMask]
+            WriteMask [_StencilWriteMask]
+        }
+        ColorMask [_ColorMask]
+        // ...
+
+        Pass
+        {
+            // ...
+            // #### required for RectMask2D ####
+            #include "UnityUI.cginc"
+            #pragma multi_compile __ UNITY_UI_CLIP_RECT
+            float4 _ClipRect;
+
+            // #### required for Mask ####
+            #pragma multi_compile __ UNITY_UI_ALPHACLIP
+
+            struct appdata_t
+            {
+                // ...
+            };
+
+            struct v2f
+            {
+                // ...
+                // #### required for RectMask2D ####
+                float4 worldPosition    : TEXCOORD1;
+            };
+            
+            v2f vert(appdata_t v)
+            {
+                v2f OUT;
+                // ...
+                // #### required for RectMask2D ####
+                OUT.worldPosition = v.vertex;
+                return OUT;
+            }
+
+            fixed4 frag(v2f IN) : SV_Target
+            {
+                // ...
+                // #### required for RectMask2D ####
+                #ifdef UNITY_UI_CLIP_RECT
+                    color.a *= UnityGet2DClipping(IN.worldPosition.xy, _ClipRect);
+                #endif
+
+                // #### required for Mask ####
+                #ifdef UNITY_UI_ALPHACLIP
+                    clip (color.a - 0.001);
+                #endif
+
+                return color;
+            }
+            ENDCG
+        }
+    }
+}
+```
+</details>
+
+
+<br><br><br><br>
+
+## 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://user-images.githubusercontent.com/12690315/50731629-3b18b480-11ad-11e9-8fad-4b13f27969c1.png)](https://www.patreon.com/join/mob_sakai?)  
+[![](https://user-images.githubusercontent.com/12690315/66942881-03686280-f085-11e9-9586-fc0b6011029f.png)](https://github.com/users/mob-sakai/sponsorship)
+
+
+
+<br><br><br><br>
+
+## License
+
+* MIT
+
+
+
+## Author
+
+* ![](https://user-images.githubusercontent.com/12690315/96986908-434a0b80-155d-11eb-8275-85138ab90afa.png) [mob-sakai](https://github.com/mob-sakai) [![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai) ![GitHub followers](https://img.shields.io/github/followers/mob-sakai?style=social)
+
+
+
+## See Also
+
+* GitHub page : https://github.com/mob-sakai/ParticleEffectForUGUI
+* Releases : https://github.com/mob-sakai/ParticleEffectForUGUI/releases
+* Issue tracker : https://github.com/mob-sakai/ParticleEffectForUGUI/issues
+* Change log : https://github.com/mob-sakai/ParticleEffectForUGUI/blob/upm/CHANGELOG.md