[cluster] UploadWorldCli
- [支援版] UploadWorldCliDigital100 JPY
- [無償版] UploadWorldCliDigital0 JPY
![[cluster] UploadWorldCli](https://booth.pximg.net/d9f61a1a-2ce8-48b2-956a-6a9660c356fa/i/8673461/3220d0d5-48e4-474a-a455-bb457f268c07_base_resized.jpg)
# UploadWorldCli CLI(コマンドラインインターフェース)から Unity をバッチモードで実行し、現在開いているシーンを検証・ビルドした上で cluster ワールド(Venue)へ自動アップロードするためのツールです。 CI/CD 環境での自動デプロイや、Unity Editor を起動せずにターミナルから素早くアップロードしたい場合に便利です。 ## 機能概要 - **トークンのローカル保存**: 初回のみトークンを設定すれば、次回以降は自動で保存されたトークンをロードしてアップロードします(cluster Creator Kit が使用する `EditorPrefs` のセキュア保存領域を再利用します)。 - **複数プラットフォームの自動ビルド**: Windows, Mac, iOS, Android 向けの各アセットバンドルを一括でビルドしてアップロードします。 - **シーンの検証**: cluster の制約を満たしているかアップロード前に `VenueValidator` による検証を行います。 --- ## 使い方 ### 1. 初回設定(トークンの保存) Webマイページから取得した cluster のアクセストークンをローカル環境(Unity EditorPrefs)に安全に保存します。 ```bash /Applications/Unity/Hub/Editor/<UnityVersion>/Unity.app/Contents/MacOS/Unity \ -batchmode \ -projectPath "/Volumes/SSD/work/Unity/work/FishingTemplate" \ -executeMethod ClusterVR.CreatorKit.Editor.Window.VenueUpload.ClusterCliUploader.UploadWorld \ -setToken "YOUR_CLUSTER_ACCESS_TOKEN" \ -logFile - ``` ※アクセストークンの保存のみを行うため、このコマンドではワールドのアップロードは行われません。 ### 2. 2回目以降のアップロード 一度トークンを設定すれば、次回以降は `-venue` を指定するだけでアップロードが可能です。 ```bash /Applications/Unity/Hub/Editor/<UnityVersion>/Unity.app/Contents/MacOS/Unity \ -batchmode \ -projectPath "/Volumes/SSD/work/Unity/work/FishingTemplate" \ -executeMethod ClusterVR.CreatorKit.Editor.Window.VenueUpload.ClusterCliUploader.UploadWorld \ -venue "YOUR_VENUE_NAME_OR_ID" \ -scene "Assets/Scenes/YourScene.unity" \ -logFile - ``` ※ `Editor/UploadWorldCli/UploadWorldCli.sh` を使用して実行することもできます。 --- ## 引数仕様 | 引数 | 必須/任意 | 説明 | | :--- | :--- | :--- | | `-setToken <token>` | 任意 | 初回トークン設定用。渡されたトークンでログインテストを行い、ローカルに保存します。 | | `-venue <nameOrId>` | 必須(アップロード時) | アップロード対象の「ワールド名」または「Venue ID」。(`-venueId` でも動作します) | | `-scene <path>` | 任意 | アップロード対象のシーンファイル(`.unity`)のプロジェクト相対パスを指定します。指定しない場合は現在開かれているアクティブシーンが対象になります。 | | `-token <token>` | 任意 | 直接トークンを指定してアップロードしたい場合に使用(保存されたトークンより優先されます)。 | | `-preview` | 任意 | 本番公開ではなくテスト用スペースとしてアップロードする場合に指定します。 | | `-beta` | 任意 | ベータ機能を使用しているワールドの場合に指定します。 | | `-logFile -` | 任意 | ログを標準出力(ターミナル)にリアルタイムで出力します。 |
