Skip to content

centhoang/PackageEmbedder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Package Embedder 📦

I. Overview

  • Package Embedder is a Unity editor tool that helps you embed packages from Git URLs directly into your project
  • Simplifies the process of converting external Git packages into embedded project folders
  • Ideal for ensuring project stability and avoiding dependency on external package repositories

II. Features

Core Features
  • Embed Git Packages into Project Folders
  • Simple Editor Interface
  • Automated Package Downloading
  • Custom Destination Paths
  • Sample Filtering Option
Benefits
  • No dependency on external Git repositories once embedded
  • Easy modification of package code to suit your project's needs
  • Simplifies version control and team collaboration
  • Better project portability

III. Setup

> Requirements

> Installation

  1. Open Package Manager from Window > Package Manager
  2. Click on the "+" button > Add package from git URL
  3. Enter the following URL:
https://github.com/centhoang/PackageEmbedder.git?path=/PackageEmbedder

Or open Packages/manifest.json and add the following to the dependencies block:

{
    "dependencies": {
        "com.centhoang.package_embedder": "https://github.com/centhoang/PackageEmbedder.git?path=/PackageEmbedder"
    }
}

Important

Use tag(#) to specify a version

Example

https://github.com/centhoang/PackageEmbedder.git?path=/PackageEmbedder#1.0.0

IV. Usage

> Basic Usage

  1. Open the Package Embedder window from Tools > Package Embedder

  2. Configure the following settings:

    • Embedded Path: The target directory where the package will be embedded (default: "Packages")
    • Embedded Folder: The name of the folder to create for the embedded package
    • Package Git URL: The Git URL of the package you want to embed
    • Ignore Samples: Toggle to exclude sample content from the package
  3. Click "Re-Embed and Update Package" to start the process

  4. The tool will:

    • Delete previous embedded version (if existed)
    • Download the package from the Git URL (if needed)
    • Copy its contents to your specified destination
    • Remove the Git package reference
    • Refresh your project

> Example

Embedded Path: Packages
Embedded Folder: PackageName
Package Git URL: https://github.com/username/PackageName.git

This will download the package and embed it at Packages/PackageName in your project.

About

Utility tool for embedding Git packages directly into your Unity project.

Topics

Resources

License

Stars

Watchers

Forks

Languages