Untoon Engine

Quick-Start

本页目录

快速开始

目标

新成员第一次接入，把下面几步走通就算跑起来了：

  • 获取 untoon 源码
  • 编译引擎
  • 启动编辑器
  • 创建第一个 Untoon 材质
  • 调整第一盏 Untoon 灯光

获取源码

  1. 克隆仓库。
  2. 切换到 untoon 分支。
  3. 确认本地工作区干净后再执行初始化与编译。

编译引擎

Windows

  1. 运行 Setup.bat
  2. 运行 GenerateProjectFiles.bat
  3. 打开 UE5.sln
  4. 使用 Development Editor | Win64 编译 UE5

macOS

  1. 运行 Setup.command
  2. 运行 GenerateProjectFiles.command
  3. 打开 UE5.xcworkspace
  4. 编译 ShaderCompileWorker
  5. 编译 UE5

Linux

  1. 运行 Setup.sh
  2. 生成工程文件
  3. 按标准 Unreal Engine 工作流编译

创建第一个 Untoon 材质

  1. 新建一个材质。
  2. 将 Shading Model 设置为 Toon。
  3. 如需要自定义 Untoon 光照，在材质中添加 Toon Light 节点；其中 ToonLighting 用于提供风格化颜色，AreaLightLightingModulate 用于调制后置阶段看到的区域光照差分结果。
  4. 如需要控制风格化阴影输出，添加 ToonShadowMask 节点。
  5. 如材质在不同 Untoon Pass 中需要不同结果，使用 ToonPassSwitch。

创建第一个 Untoon 灯光

  1. 在场景中放置一盏 Directional Light 或 Local Light。
  2. 打开 Light|Toon 分类。
  3. 根据需求启用：
    • Enable Toon Base Lighting
    • Enable Toon Rim Lighting
  4. 调整：
    • Untoon Base Lighting Intensity
    • Untoon Light Smooth
    • Untoon Light Offset
    • Untoon Rim Lighting Intensity
    • Rim Color

首次验证建议

第一次接入至少验证这几项：

  • Untoon 材质能正常编译
  • Untoon 材质在场景中能正常受光
  • 默认光照和 Untoon 光照不会互相污染
  • Untoon Rim Light 生效
  • Shadow Mask 流程没有明显异常
  • Outline 合成结果符合预期

下一步

走完这一页之后，接着读：