# PotaToon Documentation

PotaToon is an animation-style toon rendering asset designed for URP Forward(+) environments and PC/Console platforms.


- [Open Sources](https://potatoon.dev/open-sources): List of open source libraries used in PotaToon including lilToon, Tony McMapface, OIT, and various tonemapping implementations.
- [Getting Started](https://potatoon.dev/getting-started): Initial setup guide for PotaToon in Unity URP. Covers Auto Setup, Manual Setup, required components (Renderer Feature, Global Volume, Character Component), disabling PotaToon, and unlocking advanced settings.
- [Features](https://potatoon.dev/features): Overview of PotaToon key features including Normal/Concert modes, character self-shadowing, OIT, material types (General, Face, Eye), rendering modes, and post-processing. Explains how to adjust settings via Volume and Material.
 - [Volume Settings](https://potatoon.dev/features/volume-settings): Detailed Volume settings reference for PotaToon. Covers Normal/Concert modes, Shadow Direction, Follow Layer Mask, Transparent Shadow, Quality, Max Material Brightness, Character/Environment Post Processing, Global Char Shadow Settings, and OIT.
 - [Material Settings](https://potatoon.dev/features/material-settings): Detailed material settings reference for PotaToon. Covers General, Face, Eye, and Gem material types with global rendering controls, shading, alpha mask, color grading, refraction, OIT, stencil / ZTest, and pass control.
 - [Character Component](https://potatoon.dev/features/character-component): Documentation for PotaToonCharacter component. Covers Head transform connection, Dither Fade settings, Character Checking utility, All Materials list, and All Materials Control for batch editing.
 - [Presets](https://potatoon.dev/features/presets): Documentation for PotaToon preset system. Covers saving and loading Volume and Material presets, texture handling, and preset export.
 - [OIT (Transparent Rendering)](https://potatoon.dev/features/oit): Documentation for OIT (Order-Independent Transparency) feature in PotaToon. Covers accurate transparent object rendering, usage in Volume settings, platform support, and important notes about blending modes.
- [Important Notes](https://potatoon.dev/important-notes): Critical configuration notes for PotaToon. Covers Depth Priming Mode, Mesh Bounds, Face SDF texture requirements, HDR considerations, and appearance issues.
- [Wait! Is something wrong?](https://potatoon.dev/error-handling): Troubleshooting guide for PotaToon issues including character appearing black or white, jagged shadow edges, Character Shadow artifacts on low-poly meshes (Depth Bias / Normal Bias), preset not applying, and Bloom rendering problems.
- [Best Practices](https://potatoon.dev/best-practice): Best practices for modeling and shading a character with PotaToon.
- [Utility Tools](https://potatoon.dev/utility-tools): Built-in utility tools in PotaToon including Prefab Duplication, Material Conversion, and Material Finder.
- [Recommended Assets to Use](https://potatoon.dev/recommended-assets): Recommended third-party assets to enhance PotaToon including Volumetric Fog, Screen Space Reflection, and Animation Volume Component.
- [Using on Mobile](https://potatoon.dev/mobile-support): Guide for using PotaToon on mobile devices. Covers platform limitations, recommended Volume Quality settings, and disabling Transparent Shadows and OIT for mobile.
- [Warudo Pro | Meligo](https://potatoon.dev/virtual-softwares): PotaToon integration with virtual content creation software Warudo Pro and Meligo.
- [Changelog](https://potatoon.dev/changelog): Complete changelog index for PotaToon listing all version updates with features, bug fixes, and improvements.
 - [V1.4.3](https://potatoon.dev/changelog/v1.4.3): Performance Mode and Alpha Mask are now available, Gem now has Character Mask Pass control, build and shader performance has been improved, and several Gem Refraction, 2D Face Shadow, Eye Shader GUI, and shader warning issues have been cleaned up.
 - [V1.4.2](https://potatoon.dev/changelog/v1.4.2): Added custom ZTest/ZWrite controls and expanded opaque render queue flexibility, improved 2D face shadow behavior around transparent meshes, and fixed Unity 6.4 compile errors and warnings.
 - [V1.4.1](https://potatoon.dev/changelog/v1.4.1): Fixed an issue where Light Layer was not supported on the Main Light.
 - [V1.4.0](https://potatoon.dev/changelog/v1.4.0): Added official Gem shader workflow, expanded material color/lighting controls, per-material OIT and pass control options, and fixes for OIT HDR color, preset application, Visual Compositor compatibility, and warnings.
 - [V1.3.9](https://potatoon.dev/changelog/v1.3.9): Added Outline Lighting Dimmer and UX improvements with help links and Dither Fade tooltips. Bug fix for Character Component now only valid on root GameObject.
 - [V1.3.8](https://potatoon.dev/changelog/v1.3.8): Screen Rim consistency improvements. Bug fixes for Eye shader sampling, ForwardPlus warnings, APV support, OpenGLES build errors, and render queue updates.
 - [V1.3.7](https://potatoon.dev/changelog/v1.3.7): Outline Pass optimization for transparent objects. Bug fixes for OIT artifacts, Convert utility, default textures for MatCap/FaceSDF, NormalMap Tiling/Offset, and Dither Fade Undo.
 - [V1.3.6](https://potatoon.dev/changelog/v1.3.6): Added Dither Fade feature, Blending Mode selection for translucent types, Eye shader surface types, and multi-material editing. Optimization for Outline Pass and bug fixes for Cutout mode, translucent rendering, and Material Presets.
 - [V1.3.5](https://potatoon.dev/changelog/v1.3.5): Added Character Checking utility and improved Auto Setup for 2021/2022 LTS. Bug fixes for Scene View object selection and Eye Shader depth pass culling.
 - [V1.3.4](https://potatoon.dev/changelog/v1.3.4): Bug fixes for Render Texture allocation, Unity 6.2 warnings, and URP package dependency removal.
 - [V1.3.3](https://potatoon.dev/changelog/v1.3.3): Added White Balance option and updated Volume UI. Bug fix for Screen Outline with Bloom and HDR color support.
 - [V1.3.2](https://potatoon.dev/changelog/v1.3.2): Screen Rim improvements with light direction and per-material overrides. Added GT Tone mapping and Shadow Direction Control with Local/World modes. Bug fix for Fallback-Shadow distance.
 - [V1.3.1](https://potatoon.dev/changelog/v1.3.1): Added 2D Face Shadow mode and MatCap Lighting Dimmer. Bug fixes for 2021 LTS memory leak and Outline lighting attenuation.
 - [V1.3.0](https://potatoon.dev/changelog/v1.3.0): Added Unity 2021 LTS support. Bug fixes for Eye Shader depth passes and SRP Batcher compatibility.
 - [V1.2.3](https://potatoon.dev/changelog/v1.2.3): Eye shader improvements with Clipping Mask, indirect lighting support, and highlight color. Bug fix for Face SDF MidTone lighting.
 - [V1.2.2](https://potatoon.dev/changelog/v1.2.2): Environment Post Processing update with Color Grading and Bloom. Added Duplicate Materials button in Character Component. Bug fix for Mid Tone with local lights.
 - [V1.2.1](https://potatoon.dev/changelog/v1.2.1): Bug fixes for light source shadow with Receive Light Shadow option, Global Normal Bias, and MidTone rendering with low Max Material Brightness.
 - [V1.2.0](https://potatoon.dev/changelog/v1.2.0): Character shadow quality improvement with Culling Distance option. Bug fixes for Unity 6.2 compile error and Guide Warning changes.
 - [V1.1.4](https://potatoon.dev/changelog/v1.1.4): Added ShinyRim Volume preset. Bug fix for Screen Rim and Character Bloom interaction.
 - [V1.1.3](https://potatoon.dev/changelog/v1.1.3): Added Custom ToneMapping mode and improved Screen Rim Light with color bleeding. Bug fixes for AO Map lighting and Material Preset issues.
 - [V1.1.2](https://potatoon.dev/changelog/v1.1.2): Added Indirect Lighting Dimmer and Face SDF debugging feature. Bug fixes for Spot Light intensity in Concert Mode and character appearing black issues.
 - [V1.1.1](https://potatoon.dev/changelog/v1.1.1): Added Outline Depth Offset and Advanced Settings unlock in Material UI. Added Guide Warning system and fixed shader build warnings.
 - [V1.1.0](https://potatoon.dev/changelog/v1.1.0): Major UX update with Preset system, Material search, Copy/Paste settings, change notifications, MatCap Weight slider, and Face SDF UV Tiling/Offset. Bug fixes for Max Brightness and Post Processing shaders.
 - [V1.0.4](https://potatoon.dev/changelog/v1.0.4): Added character shadow direction offset option for Normal mode.
 - [V1.0.3](https://potatoon.dev/changelog/v1.0.3): Added Screen Space Outline Inner/Outer option and improved character shadow culling. Bug fixes for Utility Tool and Character Editor.
 - [V1.0.2](https://potatoon.dev/changelog/v1.0.2): Added Screen Space Outline, FaceSDF compatibility with lilToon/Poiyomi, GI support, Light Layer support, Vertex Color support, and Eye shader Stencil. Bug fixes for MidTone and Transparent Shadow.
 - [V1.0.1](https://potatoon.dev/changelog/v1.0.1): Character Soft Shadow quality improvement. Bug fixes for FaceSDF Shadow and MatCap Lighting.
 - [V1.0.0](https://potatoon.dev/changelog/v1.0.0): Initial release of PotaToon.
- [Roadmap](https://potatoon.dev/roadmap)
 - [planned](https://potatoon.dev/roadmap/planned)
  - [Fur shader type](https://potatoon.dev/roadmap/planned/fur-shader-type)
 - [under-consideration](https://potatoon.dev/roadmap/under-consideration)
  - [Custom DOF](https://potatoon.dev/roadmap/under-consideration/custom-dof)
  - [Material Settings Animation Controller](https://potatoon.dev/roadmap/under-consideration/material-settings-animation-controller)
  - [Mobile Platform Support](https://potatoon.dev/roadmap/under-consideration/mobile-platform-support)