Files
com.misaki.hdrp-toon/README.md

58 lines
2.0 KiB
Markdown

# HDRP Toon Shader
A high-quality toon shader for the High Definition Render Pipeline (HDRP).
---
## Overview
The HDRP Toon Shader is designed to provide a high-quality toon shading effect for projects using Unity's High Definition Render Pipeline and Unity 6. This shader is ideal for creating stylized, cartoon-like visuals with smooth shading and vibrant colors.
## Docs
[Documentation Page](https://doc.personalnas.com/books/hdrp-toon-documentations)
## Features
- **High-Quality Toon Shading**: Achieve smooth and vibrant toon shading effects.
- **Customizable Parameters**: Easily adjust the shader parameters to fit your artistic needs.
- **HDRP Compatibility**: Fully compatible with Unity's High Definition Render Pipeline, including ray-tracing.
- **Performance Optimized**: Designed to be efficient and performant for real-time applications.
## Pre-Requirements
1. Unity version: 6000.0.27f1 or later
2. HDRP version: 17.0.0 or later
## Installation
1. Open your Unity project.
2. Go to `Window > Package Manager`.
3. Click on the `+` button and select `Add package from git`.
4. In the url input field, type: `https://git.personalnas.com/Misaki/com.misaki.hdrp-toon.git`.
5. Click ok to add package into your project.
## Usage
1. Create a new material in your Unity project.
2. Assign the HDRP Toon Shader to the material.
3. Apply the material to your 3D models.
4. Adjust the shader parameters in the material inspector to achieve the desired look.
## Examples
Here are some examples of the HDRP Toon Shader in action:
![preview-01.png](https://s2.loli.net/2024/12/26/zHdfSXho4csURyx.png)
## Contributing
If you would like to contribute to the development of the HDRP Toon Shader, please follow these steps:
1. Fork the repository.
2. Create a new branch for your feature or bugfix.
3. Commit your changes and push them to your fork.
4. Create a pull request with a description of your changes.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.