Unity Ai Probuilder

🚀 Unity 包模板

本项目提供了一个可轻松转换为真实 Unity 包的模板仓库。Unity 编辑器支持 NPM 包，相较于多年来使用的传统插件，它是一种更灵活的解决方案。NPM 包支持版本控制和依赖管理，你可以非常轻松地更新或降级任何包。此外，Unity 编辑器拥有 UPM（Unity 包管理器），这让整个过程更加简单。

🚀 快速开始

本模板仓库旨在能轻松更新为一个真正的 Unity 包。请按照以下说明操作，它将帮助你完成包的创建、分发和安装的整个过程。

📦 安装指南

创建新仓库

1️⃣ 点击按钮，使用此模板在 GitHub 上创建新仓库。

2️⃣ 克隆新仓库并在 Unity 编辑器中打开。

重命名包

3️⃣ 重命名 Package

你的包应该有一个唯一的标识符，即包的 name。它只支持有限的符号，以下是一个包名示例：

com.github.your_name.package

• 👉 用一个或几个能说明包主要用途的词替换 package。
• 👉 name 在全球范围内应该是唯一的。

选项 1：使用脚本重命名包（推荐）

对于 MacOS：

对于 Windows：

cd Commands
.\package_rename.bat Username PackageName

选项 2：手动重命名包

请遵循说明 - 手动重命名包

自定义配置文件

3️⃣ 自定义 Assets/root/package.json

• 👉 更新 name

  示例：com.github.your_name.package 用一个或几个能说明包主要用途的词替换 package。 name 在全球范围内应该是唯一的。

• 👉 更新 unity 以设置支持的最低 Unity 版本。
• 👉 更新
  • displayName - 包的可见名称。
  • version - 包的版本（例如 1.0.0）。
  • description - 包的简短描述。
  • author - 包的作者及作者的链接（可以是 GitHub 个人资料）。
  • keywords - 描述包的关键字数组。

测试相关设置

4️⃣ 是否需要测试？

添加文件

4️⃣ 向 Assets/root 文件夹添加文件

Unity 指南 关于如何将文件组织到包的根目录：

  <root>
  ├── package.json
  ├── README.md
  ├── CHANGELOG.md
  ├── LICENSE.md
  ├── Third Party Notices.md
  ├── Editor
  │   ├── [company-name].[package-name].Editor.asmdef
  │   └── EditorExample.cs
  ├── Runtime
  │   ├── [company-name].[package-name].asmdef
  │   └── RuntimeExample.cs
  ├── Tests
  │   ├── Editor
  │   │   ├── [company-name].[package-name].Editor.Tests.asmdef
  │   │   └── EditorExampleTest.cs
  │   └── Runtime
  │        ├── [company-name].[package-name].Tests.asmdef
  │        └── RuntimeExampleTest.cs
  ├── Samples~
  │        ├── SampleFolder1
  │        ├── SampleFolder2
  │        └── ...
  └── Documentation~
       └── [package-name].md

最终完善

• 用关于你的包的信息更新 README.md 文件（即本文件）。
• 也将更新后的 README.md 复制到 Assets/root 中。

⚠️ 重要提示

root 文件夹之外的所有内容都不会添加到你的包中，但仍可用于在你的仓库中测试或展示你的包。

部署与安装

5️⃣ 部署到你喜欢的任何注册表

• 部署到 OpenUPM（推荐）
• 使用 GitHub 部署
• 部署到 npmjs.com

6️⃣ 将你的包安装到 Unity 项目中

当你的包分发后，你可以将其安装到任何 Unity 项目中。

请不要安装到同一个 Unity 项目中，请使用另一个项目。

• 安装 OpenUPM-CLI
• 在 Unity 项目的根目录（包含 Assets 的文件夹）打开命令行。
• 执行命令（针对 OpenUPM 托管的包）

openupm add AI ProBuilder

📚 详细文档

Unity 包管理器中的最终视图