Merge branch 'feature/installable_samples' into development/v1

H3idi-X · H3idi-X · commit b383379124de · 2021-06-14T19:56:28.000+09:00
diff --git a/README.md b/README.md
@@ -58,14 +58,10 @@ To install this package, follow the instructions in the [Package Manager documen
 
 If you installed this package, Unity Toon Shader files are installed into **com.unity.toonshader** folder under **Packages** folder in your Unity project.  
 
-To get the sample scenes of Unity Toon Shader, download whole project from [here](https://github.com/Unity-Technologies/com.unity.toonshader/archive/refs/heads/development/v1.zip).  
+To get the sample scenes of Unity Toon Shader, Install samples via `Package Manager` for each render pipeline. The instruction to install the samples is [here](com.unity.toonshader/Documentation~/index.md#Samples).  
 
-Each sample project is below.  
-* Legacy(built-in) : under **UnityToonshader_Project~** folder  
-* HDRP : under **UnityToonshader_ProjectHDRP~** folder  
-* URP : under **UnityToonshader_ProjectURP~** folder  
+You can learn various setting examples of Unity Toon Shader.  
 
-The project comes with sample scenes where you can learn various setting examples of Unity Toon Shader.  
 
 
 <a name="UsingUnitychanToonShader2"></a>
diff --git a/com.unity.toonshader/CHANGELOG.md b/com.unity.toonshader/CHANGELOG.md
@@ -1,4 +1,7 @@
 # Changelog
+## [0.0.7-preview] - 2021-06-14
+* Made samples insstallable.
+
 ## [0.0.6-preview] - 2021-06-04
 * Modifed documents
 
diff --git a/com.unity.toonshader/Documentation~/en/README.md b/com.unity.toonshader/Documentation~/en/README.md
@@ -58,14 +58,9 @@ To install this package, follow the instructions in the [Package Manager documen
 
 If you installed this package, Unity Toon Shader files are installed into **com.unity.toonshader** folder under **Packages** folder in your Unity project.  
 
-To get the sample scenes of Unity Toon Shader, download whole project from [here](https://github.com/Unity-Technologies/com.unity.toonshader/archive/refs/heads/development/v1.zip).  
+To get the sample scenes of Unity Toon Shader, Install samples via `Package Manager` for each render pipeline. The instruction to install the samples is [here](../index.md#Samples).  
 
-Each sample project is below.  
-* Legacy(built-in) : under **UnityToonshader_Project~** folder  
-* HDRP : under **UnityToonshader_ProjectHDRP~** folder  
-* URP : under **UnityToonshader_ProjectURP~** folder  
-
-The project comes with sample scenes where you can learn various setting examples of Unity Toon Shader.  
+You can learn various setting examples of Unity Toon Shader.  
 
 
 <a name="UsingUnitychanToonShader2"></a>
diff --git a/com.unity.toonshader/Documentation~/images/HDRP-Asset.png b/com.unity.toonshader/Documentation~/images/HDRP-Asset.png
diff --git a/com.unity.toonshader/Documentation~/images/InstallingSamples.png b/com.unity.toonshader/Documentation~/images/InstallingSamples.png
diff --git a/com.unity.toonshader/Documentation~/images/SelectLinearColorSpace.png b/com.unity.toonshader/Documentation~/images/SelectLinearColorSpace.png
diff --git a/com.unity.toonshader/Documentation~/images/URP-Asset.png b/com.unity.toonshader/Documentation~/images/URP-Asset.png
diff --git a/com.unity.toonshader/Documentation~/index.md b/com.unity.toonshader/Documentation~/index.md
@@ -1,4 +1,4 @@
-# Unity Toon Shader 0.0.6-preview Manual
+# Unity Toon Shader 0.0.7-preview Manual
 ***Read this document in [日本語版](ja/index_ja.md)***  
 
 [![](images/SDUnitychan_URP.png)](https://www.youtube.com/watch?v=TfZ8B409uqM)
@@ -49,7 +49,7 @@ Several techniques have been implemented to beautifully display characters in a
 See for yourself by coloring your best character model with Unity Toon Shader.  
 You may be surprised to see your character looking better than ever before.  
 
-This manual focuses on the latest version of Unity Toon Shader: **Unity Toon Shader v.0.0.6-preview**.  
+This manual focuses on the latest version of Unity Toon Shader: **Unity Toon Shader v.0.0.7-preview**.  
 In this manual, the screen of Unity Toon Shader for Universal Render Pipeline is used as an example, but the ones for the Legacy (Built-in) and HDRP versions are alomost the same with URP, so please read it accordingly.  
 
 ## 【Start using Unity Toon Shader】
@@ -81,9 +81,9 @@ The Toon shader should be switched to match the pipeline.
 
 
 ## 【Unity Toon Shader as an Uber Shader】
-UTS2 v.2.0.7.5 was divided into multiple shaders by function.  
+UTS2 v.2.0.7.5  consisted of various specialized feature shaders. Now, all the shaders are integrated into two uber shaders. The difference between two shaders is just one is ready for  tessellation but the other is not..
 
-<img width = "480" src="images/UTS2_Standard.png">
+<Img width = "480" src="images/UTS2_Standard.png">
 
 Unity Toon Shader has been redesigned as an integrated shader (Uber shader), allowing you to do all the work in one Universal Render Pipeline/Toon shader.  
 
@@ -208,8 +208,25 @@ Most of them are integrated into the basic shader functionality.</small>
 <small>It was deprecated in Unity Toon Shader</small>.  
 
 ---
-# Sample Scenes
-The following sample scenes can be found by opening the sample project and opening the `\UnityToonshader_ProjectURP~\Assets\Sample Scenes(Universal)` folder.  
+# Samples
+Sample scenes are installable from the package manager.
+Please, make shure that HDRP or URP is installed and set up before installing the samples for each.
+
+<img width = "400" src="images/InstallingSamples.png">
+
+Samples for Universal RP require `UTS2URPPipelineAsset` to be set in `Project Setting` dialog.
+
+<img width = "400" src="images/URP-Asset.png">
+
+Ones for HDRP require `HDRenderPipelineAsset_UTS` asset as well.
+
+<img width = "400" src="images/HDRP-Asset.png">
+
+The Color Space must be set to `Linear`.
+
+<img width = "400" src="images/SelectLinearColorSpace.png">
+
+The following sample scenes can be found by opening the sample project and opening the `Assets\Samples\Unity Toon Shader\0.0.7-preview\Universal RP\Sample Scenes(Universal)` folder.  
 
 * ToonShader.unity            ：Settings for an illustration-style shader.  
 * ToonShader_CelLook.unity    ：Settings for a cel-style shader.  
@@ -232,8 +249,8 @@ They should come in handy as an example when creating your own scenes.
 
 【**NOTE**】 
 Sample scenes for other render pipeline can be found in the following folder.  
-* for Legacy (Built-in)：`\UnityToonshader_Project~\Assets\Legacy\Sample Scenes` folder  
-* for HDRP：`\UnityToonshader_ProjectHDRP~\Assets\HDRP` folder 
+* for Legacy (Built-in)：`Assets\Samples\Unity Toon Shader\0.0.7-preview\Legacy (built-in)\Runtime` folder  
+* for HDRP：`Assets\Samples\Unity Toon Shader\0.0.7-preview\High definition render pipeline\Runtime` folder 
 
 
 # Unity Toon Shader Setting Menu：Unity Toon Shader Custom Inspector
diff --git a/com.unity.toonshader/Documentation~/ja/README_ja.md b/com.unity.toonshader/Documentation~/ja/README_ja.md
@@ -57,14 +57,13 @@ Unity Toon Shaderでは、アクセントカラーとして**2影色とAp(対蹠
 ## 【Unity Toon Shader のインストール】
 本パッケージをインストールすると、Unity Toon Shaderのファイルは、Unityプロジェクトの**Packages**フォルダ内の**com.unity.toonshader**フォルダにインストールされます。  
 
-Unity Toon Shaderのサンプルシーンを入手するには、[こちら](https://github.com/Unity-Technologies/com.unity.toonshader/archive/refs/heads/development/v1.zip)からプロジェクト全体をダウンロードしてください。  
+To get the sample scenes of Unity Toon Shader, Install samples via `Package Manager` for each render pipeline. The instruction to install the samples is [here](../index.md#InstallingSamples).  
 
-各サンプルプロジェクトは、以下のようになっています。  
-* Legacy(built-in) : **UnityToonshader_Project~** フォルダ内  
-* HDRP : **UnityToonshader_ProjectHDRP~** フォルダ内  
-* URP : **UnityToonshader_ProjectURP~** フォルダ内  
+You can learn various setting examples of Unity Toon Shader.  
 
-プロジェクトには、Unity Toon Shaderの様々な設定例を学べるサンプルシーンが用意されています。  
+Unity Toon Shaderのサンプルシーンは、`Package Manager`からインストールをお願いいたします。インストール方法は[こちら](index_ja.md#サンプルシーン)。  
+
+Unity Toon Shaderの様々な設定例を学べるサンプルシーンが用意されています。  
 
 
 
diff --git a/com.unity.toonshader/Documentation~/ja/index_ja.md b/com.unity.toonshader/Documentation~/ja/index_ja.md
@@ -1,4 +1,4 @@
-# Unity Toon Shader 0.0.6-preview マニュアル
+# Unity Toon Shader 0.0.7-preview マニュアル
 ***Read this document in [English](../index.md)***  
 
 [![](../images/SDUnitychan_URP.png)](https://www.youtube.com/watch?v=TfZ8B409uqM)
@@ -49,7 +49,7 @@ Unity Toon Shader は、セルルック3DCGアニメーションの制作現場
 是非、貴方のご自慢のキャラクターモデルをUnity Toon Shaderで彩ってみてください。  
 今まで以上に、キャラクターが美しく表現されるものと思います。  
 
-本マニュアルは、Unity Toon Shader の最新版 **Unity Toon Shader v.0.0.6-preview** 向けに書かれています。  
+本マニュアルは、Unity Toon Shader の最新版 **Unity Toon Shader v.0.0.7-preview** 向けに書かれています。  
 またマニュアル中では、Universal Render Pipeline版のUnity Toon Shaderの画面を例として使用しますが、Legacy(Built-in)およびHDRP版に関しましても、ほぼ同様の画面となっていますので、適宜読み替えてください。  
 
 ## 【Unity Toon Shaderを使い始める】
@@ -204,8 +204,26 @@ Render Queueに設定する値について、より詳しく知りたい場合
 <small>Unity Toon Shader では廃止されました。</small>  
 
 ---
+<a name="InstallingSamples"></a>
 # サンプルシーン
-サンプルプロジェクトを開くと、`\UnityToonshader_ProjectURP~\Assets\Sample Scenes(Universal)`フォルダ以下に、次のようなサンプルシーンがあります。  
+サンプルシーンはパッケージマネージャーからインストール可能です。
+HDRP, Universal RP の場合はそれぞれのレンダーパイプラインのインストールと設定をお願いいたします。
+
+<img width = "400" src="images/InstallingSamples.png">
+
+Universal RP 用サンプルは`Project Setting`ダイアログで `UTS2URPPipelineAsset` を設定する必要があります。
+
+<img width = "400" src="images/URP-Asset.png">
+
+同様にHDRP 用サンプルは`HDRenderPipelineAsset_UTS` アセットの設定が必要です。
+
+<img width = "400" src="images/HDRP-Asset.png">
+
+また、カラースペースは`Linear`に設定する必要があります。
+
+<img width = "400" src="images/SelectLinearColorSpace.png">
+
+サンプルプロジェクトを開くと、`Assets\Samples\Unity Toon Shader\0.0.7-preview\Universal RP\Sample Scenes(Universal)`フォルダ以下に、次のようなサンプルシーンがあります。  
 
 * ToonShader.unity			：イラストルックのシェーダー設定  
 * ToonShader_CelLook.unity	：セルルックのシェーダー設定  
@@ -228,8 +246,8 @@ Render Queueに設定する値について、より詳しく知りたい場合
 
 【**NOTE**】 
 その他のレンダーパイプライン向けのサンプルシーンは以下のフォルダに入っています。  
-* Legacy(Built-in)の場合：`\UnityToonshader_Project~\Assets\Legacy\Sample Scenes`フォルダ  
-* HDRPの場合：`\UnityToonshader_ProjectHDRP~\Assets\HDRP`フォルダ　
+* Legacy(Built-in)の場合：`Assets\Samples\Unity Toon Shader\0.0.7-preview\Legacy (built-in)\Runtime`フォルダ  
+* HDRPの場合：`Assets\Samples\Unity Toon Shader\0.0.7-preview\High definition render pipeline\Runtime`フォルダ　
 
 # Unity Toon Shader 設定メニュー：Unity Toon Shaderカスタムインスペクター
 
diff --git a/com.unity.toonshader/Editor/UTS_GUIBase.cs b/com.unity.toonshader/Editor/UTS_GUIBase.cs
@@ -29,7 +29,7 @@ public class UTS_GUIBase : UnityEditor.ShaderGUI
     {
         protected const float kVersionX = 0.0f;
         protected const float kVersionY = 0.0f;
-        protected const float kVersionZ = 6.0f;
+        protected const float kVersionZ = 7.0f;
 
         internal virtual string srpDefaultLightModeName { get; }
         internal virtual void TessellationSetting(Material materal) { }
diff --git a/com.unity.toonshader/Runtime/HDRP/Shaders/HDRPToon.shader b/com.unity.toonshader/Runtime/HDRP/Shaders/HDRPToon.shader
@@ -13,7 +13,7 @@ Shader "HDRP/Toon"
         [HideInInspector] [Enum(OFF, 0, ON, 1)] _isUnityToonshader("Material is touched by Unity Toon Shader", Int) = 1
         [HideInInspector] _utsVersionX("VersionX", Float) = 0
         [HideInInspector] _utsVersionY("VersionY", Float) = 0
-        [HideInInspector] _utsVersionZ("VersionZ", Float) = 6
+        [HideInInspector] _utsVersionZ("VersionZ", Float) = 7
 
         // Syntesized Textures
         _MainTexSynthesized("_MainTexSynthesized",2D) = "white" {}
diff --git a/com.unity.toonshader/Runtime/HDRP/Shaders/HDRPToonTessellation.shader b/com.unity.toonshader/Runtime/HDRP/Shaders/HDRPToonTessellation.shader
@@ -12,7 +12,7 @@ Shader "HDRP/ToonTessellation"
         [HideInInspector] _simpleUI("SimpleUI", Int) = 0
         [HideInInspector] _utsVersionX("VersionX", Float) = 0
         [HideInInspector] _utsVersionY("VersionY", Float) = 0
-        [HideInInspector] _utsVersionZ("VersionZ", Float) = 6
+        [HideInInspector] _utsVersionZ("VersionZ", Float) = 7
         // Syntesized Textures
         _MainTexSynthesized("_MainTexSynthesized",2D) = "white" {}
         _ShadowControlSynthesized("_ShadowControlSynthesized", 2D) = "white" {}
diff --git a/com.unity.toonshader/Runtime/Legacy/Shaders/LegacyToon.shader b/com.unity.toonshader/Runtime/Legacy/Shaders/LegacyToon.shader
@@ -8,7 +8,7 @@ Shader "Toon (Built-in)" {
         [HideInInspector][Enum(OFF, 0, ON, 1)] _isUnityToonshader("Material is touched by Unity Toon Shader", Int) = 1
         [HideInInspector] _utsVersionX("VersionX", Float) = 0
         [HideInInspector] _utsVersionY("VersionY", Float) = 0
-        [HideInInspector] _utsVersionZ("VersionZ", Float) = 6
+        [HideInInspector] _utsVersionZ("VersionZ", Float) = 7
         [HideInInspector] _utsTechnique ("Technique", int ) = 0 //DWF
         [HideInInspector] _AutoRenderQueue("Automatic Render Queue ", int) = 1
 
diff --git a/com.unity.toonshader/Runtime/Legacy/Shaders/LegacyToonTessellation.shader b/com.unity.toonshader/Runtime/Legacy/Shaders/LegacyToonTessellation.shader
@@ -8,7 +8,7 @@ Shader "ToonTessellation (Built-in)" {
         [HideInInspector][Enum(OFF, 0, ON, 1)] _isUnityToonshader("Material is touched by Unity Toon Shader", Int) = 1
         [HideInInspector] _utsVersionX("VersionX", Float) = 0
         [HideInInspector] _utsVersionY("VersionY", Float) = 0
-        [HideInInspector] _utsVersionZ("VersionZ", Float) = 6
+        [HideInInspector] _utsVersionZ("VersionZ", Float) = 7
         [HideInInspector] _utsTechnique ("Technique", int ) = 0 //DWF
         [HideInInspector] _AutoRenderQueue("Automatic Render Queue ", int) = 1
 
diff --git a/com.unity.toonshader/Runtime/UniversalRP/Shaders/UniversalToon.shader b/com.unity.toonshader/Runtime/UniversalRP/Shaders/UniversalToon.shader
@@ -9,7 +9,7 @@ Shader "Universal Render Pipeline/Toon" {
         [HideInInspector] [Enum(OFF, 0, ON, 1)] _isUnityToonshader("Material is touched by Unity Toon Shader", Int) = 1
         [HideInInspector] _utsVersionX("VersionX", Float) = 0
         [HideInInspector] _utsVersionY("VersionY", Float) = 0
-        [HideInInspector] _utsVersionZ("VersionZ", Float) = 6
+        [HideInInspector] _utsVersionZ("VersionZ", Float) = 7
 
         [HideInInspector] _utsTechnique("Technique", int) = 0 //DWF
         [HideInInspector] _AutoRenderQueue("Automatic Render Queue ", int) = 1
diff --git a/com.unity.toonshader/Samples~/.sample.json b/com.unity.toonshader/Samples~/.sample.json
@@ -8,11 +8,11 @@
         {
          "displayName": "Universal RP",
          "description": "Sample scenes for Universal render pipeline.",
-         "path": "Univerasl RP",
+         "path": "Universal RP",
 	  "createSeparatePackage": false
         },
         {
-         "displayName": "High definition render pipeline)",
+         "displayName": "High definition render pipeline",
          "description": "Sample scenes for High definition render pipeline.",
          "path": "HDRP",
 	  "createSeparatePackage": false
diff --git a/com.unity.toonshader/package.json b/com.unity.toonshader/package.json
@@ -1,9 +1,26 @@
 {
 	"name": "com.unity.toonshader",
 	"displayName":"Unity Toon Shader",
-	"version": "0.0.6-preview",
+	"version": "0.0.7-preview",
 	"unity": "2019.4",
 	"description": "Unity Toon Shader (Unity-Chan Toon Shader 3) is a toon shader for images and video that is designed to meet the needs of creators working on cel-shaded 3DCG animations.\nUnlike other pre-render toon shaders, all features can be adjusted in real time on Unity, which is the greatest feature of UTS.\n\nUTS has great power and makes a wide variety of character designs possible, from cel-shaded to light novel illustration styles.\n\nUTS has the 3 basic layers of Base Color, 1st Shade Color, and 2nd Shade Color, colors and textures can also accept a wide variety of customization options, such as High Color, Rim Light, MatCap (sphere mapping), and Emissive (light emission).The level of gradation (feather) between colors can also be adjusted in Unity in real-time.\n\nMore precisely, View documentation above.",
+    "samples": [
+        {
+         "displayName": "Legacy (built-in)",
+         "description": "Sample scenes for the legacy (built-in) pipe-lines.",
+         "path": "Samples~/Legacy (Built-in)"
+        },
+        {
+         "displayName": "Universal RP",
+         "description": "Sample scenes for Universal render pipeline.",
+         "path": "Samples~/Universal RP"
+        },
+        {
+         "displayName": "High definition render pipeline",
+         "description": "Sample scenes for High definition render pipeline.",
+         "path": "Samples~/HDRP"
+        }
+    ],
     "contributors": [      
       "Nobuyuki Kobayashi<nobuyuki@unity3d.com> (https://github.com/Nobuyuki-Kobayashi)",
       "Toshiyuki Mori <toshiyuki@unity3d.com> (https://github.com/higeometry)",
