ShatteredPrism

ShatteredPrism

A screen-space shader loader for Casualties Unknown

wiki:  ShatteredPrism - Ethertaco Docs

概述 / Overview

ShatteredPrism is a screen-space shader loader. It allows modders and pack authors to layer custom full-screen shader effects onto the game without writing a single line of C# code. By simply dropping in a JSON manifest and a pre-compiled AssetBundle.

ShatteredPrism 是一个屏幕后处理（screen-space）着色器加载器。它允许模组制作者和效果包作者在不编写任何 C# 代码的情况下，将自定义全屏 Shader 叠加到游戏画面上。只需放入一个 JSON 清单文件和一个预编译的 AssetBundle。

需求 / Requirements

• []BepInEx 5. 4.x[/]

  []ScavLib API (SLA) — This mod is built upon the ScavLib Shader API. / 本模组构建在 ScavLib API 的 Shader API 之上。[/]

安装 / Installation

• []Ensure BepInEx and SLA are installed. / 确保已安装 BepInEx 与 SLA。[/]

  []Place ShatteredPrism.dll into BepInEx/plugins/ShatteredPrism/. / 将 ShatteredPrism.dll 放入插件目录。[/]

  []Create an effects/ folder in the same directory. / 在同目录下建立 effects/ 文件夹。[/]

  []Drop your .json manifests and AssetBundles into the effects folder. / 将你的 .json 清单与 AssetBundle 放入该文件夹。[/]

  []Launch the game and enter any level to see the results. / 启动游戏，进入任意关卡即可看到效果。[/]

  ---

  制作效果包 / Authoring an Effect

  Each effect consists of two files: a JSON manifest describing parameters and an AssetBundle containing your URP shader.

  每个效果由两个文件组成：一个描述参数的 JSON 清单，以及一个包含 URP Shader 的 AssetBundle。

  1. Manifest Example / 清单示例 (effects/my_effect.json)

  "id": "author:vignette",

  "shader": "MyMod/Vignette",

  "bundle": "my_effects",

  "order": 100,

  "enabled": true,

  "floats": [

  { "name": "_Intensity", "value": 0. 9 }

  "colors": [

  { "name": "_Tint", "hex": "#0A0014FF" }

  "pulses": [

  { "name": "_Intensity", "amplitude": 0. 1, "speed": 2. 0, "offset": 0. 9 }

  • []id: Unique identifier for the pass. / 效果的唯一标识。[/]

    []shader: The name declared in the shader file's Shader "..." header. / Shader 文件顶部声明的名字（非文件名）。[/]

    []bundle: AssetBundle filename relative to the manifest. / AssetBundle 文件名（相对路径）。[/]

    []order: Rendering priority; lower values render first. / 渲染顺序；数值越小越先渲染。[/]

    []floats / colors / pulses: Uniforms passed to the shader. Pulses are animated via sine waves. / 传给 Shader 的变量；Pulses 会随时间进行正弦波动。[/]

    2. Shader Requirements / Shader 技术要求

    • []Must be a URP shader compatible with Unity 2022. 3 / URP 14. / 必须是兼容 Unity 2022. 3 / URP 14 的 URP 着色器。[/]

      []The source image is bound to _BlitTexture. Use SAMPLE_TEXTURE2D_X for sampling. / 源图像绑定在 _BlitTexture，请使用 SAMPLE_TEXTURE2D_X 采样。[/]

      []To prevent pink "fallback" shaders, add your shader to Always Included Shaders before building the bundle. / 为防止变体剔除导致画面变粉，打包前请将 Shader 加入 Always Included Shaders。[/]

      ---

      工作原理 / How It Works

      ShatteredPrism itself does not contain any shaders. It acts as a bridge between your assets and the ScavLib Shader API. It handles manifest parsing, asset loading, and pass registration, while ScavLib manages the heavy lifting: URP injection, uniform updates, and frame blitting.

      ShatteredPrism 本身不包含任何 Shader 和 API 实现。它充当了你的资源与 ScavLib Shader API 之间的桥梁，负责解析清单、加载资源与注册通道；而 ScavLib 则负责核心渲染工作：URP 注入、变量更新以及每帧的图像 Blit。

      ---