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 包管理器中的最終視圖