Version: 6000.3
语言: 中文
为包管理器配置网络
为您的包命名

创建自定义包

Unity 包管理器是 Unity 的官方包管理系统。它执行以下作:

  • 允许 Unity 快速轻松地分发新功能并更新现有功能。
  • 为用户提供一个发现和共享可重用组件的平台。
  • 将 Unity 推广为可扩展的开放平台。

您可以使用包管理器来定义项目依赖项、解析包依赖项、下载包、添加包以及在项目中集成内容。

有关什么是包以及 Unity 包管理器如何工作的一般信息,请参阅包入门

概述

包可以包含以下内容:

  • C# 脚本
  • 组件
  • 本机插件
  • 模型、纹理、动画和音频剪辑Unity 中音频数据的容器。Unity 支持单声道、立体声和多声道音频资产(最多 8 个声道)。Unity 可以导入 .aif、.wav、.mp3 和 .ogg 音频文件格式,以及 .xm、.mod、.it 和 .s3m 跟踪器模块格式。更多信息
    请参阅术语表
    和其他资产。

注意:包管理器不支持包中的流式资产。请改用 Addressables 包。

每个包还包含一个包清单每个包都有一个清单,该清单向包管理器提供有关包的信息。清单包含包的名称、版本、用户说明、对其他包的依赖关系(如果有)以及其他详细信息等信息。更多信息
请参阅术语表
文件,其中包含包名称、版本、依赖项列表及其存储库的 URL 等信息。

程序

要创建新包,请执行以下作:

  1. 使用以下方法之一为包创建一个空 shell:

  2. 确保文件夹结构的布局遵循 Unity 包的包布局约定。例如,如果你有编辑器和运行时库,请确保将它们存储在EditorRuntime文件夹。

  3. 如果包包含代码,请确保创建的包布局具有必要的程序集定义文件。有关创建和定义装配定义文件的信息,请参阅装配定义和包。有关其他信息,请参阅装配定义

    注意:如果控制台窗口Unity 编辑器窗口,显示 Unity 或您自己的脚本生成的错误、警告和其他消息。更多信息
    请参阅术语表
    在添加装配定义文件后报告警告,保存项目,将其关闭,然后重新打开。

  4. 添加您的工具、库和包所需的任何资产。

  5. 测试添加到包中。测试对于确保包在不同场景中按预期工作至关重要:

    • 将所有编辑器测试编写在Tests/Editor.
    • 将所有 Play 模式测试写入Tests/Runtime.
  6. 如果您有包的示例,请将它们添加到适当的示例子文件夹中。

    注意:包只能包含示例,但您也可以使用相同的布局和 JSON 结构将示例作为工具或模板包的一部分包含在内。

  7. 更新CHANGELOG.md每次发布新版本时都会添加文件。确定此文件中的新功能、重要更改和主要错误修复。有关所选变更日志格式的更多详细信息,请参阅保留变更日志文档

    对于不共享的包,此步骤是可选的,但强烈建议用于共享包,以便用户知道哪个版本最适合他们的需求。

    提示: 您可以通过在包的package.json清单文件。

  8. 您可以在LICENSE.mdTHIRD PARTY NOTICES.md文件。

    对于不共享的包,此步骤是可选的,但强烈建议对共享包执行此步骤,以便用户不会滥用包或违反任何第三方许可证。

    提示: 您可以提供指向托管此软件包许可和第三方通知的外部网页的链接。使用包的package.json清单文件。

  9. 记录您的包裹。

    提示: 您可以通过在包的package.json清单文件。

  10. 分享您的包。

创建新的嵌入式包

如果要在项目文件夹中创建自定义包,请按照以下说明作。

注意:这些说明是创建自定义包的更大过程的一部分。

  1. 打开 Unity Hub,然后在计算机上创建一个空项目

    您还可以使用计算机上的现有项目,并将包嵌入到项目下从本地文件夹安装包。但是,从新项目开始会使包内容不易出错。

  2. 使用计算机的文件管理器(例如 Windows 文件资源管理器或 macOS Finder),导航到项目文件夹并找到Packages子目录。

  3. Packages文件夹,使用与包名称匹配并遵循命名约定的名称。例如,如果您的包名称是com.example.mypackage,创建一个名为com.example.mypackage.

    注意:如果您的包包含资产,这一点很重要,因为 AssetDatabase 会查找Packages/<your-package-name>/Assets,而不考虑实际的文件夹名称。

  4. 打开您喜欢的文本编辑器并创建一个名为package.json在包文件夹的根目录中。

  5. package.json文件。可以使用包清单示例作为参考。

重新打开 Unity 时,新包将显示在“包管理器”窗口项目窗口一个窗口,显示您的内容Assets文件夹(项目选项卡)更多信息
术语表中查看
,您可以在其中查看和修改包内容。如果您选择package.json文件,也可以直接在检查器一个 Unity 窗口,显示有关当前选定游戏对象、资产或项目设置的信息,允许您检查和编辑值。更多信息
请参阅术语表
窗。

返回到主过程以完成包的创建。

创建新的本地包

如果要在项目文件夹之外创建自定义包,请按照以下说明作。

注意:这些说明是创建自定义包的更大过程的一部分。

  1. 使用计算机的文件管理器(例如 Windows 文件资源管理器或 macOS Finder),为您的包创建一个文件夹。

    如果您已经为包创建了一些内容,也可以使用现有位置。

  2. 打开您喜欢的文本编辑器并创建一个名为package.json在包文件夹的根目录中。

  3. package.json文件,确保name属性遵循命名约定。可以使用包清单示例作为参考。

  4. 在 Unity 中,创建新项目或打开现有项目。

  5. 打开 包管理器 窗口,然后按照安装本地包的说明进行作,使用package.json您刚刚创建的文件。此步骤对于确保创建所需的.meta文件。

新包将显示在“包管理器”窗口和“项目”窗口中,您可以在其中查看和修改包内容。如果您选择package.json文件,也可以直接在“检查器”窗口中修改其 JSON 值。

返回到主过程以完成包的创建。

为包管理器配置网络
为您的包命名