Quick Start Guide

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

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. These will be passed into the EOS SDK 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. While on the Developer Portal, get familiar with the Product, Sandbox, Deployment, and Client concepts in the documentation section. These concepts and their accompanying credentials are there to help define and segregate your development from your live versions of the game.

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:

Directory

Content

/SDK/

The libraries and header files necessary to link 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. Epic Games also provides Developer forums to ask questions and join the community of developers using EOS.

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

The following subsections describe the development and shipping requirements for products using the EOS SDK on various platforms.

Windows

Shipping Requirements

Linux

Development Requirements

  • Any recent x86 or x64 distribution

  • cmake 2.6 or higher

  • gcc or Clang; other compilers are untested, but may work

iOS

Development Requirements

  • iOS 11 or newer — 12 or higher recommended

Shipping Requirements

  • iOS 11 or newer — 12 or higher recommended

  • AuthenticationServices framework for iOS 12 or higher, or SafariServices framework for iOS 11

Android

Development Requirements

  • Android OS 6.0 or higher (SDK level 23)

  • ARM v7 or ARM v8-a; ARM v7 has not been tested with the latest versions

Consoles

Development Requirements (C# EOS SDK)

  • For the EOS SDK itself: .NET Framework 3.5 (tested)

  • For the samples: .NET Framework 4.7.2 and Visual Studio 2017