バージョン管理
Arrival.Space では、Spaces のバックアップ、バージョン管理、移行を行う方法が 3 つ用意されています。すべてのバージョン管理ツールは、Edit Mode の Advanced タブ内にある Versioning セクションにあります。
Export & Import
Space を保存または移行する最もシンプルな方法です。Export では .zip ファイルがコンピューターにダウンロードされ、Import ではそのファイルを再度アップロードします。
1 Export
- Edit Mode に入り、Advanced タブを開きます
- Export Space をクリックします。Versioning 行のダウンロードアイコンからも実行できます
- Space 名をもとにした
.zipファイルがコンピューターにダウンロードされます
2 Import
- Advanced タブで Import Space をクリックします。アップロードアイコンからも実行できます
- 以前に Arrival.Space から Export した
.zipファイルを選択します - Import を確認します。現在の Space 内のすべての Entities はファイル内容で置き換えられます
- Space を別アカウントへ移動する
- Space をコラボレーターとオフラインで共有する
- ローカルのハードドライブにバックアップを残す
Save Version(Snapshots)
Save Version は、いつでも参照、比較、復元できるサーバー側 Snapshot を作成します。外部アカウントや追加設定は不要です。
1 バージョンを保存する
- Advanced タブで Versioning パネルを開きます
- Save Version をクリックします
- このバージョンを説明する任意のメモを入力します。たとえば
lighting の再作業前などです - Snapshot は直ちにサーバーへ保存されます
バージョンを参照する
保存したバージョンは、Save Version ボタンの下に新しい順で一覧表示されます。各項目には次が表示されます。
- バージョンメモ(クリックすると編集)
- 保存日時
2 バージョンを比較する
- 任意のバージョンの diff アイコン をクリックすると、そのバージョンと現在の Space の違いを確認できます。変更は Entity ごとに追加、削除、変更として表示されます。
- 一覧上部の Changes since last version をクリックすると、最新バージョンとの差分として未保存の変更を確認できます。
3 バージョンを復元する
任意のバージョンの restore アイコン をクリックすると、その時点の状態に Space を戻せます。復元後は Space が自動で再読み込みされます。
Space ごとに最大 50 バージョンまで保持されます。この上限を超えると、最も古いバージョンから自動的に削除されます。
GitHub Sync
GitHub Sync を使うと、Space を GitHub リポジトリに接続できます。各 Sync では git Commit が作成され、完全な履歴、Branches、Diffs、変更の取り込みが可能になります。
必要なもの
- GitHub アカウント
- リポジトリ権限を持つ Personal Access Token (PAT)
GitHub Personal Access Token を作成する
- github.com/settings/personal-access-tokens を開きます
- Generate new token をクリックし、Fine-grained token を選択します
- たとえば
arrival-space-syncのような分かりやすい名前を付けます - 有効期限を設定します
- Repository access で All repositories を選ぶか、特定のリポジトリのみに制限します
- Permissions > Repository permissions で以下を設定します
- Contents > Read and write
- Metadata > Read-only(自動で選択されます)
- Administration > Read and write
- Generate token をクリックします
- Token はすぐにコピーしてください。あとから再表示することはできません
PAT はパスワードと同じように扱ってください。Token はブラウザ内にローカル保存され、Arrival.Space のサーバーには保存されません。
初回セットアップ
- Versioning パネルで Push to GitHub をクリックします
- Personal Access Token を入力します
- Repository Name を選択します。既定では Space のタイトルが使われます
- Commit Message を入力します
- Push をクリックします
リポジトリがまだ存在しない場合は、GitHub アカウント配下に private リポジトリとして自動作成されます。
変更を Push する
接続後に Push to GitHub をクリックすると、求められるのは Commit Message だけです。PAT とリポジトリは記憶されます。前回の Push 以降に変更がない場合は、リポジトリがすでに最新であると表示されます。
Branches
初回 Sync 後、GitHub セクションに Branch のドロップダウンが表示されます。以下のことができます。
- 既存の Branches を切り替えて履歴を確認したり、その Branch に Push したりする
- ドロップダウンから + New Branch を選んで新しい Branch を作成する
履歴を表示する
選択中の Branch の Commit 履歴が Branch セレクターの下に表示されます。各 Commit には Message、短いハッシュ、作者、日付が表示されます。
Commits を比較する
任意の Commit の diff アイコン をクリックすると、その Commit の状態と現在の Space を比較した unified diff を確認できます。
GitHub から Pull する
リモート Branch に最後の Sync より新しい Commit がある場合、新しい Commit の数を示す通知が表示されます。それをクリックすると、GitHub の最新バージョンを Space に pull できます。Pull の後、Space は自動的に再読み込みされます。
Commit を復元する
任意の Commit の restore アイコン をクリックすると、リポジトリ履歴上のその時点に Space を正確に戻せます。
保存される内容
3 つの方法、つまり export、snapshot、git sync はすべて同じデータを保存します。
- Space 内の すべての Entities。位置、設定、メタデータは個別の JSON ファイルとして保存されます
- Space settings。タイトル、プライバシー、Lighting、色、および RoomInfo に保存されたすべてのルーム設定が含まれます
- Plugin のソースコード。
.mjsファイルはダウンロードされ、export に含まれます
3D モデル、画像、音声などのバイナリアセットは 含まれません。保存されるのは URL のみです。アセット本体は Arrival.Space の CDN で引き続きホストされます。
Tips
- 定期的にバージョンを保存 して、復元可能な作業履歴を残しましょう
- 意味のあるメモと Commit Message を使うと、あとで特定のバージョンを見つけやすくなります
- リスクのある変更前に Export して、手早いローカル保険を用意しましょう
- GitHub の Token が失効したら、新しいものを作成してください。次回の Push で使われます