【Unity】自作のC#ライブラリをパッケージマネジャーでインポートできるようにするには

2024年5月29日2024年5月30日

Unityで自作のC#ライブラリをパッケージマネージャーでインポートできるようにするには、Unityのパッケージ形式に従ってパッケージを作成し、それを適切な場所に配置する必要があります。以下の手順に従って進めてください。

制作者側

制作用のUnityエディタを起動して、Assetsフォルダの下に評価テスト用のフォルダを作りこれをgithubにアップして、使用者に使ってもらいます

1. パッケージの構造を作成する

まず、Unityのパッケージの標準的なディレクトリ構造をAssetsフォルダ下に作成します。

MyLibrary/
│
├── package.json
├── MyLibrary.asmdef
├── README.md
├── LICENSE.md
├── Editor/
│   └── MyLibraryEditorScript.cs
└── Runtime/
    └── MyLibraryRuntimeScript.cs

• package.json: パッケージのメタデータを含むファイル。
• MyLibrary.asmdef: アセンブリ定義ファイルです。このファイルにより、Unityがどのスクリプトを同じアセンブリ（コンパイル単位）として扱うかを定義します。
• README.md: パッケージの説明と使用方法。
• LICENSE.md: パッケージのライセンス情報。
• Editor/: エディター用スクリプトを含むフォルダー。
• Runtime/: ランタイム用スクリプトを含むフォルダー。

2. package.jsonを設定する

package.json ファイルを作成し、以下の内容を記述します。このファイルはパッケージのメタデータを定義します。

{
  "name": "com.yourname.mylibrary",
  "version": "1.0.0",
  "displayName": "My Library",
  "description": "A description of my library.",
  "unity": "2020.3",
  "author": {
    "name": "Your Name",
    "email": "your.email@example.com",
    "url": "http://yourwebsite.com"
  }
}

3.MyLibrary.asmdefを設定する

アセンブリ定義ファイルを作成します

下記はサンプルで、未設定のところはデフォルト値が使われます
後述のUnityエディタでの作成では、"name"項目のみ作成されることになります

{
  "name": "MyLibrary",
  "rootNamespace": "MyLibrary",
  "references": [],
  "includePlatforms": [],
  "excludePlatforms": [],
  "allowUnsafeCode": false,
  "overrideReferences": false,
  "precompiledReferences": [],
  "autoReferenced": true,
  "defineConstraints": [],
  "versionDefines": [],
  "noEngineReferences": false
}

各項目の詳細説明

【Unity】アセンブリ定義ファイル

Unityのアセンブリ定義ファイル（Assembly Definition File）は、スクリプトのコンパイル時間を短縮し ...

 https://soft-rime.com/post-17150/

以下は、Unityのアセンブリ定義ファイル（.asmdef）に関する設定項目の詳細説明です。このファイルは、Unityがどのスクリプトを同じアセンブリ（コンパイル単位）として扱うかを定義します。

インスペクターから作成すると、デフォルトで"name"項目のみが列挙されます
他の情報は、デフォルトの情報を使っているため

各項目の詳細説明

1. name:
   • 説明: アセンブリの名前を指定します。この名前は、アセンブリの一意の識別子として使用されます。
   • 例: "MyLibrary"
2. rootNamespace:
   • 説明: アセンブリ内のスクリプトがデフォルトで属するネームスペースを指定します。これにより、スクリプトファイルごとにネームスペースを手動で設定する手間を省くことができます。
   • 例: "MyLibrary"
3. references:
   • 説明: このアセンブリが依存する他のアセンブリをリストします。依存関係にあるアセンブリの名前を含めます。
   • 例: ["AnotherAssembly"]
   • デフォルト: []（空のリスト）
4. includePlatforms:
   • 説明: このアセンブリが含まれるプラットフォームを指定します。特定のプラットフォーム向けにアセンブリを制限したい場合に使用します。
   • 例: ["Editor", "Windows", "iOS"]
   • デフォルト: []（空のリスト）
5. excludePlatforms:
   • 説明: このアセンブリから除外するプラットフォームを指定します。特定のプラットフォームでアセンブリを使用しない場合に使用します。
   • 例: ["Android", "Linux"]
   • デフォルト: []（空のリスト）
6. allowUnsafeCode:
   • 説明: このアセンブリ内で「unsafe」コードを許可するかどうかを指定します。「unsafe」コードは、ポインタを使用するなどの特別な操作を含むC#コードです。
   • 例: trueまたはfalse
   • デフォルト: false
7. overrideReferences:
   • 説明: Unityのデフォルトのアセンブリ参照を無効にし、カスタムの参照を使用するかどうかを指定します。
   • 例: trueまたはfalse
   • デフォルト: false
8. precompiledReferences:
   • 説明: プリコンパイル済みのアセンブリ（.dllファイル）をリストします。このアセンブリが参照する必要がある外部のプリコンパイル済みアセンブリを指定します。
   • 例: ["path/to/precompiled.dll"]
   • デフォルト: []（空のリスト）
9. autoReferenced:
   • 説明: このアセンブリが自動的に他のアセンブリから参照されるかどうかを指定します。このオプションをfalseに設定すると、明示的に参照を追加しない限り、このアセンブリは他のアセンブリから参照されません。
   • 例: trueまたはfalse
   • デフォルト: true
10. defineConstraints:
    • 説明: このアセンブリが有効になる条件を定義するためのプリプロセッサディレクティブをリストします。指定されたディレクティブが定義されている場合にのみアセンブリが有効になります。
    • 例: ["DEBUG", "UNITY_EDITOR"]
    • デフォルト: []（空のリスト）
11. versionDefines:
    • 説明: パッケージのバージョンに基づいて有効になる条件を定義します。特定のバージョン以上のパッケージが存在する場合にのみ、アセンブリが有効になります。
    • 例:
    • デフォルト: []（空のリスト）

[
  {
    "name": "com.unity.somepackage",
    "expression": "1.2.3",
    "define": "SOME_PACKAGE_1_2_3"
  }
]

このアセンブリ定義ファイル（.asmdef）により、Unityプロジェクト内でスクリプトのコンパイルと依存関係の管理を効率化できます。これにより、プロジェクトのビルド時間が短縮され、特定のプラットフォームや条件に応じたカスタムアセンブリの作成が可能になります。

4. スクリプトを作成する

次に、RuntimeフォルダーとEditorフォルダーに必要なC#スクリプトを追加します。

Runtimeスクリプト例

Runtime/MyLibraryRuntimeScript.cs

namespace MyLibrary
{
    public class MyLibraryRuntimeScript
    {
        public void DoSomething()
        {
            // Your runtime code here
        }
    }
}

Editorスクリプト例

Editor/MyLibraryEditorScript.cs

using UnityEditor;

namespace MyLibrary
{
    [CustomEditor(typeof(MyLibraryRuntimeScript))]
    public class MyLibraryEditorScript : Editor
    {
        public override void OnInspectorGUI()
        {
            // Your editor code here
        }
    }
}

自作のC#ライブラリを他の開発者に配布するためには、いくつかの方法があります。以下はその手順です。

5. GitHubにホスティング

GitHubにパッケージをホスティングし、Unityのパッケージマネージャーで直接インポートできるようにする方法です。

MyLibraryフォルダ以下をGit管理します

GitHubDedkTopにMyLibraryフォルダをドラッグ&ドロップし、リポジトリを作成します

新規のリポジトリ作成画面で、.gitignoreファイルは、none未選択（Unityを選択する必要はありません）

上記の手順詳細については省略します

GitHubへパブリッシュ

リポジトリ名をMyLibraryとして、GitHubへパブリッシュします

リポジトリをpublic（公開）にします

PrivateであればPublicへ変更します

Githubでアクセス権をprivateからpublicに変更する

GitHubリポジトリをパブリックに変更する手順は以下の通りです。これにより、リポジトリが全てのユーザ ...

 https://soft-rime.com/post-17155/

{
  "dependencies": {
    "com.example.mypackage": "https://github.com/username/repository.git#branch-or-tag"
  }
}

git config --global url."https://<PAT>@github.com/".insteadOf "https://github.com/"

使用者側

パッケージマネージャからインストール

パッケージマネージャを開きます

＋記号をクリックし、Install package from git URL…を選択します

入力欄に次のURL と.gitを足したのを入力し、インストールします

旧バージョンのUnity

新バージョンのUnity

使い方

ライブラリのコードには、namespaceブロックを追加していますので、インストール後は、次のように使えます

using UnityEngine;
using MyLibrary;

public class ClassName : MonoBehaviour
{
    void Start()
    {
        // ここにコードを記述
    }
}

具体的な手順をサンプルチュートリアルを通して学習しましょう

では、実際に進めてみましょう

製作者側

MyLibraryPackageフォルダを作成

Assets/
└── MyLibraryPackage/

package.jsonの作成

上記のサンプルコードでテキストエディタで作成します

Windowsでは、エクスプローラでMyLibraryPackageフォルダに移動してメモ帳で作成するといいでしょう

直接、Unityエディタ上でCreateすると、スクリプトとして作成されますので、これを回避します

Assets/
└── MyLibraryPackage/
    │
    └── package.json

MyLibrary.asmdefの作成

Assets/
└── MyLibraryPackage/
    │
    ├── package.json
    └── MyLibrary.asmdef

プロジェクトウィンドウMyLibraryPackageフォルダ下で作成します

旧バージョンのUnity

新バージョンのUnity

ファイル名はMyLibrary.asmdefとします

次のようにインスペクタ上でなっていれば、ファイルは自動作成済みです

郵便番号をチェックしてくれるライブラリの作成

今回は、入力された郵便番号が正しいかをチェックして、bool型で返すライブラリを作成したとします

Runtimeスクリプト例

Assets/
└── MyLibraryPackage/
    │
    ├── package.json
    ├── MyLibrary.asmdef
    └── Runtime/
        └── PostalCodeValidator.cs

Assets/MyLibraryPackage/Runtime/PostalCodeValidator.cs

using System.Text.RegularExpressions;

namespace MyLibrary
{
    public class PostalCodeValidator
    {
        public static bool IsValidPostalCode(string postalCode)
        {
            // 日本の郵便番号の形式をチェックする正規表現
            string pattern = @"^\d{3}-\d{4}$";

            // 正規表現を使って郵便番号が正しい形式かどうかをチェック
            return Regex.IsMatch(postalCode, pattern);
        }
    }
}

使用する側スクリプト例

Assets/
└── CheckPostCode.cs

Assets/CheckPostCode.cs

using UnityEngine;
using MyLibrary;

public class CheckPostCode : MonoBehaviour
{
    void Start()
    {
        Debug.Log(PostalCodeValidator.IsValidPostalCode("123-123"));
        Debug.Log(PostalCodeValidator.IsValidPostalCode("123-1234"));
    }
}

実行してテスト

実際に実行して、コンソール画面に正しい結果が表示されるか確認します

Githubへのパブリッシュ

コミット後、パブリッシュして、Githubを更新します

（オプション）オブジェクトの移動をJoyStick入力されたデータで返してくれるライブラリの作成

JoyStick（またはキーボード）入力を受け付け、JoyStickを倒した方向をベクトルで返してもらいます
引数で進む強さを渡すことができます

Runtimeスクリプト例

Assets/
└── MyLibraryPackage/
    │
    ├── package.json
    ├── MyLibrary.asmdef
    └── Runtime/
        └── PostalCodeValidator.cs
        └── Movement.cs

Assets/MyLibraryPackage/Runtime/Movement.cs

using UnityEngine;

namespace MyLibrary
{
    public static class Movement
    {
        // プレイヤーの移動入力を取得し、移動ベクトルを返す
        public static Vector3 KeyMoveVector(float speed)
        {
            // 入力を取得
            float moveX = Input.GetAxis("Horizontal");
            float moveY = Input.GetAxis("Vertical");

            // 移動ベクトルを作成
            return new Vector3(moveX, moveY, 0f) * speed * Time.deltaTime;
        }
    }
}

使用する側スクリプト例

Assets/
└── Move.cs

Assets/Move.cs

using MyLibrary;
using UnityEngine;

public class Move : MonoBehaviour
{
    float speed = 5f;

    void Update()
    {
        transform.Translate(Movement.KeyMoveVector(speed));
    }
}

使用者側

パッケージマネージャを開きます

＋記号をクリックし、Install package from git URL…を選択します

入力欄に次のURL と.gitを足したのを入力し、インストールします

上記、使用する側と同じでいいですね

郵便番号チェック

Assets/
└── CheckPostCode.cs

Assets/CheckPostCode.cs

using UnityEngine;
using MyLibrary;

public class CheckPostCode : MonoBehaviour
{
    void Start()
    {
        Debug.Log(PostalCodeValidator.IsValidPostalCode("123-123"));
        Debug.Log(PostalCodeValidator.IsValidPostalCode("123-1234"));
    }
}

（オプション）オブジェクトの移動

Assets/
└── Move.cs

Assets/Move.cs

using MyLibrary;
using UnityEngine;

public class Move : MonoBehaviour
{
    float speed = 5f;

    void Update()
    {
        transform.Translate(Movement.KeyMoveVector(speed));
    }
}