Skip to content

Commit 408d161

Browse files
committed
Update README
1 parent a902027 commit 408d161

2 files changed

Lines changed: 111 additions & 5 deletions

File tree

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ An example of a custom rendering pipeline that restores the rendering of HSR
44

55

66

7+
> [!TIP]
8+
>
9+
> [中文版 README 点这里](./README_CN.md)
10+
11+
12+
713
### Effect
814

915
> [!NOTE]
@@ -28,7 +34,7 @@ Here is a very simple demo for Windows x64:
2834

2935
> [!Tip]
3036
>
31-
> The operation is similar to the game.
37+
> The operation is similar to the game, read Release for more details.
3238
3339

3440
### Project Requirements
@@ -42,13 +48,15 @@ Here is a very simple demo for Windows x64:
4248
>
4349
> Download Git from [this website](https://git-scm.com/downloads), and install.
4450
>
45-
> Then run `` git lfs install``
46-
>
47-
> Use ``git lfs clone https://github.com/ChillyHub/Unity_StarRail_CRP_Sample.git`` to clone
51+
> Then run `` git lfs install``.
52+
>
53+
> Use ``git lfs clone https://github.com/ChillyHub/Unity_StarRail_CRP_Sample.git`` to clone.
54+
>
55+
> If still cannot download it completely, please download the unitypackage package from [Demo Release v0.0.1](https://github.com/ChillyHub/Unity_StarRail_CRP_Sample/releases/tag/v0.0.1).
4856
4957
> [!WARNING]
5058
>
51-
> Currently, there may be memory leak problem in multiple cameras and preview cameras, which needs to be fixed.
59+
> Currently, there may be memory leak problem in multiple cameras and preview cameras, which needs to be fixed. Please note the memory usage.
5260
5361

5462

@@ -66,6 +74,13 @@ The following is the flow chart of the rendering pipeline:
6674
6775

6876

77+
### Source of Assets
78+
79+
- miHoYo: models, textures, animations of characters.
80+
- Viero月城:models, textures of scenes. (such as Mar7th Room)
81+
82+
83+
6984
### Future
7085

7186
- To support decal rendering

README_CN.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Unity_StarRail_CRP_Sample
2+
3+
一个基于URP Renderer Feature 的模仿还原崩坏星穹铁道渲染的自定义渲染管道示例
4+
5+
6+
7+
> [!Tip]
8+
>
9+
> [English README Is Here](./README.md)
10+
11+
12+
13+
### 效果
14+
15+
> [!NOTE]
16+
>
17+
> 初步的效果实例。后面会继续调整并优化相关渲染效果。
18+
19+
![6](./Documents~/README.assets/6.png)
20+
21+
![5](./Documents~/README.assets/5.png)
22+
23+
###### 视频:
24+
25+
https://github.com/ChillyHub/Unity_StarRail_CRP_Sample/assets/75598757/70a140ba-5c9e-45eb-a1bd-00d58aa083cb
26+
27+
https://github.com/ChillyHub/Unity_StarRail_CRP_Sample/assets/75598757/d4a82116-1efc-464e-8d14-abc0946d0067
28+
29+
### 实例程序 Demo
30+
31+
下面是一个非常简单的程序实例,基于 Windows 64 平台。
32+
33+
[Demo Release v0.0.1](https://github.com/ChillyHub/Unity_StarRail_CRP_Sample/releases/tag/v0.0.1)
34+
35+
> [!Tip]
36+
>
37+
> 输入操作类似星穹铁道游戏,详细可看 Release 中的解释。
38+
39+
40+
### 项目依赖
41+
42+
- Unity 2022.3.8f1 (基于 URP 渲染管线)
43+
- Git 和 Git LFS
44+
45+
> [!IMPORTANT]
46+
>
47+
> 克隆项目之前,确保已经安装 Git LFS。否则一些较大的FBX文件无法正确克隆。
48+
>
49+
> [这个网址](https://git-scm.com/downloads)下载并安装 Git 。
50+
>
51+
> 然后运行 `` git lfs install``
52+
>
53+
> 再运行 ``git lfs clone https://github.com/ChillyHub/Unity_StarRail_CRP_Sample.git`` 克隆。
54+
>
55+
> 如果仍然无法完整下载,可以从[Demo Release v0.0.1](https://github.com/ChillyHub/Unity_StarRail_CRP_Sample/releases/tag/v0.0.1)下载 unitypackage 包。
56+
57+
> [!WARNING]
58+
>
59+
> 目前,在编辑器模式下有多相机或预览相机窗口时可能会出现内存泄漏,后面需要修复。请注意内存占用。
60+
61+
62+
63+
### 关于自定义的渲染管线
64+
65+
使用单个 Custom Renderer Feature 来管理所有的自定义 Pass。 使用基于模板的延迟渲染,以更高效的实现更丰富多彩的照明。 此外,每个角色单独进行阴影投射(ShadowCaster),以实现更多可变,自定义的阴影效果。 该管道还有屏幕空间反射(SSR)和 时域抗锯齿(TAA) 来帮助表达更细腻的图像。
66+
67+
以下是渲染管线的流程图:
68+
69+
![Custom Render Pipeline](./Documents~/README.assets/CustomRenderPipeline.png)
70+
71+
> [!TIP]
72+
>
73+
> 了解更多关于渲染管线的信息,可以阅读 [RenderPipeline.md](./Documents~/RenderPipeline.md) 以获取细节。
74+
75+
76+
77+
### 资产来源
78+
79+
- miHoYo: 角色模型,贴图,动作数据。
80+
- Viero月城:三月七房间等场景模型贴图。
81+
82+
83+
84+
### 未来计划
85+
86+
- 支持贴花渲染
87+
- 支持贴花屏幕空间阴影
88+
- 添加 HBAO 屏幕空间阴影
89+
- 添加体积光
90+
- 添加屏幕空间雾效
91+
- 更高效的光晕(Bloom)算法。 (更少的RT切换)

0 commit comments

Comments
 (0)