Wiki
デスクトップクライアント
Windows、macOS、Linux 向けの uVersion デスクトップクライアント:インストール、workspace、タブ、設定。
インストール
デスクトップクライアントは Windows、macOS(Apple Silicon)、Linux 向けのネイティブアプリケーションです。Windows、macOS、Linux のインストーラーには uversion CLI も同梱され、利用できるようになります。/downloads からダウンロードしてください。
Windows
uVersion_x.y.z_x64-setup.exe(署名済み NSIS インストーラー、約 25 MB)をダウンロードします。実行するとインストーラーは次を行います。
- クライアントを
%LOCALAPPDATA%\uVersionにインストール(ユーザー単位、管理者権限不要) - インストールフォルダーをユーザー PATH に追加(
uversion.exeCLI がそこに同梱されています) - スタートメニューにショートカットを作成
- Tauri updater による自動アップデートを有効化
macOS(Apple Silicon)
uVersion_x.y.z_macos-arm64.app.zip(約 32 MB、Developer ID 署名済みかつ Apple 公証済み)をダウンロードします。ダブルクリックで解凍し、uVersion.app を /Applications にドラッグします。初回起動時に Gatekeeper が公証を自動的に検証し、警告は表示されません。
uversion CLI はアプリに同梱されています。初回起動時、クライアントは ~/.local/bin/uversion へのシンボリックリンクを自動的に作成し、~/.zprofile を通じて ~/.local/bin を PATH に追加します。手動操作は不要です。新しいターミナルを開けば uversion が利用できます。
注意:Apple Silicon(M1/M2/M3/M4)のみサポートされます。Intel バイナリはありません。
Linux
x86_64 向けに 2 つの形式があります。
-
AppImage(
uVersion_x.y.z_amd64.AppImage、約 76 MB):ポータブルで、すべての依存関係(libwebkit2gtk、libgtk、libsoup など)を同梱します。システムへのインストールなしに、あらゆる Linux ディストリビューションで動作します。chmod +x uVersion_x.y.z_amd64.AppImage ./uVersion_x.y.z_amd64.AppImage -
.deb パッケージ(
uVersion_x.y.z_amd64.deb、約 5 MB):Ubuntu / Debian / 派生ディストリビューション向け。apt がシステムの依存関係を解決します。
アプリはsudo apt install ./uVersion_x.y.z_amd64.deb/usr/bin/uVersionにインストールされます。
注意:uversion CLI は Linux パッケージに同梱されています。初回起動時、クライアントはバイナリを ~/.local/bin/uversion にコピーし、~/.profile を通じて ~/.local/bin を PATH に追加します(手動操作は不要)。
初回起動
初回起動時、クライアントはログインページを表示します。次を入力してください。
- サーバーアドレス:あなたのスタジオのアドレス(例:
https://uversion.mygamestudio.com) - ユーザー名とパスワード
接続すると、クライアントはセッションを安全に記憶します。uversion CLI とエディタープラグイン(Unreal、Rider)は同じ認証情報を自動的に再利用します。他のどこでもパスワードを再入力する必要はありません。
Workspace
workspace はサーバー repository にリンクされたローカルフォルダーです。クライアントは複数の workspace を同時に管理でき、上部のタブバーに表示されます。各 workspace はローカルフォルダーのルートにある .uversion/ にメタデータを保存します。
.uversion/config.toml:owner、repo_id、server URL、workspace UUID.uversion/checkouts_<workspace_id>.json:この workspace であなたが保持している locks.uversion/changelists_<workspace_id>.json:ローカル changelists.uversion/.last_sync:最後に synced されたリビジョン(差分 sync 用)
Files タブ
workspace のファイルをステータス付きでツリー表示します。利用できるフィルター:
- Search:path 内の部分文字列で検索(大文字小文字を区別しない)
- Status filters:Synced、Modified、Local only、Server only、Locked、Deleted
数万ファイル規模のプロジェクトでも、ビューは滑らかなままです。
複数選択とアクション
複数のファイルを選択(クリック + shift、またはチェックボックスをオン)してから:
- Checkout:locks を取得します(idempotent。すでに locked のファイルの再 checkout は no-op)
- Sync:選択したファイルを再ダウンロードします(ローカルでファイルが破損した場合に便利)
- Revert:lock を release し、サーバー版を復元します
Pending タブ
現在 checked-out で、あなたまたは他のユーザーによって locked されているファイル。2 つのセクションがあります。
- Your locks:checkin、revert、または個別に release できます
- Other users' locks:誰が lock を保持しているかが表示され、Production ボードに request カード(
requestバッジ)を作成する Request release ボタンがあります
管理者には、第三者の locks に対する Force unlock ボタンも表示されます。これは保持者の同意なしに lock を release します。すべての force unlock は監査されます。
History タブ
repository の commits のページ分割リストで、作成者、日付、メッセージ、変更されたファイルが表示されます。commit をクリックすると詳細が開きます。その commit のファイル一覧とそれぞれのリビジョンです。
各 commit の Get all ボタンで、そのリビジョンにおけるすべてのファイルのローカルコピーをダウンロードできます(安定した状態を復元するのに便利)。
Production
Production ゾーン(サイドバーの専用エントリ)は、プロジェクトの進捗管理をリポジトリごとにまとめます。Workspace の旧 Activity タブと Requests タブを置き換えました:Workspace は現在、ファイル(Files、Pending、History)に専念します。
My tasks
あなたに割り当てられたカードの一覧。アクセスできるすべてのリポジトリにわたって集約されます。
Board
リポジトリごとの kanban ボード。列は設定可能(デフォルトは To Do、In Progress、Review、Done)。各カードは優先度(low / normal / high / urgent)、ラベル、担当者、期限、コメント、asset や commit へのリンク、カバー画像を持ちます。
request バッジの付いたボードのカードになりました。別の Requests タブはもうありません。
Activity
統合ダッシュボード:
- 24 時間 KPI:commits、アクティブな投稿者、アクティブな locks
- アクティビティカレンダー:数か月にわたる日ごとの commits(heatmap)
- Recent Checkins と Most Modified Directories
- Commit History:ユーザーおよびパスによるフィルター付きのページ分割された commits
Watchlist
パス(glob パターン)を監視して、それらに触れる check-in の通知を受け取ります。各エントリは監視対象のパスと追跡するイベントを示します。
Games
Games ゾーンは、プロジェクト向けに公開された内部プレイテストビルドを一覧表示します。各ビルドはバージョン、構成(DebugGame / Development / Shipping)、プラットフォーム(Win64 / Mac / Linux)、サイズ、リリースノートを示し、プラットフォームに応じたダウンロードボタンが付きます。
これはplaytesterのアクセスポイントです:playtester ロールのアカウントはこのページのみを見ることができ(Workspace も Production も見えません)、自分に開かれたプロジェクトのビルドにのみアクセスできます。
ローカル Changelists
checked-out files を複数の独立した commits にまとめます。changelists はあなたの workspace に対してローカルです(サーバーには送信されません)。次のような用途に便利です。
- 重要な修正を進行中の作業から分離する
- すべてを混ぜずに、複数の送信を並行して準備する
- WIP 用の「default」changelist と、checkin に送るための「review」を保持する
Settings
クライアントのグローバル設定(%APPDATA%/uversion/uVersion/config/config.toml に保存):
| オプション | 説明 |
|---|---|
| Default server URL | ログインページに事前入力されます |
| Username | ログインページに事前入力されます |
| Theme | System / Light / Dark |
| Show hidden files | Files タブで . で始まるファイルを表示します |
| Auto-sync interval | 無効 / 5 分 / 15 分 / 30 分:自動的な差分 sync をトリガーします |
| Parallel uploads | concurrency の上限(1-32、デフォルト 16) |
| Default repos path | clone 時にデフォルトで提案されるフォルダー |
Unreal パネル
クライアントが workspace 内に Unreal プロジェクト(.uproject ファイルの存在)を検出すると、専用パネルが表示されます。IDE を介さずに、クライアントから直接エンジンを操作できます。エディターを開く、コンパイルする、パッケージ化する、といった操作です。ほとんどのアクションは C++ プロジェクトにのみ関係します(純粋な Blueprint プロジェクトはコンパイル不要です)。
Engine path
Unreal のバージョンは .uproject の EngineAssociation から自動検出されます(Windows レジストリ、LauncherInstalled.dat、またはソースビルド)。検出に失敗した場合は手動で上書きできます。このパスは以下のすべてのアクションに必要です。
Open Editor
workspace のプロジェクトで Unreal エディター(UnrealEditor)を起動します。このボタンはべき等です。エディターはウィンドウを表示するまでに数十秒かかることがあり(特に macOS / Linux)、その間に 2 回目のクリックをしても 2 つ目のインスタンスは開きません。エディターの起動中、ボタンには「Opening…」と表示されます。ローカルで一度もコンパイルしていない C++ プロジェクトの場合、エディターを開くとまずプロジェクトファイルの生成、続いてコンパイルが実行されます(自動アクションを参照)。
Compile
プロジェクトをコンパイルします(Unreal Build Tool)。出力は組み込みコンソールにリアルタイムで表示されます。C++ プロジェクトは、エディターで開くため、そしてコードの変更を反映するために、コンパイルする必要があります。
Generate Project Files
IDE のプロジェクトファイルを再生成します(Visual Studio、Rider)。ソースファイルを追加・削除した後や、clone の後に便利です。パネルの 「…」(その他のアクション)メニューにあります。
Package Game
RunUAT BuildCookRun でゲームをパッケージ化し、結果を workspace のルートの Packages/{config}/ にアーカイブします。3 つの構成から選べます。
| Config | 用途 |
|---|---|
DebugGame | デバッグビルド(完全なシンボル、最適化なし)。 |
Development | 開発ビルド(デフォルト):最適化されているが開発ツール付き。 |
Shipping | 配布ビルド:最適化済み、開発ツールなし。 |
Packages/ フォルダーはデフォルトで無視されます(.uversionignore)。パッケージ化されたビルドはバージョン管理されず、Publish Build で配布します。
Publish Build
パッケージ化したビルドを内部プレイテスト版として公開します。チームはクライアントの Games ページからダウンロードできるようになります(playtester ロールまたはビルドへのアクセス権が必要)。クライアントは Packages/{config}/ をスキャンし、ファイルを送信(サーバー側で重複排除)してからマニフェストを登録します。
Open project folder
workspace のフォルダーをシステムのファイルエクスプローラーで開きます(Windows のエクスプローラー、Finder、または Linux の xdg-open)。
Stop
進行中のすべてのビルドを適切に中断します。コンパイルとパッケージ化の両方です。ボタンには停止したビルドの数が表示されます(バックグラウンドで起動した自動コンパイルが含まれることがあります)。
自動アクション
ボタンに加えて、クライアントは C++ プロジェクトが常に最新かつコンパイル可能な状態に保たれるよう、いくつかの Unreal アクションを自動的に実行します。
- check-in の前:コードファイルが変更されている場合、先にプロジェクトがコンパイルされます。コンパイルに失敗すると check-in はブロックされます(コンパイルできないコードは送信しません)。
- sync の後:sync がコードをダウンロードした場合、クライアントはプロジェクトファイルを再生成してから再コンパイルします。
- clone 後の初回起動時(C++ プロジェクト):エディターを開けるようになる前に、プロジェクトファイルの生成、続いてコンパイルが行われます。
これらの自動ビルドはエンジンのロック(Unreal Build Tool -WaitMutex)で直列化されます。互いを拒否せず、順番に実行されます。Stop ボタンでこれらも中断できます。