AzShadersDocument

KO | EN

gitlite — search

#python #react #llm #machine-learning #rust #java #awesome #cli #vue #awesome-list #pytorch #security #ios #openai

AzShadersDocument

(★ 22)

No description available.

AzShadersDocument Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![az_shaders_banner](https://raw.githubusercontent.com/acezen3d/AzShadersDocument/main/images/az_shaders_banner.png)

# Welcome to Az Shaders Document

- [Welcome to Az Shaders Document](#welcome-to-az-shaders-document)
  - [Live](#live)
  - [Draft](#draft)
  - [General information](#general-information)
    - [Texture color space](#texture-color-space)
    - [Texture properties](#texture-properties)
    - [Explicit default](#explicit-default)
    - [Consistency with Unity Standard Shader](#consistency-with-unity-standard-shader)
    - [Shader type](#shader-type)
    - [Shader keyword support](#shader-keyword-support)
    - [Property category support](#property-category-support)
  - [Tutorials](#tutorials)
  - [Notes](#notes)

This is the complete documentation for Az shaders: the shaders created by Acezen for Koikatsu and Koikatsu Sunshine.

## Live
- [Az Shadow shaders](az_shadow/README.md)
- [Az Blur shaders](az_blur/README.md)
- [Az Debug shaders](az_debug/README.md)
- [Az Matcap shaders](az_matcap/README.md)
- [Az Unlit shaders](az_unlit/README.md)
- [Az Standard shaders](az_standard/README.md)
- [Az Planar Reflection shaders](az_planar_reflection/README.md)
- [Az Fur shader](az_fur/README.md)

You can find the mods containing these shaders on my Patreon: https://www.patreon.com/AcezenMod.

## Draft
- [Az Subsurface shaders](az_subsurface/README.md)
- [Az Anisotropic shaders](az_anisotropic/README.md)
- [Az Advanced shaders](az_advanced/README.md)

## General information
### Texture color space
Since Material Editor only allows textures to be imported in gamma color space, many Az shaders perform the color space conversion internally to support linear color space. In other words, the textures are imported in gamma color space, but will be processed as if in linear color space (equivalent to unchecking the "sRGB (Color Texture)" in Unity Editor).

To save space and maintain a neat layout, the color space is abbreviated and appended to the texture type instead of using a separate column.

**Texture2D(G)**: `Texture2D` in gamma color space

**Texture2D(L)**: `Texture2D` in linear color space

The color space labeling of textures serves as a reference during texture creation, as the color space itself plays an important role in rendering. Because gamma and linear color spaces have different value gradients, using textures with a wrong color space may result in unintended visual outcomes.

### Texture properties
In newer Az shaders, certain textures now provide finer control over sampling-related properties, namely `AnisoLevel`, `FilterMode`, and `WrapMode`, making their sampling more appropriate. You need to update Material Editor to v3.13.2 or higher.

### Explicit default
Shader properties themselves have internal default values, which are not visible externally. When a property is not assigned, that value is used. This is called "implicit default".

The shader manifest of Material Editor also allows shader authors to define default values for specific shader properties externally. When switching to that shader, those properties will be assigned the corresponding values. This is called "explicit default". Since this assignment is enforced by Material Editor when switching shaders, such default values are clearly marked as *explicit* as a reminder.

### Consistency with Unity Standard Shader
Az shaders have exactly the same lighting result as Unity Standard Shader under the condition that they use the Standard (isotropic BRDF) model, and the following properties, if present, must have the following values:

*Lighting properties*
- `ShadowIntensity`: 1
- `DirectDiffuseIntensity`: 1
- `DirectSpecularIntensity`: 1
- `IndirectDiffuseIntensity`: 1
- `IndirectSpecularIntensity`: 1
- `ShadowTransitionPower`: 0
- `DummyAmbient`: (0,0,0,1)
- `SampleFullSHPerPixel`: `false`

*PBR properties*
- `Metallic`: $Metallic_{\text{Unity Standard}}={Metallic_{\text{Az}}}^\frac{1}{2.2}$ or $Metallic_{\text{Az}}={Metallic_{\text{Unity Standard}}}^{2.2}$.

### Shader type
Most Az shaders include specific Koikatsu game features, giving them types that suggest their intended use. These types appear as suffixes in the shader names. Most of the shader types listed below are derived from the game's original shaders.

| Shader type      | Potential renderers                              | Typical game shader                   |
| ---------------- | ------------------------------------------------ | ------------------------------------- |
| Skin             | Body, face                                       | `Shader Forge/main_skin`              |
| Subpart          | Tooth, tongue, genital, etc.                     | -                                     |
| Eye              | Eye (iris)                                       | `Shader Forge/toon_eye_lod0`          |
| EyeW             | Eye white (sclera), eyebrow, eyeliner, nose line | `Shader Forge/toon_eyew_lod0`         |
| Hair             | Hair, front hair*                                | `Shader Forge/main_hair`              |
| HairFront        | Front hair                                       | `Shader Forge/main_hair_front`        |
| ItemCutout       | Item, studio item*                               | `Shader Forge/main_item`              |
| ItemAlpha        | Item, studio item*                               | -                                     |
| ItemStudioCutout | Studio item                                      | `Shader Forge/main_item_studio`       |
| ItemStudioAlpha  | Studio item                                      | `Shader Forge/main_item_studio_alpha` |
| ClothCutout      | Clothing                                         | `Shader Forge/main_opaque`            |
| ClothAlpha       | Clothing                                         | `Shader Forge/main_alpha`             |
| LiteCutout       | Item, studio item, clothing                      | -                                     |
| LiteAlpha        | Item, studio item, clothing                      | -                                     |

*: Some shaders also support other renderers to reduce the number of separate shaders needed.

### Shader keyword support
Some Az shaders rely on shader keywords, which are only supported in newer versions of Material Editor. To use these shaders correctly, make sure your Material Editor is updated to v3.3.0 or later. If you use these shaders in older versions, you may get an error that Material Editor fails and other shader mods cannot be loaded.

### Property category support
It is recommended to use Material Editor v3.12.0 or later to display the property categories of certain Az shaders. Additionally, by disabling **Sort Properties by Type** and **Sort Properties by Name** configs, the properties will be sorted in their default order as shown in the documents.

## Tutorials
- [How to set up ambient lighting](tutorials/how_to_set_up_ambient_lighting.md)
- [Auto replace shaders from asset bundles in Unity Editor (Play mode)](tutorials/auto_replace_shaders_from_asset_bundles_in_unity_editor_play_mode.md)

## Notes
- If you need to view previous versions of the documents, please check the commit history.
- If you find any errors in the documents, or if you have any questions, feel free to contact me: [https://linktr.ee/acezen3d](https://linktr.ee/acezen3d).

AzShadersDocument

AzShadersDocument Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

AzShadersDocument

AzShadersDocument Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README