Get started

The Authentication SDK for Unreal Engine is a part of the Unity Gaming Services SDK plugin for Unreal Engine. To use Unity Authentication inside the Unreal Engine, you’ll first need to install the Unity Gaming Services SDK.

Understand the requirements

The Authentication SDK plug-in for Unreal Engine supports the Unreal Engine versions 4.27 to 5.3.

Download the Authentication SDK

From the Unreal Engine Marketplace website

  1. Sign in to the Unreal Engine Marketplace.

  2. Access the Unity Gaming Services SDK for Unreal Engine Marketplace page. Unity Gaming Services SDK for Unreal Engine Marketplace page

  3. Select Open in Launcher.

  4. Skip to Step 4 in From the Epic Games Launcher.

From the Epic Games Launcher

  1. Sign in to your Epic Games Launcher.
  2. Search for Unity Gaming Services SDK for Unreal Engine in your Epic Games Launcher. Search for Unity Gaming Services SDK for Unreal Engine
  3. Access the Unity Gaming Services SDK for Unreal Engine page and select Free. Unity Gaming Services SDK for Unreal Engine Launcher page
  4. Select Install to Engine in your Epic Games Launcher. Unity Gaming Services SDK for Unreal Engine install button
  5. Open a new project or an existing one.
  6. Navigate to the Plugins window and check the box next to the Unity Gaming Services SDK for Unreal Engine. Unity Gaming Services SDK for Unreal Engine plugins window
  7. Restart Unreal Engine.

Note: If you use a version of the engine built from sources then you can access your Marketplace folder by doing the following:

  • If you're using Windows, then default path is: C:\Program Files\Epic Games\UE_5.3\Engine\Plugins\Marketplace. MacOS and Linux also have similar paths.
  • Copy the UnityGamingServicesSDK folder into your project Plugins folder. If it doesn't exist yet, create it at the root of your project.

Configure the Authentication SDK

Before you begin using the Authentication SDK, you need to sign up for Unity Gaming Services and register a project.

Sign up for UGS

Note: If you already signed up for Unity Gaming Services and have a registered project, skip this step.

If you don't have a Unity account, create one and create a new project to sign up for Unity Gaming Services:

  1. Sign into the Unity Cloud Dashboard.
  2. Select Explore Services in the side panel.
  3. Select Sign Up in the top banner and follow the instructions.

Link your project

  1. Sign in to your Unity Cloud Dashboard.
  2. Select the gear icon next to the project name in the header to access your project's settings. The Project Settings gear icon.
  3. Under General > Project Details, there is a Project ID field. Copy this value. The Copy button for the Project ID.
  4. In the Unreal Engine editor, go to Edit > Project Settings > Plugins > Unity Authentication > Unity Project Settings.
  5. Paste the copied value into the Unity Project ID field.
  6. Retrieve the Unity Environment. This is an optional parameter that specifies the specific environment you’d like the Authentication SDK to interact with.
  7. In the Unity Cloud Dashboard, go to Environments > Your Environments and select the Environment you want to use and copy its Name. This is the identifier we use for the environment. The Unity Cloud Dashboard list of your environments.

Note: We’re copying the name of the environment, not the Environment ID. In the example above, the name is “testenv”. Using any other value causes Authentication requests to fail.

  1. In the Unreal Engine editor, go to Edit > Project Settings > Plugins > Unity Authentication > Unity Project Settings.
  2. Paste the copied value into the Unity Environment Name field.

After you copy both fields, the project settings in the Unreal Editor should look like the following:

The Unity Authentication plugin.

The Default Player Profile Name field grants a different name to be given to the default Authentication player profile. This can be left alone, or customized according to your needs.

Note: A valid player profile name is between 1-30 characters, and consists of characters a-z, A-Z, 0-9, -, and _, with no spaces.

See Player Profiles to read more about Player Profiles inside the Authentication SDK.

What's next?

Proceed with either integrations:

Unity logo Documentation
Copyright © 2024 Unity Technologies
"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.