Skip to content

Commit 70755b9

Browse files
committed
fix: Update documentation.
1 parent a394066 commit 70755b9

File tree

3 files changed

+10
-11
lines changed

3 files changed

+10
-11
lines changed

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

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
<a href="/com.playeveryware.eos/README.md"><img src="/com.playeveryware.eos/Documentation~/images/PlayEveryWareLogo.gif" alt="Readme" width="5%"/></a>
22

3-
# Configuring the Plugin
3+
# Getting Started - Configuring the Plugin
44

55
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.
66

77
## In the Unity editor, Open ```EOS Plugin -> EOS Configuration```.
88

9-
![EOS Config Menu](/com.playeveryware.eos/Documentation~/images/dev-portal-configuration-editor-menu.png)
9+
![EOS Config Menu](/com.playeveryware.eos/Documentation~/images/eos-configuration-menu.png)
1010

1111
![EOS Configuration](/com.playeveryware.eos/Documentation~/images/eos_configuration.png)
1212

@@ -17,12 +17,12 @@ From the [Developer Portal](https://dev.epicgames.com/portal/), inside your game
1717
> [!NOTE]
1818
> 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).
1919
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)
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)
2626

2727
There are two other fields in the configuration editor.
2828

@@ -34,9 +34,8 @@ There are two other fields in the configuration editor.
3434
`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.
3535

3636
> [!NOTE]
37-
> 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/).
38-
> 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.
39-
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.
4039
**Click `Save All Changes`.**
4140

4241
## Add EOS functionality to your game scene
Binary file not shown.
16.2 KB
Loading

0 commit comments

Comments
 (0)