文档

Unity 引擎

Unity 引擎

创建自定义资源包

了解创建新建的 UPM 包的Development工作流程。
阅读时间8 分钟最后更新于 8 天前

Unity 包管理器 是 Unity 的官方包管理System。它执行以下操作:
  • 允许 Unity 快速轻松地分发新建Features和更新现有Features。
  • 为Users提供了发现和共享可重用组件的平台。
  • 将 Unity 推广为可扩展的 Open 平台。
您可以使用 包管理器 来定义Project依赖关系、解析包依赖关系、Download包、添加包以及在Projects中集成内容。
ON 什么是包以及 Unity 包管理器的工作原理的一般信息,请参阅包入门。

概览

包可以包含以下内容:
  • C# 脚本
  • 程序集
  • 原生插件
  • 模型、Textures、动画和音频Clips以及OtherAssets。
注意
包管理器 不Support包中的Streaming Assets。请改用 Addressables 包。
每个包还包含一个包清单文件,其中包含 Package Name、版本、依赖项列表以及代码仓库的网址等信息。

程序

要创建新包,请执行以下操作:
  1. 使用以下方法之一为包个空 shell:
  2. 确保文件夹结构的 Layout 遵循 Unity 包的包 Layout 约定。例如,如果有 Editor 和运行时库,请确保将它们存储在
    Editor
    和
    Runtime
    文件夹下。
  3. 如果包包含代码,请make创建的Layoutyout局具有必要的程序Assembly Definition文件。有关创建和定义 Assembly Definition 文件的信息,请参阅 Assembly Definition 和包。有关其他信息,请参阅程序集定义。
    注意
    如果在添加程序Assembly Definition文件后控制台窗口ReportsWarning,请SaveProject,将其关闭,然后重新打开。
  4. 添加工具、库和包所需的 Any Assets。
  5. 向包添加测试。测试对于确保包在不同情况下按预期工作至关重要:
    • 用
      Tests/Editor
      编写所有 Editor 测试。
    • 用
      Tests/Runtime
      编写所有播放模式测试。
  6. 如果包中有样本,请将它们添加到相应样本子文件夹。
    注意
    包只能包含样本,但也可以使用相同的 Layout 和 json 结构将样本作为工具或模板包的一部分。
  7. 每次发布新建版本时更新
    CHANGELOG.md
    文件。说明此文件中的新建Features、重要更改和主要错误修复。ON所选变更日志 Format 的更多详细信息,请参阅保持变更日志文档。
    对于不共享的包,此步骤是可选的,但对于共享的包,强烈建议这样做,以便Users知道哪个版本最适合自己的需求。
    提示
    您可以通过在包的
    package.json
    清单文件中设置 changelogUrl 属性来提供指向托管此包变更日志的外部网页的 Link。
  8. 您可以在
    LICENSE.md
    和
    THIRD PARTY NOTICES.md
    文件中包含许可证和第三方声明。
    对于不共享的包,此步骤是可选的,但对于共享的包,强烈建议这样做,以便您的Users不会滥用您的包或违反Any第三方许可证。
    提示
    您可以提供指向托管此包的许可和第三方声明的 External Web Page 的 Link。使用包的
    package.json
    清单文件中的 licensesUrl 属性设置 Link。
  9. 记录您的包。
    提示
    您可以通过在包的
    package.json
    清单文件中设置 documentationUrl 属性来提供指向托管此包文档的 External Web Page 的 Link。
  10. 分享你的包。

创建新建的嵌入式入式包

如果要在 Project Folder 中创建 Custom Package,请遵循以下说明。
注意
这些指令是[创建自定义资源包](# procedure)的更大过程的一部分。
  1. 打开 Unity Hub,然后 ON 计算机创建 Empty Project。
    还可以使用计算机上的现有项目,并将包嵌入 Project 下或从本地文件夹安装该包。但是,从新建Project开始会包内容不太容易出错。
  2. 使用计算机的文件管理员(例如 Windows 文件资源管理器或 macOS Finder),导航到 Project Folder 并找到
    Packages
    子目录。
  3. 使用与 Package Name 匹配并遵循命名约定的 Name,在
    Packages
    Folder 中为包新建子目录。例如,如果 Package Name 为
    com.example.mypackage
    ,则创建一个名为
    com.example.mypackage
    的子目录。
    注意
    如果包包含资源,这很重要,因为 AssetDatabase 会查找与
    Packages/<your-package-name>/ Assets
    匹配的资源路径
    (无论实际 Folder Name 如何)。
  4. Open your preferred Text Editor 并在包 Folder 的根目录中创建名为
    package.json
    的 json 文件。
  5. 填写
    package.json
    文件中的所有必填字段和建议字段。您可以使用包清单示例作为参考。
当您重新打开 Unity 时,新建的包将显示在包管理器窗口和 Project 窗口中,您可以在其中查看和修改包内容。如果在 Project 窗口中选择
package.json
文件,还可以直接在 Inspector 窗口中修改其 json 值。
返回到主要程序以完成包的创建。

创建新建的本地包

如果要在 Project Folder 外部创建 Custom Package,请遵循以下说明。
注意
这些指令是[创建自定义资源包](# procedure)的更大过程的一部分。
  1. 使用计算机的文件管理员器(例如 Windows 文件资源管理器或 macOS Finder)为包创建一个Folder。
    如果已经为包创建了一些内容,也可以使用现有位置。
  2. Open your preferred Text Editor 并在包 Folder 的根目录中创建名为
    package.json
    的 json 文件。
  3. 填写
    package.json
    文件中的所有必填字段和建议字段,确保
    name
    属性遵循命名约定。您可以使用包清单示例作为参考。
  4. 在 Unity 中,创建新建Project或Open现有Project。
  5. Open 包管理器窗口,然后按照说明使用刚创建的
    package.json
    文件安装本地包。此步骤对于确保创建所需的
    .meta
    文件至关重要。
新建包将显示在 包管理器 窗口 项目窗口中,您可以在其中查View和修改包内容。如果在 Project 窗口中选择
package.json
文件,还可以直接在 Inspector 窗口中修改其 json 值。
返回到主要程序以完成包的创建。