Skip to content

Commit c00bbd2

Browse files
Merge pull request #1206 from EOS-Contrib/docs/eosu-801-update-contact
Docs/eosu 801 update contact
2 parents 477ab0f + e760b4e commit c00bbd2

2 files changed

Lines changed: 26 additions & 40 deletions

File tree

com.playeveryware.eos/Documentation~/supported_platforms.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,12 @@
1010
- **[iOS](/com.playeveryware.eos/Documentation~/iOS/README_iOS.md)** [^1]
1111
- **[Linux](/com.playeveryware.eos/Documentation~/dev_env/Ubuntu_Development_Environment.md)** [^1]
1212
- **[MacOS](/com.playeveryware.eos/Documentation~/macOS/README_macOS.md)**
13-
- **Nintendo Switch**<br>
14-
_For details, please see the Nintendo Developer Portal._
13+
- **Nintendo (Switch & Switch 2)**<br>
1514
- **Xbox (One & Xbox Series X)**<br>
16-
_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._
1715
- **PlayStation (4 & 5)**<br>
18-
_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)_
16+
_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)_
1917

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

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

@@ -30,4 +28,4 @@ We are always looking to add the functionality of the plugin to more platforms,
3028
## Targetted Versions:
3129

3230
* 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.
33-
* Targets [EOS SDK 1.16.3](https://dev.epicgames.com/docs/epic-online-services/release-notes#1163-cl32303053---2024-apr-09) *(bundled with plugin)*.
31+
* 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)*.

com.playeveryware.eos/README.md

Lines changed: 22 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,31 @@
1-
<a href="/com.playeveryware.eos/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Lobby Screenshot" width="5%"/></a>
2-
3-
<div align="center"> <img src="/com.playeveryware.eos/Documentation~/images/EOSPluginLogo.png" alt="PlayEveryWare EOS Plugin for Unity" /> </div>
4-
5-
<br />
6-
71
<div align="left">
82

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

137
</div>
148

159
# Overview
1610

17-
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).
11+
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).
1812

19-
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).
13+
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).
2014

21-
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!
15+
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.
2216

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

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

2721
> [!NOTE]
28-
> 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.
22+
> 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.
2923
3024
# Getting Started
3125

3226
## Prerequisites
3327

34-
* [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_).
28+
* [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_).
3529
* A product configured on the [Epic Games Developer Portal](https://dev.epicgames.com/portal/).
3630
* A Unity project to integrate the plugin into.
3731

@@ -40,13 +34,13 @@ See [this](/com.playeveryware.eos/Documentation~/plugin_advantages.md) for a mor
4034
4135
# Supported EOS SDK Features
4236

43-
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.
37+
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.
4438

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

47-
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.
41+
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.
4842

49-
| Feature | Status | Sample Scene Walkthrough | Requires EGA |
43+
| Feature | Status | Sample Scene Walkthrough | Requires Epic Games account |
5044
| :-- | :-: | :-- | :-: |
5145
|[Achievements](https://dev.epicgames.com/docs/game-services/achievements) || ["Achievements"](/com.playeveryware.eos/Documentation~/scene_walkthrough/achievements_walkthrough.md) | |
5246
|[Anti-Cheat](https://dev.epicgames.com/docs/game-services/anti-cheat) || ["Information"](/com.playeveryware.eos/Documentation~/easy_anticheat_configuration.md) | |
@@ -56,11 +50,10 @@ There are many EOS features that do not require your player to have an Epic Game
5650
|[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) | ✔️ |
5751
|[Friends](https://dev.epicgames.com/docs/epic-account-services/eos-friends-interface) || ["Auth & Friends"](/com.playeveryware.eos/Documentation~/scene_walkthrough/auth&friends_walkthrough.md) | ✔️ |
5852
|[Leaderboards](https://dev.epicgames.com/docs/game-services/leaderboards) || ["Leaderboards"](/com.playeveryware.eos/Documentation~/scene_walkthrough/leaderboards_walkthrough.md) | |
59-
|[Lobby](https://dev.epicgames.com/docs/game-services/lobbies) || ["Lobbies"](/com.playeveryware.eos/Documentation~/scene_walkthrough/lobbies_walkthrough.md) | |
60-
|[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) | |
53+
|[Lobbies](https://dev.epicgames.com/docs/game-services/lobbies) || ["Lobbies"](/com.playeveryware.eos/Documentation~/scene_walkthrough/lobbies_walkthrough.md) | |
6154
|[Logging Interface](https://dev.epicgames.com/docs/game-services/eos-logging-interface) || NA | |
6255
|[Metrics](https://dev.epicgames.com/docs/game-services/eos-metrics-interface) || ["Metrics"](/com.playeveryware.eos/Documentation~/scene_walkthrough/metrics_walkthrough.md) | |
63-
|[Mod SDK](https://dev.epicgames.com/docs/epic-games-store/tech-features-config/mods) || NA | ✔️ |
56+
|[Epic Games Store Mods](https://dev.epicgames.com/docs/epic-games-store/tech-features-config/mods) || NA | ✔️ |
6457
|[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) | |
6558
|[Platform Interface](https://dev.epicgames.com/docs/game-services/eos-platform-interface) || NA | |
6659
|[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) | |
@@ -73,11 +66,12 @@ There are many EOS features that do not require your player to have an Epic Game
7366
|[Stats](https://dev.epicgames.com/docs/game-services/eos-stats-interface) || ["Leaderboards"](/com.playeveryware.eos/Documentation~/scene_walkthrough/leaderboards_walkthrough.md) | |
7467
|[Title Storage](https://dev.epicgames.com/docs/game-services/title-storage) || ["Title Storage"](/com.playeveryware.eos/Documentation~/scene_walkthrough/title_storage_walkthrough.md) | |
7568
|[User Info Interface](https://dev.epicgames.com/docs/epic-account-services/eos-user-info-interface) || NA | ✔️ |
69+
|[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) | |
7670
|[Voice Trusted Server](https://dev.epicgames.com/docs/game-services/voice#voicewithatrustedserverapplication) || NA | |
7771

7872
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.
7973

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

8276
## Supported Platforms
8377

@@ -88,11 +82,11 @@ We currently support the following platforms, details of each can be found on ou
8882
* macOS
8983
* Android
9084
* iOS
91-
* Nintendo Switch
85+
* Nintendo Switch
9286
* Xbox One
93-
* Xbox Series X
94-
* PlayStation 4
95-
* PlayStation 5
87+
* Xbox Series X|S
88+
* PlayStation®4
89+
* PlayStation®5
9690

9791
## Importing the Plugin Package
9892

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

110104
# Support / Contact
111105

112-
PlayEveryWare EOS Plugin for Unity documentation can be found here on GitHub.
106+
EOS Plugin for Unity documentation can be found here on GitHub.
113107

114-
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.
108+
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).
115109

116-
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/).
110+
Detailed descriptions and usage for EOS SDK Interfaces can be found on [Epic Developer Resources Documentation](https://dev.epicgames.com/docs/).
117111

118-
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).
119-
120-
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).
121-
122-
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 :)
112+
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).
123113

124114
# Contributor Notes
125115

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

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

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

0 commit comments

Comments
 (0)