Installation - BluePixelDev/utilkit GitHub Wiki

Great! Here's the content for your Installation wiki page (Installation.md), clearly explaining both UPM and manual methods:

📦 Installation

There are two main ways to install Utilkit in your Unity project:

Method 1: Unity Package Manager (Recommended)

You can install Utilkit as a Git-based package via Unity's Package Manager.

🔧 Steps:

  1. Open your Unity project.

  2. Navigate to: Edit > Project Settings > Package Manager > Scoped Registries (Optional, if you want to manage custom registries)

  3. Open your Packages/manifest.json file.

  4. Add the following line to the dependencies section:

{
  "dependencies": {
    "com.bluepixel.utilkit": "https://github.com/bluepixeldev/utilkit.git"
  }
}
  1. Save the file and return to Unity. The package will be automatically downloaded and imported.

Method 2: Manual Download

If you prefer to include the source code directly in your project:

  1. Download or clone the repository:
git clone https://github.com/BluePixelDev/utilkit.git
  1. Copy the Utilkit folder into your Unity project's Assets directory.

Verifying Installation

Once imported, you can test by using the namespace in a script:

using BP.Utilkit;

void Start()
{
    Vector3 position = Vector3.zero.SetY(5);
    Debug.Log(position);
}