Skip to content

Commit b2f0f72

Browse files
ga: update README (executed by update_readme.yml)
[skip ci]
1 parent de0e7a8 commit b2f0f72

File tree

1 file changed

+34
-43
lines changed

1 file changed

+34
-43
lines changed

README.md

Lines changed: 34 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,35 @@
11
# Latest official docs
22
- [English](https://docs.unity3d.com/Packages/com.unity.toonshader@latest)
33
- [日本語](https://docs.unity3d.com/ja/Packages/com.unity.toonshader@latest)
4+
# Unity Toon Shader overview
45

5-
# Unity Toon Shader
6-
---
7-
* [Unity Toon Shader](com.unity.toonshader/Documentation~/index.md)
8-
* [Requirements](com.unity.toonshader/Documentation~/System-Requirements.md)
9-
* [Installation](com.unity.toonshader/Documentation~/installation.md)
10-
* [What's new](com.unity.toonshader/Documentation~/whats-new.md)
11-
* [0.10.x-preview](com.unity.toonshader/Documentation~/whats-new-0.10.x.md)
12-
* [0.9.x-preview](com.unity.toonshader/Documentation~/whats-new-0.9.x.md)
13-
* [0.8.x-preview](com.unity.toonshader/Documentation~/whats-new-0.8.x.md)
14-
* [0.7.x-preview](com.unity.toonshader/Documentation~/whats-new-0.7.x.md)
15-
* [0.6.x-preview](com.unity.toonshader/Documentation~/whats-new-0.6.x.md)
16-
* [0.5.x-preview](com.unity.toonshader/Documentation~/whats-new-0.5.x.md)
17-
* [0.3.x-preview](com.unity.toonshader/Documentation~/whats-new-0.3.x.md)
18-
* [Getting Started](com.unity.toonshader/Documentation~/GettingStarted.md)
19-
* [Material Converter](com.unity.toonshader/Documentation~/MaterialConverter.md)
20-
* [Shader Parameter Settings](com.unity.toonshader/Documentation~/Parameter-Settings.md)
21-
* [Modes](com.unity.toonshader/Documentation~/Modes.md)
22-
* [Shader Settings](com.unity.toonshader/Documentation~/Shader.md)
23-
* [Three Color Map and Control Map Settings](com.unity.toonshader/Documentation~/Basic.md)
24-
* [Shading Step and Feather Settings](com.unity.toonshader/Documentation~/ShadingStepAndFeather.md)
25-
* [Normal Map Settings](com.unity.toonshader/Documentation~/NormalMap.md)
26-
* [Highlight Settings](com.unity.toonshader/Documentation~/Highlight.md)
27-
* [Rim Light Settings](com.unity.toonshader/Documentation~/Rimlight.md)
28-
* [Material Capture (MatCap) Setting](com.unity.toonshader/Documentation~/MatCap.md)
29-
* [Emission Settings](com.unity.toonshader/Documentation~/Emission.md)
30-
* [Angel Ring Projection Settings](com.unity.toonshader/Documentation~/AngelRing.md)
31-
* [Scene Light Effectiveness Settings](com.unity.toonshader/Documentation~/SceneLight.md)
32-
* [Metaverse Settings(Experimental)](com.unity.toonshader/Documentation~/Metaverse.md)
33-
* [Outline Settings](com.unity.toonshader/Documentation~/Outline.md)
34-
* [Tessellation Settings(the Built-in Render Pipeline)](com.unity.toonshader/Documentation~/TessellationLegacy.md)
35-
* [Tessellation Settings(HDRP)](com.unity.toonshader/Documentation~/TessellationHDRP.md)
36-
* Additional features for HDRP
37-
* [Box Light](com.unity.toonshader/Documentation~/HDRPBoxLight.md)
38-
* [Toon EV Adjustment](com.unity.toonshader/Documentation~/ToonEVAdjustment.md)
39-
* [Samples](com.unity.toonshader/Documentation~/sample-instlation.md)
40-
* [Feature Difference](com.unity.toonshader/Documentation~/FeatureModel_en.md)
41-
* [Known Issues](com.unity.toonshader/Documentation~/Known-issue.md)
42-
43-
44-
# Post-Cloning Setup on Windows
6+
![An image from the toon-shaded film The Phantom Knowledge in the Scene view of the Unity Editor. A close-up of a girl raising a weapon with a ruined cityscape in the background.](Documentation~/images/TPK_04.png)
7+
8+
The **Unity Toon Shader** (UTS3) is a set of toon shaders designed to meet the needs of creators working on cel-shaded 3D-CG animations.
9+
10+
The **Unity Toon Shader** is compatible with all render pipelines: the **Built-in Render Pipeline**, the **Universal Render Pipeline (URP)**, and the **High Definition Render Pipeline (HDRP)**. However, there are some differences in the features supported by different render pipelines. Please refer to [Feature Difference](Documentation~/FeatureModel_en.md) for details about each render pipeline.
11+
12+
**Unity Toon Shader** is the successor to **Unity-chan Toon Shader ver 2.0 (UTS2)**, which was popular for years in games and animations. However, UTS2 was designed solely for the **Built-in Render Pipeline**, consisted of many different shaders, could not be installed through the [Package Manager window](https://docs.unity3d.com/Manual/upm-ui.html), and had a different license from other Unity software.
13+
14+
## Features of Unity Toon Shader
15+
16+
In animation production, color specialists specify detailed color designs for every scene. UTS can apply these color specifications as written in the design instructions. UTS allows users to apply specific colors for light and shadow areas regardless of the actual light colors in the scene. This feature is essential for cel-shaded character designs. UTS provides detailed control over whether the directional light color affects materials.
17+
18+
Typical color design instruction example:
19+
20+
![A stylized girl in a sailor uniform. A: White highlights on the hair. B: The main blonde hair color. C: Hair in shadow, with a tan color. D: Hair in darker shadow, with a darker tan color.](Documentation~/images/UTS4Color2.png)
21+
22+
- A: Highlight Color
23+
- B: Base Color
24+
- C: 1st Shading Color
25+
- D: 2nd Shading Color
26+
27+
Three basic colors—**base color**, **1st shading color**, and **2nd shading color**—play key roles in character design with the **Unity Toon Shader**. Please refer to [Three Color Map and Control Map Settings](Documentation~/Basic.md) for more information.
28+
29+
Besides the three basic colors, the **Unity Toon Shader** provides a wide variety of features such as [Highlight](Highlight.md), [Rim Light](Rimlight.md), [Emission](Emission.md), [Angel Ring](AngelRing.md), [Material Capture (MatCap)](Documentation~/MatCap.md), and some special maps.
30+
31+
To get started with cel-shading, see [Getting Started](Documentation~/GettingStarted.md).
32+
# Post-Cloning Setup on Windows
4533

4634
This repository utilizes symbolic links to share code across multiple projects.
4735
On Windows 10 or later, symbolic link creation is restricted by default for regular users,
@@ -51,19 +39,19 @@ To resolve this, follow the steps below to enable symbolic link creation and con
5139

5240
1. Open **Local Security Policy** by typing `secpol.msc` on Windows Command Prompt
5341

54-
![](Images/CreateSymbolicLinks_LocalSecurityPolicy.jpg)
42+
![](Documentation~/Images/CreateSymbolicLinks_LocalSecurityPolicy.jpg)
5543

5644

5745
2. Under **User Rights Assignment**, find a policy called **Create symbolic links** and open it.
5846
- Click **Add User or Group**
5947
- Click **Object Types**
6048
- Make sure **Groups** is checked and click **OK**.
6149

62-
![](Images/CreateSymbolicLinks_Properties.jpg)
50+
![](Documentation~/Images/CreateSymbolicLinks_Properties.jpg)
6351

6452
3. Type **USERS** inside the textbox and click on **Check Names** to verify it, then click **OK**.
6553

66-
![](Images/CreateSymbolicLinks_SelectUsers.jpg)
54+
![](Documentation~/Images/CreateSymbolicLinks_SelectUsers.jpg)
6755

6856
4. Configure git to allow symbolic links. For example, by typing the following in Git Bash:
6957

@@ -72,3 +60,6 @@ git config --local core.symlinks true
7260
git config --global core.symlinks true
7361
```
7462

63+
64+
65+
*Auto-generated on Wed Oct 15 12:10:17 UTC 2025*

0 commit comments

Comments
 (0)