Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 5.96 KB

README.md

File metadata and controls

72 lines (48 loc) · 5.96 KB

Epic Online Services - Getting Started Guide

License

Welcome to the repository for the Epic Online Services (EOS) Getting Started series. This repository contains source code accompanying the various tutorials found on the Epic Online Services blog and the Epic Developer Community.

The tutorials focus on getting started with EOS, using C# and Unreal Engine with the Online Subsystem (OSS). The content covers topics such as authentication, player presence, achievements, leaderboards, and more.

C# Code Samples

The table below links to C#-focused blog posts and the corresponding code in this repository. These blog posts can be found on the Epic Online Services blog, providing guidance on how to use EOS with C#. The full list of blog posts in this series can be found in the Introduction to Epic Online Services (EOS).

Blog Post Title Code Folder Minimum SDK Version
3. Setting up a C# solution for EOS in Visual Studio 2019 CSharp/EOSCSharpSample_3 1.15.2
4. Authenticating with Epic Account Services (EAS) CSharp/EOSCSharpSample_4 1.15.2
5. Getting and setting user presence CSharp/EOSCSharpSample_5 1.15.2
6. Querying for Epic Friends and their status CSharp/EOSCSharpSample_6 1.15.2
7. Accessing EOS Game Services with the Connect Interface CSharp/EOSCSharpSample_7 1.15.2
8. Retrieve game-specific data from the cloud CSharp/EOSCSharpSample_8 1.15.2
9. Storing and retrieving player-specific data CSharp/EOSCSharpSample_9 1.15.2
10. Manage player statistics with Epic Online Services CSharp/EOSCSharpSample_10 1.15.2
11. Rank player scores using leaderboards CSharp/EOSCSharpSample_11 1.15.2
12. Adding achievements to your game CSharp/EOSCSharpSample_12 1.15.2

For more detailed instructions on using the C# code, refer to the readme file in the CSharp folder.

Unreal Engine Online Subsystem (OSS) Code

This section contains the source code of an Unreal Engine project built using the Third Person Feature Pack. The project demonstrates how to integrate the Epic Online Services Online Subsystem plugin into your game. The code corresponds to the course: The EOS Online Subsystem (OSS) Plugin.

The Unreal Engine code is structured around real-world scenarios and is up to module 7 - EOS P2P, Lobbies and Voice. Below is a table listing the modules included in the course.

Module Release Date
Plugin Configuration Released
Signing-in Released
Setting up a dedicated server to host EOS Sessions Released
Joining EOS Session Released
EOS Stats, Achievements, and Leaderboards Released
EOS Player and Title Data Storage Released
EOS P2P, Lobbies, and Voice Released
Voice on Trusted Server TBD
Easy Anti-Cheat TBD

Important Note

If you're working with EOS P2P, make sure to use Unreal Engine version 5.3, which includes EOS SDK version 1.16. If you are using an older version of Unreal Engine, you may need to upgrade the EOS SDK. For guidance, refer to Upgrading the EOS SDK.

Older versions of the EOS SDK may be affected by a WebRTC vulnerability.

Reporting Issues

If you encounter any issues with the code, please file an issue. We welcome contributions to improve this repository.

License

The code in this repository is distributed under the terms of the MIT License. See the LICENSE file for details.

Code of Conduct

We are committed to providing a friendly, safe, and welcoming environment for all contributors. Please be respectful, considerate, and inclusive when interacting with others. Harassment and discrimination of any kind will not be tolerated.

By participating in this project, you agree to follow the community guidelines, respect others, and help maintain a welcoming environment for everyone.

If you encounter any issues or have concerns, please report them to the project maintainers.

Resources: