Giter VIP home page Giter VIP logo

upmgitextension's Introduction

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 | 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

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

  2. Input a git repository url and click Find Versions button.
    In Unity 2019.3.4 or later, you can specify a subdirectory.
  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)





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

  • MIT

Author

mob-sakai

See Also

upmgitextension's People

Contributors

mob-sakai avatar semantic-release-bot avatar andrewcarvalho avatar jzapdot avatar laicasaane avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.