从 Unity 编辑器 2019.1 版本开始,您可以向包中添加示例。示例可能是示例代码片段、一些着色器在 GPU 上运行的程序。 更多信息
参见 术语表和纹理、一些动画或任何其他文件,这些文件通常可以在项目的Assets
文件夹下找到。
当您打开包管理器窗口并选择包含示例的包时,在包的每个示例的详细信息面板中会出现一个**导入**按钮。当您选择**导入**时,包管理器会将该示例的整个子文件夹结构复制到项目的Assets
文件夹下。
要向您的包添加示例
将资源文件或示例 C# 代码文件放在 Samples~ 文件夹下。您可以在一个包中拥有多个示例;Samples~
文件夹的每个子文件夹都包含一个示例。
注意:波浪号字符 (~
) 告诉 Unity 忽略Samples~
文件夹的内容。此类文件夹不会使用.meta
文件进行跟踪。
在您的package.json
清单文件中,在samples
数组下为每个示例添加一个 JSON 对象。
您可以在包的Samples~
文件夹的子文件夹下添加示例资源。例如,包含着色器示例的包可能如下所示
MyPackage
├── package.json
└── Samples~
├── SamplesHDRP
│ ├── Textures
│ | ├── MossyRock.bmp
│ | └── SandyRock.bmp
│ └── Shader
│ ├── Lit Texture Blend HDRP.ShaderGraph
│ └── Lit Vertex Color HDRP.ShaderGraph
└── SamplesStandard
│ ├── Textures
│ | ├── MossyRock.bmp
│ | └── SandyRock.bmp
│ └── Shader
│ ├── StandardTextureBlend.shader
│ └── StandardVertexColor.shader
└── SamplesUniversalRP
├── Textures
| ├── MossyRock.bmp
| └── SandyRock.bmp
└── Shader
├── Lit Texture Blend URP.ShaderGraph
└── Lit Vertex Color URP.ShaderGraph
向package.json
文件添加一个名为samples
的 JSON 数组。对于每个示例,添加一个 JSON 对象,其中至少包含displayName
和指向示例文件夹的path
键 | 描述 |
---|---|
displayName |
示例在包管理器窗口的包详细信息中显示的名称。 |
description |
简要描述示例演示的内容或包含的内容。这仅适用于包清单每个包都有一个清单,它向包管理器提供有关该包的信息。清单包含诸如包的名称、版本、用户描述、对其他包的依赖项(如果有)以及其他详细信息等信息。 更多信息 参见 术语表。描述不会出现在界面中,即使作为工具提示也不会出现。 |
path |
从Samples~ 文件夹到示例根文件夹的路径。 |
例如,使用与示例文件的位置相同的结构,samples
部分类似于以下内容
{
"samples": [
{
"displayName": "HDRP Shaders",
"description": "Contains sample shaders for the High Definition render pipeline",
"path": "Samples~/SamplesHDRP"
},
{
"displayName": "URP Shaders",
"description": "Contains sample shaders for the Universal render pipeline",
"path": "Samples~/SamplesUniversalRP"
},
{
"displayName": "Standard RP Shaders",
"description": "Contains sample shaders for the Standard render pipeline",
"path": "Samples~/SamplesStandard"
}
]
}