EOS Get Started

Integrate Epic Online Services (EOS) into your game.

5 mins to read

To get up and running with the Epic Online Services (EOS), you need to download the EOS SDK. To do this you need to:

  • Set up an Epic Games developer account.
  • Download the EOS SDK.

Epic Games also provides a project to show how EOS can fit into your game.

Setting up an Account

You use the Developer Portal (dev.epicgames.com/portal) to set up your game to use EOS services, and to configure the services.
In the Developer Portal, each game is known as a "product"; it has a ProductId, SandboxId, and DeploymentId. The EOS SDK uses these to identify your game with the EOS services.

For more information about how to use product management tools when setting up an account, see the documentation on the Developer Portal and Product, Sandbox, and Deployment IDs.

Downloading the EOS SDK

Once you have set up your organization and products, you can download the EOS SDK FROM the Developer Portal. The SDK gives you access to EOS features and services, such as metrics collection and user authentication. Inside the SDK download, you will find the following directories:

DirectoryContent
/SDK/The libraries and header files necessary to integrate the EOS SDK with your product
/Samples/Sample applications demonstrating how the SDK works
/Third Party Notices/Legal information about various supporting libraries

There are different types of SDK downloads to use, depending on which platform your game client runs on:

  • Windows, macOS, Linux - the EOS SDK in C, and the EOS SDK in C#.
  • Mobile - the EOS SDK for iOS, and the EOS SDK for Android.
  • Consoles - there are EOS SDK downloads for game consoles in C, and in C#.
    The SDK downloads for consoles are only available to developers approved by the platform holders and approved by Epic Games.
    The platform holders are: Microsoft (Xbox One, Xbox Series X), Sony (PlayStation 4, PlayStation 5), Nintendo (Switch).
    To get access to the SDK downloads for consoles and associated documentation:
    • See the Developer Portal (dev.epicgames.com/dev-portal) for guidance on applying for console developer access from the platform holders.
    • Once you have platform-holder approval, you can apply to Epic Games using the Console Developer Request for Epic Online Services form, which is at eoshelp.epicgames.com.

Tip: You can use the developer forums to ask questions, get support, and become part of the EOS developer community.

Trying out the Samples

After downloading the SDK, you will find various samples demonstrating individual features of the platform. For more detailed information about samples, please see the following documentation:

EOS SDK Dependencies

These subsections describe the operating systems and supporting software required to develop and ship your application on each supported platform.

SDK Samples

Development (Samples)
Installed SoftwareVisual Studio 2017 or higher

Windows

Shipping
Operating SystemWindows 7 and newer
EOS SDKEOS SDK binary (DLL)
Installed SoftwareThe latest Microsoft Visual C++ Redistributable; the application requires MSVCP140.dll.

Linux

Development
Operating SystemAny recent x86 or x64 distribution
Installed Softwaregcc or Clang compilers
Other compilers may work, but have not been tested.
Installed Softwarecmake 2.6 or higher

Mac

Development (Recommended)
Operating SystemmacOS Catalina (10.15.4) or higher
Installed SoftwareXcode 12.4 or higher
Shipping
Operating SystemmacOS Sierra (10.12) or higher (Intel-based Macs) macOS Big Sur (11.0) or higher (Apple silicon Macs)

iOS

Development
Operating SystemiOS 11 or higher — 12 or higher recommended
Installed SoftwareAuthenticationServices framework for iOS 12 and higher
Installed SoftwareSafariServices framework for iOS 11
Shipping
Operating SystemiOS 11 or higher — 12 or higher recommended
Installed SoftwareAuthenticationServices framework for iOS 12 or higher
Installed SoftwareSafariServices framework for iOS 11

Android

Development
Operating SystemAndroid OS 6.0 or higher (SDK level 23)
Installed SoftwareARM v7 or ARM v8-a
ARM v7 has not been tested with the latest versions