EOS Get Started

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.

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.

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:

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.

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:

• Auth And Friends Sample
• Achievements Sample
• Session Matchmaking Sample
• Lobby Sample
• P2P NAT Sample
• Player Data Storage Sample
• Title Storage Sample
• Leaderboards Sample
• Store Sample
• Mods Sample
• Using the Android SDK Samples
• Using the C# SDK Samples
• Using the iOS SDK Samples

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