Skip to content

hadashiA/UpmGitExtension

 
 

Repository files navigation

UPM Git Extension

This package extends the UI of Unity Package Manager (UPM) for the packages installed from git repository.

openupm GitHub release (latest SemVer including pre-releases) PRs Welcome

<< Description | Install | Usage | Development Note >>

What's new? See changelog

Do you want to receive notifications for new releases? Watch this repo

Support me on GitHub!





Description

In Unity 2018.3, the Unity Package Manager (UPM) supported Git. :)
https://forum.unity.com/threads/git-support-on-package-manager.573673/

This update allows us to quickly install packages on code hosting services such as GitHub.
But, I'm not quite satisfied with the feature. :(

  • Incorrect links to documents (readme, changelog, license)
  • There is not a link to repo URL
  • I wanna add, update, and remove the packages in the UI

This project extends the UI of Unity Package Manager for package installed using git!

Features

  • Link to git repository URL
  • Link to offline documents
    • Documentations
    • Changelog
    • License
  • Support GitHub, GitLab, Bitbucket, Azure Dev Ops etc.
  • Install package from git repository URL with UI
  • Update package with a specific tag/branch
  • Remove package
  • Support Unity 2018.3 or later
  • Support .Net 3.5, .Net 4.x and .Net Standard 2.0
  • Version filtering
  • Support GitDependencyResolverForUnity in Unity 2019.1 or later

Future plans





Installation

For Unity 2018.3 or later (Using OpenUPM)

This package is available on OpenUPM.
You can install it via openupm-cli.

openupm add com.coffee.upm-git-extension

For Unity 2018.3 or later (Using Unity Package Manager)

Find the manifest.json file in the Packages folder of your project and edit it to look like this:

{
  "dependencies": {
    "com.coffee.upm-git-extension": "https://github.com/mob-sakai/UpmGitExtension.git",
    ...
  },
}

Requirement

  • Unity 2018.3 or later
  • Git (executable on command-line)





Usage

Install a package from git repository

  1. Click giticon button in package manager UI to open Install Package Window

  2. Input a git repository url and click Find Versions button
  3. Select a tag or branch and click Find Package button
  4. Wait a few seconds for validation
  5. Click Add Package button to install the package

Update package with a specific tag or branch as version

You can update the package in your project, just like official packages.

For Unity 2019.1 or later

  1. Select the version of the package
  2. Click Update To *** button

For Unity 2018.3

  1. Click version popup and select a tag or branch in repository
  2. Click Update To button

Remove package

You can update the package from your project, just like official packages.

  1. Click Remove button





Development Note

Develop a package for UPM

See https://www.patreon.com/posts/25070968, https://www.jianshu.com/u/275cca6e5f17 (Chinese)





License

  • MIT





Support

This is an open-source project that I am developing in my free time.
If you like it, you can support me.
By supporting, you let me spend more time working on better tools that you can use for free. :)

become_a_patron_on_patreon
become_a_sponsor_on_github

Author

mob-sakai

See Also

About

Git extension for Unity Package Manager (UPM)

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 94.6%
  • JavaScript 5.4%