コーデックパッケージ定義

カスタム コーデック パッケージは単独でインストール可能であり、インポート後に TSMPSetup によって検出される必要があります。コアはコーデックの具体的な C# クラスを参照しないでください。

パッケージのアイデンティティ

以下のパッケージ名を使用します。

com.kibalab.tsmp.codec.yourcodec

パッケージのメタデータはユーザー向けである必要があります。

{
  "name": "com.kibalab.tsmp.codec.yourcodec",
  "displayName": "TSMP Codec YourCodec",
  "version": "0.0.3-beta.1",
  "author": {
    "name": "KIBA_Labs"
  },
  "description": "A TSMP codec package.",
  "unity": "2022.3",
  "vpmDependencies": {
    "com.kibalab.tsmp.core": ">=0.0.1"
  },
  "dependencies": {
    "com.kibalab.tsmp.core": "0.0.3-beta.1"
  }
}

配布チャネルがサポートしている場合は、VRChat Creator Companion インストールには VPM 依存関係を使用し、UPM スタイルのインストールには Unity 依存関係を使用します。

推奨パッケージ内容

パス	コンテンツ
Runtime	コーデック コンポーネント、ランタイム ヘルパー、シェーダー、マテリアル、プレハブ。
Editor	オプションのコーデック エディターまたはセットアップ ヘルパー。
Samples	ユーザーがインポートするシーンまたはプレハブの例。
package.json	パッケージのメタデータ。
README.md	ユーザー向けの短い使用法の概要。
CHANGELOG.md	バージョンが変わります。
LICENSE.md	ライセンスのテキスト。

組み立てルール

• ランタイム アセンブリは K13A.TSMP.Core に依存する必要があります。
• エディター アセンブリはランタイム アセンブリと Unity エディター アセンブリに依存する必要があります。
• UdonSharp と互換性のあるスクリプトは、UdonSharp がコンパイルできるアセンブリ内に存在する必要があります。
• コアからオプションのコーデック アセンブリへの参照を避けます。

カタログルール

TSMPCodecCatalog アセットまたはコーデック プレハブをリストするプレハブ参照を追加します。セットアップはこれを使用して、[コーデック] タブにデータを設定します。

コーデック プレハブには次のものが含まれている必要があります。

• 1 つの TSMPCodec コンポーネント。
• 素材をエンコード/デコードします。
• 明確なインスペクター名を持つコーデック固有の設定。

バージョン管理ルール

バイト レイアウト、シェーダ シンボル マッピング、または codecId 互換性の変更は、コーデックの破壊的な変更です。セマンティック バージョニングを使用し、変更ログで移行について説明します。