Get started
Install and set up the Authentication Software Development Kit for Unreal Engine.
Read time 3 minutesLast updated 2 months ago
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
- Sign in to the Unreal Engine Marketplace.
-
Access the Unity Gaming Services SDK for Unreal Engine Marketplace page.
Unity Gaming Services SDK for Unreal Engine Marketplace page
- Select Open in Launcher.
- Skip to Step 4 in From the Epic Games Launcher.
From the Epic Games Launcher
- Sign in to your Epic Games Launcher.
-
Search for Unity Gaming Services SDK for Unreal Engine in your Epic Games Launcher.
Search for Unity Gaming Services SDK for Unreal Engine
-
Access the Unity Gaming Services SDK for Unreal Engine page and select Free.
Unity Gaming Services SDK for Unreal Engine Launcher page
-
Select Install to Engine in your Epic Games Launcher.
Unity Gaming Services SDK for Unreal Engine install button
- Open a new project or an existing one.
-
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
- 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: . MacOS and Linux also have similar paths.
C:\Program Files\Epic Games\UE_5.3\Engine\Plugins\Marketplace - Copy the folder into your project
UnityGamingServicesSDKfolder. If it doesn't exist yet, create it at the root of your project.Plugins
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.
- Sign into the Unity Dashboard.
- Select Explore Services in the side panel.
- Select Sign Up in the top banner and follow the instructions.
Link your project
- Sign in to your Unity Dashboard.
- Select the gear icon next to the project name in the header to access your project's settings.
-
Under General > Project Details, there is a Project ID field. Copy this value.
The Copy button for the Project ID.
- In the Unreal Engine editor, go to Edit > Project Settings > Plugins > Unity Authentication > Unity Project Settings.
- Paste the copied value into the Unity Project ID field.
- Retrieve the Unity Environment. This is an optional parameter that specifies the specific environment you’d like the Authentication SDK to interact with.
-
In the Unity 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 Dashboard list of your environments.
NoteWe’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. - In the Unreal Engine editor, go to Edit > Project Settings > Plugins > Unity Authentication > Unity Project Settings.
- Paste the copied value into the Unity Environment Name field.
The Unity Authentication plugin.
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.