UE5 の分散ビルドを行います。

• 公式のマニュアル
  • https://dev.epicgames.com/documentation/unreal-engine/horde-unreal-build-accelerator-and-remote-compilation-tutorial-for-unreal-engine

• より詳細なドキュメントは、HordeServer をインストールしたあと http://＜HordeサーバーのIPアドレス＞:13340/docs で読むことができます。

• GitHub のソースコード版エンジンダウンロード時に同時にダウンロード可能です
• またソースコード版エンジンの場合 Engine/Extras/Horde/UnrealHordeServer.msi として入っています

空いている PC に Horde Server をインストールします。

1. UnrealHordeServer.msi をダブルクリックして進める
2. Horde Server Configuration はデフォルトのままで OK (Port は 13340)
3. 完了したら自動的にブラウザが開くので、「UNREAL ENGINE HORDE」のページが表示されていれば OK
   • または手動で「 http://localhost:13340 」を開いても構わない

1. スタートメニューで “fire” を検索して「Windows Defender ファイアウォール」を開く
2. 左側の「詳細設定」をクリックして、「セキュリティが強化された Windows Defener ファイアウォール」を立ち上げる
3. 「ローカル コンピューター のセキュリティ」の中の「受信の規則」をクリック
4. 一番右の「操作」の中にある「受信の規則」にある「新しい規則…」をクリック
5. 「新規の受信の規則ウィザード」が開くの以下の順番に入力
   1. 「ステップ: 規則の種類」で「ポート」を選択して「次へ」
   2. 「ステップ: プロトコルおよびポート」で TCP(T) のまま、「特定のローカルポート」に「13340,13342」を入力して「次へ」
   3. 「ステップ: 操作」で「接続を許可する(A)」のまま「次へ」
   4. 「ステップ: プロファイル」は「パブリック」からチェックを外して「次へ」
   5. 「ステップ: 名前」に “Horde Server 13340,13342” と入力して「完了」

• UE5 5.4 の実験機能版 UBA と、5.5 以降の正式版 UBA では Agent のインストール手順が異なります。5.4 の実験機能で存在していた Agent の Task Tray App は、正式版では Unreal Toolbox に置き換わりました。
• 個人で使う場合は PC の台数も少ないと思うので、Horde Server と同じ PC に Horde Agent をインストールしても特に問題ありません。

1. ブラウザで Horde Server をインストールした PC の 13340 を開く 「 http://＜HordeサーバーのIPアドレス＞:13340 」
   • 例えば Horde Server をインストールした PC の IP アドレスが 192.168.0.100 なら 「 http://192.168.0.100:13340 」を開く
2. 上部メニューの「TOOLS」から「Downloads」を選択
3. 「Unreal Toolbox (Windows Installer)」をダウンロード
4. ダウンロードした “UnrealToolbox.msi” をインストールする
5. 「Horde Server URL:」にはサーバーの URL を入力
   • 例えば IP アドレスが 192.168.0.100 なら「 http://192.168.0.100:13340 」を入力する

1. Toolbox のインストールが完了すると Unreal Toolbox の設定画面が開く
   • もし開かない場合はスタートメニューから Unreal Toolbox を開く
2. 「Unreal Toolbox」の Settings → General から、Tools の中にある「Horde Agent (Windows Installer)」の右にある「Add」をクリック
3. 「Unreal Horde Agent Setup」が開くのでそのままインストール
4. 途中の「Horde Server URL:」は先程 Toolbox に入れたものと同じ (最初から入っている)
5. 「Sandbox directory:」もデフォルトのままで構わない (別の場所に設定しても構わない)
6. 最後の画面で「Enroll agent with Horde server」にチェックを入れたまま「Finish」するとブラウザが開いて自動的に Agent Enrollment 画面になる

1. もし自動的に開いたブラウザページに「Enroll Agent ～」とダイアログが表示されていたら青い「Register」ボタンを選択
   • もし表示されていない場合は以下の手順で登録を行う
   1. Windows のタスクトレイにある Unreal のアイコン右クリックから「Enroll with Server…」
   2. ブラウザが開いて “Agent Enrollment” のページが開くので、「Enroll Agent～」のダイアログで「Register」をクリック
      • もし自動的にダイアログが出ていない場合は、自分の PC 名にチェックを入れて右上の「Enroll Agents」をクリック
   • すでに登録済みの場合は自動的にこの画面が表示されないことがあるので注意

1. PC のブラウザで「 http://＜HordeサーバーのIPアドレス＞:13340/agents 」を開く
2. 登録された PC 一覧が出るのでここに含まれていれば OK

1. スタートメニューで “fire” を検索して「Windows Defender ファイアウォール」を開く
2. 左側の「詳細設定」をクリックして、「セキュリティが強化された Windows Defener ファイアウォール」を立ち上げる
3. 「ローカル コンピューター のセキュリティ」の中の「受信の規則」をクリック
4. 一番右の「操作」の中にある「受信の規則」にある「新しい規則…」をクリック
5. 「新規の受信の規則ウィザード」が開くの以下の順番に入力
   1. 「ステップ: 規則の種類」で「ポート」を選択して「次へ」
   2. 「ステップ: プロトコルおよびポート」で TCP(T) のまま、「特定のローカルポート」に「7000-7010」を入力して「次へ」
   3. 「ステップ: 操作」で「接続を許可する(A)」のまま「次へ」
   4. 「ステップ: プロファイル」は「パブリック」からチェックを外して「次へ」
   5. 「ステップ: 名前」に “Horde Agent 7000-7010” と入力して「完了」

※ 5.7 からは (2) の設定だけで C++ とシェーダーの両方が有効化されます。

C++ の分散ビルドを行う場合は BuildConfiguration.xml で有効化する必要があります。

• 以下の内容で C:\Users\ユーザー名\Documents\Unreal Engine\UnrealBuildTool\BuildConfiguration.xml に保存してください。
• Horde.Server の部分は Horde サーバーの URL に置き換えてください。

<?xml version='1.0' encoding='utf-8'?>
<Configuration xmlns="https://www.unrealengine.com/BuildConfiguration">
	<BuildConfiguration>
		<bAllowUBAExecutor>true</bAllowUBAExecutor>
	</BuildConfiguration>
	<Horde>
		<Server>http://＜HordeサーバーのIPアドレス＞:13340</Server>
		<WindowsPool>Win-UE5</WindowsPool>
	</Horde>
	<UnrealBuildAccelerator>
		<bLaunchVisualizer>false</bLaunchVisualizer>
	</UnrealBuildAccelerator>
</Configuration>

例

<?xml version='1.0' encoding='utf-8'?>
<Configuration xmlns="https://www.unrealengine.com/BuildConfiguration">
	<BuildConfiguration>
		<bAllowXGE>false</bAllowXGE>
		<bAllowSNDBS>false</bAllowSNDBS>
		<bAllowFASTBuild>false</bAllowFASTBuild>
		<bAllowUBAExecutor>true</bAllowUBAExecutor>
	</BuildConfiguration>
	<Horde>
		<Server>http://192.168.0.100:13340</Server>
		<WindowsPool>Win-UE5</WindowsPool>
	</Horde>
	<UnrealBuildAccelerator>
		<bLaunchVisualizer>false</bLaunchVisualizer>
	</UnrealBuildAccelerator>
</Configuration>

こちらは Config/～Engine.ini で設定します。 プロジェクトの Config/DefaultEngine.ini でも構いませんし、Engine 側で強制的に有効にする場合は Engine/Config/BaseEngine.ini で設定できます。 HordeServer や UE5 のバージョンによって設定方法が異なります。

[Uba.Provider.Horde.UE5]
Enabled=true
ServerUrl="http://＜HordeサーバーのIPアドレス＞:13340/"
MaxCores=500
 
[UbaController]
+Providers=Uba.Provider.Horde.UE5

設定例

[Uba.Provider.Horde.UE5]
Enabled=true
ServerUrl="http://192.168.0.100:13340/"
MaxCores=500
 
[UbaController]
+Providers=Uba.Provider.Horde.UE5

[Uba.Provider.Horde]
Enabled=true
Horde=(Pool=Win-UE5,MaxCores=500)
 
[Horde]
ServerUrl="http://＜HordeサーバーのIPアドレス＞:13340/"

[UbaController]
Enabled=true
Horde=(Pool=Win-UE5,MaxCores=500)
 
[Horde]
ServerUrl="http://＜HordeサーバーのIPアドレス＞:13340/"