Scoped registries

Scoped registries allow Unity to communicate the location of any custom package registry server to the Package Manager so that the user has access to several collections of packages at the same time. Here are some important concepts to help you understand this feature:

概念	説明
package registry server	パッケージを記録し、保存する場所を提供するアプリケーション。Unity の Package Manager ウィンドウで、Unity Registry コンテキストを選択すると、Unity のレジストリに登録されているすべてのパッケージが、リストビュー に表示されます。
package manager	An application that tells the user what packages are available, and downloads and installs whatever package the user requests for their project. Unity has implemented its own version of a package manager, but there are several similar applications in other organizations.
scope	com.example.mycompany.animation や com.example のように、パッケージ名や名前空間 (リバースドメイン形式) を定義します。ユーザーがパッケージを要求すると、Package Manager はレジストリからスコープに最も適合するパッケージを取得します。詳細については、後述の プロジェクトのスコープ付きレジストリの管理 を参照してください。

The way you interact with scoped registries depends on your role:

• Package providers set up custom registry servers to host and distribute custom packages in addition to the Unity registry.
• Package consumers set up scoped registries for each project to access a custom package provider’s registry server.

Integrity and security of scoped registries

As a package provider, make sure any package registry servers you set up conform to Unity’s Terms of Service and Unity’s Package Guiding Principles & Guidelines. Unity provides access to the Package Manager to facilitate sharing knowledge and creations, but not as a marketplace for third-party products.

As a package consumer, when you install a scoped registry, use the same level of caution that you use when installing any other third-party software:

• Install scoped registries only from trusted sources, since the packages in those registries can contain executable code.
• Beware of third-party registries that may be harmful or capture data without appropriate controls. Also beware of third parties misrepresenting themselves as Unity, or sanctioned or supported by Unity.

Benefits of scoped registries

Scoped registries can help to:

• ツール、ライブラリ、その他のアセットを配布することで新しい機能を提供

  As a provider, you can create your own registry to distribute tools and scripts (or other types of assets) with version numbers that indicate how mature the package is. Version numbers also indicate whether updates introduce breaking API changes or minor fixes, based on Semantic Versioning. Your code can depend on code in other packages, because the Package Manager supports package dependencies.

  As a consumer, your experience of browsing and installing third-party custom packages in the Package Manager is the same as browsing Unity’s packages.

• 既存の Unity のパッケージ機能を拡張

  ユーザーとしては、レジストリを手動で切り替えたり、異なるパッケージバージョンを明示的にインストールしたりすることなしに、カスタムパッケージが Unity パッケージをオーバーライドするシームレスな体験をすることができます。これは、パッケージを特定のレジストリにマップすることで、Package Manager が Unity レジストリまたはカスタムパッケージレジストリサーバーのいずれかから取得することができるためです。

• クローズドネットワーク環境でパッケージにアクセス

  組織によっては、クローズドネットワーク (閉域網) の中で仕事をしているために、Unity 自体のパッケージレジストリにアクセスすることが困難な場合があります。このような場合、その組織は、クローズドネットワーク内のサーバーに独自のパッケージレジストリを設定することができます。ネットワーク管理者は、Unity のパッケージレジストリと定期的に同期して、スコープ付きレジストリに最新のパッケージがあることを確認します。

If you are a package consumer, see Managing scoped registries for a project for information about connecting to an existing custom package registry server in your Unity project. If you are a package producer, see Sharing your package for information about supported package registry servers, and to get links to information on how to set them up to use with scoped registries.

Note: If you are setting up a scoped registry that points to a package registry server with restricted access, you can configure Package Manager to pass your npm authentication token to the server. For more information, see Scoped registry authentication.

スコープ付きレジストリのインポート

If you are working in a shared project, and another user adds a scoped registry to the project, Unity warns you that another user added a new scoped registry.

When you click the Close button, the Package Manager project settings window appears so you can add, modify, or remove scoped registries for your project.

代わりに Read more (詳しい情報) ボタンをクリックすると、Unity はこのページをデフォルトのウェブブラウザーで開きます。

ヒント:
To access the Package Manager project settings window at any time, use the main menu in Unity (Edit > Project Settings, then the Package Manager category) or select Advanced Project Settings from the advanced settings menu on the Package Manager window.

プロジェクトのスコープ付きレジストリの管理

プロジェクトのスコープ付きパッケージレジストリを管理するには、プロジェクトマニフェスト ファイルを直接編集するか、Package Manager プロジェクト設定ウィンドウを使用して、Unity にマニフェストを修正させることができます。

[プロジェクトマニフェストは、scopedRegistries プロパティを使用します。このプロパティには、スコープ付きレジストリ構成オブジェクトの配列が含まれています。各オブジェクトには、以下のプロパティが含まれています。

プロパティ	JSON 型	説明
name	文字列	ユーザーインターフェースに表示されるスコープ名。Package Manager ウィンドウは パッケージの詳細ビュー にこの名前を表示します。 例えば、"name": "Tools"
url	文字列	npm と互換性のあるレジストリサーバーの URL。 例えば、"url": "https://mycompany.example.com/tools-registry" ノート: すべてのレジストリプロバイダーが Unity の Package Manager と互換性があるわけではありません。追加しようとしているパッケージレジストリサーバーが、/-/v1/search または /-/all のエンドポイントを実装していることを確認してください。
scopes	文字列の配列	Array of scopes that you can map to a package name, either as an exact match on the package name, or as a namespace. Wildcards and other glob patterns aren’t supported. For example, "scopes": [ "com.example", "com.example.tools.physics" ] Note: This configuration type assumes that packages follow the Reverse domain name notation. This ensures that com.unity is equivalent to any package name that matches the com.unity namespace, such as com.unity.timeline or com.unity.2d.animation. Warning: Unity doesn’t support npm’s scope notation.

When the Package Manager decides which registry to fetch a package from, it compares the package name to the scopes values and finds the registry whose scopes value is the closest match.

例えば、以下のプロジェクトマニフェストには、 General と Tools の 2 つのスコープ付きレジストリがあります。

{
    "scopedRegistries": [
        {
            "name": "General",
            "url": "https://example.com/registry",
            "scopes": [
                "com.example", "com.example.tools.physics"
            ]
        },
        {
            "name": "Tools",
            "url": "https://mycompany.example.com/tools-registry",
            "scopes": [
                "com.example.mycompany.tools"
            ]
        }
    ],
    "dependencies": {
        "com.unity.animation": "1.0.0",
        "com.example.mycompany.tools.animation": "1.0.0",
        "com.example.tools.physics": "1.0.0",
        "com.example.animation": "1.0.0"
    }
}

When the Package Manager looks up the com.example.animation package, it finds that the com.example namespace is the closest match to its name, and fetches that package from the “General” registry.

Package Manager が com.example.tools.physics パッケージを検索すると、“General” レジストリには、パッケージ名と完全に一致するスコープがあります。

When the Package Manager looks up the com.example.mycompany.tools.animation package, the Package Manager finds that the com.example.mycompany.tools namespace is the closest match to its name and fetches that package from the “Tools” registry. Even though it also matches the “General” scope, the com.example namespace isn’t as close a match.

When the Package Manager looks up the com.unity.animation package, the Package Manager doesn’t find a match in any of the scoped registries, so it fetches the package from the default registry.