📤

Unity Package Manager (UPM) に対応した自作パッケージを公開する

2021/02/26に公開

概要

この記事では、この記事作成時点で、自作パッケージを Unity Package Manager (UPM)を通じて使えるように公開する方法(GitHub・OpenUPM)を書きます。

背景

https://github.com/kumaS-nu/NuGet-importer-for-Unity
↑のプロジェクトを公開したい!と思い、どの方法をとればいいかと模索しました。このプロジェクトは以下の記事で宣伝しています。
Unity のプロジェクトに NuGet のパッケージをインポートするエディタ拡張を作ったよ

配信方法

UPM に関して正直あまり情報がなかったのですが、公開先として OpenUPM を選択しました。そのため、OpenUPM に公開するための手順を書いていきます。

パッケージ準備

公開するパッケージに関しては、package.json がちゃんと書けていればパッケージとして認識されます。が、Unity 公式のパッケージレイアウトに従っておいたほうが無難だと思います。package.json のフォーマットはこちら。
パッケージマニフェスト - Unity

GitHub で公開

GitHubで公開するのは非常に簡単です。package.json も含むパッケージ一式を GitHub にパブリックで公開するだけです。このパッケージを利用するには、もし、package.json がルートにあるのであれば、UPM のウィンドウで Add package from git URL をクリックし、Git URL を入力すれば追加できます。package.json がルートになければ、その URL に続き、?path=package.json があるディレクトリまでのパスを入力すれば追加できるようになります。

OpenUPM で公開

OpenUPM は GitHub にあるリポジトリを参照するので、上の GitHub で公開は必須です。OpenUPM で公開するにはそのまま手順道理にやれば問題ありません。
 それでは、順に行きましょう。

  1. まず、OpenUPM のサイトに行き、ヘッダーの Package の左の + をクリックします。
  2. パッケージの情報を入力していきます。画像は、パッケージの紹介に使われる画像[1]として使うものを選びます。
  3. 入力し終わったら、ページ下部の Verify package をクリックします。
  4. GitHub に飛ばされ、openupm のリポジトリに yaml ファイルを追加する画面となります。追加するためのプルリクエストを作ります。
    1. GitHub が不調でプルリクエストを作れなかったら、openupm を自分のところへフォークします。
    2. data/packages に生成された yaml ファイルを追加し、openupm へプルリクエストを出します。
  5. しばらくすると、マージされ OpenUPM に追加されます。

あとがき

自信があるものを公開すると「私すごい!!天才!!!神!!!!」ってなってテンション上がるよね。

参考資料

脚注
  1. gifは動きません。 ↩︎

Discussion