Skip to main content
When an Unreal project is in a Perforce workspace, each node that renders it syncs the project from Perforce instead of RenderFlow copying the whole project into the repository. A node keeps its workspace between jobs, so after the first job it only fetches the files that changed.

What you need

  • A Perforce server that every render node can reach, and a Perforce account for the nodes to log in with. The account only needs read access.
  • The Perforce command-line client (p4) installed on every node that renders Unreal. RenderFlow does not install it.
  • Unreal Engine with the RenderFlow plugin, on the artist’s workstation and on the nodes. Installing RenderFlow adds the plugin to every Unreal Engine it finds.
  • The project connected to Perforce in Unreal’s Revision Control, and a Movie Render Queue with at least one job in it: a saved level, a saved sequence and a saved configuration.
  • p4 on the artist’s workstation as well, if checked-out files should go with the job.

1. Add the Perforce server

1

Open Settings → Perforce

Press New Perforce server.
2

Fill in the server

Enter a Name for the list, the Address the artists use in Unreal (the P4PORT, for example perforce.studio.local:1666), and the User and Password of the account the nodes log in with.
The New Perforce Server dialog with Name, Address, User and Password fields and the Test and Add buttons

A new Perforce server, with the account the nodes log in with

3

Test it

Press Test. The dialog says whether the server answered and the login worked. Press Add to save the server.
The Perforce settings page listing a server named Studio depot at perforce.studio.local:1666, with the user renderfarm

Settings → Perforce with one server added

The password is stored encrypted on the server and is not shown again. To change it, open the server’s menu in the list, press Edit and enter the new one.

2. Submit from Unreal

1

Open the Movie Render Queue

In Unreal, open Window → Cinematics → Movie Render Queue and check that the jobs you want to render are in it. Save the queue asset.
2

Press Submit to RenderFlow

Open the Tools menu and press Submit to RenderFlow. If the project has unsaved changes, Unreal asks to save them first, since the nodes load the level, the sequence and the queue from disk.
3

Check the project source

The RenderFlow submitter opens with the job. Under the project, Project source reads Sync from Perforce, with the Server from Settings → Perforce and the artist’s Workspace. Copy to repository and Render in place are there too, for a job that should not sync.If the .uproject file was added to Perforce but never submitted, the nodes cannot sync it. The submitter then keeps Copy to repository and says The project file isn’t submitted to Perforce, so the project is copied. Submit the project file to Perforce to render it with a sync.
The RenderFlow submitter with an Unreal step: Project source set to Sync from Perforce, the Studio depot server, the artist's workspace, a note that the checked-out files are shelved in changelist 48211, the render item and the frame range

The submitter opened from Unreal, with the project synced from Perforce

4

Press Submit

Press Submit. Every node that takes a task syncs the project first, then renders.
The nodes render the files the artist’s workspace has, at the revisions the artist synced. If the artist syncs again while the job is rendering, tasks that start afterwards render the newer files. Checked-out files. Files that are checked out or added in the artist’s workspace are not in the depot yet. When you submit, the plugin shelves them in a changelist of its own, so the nodes render them too, and the submitter says Your checked-out files go with the job, shelved in changelist 1234. The files stay checked out in your workspace and are not changed. The plugin deletes its own shelves once their job has completed or been deleted, at the next submit. If p4 is not installed on the workstation, or shelving fails, Unreal asks whether to submit anyway. A job submitted that way renders the workspace without the checked-out files, and the submitter shows how many files it leaves out. The output folder. Each render item writes to the output directory of its config, Saved/MovieRenders inside the artist’s project by default. A node renders into a folder of its own and copies the frames there as each task ends. A workspace on the artist’s own disk is not reachable from the nodes, so set the config’s output directory to a shared folder before you submit. If the copy fails, the job’s log says so and names the folder on the node where the frames stayed.
The submitter matches the address Unreal reports against the servers in Settings → Perforce. If it finds none, it says so above the project source. Add the server under that address, or pick the server it is reached by from Server.

3. Follow the sync

Each task shows Syncing from Perforce with a percentage while its node syncs. In the job’s log, the sync comes first, before Unreal’s own lines:
The log lists the first 1,000 files a sync transfers and counts the rest. Workspaces on the nodes. A node keeps each project it renders in a folder of its own under cache in the RenderFlow data folder (C:\ProgramData\RenderFlow\cache on Windows). The project’s files are in its project folder, whether they came from a Perforce sync or a copy, beside Unreal’s own caches for that project. A node keeps the three projects it used most recently and removes older ones, but never a project a running job is using. Before transferring, it checks that the disk has room for the sync and 1 GB more.

When a sync fails

The task fails with one of these errors, and the job’s error list says what to do: