Skip to content

Commit bb62260

Browse files
authored
doc: clean up Samples documentation (#664)
* rename sample installation documentation (#663) * reorder the sample list * use <version> instead of a specific package version * rename "ToonShader" scenes to "UnityChan" * add a reference to UnityChan license * update TOC * update links to Unity manuals
1 parent f0b31f4 commit bb62260

File tree

3 files changed

+55
-33
lines changed

3 files changed

+55
-33
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Installing the sample scenes
2+
3+
The **Unity Toon Shader (UTS)** package provides
4+
sample scenes for every supported render pipeline.
5+
Import the sample set that matches the render pipeline currently assigned to your project.
6+
7+
## Before you import
8+
9+
- Confirm that the [render pipeline](https://docs.unity3d.com/6000.0/Documentation/Manual/render-pipelines.html) you intend to use is installed and active.
10+
11+
## Import samples through Package Manager
12+
13+
1. Open the [Package Manager](https://docs.unity3d.com/6000.0/Documentation/Manual/Packages.html).
14+
2. Select **Unity Toon Shader** from the package list.
15+
3. In the **Samples** section, choose the collection that matches your render pipeline.
16+
4. Click **Import**. Unity creates an `Assets/Samples/Unity Toon Shader/<version>/...` folder containing the selected samples.
17+
18+
> Tip: You can re-import the samples at any time. Unity prompts you before overwriting existing files.
19+
20+
## Sample scene overview
21+
22+
### Universal Render Pipeline
23+
24+
`Assets/Samples/Unity Toon Shader/<version>/URP`
25+
26+
- `AngelRing/AngelRing.unity` &mdash; Setup for the [Angel Ring](AngelRing.md) feature.
27+
- `Cube_HardEdge/Cube_HardEdge.unity` &mdash; Reference for baked normals.
28+
- `BoxProjection/BoxProjection.unity` &mdash; Dark room lighting with box projection probes.
29+
- `EmissiveAnimation/EmissiveAnimation.unity` &mdash; Animated [Emission](Emission.md) sequences.
30+
- `LightAndShadows/LightAndShadows.unity` &mdash; Comparison between the PBR shader and UTS.
31+
- `MatCapMask/MatCapMask.unity` &mdash; Using [MatCap](MatCap.md) masks.
32+
- `Mirror/MirrorTest.unity` &mdash; Mirror material setup and testing.
33+
- `NormalMap/NormalMap.unity` &mdash; Normal map techniques tuned with UTS.
34+
- `PointLightTest/PointLightTest.unity` &mdash; Cel-shading examples using point lights.
35+
- `KageBall/KageBall.unity` &mdash; The basics.
36+
- `UnityChan/UnityChan.unity` &mdash; SD Unity-chan model showcasing illustration-style shading.
37+
- `UnityChan_CelLook/UnityChan_CelLook.unity` &mdash; SD Unity-chan model with classic cel-look settings for characters.
38+
- `UnityChan_Emissive/UnityChan_Emissive.unity` &mdash; SD Unity-chan model showing the [Emission](Emission.md) feature.
39+
- `UnityChan_Firefly/UnityChan_Firefly.unity` &mdash; SD Unity-chan model with multiple point lights.
40+
41+
> Unity-chan assets are licensed under the [Unity-Chan License](http://unity-chan.com/contents/guideline_en/)
42+
43+
### Built-in Render Pipeline
44+
45+
`Assets/Samples/Unity Toon Shader/<version>/Built-In RP`
46+
47+
- Mirrors the URP scenes but configured for built-in render pipeline.
48+
49+
### High Definition Render Pipeline
50+
51+
`Assets/Samples/Unity Toon Shader/<version>/HDRP`
52+
53+
- Mirrors the URP scenes but configured for HDRP.
54+

com.unity.toonshader/Documentation~/TableOfContents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* [Box Light](HDRPBoxLight.md)
2424
* [Toon EV Adjustment](ToonEVAdjustment.md)
2525
* [Material Converter](MaterialConverter.md)
26-
* [Samples](sample-instlation.md)
26+
* [Samples](SampleInstallation.md)
2727
* [Feature Difference](FeatureModel_en.md)
2828
* [Known Issues](Known-issue.md)
2929

com.unity.toonshader/Documentation~/sample-instlation.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

0 commit comments

Comments
 (0)