How to Use Unreal Engine 4 With Perforce Helix Core
Unreal Engine 4 is a popular tool among game developers (and others). And it’s often used alongside Helix Core.
What Is Unreal Engine 4 (UE4)?
Unreal Engine 4 (UE4) is a game engine developed by Epic Games and released in 2014. UE4 is the latest version of Epic’s game engine. It’s been powering games since 1998. Developers, designers, and artists all love to use UE4.
This suite of development tools is primarily used in game development, from indie studios to AAA game companies. UE4 is also used by AR/VR shops, motion picture studios and animation companies, architecture firms, and more.
Why Unreal Engine Game Development Teams Use Helix Core
UE4 is popular among game development and AR/VR teams. That’s because UE4 is a great engine for creating immersive experiences.
Epic Games develops the Unreal Engine. They also use Helix Core as their version control. And Epic Games encourages third party developers using Unreal to also use Helix Core.
So, it should come as no surprise that many teams using Unreal also use Perforce version control — Helix Core. The two tools are tightly integrated, which helps your team work together more efficiently on projects. This integration is through the Unreal Editor.
Helix Core Helps Unreal Teams…
16 of the top 22 games of 2018 were built on Helix Core. Here are some of the reasons why.
Gain a Single Source of Truth
There are large binary files, many files, many contributors, and many changes involved in building a game today. And it’s important to maintain a single source of truth
Helix Core delivers just that. . It makes it easier to find the assets you need to work on. And it lets you see if someone else is working on a particular file.
The Unreal integration is a key part of this.
Branch and Merge Better
If you are a developer, you know how tough merging code across a team can be. And the large number of branches associated with game development can be overwhelming.
Branching in Helix Core — called Perforce Streams — helps you:
- Manage these branches easily.
- Visualize how code flows.
- Encourage best practices for merging code between branches.
“Dealing with so many branches can be overwhelming,” says Nick Penwarden, UE4 Development Manager, Epic Games. “We use the streams feature in Helix Core to facilitate and help manage the complexity of our branching setup.”
Hear more from Epic Games and other top game development teams. Get the Version Control Best Practices in Game Development eBook >>
For Unreal teams, using Streams is key for controlling updates.
Let’s say that UE4 has an update. You need to bring that update into your project — without breaking anything. Streams helps you do it.
In a recent webinar, Sumo Digital shared best practices for game development using Streams. One of these practices is having three streams — main development, integration, and engine.
The engine stream is where Unreal updates enter the project. The update then goes into the integration stream. This allows the integration team to test changes before merging them into the main development stream. As a result, the main development team gets to stay focused on the project — and still get the latest version of Unreal.
How to Use Unreal Engine 4 With Perforce Helix Core
Here’s how to use Unreal Engine 4 with Perforce Helix Core.
1. Install Unreal Engine 4
First, you’ll need to install Unreal Engine 4. If you’ve already done this, skip to the next step.
To install Unreal Engine 4:
- Go to unrealengine.com and click get started.
- Create an account.
- Download and run the installer.
- Once the installer is downloaded, login using your new account.
- Download and install the latest version of UE4.
- Launch UE4.
You can find the latest installation information for UE4 here.
2. Download Helix Core From Perforce
Next, you’ll download Perforce Helix Core.
If you’re not using Helix Core yet, get started here >>
If you’re already a Helix Core user, download the latest version of the:
The video below walks through this process.
Unreal also provides guidance for getting started with Helix Core in Unreal.
3. Set Up P4 Typemap
Before adding files to the server, you’ll need to set up the P4 Typemap, so Helix Core knows how to handle Unreal files.
This is an important step. For instance, if you want to edit a binary, it will be exclusively locked if you have the typemap setup.
4. Set Up the Environment
Next, you'll need to set a couple of environment variables, so UE can find your workspace.
Open a command window and type:
- p4 set P4USER=your.username
- p4 set P4PORT=localhost:1666
5. Go Back to UE4
Now it’s time to return to UE4 (or launch it if it isn’t already open).
Once you open Unreal:
- Click the source control button.
- Select change source control settings.
- Drop down the provider menu and choose Perforce.
- Click accept settings.
Watch the video below for an in-depth tutorial of how to download Helix Core and get started with the Unreal Editor.
6. Use the Unreal Editor (If You’re A Designer or Technical Artist)
The Unreal Editor has built-in integration for Helix Core, maintained by Epic Games. Designers primarily use the Unreal Editor with Helix Core for version control.
Asset files (with the extensions .uasset and .umap) are binary files modified in the Unreal Editor. They cannot be opened as text or merged in a text-based merge tool.
When you want to work on an asset, you just click on it in a UE content browser. You’ll see a “check out” choice. The file is locked automatically when you make that choice.
When you’re done editing files you have locked, check in or submit those files. This uploads the changes to the server and releases the lock on the files.
You can even see the history of changes to the files — and visually compare one version to another — without leaving UE.
7. Use Microsoft Visual Studio (If You’re a Coder)
Unreal and Helix Core both integrate with Microsoft Visual Studio. Many game developers love Visual Studio.
Here’s that single source of truth again. All the changes that anyone on the team makes, whether to artwork assets, blueprints, code, or other work items, are seamlessly managed in Helix Core.
Get Started: UE4 and Perforce
Get started with Unreal Engine 4 and Helix Core today.