Skip to main content

Welcome

This guide will walk you through the process of installing the EOS Online Subsystem plugin for Unreal Engine.

Understand the license you need

The EOS Online Subsystem plugin is available in two editions: the Marketplace edition and the Free edition. Which version you use depends on whether you need support, source code access and whether you or the company you work for earns above the threshold.

Installing the plugin

If you want to use precompiled versions of the plugin, or you want to use the plugin in a blueprint-only project, you can install the plugin using the links below.

Marketplace Edition

You can install the plugin through the Epic Games Launcher.

Free Edition

Download the ZIP file for the latest stable version of Unreal Engine.

Installing the EOS SDK

If you are not using the Marketplace Edition installed through the Epic Games Launcher, you will need to download and unzip the EOS SDK in one of the following supported locations. You can download the EOS SDK from the Epic Games developer portal.

info

The Free Edition currently requires -v. If you can't download this version from the Epic Games developer portal, you will either need to wait until the Free Edition is updated to be compatible with the latest version, or purchase the Marketplace Edition (which includes the required EOS SDK for you).

You need to extract the ZIP into a folder with a matching name. For example, if you were installing SDK -v, you would extract it to one of the following locations. Substitute the version number in the folder path for the version number of the SDK you are using.

  • <project>\Plugins\EOS-SDK--v
  • C:\Users\<username>\Downloads\EOS-SDK--v
  • C:\ProgramData\EOS-SDK--v
  • C:\EOS-SDK--v
  • /Users/<username>/Downloads/EOS-SDK--v

If you need iOS support, you can download the EOS iOS SDK from the Epic Games developer portal and extract it in one of the following locations:

  • <project>\Plugins\EOS-SDK-IOS--v
  • C:\Users\<username>\Downloads\EOS-SDK-IOS--v
  • C:\ProgramData\EOS-SDK-IOS--v
  • C:\EOS-SDK-IOS--v
  • /Users/<username>/Downloads/EOS-SDK-IOS--v

If you need Android support, you can download the EOS Android SDK from the Epic Games developer portal and extract it in one of the following locations:

  • <project>\Plugins\EOS-SDK-Android--v
  • C:\Users\<username>\Downloads\EOS-SDK-Android--v
  • C:\ProgramData\EOS-SDK-Android--v
  • C:\EOS-SDK-Android--v
  • /Users/<username>/Downloads/EOS-SDK-Android--v

If you are not using the plugin as a Git submodule, and are instead versioning a copy of the plugin in your own repository, you can add the EOS SDK to your own repository alongside the plugin.

To version the EOS SDK in your own repository, copy the SDK folder from the SDK and rename it to ThirdParty. For the IOS SDK, rename it to ThirdParty-IOS. For the Android SDK, rename it to ThirdParty-Android. Then place those directories in the following locations, relative to the plugin location and next to the Source/OnlineSubsystemEOS folder:

  • <Plugin Location>/Source/ThirdParty
  • <Plugin Location>/Source/ThirdParty-IOS
  • <Plugin Location>/Source/ThirdParty-Android

Entering your license key

If you are using the Free Edition, you will be provided with a license key from the Redpoint Games License Manager. When you've installed the plugin in your project, you'll need to set the license key. You can do that either by setting the license key in the DefaultEngine.ini file, or by changing it through "Project Settings".

This does not apply to Marketplace Edition users.

[EpicOnlineServices]
FreeEditionLicenseKey=...

Source code access

If you have source code access for the EOS Online Subsystem plugin, you can clone the Git repository or add it as a submodule. You can get source code access by uploading your receipt to the Redpoint Games License Manager.

If your Unreal Engine project is in a Git repository, add it as a submodule like so:

git submodule add [email protected]:redpointgames/eos-online-subsystem Plugins/EpicOnlineSubsystem
git submodule update --init --recursive

You can also access the source code on GitLab.

note

You can also clone the repository using HTTPS using https://src.redpoint.games/redpointgames/eos-online-subsystem as the URL, but you must create a personal access token with the read_repository scope and use this personal access token as the password for HTTPS authentication. It is recommended that you use SSH URLs instead, as shown in the git submodule add command above.

Next steps

Now that you've installed the plugin, continue to the Getting Started guide. This guide will walk you through the steps involved in setting up your product in the EOS Developer Portal.