docs: add docs

mob-sakai · Nov 11, 2024 · ef02805 · ef02805
1 parent e8e14c8
commit ef02805
Show file tree

Hide file tree

Showing 6 changed files with 401 additions and 0 deletions.
diff --git a/Packages/src/CHANGELOG.md b/Packages/src/CHANGELOG.md
diff --git a/Packages/src/CHANGELOG.md.meta b/Packages/src/CHANGELOG.md.meta
diff --git a/Packages/src/LICENSE.md b/Packages/src/LICENSE.md
@@ -0,0 +1,7 @@
+Copyright 2017-2024 mob-sakai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/Packages/src/LICENSE.md.meta b/Packages/src/LICENSE.md.meta
diff --git a/Packages/src/README.md b/Packages/src/README.md
@@ -0,0 +1,370 @@
+# <img alt="logo" height="26" src="https://github.com/user-attachments/assets/dc72baf5-eadf-463e-abc9-464477fd0b9e"/> UIEffect v5 <!-- omit in toc -->
+
+[![](https://img.shields.io/npm/v/com.coffee.ui-effect?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.coffee.ui-effect/)
+[![](https://img.shields.io/github/v/release/mob-sakai/UIEffect?include_prereleases)](https://github.com/mob-sakai/UIEffect/releases)
+[![](https://img.shields.io/github/release-date/mob-sakai/UIEffect.svg)](https://github.com/mob-sakai/UIEffect/releases)  
+![](https://img.shields.io/badge/Unity-2020.3+-57b9d3.svg?style=flat&logo=unity)
+![](https://img.shields.io/badge/Unity-6000.0+-57b9d3.svg?style=flat&logo=unity)
+![](https://img.shields.io/badge/TextMeshPro_Support-57b9d3.svg?style=flat)
+![](https://img.shields.io/badge/UPR%2FHDPR_Support-57b9d3.svg?style=flat)
+![](https://img.shields.io/badge/VR_Support-57b9d3.svg?style=flat)  
+[![](https://img.shields.io/github/license/mob-sakai/UIEffect.svg)](https://github.com/mob-sakai/UIEffect/blob/main/LICENSE.md)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-orange.svg)](http://makeapullrequest.com)
+[![](https://img.shields.io/github/watchers/mob-sakai/UIEffect.svg?style=social&label=Watch)](https://github.com/mob-sakai/UIEffect/subscription)
+[![](https://img.shields.io/twitter/follow/mob_sakai.svg?label=Follow&style=social)](https://twitter.com/intent/follow?screen_name=mob_sakai)
+
+<< [📝 Description](#-description-) | [📌 Key Features](#-key-features) | [🎮 Demo](#-demo) | [⚙ Installation](#-installation) | [🔄 Upgrading from v4 to v5](#-upgrading-from-v4-to-v5) | [🚀 Usage](#-usage) | [🤝 Contributing](#-contributing) >>
+
+⚠️ This README is for v5. For v4, please visit [here](https://github.com/mob-sakai/UIEffect/blob/upm/README.md).
+
+## 📝 Description <!-- omit in toc -->
+
+**_"Decorate your uGUI, simply and powerfully."_**  
+UIEffect is an open-source package that allows you to intuitively apply rich UI effects directly from the Inspector or via code.  
+Combine various filters, such as grayscale, blur, and dissolve, to decorate your UI with a unique visual style!
+
+![](https://github.com/user-attachments/assets/bce4ddb2-766f-4bed-bad2-fda91bb8133c)
+
+- [📌 Key Features](#-key-features)
+- [🎮 Demo](#-demo)
+- [⚙ Installation](#-installation)
+  - [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)
+  - [Additional Resource Imports](#additional-resource-imports)
+- [🔄 Upgrading from v4 to v5](#-upgrading-from-v4-to-v5)
+- [🚀 Usage](#-usage)
+  - [Getting Started](#getting-started)
+  - [Component: UIEffect](#component-uieffect)
+  - [Component: UIEffectTweener](#component-uieffecttweener)
+  - [Component: UIEffectReplica](#component-uieffectreplica)
+  - [Usage with TextMeshPro](#usage-with-textmeshpro)
+  - [Runtime/Editor Preset for UIEffect](#runtimeeditor-preset-for-uieffect)
+  - [Usage with Code](#usage-with-code)
+  - [Project Settings](#project-settings)
+  - [:warning: Limitations](#warning-limitations)
+- [🤝 Contributing](#-contributing)
+  - [Issues](#issues)
+  - [Pull Requests](#pull-requests)
+  - [Support](#support)
+- [License](#license)
+- [Author](#author)
+- [See Also](#see-also)
+
+<br><br>
+
+## 📌 Key Features
+
+![](https://github.com/user-attachments/assets/eab596e5-6cae-4441-b02b-7fc1fb45743d)
+
+- **UIEffect is out-of-the-box!**: Easily apply effects by adjusting parameters directly in the inspector.
+- **Rich effect combinations**: Decorate your UI with a variety of effects, such as grayscale, blur, and dissolve, by combining multiple filters and parameters.
+- **Efficient shader builds**: Only the shader variants in use are built, resulting in shorter build times.
+- **URP/HDRP/VR support**: Compatible with URP, HDRP, and VR environments.
+- **Runtime and editor presets**: Presets are available both at runtime and in the editor.
+- **TextMeshPro support**: Supports TextMeshPro, including `<font>` and `<sprite>` tags.
+- **UIEffectReplica Component**: Duplicate effects and apply them to multiple UI elements at once.
+- **UIEffectTweener Component**: A simple tweener component to play, stop, pause, and resume effects.
+- **AnimationClip support**: Allows control of effect animations using `AnimationClips`.
+- **v4 compatible components (optional)**: For easy upgrading with minimal changes, compatible v4 components are available optionally.
+
+<br><br>
+
+## 🎮 Demo
+
+![](https://github.com/user-attachments/assets/17e5ee27-f7d5-43aa-942f-182e2b4c838c)  
+![](https://github.com/user-attachments/assets/02ab1686-03d4-4500-bd89-004b2c401441)
+
+[WebGL Demo](https://mob-sakai.github.io/UIEffect/)
+
+<br><br>
+
+## ⚙ Installation
+
+_This package requires **Unity 2020.3 or later**._
+
+### Install via OpenUPM
+
+- This package is available on [OpenUPM](https://openupm.com) package registry.
+- This is the preferred method of installation, as you can easily receive updates as they're released.
+- If you have [openupm-cli](https://github.com/openupm/openupm-cli) installed, then run the following command in your project's directory:
+  ```
+  openupm add com.coffee.ui-effect
+  ```
+- To update the package, use Package Manager UI (`Window > Package Manager`) or run the following command with `@{version}`:
+  ```
+  openupm add [email protected]
+  ```
+
+### 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/UIEffect.git?path=Packages/src`  
+  ![](https://github.com/user-attachments/assets/f88f47ad-c606-44bd-9e86-ee3f72eac548)
+- To update the package, change suffix `#{version}` to the target version.
+    - e.g. `https://github.com/mob-sakai/UIEffect.git?path=Packages/src#5.0.0`
+
+### Install via UPM (Manually)
+
+- Open the `Packages/manifest.json` file in your project. Then add this package somewhere in the `dependencies` block:
+  ```json
+  {
+    "dependencies": {
+      "com.coffee.ui-effect": "https://github.com/mob-sakai/UIEffect.git?path=Packages/src",
+      ...
+    }
+  }
+  ```
+
+- 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.0.0",`
+
+### Install as Embedded Package
+
+1. Download a source code zip file from [Releases](https://github.com/mob-sakai/UIEffect/releases) and extract it.
+2. Place `<extracted_dir>/Packages/src` directory in your project's `Packages` directory.  
+   ![](https://github.com/user-attachments/assets/187cbcbe-5922-4ed5-acec-cf19aa17d208)
+- You can rename the `src` 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.
+
+### Additional Resource Imports
+
+UIEffect includes additional resources to import.
+
+- [🔄 Upgrading from v4 to v5](#-upgrading-from-v4-to-v5)
+- [Usage with TextMeshPro](#usage-with-textmeshpro)
+
+<br><br>
+
+## 🔄 Upgrading from v4 to v5
+
+If upgrading from UIEffect v4 to v5, note the following breaking changes:
+
+1. If you are installing via git URL, add `?path=Packages/src`. The default branch is changed `upm` to `main`.
+   ```json
+   // v4
+   "com.coffee.ui-effect": "https://github.com/mob-sakai/UIEffect.git",
+   "com.coffee.ui-effect": "https://github.com/mob-sakai/UIEffect.git#upm",
+
+   // v5
+   "com.coffee.ui-effect": "https://github.com/mob-sakai/UIEffect.git?path=Packages/src",
+   ```
+
+2. Import the `v4 Compatible Components` sample from the Package Manager window.  
+   ![](https://github.com/user-attachments/assets/a1b246d3-3a0b-4a70-a9d2-3e75429fa757)
+
+3. All v4 components are obsolete.  
+- v4 `UIEffect` component is now `UIEffectV4` component. Change the reference in the code.
+- The `effectArea` property in some components are not supported in v5.
+- `UIShadow`, `UIGradient`, `UIFlip` components are not supported in v5.
+- v4 components can be converted to v5 `UIEffect` component by selecting `Convert To UIEffect` from the context menu.  
+  ![](https://github.com/user-attachments/assets/4911f06d-4749-4aa8-a72e-deb0fa06bc5d)
+
+<br><br>
+
+## 🚀 Usage
+
+### Getting Started
+
+1. [Install the package](#-installation).
+
+2. Add a `UIEffect` component to a UI element (Image, RawImage, Text, TextMeshProUGUI, etc...) from the `Add Component` in the inspector or `Component > UI > UIEffect` menu.  
+   ![](https://github.com/user-attachments/assets/9e9de844-b265-489e-b8bd-51760996cfd2)
+
+3. Adjust the effect filters and parameters in the inspector.  
+   ![](https://github.com/user-attachments/assets/38c2df5a-d7f7-4062-a595-8d3e887855cf)
+
+4. Enjoy!
+
+<br><br>
+
+### Component: UIEffect
+
+![](https://github.com/user-attachments/assets/090a71ea-81b4-4264-852c-af03f9346dd3)
+
+The `UIEffect` component applies visual effects to UI elements, allowing various effects to be achieved by combining multiple filters.
+
+- **Tone Filter**: `None`, `Grayscale`, `Sepia`, `Nega`, `Retro`, `Posterize`
+- **Tone Intensity**: 0.0 (no effect) - 1.0 (full effect).
+- **Color Filter**: `None`, `Multiply`, `Additive`, `Subtractive`, `Replace`, `Multiply Luminance`, `Multiply Additive`, `Hsv Modifier`, `Contrast`
+- **Color Intensity**: 0.0 (no effect) - 1.0 (full effect).
+- **Sampling Filter**: `None`, `Blur Fast`, `Blur Medium`, `Blur Detail`, `Pixelation`, `Rgb Shift`, `Edge Luminescence`, `Edge Alpha`
+- **Sampling Intensity**: 0.0 (no effect) - 1.0 (full effect).
+- **Transition Filter**: `None`, `Fade`, `Cutoff`, `Dissolve`, `Shiny`, `Mask`, `Melt`, `Burn`
+- **Transition Rate**: 0.0 (no effect) - 1.0 (full effect).
+- **Transition Tex**: The texture used for the transition filter.- **Transition Width**: The width where the transition color is applied.
+- **Transition Softness**: The softness of the boundary for the transition color.
+- **Transition Color Filter/Transition Color**: Specifies the transition color.
+- **Target Mode**: `None`, `Hue`, `Luminance`
+  - Restricts the effect application area based on hue or luminance.
+- **Target Range**: The range of target hue or luminance.
+- **Target Softness**: The softness of the target boundary.
+- **Blend Type**: `Alpha Blend`, `Multiply`, `Additive`, `Soft Additive`, `Multiply Additive`, `Custom (SrcBlend, DstBlend)`
+- **Shadow Mode**: `None`, `Shadow`, `Shadow3`, `Outline`, `Outline8`, `Mirror`
+- **Shadow Distance**: Distance of the shadow or outline.
+- **Shadow Iteration**: Number of times the shadow or outline is applied.
+- **Shadow Fade**: Alpha value of the shadow or outline.
+- **Shadow Effect On Origin**: Applies effects to meshes other than shadows.
+- **Mirror Reflection**: Distance of the mirrored image.
+- **Mirror Offset**: Offset for the mirrored image.
+- **Mirror Scale**: Scale of the mirrored image.
+
+<br><br>
+
+### Component: UIEffectTweener
+
+![](https://github.com/user-attachments/assets/7b02f029-c9d4-4e00-aad7-240f893af775)
+
+The `UIEffectTweener` component animates the effect, enabling easy control over effect animations without the need for an `AnimationClip`.
+
+- **Culling Mask**: `Tone`, `Color`, `Sampling`, `Transition`
+- **Direction**: `Forward (0.0 -> 1.0)`, `Backward (1.0 -> 0.0)`
+- **Delay**: The delay time before starting the animation.
+- **Duration**: The duration of the animation.
+- **Interval**: The interval time between the animation.
+- **Curve**: The curve of the animation.
+- **Restart On Enable**: Play the animation automatically when the component is enabled.
+- **Wrap Mode**: `Once`, `Loop`, `PingPongOnce`, `PingPongLoop`
+- **Update Mode**: `Normal`, `UnscaledTime`, `Manual`
+
+<br><br>
+
+### Component: UIEffectReplica
+
+![](https://github.com/user-attachments/assets/a1fad455-de60-4a18-b587-1ae138af1d37)
+
+The `UIEffectReplica` component applies visual effects to UI elements by replicating the settings of another `UIEffect` component. This allows the same effect to be applied across multiple UI elements simultaneously.
+
+- **Target**: The target `UIEffect` component to replicate.
+- **Use Target Transform**: Use the target's transform for some effects.  
+  ![](https://github.com/user-attachments/assets/127e30fb-15c7-4002-ab65-e8f29e640330)
+<br><br>
+
+### Usage with TextMeshPro
+
+![](https://github.com/user-attachments/assets/bd12baa3-52f7-41e9-bf05-a052d0aabc37)
+
+UIEffect supports TextMeshProUGUI elements. To use UIEffect with TextMeshPro, follow these steps:
+
+1. First, you must import [TMP Essential Resources](https://docs.unity3d.com/Packages/[email protected]/manual/index.html#installation) before using.  
+   ![](https://github.com/user-attachments/assets/70653ccf-0b5e-4352-ac62-76bdd49c5f92)
+
+2. Open the `Package Manager` window and select the `UI Soft Mask` package in the package list and click the `TextMeshPro Support > Import` button.  
+   ⚠️ If you are using `Unity 2023.2/6000.0+` or `TextMeshPro 3.2/4.0+`, click the `TextMeshPro Support (Unity 6) > Import` button instead.  
+   ![](https://github.com/user-attachments/assets/a1b246d3-3a0b-4a70-a9d2-3e75429fa757)
+
+3. The assets will be imported under `Assets/Samples/UI Effect/{version}`.
+
+4. Add the `UIEffect` component to a TextMeshProUGUI element and adjust the effect settings. The `<font>` and `<sprite>` tags are also supported.  
+   ![](https://github.com/user-attachments/assets/bfd28f36-2e32-4383-8628-276b02579fd4)
+
+<br><br>
+
+### Runtime/Editor Preset for UIEffect
+
+![](https://github.com/user-attachments/assets/4244d162-a768-463e-8aad-8cafbdf3a5b3)
+
+You can create and use presets for `UIEffect` components.
+- In the `UIEffect` component inspector, click "Save As" button to save the current settings as an editor preset.
+- Click "Load" button to apply an editor preset.
+- In the [Project Settings](#project-settings), you can register saved editor presets as runtime presets.
+- Runtime presets can be loaded using the `UIEffect.LoadPreset(presetName)` method.
+
+<br><br>
+
+### Usage with Code
+
+You can control the effect settings and animations via code.
+
+```csharp
+var effect = graphic.AddComponent<UIEffect>();
+
+// Apply a preset
+effect.LoadPreset("Dissolve");
+
+// Set the effect parameters
+effect.transitionWidth = 0.1f;
+effect.transitionColor = Color.red;
+
+// Add a tweener
+var tweener = graphic.AddComponent<UIEffectTweener>();
+tweener.cullingMask = UICullingMask.Tone;
+tweener.wrapMode = UIWrapMode.PingPongLoop;
+
+// Warm up the shader variant collection.
+UIEffectProjectSettings.shaderVariantCollection.WarmUp();
+```
+
+<br><br>
+
+### Project Settings
+
+![](https://github.com/user-attachments/assets/33b01665-0893-4460-a220-62f5f08b2eec)
+
+You can adjust the project-wide settings for UIEffect. (`Edit > Project Settings > UI > UIEffect`)
+
+- **Transform Sensitivity**: `Low`, `Medium`, `High`
+  - Set the sensitivity of the transformation when `Use Target Transform` is enabled in `UIEffectReplica` component.
+- **Runtime Presets**: A list of presets that can be loaded at runtime. Load them using `UIEffect.LoadPreset(presetName)` method.
+- **Fallback Variant Behavior**: Specifies the behavior when an unregistered shader variant is used in the editor.
+  - `Register Variant`: Adds the variant to `Registered Variants` for runtime use.
+  - `LogError`: Outputs a error and adds it to `Unregistered Variants`.
+- **Unregistered Variants**: A list of shader variants that are not registered. Use "+" button to add variants.
+- **Registered Variants**: A list of shader variants available at runtime. Use "-" button to remove unused variants, reducing build time and file size.
+
+<br><br>
+
+### :warning: Limitations
+
+Here are the limitations of UIEffect:
+
+- Shader variants used at runtime must be registered in the [Project Settings](#project-settings).
+- When using UIEffect with TextMeshProUGUI, `SamplingFilter.BlurMedium` and `SamplingFilter.BlurDetail` are not supported due to performance considerations.
+  - These will automatically fall back to `SamplingFilter.BlurFast`.
+
+<br><br>
+
+## 🤝 Contributing
+
+### Issues
+
+Issues are incredibly valuable to this project:
+
+- Ideas provide a valuable source of contributions that others can make.
+- Problems help identify areas where this project needs improvement.
+- Questions indicate where contributors can enhance the user experience.
+
+### Pull Requests
+
+Pull requests offer a fantastic way to contribute your ideas to this repository.  
+Please refer to [CONTRIBUTING.md](https://github.com/mob-sakai/UIEffect/tree/main/CONTRIBUTING.md)
+and use [develop branch](https://github.com/mob-sakai/UIEffect/tree/develop) for development.
+
+### Support
+
+This is an open-source project developed during my spare time.  
+If you appreciate it, consider supporting me.  
+Your support allows me to dedicate more time to development. 😊
+
+[![](https://user-images.githubusercontent.com/12690315/66942881-03686280-f085-11e9-9586-fc0b6011029f.png)](https://github.com/users/mob-sakai/sponsorship)  
+[![](https://user-images.githubusercontent.com/12690315/50731629-3b18b480-11ad-11e9-8fad-4b13f27969c1.png)](https://www.patreon.com/join/2343451?)
+
+<br><br>
+
+## License
+
+* MIT
+* © UTJ/UCL
+
+## 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/UIEffect
+* Releases : https://github.com/mob-sakai/UIEffect/releases
+* Issue tracker : https://github.com/mob-sakai/UIEffect/issues
+* Change log : https://github.com/mob-sakai/UIEffect/blob/main/Packages/src/CHANGELOG.md