命名规范

常见规则

名称 特点
kebab-case 以“-”分隔单词, 全小写字母
PascalCase 单词之间没有分隔, 每个单词的首字母大写
camelCase 单词之间没有分隔, 除第一个单词外的首字母大写
lower_snake_case 以“_”分隔单词, 全小写字母
Upper_Snake_Case 以“_”分隔单词, 首字母大写
SCREAMING_SNAKE_CASE 以“_”分隔单词, 全大写字母

兼容性最好的字符：

  • ABCDEFGHIJKLMNOPQRSTUVWXYZ
  • abcdefghijklmnopqrstuvwxyz
  • 1234567890
  • _

项目内命名规范

场景 使用的命名规则 备注
C#代码文件命 PascalCase
Unity 内的文件夹 PascalCase
静态模型 Mesh Upper_Snake_Case 前缀 SM_
模型材质命名 Upper_Snake_Case 前缀 M_
模型贴图命名 Upper_Snake_Case 前缀 T_
Sprite命名 Upper_Snake_Case

静态模型相关资产命名

模型命名

  1. 使用前缀SM_
  2. 后缀提供更多的上下文，区分该模型使用的材质和贴图

使用场景特定材质和贴图的模型使用后缀_Specific

e.g. SM_Smlall_Station_MM169_Specific

使用了可复用材质和贴图的模型使用后缀_General

e.g. SM_Smlall_Station_MM169_General

模型材质命名

  1. 通用材质：

使用前缀M_ + 材质名

  1. 特定材质（单物体单材质且仅有该物体使用，否则视为通用材质命名）：

使用前缀M_ + 模型名

模型贴图命名：

  1. 通用材质的贴图：

使用前缀T_ + 贴图名

  1. 特定材质（单物体单材质的贴图且仅有该物体使用，否则视为通用贴图命名）：

使用前缀T_ + 模型名

  1. 后缀提供资产的更多上下文，表明其用法，具体规则如下：
  • 基础色/漫反射：_C
  • 法线贴图：_N
  • 自发光：_E
  • AO贴图：_AO
  • 粗糙度贴图：_R
  • 金属度：_M
  • AO+粗糙+金属：_ARM

其它模型、材质及贴图命名

其它的模型、材质及贴图资产命名遵守以下规则：

1
[AssetTypePrefix]_[AssetName]_[Descriptor]_[OptionalVariantLetterOrNumber]
  • AssetTypePrefix 将表明资产的类型
  • AssetName 是资产的名称
  • Descriptor 将提供资产的更多上下文，表明其用法。例如，纹理是贴画（_De）或噪声图（_Noise）
  • OptionalVariantLetterOrNumber 是可选的，用于区分资产的多个版本或变体

列举部分可能会有的其它资产类型：

  • 后处理材质：前缀PPM_
  • 体积纹理：前缀VT_

若有未出现在此处的资产类型，请及时反馈

Sprite资产命名

Sprites 资产命名遵守以下规则：

1
[AssetTypePrefix]_[AssetName]_[Descriptor]_[OptionalVariantLetterOrNumber]
  • AssetTypePrefix 将表明 Sprites 资产的类型，Sprites 资产类型可在下表查询
  • AssetName 是资产的名称
  • Descriptor 将提供资产的更多上下文。例如，角色持有武器状态或 UI 的用途

e.g. 角色持有迅捷剑时的闪避 CH_Evade_Rapier

e.g. 打开内标尺的按钮 UI_OpenInnerRuler_Button

  • OptionalVariantLetterOrNumber 是可选的，用于区分资产的多个版本或变体

e.g. 角色魔剑攻击的第二段 CH_Attack_MagicSword_Second

Sprites类型 前缀
角色 CH_
怪物 MO_
特效 FX_
UI UI_
装备品 EQ_
消耗品 CO_
静态场景 Sprites T_

若有未出现在此处的资产类型，请及时反馈

静态场景 Sprites 的特殊说明

由于该类 Sprites 将会放在场景中的 Quad 上，本质是模型的纹理，故该类 Sprite 实际上是模型 的 Textures，遵守其命名规则，以一个车站钟表（StationClock）为例：

模型文件名：SM_StationClock_Blue

材质名：M_StationClock_Blue

基础色文件名：T_StationClock_Blue_C

法线贴图文件名：T_StationClock_Blue_N

和静态模型一样，如果该物体是某场景特定物品则归入目录“Asset/Art/Scenes/<场景名>/”下，如果是复用物品则归入目录“Asset/Art/StaticMeshes/General/”下

资产文件夹目录

  • Art
    • Scenes
      • SmallStationMM169（场景）
        • StaticMeshes（该场景的模型，使用专属材质和公有材质的模型分成两部分）
        • Materials（该场景模型专属材质，其它模型不再引用）
        • Textures（该场景模型专属贴图，其它材质不再引用）
      • xxx
        • xxx
        • xxx
        • xxx
    • StaticMeshes（复用模型，单独的小物体）
      • General（场景物体模型）
      • FX（特效用模型）
      • xxx
    • Materials（复用材质）
      • General（场景模型材质）
      • Particle（粒子材质）
      • xxx
    • Textures（复用贴图）
      • General（场景模型复用贴图）
      • Noise（复用噪声图）
      • PostProcessing（后处理用贴图）
      • xxx
    • Sprites（Sprites 资产）
      • UI
      • Characters（角色）
      • Monsters（怪物）
      • EQ（装备品）
      • CO（消耗品）
      • FX（特效）