阅读(4527) (1)

Unity 创建自定义包

2020-10-22 10:54:48 更新

Unity Package Manager 是 Unity 官方的包管理系统。具备以下功能:

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

You can use the Package Manager to define project dependencies, resolve package dependencies, download and add packages as needed, and integrate content in your projects.

有关包的简介以及 Unity Package Manager 工作方式的一般信息,请参阅文档。

概述

包可以包含以下内容:

  • C# 脚本
  • 程序集
  • 原生插件
  • Models, Textures, animation and audio clips, and other assets.

每个包还包含一个包清单文件,其中包含诸如包名称、其版本、其依赖项列表以及其存储库 URL 之类的信息。

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

1.使用下列其中一种方法来为包创建一个空 shell:

* [设置嵌入式包](#EmbedMe)。
* [设置本地包](#LocalMe)。

  1. Implement your tools, libraries, and any assets your package requires.

3.确保包的布局遵循 Unity 包的包布局约定

4.向包添加测试。测试对于确保包在不同情况下能够按预期工作至关重要:

* 将所有 Editor 测试写入 `Tests/Editor` 中。
* 将所有 Playmode 测试写入 `Tests/Runtime` 中。

5.重命名并更新程序集定义文件

6.每次发布新版本时,您都可以更新 CHANGELOG.md 文件。每个新功能或错误修复都应在此文件中包含跟踪。有关所选变更日志格式的更多详细信息,请参阅保留变更日志 (Keep a Changelog) 文档。

对于未共享的包,这是可选的操作,但对于共享的包,强烈建议这样做,以便用户知道哪个版本最符合他们的需求。

7.可以在 LICENSE.mdTHIRD PARTY NOTICES.md 文件中包含许可证和第三方声明

对于未共享的包,这是可选的操作,但对于共享的包,强烈建议这样做,以免用户滥用您的包或违反任何第三方许可证的要求。

8.共享包。

创建新的嵌入式包

Follow these instructions if you want to create a custom package inside your project folder.

  1. Open the Unity Hub, and create an empty project on your computer.

You can also use an existing project on your computer, and embed the package under your project or install the package from a local folder. However, starting with a new project makes the package contents less prone to errors.

  1. Using your computer’s file manager (for example the Windows File Explorer or the macOS Finder), navigate to your project folder and locate the Packages subfolder.

  1. Create a new subfolder for your package inside the Packages folder using a name that matches the package name. For example, if your package is called com.example.mypackage, the subfolder should also be called com.example.mypackage.

Note: This is particularly important if your package contains assets, because the AssetDatabase looks for an asset path that matches Packages/<your-package-name>/Assets, regardless of what the actual folder is called.

4.打开所选的文本编辑器,然后创建一个名为 package.json 的 JSON 文件。

5.将这个文件保存在您创建的新包根文件夹下面。

6.填写包清单 (package.json) 文件中的所有必填字段。

重新打开 Unity 时,新包会显示在 Package Manager 窗口中和 Project 窗口中,可以在其中查看和修改包内容。如果在 Project 窗口中选择 package.json 文件,则也可以直接在 Inspector 窗口中修改其内容。

创建新的本地包

Follow these instructions if you want to create a custom package outside your project folder:

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

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

2.确保您的文件夹结构的布局遵循 Unity 包的包布局约定。例如,如果具有 Editor 库和 Runtime 库,请确保将它们存储在 EditorRuntime 文件夹下。

3.打开所选的文本编辑器,然后创建一个名为 package.json 的 JSON 文件。

4.将这个文件保存在包根文件夹下。

5.填写包清单 (package.json) 文件中的所有必填字段。

  1. In Unity, create a new project or open an existing project.

7.打开 Packages 窗口,然后使用刚刚创建的 package.json 文件,按照安装本地包的说明操作。

新包会显示在 Package Manager 窗口中和 Project 窗口中,可以在其中查看和修改包内容。如果在 Project 窗口中选择 package.json 文件,则也可以直接在 Inspector 窗口中修改其内容。