https://github.com/stalomeow/StarRailNPRShader

Fan-made shaders for Unity URP attempting to replicate the shading of Honkai: Star Rail.
https://github.com/stalomeow/StarRailNPRShader

3d anime game honkai-star-rail honkai-starrail hoyoverse mihoyo npr shader star-rail starrail toon unity urp

Last synced: 4 months ago
JSON representation

Fan-made shaders for Unity URP attempting to replicate the shading of Honkai: Star Rail.

• Host: GitHub
• URL: https://github.com/stalomeow/StarRailNPRShader
• Owner: stalomeow
• License: gpl-3.0
• Created: 2023-08-06T08:50:58.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-02-28T10:25:00.000Z (4 months ago)
• Last Synced: 2024-02-28T10:25:53.993Z (4 months ago)
• Topics: 3d, anime, game, honkai-star-rail, honkai-starrail, hoyoverse, mihoyo, npr, shader, star-rail, starrail, toon, unity, urp
• Language: C#
• Homepage:
• Size: 22.2 MB
• Stars: 305
• Watchers: 6
• Forks: 66
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• awesome-unity3d - StarRailNPRShader - Fan-made shaders for Unity URP attempting to replicate the shading of Honkai: Star Rail. (Open Source Repositories / Effect-Toon)

README

        
# StarRailNPRShader

> [!IMPORTANT]

> Please read this file before using the shaders!!!

[中文翻译点这里](README_CN.md)

Fan-made shaders for Unity URP attempting to replicate the shading of Honkai: Star Rail. The shaders are not 100% accurate because this project is not a reverse engineering - what I do is to replicate the in-game looks to the best of my ability.

![sparkle](Screenshots~/sparkle.png)

↑↑↑ Sparkle ↑↑↑


![firefly](Screenshots~/firefly.png)

↑↑↑ Firefly ↑↑↑


## Character shaders

- Honkai Star Rail/Character/Body

- Honkai Star Rail/Character/Body (Transparent)

- Honkai Star Rail/Character/EyeShadow

- Honkai Star Rail/Character/Face

- Honkai Star Rail/Character/FaceMask

- Honkai Star Rail/Character/Hair

The rendering of character takes advantage of MRT whose pass is always executed after UniversalForward. Transparent objects using normal URP Shader and transparent objects on characters are divided into two groups for rendering, which may cause problems.

## Post-processing

- Custom bloom using the method shared by Jack He in Unite 2018.

- Custom ACES tonemapping. The formula is

    $$f(x)=\frac{x(ax+b)}{x(cx+d)+e}$$

    where $a,b,c,d,e$ are all parameters.

## Installation

### Install via git URL

Install these packages **in order**. The second one requires Unity >= 2022.3.

1. https://github.com/stalomeow/ShaderUtilsForSRP.git

2. https://github.com/stalomeow/StarRailNPRShader.git

![install](Screenshots~/_install.png)

### RenderPipeline settings

- Use linear color space instead of gamma.

- Use forward rendering path.

- Disable depth priming.

- Add `StarRailForward` RendererFeature to the renderer.

### Recommended post-processing settings

Post-processing is important; be sure to add it.

![post-processing settings](Screenshots~/_postprocessing.png)

### Per-Object Shadow for character

Add the `PerObjectShadowCaster` component to the root object of a character. It supports up to 16 shadows on the same screen.

![per-obj-shadow](Screenshots~/_per_obj_shadow.png)

### Other tips

- It is recommended to turn on HDR.

- Please reset the material after changing its shader.

- This project implements its own screen space shadows. Please do not add the `ScreenSpaceShadows` RendererFeature of URP again.

## Advanced topics

- [Working with asset preprocessor](Documentation~/WorkingWithAssetPreprocessor.md)

- [Working with HSRMaterialViewer](Documentation~/WorkingWithHSRMaterialViewer.md)

- [For MMD models](Documentation~/ForMMDModels.md)

- [FAQ](Documentation~/FAQ.md)

## Rules

In addition to GPL-3.0 license, please give proper credits as well as a link to this repo when redistributing or using my code.

## Special thanks

- miHoYo

- Related posts on Zhihu

- Related videos on bilibili

- °Nya°222