阅读(2985)
赞(12)
Unity 包清单
2020-10-22 11:35:12 更新
Unity 使用包清单文件 (package.json) 来管理有关特定包的特定版本的信息。包清单始终位于包的根目录，并且包含有关包的重要信息，例如其注册名称和版本号。包清单还定义了与用户通信的有用信息，例如出现在 UI 中的用户友好名称、包的简要说明以及该包兼容的最低 Unity 版本。
包清单使用 JSON（JavaScript 对象表示法）语法来描述包中包含的内容。该文件的格式类似于 npm 的 package.json 格式，但是其某些属性使用了不同的语义。
Package Manager 读取此清单以确认包中包含的内容，如何解压缩其内容，以及在 Package Manager 窗口中向用户显示哪些信息。清单将此信息存储在一系列必需、强制和可选属性中。
必需属性
这些属性是必需的。如果不存在这些属性，则注册表在发布包时会拒绝该包，或者 Package Manager 无法获取或加载该包。
| 属性 | JSON 类型 | 描述 |
|---|---|---|
| name | String | 官方注册的包名称。此名称必须遵循 Unity Package Manager 命名约定，也就是使用反向域名表示法。 名称必须满足以下条件： - 以 com.<公司名称> 开头。 - 若要在 Editor 中显示，长度不得超过 50 个字符；如果无需在 Editor 中显示，则不得超过 214 个字符。 - 仅包含小写字母、数字、连字符 (-)、下划线 (_) 和句点 (.)。 - 要指示嵌套的命名空间，请为命名空间添加一个句点作为后缀。 例如，com.unity.timeline 是实现 Unity Timeline 的包的名称。 注意：这是一个唯一标识符，而不是出现在 Package Manager 窗口的列表视图中的用户友好名称。 |
| version | string | 包版本号 (MAJOR.MINOR.PATCH)。 例如，“3.2.1”表示这是第 3 个主要发行版、第 2 个次要发行版和第 1 个补丁。 该值必须遵守语义版本控制。有关更多信息，请参阅版本控制。 |
强制属性
这些属性在技术上是可选的，即使它们不包含有效值或者缺失，Package Manager 仍可以将它们装入到项目中。但是，您应该为这些属性值提供值，以使您的包易于发现，并为包使用者提供更好的体验。
| 属性 | JSON 类型 | 描述 |
|---|---|---|
| displayName | String | 一个显示在 Unity Editor 中的用户友好名称（例如，显示在 Project Browser 中、Package Manager 窗口中，等等）。 例如，Unity Timeline、ProBuilder 或 In App Purchasing。 |
| description | String | 包的简要描述。这是在 Package Manager 窗口的详细信息视图中显示的文本。支持任何 UTF–8 字符代码。这意味着您可以使用特殊格式的字符代码，例如换行符 (\n) 和项目符号 (\u25AA)。 |
| unity | String | 指示包兼容的最低 Unity 版本。如果省略，则认为该包与所有 Unity 版本兼容。 预期格式为“<主要版本>.<次要版本>”（例如，2018.3）。要指向特定补丁，还要使用 unityRelease 属性。 注意：与 Unity 不兼容的包将不会出现在 Package Manager 窗口中。 |
可选属性
这些属性是可选的，这意味着您可以省略它们。但如果存在，则必须具有有效值。
| 属性 | JSON 类型 | 描述 |
|---|---|---|
| unityRelease | String | Unity 版本的一部分，指示与包兼容的特定 Unity 版本。当更新的包需要在 Unity alpha/beta 开发周期中进行更改时（例如，如果该包需要新引入的 API，或该包使用的现有 API 以非向后兼容方式进行更改而不遵循 API Updater 规则），则可以使用此属性。 预期格式为“<更新><发行版本>”（例如 0b4）。 注意：如果省略 unity 属性，则此属性没有效果。 与 Unity 不兼容的包不会出现在 Package Manager 窗口中。 |
| dependencies | 对象 | 包依赖关系映射。键是包名称，值是特定版本。它们指示此包依赖的其他包。 注意：Package Manager 不支持范围语法，仅支持 SemVer 版本。 |
| keywords | 字符串数组 | Package Manager 搜索 API 使用的关键字数组。这可以帮助用户找到相关的包。 |
| type | String | 为 Package Manager 提供其他信息的常量。 保留仅供内部使用。 |
| author | 对象 | 包的创作者。 该对象包含一个必填字段 (name) 和两个可选字段 (email) 和 (url)。 例如： { "name" : "John Doe", "email" : "john.doe@example.com", "url" : "http://john.doe.example.com/" } |
包清单示例
{
"name": "com.unity.example",
"version": "1.2.3",
"displayName": "Package Example",
"description": "This is an example package",
"unity": "2019.1",
"unityRelease": "0b5",
"dependencies": {
"com.unity.some-package": "1.0.0",
"com.unity.other-package": "2.0.0"
},
"keywords": [
"keyword1",
"keyword2",
"keyword3"
],
"author": {
"name": "Unity",
"email": "unity@example.com",
"url": "https://www.unity3d.com"
}
}