# ConfigurableShaders

**Repository Path**: maoweiming/ConfigurableShaders

## Basic Information

- **Project Name**: ConfigurableShaders
- **Description**: 在Unity中展示着色器属性的强大功能
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-04-08
- **Last Updated**: 2024-04-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Configurable Unity Shaders

![Configurable stencil shader inspector screenshot](../../wiki/images/cutoutExample.gif)

### Access otherwise hidden shader features to understand them
[![openupm](https://img.shields.io/npm/v/com.supyrb.configurableshaders?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.supyrb.configurableshaders/)
[![](https://img.shields.io/github/release-date/supyrb/ConfigurableShaders.svg)](https://github.com/supyrb/ConfigurableShaders/releases)
[![Unity 5.6 or later](https://img.shields.io/badge/unity-5.6%20or%20later-green.svg?logo=unity&cacheSeconds=2592000)](https://unity3d.com/get-unity/download/archive)
![Built-In Render Pipeline](https://img.shields.io/badge/render%20pipeline-builtin-blue.svg)
---

Don't repeat yourself by writing the same shaders over and over again with little variation. You can expose a lot of different shader settings through attributes!
Configurable Shaders does three main things:

1. Provide unlit and lit shaders for Opaque, Cutout and Transparent RenderTypes with a lot of configuration.
2. Provide new useful Material Property Drawers and Debug Shaders
3. Document the hidden features of shaders, that are not that apparent from the Unity Docs.

[Unity Thread](https://forum.unity.com/threads/painless-stencil-shader-with-enums.518966)

## Installation

### Simple Download
[Latest Unity Packages](../../releases/latest)

### Unity Package Manager (UPM)

> You will need to have git installed and set in your system PATH.

Find `Packages/manifest.json` in your project and add the following:
```json
{
  "dependencies": {
    "com.supyrb.configurableshaders": "https://github.com/supyrb/ConfigurableShaders.git#0.7.1",
    "...": "..."
  }
}
```

### OpenUPM

Install the package with [OpenUPM](https://openupm.com/) through the commandline

```sh
# Install openupm-cli
$ npm install -g openupm-cli

# Enter your unity project folder
$ cd YOUR_UNITY_PROJECT_FOLDER

# Add package to your project
$ openupm add com.supyrb.configurableshaders
```

## Wiki ([Home](../../wiki))
* [Rendering](../../wiki/Rendering)
* [Stencil](../../wiki/Stencil)
* [Blending](../../wiki/Blending)
* [BlendModes](../../wiki/BlendModes)
* [Material PropertyDrawers](../../wiki/PropertyDrawers)
* [DebugShaders](../../wiki/DebugShaders)

## Additional Support Notes

* This project is for Unity's Built-In Render Pipeline, and not meant for usage in the Universal Render Pipeline (URP) or the High Definition Render Pipeline (HDRP)
* Alpha 2 Coverage is supported in the Unlit Cutout Shader ([More Information](https://github.com/supyrb/ConfigurableShaders/issues/9))
* Easily Recreate [Diablo BlendAdd](https://www.youtube.com/watch?v=YPy2hytwDLM&feature=youtu.be&t=1217) by setting Blend to `One OneMinusSrcAlpha` ([More Information](https://github.com/supyrb/ConfigurableShaders/wiki/BlendModes))
* Custom [Material PropertyDrawers](../../wiki/PropertyDrawers)
* Single Pass Stereo Rendering for VR
* Shadows are also configured with the settings of the shader (which is great!)

## Examples

Name | Example
--- | ---
Overview Scene | ![Overview Scene Screenshot](https://repository-images.githubusercontent.com/122844243/ea508d80-ee9b-11e9-8c62-e88efcc1d60f)
World Normal Shader | ![WorldNormalShader](../../wiki/images/DebugShaders/WorldNormalDemo.gif)
Depth01 Shader | ![Depth01Shader](../../wiki/images/DebugShaders/Depth01Demo.gif)
Standard Material Properties | ![Depth01Shader](../../wiki/images/ConfigurableStandardMaterial.png)
Custom Property Drawers | ![Custom Material Property Drawers](../../wiki/images/PropertyDrawers/PropertyDrawersMaterial.png) 

## Contribute
Let's make something great together!
* If you find a problem, either create a PR or file an issue
* Post your thoughts in the [Unity Forum Thread](https://forum.unity.com/threads/configurable-shaders-open-source-project.518966/)
* To get in touch [send us a tweet]((https://twitter.com/supyrb))
* Support Supyrb by playing [our games](https://itunes.apple.com/us/app/marbloid/id1207773612)


## Helping Hands & Contributors
* [@Supyrb](https://twitter.com/supyrb) (Owner)
* [@DemlJohannes](https://twitter.com/DemlJohannes)
* [@bgolus](https://twitter.com/bgolus)

## License
* MIT - see [LICENSE](./LICENSE.md)
* Stanford Bunny from https://graphics.stanford.edu/data/3Dscanrep/


*Made by ![💥Supyrb](https://supyrb.com/data/supyrb-inline-logo.svg)*