You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<divalign="center"> <imgsrc="/com.playeveryware.eos/Documentation~/images/EOSPluginLogo.png"alt="PlayEveryWare EOS Plugin for Unity" /> </div>
1
+
<divalign="center"> <imgsrc="/com.playeveryware.eos/Documentation~/images/EOSPluginLogo.png"alt="EOS Plugin for Unity" /> </div>
4
2
5
3
<br />
6
4
@@ -14,24 +12,24 @@
14
12
15
13
# Overview
16
14
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).
15
+
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).
18
16
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/PlayEveryWare/eos_plugin_for_unity_upm).
17
+
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).
20
18
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!
19
+
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.
22
20
23
21
See [this](/com.playeveryware.eos/Documentation~/plugin_advantages.md) for a more complete overview of the advantages of using EOS with Unity.
24
22
25
23
[^1]: See the [supported-eos-sdk-features](#supported-eos-sdk-features) section for which SDK features specifically are demonstrated.
26
24
27
25
> [!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.
26
+
> 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.
29
27
30
28
# Getting Started
31
29
32
30
## Prerequisites
33
31
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_).
32
+
*[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_).
35
33
* A product configured on the [Epic Games Developer Portal](https://dev.epicgames.com/portal/).
36
34
* A Unity project to integrate the plugin into.
37
35
@@ -40,13 +38,13 @@ See [this](/com.playeveryware.eos/Documentation~/plugin_advantages.md) for a mor
40
38
41
39
# Supported EOS SDK Features
42
40
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.
41
+
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.
44
42
45
43
Use the "Select Demo Scene" dropdown in the application to select the sample scene that corresponds with the walkthrough.
46
44
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.
45
+
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.
48
46
49
-
| Feature | Status | Sample Scene Walkthrough | Requires EGA|
47
+
| Feature | Status | Sample Scene Walkthrough | Requires Epic Games account|
|[Platform Interface](https://dev.epicgames.com/docs/game-services/eos-platform-interface)| ✅ | NA ||
66
63
|[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 +70,12 @@ There are many EOS features that do not require your player to have an Epic Game
|[User Info Interface](https://dev.epicgames.com/docs/epic-account-services/eos-user-info-interface)| ✅ | NA | ✔️ |
73
+
|[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)||
76
74
|[Voice Trusted Server](https://dev.epicgames.com/docs/game-services/voice#voicewithatrustedserverapplication)| ❌ | NA ||
77
75
78
76
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.
79
77
80
-
[^2]: Overlay Features aren't supported yet on Mobile devices as of EOSSDK 1.16.4. That includes Social Overlay and Store Overlay.
78
+
[^2]: Overlay features aren't supported yet on mobile devices as of EOSSDK 1.17. That includes Social Overlay and Store Overlay.
81
79
82
80
## Supported Platforms
83
81
@@ -88,11 +86,11 @@ We currently support the following platforms, details of each can be found on ou
88
86
* macOS
89
87
* Android
90
88
* iOS
91
-
* Nintendo Switch
89
+
* Nintendo Switch™
92
90
* Xbox One
93
-
* Xbox Series X
94
-
* PlayStation4
95
-
* PlayStation5
91
+
* Xbox Series X|S
92
+
* PlayStation®4
93
+
* PlayStation®5
96
94
97
95
## Importing the Plugin Package
98
96
@@ -109,17 +107,13 @@ Once imported into your project, be sure to [Configure the Plugin](/com.playever
109
107
110
108
# Support / Contact
111
109
112
-
PlayEveryWare EOS Plugin for Unity documentation can be found here on GitHub.
113
-
114
-
For issues related to integration or usage of the EOS Unity plugin, please create a `New Issue` under the [Issues](https://github.com/PlayEveryWare/eos_plugin_for_unity/issues) tab.
110
+
EOS Plugin for Unity documentation can be found here on GitHub.
115
111
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/).
112
+
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).
117
113
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).
114
+
Detailed descriptions and usage for EOS SDK Interfaces can be found on [Epic Developer Resources Documentation](https://dev.epicgames.com/docs/).
119
115
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 [[email protected]](mailto:[email protected]).
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/PlayEveryWare/eos_plugin_for_unity/issues) tab, and we will make certain that you are properly (and promptly) assisted :)
116
+
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).
123
117
124
118
# Contributor Notes
125
119
@@ -134,5 +128,3 @@ See [our guide](/com.playeveryware.eos/Documentation~/command_line_export.md) on
134
128
For issues of API Level compatibility, please read our [document](/com.playeveryware.eos/Documentation~/dotnet_quirks.md) on .NET Quirks and Unity compatibility.
135
129
136
130
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/PlayEveryWare/eos_plugin_for_unity/discussions) tab.
0 commit comments