Skip to content

EOSU-801 Update readme and supported platforms #1218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
DanF-ApexSystems wants to merge 4 commits into from
+27 −41
Closed

EOSU-801 Update readme and supported platforms #1218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4ea29d1
Update readme and supported_platforms
EOSPluginJeff Jan 6, 2026
e760b4e
Update supported_platforms.md
EOSPluginJeff Jan 6, 2026
631c941
Fix typo
DanF-ApexSystems Jan 7, 2026
44d0838
Merge branch 'release-6.0.0' into docs/eosu-801-update-contact
matt-clarke Jan 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions com.playeveryware.eos/Documentation~/supported_platforms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,12 @@
- **[iOS](/com.playeveryware.eos/Documentation~/iOS/README_iOS.md)** [^1]
- **[Linux](/com.playeveryware.eos/Documentation~/dev_env/Ubuntu_Development_Environment.md)** [^1]
- **[MacOS](/com.playeveryware.eos/Documentation~/macOS/README_macOS.md)**
- **Nintendo Switch**<br>
_For details, please see the Nintendo Developer Portal._
- **Nintendo (Switch & Switch 2)**<br>
- **Xbox (One & Xbox Series X)**<br>
_To get access to PlayEveryWare's EOS Plugin for Unity on Xbox platforms, please prompt your EPM to contact PlayEveryWare to confirm status as a verified GDKX licensed developer._
- **PlayStation (4 & 5)**<br>
_To get access to PlayEveryWare's EOS Plugin for Unity on Sony platforms, please contact us at [eos-support@playeveryware.com](mailto:eos-support@playeveryware.com)_
_To get access to the EOS Plugin for Unity on console platforms, please follow this guide [Console Developer Access](https://dev.epicgames.com/docs/dev-portal/organization-management#console-developer-access)_

We are always looking to add the functionality of the plugin to more platforms, and have functionality for some in private development
We are always looking to add the functionality of the plugin to more platforms, and have functionality for some in private development.

[^1]: Social overlay feature is currently not supported on this platform.

Expand All @@ -27,7 +25,7 @@ We are always looking to add the functionality of the plugin to more platforms,
- Universal Windows Platform (x86)
- Unity Web Player

## Targetted Versions:
## Targeted Versions:

* Targets [Unity 2021.3.16f1](https://unity.com/releases/editor/whats-new/2021.3.16), for best results a version of Unity 2021 is preferred.
* Targets [EOS SDK 1.16.3](https://dev.epicgames.com/docs/epic-online-services/release-notes#1163-cl32303053---2024-apr-09) *(bundled with plugin)*.
* Targets [EOS SDK 1.18.1.2](https://dev.epicgames.com/docs/epic-online-services/release-notes#11812---cl47370208---2025-nov-04) *(bundled with plugin)*.
56 changes: 22 additions & 34 deletions com.playeveryware.eos/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,31 @@
<a href="/com.playeveryware.eos/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>

<div align="center"> <img src="/com.playeveryware.eos/Documentation~/images/EOSPluginLogo.png" alt="PlayEveryWare EOS Plugin for Unity" /> </div>

<br />

<div align="left">

<a href="">[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)</a>
<a href="">![Unity](https://img.shields.io/badge/Unity-2021.3.16f1-blue)</a>
<img src="tools/coverage/results/Report/badge_linecoverage.svg" />
<img src="/tools/coverage/results/Report/badge_linecoverage.svg" />

</div>

# Overview

The PlayEveryWare EOS Plugin for Unity brings the free services from Epic that connect players across all platforms and all stores to Unity in an easy-to-use package. Find more information on what services Epic Online Services encompasses, see here: [https://dev.epicgames.com/en-US/services](https://dev.epicgames.com/en-US/services) and to read the developer documentation on those services, see here: [https://dev.epicgames.com/docs/epic-online-services](https://dev.epicgames.com/docs/epic-online-services).
The EOS Plugin for Unity brings the free services from Epic that connect players across all platforms and all stores to Unity in an easy-to-use package. Find more information on what services Epic Online Services encompasses at [https://dev.epicgames.com/en-US/services](https://dev.epicgames.com/en-US/services) and read the developer documentation at [https://dev.epicgames.com/docs/epic-online-services](https://dev.epicgames.com/docs/epic-online-services).

This repository contains the source code for development and serves as a destination for support for the [PlayEveryWare EOS Plugin for Unity (UPM Package)](https://github.com/EOS-Contrib/eos_plugin_for_unity_upm).
This repository contains the source code for development of the [EOS Plugin for Unity (UPM Package)](https://github.com/EOS-Contrib/eos_plugin_for_unity_upm).

Out of the box, this project demonstrates (through a collection of sample scenes) each feature of the Epic Online Services SDK[^1]. The sample scenes (coupled with accompanying documentation) can be used to get an idea of how you can implement all the online features you want in your game!
Out of the box, this project demonstrates (through a collection of sample scenes) each feature of the Epic Online Services SDK[^1]. The sample scenes (coupled with accompanying documentation) can be used to get an idea of how you can implement the online features you want in your game.

See [this](/com.playeveryware.eos/Documentation~/plugin_advantages.md) for a more complete overview of the advantages of using EOS with Unity.

[^1]: See the [supported-eos-sdk-features](#supported-eos-sdk-features) section for which SDK features specifically are demonstrated.

> [!NOTE]
> If you are **not** interested in the _development_ of the EOS Plugin project (and instead just want to get to using it) you can follow our guide on [Importing the Plugin Package](#importing-the-plugin-package) to start using the most recently released version of the EOS Plugin.
> If you are **not** interested in the _development_ of the EOS Plugin for Unity project (and instead just want to get to using it) you can follow our guide on [Importing the Plugin Package](#importing-the-plugin-package) to start using the most recently released version of the EOS Plugin for Unity.

# Getting Started

## Prerequisites

* [Create an Epic Games Account](https://www.epicgames.com/id/register) (_although, most [features](#exploring-supported-eos-features) do not require your users to have an Epic Games Account, you must have one to configure your game with Epic Games Developer Portal_).
* [An Epic Games account](https://www.epicgames.com/id/register) (_although, most [features](#exploring-supported-eos-features) do not require your users to have an Epic Games account, you must have one to configure your game in the Epic Games Developer Portal_).
* A product configured on the [Epic Games Developer Portal](https://dev.epicgames.com/portal/).
* A Unity project to integrate the plugin into.

Expand All @@ -40,13 +34,13 @@ See [this](/com.playeveryware.eos/Documentation~/plugin_advantages.md) for a mor

# Supported EOS SDK Features

Below is a table summarizing the level of support the EOS Plugin for Unity provides. Most features are demonstrated via sample scenes provided in the project, and links to the guide for each corresponding sample scene are listed below. In some cases (such as Anti-Cheat) the feature is not very well demonstrated with a scene. In those cases, a link to information about how the plugin utilizes the feature is provided. In some cases (such as logging and overlay) the features are not implemented in any one scene specifically, but in all of them.
Below is a table summarizing the features the EOS Plugin for Unity supports. Most features are demonstrated via sample scenes provided in the project, and links to the guide for each corresponding sample scene are listed below. In some cases (such as Anti-Cheat) the feature is not able to be demonstrated well with a scene. In those cases, a link to information about how the plugin utilizes the feature is provided. In some cases (such as logging and overlay) the features are not implemented in any one scene specifically, but in all of them.

Use the "Select Demo Scene" dropdown in the application to select the sample scene that corresponds with the walkthrough.

There are many EOS features that do not require your player to have an Epic Games Account (EGA) - such features are also marked accordingly in the following table.
There are many EOS features that do not require your player to have an Epic Games account - such features are also marked accordingly in the following table.

| Feature | Status | Sample Scene Walkthrough | Requires EGA |
| Feature | Status | Sample Scene Walkthrough | Requires Epic Games account |
| :-- | :-: | :-- | :-: |
|[Achievements](https://dev.epicgames.com/docs/game-services/achievements) | ✅ | ["Achievements"](/com.playeveryware.eos/Documentation~/scene_walkthrough/achievements_walkthrough.md) | |
|[Anti-Cheat](https://dev.epicgames.com/docs/game-services/anti-cheat) | ✅ | ["Information"](/com.playeveryware.eos/Documentation~/easy_anticheat_configuration.md) | |
Expand All @@ -56,11 +50,10 @@ There are many EOS features that do not require your player to have an Epic Game
|[Ecommerce](https://dev.epicgames.com/docs/epic-games-store/tech-features-config/ecom)[^2] | ✅ | ["Store"](/com.playeveryware.eos/Documentation~/scene_walkthrough/store_walkthrough.md), [Information](/com.playeveryware.eos/Documentation~/ecom.md) | ✔️ |
|[Friends](https://dev.epicgames.com/docs/epic-account-services/eos-friends-interface) | ✅ | ["Auth & Friends"](/com.playeveryware.eos/Documentation~/scene_walkthrough/auth&friends_walkthrough.md) | ✔️ |
|[Leaderboards](https://dev.epicgames.com/docs/game-services/leaderboards) | ✅ | ["Leaderboards"](/com.playeveryware.eos/Documentation~/scene_walkthrough/leaderboards_walkthrough.md) | |
|[Lobby](https://dev.epicgames.com/docs/game-services/lobbies) | ✅ | ["Lobbies"](/com.playeveryware.eos/Documentation~/scene_walkthrough/lobbies_walkthrough.md) | |
|[Lobby with Voice](https://dev.epicgames.com/docs/game-services/voice#voicewithlobbies) | ✅ | ["Lobbies"](/com.playeveryware.eos/Documentation~/scene_walkthrough/lobbies_walkthrough.md), [Information](/com.playeveryware.eos/Documentation~/enabling_voice.md) | |
|[Lobbies](https://dev.epicgames.com/docs/game-services/lobbies) | ✅ | ["Lobbies"](/com.playeveryware.eos/Documentation~/scene_walkthrough/lobbies_walkthrough.md) | |
|[Logging Interface](https://dev.epicgames.com/docs/game-services/eos-logging-interface) | ✅ | NA | |
|[Metrics](https://dev.epicgames.com/docs/game-services/eos-metrics-interface) | ✅ | ["Metrics"](/com.playeveryware.eos/Documentation~/scene_walkthrough/metrics_walkthrough.md) | |
|[Mod SDK](https://dev.epicgames.com/docs/epic-games-store/tech-features-config/mods) | ❌ | NA | ✔️ |
|[Epic Games Store Mods](https://dev.epicgames.com/docs/epic-games-store/tech-features-config/mods) | ❌ | NA | ✔️ |
|[NAT P2P](https://dev.epicgames.com/docs/game-services/p-2-p) | ✅ | ["Peer 2 Peer"](/com.playeveryware.eos/Documentation~/scene_walkthrough/P2P_walkthrough.md), ["P2P Netcode"](/com.playeveryware.eos/Documentation~/scene_walkthrough/P2P_netcode_walkthrough.md) | |
|[Platform Interface](https://dev.epicgames.com/docs/game-services/eos-platform-interface) | ✅ | NA | |
|[Player Data Storage](https://dev.epicgames.com/docs/game-services/player-data-storage) | ✅ | ["Player Data Storage"](/com.playeveryware.eos/Documentation~/scene_walkthrough/player_data_storage_walkthrough.md) | |
Expand All @@ -73,11 +66,12 @@ There are many EOS features that do not require your player to have an Epic Game
|[Stats](https://dev.epicgames.com/docs/game-services/eos-stats-interface) | ✅ | ["Leaderboards"](/com.playeveryware.eos/Documentation~/scene_walkthrough/leaderboards_walkthrough.md) | |
|[Title Storage](https://dev.epicgames.com/docs/game-services/title-storage) | ✅ | ["Title Storage"](/com.playeveryware.eos/Documentation~/scene_walkthrough/title_storage_walkthrough.md) | |
|[User Info Interface](https://dev.epicgames.com/docs/epic-account-services/eos-user-info-interface) | ✅ | NA | ✔️ |
|[Voice with Lobbies](https://dev.epicgames.com/docs/game-services/voice#voicewithlobbies) | ✅ | ["Lobbies"](/com.playeveryware.eos/Documentation~/scene_walkthrough/lobbies_walkthrough.md), [Information](/com.playeveryware.eos/Documentation~/enabling_voice.md) | |
|[Voice Trusted Server](https://dev.epicgames.com/docs/game-services/voice#voicewithatrustedserverapplication) | ❌ | NA | |

Efforts will be made to add corresponding support to features as they are added to the Epic Online Services SDK. The table above reflects the features as of November 2023.

[^2]: Overlay Features aren't supported yet on Mobile devices as of EOSSDK 1.16.4. That includes Social Overlay and Store Overlay.
[^2]: Overlay features aren't supported yet on mobile devices as of EOSSDK 1.17. That includes Social Overlay and Store Overlay.

## Supported Platforms

Expand All @@ -88,11 +82,11 @@ We currently support the following platforms, details of each can be found on ou
* macOS
* Android
* iOS
* Nintendo Switch
* Nintendo Switch™
* Xbox One
* Xbox Series X
* PlayStation 4
* PlayStation 5
* Xbox Series X|S
* PlayStation®4
* PlayStation®5

## Importing the Plugin Package

Expand All @@ -109,17 +103,13 @@ Once imported into your project, be sure to [Configure the Plugin](/com.playever

# Support / Contact

PlayEveryWare EOS Plugin for Unity documentation can be found here on GitHub.
EOS Plugin for Unity documentation can be found here on GitHub.

For issues related to integration or usage of the EOS Unity plugin, please create a `New Issue` under the [Issues](https://github.com/EOS-Contrib/eos_plugin_for_unity/issues) tab.
For questions or issues related to integration or usage of Epic Online Services, Epic Games Developer Portal, or the EOS Plugin for Unity, please create a discussion on the [EOS Developer Community](https://eoshelp.epicgames.com).

For issues related to Epic Online Services SDK, Epic Dev Portal or for general EOS SDK information, see the [Epic Online Services Community Support](https://eoshelp.epicgames.com/).
Detailed descriptions and usage for EOS SDK Interfaces can be found on [Epic Developer Resources Documentation](https://dev.epicgames.com/docs/).

Detailed descriptions and usage for EOS SDK Interfaces can be found on [Epic's documentation for Game Services](https://dev.epicgames.com/docs/services/en-US/GameServices/index.html).

For issues of a confidential nature (for instance for support using this Plugin on restricted console platforms), please reach out to us directly at [eos-support@playeveryware.com](mailto:playeos-support@playeveryware.com).

If it is _at all_ unclear to you where to go for support - do not hesitate to open a `New Issue` under the [Issues](https://github.com/EOS-Contrib/eos_plugin_for_unity/issues) tab, and we will make certain that you are properly (and promptly) assisted :)
For issues of a confidential nature (including support using this plugin on console platforms), please create a private discussion on the [EOS Developer Community](https://eoshelp.epicgames.com).

# Contributor Notes

Expand All @@ -133,6 +123,4 @@ See [our guide](/com.playeveryware.eos/Documentation~/command_line_export.md) on

For issues of API Level compatibility, please read our [document](/com.playeveryware.eos/Documentation~/dotnet_quirks.md) on .NET Quirks and Unity compatibility.

For more FAQs see [Frequently Asked Questions](/com.playeveryware.eos/Documentation~/frequently_asked_questions.md).

If you have any outstanding questions, please bring them up in the [Discussions](https://github.com/EOS-Contrib/eos_plugin_for_unity/discussions) tab.
For more FAQs see [Frequently Asked Questions](/com.playeveryware.eos/Documentation~/frequently_asked_questions.md).