uVersion
日本語
ダウンロード →

Wiki

検証ルール

チェックイン時に実行されるアセット検証チェック : 9つの組み込みルール、error / warning / info の重要度、JSON設定、エクスポート / インポート / リセット。

はじめに

検証ルールは、チェックイン時に実行される Unreal アセットのチェックです : 命名、テクスチャ サイズ、依存関係の欠落など。コンテンツがリポジトリに入る前に、スタジオの規約を自動的に強制するためのものです。設定は リポジトリごとに行います。

アクセスとロール

ルールタブは、スーパー管理者と、自身が管理するリポジトリ上の project_admin が利用できます。

自動シード まだルールを持たないリポジトリのルールを初めて開くと、9つのデフォルトルールが自動的に作成されます。そのため常に完全な セットから始めて、調整していく形になります。

重要度

重要度チェックイン時の効果
error問題が修正されるまでチェックインをブロックします。
warning警告しますが通過させます。
info純粋に情報提供のみです。

9つの組み込みルール

組み込みルールの一覧。各ルールに有効化スイッチと error/warning/info の重要度メニューが付いています。
ルールデフォルトチェック内容
blueprint_compilationerrorチェックイン前に Blueprint がエラーなくコンパイルされること。
naming_conventionwarning命名プレフィックス(Allar UE5 スタイル): T_ テクスチャ、M_ マテリアル、BP_ ブループリント、SM_ スタティックメッシュ、WBP_ ウィジェットなど。
max_texture_sizewarningテクスチャの最大サイズ : デフォルトは 4096 × 4096、2の累乗が必須。
material_complexitywarningマテリアルの複雑さ : デフォルトで最大 256 命令、16 テクスチャサンプル。
import_settingswarning準拠したインポート設定(テクスチャ、メッシュ)。
missing_dependencyerror依存関係の欠落がないこと(デフォルトでエンジンコンテンツを無視)。
circular_dependencyerror循環依存がないこと(デフォルトの探索深度は 20)。
unreferenced_assetinfo参照されていないアセットを報告します(デフォルトでマップとウィジェットを除外)。
duplicate_assetwarning重複したアセットを検出します(デフォルトで .umap を無視)。

有効化と設定

JSON設定エディタを展開したルールと Save Config ボタン。

各ルールについて :

  • スイッチ : ルールを有効化 / 無効化します。即時保存されます。
  • 重要度 : error / warning / info のドロップダウン。即時保存されます。
  • 設定(JSON) : ルールを展開(シェブロン)してパラメータを JSON で編集し、 Save Config を押します。無効な JSON はエラーの詳細とともに保存をブロックします。

例 : モバイルプロジェクト向けに max_texture_size を 2048 に下げる、または厳格に強制するために naming_conventionerror に切り替える。

エクスポート、インポート、リセット

  • Export : すべてのルールの状態(有効化、重要度、設定)を含む rules.json ファイルをダウンロードします。
  • Import : rules.json を再読み込みし、各エントリを対応するルールに適用します (不明なキーは無視されます)。
  • Reset to Defaults : すべてのルールをデフォルト値に戻します。カスタム設定は失われます (確認が求められます)。

エクスポート / インポートは、あるリポジトリから別のリポジトリへ検証ポリシーを複製したり、オフラインでバージョン管理する のに使います。

リポジトリ内の rules.json

コミットされた rules.json は誰にでも適用されるわけではない コミットされた .uversion/rules.json ファイルは、コミットの作者が manage_rules ケイパビリティを保持している場合にのみリポジトリのポリシーに適用されます。そうでない場合、ファイルは保存されますが ルールは変わりません。これは保護策です : そのパスに書き込み権限を持つ貢献者が、ファイルをコミットして検証を無効化する ことはできません。

よくある落とし穴

チェックインがブロックされる

error のルールが失敗しました。メッセージにどのルールかが示されます。アセットを修正するか、(そのルールが 自分の状況には厳しすぎる場合は)重要度を warning に下げてください。

リセットで自分の設定が消える

Reset to Defaults はカスタム設定に対して破壊的です。元に戻せるようにしたい場合は、先に Export を行ってください。

ルールが何もしていないように見える

有効になっているか(スイッチ)、ブロックを期待していたなら重要度が info になっていないかを確認してください。 error のみがチェックインをブロックします。