Language:
Page Info
Engine Version:

Setting up a Shotgun Project to Work with Unreal Engine

Choose your OS:

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 famililar 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 .

Setting up the Shotgun Project

  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/shotgunsoftware/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.

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 ShotgunNEW!  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.