|
|
**Table of Contents:**
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
# Basics
|
|
|
|
|
|
- Make sure the **Switchboard** plugin is enabled.
|
|
|
- https://docs.unrealengine.com/5.3/en-US/switchboard-in-unreal-engine/
|
|
|
- The first time you start Switchboard from a Unreal Engine project it will download and install its python dependencies and create a **SwitchboardListener.exe**
|
|
|
- Don't let Unreal Engine manage the Autostart. Move the shortcut(s) to the following folder on each cluster machine
|
|
|
|
|
|
```
|
|
|
C:\Users\arena\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup
|
|
|
```
|
|
|
|
|
|
# Switchboard Listener
|
|
|
|
|
|
Make sure to install and use the Switchboard Listener from the specific Unreal version you are using. Otherwise this might lead to complications.
|
|
|
|
|
|
If you have more than one version of the Unreal Engine installed on your cluster AND you want to use all of them, you need to have the `SwitchboardListeners` running on different ports. You can do this via the `-port=XXXX` flag
|
|
|
|
|
|
e.g. for UE5.3 we use port 5300
|
|
|
|
|
|
So if you have placed a shortcut to the `.exe` in your Autostart folder, add this in the shortcut settings for the target:
|
|
|
|
|
|
```
|
|
|
C:\Epic\UE_5.3\Engine\Binaries\Win64\SwitchboardListener.exe -port=5300
|
|
|
```
|
|
|
|
|
|
# Switchboard Config
|
|
|
|
|
|
Your Switchboard configs are located in your Unreal Engine folder. for example:
|
|
|
|
|
|
```
|
|
|
C:\Epic\UE_5.3\Engine\Plugins\VirtualProduction\Switchboard\Source\Switchboard\configs\RWTH_Test_Mono.json
|
|
|
```
|
|
|
|
|
|
## Find the steps to set up your Switchboard config here: https://docs.unrealengine.com/5.3/en-US/ndisplay-quick-start-for-unreal-engine/#step3-packageanddeploy
|
|
|
|
|
|
## Custom Settings
|
|
|
|
|
|
- If you are using a different SwitchboardListener port you need to change that setting.
|
|
|
- Also if you want e.g. Unreal Engine Blueprint `Print String` output to show up on screen in the cluster, uncheck `Disable All Screen Messages`
|
|
|
|
|
|

|
|
|
|
|
|
## Launch Cooked/packaged Builds (.exe)
|
|
|
|
|
|
The default Switchboard launch mechanism described above uses -game mode. You can also work with cooked builds. This will require you to specify the file path of the cooked executable instead of the uproject file.
|
|
|
|
|
|
When working with cooked builds, you must update Switchboard settings to include the path of the .exe file and empty the UProject path. This tells Switchboard to ignore project location and use the cooked .exe file instead.
|
|
|
|
|
|

|
|
|
|
|
|
**Table of Contents:**
|
|
|
|
|
|
[[_TOC_]]
|
|
|
|
|
|
# Basics
|
|
|
|
|
|
- Make sure the **Switchboard** plugin is enabled.
|
|
|
- https://docs.unrealengine.com/5.3/en-US/switchboard-in-unreal-engine/
|
|
|
- The first time you start Switchboard from a Unreal Engine project it will download and install its python dependencies and create a **SwitchboardListener.exe**
|
|
|
- Don't let Unreal Engine manage the Autostart. Move the shortcut(s) to the following folder on each cluster machine
|
|
|
|
|
|
```
|
|
|
C:\Users\arena\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup
|
|
|
```
|
|
|
|
|
|
# Switchboard Listener
|
|
|
|
|
|
Make sure to install and use the Switchboard Listener from the specific Unreal version you are using. Otherwise this might lead to complications.
|
|
|
|
|
|
If you have more than one version of the Unreal Engine installed on your cluster AND you want to use all of them, you need to have the `SwitchboardListeners` running on different ports. You can do this via the `-port=XXXX` flag
|
|
|
|
|
|
e.g. for UE5.3 we use port 5300
|
|
|
|
|
|
So if you have placed a shortcut to the `.exe` in your Autostart folder, add this in the shortcut settings for the target:
|
|
|
|
|
|
```
|
|
|
C:\Epic\UE_5.3\Engine\Binaries\Win64\SwitchboardListener.exe -port=5300
|
|
|
```
|
|
|
|
|
|
# Switchboard Config
|
|
|
|
|
|
Your Switchboard configs are located in your Unreal Engine folder. for example:
|
|
|
|
|
|
```
|
|
|
C:\Epic\UE_5.3\Engine\Plugins\VirtualProduction\Switchboard\Source\Switchboard\configs\RWTH_Test_Mono.json
|
|
|
```
|
|
|
|
|
|
# Find the steps to set up your Switchboard config here: https://docs.unrealengine.com/5.3/en-US/ndisplay-quick-start-for-unreal-engine/#step3-packageanddeploy
|
|
|
|
|
|
If you need to switch out the nDisplay config at some point, do this by pressing the `Add Device` button:
|
|
|
|
|
|

|
|
|
|
|
|
## Custom Settings
|
|
|
|
|
|
- If you are using a different SwitchboardListener port you need to change that setting.
|
|
|
- Also if you want e.g. Unreal Engine Blueprint `Print String` output to show up on screen in the cluster, uncheck `Disable All Screen Messages`
|
|
|
|
|
|

|
|
|
|
|
|
## Launch Cooked/packaged Builds (.exe)
|
|
|
|
|
|
The default Switchboard launch mechanism described above uses -game mode. You can also work with cooked builds. This will require you to specify the file path of the cooked executable instead of the uproject file.
|
|
|
|
|
|
When working with cooked builds, you must update Switchboard settings to include the path of the .exe file and empty the UProject path. This tells Switchboard to ignore project location and use the cooked .exe file instead.
|
|
|
|
|
|

|
|
|
|