Skip to content

Latest commit

 

History

History
120 lines (91 loc) · 5.1 KB

VCC_Package_2024-11.md

File metadata and controls

120 lines (91 loc) · 5.1 KB

GitHubからVRChat Creator Companion（VCC）にパッケージを登録するには、以下の手順を行います。

  1. VCCのインストール: まず、VCCをインストールします。公式サイトからダウンロードし、指示に従ってインストールしてください。

  2. GitHubリポジトリの確認: 登録したいパッケージのGitHubリポジトリにアクセスし、VCC用のvpm.jsonファイルが提供されているか確認します。多くの場合、リポジトリ内にvpm.jsonへのリンクや「Add to VCC」ボタンが設置されています。

  3. VCCへのリポジトリ追加:

    • 方法1: GitHubリポジトリに「Add to VCC」ボタンがある場合、そのボタンをクリックすると、自動的にVCCにリポジトリが追加されます。
    • 方法2: 手動で追加する場合、VCCを起動し、左下の「⚙ Settings」をクリックします。次に「Packages」タブを選択し、「Add Repository」をクリックします。表示されたフィールドに、GitHubリポジトリのvpm.jsonファイルのURLを入力し、「Add」をクリックします。

  4. プロジェクトへのパッケージ導入: VCCの「Projects」タブから、対象のプロジェクトの「Manage Project」を選択します。追加したリポジトリから目的のパッケージを見つけ、右側の「＋」ボタンをクリックしてプロジェクトに導入します。

これらの手順を実行することで、GitHub上のパッケージをVCC経由で管理し、プロジェクトに導入できます。

VRChat用のパッケージをVCCに登録するためのvpm.jsonファイルは、以下の形式に従って作成する必要があります。 vpm.jsonは、パッケージのメタデータを記述するJSONファイルで、パッケージ管理ツール（VPM）で認識されます。

vpm.jsonの基本構造

以下は、vpm.jsonの基本的な構造です。

{
  "name": "com.example.mypackage",
  "displayName": "My Package",
  "version": "1.0.0",
  "description": "This is a description of my package.",
  "author": {
    "name": "Your Name",
    "url": "https://yourwebsite.com"
  },
  "dependencies": {
    "com.vrchat.base": "3.0.0"
  },
  "vpmDependencies": {},
  "repository": {
    "type": "git",
    "url": "https://github.com/username/repository-name.git",
    "revision": "main"
  }
}

各フィールドの説明

  1. name

    • パッケージの一意の名前を指定します。
    • 通常は「com.<組織名またはドメイン>.<パッケージ名>」という形式を使用します。
      例: com.example.mypackage

  2. displayName

    • パッケージ名をユーザーが読みやすい形で表示するために使います。 例: My Package

  3. version

    • パッケージのバージョン番号を指定します。
      例: 1.0.0

  4. description

    • パッケージの説明を記載します。 例: This is a description of my package.

  5. author

    • パッケージの作成者情報を記載します。
      • name: 作成者名または組織名
        例: Your Name
      • url: 作成者のウェブサイトまたは関連リンク
        例: https://yourwebsite.com

  6. dependencies

    • UnityやVRChat関連の依存関係を記載します。 例: com.vrchat.base: "3.0.0"

  7. vpmDependencies

    • 他のVPMパッケージへの依存関係を記載します。 例: 空のままでもOK ({})

  8. repository

    • パッケージのリポジトリ情報を記載します。
      • type: 通常は「git」
        例: "git"
      • url: GitHubなどのリポジトリのURL
        例: "https://github.com/username/repository-name.git"
      • revision: デフォルトで使用するブランチ名またはタグ名
        例: "main"

手順: vpm.jsonの作成

  1. テキストエディタを使用
    メモ帳、VS Code、または他のテキストエディタを開き、上記の内容をコピーして編集します。

  2. 保存
    ファイル名をvpm.jsonとして保存します。必ずJSON形式で保存してください。

  3. リポジトリのルートディレクトリに配置
    作成したvpm.jsonを、GitHubリポジトリのルートディレクトリ（トップ階層）に置きます。

  4. リポジトリをVCCに追加
    作成したリポジトリをVCCに登録する方法に従い、vpm.jsonを読み込ませます。

補足: JSONの構文チェック

作成後に構文エラーがないか確認するには、以下の方法を試してください：

  • オンラインツール: https://jsonlint.com
  • エディタのプラグイン: VS Codeの「Prettier」や「JSON Lint」など

参考リソース