EOS Integration KitAlpha
v5.0.1
Getting Started

Configuration

Configure EOS Integration Kit with your Epic Online Services credentials

Open Plugin Settings

Go to Project Settings → Game → EOS Integration Kit to access the plugin settings.

Plugin Settings

Enable Automatically setup EIK to let the plugin configure everything for you. This handles all the DefaultEngine.ini settings automatically.

Auto Setup

EIK now supports both Online Subsystem (OSS v1) and the new Online Services (OSS v2). The automatic setup configures both for maximum compatibility.

Configure Artifacts

Artifacts contain your EOS credentials. You need at least one artifact configured.

Get Your Credentials

  1. Go to the Epic Games Developer Portal and sign in.

  2. Select your product (or create one), then go to Product Settings → Clients.

Developer Portal Clients

  1. Create a new Client Policy with type Peer2Peer (or custom if you need specific features).

Client Policy

  1. Create a new Client using the policy you just created.

New Client

  1. Go to SDK Download & Credentials to find your credentials.

SDK Credentials

Add Artifact in Plugin Settings

  1. Click the + button under Artifacts to add a new artifact.

Add Artifact

  1. Fill in the credentials from the Developer Portal:
FieldDescription
Artifact NameA name for this configuration (e.g., "Development")
Client IDFrom SDK Credentials
Client SecretFrom SDK Credentials
Product IDFrom SDK Credentials
Sandbox IDFrom SDK Credentials (Dev, Stage, or Live)
Deployment IDFrom SDK Credentials

Artifact Filled

  1. Set the Default Artifact field to match your artifact name.

The Default Artifact field must match one of your artifact names exactly.

  1. Restart the editor for changes to take effect.

Manual Configuration (Optional)

If you prefer manual setup, add this to your Config/DefaultEngine.ini:

[OnlineServices]
DefaultServices=Epic

[/Script/Engine.OnlineEngineInterface]
ClassName=/Script/OnlineSubsystemUtils.OnlineServicesEngineInterfaceImpl

[/Script/Engine.Engine]
!NetDriverDefinitions=ClearArray
+NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="/Script/OnlineSubsystemEIK.NetDriverEIK",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")
+NetDriverDefinitions=(DefName="BeaconNetDriver",DriverClassName="/Script/OnlineSubsystemEIK.NetDriverEIK",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")

[/Script/Engine.GameEngine]
!NetDriverDefinitions=ClearArray
+NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="/Script/OnlineSubsystemEIK.NetDriverEIK",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")
+NetDriverDefinitions=(DefName="BeaconNetDriver",DriverClassName="/Script/OnlineSubsystemEIK.NetDriverEIK",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")
[OnlineSubsystem]
DefaultPlatformService=EIK

[OnlineSubsystemEIK]
bEnabled=true

[/Script/Engine.Engine]
!NetDriverDefinitions=ClearArray
+NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="/Script/OnlineSubsystemEIK.NetDriverEIK",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")
+NetDriverDefinitions=(DefName="BeaconNetDriver",DriverClassName="/Script/OnlineSubsystemEIK.NetDriverEIK",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")

[/Script/Engine.GameEngine]
!NetDriverDefinitions=ClearArray
+NetDriverDefinitions=(DefName="GameNetDriver",DriverClassName="/Script/OnlineSubsystemEIK.NetDriverEIK",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")
+NetDriverDefinitions=(DefName="BeaconNetDriver",DriverClassName="/Script/OnlineSubsystemEIK.NetDriverEIK",DriverClassNameFallback="OnlineSubsystemUtils.IpNetDriver")

Next Steps

You're all set! Head to Quick Start to authenticate your first player.

On this page