Setting up a Shotgun Project to Work with Unreal Engine

Describes how to set up an existing Shotgun project with a configuration that enables the Unreal toolkit engine.

Windows
MacOS
Linux

The process for setting up a Shotgun project to work with Unreal Engine 4 is similar to the process for other applications in your content pipeline, such as Autodesk Maya or 3ds Max, or the Foundry's Nuke. You'll configure your Shotgun project to use a toolkit engine: a collection of tools and scripts that are designed to make your Shotgun project aware of Unreal Engine, and that integrate Shotgun tools and workflows into the Unreal Editor interface.

The configuration outlined on this page only has to be done once for each Shotgun project that you want to use with Unreal Engine. It is typically done by a Shotgun administrator. If you've already set up Shotgun projects and configured them to integrate with other content creation tools, this process should be familiar to you. If not, see the following resources:

Before you Start

We recommend using the project configuration set up for you in the tk-config-unreal repository on GitHub. This configuration extends the basic Shotgun toolkit config with the elements that make up the Unreal integration.

  • In order to use this configuration from GitHub, you'll need to have Git installed on your computer. If you don't already have Git installed, download it here.

1 - Adding the Unreal Engine Software to Shotgun

In this step, you'll add the Unreal Engine integration as a new Software for your organization.

  1. Log in to your organization's Shotgun URL in a Web browser. Then, from the user menu, select Software.

  2. On the Software page, click the + Software button.
    +Software

  3. Set the Software Name to Unreal Engine, and set the Engine to tk-unreal
    Create a New Software panel

  4. Click Create Software.
    When you return to the Software page, you should see a new entry in the list for Unreal Engine.
    Unreal Engine tk-unreal software

End Result

Shotgun is now aware of the Unreal Engine integration, and you'll be able to follow the steps in the next section to make any of your organization's Shotgun projects work with the Unreal Editor.

2 - Setting up the Shotgun Project

In this step, you'll get one of your existing Shotgun projects set up to use the Unreal Engine integration.

  1. Open the Shotgun Desktop application, and choose the project you want to use with Unreal Engine from the Projects page.

  2. Click your user picture, and select Advanced project setup... from the menu.

  3. Select the Git configuration option and click Continue.

  4. Paste in the URL of the Unreal config repository:
    https://github.com/ue4plugins/tk-config-unreal.git
    and click Continue.

  5. Follow the rest of the prompts in the Shotgun Set Up Project Wizard to set up a shared storage location for your Shotgun project and set a location for your pipeline configuration.

End Result

When the project setup is complete, Shotgun Desktop should scan your computer for installations of Unreal Engine and list them on the Apps page for your project:

Shotgun Desktop with Unreal

If you launch Unreal from one of these shortcuts, and open an Unreal Engine Project that has the Shotgun plugin enabled, you'll be able to use the Shotgun integration as described on the Using Unreal Engine with Autodesk Shotgun page.

Next Steps

  • For more about how you can extend the toolkit configuration for your project, see Beyond Your First Project.

  • For more about how to manage project configurations in Shotgun, see Configuration staging and rollout.

  • To see how the Unreal project configuration is set up, see the tk-config-unreal repository.

  • To explore the implementation of the Unreal toolkit engine, including the Python hooks it uses and exposes, see the tk-unreal repository.

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback