Unity Ai Probuilder

🚀 Unity Package Template

This template simplifies creating, distributing, and installing Unity packages using NPM and UPM, offering flexibility and easy version management.

🚀 Quick Start

Unity Editor supports NPM packages, a more flexible solution compared to the classic plugins Unity has used for years. NPM packages support versioning and dependencies, allowing you to easily update or downgrade any package. Additionally, the Unity Editor has UPM (Unity Package Manager), which further simplifies the process.

This template repository can be easily updated into a real Unity package. Follow the instructions below to complete the entire process of package creation, distribution, and installation.

📦 Steps to Make Your Package

1️⃣ Create a New Repository on GitHub

Click the button to create a new repository on GitHub using this template.

2️⃣ Clone and Open in Unity Editor

Clone your new repository and open it in the Unity Editor.

3️⃣ Rename Package

Your package needs a unique identifier, called the name of the package. It supports only limited symbols. Here is a sample package name:

com.github.your_name.package

• 👉 Replace the word package with one or a few words that describe the main purpose of the package.
• 👉 The name should be globally unique.

Option 1: Use Script to Rename Package (Recommended)

For MacOS

For Windows

cd Commands
.\package_rename.bat Username PackageName

Option 2: Manual Package Rename

Follow the instruction - manual package rename

3️⃣ Customize Assets/root/package.json

• 👉 Update name

  Sample: com.github.your_name.package Replace the word package with one or a few words that describe the main purpose of the package. The name should be globally unique.

• 👉 Update unity to set the minimum supported Unity version.
• 👉 Update
  • displayName: The visible name of the package.
  • version: The version of the package (e.g., 1.0.0).
  • description: A short description of the package.
  • author: The author of the package and the URL to the author (could be a GitHub profile).
  • keywords: An array of keywords that describe the package.

4️⃣ Decide on Tests

4️⃣ Add Files to Assets/root Folder

Refer to Unity guidelines for organizing files in the package root directory.

  <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

Final Polishing

• Update the README.md file (this file) with information about your package.
• Copy the updated README.md to Assets/root as well.

⚠️ Important Note

Everything outside the root folder won't be included in your package, but it can still be used for testing or showcasing your package in your repository.

5️⃣ Deploy to a Registry

• Deploy to OpenUPM (recommended)
• Deploy using GitHub
• Deploy to npmjs.com

6️⃣ Install Your Package in a Unity Project

Once your package is distributed, you can install it in any Unity project.

💡 Usage Tip

Don't install it in the same Unity project; use another one.

• Install OpenUPM-CLI

• Open a command line at the root of the Unity project (the folder containing Assets).

• Execute the command (for OpenUPM hosted packages)

  openupm add AI ProBuilder
  

📸 Final View in Unity Package Manager