パッケージのサンプルの作成

2019.1. では、パッケージにサンプルを加えることができます。サンプルとは、コード例、シェーダー、テクスチャ、アニメーションの一部分やその他のファイルで、通常はプロジェクトの Assets フォルダーー内に置かれています。

ユーザーが Package Manager ウィンドウを開いてサンプルを含むパッケージを選択すると、パッケージの詳細ペインに、パッケージ内の各サンプルに対して Import ボタンが表示されます。ユーザーが Import ボタンをクリックすると、Package Manager は、プロジェクトの Assets フォルダーーの下に、そのサンプルのサブフォルダーー構造全体をコピーします。

パッケージにサンプルを加える手順は以下の通りです。

1. アセットファイルや C# コードのサンプルファイルを Samples~ フォルダーー に置いてください。1 つのパッケージに複数のサンプルを加えることができます。Samples~ フォルダーーの各サブフォルダーーに 1 つのサンプルが含まれます。

   Note: The tilde character (~) tells Unity to ignore the contents the Samples~ folder. Such folders aren’t tracked with .meta files.

2. package.json マニフェストファイルの samples 配列の下に 各サンプルの JSON オブジェクト を加えます。

サンプルファイルの場所

サンプルアセットは、パッケージの Samples~ フォルダーーのサブフォルダーーに加えることができます。例えば、シェーダーのサンプルを集めたパッケージは以下のようになります。

MyPackage
  ├── package.json
  └── Samples~
        ├── SamplesHDRP
        │    ├── Textures
        │    |     ├── MossyRock.bmp
        │    |     └── SandyRock.bmp
        │    └── Shader
        │          ├── Lit Texture Blend HDRP.ShaderGraph
        │          └── Lit Vertex Color HDRP.ShaderGraph
        └── SamplesStandard
        │    ├── Textures
        │    |     ├── MossyRock.bmp
        │    |     └── SandyRock.bmp
        │    └── Shader
        │          ├── StandardTextureBlend.shader
        │          └── StandardVertexColor.shader
        └── SamplesUniversalRP
             ├── Textures
             |     ├── MossyRock.bmp
             |     └── SandyRock.bmp
             └── Shader
                   ├── Lit Texture Blend URP.ShaderGraph
                   └── Lit Vertex Color URP.ShaderGraph

マニフェストにサンプルを加える

package.json ファイルに samples という名前の JSON 配列を加えます。各サンプルについて、少なくとも displayName と path を含む JSON オブジェクトを samples フォルダーーに加えます。

例えば、Location of sample files の例とおなじ構造を使って、samples セクションは以下のようになります。

{
    "samples": [
        {
            "displayName": "HDRP Shaders",
            "description": "Contains sample shaders for the High Definition render pipeline",
            "path": "Samples~/SamplesHDRP"
        },
        {
            "displayName": "URP Shaders",
            "description": "Contains sample shaders for the Universal render pipeline",
            "path": "Samples~/SamplesUniversalRP"
        },
        {
            "displayName": "Standard RP Shaders",
            "description": "Contains sample shaders for the Standard render pipeline",
            "path": "Samples~/SamplesStandard"
        }
    ]
}