Quick Start Guide

Quickly get your project up and running using Epic Online Services.

4 min read

To get up and running with the Epic Online Services (EOS) SDK, you'll need to set up a developer account, and download the SDK. Epic Games also provides a small project to show how EOS can fit into your game.

Setting up an Account

The Developer Portal contains setup information about your products and provides the means to administer your integrated services. Each product has a ProductId, SandboxId, and DeploymentId. The EOS SDK uses these to identify your product with the backend services. For more information about how to utilize product management tools when setting up an account, please see Product, Sandbox, and Deployment IDs.

Downloading the SDK

Once you have set up your organization and products, you can download the SDK on the developer portal. The SDK grants you access to EOS' backend features and services, such as metrics collection and user authentication. Inside the distribution archive, 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

For detailed information about the EOS SDK, see our online documentation. You can also use the Developer forums to ask questions 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 10
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