Unreal Engine Tutorial

Beta

This feature is currently in BETA. We're interested in hearing your feedback. Please direct all feedback to support.

The Unreal Engine Conductor plugin allows for the simple submission of Unreal scenes via Media Render Queue to render on Conductor.

This tutorial will cover everything from installation to the download of rendered frames.

Note

It is recommended by Epic to use the latest video drivers available to properly run Unreal. Submissions may fail with older drivers.

Installing the Plugin

The Conductor submitter for Unreal is a Python package that needs to be installed using the Python installation that ships with Unreal. Below is a script that will find the Python installation from Unreal and then install the ciounreal Python package.

Please copy and paste this into a file and run it in a PowerShell terminal:

& conductor_unreal_submitter_installer.ps

Review the output to ensure the currect version of Unreal was detected, etc...

conductor_unreal_submitter_installer.ps

# Define the registry paths for Unreal Engine versions
$unrealVersions = @("5.2", "5.3", "5.4")
$baseRegistryPath = "HKLM:\SOFTWARE\EpicGames\Unreal Engine"

# Loop through each version and get the "Installed directory" value
foreach ($version in $unrealVersions) {
    $registryPath = "$baseRegistryPath\$version"
    $installedDirectory = Get-ItemProperty -Path $registryPath -Name "InstalledDirectory" -ErrorAction SilentlyContinue

    if ($installedDirectory) {
        $pythonExePath = Join-Path -Path $installedDirectory.InstalledDirectory -ChildPath "Engine\Binaries\ThirdParty\Python3\Win64\python.exe"
        Write-Output "Using Python executable: $pythonExePath"

        # Run the pip install command using the & operator
        & $pythonExePath -m pip install --extra-index-url https://test.pypi.org/simple/ ciounreal --target "$env:USERPROFILE/Conductor/unreal"

        # Define the path to the post_install.py script
        $postInstallScriptPath = "$env:USERPROFILE/Conductor/unreal/ciounreal/post_install.py"

        # Run the post_install.py script using the & operator
        & $pythonExePath $postInstallScriptPath
    }
}

Load the Plugin

• Open the Plugins panel, search for render and enable the Conductor plugin. After it is enabled for the first time, there will be no need to do so again.

Enable the Plugin

With the plugin enabled, the executors must be properly configured to submit jobs to Conductor.

• Open Project settings and search for Movie Render. Under the Plugins - Movie Render Pipeline section change the following:

  • Default Local Executor -> MoviePipelineConductorLocalEditorExecutor
  • Default Remote Executor -> MoviePipelineConductorRemoteExecutor
  • Default Executor Job -> ConductorMoviePipelineExecutorJob

• With the proper executors selected close the project settings window.

Setting up the Executors

Note

In order to reconnect a Conductor account, open the Project Settings and search for Conductor. Select the Reconnect button that appears. There is also a shelf button available for easy reconnection.

Reconnect in Project Settings

Reconnect with the Shelf Button

Configure Perforce Settings

Perforce offers an alternative to CoreWeave cloud storage for managing project file synchronization. Follow these steps to set up Perforce for submissions:

• Connect to the P4 server:

  • Use the P4V application
  • Log in with P4 user credentials

• Set up P4 workspace:

  • Create a workspace for the current project
  • Place the workspace in the designated project location

• Configure the Source Control plugin:

  • Open Revision Control

    

    Open Revision Control

• Set Provider as "Perforce". Server and username should be fetched from P4V connection. Select Workspace that contains the proper project.

Configure Perforce settings

• Accept the settings. A success message will be displayed with a green check mark. Reload the project for the Perforce settings to commit.

Note

Proper configuration of the Source Control plugin settings is essential for ensuring the Plugin functions correctly with your Perforce setup.

Setting up a submission.

• Open the Content Browser window. In any location suitable for a Data Asset Right click -> Miscellaneous -> Data Asset. Select Conductor Settings as the class, and provide it any name.

Create a Data Asset

• Double click the new Data Asset to configure the desired Conductor settings.

• Set the Project and instance type to be used

• Add any additional files or Environment variables required

Configure the Data Asset

Note

If using Perforce enable the Use Perforce checkbox. Manually configure the Perforce server field if needed. Expand the Environment Settings section to provide the required Perforce Environment Variables.

Configure Perforce Environment Variables

• P4PORT - Which server should be connected to in order to sync project files

• P4USER - Which user should be used

• P4PASSWD - with which credentials

• Once The Data Asset is configured, save it via File -> Save, or use CTRL + S.

Submit a Job to Conductor

• A submission can now be sent from Movie Render Queue to Conductor.

• Open Movie Render Queue. Window -> Cinematics -> Movie Render Queue.

Configure Media Render Queue Submission

• Select the scene(s) and levels to be submitted for render.

• In the Job Settings field, select the Data Asset created in steps prior.

• Provide any Submission overrides if required, and select Render (Remote) to submit to Conductor.

Submit the job to Conductor

Download finished files

As tasks finish, you can download your images via the command-line tools or open the Downloader page in the Companion app.

Support

If there are any issues or questions about submissions please contact conductor Support.