|
1 | 1 | <a href="/com.playeveryware.eos/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Readme" width="5%"/></a> |
2 | 2 |
|
3 | | -# Configuring the Plugin |
| 3 | +# Getting Started - Configuring the Plugin |
4 | 4 |
|
5 | 5 | To function, the plugin needs some information from your EOS project. Be sure to read the Epic Documentation on [getting started](https://dev.epicgames.com/docs/epic-account-services/getting-started?sessionInvalidated=true) with Epic Online Services. |
6 | 6 |
|
7 | | -1) Open your Unity project with the integrated EOS Unity Plugin. |
8 | | -2) In the Unity editor, Open ```Tools -> EOS Plugin -> Dev Portal Configuration```. |
| 7 | +## In the Unity editor, Open ```EOS Plugin -> EOS Configuration```. |
9 | 8 |
|
10 | | -  |
| 9 | + |
11 | 10 |
|
12 | | -  |
| 11 | + |
13 | 12 |
|
14 | | -3) From the [Developer Portal](https://dev.epicgames.com/portal/), copy the configuration values listed below, and paste them into the similarly named fields in the editor tool window pictured above: |
| 13 | +## Set product settings from Epic Developer Portal |
15 | 14 |
|
16 | | - > [!NOTE] |
17 | | - > For more detailed information, check out Epic's Documentation on [Creating the Platform Interface](https://dev.epicgames.com/docs/game-services/eos-platform-interface#creating-the-platform-interface). |
| 15 | +From the [Developer Portal](https://dev.epicgames.com/portal/), inside your game's `Product Settings` page, copy the configuration values listed below, and paste them into the similarly named fields in the editor tool window pictured above: |
18 | 16 |
|
19 | | - * ProductName |
20 | | - * ProductVersion |
21 | | - * [ProductID](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=ProductId) |
22 | | - * [SandboxID](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=SandboxId) |
23 | | - * [DeploymentID](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=DeploymentId) |
24 | | - * [ClientSecret](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=ClientSecret) |
25 | | - * [ClientID](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=ClientId) |
26 | | - * EncryptionKey |
27 | | - |
28 | | - <br /> |
| 17 | +> [!NOTE] |
| 18 | +> For more detailed information, check out Epic's Documentation on [Creating the Platform Interface](https://dev.epicgames.com/docs/game-services/eos-platform-interface#creating-the-platform-interface). |
29 | 19 |
|
30 | | - > [!NOTE] |
31 | | - > Click the "Generate" button to create a random key, if you haven't already configured an encryption key in the EOS portal. You can then add the generated key to the [Developer Portal](https://dev.epicgames.com/portal/). |
32 | | - > The Encryption Key is Used for Player Data Storage and Title Storage, if you do not plan to use these features in your project or the samples (and don't want to create an Encryption Key) then the field can be left blank. |
| 20 | +* ProductName |
| 21 | +* [ProductID](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=ProductId) |
| 22 | +* [SandboxID](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=SandboxId) |
| 23 | +* [DeploymentID](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=DeploymentId) |
| 24 | +* [ClientSecret](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=ClientSecret) |
| 25 | +* [ClientID](https://dev.epicgames.com/docs/services/en-US/Glossary/index.html#D?term=ClientId) |
33 | 26 |
|
34 | | -4) Click `Save All Changes`. |
| 27 | +There are two other fields in the configuration editor. |
35 | 28 |
|
36 | | -5) Navigate to `Packages/Epic Online Services for Unity/Runtime` via the `Project` window. |
| 29 | +`ProductVersion` is a free-form numeric field, and can use any number. |
37 | 30 |
|
38 | | -6) Either: |
39 | | - - Add the `Singletons.prefab`, to each of your game's scenes. |
40 | | - - Attach `EOSManager.cs (Script)` to a Unity object, and it will initialize the plugin with the specified configuration in `OnAwake()` (this is what `Singletons.prefab` does). |
| 31 | +> [!WARNING] |
| 32 | +> The `ProductVersion` field needs to have some value inside it; it cannot be left empty. |
| 33 | + |
| 34 | +`EncryptionKey` is used to encrypt uploads to the `Player Data Storage` and `Title Data Storage` EOS features. This value should be consistently used whenever uploading or downloading files from these Data Storages. |
41 | 35 |
|
42 | 36 | > [!NOTE] |
43 | | -The included [samples](http://github.com/PlayEveryWare/eos_plugin_for_unity/blob/development/com.playeveryware.eos/com.playeveryware.eos/README.md#samples) already have configuration values set for you to experiment with! |
| 37 | +> The Encryption Key is generated automatically for you when you create a set of Client Credentials. To view the key, generate a new one - or set it to a specific value, click on the "Key" button next to the client credentials. |
| 38 | +> The Encryption Key is used for Player Data Storage and Title Storage. |
| 39 | +**Click `Save All Changes`.** |
| 40 | + |
| 41 | +## Add EOS functionality to your game scene |
44 | 42 |
|
45 | | -If you would like to see specific examples of various EOS features in action, import the sample Unity scenes that are described below. |
| 43 | +Navigate to `Packages/Epic Online Services for Unity/Runtime` via the `Project` window. |
| 44 | + |
| 45 | +Either: |
| 46 | +- Add the `Singletons.prefab`, to each of your game's scenes. |
| 47 | +- Attach `EOSManager.cs (Script)` to a Unity object, and it will initialize the plugin with the specified configuration in `OnAwake()` (this is what `Singletons.prefab` does). |
| 48 | + |
| 49 | +> [!NOTE] |
| 50 | +> The included [samples](http://github.com/PlayEveryWare/eos_plugin_for_unity/blob/development/com.playeveryware.eos/README.md#samples) already have configuration values set for you to experiment with! |
0 commit comments