UPM Git Extension

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

<< Description | Installation | 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 path query parameter (for Unity 2019.3.4f or later)
(2.0.0) Git repositories are cached and installed/searched packages are automatically indexed
- Cached repositories will be shared between different projects
- Cached repository urls will be displayed as history in the installation window
- Indexed packages will be displayed in My Registries
(2.0.0) Add menu to open manifest.json with code editor, open cache directory, clear cache and fetch packages

Installation (for Unity 2020 or later)

Using OpenUPM

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

openupm add com.coffee.upm-git-extension

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",
    ...
  },
}

Installation (For Unity 2018 or 2019)

v2.x supports 2020.1 or later.
Please use v1.x for Unity 2018 or 2019.

Install via OpenUPM

openupm add com.coffee.upm-git-extension@v1

or install via Unity Package Manager

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

Requirement

Unity 2018.3 or later
- Unity 2018 or 2019 -> v1.x
- Unity 2020 or later -> v2.x
Git (executable on command-line)

Usage

Install a package from git repository

Click button in package manager UI to open Install Package Window.
Input a git repository url and click Find Versions button.
In Unity 2019.3.4 or later, you can specify a subdirectory.
Select a tag or branch and click Find Package button.
Wait a few seconds for validation.
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

Select the version of the package
Click Update To *** button

For Unity 2018.3

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

Remove package

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

Click Remove button

Development Note

Develop a package for UPM

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

Contributing

Issues

Issues are very valuable to this project.

Ideas are a valuable source of contributions others can make
Problems show where this project is lacking
With a question you show where contributors can improve the user experience

Pull Requests

Pull requests are, a great way to get your ideas into this repository.
See CONTRIBUTING.md.

Support

This is an open source project that I am developing in my spare time.
If you like it, please support me.
With your support, I can spend more time on development. :)

License

Author

mob-sakai

mob-sakai/UpmGitExtension